TestGen generating performance comparative tests (#93)

Makefile

@@ -31,7 +31,7 @@ build: clean
 
 testgen:
 	@echo "Generating tests"
-	cd testgen/ && rm -f generated_*.go && go run *.go && mv generated_endtoend_*tests.go ../tests/endtoend/ && mv generated_validation_*_test.go ../internal/codegenerator/ && mv generated_function_code_*_test.go ../internal/codegenerator/
+	cd testgen/ && rm -f generated_*.go && go run *.go && mv generated_endtoend_*tests.go ../tests/endtoend/ && mv generated_validation_*_test.go ../internal/codegenerator/ && mv generated_function_code_*_test.go ../internal/codegenerator/ && mv generated_cmp_perf_*.go ../tests/cmpbenchtests/generated_tests/
 
 endtoendtests: build
 	@echo "Running endtoend tests"
@@ -41,7 +41,7 @@ endtoendtests: build
 
 cmpbenchtests: build
 	@echo "Running cmp bench tests"
-	rm -f tests/cmpbenchtests/generated_tests/*
+	rm -f tests/cmpbenchtests/generated_tests/valid*.go && rm -f tests/cmpbenchtests/generated_tests/types.go
 	cd tests/cmpbenchtests; go run .
 	$(VALIDGEN_BIN) tests/cmpbenchtests/generated_tests
 	go clean -testcache

testgen/cmp_perf_no_pointer_tests.tpl

@@ -0,0 +1,48 @@
+// Code generated by TestGen. DO NOT EDIT.
+
+package benchtests
+
+import (
+	"testing"
+
+	"github.com/go-playground/validator/v10"
+)
+
+{{range .Tests}}
+type ValidGen{{.TestName}}Struct struct {
+	Field {{.FieldType}} `valid:"{{.ValidGenTag}}"`
+}
+
+type Validator{{.TestName}}Struct struct {
+	Field {{.FieldType}} `validate:"{{.ValidatorTag}}"`
+}
+{{end}}
+
+{{range .Tests}}
+func BenchmarkValidGen{{.TestName}}(b *testing.B) {
+	data := &ValidGen{{.TestName}}Struct{
+		Field: {{.ValidInput}},
+	}
+
+	for b.Loop() {
+		if err := ValidGen{{.TestName}}StructValidate(data); len(err) > 0 {
+			b.FailNow()
+		}
+	}
+}
+
+func BenchmarkValidator{{.TestName}}(b *testing.B) {
+	var validate *validator.Validate
+
+	validate = validator.New(validator.WithRequiredStructEnabled())
+	data := &Validator{{.TestName}}Struct{
+		Field: {{.ValidInput}},
+	}
+
+	for b.Loop() {
+		if err := validate.Struct(data); err != nil {
+			b.FailNow()
+		}
+	}
+}
+{{end}}

testgen/cmp_perf_pointer_tests.tpl

@@ -0,0 +1,52 @@
+// Code generated by TestGen. DO NOT EDIT.
+
+package benchtests
+
+import (
+	"testing"
+
+	"github.com/go-playground/validator/v10"
+)
+
+{{range .Tests}}
+type ValidGen{{.TestName}}Struct struct {
+	Field {{.FieldType}} `valid:"{{.ValidGenTag}}"`
+}
+
+type Validator{{.TestName}}Struct struct {
+	Field {{.FieldType}} `validate:"{{.ValidatorTag}}"`
+}
+{{end}}
+
+{{range .Tests}}
+func BenchmarkValidGen{{.TestName}}(b *testing.B) {
+	var validInput {{.BasicType}} = {{.ValidInput}}
+	data := &ValidGen{{.TestName}}Struct{
+		Field: &validInput,
+	}
+
+	for b.Loop() {
+		if err := ValidGen{{.TestName}}StructValidate(data); len(err) > 0 {
+			b.FailNow()
+		}
+	}
+}
+
+func BenchmarkValidator{{.TestName}}(b *testing.B) {
+	var validate *validator.Validate
+
+	validate = validator.New(validator.WithRequiredStructEnabled())
+
+	var validInput {{.BasicType}} = {{.ValidInput}}
+
+	data := &Validator{{.TestName}}Struct{
+		Field: &validInput,
+	}
+
+	for b.Loop() {
+		if err := validate.Struct(data); err != nil {
+			b.FailNow()
+		}
+	}
+}
+{{end}}

testgen/generate_cmp_perf_tests.go

@@ -0,0 +1,124 @@
+package main
+
+import (
+	"bytes"
+	"fmt"
+	"go/format"
+	"log"
+	"os"
+	"strings"
+	"text/template"
+
+	"github.com/opencodeco/validgen/internal/common"
+	"golang.org/x/text/cases"
+	"golang.org/x/text/language"
+)
+
+type CmpBenchTests struct {
+	Tests []CmpBenchTest
+}
+
+type CmpBenchTest struct {
+	TestName     string
+	FieldType    string
+	BasicType    string
+	ValidGenTag  string
+	ValidatorTag string
+	ValidInput   string
+}
+
+func generateComparativePerformanceTests() {
+	generateComparativePerformanceTest("cmp_perf_no_pointer_tests.tpl", "generated_cmp_perf_no_pointer_test.go", false)
+	generateComparativePerformanceTest("cmp_perf_pointer_tests.tpl", "generated_cmp_perf_pointer_test.go", true)
+}
+
+func generateComparativePerformanceTest(tpl, dest string, pointer bool) {
+	log.Printf("Generating comparative performance tests file: tpl[%s] dest[%s] pointer[%v]\n", tpl, dest, pointer)
+
+	benchTests := CmpBenchTests{}
+
+	for _, typeVal := range typesValidation {
+		if typeVal.validatorTag == "" {
+			log.Printf("Skipping tag %s: go-validator tag not defined\n", typeVal.tag)
+			continue
+		}
+
+		for _, testCase := range typeVal.testCases {
+			if testCase.excludeIf&cmpBenchTests != 0 {
+				log.Printf("Skipping test: tag %s type %s\n", typeVal.tag, testCase.typeClass)
+				continue
+			}
+			if testCase.excludeIf&noPointer != 0 && !pointer {
+				log.Printf("Skipping no pointer: tag %s type %s\n", typeVal.tag, testCase.typeClass)
+				continue
+			}
+
+			normalizedType := testCase.typeClass
+			if pointer {
+				normalizedType = "*" + normalizedType
+			}
+
+			fTypes := common.HelperFromNormalizedToBasicTypes(normalizedType)
+			sNames := common.HelperFromNormalizedToStringNames(normalizedType)
+
+			for i := range fTypes {
+				validGenTag := typeVal.tag
+				if typeVal.argsCount != common.ZeroValue {
+					validGenTag += "=" + testCase.validation
+				}
+				goValidatorTag := typeVal.validatorTag
+				if typeVal.argsCount != common.ZeroValue {
+					goValidatorTag += "=" + testCase.validation
+				}
+				testName := cases.Title(language.Und).String(typeVal.tag) + sNames[i]
+
+				basicType, _ := strings.CutPrefix(fTypes[i], "*")
+
+				benchTests.Tests = append(benchTests.Tests, CmpBenchTest{
+					TestName:     testName,
+					FieldType:    fTypes[i],
+					BasicType:    basicType,
+					ValidGenTag:  validGenTag,
+					ValidatorTag: goValidatorTag,
+					ValidInput:   strings.ReplaceAll(testCase.validCase, "{{.BasicType}}", basicType),
+				})
+			}
+		}
+	}
+
+	log.Printf("%d test cases were generated\n", len(benchTests.Tests))
+
+	if err := benchTests.GenerateFile(tpl, dest); err != nil {
+		log.Fatalf("error generating comparative performance tests file %s", err)
+	}
+
+	log.Println("Generating done")
+}
+
+func (cbt *CmpBenchTests) GenerateFile(tplFile, output string) error {
+	tpl, err := os.ReadFile(tplFile)
+	if err != nil {
+		return fmt.Errorf("error reading %s: %s", tplFile, err)
+	}
+
+	tmpl, err := template.New("BenchTest").Parse(string(tpl))
+	if err != nil {
+		return fmt.Errorf("error parsing template %s: %s", tplFile, err)
+	}
+
+	code := new(bytes.Buffer)
+	if err := tmpl.Execute(code, cbt); err != nil {
+		return err
+	}
+
+	formattedCode, err := format.Source(code.Bytes())
+	if err != nil {
+		return err
+	}
+
+	if err := os.WriteFile(output, formattedCode, 0644); err != nil {
+		return err
+	}
+
+	return nil
+}

testgen/generate_function_code_tests.go

@@ -65,14 +65,9 @@ func generateFunctionCodeTestsFile(tpl, dest string, pointer bool) {
 		}
 
 		for _, toGenerate := range typeValidation.testCases {
-			// Default ("") gen no pointer and pointer test.
-			if toGenerate.generateFor != "" {
-				if toGenerate.generateFor == "pointer" && !pointer {
-					continue
-				}
-				if toGenerate.generateFor == "nopointer" && pointer {
-					continue
-				}
+			if toGenerate.excludeIf&noPointer != 0 && !pointer {
+				log.Printf("Skipping no pointer: tag %s type %s\n", typeValidation.tag, toGenerate.typeClass)
+				continue
 			}
 
 			normalizedType := toGenerate.typeClass

testgen/generate_tests.go

@@ -10,6 +10,7 @@ func main() {
 	generateValidationTypesEndToEndTests()
 	generateValidationCodeUnitTests()
 	generateFunctionCodeUnitTests()
+	generateComparativePerformanceTests()
 
 	fmt.Println("Generating done")
 }

testgen/generate_validation_code_tests.go

@@ -47,14 +47,9 @@ func generateValidationCodeTestsFile(tpl, dest string, pointer bool) {
 
 	for _, typeValidation := range typesValidation {
 		for _, toGenerate := range typeValidation.testCases {
-			// Default ("") gen no pointer and pointer test.
-			if toGenerate.generateFor != "" {
-				if toGenerate.generateFor == "pointer" && !pointer {
-					continue
-				}
-				if toGenerate.generateFor == "nopointer" && pointer {
-					continue
-				}
+			if toGenerate.excludeIf&noPointer != 0 && !pointer {
+				log.Printf("Skipping no pointer: tag %s type %s\n", typeValidation.tag, toGenerate.typeClass)
+				continue
 			}
 
 			normalizedType := toGenerate.typeClass

testgen/generate_validation_types_tests.go

@@ -52,15 +52,11 @@ func generateValidationTypesTestsFile(tpl, dest string, pointer bool) {
 			StructName: structName,
 		})
 		for _, toGenerate := range testCase.testCases {
-			// Default ("") gen no pointer and pointer test.
-			if toGenerate.generateFor != "" {
-				if toGenerate.generateFor == "pointer" && !pointer {
-					continue
-				}
-				if toGenerate.generateFor == "nopointer" && pointer {
-					continue
-				}
+			if toGenerate.excludeIf&noPointer != 0 && !pointer {
+				log.Printf("Skipping no pointer: tag %s type %s\n", testCase.tag, toGenerate.typeClass)
+				continue
 			}
+
 			normalizedType := toGenerate.typeClass
 			if pointer {
 				normalizedType = "*" + normalizedType