github.com/onflow/flow-go@v0.35.7-crescendo-preview.23-atree-inlining/model/convert/service_event_test.go

package convert_test

import (
	"fmt"
	"testing"

	"github.com/onflow/cadence"
	"github.com/onflow/cadence/encoding/ccf"
	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"

	"github.com/onflow/flow-go/fvm/systemcontracts"
	"github.com/onflow/flow-go/model/convert"
	"github.com/onflow/flow-go/model/flow"
	"github.com/onflow/flow-go/utils/unittest"
)

func TestEventConversion(t *testing.T) {

	chainID := flow.Emulator

	t.Run(
		"epoch setup", func(t *testing.T) {

			fixture, expected := unittest.EpochSetupFixtureByChainID(chainID)

			// convert Cadence types to Go types
			event, err := convert.ServiceEvent(chainID, fixture)
			require.NoError(t, err)
			require.NotNil(t, event)

			// cast event type to epoch setup
			actual, ok := event.Event.(*flow.EpochSetup)
			require.True(t, ok)

			assert.Equal(t, expected, actual)

		},
	)

	t.Run(
		"epoch setup with random source with leading zeroes", func(t *testing.T) {

			fixture, _ := unittest.EpochSetupFixtureByChainID(chainID)
			// all zero source to cover all cases of endiannesses
			randomSource := make([]byte, flow.EpochSetupRandomSourceLength)
			// update the random source in event fixture
			fixture.Payload = unittest.EpochSetupFixtureCCF(randomSource)

			// convert Cadence types to Go types
			event, err := convert.ServiceEvent(chainID, fixture)
			require.NoError(t, err)
			require.NotNil(t, event)

			// cast event type to epoch setup
			_, ok := event.Event.(*flow.EpochSetup)
			require.True(t, ok)
		},
	)

	t.Run(
		"epoch setup with short random source", func(t *testing.T) {

			fixture, _ := unittest.EpochSetupFixtureByChainID(chainID)
			// update the random source in event fixture
			randomSource := unittest.EpochSetupRandomSourceFixture()
			fixture.Payload = unittest.EpochSetupFixtureCCF(randomSource[:flow.EpochSetupRandomSourceLength-1])

			// convert Cadence types to Go types
			event, err := convert.ServiceEvent(chainID, fixture)
			require.Error(t, err)
			require.Nil(t, event)
		},
	)

	t.Run(
		"epoch setup with non-hex random source", func(t *testing.T) {

			fixture, _ := unittest.EpochSetupFixtureByChainID(chainID)
			// update the random source in event fixture
			fixture.Payload = unittest.EpochSetupCCFWithNonHexRandomSource()

			// convert Cadence types to Go types
			event, err := convert.ServiceEvent(chainID, fixture)
			require.Error(t, err)
			require.Nil(t, event)
		},
	)

	t.Run(
		"epoch commit", func(t *testing.T) {

			fixture, expected := unittest.EpochCommitFixtureByChainID(chainID)

			// convert Cadence types to Go types
			event, err := convert.ServiceEvent(chainID, fixture)
			require.NoError(t, err)
			require.NotNil(t, event)

			// cast event type to epoch commit
			actual, ok := event.Event.(*flow.EpochCommit)
			require.True(t, ok)

			assert.Equal(t, expected, actual)
		},
	)

	t.Run(
		"version beacon", func(t *testing.T) {

			fixture, expected := unittest.VersionBeaconFixtureByChainID(chainID)

			// convert Cadence types to Go types
			event, err := convert.ServiceEvent(chainID, fixture)
			require.NoError(t, err)
			require.NotNil(t, event)

			// cast event type to version beacon
			actual, ok := event.Event.(*flow.VersionBeacon)
			require.True(t, ok)

			assert.Equal(t, expected, actual)
		},
	)

	t.Run("protocol state version upgrade", func(t *testing.T) {
		fixture, expected := unittest.ProtocolStateVersionUpgradeFixtureByChainID(chainID)

		// convert Cadence types to Go types
		event, err := convert.ServiceEvent(chainID, fixture)
		require.NoError(t, err)
		require.NotNil(t, event)

		// cast event type to version upgrade
		actual, ok := event.Event.(*flow.ProtocolStateVersionUpgrade)
		require.True(t, ok)

		assert.Equal(t, expected, actual)
	})
}

func TestDecodeCadenceValue(t *testing.T) {

	tests := []struct {
		name             string
		location         string
		value            cadence.Value
		decodeInner      func(cadence.Value) (interface{}, error)
		expected         interface{}
		expectError      bool
		expectedLocation string
	}{
		{
			name:     "Basic",
			location: "test",
			value:    cadence.UInt64(42),
			decodeInner: func(value cadence.Value) (
				interface{},
				error,
			) {
				return 42, nil
			},
			expected:    42,
			expectError: false,
		},
		{
			name:     "Nil value",
			location: "test",
			value:    nil,
			decodeInner: func(value cadence.Value) (
				interface{},
				error,
			) {
				return 42, nil
			},
			expected:    nil,
			expectError: true,
		},
		{
			name:     "Custom decode error",
			location: "test",
			value:    cadence.String("hello"),
			decodeInner: func(value cadence.Value) (
				interface{},
				error,
			) {
				return nil, fmt.Errorf("custom error")
			},
			expected:    nil,
			expectError: true,
		},
		{
			name:     "Nested location",
			location: "outer",
			value:    cadence.String("hello"),
			decodeInner: func(value cadence.Value) (interface{}, error) {
				return convert.DecodeCadenceValue(
					".inner", value,
					func(value cadence.Value) (interface{}, error) {
						return nil, fmt.Errorf("custom error")
					},
				)
			},
			expected:         nil,
			expectError:      true,
			expectedLocation: "outer.inner",
		},
	}

	for _, tt := range tests {
		t.Run(
			tt.name, func(t *testing.T) {
				result, err := convert.DecodeCadenceValue(
					tt.location,
					tt.value,
					tt.decodeInner,
				)

				if tt.expectError {
					assert.Error(t, err)
					if tt.expectedLocation != "" {
						assert.Contains(t, err.Error(), tt.expectedLocation)
					}
				} else {
					assert.NoError(t, err)
					assert.Equal(t, tt.expected, result)
				}
			},
		)
	}
}

func TestVersionBeaconEventConversion(t *testing.T) {
	versionBoundaryType := unittest.NewNodeVersionBeaconVersionBoundaryStructType()
	semverType := unittest.NewNodeVersionBeaconSemverStructType()
	eventType := unittest.NewNodeVersionBeaconVersionBeaconEventType()

	type vbTestCase struct {
		name                 string
		event                cadence.Event
		converted            *flow.VersionBeacon
		expectAndHandleError func(t *testing.T, err error)
	}

	runVersionBeaconTestCase := func(t *testing.T, test vbTestCase) {
		chainID := flow.Emulator
		t.Run(test.name, func(t *testing.T) {
			events := systemcontracts.ServiceEventsForChain(chainID)

			var err error
			event := unittest.EventFixture(events.VersionBeacon.EventType(), 1, 1, unittest.IdentifierFixture(), 0)
			event.Payload, err = ccf.Encode(test.event)
			require.NoError(t, err)

			// convert Cadence types to Go types
			serviceEvent, err := convert.ServiceEvent(chainID, event)

			if test.expectAndHandleError != nil {
				require.Error(t, err)
				test.expectAndHandleError(t, err)
				return
			}

			require.NoError(t, err)
			require.NotNil(t, event)

			// cast event type to version beacon
			actual, ok := serviceEvent.Event.(*flow.VersionBeacon)
			require.True(t, ok)

			require.Equal(t, test.converted, actual)
		})
	}

	runVersionBeaconTestCase(t,
		vbTestCase{
			name: "with pre-release",
			event: cadence.NewEvent(
				[]cadence.Value{
					// versionBoundaries
					cadence.NewArray(
						[]cadence.Value{
							cadence.NewStruct(
								[]cadence.Value{
									// blockHeight
									cadence.UInt64(44),
									// version
									cadence.NewStruct(
										[]cadence.Value{
											// major
											cadence.UInt8(2),
											// minor
											cadence.UInt8(13),
											// patch
											cadence.UInt8(7),
											// preRelease
											cadence.NewOptional(cadence.String("test")),
										},
									).WithType(semverType),
								},
							).WithType(versionBoundaryType),
						},
					).WithType(cadence.NewVariableSizedArrayType(versionBoundaryType)),
					// sequence
					cadence.UInt64(5),
				},
			).WithType(eventType),
			converted: &flow.VersionBeacon{
				VersionBoundaries: []flow.VersionBoundary{
					{
						BlockHeight: 44,
						Version:     "2.13.7-test",
					},
				},
				Sequence: 5,
			},
		},
	)

	runVersionBeaconTestCase(t,
		vbTestCase{
			name: "without pre-release",
			event: cadence.NewEvent(
				[]cadence.Value{
					// versionBoundaries
					cadence.NewArray(
						[]cadence.Value{
							cadence.NewStruct(
								[]cadence.Value{
									// blockHeight
									cadence.UInt64(44),
									// version
									cadence.NewStruct(
										[]cadence.Value{
											// major
											cadence.UInt8(2),
											// minor
											cadence.UInt8(13),
											// patch
											cadence.UInt8(7),
											// preRelease
											cadence.NewOptional(nil),
										},
									).WithType(semverType),
								},
							).WithType(versionBoundaryType),
						},
					).WithType(cadence.NewVariableSizedArrayType(versionBoundaryType)),
					// sequence
					cadence.UInt64(5),
				},
			).WithType(eventType),
			converted: &flow.VersionBeacon{
				VersionBoundaries: []flow.VersionBoundary{
					{
						BlockHeight: 44,
						Version:     "2.13.7",
					},
				},
				Sequence: 5,
			},
		},
	)
	runVersionBeaconTestCase(t,
		vbTestCase{
			name: "invalid pre-release",
			event: cadence.NewEvent(
				[]cadence.Value{
					// versionBoundaries
					cadence.NewArray(
						[]cadence.Value{
							cadence.NewStruct(
								[]cadence.Value{
									// blockHeight
									cadence.UInt64(44),
									// version
									cadence.NewStruct(
										[]cadence.Value{
											// major
											cadence.UInt8(2),
											// minor
											cadence.UInt8(13),
											// patch
											cadence.UInt8(7),
											// preRelease
											cadence.NewOptional(cadence.String("/slashes.not.allowed")),
										},
									).WithType(semverType),
								},
							).WithType(versionBoundaryType),
						},
					).WithType(cadence.NewVariableSizedArrayType(versionBoundaryType)),
					// sequence
					cadence.UInt64(5),
				},
			).WithType(eventType),
			expectAndHandleError: func(t *testing.T, err error) {
				require.ErrorContains(t, err, "failed to validate pre-release")
			},
		},
	)
}