Merge pull request #1440 from go-gorm/fix/issue-1115-unique-aware

feat: skip batch insert when unique index exists

Author: qqxhb

config.go

@@ -48,6 +48,8 @@ type Config struct {
 
 	Mode GenerateMode // generate mode
 
+	UnitTestTemplate string
+
 	queryPkgName   string // generated query code's package name
 	modelPkgPath   string // model pkg path in target project
 	dbNameOpts     []model.SchemaNameOpt

generator.go

@@ -475,7 +475,15 @@ func (g *Generator) generateQueryUnitTestFile(data *genInfo) (err error) {
 		return err
 	}
 
-	err = render(tmpl.CRUDMethodTest, &buf, data.QueryStructMeta)
+	crudTmpl := tmpl.CRUDMethodTest
+	if g.UnitTestTemplate != "" {
+		content, readErr := os.ReadFile(g.UnitTestTemplate)
+		if readErr != nil {
+			return readErr
+		}
+		crudTmpl = string(content)
+	}
+	err = render(crudTmpl, &buf, data.QueryStructMeta)
 	if err != nil {
 		return err
 	}

internal/generate/query.go

@@ -137,6 +137,18 @@ func (b *QueryStructMeta) appendOrUpdateField(f *model.Field) {
 
 func (b *QueryStructMeta) appendField(f *model.Field) { b.Fields = append(b.Fields, f) }
 
+func (b *QueryStructMeta) HasUniqueIndex() bool {
+	for _, f := range b.Fields {
+		if f == nil {
+			continue
+		}
+		if len(f.GORMTag[field.TagKeyGormUniqueIndex]) > 0 {
+			return true
+		}
+	}
+	return false
+}
+
 // HasField check if BaseStruct has fields
 func (b *QueryStructMeta) HasField() bool { return len(b.Fields) > 0 }
 

internal/template/method.go

@@ -308,11 +308,12 @@ func Test_{{.QueryStructName}}Query(t *testing.T) {
 		t.Error("create item in table <{{.TableName}}> fail:", err)
 	}
 
+{{ if not .HasUniqueIndex }}
 	err = _do.CreateInBatches([]*{{.StructInfo.Package}}.{{.ModelStructName}}{ {}, {} }, 10)
 	if err != nil {
 		t.Error("create item in table <{{.TableName}}> fail:", err)
 	}
-
+{{ end }}
 	_, err = _do.Select({{.QueryStructName}}.ALL).Take()
 	if err != nil {
 		t.Error("Take() on table <{{.TableName}}> fail:", err)

tools/gentool/README.ZH_CN.md

@@ -43,6 +43,8 @@
         only generate models (without query file)
   -withUnitTest
         generate unit test for query code
+  -unitTestTemplate string
+        custom unit test template file path for query code
   -fieldSignable
         detect integer field's unsigned type, adjust generated data type
 
@@ -126,6 +128,10 @@ eg :
 
 生成单元测试。
 
+#### unitTestTemplate
+
+自定义 query 单测模板文件路径
+
 #### fieldSignable
 
 Value : False / True

tools/gentool/README.md

@@ -41,6 +41,8 @@ Install GEN as a binary tool
         only generate models (without query file)
   -withUnitTest
         generate unit test for query code
+  -unitTestTemplate string
+        custom unit test template file path for query code
   -fieldSignable
         detect integer field's unsigned type, adjust generated data type
 
@@ -120,6 +122,10 @@ Value : False / True
 
 Generate unit test.
 
+#### unitTestTemplate
+
+custom unit test template file path for query code
+
 #### fieldSignable
 
 Value : False / True

tools/gentool/gen.yml

@@ -18,6 +18,7 @@ database:
   outFile :  ""
   # generate unit test for query code
   withUnitTest  : false
+  unitTestTemplate : ""
   # generated model code's package name
   modelPkgName  : ""
   # generate with pointer when field is nullable

tools/gentool/gentool.go

@@ -34,13 +34,14 @@ const (
 
 // CmdParams is command line parameters
 type CmdParams struct {
-	DSN                 string   `yaml:"dsn"`                 // consult[https://gorm.io/docs/connecting_to_the_database.html]"
-	DB                  string   `yaml:"db"`                  // input mysql or postgres or sqlite or sqlserver. consult[https://gorm.io/docs/connecting_to_the_database.html]
-	Tables              []string `yaml:"tables"`              // enter the required data table or leave it blank
-	OnlyModel           bool     `yaml:"onlyModel"`           // only generate model
-	OutPath             string   `yaml:"outPath"`             // specify a directory for output
-	OutFile             string   `yaml:"outFile"`             // query code file name, default: gen.go
-	WithUnitTest        bool     `yaml:"withUnitTest"`        // generate unit test for query code
+	DSN                 string   `yaml:"dsn"`          // consult[https://gorm.io/docs/connecting_to_the_database.html]"
+	DB                  string   `yaml:"db"`           // input mysql or postgres or sqlite or sqlserver. consult[https://gorm.io/docs/connecting_to_the_database.html]
+	Tables              []string `yaml:"tables"`       // enter the required data table or leave it blank
+	OnlyModel           bool     `yaml:"onlyModel"`    // only generate model
+	OutPath             string   `yaml:"outPath"`      // specify a directory for output
+	OutFile             string   `yaml:"outFile"`      // query code file name, default: gen.go
+	WithUnitTest        bool     `yaml:"withUnitTest"` // generate unit test for query code
+	UnitTestTemplate    string   `yaml:"unitTestTemplate"`
 	ModelPkgName        string   `yaml:"modelPkgName"`        // generated model code's package name
 	FieldNullable       bool     `yaml:"fieldNullable"`       // generate with pointer when field is nullable
 	FieldCoverable      bool     `yaml:"fieldCoverable"`      // generate with pointer when field has default value
@@ -149,6 +150,7 @@ func argParse() *CmdParams {
 	outPath := flag.String("outPath", defaultQueryPath, "specify a directory for output")
 	outFile := flag.String("outFile", "", "query code file name, default: gen.go")
 	withUnitTest := flag.Bool("withUnitTest", false, "generate unit test for query code")
+	unitTestTemplate := flag.String("unitTestTemplate", "", "custom unit test template file path for query code")
 	modelPkgName := flag.String("modelPkgName", "", "generated model code's package name")
 	fieldNullable := flag.Bool("fieldNullable", false, "generate with pointer when field is nullable")
 	fieldCoverable := flag.Bool("fieldCoverable", false, "generate with pointer when field has default value")
@@ -185,6 +187,9 @@ func argParse() *CmdParams {
 	if *withUnitTest {
 		cmdParse.WithUnitTest = *withUnitTest
 	}
+	if *unitTestTemplate != "" {
+		cmdParse.UnitTestTemplate = *unitTestTemplate
+	}
 	if *modelPkgName != "" {
 		cmdParse.ModelPkgName = *modelPkgName
 	}
@@ -226,6 +231,7 @@ func main() {
 		OutFile:             config.OutFile,
 		ModelPkgPath:        config.ModelPkgName,
 		WithUnitTest:        config.WithUnitTest,
+		UnitTestTemplate:    config.UnitTestTemplate,
 		FieldNullable:       config.FieldNullable,
 		FieldCoverable:      config.FieldCoverable,
 		FieldWithIndexTag:   config.FieldWithIndexTag,