Fix SSZ Compatibility Test

proto/beacon/p2p/v1/types.proto

@@ -33,7 +33,7 @@ message BeaconState {
   repeated bytes compact_committees_roots = 5004 [(gogoproto.moretags) = "ssz-size:\"65536,32\""];
 
   // Slashings [6001-7000]
-  repeated uint64 slashings = 6001 [(gogoproto.moretags) = "ssz:\"size=8192\""];
+  repeated uint64 slashings = 6001 [(gogoproto.moretags) = "ssz-size:\"8192\""];
 
   // Attestations [7001-8000]
   repeated PendingAttestation previous_epoch_attestations = 7001 [(gogoproto.moretags) = "ssz-max:\"8192\""];
@@ -45,7 +45,7 @@ message BeaconState {
 
   // Finality [9001-10000]
   // Spec type [4]Bitvector which means this would be a fixed size of 4 bits.
-  bytes justification_bits = 9001 [(gogoproto.casttype) = "github.com/prysmaticlabs/go-bitfield.Bitvector4"];
+  bytes justification_bits = 9001 [(gogoproto.moretags) = "ssz-size:\"1\"", (gogoproto.casttype) = "github.com/prysmaticlabs/go-bitfield.Bitvector4"];
   Checkpoint previous_justified_checkpoint = 9002;
   Checkpoint current_justified_checkpoint = 9003;
   Checkpoint finalized_checkpoint = 9004;
@@ -296,5 +296,5 @@ message CompactCommittee {
   // The list of the validator public keys in the committee.
   repeated bytes pubkeys = 1 [(gogoproto.moretags) = "ssz-size:\"?,48\" ssz-max:\"4096\""];
   // The list of the validator indices in the committee.
-  repeated uint64 compact_validators = 2 [(gogoproto.moretags) = "ssz-size:\"4096\""];
+  repeated uint64 compact_validators = 2 [(gogoproto.moretags) = "ssz-max:\"4096\""];
 }

proto/testing/BUILD.bazel

@@ -21,7 +21,7 @@ go_proto_library(
 go_library(
     name = "go_default_library",
     testonly = True,
-    srcs = ["ssz_minimal.yaml.go"],
+    srcs = ["ssz_protobuf.yaml.go"],
     embed = [":ethereum_testing_go_proto"],
     importpath = "github.com/prysmaticlabs/prysm/proto/testing",
     visibility = ["//visibility:public"],
@@ -42,10 +42,10 @@ go_test(
     tags = ["spectest"],
     deps = [
         "//proto/beacon/p2p/v1:go_default_library",
-        "//shared/params/spectest:go_default_library",
         "//shared/testutil:go_default_library",
         "@com_github_ghodss_yaml//:go_default_library",
         "@com_github_prysmaticlabs_go_ssz//:go_default_library",
+        "@com_github_prysmaticlabs_go_ssz//spectests:go_default_library",
         "@io_bazel_rules_go//go/tools/bazel:go_default_library",
     ],
 )

proto/testing/ssz_compatibility_test.go

@@ -3,38 +3,44 @@ package testing
 import (
 	"bytes"
 	"io/ioutil"
-	"reflect"
+	"path"
 	"testing"
 
 	"github.com/bazelbuild/rules_go/go/tools/bazel"
 	"github.com/ghodss/yaml"
 	"github.com/prysmaticlabs/go-ssz"
+	sszspectest "github.com/prysmaticlabs/go-ssz/spectests"
 	pb "github.com/prysmaticlabs/prysm/proto/beacon/p2p/v1"
-	"github.com/prysmaticlabs/prysm/shared/params/spectest"
 	"github.com/prysmaticlabs/prysm/shared/testutil"
 )
 
-func TestMainnetRandomYaml(t *testing.T) {
-	filepath, err := bazel.Runfile("/eth2_spec_tests/tests/ssz_static/core/ssz_mainnet_random.yaml")
-	if err != nil {
-		t.Fatal(err)
-	}
-	file, err := ioutil.ReadFile(filepath)
-	if err != nil {
-		t.Fatalf("Could not load file %v", err)
-	}
-
-	s := &SszMinimalTest{}
-	if err := yaml.Unmarshal(file, s); err != nil {
-		t.Fatalf("Failed to unmarshal: %v", err)
+func TestYamlStatic(t *testing.T) {
+	topPath := "/eth2_spec_tests/tests/ssz_static/core/"
+	yamlFileNames := []string{
+		"ssz_mainnet_random.yaml",
 	}
 
-	if err := spectest.SetConfig(s.Config); err != nil {
-		t.Fatal(err)
+	for _, f := range yamlFileNames {
+		fullPath := path.Join(topPath, f)
+		filepath, err := bazel.Runfile(fullPath)
+		if err != nil {
+			t.Fatal(err)
+		}
+		file, err := ioutil.ReadFile(filepath)
+		if err != nil {
+			t.Fatalf("Could not load file %v", err)
+		}
+		s := &sszspectest.SszMainnetTest{}
+		if err := yaml.Unmarshal(file, s); err != nil {
+			t.Fatalf("Failed to unmarshal: %v", err)
+		}
+		runTestCases(t, s)
 	}
+}
 
+func runTestCases(t *testing.T, s *sszspectest.SszMainnetTest) {
 	for _, testCase := range s.TestCases {
-		if !isEmpty(testCase.Attestation.Value) {
+		if !testutil.IsEmpty(testCase.Attestation.Value) {
 			p := &pb.Attestation{}
 			if err := testutil.ConvertToPb(testCase.Attestation.Value, p); err != nil {
 				t.Fatal(err)
@@ -47,7 +53,7 @@ func TestMainnetRandomYaml(t *testing.T) {
 				t.Errorf("Expected attestation %#x, received %#x", testCase.Attestation.Root, root[:])
 			}
 		}
-		if !isEmpty(testCase.AttestationData.Value) {
+		if !testutil.IsEmpty(testCase.AttestationData.Value) {
 			p := &pb.AttestationData{}
 			if err := testutil.ConvertToPb(testCase.AttestationData.Value, p); err != nil {
 				t.Fatal(err)
@@ -60,7 +66,7 @@ func TestMainnetRandomYaml(t *testing.T) {
 				t.Errorf("Expected attestation data %#x, received %#x", testCase.AttestationData.Root, root[:])
 			}
 		}
-		if !isEmpty(testCase.AttestationDataAndCustodyBit.Value) {
+		if !testutil.IsEmpty(testCase.AttestationDataAndCustodyBit.Value) {
 			p := &pb.AttestationDataAndCustodyBit{}
 			if err := testutil.ConvertToPb(testCase.AttestationDataAndCustodyBit.Value, p); err != nil {
 				t.Fatal(err)
@@ -73,7 +79,7 @@ func TestMainnetRandomYaml(t *testing.T) {
 				t.Errorf("Expected attestation data and custody bit %#x, received %#x", testCase.AttestationDataAndCustodyBit.Root, root[:])
 			}
 		}
-		if !isEmpty(testCase.AttesterSlashing.Value) {
+		if !testutil.IsEmpty(testCase.AttesterSlashing.Value) {
 			p := &pb.AttesterSlashing{}
 			if err := testutil.ConvertToPb(testCase.AttesterSlashing.Value, p); err != nil {
 				t.Fatal(err)
@@ -86,7 +92,7 @@ func TestMainnetRandomYaml(t *testing.T) {
 				t.Errorf("Expected attester slashing bit %#x, received %#x", testCase.AttesterSlashing.Root, root[:])
 			}
 		}
-		if !isEmpty(testCase.BeaconBlock.Value) {
+		if !testutil.IsEmpty(testCase.BeaconBlock.Value) {
 			p := &pb.BeaconBlock{}
 			if err := testutil.ConvertToPb(testCase.BeaconBlock.Value, p); err != nil {
 				t.Fatal(err)
@@ -99,7 +105,7 @@ func TestMainnetRandomYaml(t *testing.T) {
 				t.Errorf("Expected beacon block %#x, received %#x", testCase.BeaconBlock.Root, root[:])
 			}
 		}
-		if !isEmpty(testCase.BeaconBlockBody.Value) {
+		if !testutil.IsEmpty(testCase.BeaconBlockBody.Value) {
 			p := &pb.BeaconBlockBody{}
 			if err := testutil.ConvertToPb(testCase.BeaconBlockBody.Value, p); err != nil {
 				t.Fatal(err)
@@ -112,7 +118,7 @@ func TestMainnetRandomYaml(t *testing.T) {
 				t.Errorf("Expected beacon block body %#x, received %#x", testCase.BeaconBlockBody.Root, root[:])
 			}
 		}
-		if !isEmpty(testCase.BeaconBlockHeader.Value) {
+		if !testutil.IsEmpty(testCase.BeaconBlockHeader.Value) {
 			p := &pb.BeaconBlockHeader{}
 			if err := testutil.ConvertToPb(testCase.BeaconBlockHeader.Value, p); err != nil {
 				t.Fatal(err)
@@ -125,7 +131,7 @@ func TestMainnetRandomYaml(t *testing.T) {
 				t.Errorf("Expected beacon block header %#x, received %#x", testCase.BeaconBlockHeader.Root, root[:])
 			}
 		}
-		if !isEmpty(testCase.BeaconState.Value) {
+		if !testutil.IsEmpty(testCase.BeaconState.Value) {
 			p := &pb.BeaconState{}
 			if err := testutil.ConvertToPb(testCase.BeaconState.Value, p); err != nil {
 				t.Fatal(err)
@@ -138,7 +144,7 @@ func TestMainnetRandomYaml(t *testing.T) {
 				t.Errorf("Expected beacon state %#x, received %#x", testCase.BeaconState.Root, root[:])
 			}
 		}
-		if !isEmpty(testCase.Crosslink.Value) {
+		if !testutil.IsEmpty(testCase.Crosslink.Value) {
 			c := &pb.Crosslink{}
 			if err := testutil.ConvertToPb(testCase.Crosslink.Value, c); err != nil {
 				t.Fatal(err)
@@ -151,7 +157,7 @@ func TestMainnetRandomYaml(t *testing.T) {
 				t.Errorf("Expected crosslink %#x, received %#x", testCase.Crosslink.Root, root[:])
 			}
 		}
-		if !isEmpty(testCase.Deposit.Value) {
+		if !testutil.IsEmpty(testCase.Deposit.Value) {
 			p := &pb.Deposit{}
 			if err := testutil.ConvertToPb(testCase.Deposit.Value, p); err != nil {
 				t.Fatal(err)
@@ -164,7 +170,7 @@ func TestMainnetRandomYaml(t *testing.T) {
 				t.Errorf("Expected deposit root %#x, received %#x", testCase.Deposit.Root, root[:])
 			}
 		}
-		if !isEmpty(testCase.DepositData.Value) {
+		if !testutil.IsEmpty(testCase.DepositData.Value) {
 			p := &pb.DepositData{}
 			if err := testutil.ConvertToPb(testCase.DepositData.Value, p); err != nil {
 				t.Fatal(err)
@@ -177,7 +183,7 @@ func TestMainnetRandomYaml(t *testing.T) {
 				t.Errorf("Expected deposit data %#x, received %#x", testCase.DepositData.Root, root[:])
 			}
 		}
-		if !isEmpty(testCase.Eth1Data.Value) {
+		if !testutil.IsEmpty(testCase.Eth1Data.Value) {
 			p := &pb.Eth1Data{}
 			if err := testutil.ConvertToPb(testCase.Eth1Data.Value, p); err != nil {
 				t.Fatal(err)
@@ -190,7 +196,7 @@ func TestMainnetRandomYaml(t *testing.T) {
 				t.Errorf("Expected eth1 data %#x, received %#x", testCase.Eth1Data.Root, root[:])
 			}
 		}
-		if !isEmpty(testCase.Fork.Value) {
+		if !testutil.IsEmpty(testCase.Fork.Value) {
 			p := &pb.Fork{}
 			if err := testutil.ConvertToPb(testCase.Fork.Value, p); err != nil {
 				t.Fatal(err)
@@ -203,7 +209,7 @@ func TestMainnetRandomYaml(t *testing.T) {
 				t.Errorf("Expected fork %#x, received %#x", testCase.Fork.Root, root[:])
 			}
 		}
-		if !isEmpty(testCase.HistoricalBatch.Value) {
+		if !testutil.IsEmpty(testCase.HistoricalBatch.Value) {
 			p := &pb.HistoricalBatch{}
 			if err := testutil.ConvertToPb(testCase.HistoricalBatch.Value, p); err != nil {
 				t.Fatal(err)
@@ -216,7 +222,7 @@ func TestMainnetRandomYaml(t *testing.T) {
 				t.Errorf("Expected historical batch %#x, received %#x", testCase.HistoricalBatch.Root, root[:])
 			}
 		}
-		if !isEmpty(testCase.IndexedAttestation.Value) {
+		if !testutil.IsEmpty(testCase.IndexedAttestation.Value) {
 			p := &pb.IndexedAttestation{}
 			if err := testutil.ConvertToPb(testCase.IndexedAttestation.Value, p); err != nil {
 				t.Fatal(err)
@@ -229,7 +235,7 @@ func TestMainnetRandomYaml(t *testing.T) {
 				t.Errorf("Expected indexed attestation %#x, received %#x", testCase.IndexedAttestation.Root, root[:])
 			}
 		}
-		if !isEmpty(testCase.PendingAttestation.Value) {
+		if !testutil.IsEmpty(testCase.PendingAttestation.Value) {
 			p := &pb.PendingAttestation{}
 			if err := testutil.ConvertToPb(testCase.PendingAttestation.Value, p); err != nil {
 				t.Fatal(err)
@@ -242,7 +248,7 @@ func TestMainnetRandomYaml(t *testing.T) {
 				t.Errorf("Expected pending attestation %#x, received %#x", testCase.PendingAttestation.Root, root[:])
 			}
 		}
-		if !isEmpty(testCase.ProposerSlashing.Value) {
+		if !testutil.IsEmpty(testCase.ProposerSlashing.Value) {
 			p := &pb.ProposerSlashing{}
 			if err := testutil.ConvertToPb(testCase.ProposerSlashing.Value, p); err != nil {
 				t.Fatal(err)
@@ -255,7 +261,7 @@ func TestMainnetRandomYaml(t *testing.T) {
 				t.Errorf("Expected proposer slashing %#x, received %#x", testCase.ProposerSlashing.Root, root[:])
 			}
 		}
-		if !isEmpty(testCase.Transfer.Value) {
+		if !testutil.IsEmpty(testCase.Transfer.Value) {
 			p := &pb.Transfer{}
 			if err := testutil.ConvertToPb(testCase.Transfer.Value, p); err != nil {
 				t.Fatal(err)
@@ -268,7 +274,7 @@ func TestMainnetRandomYaml(t *testing.T) {
 				t.Errorf("Expected trasnfer %#x, received %#x", testCase.Transfer.Root, root[:])
 			}
 		}
-		if !isEmpty(testCase.Validator.Value) {
+		if !testutil.IsEmpty(testCase.Validator.Value) {
 			p := &pb.Validator{}
 			if err := testutil.ConvertToPb(testCase.Validator.Value, p); err != nil {
 				t.Fatal(err)
@@ -281,7 +287,7 @@ func TestMainnetRandomYaml(t *testing.T) {
 				t.Errorf("Expected trasnfer %#x, received %#x", testCase.Validator.Root, root[:])
 			}
 		}
-		if !isEmpty(testCase.VoluntaryExit.Value) {
+		if !testutil.IsEmpty(testCase.VoluntaryExit.Value) {
 			p := &pb.VoluntaryExit{}
 			if err := testutil.ConvertToPb(testCase.VoluntaryExit.Value, p); err != nil {
 				t.Fatal(err)
@@ -296,13 +302,3 @@ func TestMainnetRandomYaml(t *testing.T) {
 		}
 	}
 }
-
-func isEmpty(item interface{}) bool {
-	val := reflect.ValueOf(item)
-	for i := 0; i < val.NumField(); i++ {
-		if !reflect.DeepEqual(val.Field(i).Interface(), reflect.Zero(val.Field(i).Type()).Interface()) {
-			return false
-		}
-	}
-	return true
-}

proto/testing/tags_test.go

@@ -54,9 +54,9 @@ func sszTagSizes(i interface{}, fName string) ([]int, error) {
 	if !exists {
 		return nil, errors.New("wanted field does not exist")
 	}
-	tag, exists := field.Tag.Lookup("ssz")
+	tag, exists := field.Tag.Lookup("ssz-size")
 	if !exists {
-		return nil, errors.New("wanted field does not contain ssz tag")
+		return nil, errors.New("wanted field does not contain ssz-size tag")
 	}
 	start := strings.IndexRune(tag, '=')
 	items := strings.Split(tag[start+1:], ",")

shared/testutil/BUILD.bazel

@@ -6,6 +6,7 @@ go_library(
     srcs = [
         "checkbit.go",
         "helpers.go",
+        "is_empty.go",
         "json_to_pb_converter.go",
         "log.go",
         "tempdir.go",

shared/testutil/is_empty.go

@@ -0,0 +1,14 @@
+package testutil
+
+import "reflect"
+
+// IsEmpty returns true if the struct is empty.
+func IsEmpty(item interface{}) bool {
+	val := reflect.ValueOf(item)
+	for i := 0; i < val.NumField(); i++ {
+		if !reflect.DeepEqual(val.Field(i).Interface(), reflect.Zero(val.Field(i).Type()).Interface()) {
+			return false
+		}
+	}
+	return true
+}