add protocol.TagList completeness check test

algorand · algorandskiy · Feb 1, 2023 · Aug 31, 2022 · Sep 8, 2022 · Sep 8, 2022
commit 5f0cd15f5751d5b1034b60c2d2d6020596232e98
diff --git a/network/wsPeer_test.go b/network/wsPeer_test.go
@@ -257,22 +257,18 @@ func getProtocolTags(t *testing.T) []string {
 	fset := token.NewFileSet()
 	f, _ := parser.ParseFile(fset, file, nil, parser.ParseComments)
 
+	// look for const declarations in protocol/tags.go
 	var declaredTags []string
 	for _, d := range f.Decls {
 		genDecl, ok := d.(*ast.GenDecl)
-		if !ok {
-			continue
-		}
-		if genDecl.Tok != token.CONST {
+		if !ok || genDecl.Tok != token.CONST {
 			continue
 		}
 		for _, spec := range genDecl.Specs {
-			valueSpec, ok := spec.(*ast.ValueSpec)
-			if !ok {
-				continue
-			}
-			for _, n := range valueSpec.Names {
-				declaredTags = append(declaredTags, n.Name)
+			if valueSpec, ok := spec.(*ast.ValueSpec); ok {
+				for _, n := range valueSpec.Names {
+					declaredTags = append(declaredTags, n.Name)
+				}
 			}
 		}
 	}

diff --git a/protocol/tags.go b/protocol/tags.go
@@ -43,7 +43,6 @@ const (
 )
 
 // TagList is a list of all currently used protocol tags.
-// TODO: generate this and/or have a test that it is complete.
 var TagList = []Tag{
 	AgreementVoteTag,
 	MsgOfInterestTag,

diff --git a/protocol/tags_test.go b/protocol/tags_test.go
@@ -0,0 +1,53 @@
+package protocol
+
+import (
+	"go/ast"
+	"go/parser"
+	"go/token"
+	"testing"
+
+	"github.com/stretchr/testify/require"
+)
+
+// TestTagList checks that the TagList global variable contains
+// all the constant Tag variables declared in tags.go.
+func TestTagList(t *testing.T) {
+	t.Parallel()
+
+	fset := token.NewFileSet()
+	f, err := parser.ParseFile(fset, "tags.go", nil, 0)
+	require.NoError(t, err)
+
+	var constTags []Tag
+	for _, d := range f.Decls {
+		gen, ok := d.(*ast.GenDecl)
+		if !ok || gen.Tok != token.CONST {
+			continue
+		}
+
+		for _, spec := range gen.Specs {
+			v, ok := spec.(*ast.ValueSpec)
+			if !ok {
+				continue
+			}
+			for _, expr := range v.Values {
+				val, ok := expr.(*ast.BasicLit)
+				if !ok {
+					continue
+				}
+				constTags = append(constTags, Tag(val.Value))
+			}
+		}
+	}
+	require.NotEmpty(t, TagList)
+	require.Len(t, TagList, len(constTags), "TagList is not complete")
+	tagMap := make(map[Tag]bool)
+	for _, tag := range TagList {
+		tagMap[tag] = true
+	}
+	for _, tag := range constTags {
+		if !tagMap[tag] {
+			t.Errorf("Tag %s is not in TagList", tag)
+		}
+	}
+}