add unit testing cases for command gen ctrl (#3090)

cmd/gf/internal/cmd/cmd__test.go

@@ -0,0 +1,11 @@
+// Copyright GoFrame gf Author(https://goframe.org). All Rights Reserved.
+//
+// This Source Code Form is subject to the terms of the MIT License.
+// If a copy of the MIT was not distributed with this file,
+// You can obtain one at https://github.com/gogf/gf.
+
+package cmd
+
+import "context"
+
+var ctx = context.Background()

cmd/gf/internal/cmd/cmd_gen_ctrl_test.go

@@ -0,0 +1,86 @@
+// Copyright GoFrame gf Author(https://goframe.org). All Rights Reserved.
+//
+// This Source Code Form is subject to the terms of the MIT License.
+// If a copy of the MIT was not distributed with this file,
+// You can obtain one at https://github.com/gogf/gf.
+
+package cmd
+
+import (
+	"github.com/gogf/gf/cmd/gf/v2/internal/cmd/genctrl"
+	"github.com/gogf/gf/v2/os/gfile"
+	"github.com/gogf/gf/v2/test/gtest"
+	"github.com/gogf/gf/v2/util/guid"
+	"github.com/gogf/gf/v2/util/gutil"
+	"path/filepath"
+	"testing"
+)
+
+func Test_Gen_Ctrl_Default(t *testing.T) {
+	gtest.C(t, func(t *gtest.T) {
+		var (
+			path      = gfile.Temp(guid.S())
+			apiFolder = gtest.DataPath("genctrl", "api")
+			in        = genctrl.CGenCtrlInput{
+				SrcFolder:     apiFolder,
+				DstFolder:     path,
+				WatchFile:     "",
+				SdkPath:       "",
+				SdkStdVersion: false,
+				SdkNoV1:       false,
+				Clear:         false,
+				Merge:         false,
+			}
+		)
+		err := gutil.FillStructWithDefault(&in)
+
+		t.AssertNil(err)
+
+		err = gfile.Mkdir(path)
+		t.AssertNil(err)
+		defer gfile.Remove(path)
+
+		_, err = genctrl.CGenCtrl{}.Ctrl(ctx, in)
+		if err != nil {
+			panic(err)
+		}
+
+		// apiInterface files
+		var (
+			genApi       = apiFolder + filepath.FromSlash("/article/article.go")
+			genApiExpect = apiFolder + filepath.FromSlash("/article/article_expect.go")
+		)
+		defer gfile.Remove(genApi)
+		t.Assert(gfile.GetContents(genApi), gfile.GetContents(genApiExpect))
+
+		// files
+		files, err := gfile.ScanDir(path, "*.go", true)
+		t.AssertNil(err)
+		t.Assert(files, []string{
+			path + filepath.FromSlash("/article/article.go"),
+			path + filepath.FromSlash("/article/article_new.go"),
+			path + filepath.FromSlash("/article/article_v1_create.go"),
+			path + filepath.FromSlash("/article/article_v1_get_list.go"),
+			path + filepath.FromSlash("/article/article_v1_get_one.go"),
+			path + filepath.FromSlash("/article/article_v1_update.go"),
+			path + filepath.FromSlash("/article/article_v2_create.go"),
+			path + filepath.FromSlash("/article/article_v2_update.go"),
+		})
+
+		// content
+		testPath := gtest.DataPath("genctrl", "controller")
+		expectFiles := []string{
+			testPath + filepath.FromSlash("/article/article.go"),
+			testPath + filepath.FromSlash("/article/article_new.go"),
+			testPath + filepath.FromSlash("/article/article_v1_create.go"),
+			testPath + filepath.FromSlash("/article/article_v1_get_list.go"),
+			testPath + filepath.FromSlash("/article/article_v1_get_one.go"),
+			testPath + filepath.FromSlash("/article/article_v1_update.go"),
+			testPath + filepath.FromSlash("/article/article_v2_create.go"),
+			testPath + filepath.FromSlash("/article/article_v2_update.go"),
+		}
+		for i, _ := range files {
+			t.Assert(gfile.GetContents(files[i]), gfile.GetContents(expectFiles[i]))
+		}
+	})
+}

cmd/gf/internal/cmd/cmd_gen_dao_test.go

@@ -7,7 +7,6 @@
 package cmd
 
 import (
-	"context"
 	"fmt"
 	"path/filepath"
 	"testing"
@@ -21,8 +20,6 @@ import (
 	"github.com/gogf/gf/v2/util/gutil"
 )
 
-var ctx = context.Background()
-
 func dropTableWithDb(db gdb.DB, table string) {
 	dropTableStmt := fmt.Sprintf("DROP TABLE IF EXISTS `%s`", table)
 	if _, err := db.Exec(ctx, dropTableStmt); err != nil {

cmd/gf/internal/cmd/genctrl/genctrl_generate_ctrl.go

@@ -108,7 +108,7 @@ func (c *controllerGenerator) doGenerateCtrlNewByModuleAndVersion(
 			"{NewFuncName}":   newFuncName,
 			"{InterfaceName}": interfaceName,
 		})
-		err = gfile.PutContentsAppend(moduleFilePathNew, gstr.TrimLeft(content))
+		err = gfile.PutContentsAppend(moduleFilePathNew, content)
 		if err != nil {
 			return err
 		}

cmd/gf/internal/cmd/genctrl/genctrl_generate_interface.go

@@ -50,8 +50,7 @@ func (c *apiInterfaceGenerator) doGenerate(apiModuleFolderPath string, module st
 		moduleFilePath = filepath.FromSlash(gfile.Join(apiModuleFolderPath, fmt.Sprintf(`%s.if.go`, module)))
 	}
 	// all import paths.
-	importPathMap.Set("\t"+`"context"`, 1)
-	importPathMap.Set("\t"+``, 1)
+	importPathMap.Set("\t"+`"context"`+"\n", 1)
 	for _, item := range items {
 		importPathMap.Set(fmt.Sprintf("\t"+`"%s"`, item.Import), 1)
 	}
@@ -92,7 +91,7 @@ func (c *apiInterfaceGenerator) doGenerate(apiModuleFolderPath string, module st
 		interfaceDefinition += "\n\n"
 	}
 	interfaceContent = gstr.TrimLeft(gstr.ReplaceByMap(interfaceContent, g.MapStrStr{
-		"{Interfaces}": interfaceDefinition,
+		"{Interfaces}": gstr.TrimRightStr(interfaceDefinition, "\n", 2),
 	}))
 	err = gfile.PutContents(moduleFilePath, interfaceContent)
 	mlog.Printf(`generated: %s`, moduleFilePath)

cmd/gf/internal/cmd/testdata/genctrl/api/article/article_expect.go

@@ -0,0 +1,24 @@
+// =================================================================================
+// Code generated and maintained by GoFrame CLI tool. DO NOT EDIT.
+// =================================================================================
+
+package article
+
+import (
+	"context"
+
+	"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/api/article/v1"
+	"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/api/article/v2"
+)
+
+type IArticleV1 interface {
+	Create(ctx context.Context, req *v1.CreateReq) (res *v1.CreateRes, err error)
+	Update(ctx context.Context, req *v1.UpdateReq) (res *v1.UpdateRes, err error)
+	GetList(ctx context.Context, req *v1.GetListReq) (res *v1.GetListRes, err error)
+	GetOne(ctx context.Context, req *v1.GetOneReq) (res *v1.GetOneRes, err error)
+}
+
+type IArticleV2 interface {
+	Create(ctx context.Context, req *v2.CreateReq) (res *v2.CreateRes, err error)
+	Update(ctx context.Context, req *v2.UpdateReq) (res *v2.UpdateRes, err error)
+}

cmd/gf/internal/cmd/testdata/genctrl/api/article/v1/edit.go

@@ -0,0 +1,23 @@
+// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
+//
+// This Source Code Form is subject to the terms of the MIT License.
+// If a copy of the MIT was not distributed with this file,
+// You can obtain one at https://github.com/gogf/gf.
+
+package v1
+
+import "github.com/gogf/gf/v2/frame/g"
+
+type CreateReq struct {
+	g.Meta `path:"/article/create" method:"post" tags:"ArticleService"`
+	Title  string `v:"required"`
+}
+
+type CreateRes struct{}
+
+type UpdateReq struct {
+	g.Meta `path:"/article/update" method:"post" tags:"ArticleService"`
+	Title  string `v:"required"`
+}
+
+type UpdateRes struct{}

cmd/gf/internal/cmd/testdata/genctrl/api/article/v1/get.go

@@ -0,0 +1,25 @@
+// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
+//
+// This Source Code Form is subject to the terms of the MIT License.
+// If a copy of the MIT was not distributed with this file,
+// You can obtain one at https://github.com/gogf/gf.
+
+package v1
+
+import "github.com/gogf/gf/v2/frame/g"
+
+type GetListReq struct {
+	g.Meta `path:"/article/list" method:"get" tags:"ArticleService"`
+}
+
+type GetListRes struct {
+	list []struct{}
+}
+
+type GetOneReq struct {
+	g.Meta `path:"/article/one" method:"get" tags:"ArticleService"`
+}
+
+type GetOneRes struct {
+	one struct{}
+}

cmd/gf/internal/cmd/testdata/genctrl/api/article/v2/edit.go

@@ -0,0 +1,23 @@
+// Copyright GoFrame Author(https://goframe.org). All Rights Reserved.
+//
+// This Source Code Form is subject to the terms of the MIT License.
+// If a copy of the MIT was not distributed with this file,
+// You can obtain one at https://github.com/gogf/gf.
+
+package v2
+
+import "github.com/gogf/gf/v2/frame/g"
+
+type CreateReq struct {
+	g.Meta `path:"/article/create" method:"post" tags:"ArticleService"`
+	Title  string `v:"required"`
+}
+
+type CreateRes struct{}
+
+type UpdateReq struct {
+	g.Meta `path:"/article/update" method:"post" tags:"ArticleService"`
+	Title  string `v:"required"`
+}
+
+type UpdateRes struct{}

cmd/gf/internal/cmd/testdata/genctrl/controller/article/article.go

@@ -0,0 +1,5 @@
+// =================================================================================
+// This is auto-generated by GoFrame CLI tool only once. Fill this file as you wish.
+// =================================================================================
+
+package article

cmd/gf/internal/cmd/testdata/genctrl/controller/article/article_new.go

@@ -0,0 +1,21 @@
+// =================================================================================
+// This is auto-generated by GoFrame CLI tool only once. Fill this file as you wish.
+// =================================================================================
+
+package article
+
+import (
+	"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/api/article"
+)
+
+type ControllerV1 struct{}
+
+func NewV1() article.IArticleV1 {
+	return &ControllerV1{}
+}
+
+type ControllerV2 struct{}
+
+func NewV2() article.IArticleV2 {
+	return &ControllerV2{}
+}

cmd/gf/internal/cmd/testdata/genctrl/controller/article/article_v1_create.go

@@ -0,0 +1,14 @@
+package article
+
+import (
+	"context"
+
+	"github.com/gogf/gf/v2/errors/gcode"
+	"github.com/gogf/gf/v2/errors/gerror"
+
+	"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/api/article/v1"
+)
+
+func (c *ControllerV1) Create(ctx context.Context, req *v1.CreateReq) (res *v1.CreateRes, err error) {
+	return nil, gerror.NewCode(gcode.CodeNotImplemented)
+}

cmd/gf/internal/cmd/testdata/genctrl/controller/article/article_v1_get_list.go

@@ -0,0 +1,14 @@
+package article
+
+import (
+	"context"
+
+	"github.com/gogf/gf/v2/errors/gcode"
+	"github.com/gogf/gf/v2/errors/gerror"
+
+	"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/api/article/v1"
+)
+
+func (c *ControllerV1) GetList(ctx context.Context, req *v1.GetListReq) (res *v1.GetListRes, err error) {
+	return nil, gerror.NewCode(gcode.CodeNotImplemented)
+}

cmd/gf/internal/cmd/testdata/genctrl/controller/article/article_v1_get_one.go

@@ -0,0 +1,14 @@
+package article
+
+import (
+	"context"
+
+	"github.com/gogf/gf/v2/errors/gcode"
+	"github.com/gogf/gf/v2/errors/gerror"
+
+	"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/api/article/v1"
+)
+
+func (c *ControllerV1) GetOne(ctx context.Context, req *v1.GetOneReq) (res *v1.GetOneRes, err error) {
+	return nil, gerror.NewCode(gcode.CodeNotImplemented)
+}

cmd/gf/internal/cmd/testdata/genctrl/controller/article/article_v1_update.go

@@ -0,0 +1,14 @@
+package article
+
+import (
+	"context"
+
+	"github.com/gogf/gf/v2/errors/gcode"
+	"github.com/gogf/gf/v2/errors/gerror"
+
+	"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/api/article/v1"
+)
+
+func (c *ControllerV1) Update(ctx context.Context, req *v1.UpdateReq) (res *v1.UpdateRes, err error) {
+	return nil, gerror.NewCode(gcode.CodeNotImplemented)
+}

cmd/gf/internal/cmd/testdata/genctrl/controller/article/article_v2_create.go

@@ -0,0 +1,14 @@
+package article
+
+import (
+	"context"
+
+	"github.com/gogf/gf/v2/errors/gcode"
+	"github.com/gogf/gf/v2/errors/gerror"
+
+	"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/api/article/v2"
+)
+
+func (c *ControllerV2) Create(ctx context.Context, req *v2.CreateReq) (res *v2.CreateRes, err error) {
+	return nil, gerror.NewCode(gcode.CodeNotImplemented)
+}

cmd/gf/internal/cmd/testdata/genctrl/controller/article/article_v2_update.go

@@ -0,0 +1,14 @@
+package article
+
+import (
+	"context"
+
+	"github.com/gogf/gf/v2/errors/gcode"
+	"github.com/gogf/gf/v2/errors/gerror"
+
+	"github.com/gogf/gf/cmd/gf/v2/internal/cmd/testdata/genctrl/api/article/v2"
+)
+
+func (c *ControllerV2) Update(ctx context.Context, req *v2.UpdateReq) (res *v2.UpdateRes, err error) {
+	return nil, gerror.NewCode(gcode.CodeNotImplemented)
+}

cmd/gf/internal/consts/consts_gen_ctrl_template.go

@@ -12,7 +12,6 @@ const TemplateGenCtrlControllerEmpty = `
 // =================================================================================
 
 package {Module}
-
 `
 
 const TemplateGenCtrlControllerNewEmpty = `
@@ -25,17 +24,14 @@ package {Module}
 import (
 	{ImportPath}
 )
-
 `
 
 const TemplateGenCtrlControllerNewFunc = `
-
 type {CtrlName} struct{}
 
 func {NewFuncName}() {InterfaceName} {
 	return &{CtrlName}{}
 }
-
 `
 
 const TemplateGenCtrlControllerMethodFunc = `
@@ -64,7 +60,7 @@ func (c *{CtrlName}) {MethodName}(ctx context.Context, req *{Version}.{MethodNam
 
 const TemplateGenCtrlApiInterface = `
 // =================================================================================
-// Code generated and maintained by GoFrame CLI tool. DO NOT EDIT. 
+// Code generated and maintained by GoFrame CLI tool. DO NOT EDIT.
 // =================================================================================
 
 package {Module}