Fix -validate and add -name flags (#176)

* main: Add -name flag

This flag allows selecting a subset of benchmarks to run when generating
the report or validating benchmarks.

This is useful during development in order to verify only newly added
benchmarks as opposed to all benchmarks.

* main: Verify benchmark finished when validating

Unfortunately, benchmarks ran with testing.Benchmark() do not return an
error, panic or otherwise make their calling goroutine exit early in
order to signal failure.

This could cause validation errors to be silently ignored when running
with -validate specified.

This commit addresses this issue by using a flag to detect when the test
was prematurely finished to report it as an error, with a message for
the user to re-run the test in a way that can actually report the error.

* goserbench: Add validation for Money field

This validation was missing from the code.

Author: matheusd

benchmark.go

@@ -6,6 +6,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"os"
+	"regexp"
 	"strings"
 	"testing"
 
@@ -35,19 +36,32 @@ type reportLine struct {
 	Notes                 string `json:"notes"`
 }
 
-func BenchAndReportSerializers(generateReport bool, validate bool) error {
+func BenchAndReportSerializers(generateReport bool, validate bool, namesRe *regexp.Regexp) error {
 	data := make([]reportLine, len(benchmarkCases))
 	for i, bench := range benchmarkCases {
+		if namesRe != nil && !namesRe.MatchString(bench.Name) {
+			continue
+		}
+
 		marshalRes := testing.Benchmark(func(b *testing.B) {
 			goserbench.BenchMarshalSmallStruct(b, bench.New())
 		})
 		fmt.Printf("%10s -   Marshal - %s %s\n", bench.Name, marshalRes.String(),
 			marshalRes.MemString())
+
+		unmarshalOk := false
 		unmarshalRes := testing.Benchmark(func(b *testing.B) {
 			goserbench.BenchUnmarshalSmallStruct(b, bench.New(), validate)
+			unmarshalOk = true
 		})
-		fmt.Printf("%10s - Unmarshal - %s %s\n", bench.Name, unmarshalRes.String(),
-			unmarshalRes.MemString())
+		if !unmarshalOk {
+			fmt.Printf("\nUnmarshal benchmark of %q did not complete successfully\n", bench.Name)
+			fmt.Printf("Test with go test -validate -run Bench -bench BenchmarkSerializers/unmarshal/%s\n\n", bench.Name)
+			return fmt.Errorf("benchmark %s failed", bench.Name)
+		} else {
+			fmt.Printf("%10s - Unmarshal - %s %s\n", bench.Name, unmarshalRes.String(),
+				unmarshalRes.MemString())
+		}
 
 		data[i] = reportLine{
 			Name:                  bench.Name,

genreport_test.go

@@ -6,6 +6,8 @@ package main
 
 import (
 	"fmt"
+	"os"
+	"regexp"
 	"testing"
 )
 
@@ -19,7 +21,17 @@ Re-Generating Report = true
 
 `, *validate)
 
-	err := BenchAndReportSerializers(true, *validate)
+	var nameRe *regexp.Regexp
+	if *nameFlag != "" {
+		var err error
+		nameRe, err = regexp.Compile(*nameFlag)
+		if err != nil {
+			fmt.Printf("Error compiling -name regexp: %v\n", err)
+			os.Exit(1)
+		}
+	}
+
+	err := BenchAndReportSerializers(true, *validate, nameRe)
 	if err != nil {
 		t.Fatal(err)
 	}

goserbench/goserbench.go

@@ -139,6 +139,9 @@ func BenchUnmarshalSmallStruct(b *testing.B, s Serializer, validate bool) {
 			if !o.BirthDay.Equal(i.BirthDay) {
 				b.Fatalf("wrong birthday: got %v, want %v", o.BirthDay, i.BirthDay)
 			}
+			if o.Money != i.Money {
+				b.Fatalf("wrong money: got %v, want %v", o.Money, i.Money)
+			}
 		}
 	}
 }

main.go

@@ -3,11 +3,15 @@ package main
 import (
 	"flag"
 	"fmt"
+	"os"
+	"regexp"
+	"testing"
 )
 
 var (
 	validate  = flag.Bool("validate", false, "to validate the correctness of the serializers")
 	genReport = flag.Bool("genreport", false, "to re-generate the report")
+	nameFlag  = flag.String("name", "", "restrict benchmarks to run only if they match this regexp")
 )
 
 func main() {
@@ -22,7 +26,21 @@ Re-Generating Report = %t
 
 `, *validate, *genReport)
 
-	err := BenchAndReportSerializers(*genReport, *validate)
+	var nameRe *regexp.Regexp
+	if *nameFlag != "" {
+		var err error
+		nameRe, err = regexp.Compile(*nameFlag)
+		if err != nil {
+			fmt.Printf("Error compiling -name regexp: %v\n", err)
+			os.Exit(1)
+		}
+	}
+
+	// Manually call testing.Init(), otherwise validation errors may cause
+	// internal panics.
+	testing.Init()
+
+	err := BenchAndReportSerializers(*genReport, *validate, nameRe)
 	if err != nil {
 		panic(err)
 	}