tools: smoke test generating Go from JSON schemas

Use go-jsonschema to generate Go code from the JSON schemas. We
explicitly don't want to distribute that generated code, but it's
helpful to verify that at least one tool is able to do codegen without
error from the schema files.

By asserting that there are no warnings we also catch cases where
identical schema object names result in duplicate type definitions that
require clunky suffixing. This is a strong indicator there's schema
elements we should de-duplicate and catching these early helps make the
schemas _and_ the generated code better.

Author: cpu

.github/workflows/vectorlint.yml

@@ -42,3 +42,6 @@ jobs:
 
       - name: Run twistcheck
         run: go run ./tools/twistcheck
+
+      - name: Run schemagen
+        run: go run ./tools/schemagen

go.mod

@@ -1,10 +1,19 @@
 module github.com/c2sp/wycheproof
 
-go 1.23.6
+go 1.24.0
 
 require (
 	filippo.io/edwards25519 v1.1.0
 	github.com/santhosh-tekuri/jsonschema/v6 v6.0.1
 )
 
-require golang.org/x/text v0.14.0 // indirect
+require (
+	dario.cat/mergo v1.0.2 // indirect
+	github.com/atombender/go-jsonschema v0.22.0 // indirect
+	github.com/goccy/go-yaml v1.19.2 // indirect
+	github.com/google/go-cmp v0.7.0 // indirect
+	github.com/mitchellh/go-wordwrap v1.0.1 // indirect
+	github.com/sanity-io/litter v1.5.8 // indirect
+	github.com/sosodev/duration v1.3.1 // indirect
+	golang.org/x/text v0.14.0 // indirect
+)

go.sum

@@ -1,8 +1,25 @@
+dario.cat/mergo v1.0.2 h1:85+piFYR1tMbRrLcDwR18y4UKJ3aH1Tbzi24VRW1TK8=
+dario.cat/mergo v1.0.2/go.mod h1:E/hbnu0NxMFBjpMIE34DRGLWqDy0g5FuKDhCb31ngxA=
 filippo.io/edwards25519 v1.1.0 h1:FNf4tywRC1HmFuKW5xopWpigGjJKiJSV0Cqo0cJWDaA=
 filippo.io/edwards25519 v1.1.0/go.mod h1:BxyFTGdWcka3PhytdK4V28tE5sGfRvvvRV7EaN4VDT4=
+github.com/atombender/go-jsonschema v0.22.0 h1:7H48X5fUccsfsacar5UfP6nnOXuQzmnr6lQmH/Fj2pQ=
+github.com/atombender/go-jsonschema v0.22.0/go.mod h1:8Q281v0ozTIfvdnbwDoWQDIk0syH6F0Fpoq+Z1cs+rM=
+github.com/davecgh/go-spew v0.0.0-20161028175848-04cdfd42973b/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
 github.com/dlclark/regexp2 v1.11.0 h1:G/nrcoOa7ZXlpoa/91N3X7mM3r8eIlMBBJZvsz/mxKI=
 github.com/dlclark/regexp2 v1.11.0/go.mod h1:DHkYz0B9wPfa6wondMfaivmHpzrQ3v9q8cnmRbL6yW8=
+github.com/goccy/go-yaml v1.19.2 h1:PmFC1S6h8ljIz6gMRBopkjP1TVT7xuwrButHID66PoM=
+github.com/goccy/go-yaml v1.19.2/go.mod h1:XBurs7gK8ATbW4ZPGKgcbrY1Br56PdM69F7LkFRi1kA=
+github.com/google/go-cmp v0.7.0 h1:wk8382ETsv4JYUZwIsn6YpYiWiBsYLSJiTsyBybVuN8=
+github.com/google/go-cmp v0.7.0/go.mod h1:pXiqmnSA92OHEEa9HXL2W4E7lf9JzCmGVUdgjX3N/iU=
+github.com/mitchellh/go-wordwrap v1.0.1 h1:TLuKupo69TCn6TQSyGxwI1EblZZEsQ0vMlAFQflz0v0=
+github.com/mitchellh/go-wordwrap v1.0.1/go.mod h1:R62XHJLzvMFRBbcrT7m7WgmE1eOyTSsCt+hzestvNj0=
+github.com/pmezard/go-difflib v0.0.0-20151028094244-d8ed2627bdf0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/sanity-io/litter v1.5.8 h1:uM/2lKrWdGbRXDrIq08Lh9XtVYoeGtcQxk9rtQ7+rYg=
+github.com/sanity-io/litter v1.5.8/go.mod h1:9gzJgR2i4ZpjZHsKvUXIRQVk7P+yM3e+jAF7bU2UI5U=
 github.com/santhosh-tekuri/jsonschema/v6 v6.0.1 h1:PKK9DyHxif4LZo+uQSgXNqs0jj5+xZwwfKHgph2lxBw=
 github.com/santhosh-tekuri/jsonschema/v6 v6.0.1/go.mod h1:JXeL+ps8p7/KNMjDQk3TCwPpBy0wYklyWTfbkIzdIFU=
+github.com/sosodev/duration v1.3.1 h1:qtHBDMQ6lvMQsL15g4aopM4HEfOaYuhWBw3NPTtlqq4=
+github.com/sosodev/duration v1.3.1/go.mod h1:RQIBBX0+fMLc/D9+Jb/fwvVmo0eZvDDEERAikUR6SDg=
+github.com/stretchr/testify v0.0.0-20161117074351-18a02ba4a312/go.mod h1:a8OnRcib4nhh0OaRAV+Yts87kKdq0PP7pXfy6kDkUVs=
 golang.org/x/text v0.14.0 h1:ScX5w1eTa3QqT8oi6+ziP7dTV1S2+ALU0bI+0zXKWiQ=
 golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=

tools/schemagen/schemagen.go

@@ -0,0 +1,74 @@
+// schemagen is a smoke test that go-jsonschema is able to generate Go code
+// for the Wycheproof JSON schemas without any errors or warnings.
+//
+// In particular this is useful for catching cases where we are emitting
+// schema types with conflicting names as this is often a strong indicator
+// that there's commonality we can lift into a single shared definition.
+// Ignoring these warnings results in generated types with clunky numeric
+// suffixes (e.g. `SignatureTestCase` and `SignatureTestCase_1`)
+package main
+
+import (
+	"flag"
+	"log"
+	"os"
+	"path/filepath"
+
+	"github.com/atombender/go-jsonschema/pkg/generator"
+)
+
+var schemaDirectory = flag.String("schemas-dir", "schemas", "directory containing schema files")
+
+func main() {
+	flag.Parse()
+
+	var warnings []string
+
+	ouputName := "schema.go"
+	cfg := generator.Config{
+		DefaultPackageName: "wycheproof",
+		DefaultOutputName:  ouputName,
+		Tags:               []string{"json"},
+		Warner: func(message string) {
+			warnings = append(warnings, message)
+		},
+	}
+	gen, err := generator.New(cfg)
+	if err != nil {
+		log.Fatal(err)
+	}
+
+	entries, err := os.ReadDir(*schemaDirectory)
+	if err != nil {
+		log.Fatalf("reading schemas dir: %v", err)
+	}
+
+	for _, entry := range entries {
+		if entry.IsDir() {
+			continue
+		}
+		schemaFile := filepath.Join(*schemaDirectory, entry.Name())
+		err = gen.DoFile(schemaFile)
+		if err != nil {
+			log.Fatalf("processing %s: %v", schemaFile, err)
+		}
+	}
+
+	sources, err := gen.Sources()
+	if err != nil {
+		log.Fatalf("error generating sources: %v\n", err)
+	}
+	if sourceCount := len(sources); sourceCount != 1 {
+		log.Fatalf("expected to generate 1 source file, got %d\n", sourceCount)
+	}
+	_, ok := sources[ouputName]
+	if !ok {
+		log.Fatalf("missing generated %q output file source", ouputName)
+	}
+
+	for _, warning := range warnings {
+		log.Printf("⚠️ Warning: %s", warning)
+	}
+
+	os.Exit(len(warnings))
+}