MINOR: automatic unit tests generation

temp

temp2

Author: ivanmatmati

.gitlab-ci.yml

@@ -78,10 +78,17 @@ generate:
   tags:
     - go
   before_script:
-    - find -maxdepth 1 -type f -name "*.go" -exec rm {} \;
+    - find models -maxdepth 1 -type f -name "*.go" -exec rm {} \;
     - make models
   script:
-    - test -z "$(git diff 2> /dev/null)" || exit "Models are not generated, issue \`make models\` and commit the result"
+    - |
+      # Check for unstaged changes
+      if ! git diff --quiet 2>/dev/null; then
+          echo "Diff output:"
+          git diff
+          echo "Models are not generated. Please run \`make models\` and commit the result."
+          exit 1
+      fi
     - test -z "$(git ls-files --others --exclude-standard 2> /dev/null)" || exit "Models generation created untracked files, cannot proceed"
   rules:
     - if: $CI_PIPELINE_SOURCE == 'merge_request_event'

.golangci.yml

@@ -38,7 +38,8 @@ linters:
     - gci
     - goconst
     - recvcheck
-    - tenv  # deprecated
+    - tenv # deprecated
+    - gocritic
 
 issues:
   exclude-files:

Makefile

@@ -33,22 +33,13 @@ spec:
 	go run cmd/specification/*.go -file specification/haproxy-spec.yaml > specification/build/haproxy_spec.yaml
 
 .PHONY: models
-models: gentypes spec swagger-check
-	./bin/swagger generate model --additional-initialism=FCGI -f ${PROJECT_PATH}/specification/build/haproxy_spec.yaml -r ${PROJECT_PATH}/specification/copyright.txt -m models -t ${PROJECT_PATH}
-	rm -rf models/server_params_prepare_for_runtime.go
-	rm -rf models/*_compare.go
-	rm -rf models/*_compare_test.go
-	go run cmd/struct_equal_generator/*.go -l ${PROJECT_PATH}/specification/copyright.txt ${PROJECT_PATH}/models
-	go run cmd/struct_tags_checker/*.go ${PROJECT_PATH}/models
-	go run cmd/kubebuilder_marker_generator/*.go  ${PROJECT_PATH}/models
-	go run cmd/server_params_runtime/*.go ${PROJECT_PATH}/models
-
-.PHONY: models-with-go-method-gen
-models-with-go-method-gen: gentypes spec go-method-gen-check
+models:  gentypes spec swagger-check go-method-gen-check
 	./bin/swagger generate model --additional-initialism=FCGI -f ${PROJECT_PATH}/specification/build/haproxy_spec.yaml -r ${PROJECT_PATH}/specification/copyright.txt -m models -t ${PROJECT_PATH}
 	rm -rf models/server_params_prepare_for_runtime.go
 	rm -rf models/*_generated*.go
+	rm -rf models/*_compare_test.go
 	./bin/go-method-gen --header-file=specification/copyright.txt --scan=models --debug --overrides=models/funcs/overrides.yaml && find ./generated -name "*.go" -exec cp {} ./models \; && rm -rf generated
+	go run cmd/struct_equal_generator/*.go -l ${PROJECT_PATH}/specification/copyright.txt ${PROJECT_PATH}/models
 	go run cmd/struct_tags_checker/*.go ${PROJECT_PATH}/models
 	go run cmd/kubebuilder_marker_generator/*.go  ${PROJECT_PATH}/models
 	go run cmd/server_params_runtime/*.go ${PROJECT_PATH}/models

cmd/struct_equal_generator/embed.go

@@ -7,8 +7,5 @@ import (
 //go:embed header.tmpl
 var tmplHeader string
 
-//go:embed generate.tmpl
-var tmplEqualAndDiff string
-
 //go:embed test.tmpl
 var tmplCompareTest string

cmd/struct_equal_generator/generate.go

@@ -6,49 +6,6 @@ import (
 )
 
 func generateEqualAndDiff(opt generateEqualAndDiffOptions) error {
-	funcMaps := template.FuncMap{
-		"HasPrefix":  strings.HasPrefix,
-		"TrimPrefix": strings.TrimPrefix,
-		"Title":      toTitle,
-		"CamelCase":  toCamelCase,
-		"LowerCase":  toLowerCase,
-		"JSON":       toJSON,
-	}
-	tmpl, err := template.New("generate.tmpl").Funcs(funcMaps).Parse(tmplEqualAndDiff)
-	if err != nil {
-		return err
-	}
-
-	data := map[string]interface{}{
-		"Mode":              opt.Mode,
-		"Name":              opt.Name,
-		"Type":              opt.Type,
-		"Fields":            opt.Fields,
-		"NeedsOptions":      opt.NeedsOptions,
-		"NeedsOptionsIndex": opt.NeedsOptionsIndex,
-		"IsBasicType":       opt.IsBasicType,
-		"IsComplex":         opt.IsComplex,
-		"IsComparable":      opt.IsComparable,
-		"IsPointer":         opt.IsPointer,
-	}
-
-	functions := map[string]interface{}{
-		"Functions": []interface{}{
-			map[string]interface{}{
-				"Name": "Equal",
-				"Data": data,
-			},
-			map[string]interface{}{
-				"Name": "Diff",
-				"Data": data,
-			},
-		},
-	}
-
-	err = tmpl.Execute(opt.File, functions)
-	if err != nil {
-		return err
-	}
 	return generateCompareTests(opt)
 }
 

cmd/struct_equal_generator/main.go

@@ -71,7 +71,7 @@ func scanAllTypes(fileName string) []string {
 	return typesInFile
 }
 
-func generate(fileName string, args Args) (string, error) { //nolint:gocognit,maintidx
+func generate(fileName string, args Args) (string, error) { //nolint:gocognit
 	fset := token.NewFileSet()
 	var packageName string
 
@@ -81,43 +81,19 @@ func generate(fileName string, args Args) (string, error) { //nolint:gocognit,ma
 	}
 	sourceOfFile = string(src)
 
-	// node, err := parser.ParseFile(fset, fileName, nil, parser.ParseComments)
 	node, err := parser.ParseFile(fset, "", src, 0)
 	if err != nil {
 		return packageName, err
 	}
-	generatedFileName := strings.TrimSuffix(fileName, ".go") + "_compare.go"
 	generatedFileNameTest := strings.TrimSuffix(fileName, ".go") + "_compare_test.go"
 
-	_ = os.Truncate(generatedFileName, 0)
-	file, err := os.OpenFile(generatedFileName, os.O_CREATE|os.O_WRONLY, 0o600)
-	if err != nil {
-		return packageName, err
-	}
-	defer file.Close()
-
 	_ = os.Truncate(generatedFileNameTest, 0)
 	fileTest, err := os.OpenFile(generatedFileNameTest, os.O_CREATE|os.O_WRONLY, 0o600)
 	if err != nil {
 		return packageName, err
 	}
 	defer fileTest.Close()
 
-	// Adding the header to the generated file
-	tmpl, err := template.New("generate.tmpl").Parse(tmplHeader)
-	// ParseFiles(path.Join(templatePath))
-	if err != nil {
-		return packageName, err
-	}
-
-	err = tmpl.Execute(file, map[string]interface{}{
-		"Package": node.Name.String(),
-		"License": args.License,
-	})
-	if err != nil {
-		return packageName, err
-	}
-
 	// Adding the header to the generated file
 	tmpl2, err := template.New("generate.tmpl").Parse(tmplHeader)
 	// ParseFiles(path.Join(templatePath))
@@ -176,7 +152,6 @@ func generate(fileName string, args Args) (string, error) { //nolint:gocognit,ma
 				hasTests = true
 				err = generateEqualAndDiff(generateEqualAndDiffOptions{
 					PackageName:       packageName,
-					File:              file,
 					FileTest:          fileTest,
 					Name:              currSpecType.Name.Name,
 					CurrType:          currSpecType,
@@ -192,7 +167,6 @@ func generate(fileName string, args Args) (string, error) { //nolint:gocognit,ma
 				hasTests = true
 				err = generateEqualAndDiff(generateEqualAndDiffOptions{
 					PackageName:  packageName,
-					File:         file,
 					FileTest:     fileTest,
 					Name:         currSpecType.Name.Name,
 					NeedsOptions: false,
@@ -211,7 +185,6 @@ func generate(fileName string, args Args) (string, error) { //nolint:gocognit,ma
 				}
 				err = generateEqualAndDiff(generateEqualAndDiffOptions{
 					PackageName:       packageName,
-					File:              file,
 					FileTest:          fileTest,
 					Name:              currSpecType.Name.Name,
 					Type:              res.Name,
@@ -237,7 +210,6 @@ func generate(fileName string, args Args) (string, error) { //nolint:gocognit,ma
 				}
 				err = generateEqualAndDiff(generateEqualAndDiffOptions{
 					PackageName:       packageName,
-					File:              file,
 					FileTest:          fileTest,
 					Name:              currSpecType.Name.Name,
 					Type:              res.Name,
@@ -265,11 +237,6 @@ func generate(fileName string, args Args) (string, error) { //nolint:gocognit,ma
 	} else {
 		os.Remove(generatedFileNameTest)
 	}
-	// Format the file
-	err = fmtFile(generatedFileName)
-	if err != nil {
-		return packageName, err
-	}
 	return packageName, nil
 }
 

cmd/struct_equal_generator/misc.go

@@ -5,7 +5,6 @@ import (
 	"os"
 	"strings"
 
-	jsoniter "github.com/json-iterator/go"
 	"golang.org/x/text/cases"
 	"golang.org/x/text/language"
 )
@@ -28,7 +27,6 @@ type Field struct {
 }
 
 type generateEqualAndDiffOptions struct {
-	File              *os.File
 	FileTest          *os.File
 	CurrType          *ast.TypeSpec
 	PackageName       string
@@ -49,15 +47,6 @@ func toTitle(s string) string {
 	return caser.String(strings.TrimPrefix(s, "*"))
 }
 
-func toJSON(x any) string {
-	json := jsoniter.ConfigCompatibleWithStandardLibrary
-	b, err := json.Marshal(x)
-	if err != nil {
-		panic(err)
-	}
-	return string(b)
-}
-
 func toCamelCase(s string) string {
 	caser := cases.Title(language.Und)
 	var result string
@@ -72,20 +61,6 @@ func toCamelCase(s string) string {
 	return result
 }
 
-func toLowerCase(s string) string {
-	caser := cases.Lower(language.Und)
-	var result string
-	words := strings.Split(s, "_")
-
-	for _, word := range words {
-		result += caser.String(word)
-	}
-
-	result = strings.ToLower(result[:1]) + result[1:]
-
-	return result
-}
-
 // isComparable checks if a given type is comparable.
 // It takes in the name of the type as a string and returns a boolean value.
 func isComparable(typeName string) bool {

cmd/struct_equal_generator/test.tmpl

@@ -112,13 +112,14 @@ func Test{{$.Name}}{{.}}False(t *testing.T) {
 		{{- if eq $.FieldCount 0 }}
 		if len(result) == 0 {
 		{{- else  }}
+		listDiffFields := GetListOfDiffFields(result)
 			{{- if $.HasIndex }}
-				if len(result) != {{$.FieldCount}} -1 {
+		if len(result) != {{$.FieldCount}} -1 {
 			{{- else }}
-				if len(result) != {{$.FieldCount}} {
+		if len(listDiffFields) != {{$.FieldCount}} {
 			{{end -}}
 		{{end -}}
-		{{end -}}
+		{{end -}}		
 			json := jsoniter.ConfigCompatibleWithStandardLibrary
 			a, err := json.Marshal(&sample.a)
 			if err != nil {

cmd/struct_equal_generator/utils.tmpl

@@ -1,3 +1,13 @@
+
+
+import (
+	"fmt"
+	"reflect"
+	"strings"
+	"unicode"
+)
+
+
 var NilSameAsEmpty = true
 var SkipIndex = true
 
@@ -136,3 +146,68 @@ func equalMapStringMapSting(m1, m2 map[string]map[string]string, opt Options) bo
 	}
 	return true
 }
+
+
+func GetListOfFields(typ reflect.Type) []string {
+	if typ.Kind() != reflect.Struct {
+		return nil
+	}
+	var fields []string
+	for i := 0; i < typ.NumField(); i++ {
+		fieldName := typ.Field(i).Name
+		if fieldName == "Metadata" {
+			continue
+		}
+		fields = append(fields, typ.Field(i).Name)
+	}
+	return fields
+}
+
+func GetListOfDiffFields(diffs map[string][]interface{}) []string {
+	fields := make(map[string]struct{}, len(diffs))
+	for diff := range diffs {
+		var sb strings.Builder
+		for _, r := range diff {
+			if !(unicode.IsLetter(r) || unicode.IsNumber(r)) {
+				break
+			}
+			sb.WriteRune(r)
+		}
+		key := sb.String()
+		if key == "Metadata" {
+			continue
+		}
+		fields[key] = struct{}{}
+	}
+	result := make([]string, 0, len(fields))
+	for k := range fields {
+		result = append(result, k)
+	}
+	return result
+}
+
+func DiffFields(fields1, fields2 []string) ([]string, []string) {
+	var result1 []string
+	var result2 []string
+	for _, f1 := range fields1 {
+		if !contains(fields2, f1) {
+			result1 = append(result1, f1)
+		}
+	}
+	for _, f2 := range fields2 {
+		if !contains(fields1, f2) {
+			result2 = append(result2, f2)
+		}
+	}
+	return result1, result2
+
+}
+
+func contains(slice []string, item string) bool {
+	for _, s := range slice {
+		if s == item {
+			return true
+		}
+	}
+	return false
+}