prysm-pulse/testing/spectest/shared/common/ssz_static/ssz_static.go

package ssz_static

import (
	"encoding/hex"
	"errors"
	"path"
	"testing"

	fssz "github.com/ferranbt/fastssz"
	"github.com/golang/snappy"
	"github.com/prysmaticlabs/prysm/testing/require"
	"github.com/prysmaticlabs/prysm/testing/spectest/utils"
	"github.com/prysmaticlabs/prysm/testing/util"
)

// RunSSZStaticTests executes "ssz_static" tests for the given fork of phase using the provided
// unmarshaller to hydrate serialized test data into go struct pointers and also applies any custom
// HTR methods via the customHTR callback.
func RunSSZStaticTests(t *testing.T, config, forkOrPhase string, unmarshaller Unmarshaller, customHtr CustomHTRAdder) {
	require.NoError(t, utils.SetConfig(t, config))
	testFolders, _ := utils.TestFolders(t, config, forkOrPhase, "ssz_static")

	if len(testFolders) == 0 {
		t.Fatalf("No test folders found for %s/%s", config, forkOrPhase)
	}

	for _, folder := range testFolders {
		modePath := path.Join("ssz_static", folder.Name())
		modeFolders, _ := utils.TestFolders(t, config, forkOrPhase, modePath)

		if len(modeFolders) == 0 {
			t.Fatalf("No test folders found for %s/%s/%s", config, forkOrPhase, folder.Name())
		}

		for _, modeFolder := range modeFolders {
			innerPath := path.Join(modePath, modeFolder.Name())
			innerTestFolders, innerTestsFolderPath := utils.TestFolders(t, config, forkOrPhase, innerPath)

			if len(innerTestFolders) == 0 {
				t.Fatalf("No test folders found for %s/%s/%s/%s", config, forkOrPhase, folder.Name(), modeFolder.Name())
			}

			for _, innerFolder := range innerTestFolders {
				t.Run(path.Join(modeFolder.Name(), folder.Name(), innerFolder.Name()), func(t *testing.T) {
					serializedBytes, err := util.BazelFileBytes(innerTestsFolderPath, innerFolder.Name(), "serialized.ssz_snappy")
					require.NoError(t, err)
					serializedSSZ, err := snappy.Decode(nil /* dst */, serializedBytes)
					require.NoError(t, err, "Failed to decompress")
					object, err := unmarshaller(t, serializedSSZ, folder.Name())
					require.NoError(t, err, "Could not unmarshall serialized SSZ")

					rootsYamlFile, err := util.BazelFileBytes(innerTestsFolderPath, innerFolder.Name(), "roots.yaml")
					require.NoError(t, err)
					rootsYaml := &SSZRoots{}
					require.NoError(t, utils.UnmarshalYaml(rootsYamlFile, rootsYaml), "Failed to Unmarshal")

					// All types support fastssz generated code, but may also include a custom HTR method.
					var htrs []HTR
					htrs = append(htrs, func(s interface{}) ([32]byte, error) {
						sszObj, ok := s.(fssz.HashRoot)
						if !ok {
							return [32]byte{}, errors.New("could not get hash root, not compatible object")
						}
						return sszObj.HashTreeRoot()
					})

					// Apply custom HTR methods, if any.
					if customHtr != nil {
						htrs = customHtr(t, htrs, object)
					}

					if len(htrs) == 0 {
						t.Fatal("no HTRs to run")
					}

					for i, htr := range htrs {
						var testName string
						if i == 0 { // First HTR test is fastssz generated code.
							testName = "fastssz"
						} else {
							testName = "custom"
						}
						t.Run(testName, func(t *testing.T) {
							root, err := htr(object)
							require.NoError(t, err)
							rootBytes, err := hex.DecodeString(rootsYaml.Root[2:])
							require.NoError(t, err)
							require.DeepEqual(t, rootBytes, root[:], "Did not receive expected hash tree root")

							if rootsYaml.SigningRoot == "" {
								return
							}

							var signingRoot [32]byte
							if v, ok := object.(fssz.HashRoot); ok {
								signingRoot, err = v.HashTreeRoot()
							} else {
								t.Fatal("object does not meet fssz.HashRoot")
							}

							require.NoError(t, err)
							signingRootBytes, err := hex.DecodeString(rootsYaml.SigningRoot[2:])
							require.NoError(t, err)
							require.DeepEqual(t, signingRootBytes, signingRoot[:], "Did not receive expected signing root")
						})
					}
				})
			}
		}
	}
}