optimize dockerfile generation (#284)

Co-authored-by: anqiansong <anqiansong@xiaoheiban.cn>

core/logx/tracelogger_test.go

@@ -21,6 +21,7 @@ var mock tracespec.Trace = new(mockTrace)
 
 func TestTraceLog(t *testing.T) {
 	var buf mockWriter
+	atomic.StoreUint32(&initialized, 1)
 	ctx := context.WithValue(context.Background(), tracespec.TracingKey, mock)
 	WithContext(ctx).(*traceLogger).write(&buf, levelInfo, testlog)
 	assert.True(t, strings.Contains(buf.String(), mockTraceId))

core/mapping/utils.go

@@ -153,9 +153,11 @@ func doParseKeyAndOptions(field reflect.StructField, value string) (string, *fie
 	key := strings.TrimSpace(segments[0])
 	options := segments[1:]
 
-	if len(options) > 0 {
+	if len(options) == 0 {
-		var fieldOpts fieldOptions
+		return key, nil, nil
+	}
 
+	var fieldOpts fieldOptions
 	for _, segment := range options {
 		option := strings.TrimSpace(segment)
 		switch {
@@ -204,9 +206,6 @@ func doParseKeyAndOptions(field reflect.StructField, value string) (string, *fie
 	return key, &fieldOpts, nil
 }
 
-	return key, nil, nil
-}
-
 func implicitValueRequiredStruct(tag string, tp reflect.Type) (bool, error) {
 	numFields := tp.NumField()
 	for i := 0; i < numFields; i++ {

rest/router/patrouter.go

@@ -64,7 +64,7 @@ func (pr *patRouter) ServeHTTP(w http.ResponseWriter, r *http.Request) {
 		}
 	}
 
-	allow, ok := pr.methodNotAllowed(r.Method, reqPath)
+	allows, ok := pr.methodsAllowed(r.Method, reqPath)
 	if !ok {
 		pr.handleNotFound(w, r)
 		return
@@ -73,7 +73,7 @@ func (pr *patRouter) ServeHTTP(w http.ResponseWriter, r *http.Request) {
 	if pr.notAllowed != nil {
 		pr.notAllowed.ServeHTTP(w, r)
 	} else {
-		w.Header().Set(allowHeader, allow)
+		w.Header().Set(allowHeader, allows)
 		w.WriteHeader(http.StatusMethodNotAllowed)
 	}
 }
@@ -94,7 +94,7 @@ func (pr *patRouter) handleNotFound(w http.ResponseWriter, r *http.Request) {
 	}
 }
 
-func (pr *patRouter) methodNotAllowed(method, path string) (string, bool) {
+func (pr *patRouter) methodsAllowed(method, path string) (string, bool) {
 	var allows []string
 
 	for treeMethod, tree := range pr.trees {

tools/goctl/api/gogen/template.go

@@ -38,11 +38,12 @@ func RevertTemplate(name string) error {
 	return util.CreateTemplate(category, name, content)
 }
 
-func Update(category string) error {
+func Update() error {
 	err := Clean()
 	if err != nil {
 		return err
 	}
+
 	return util.InitTemplates(category, templates)
 }
 
@@ -50,6 +51,6 @@ func Clean() error {
 	return util.Clean(category)
 }
 
-func GetCategory() string {
+func Category() string {
 	return category
 }

tools/goctl/api/gogen/template_test.go

@@ -84,7 +84,7 @@ func TestUpdate(t *testing.T) {
 
 	assert.Equal(t, string(data), modifyData)
 
-	assert.Nil(t, Update(category))
+	assert.Nil(t, Update())
 
 	data, err = ioutil.ReadFile(file)
 	assert.Nil(t, err)

tools/goctl/docker/docker.go

@@ -9,12 +9,14 @@ import (
 	"text/template"
 	"time"
 
+	"github.com/logrusorgru/aurora"
 	"github.com/tal-tech/go-zero/tools/goctl/util"
 	ctlutil "github.com/tal-tech/go-zero/tools/goctl/util"
 	"github.com/urfave/cli"
 )
 
 const (
+	dockerfileName = "Dockerfile"
 	etcDir         = "etc"
 	yamlEtx        = ".yaml"
 	cstOffset      = 60 * 60 * 8 // 8 hours offset for Chinese Standard Time
@@ -25,10 +27,18 @@ type Docker struct {
 	GoRelPath string
 	GoFile    string
 	ExeFile   string
+	HasPort   bool
+	Port      int
 	Argument  string
 }
 
-func DockerCommand(c *cli.Context) error {
+func DockerCommand(c *cli.Context) (err error) {
+	defer func() {
+		if err == nil {
+			fmt.Println(aurora.Green("Done."))
+		}
+	}()
+
 	goFile := c.String("go")
 	if len(goFile) == 0 {
 		return errors.New("-go can't be empty")
@@ -38,8 +48,9 @@ func DockerCommand(c *cli.Context) error {
 		return fmt.Errorf("file %q not found", goFile)
 	}
 
+	port := c.Int("port")
 	if _, err := os.Stat(etcDir); os.IsNotExist(err) {
-		return generateDockerfile(goFile)
+		return generateDockerfile(goFile, port)
 	}
 
 	cfg, err := findConfig(goFile, etcDir)
@@ -47,13 +58,13 @@ func DockerCommand(c *cli.Context) error {
 		return err
 	}
 
-	if err := generateDockerfile(goFile, "-f", "etc/"+cfg); err != nil {
+	if err := generateDockerfile(goFile, port, "-f", "etc/"+cfg); err != nil {
 		return err
 	}
 
 	projDir, ok := util.FindProjectPath(goFile)
 	if ok {
-		fmt.Printf("Run \"docker build ...\" command in dir %q\n", projDir)
+		fmt.Printf("Hint: run \"docker build ...\" command in dir %q\n", projDir)
 	}
 
 	return nil
@@ -88,18 +99,22 @@ func findConfig(file, dir string) (string, error) {
 	return files[0], nil
 }
 
-func generateDockerfile(goFile string, args ...string) error {
+func generateDockerfile(goFile string, port int, args ...string) error {
 	projPath, err := getFilePath(filepath.Dir(goFile))
 	if err != nil {
 		return err
 	}
 
-	pos := strings.IndexByte(projPath, '/')
+	if len(projPath) == 0 {
+		projPath = "."
+	} else {
+		pos := strings.IndexByte(projPath, os.PathSeparator)
 		if pos >= 0 {
 			projPath = projPath[pos+1:]
 		}
+	}
 
-	out, err := util.CreateIfNotExist("Dockerfile")
+	out, err := util.CreateIfNotExist(dockerfileName)
 	if err != nil {
 		return err
 	}
@@ -122,6 +137,8 @@ func generateDockerfile(goFile string, args ...string) error {
 		GoRelPath: projPath,
 		GoFile:    goFile,
 		ExeFile:   util.FileNameWithoutExt(filepath.Base(goFile)),
+		HasPort:   port > 0,
+		Port:      port,
 		Argument:  builder.String(),
 	})
 }

tools/goctl/docker/template.go

@@ -14,34 +14,59 @@ LABEL stage=gobuilder
 
 ENV CGO_ENABLED 0
 ENV GOOS linux
-{{if .Chinese}}ENV GOPROXY https://goproxy.cn,direct{{end}}
+{{if .Chinese}}ENV GOPROXY https://goproxy.cn,direct
-
+{{end}}
 WORKDIR /build/zero
 
 ADD go.mod .
 ADD go.sum .
 RUN go mod download
 COPY . .
-COPY {{.GoRelPath}}/etc /app/etc
+{{if .Argument}}COPY {{.GoRelPath}}/etc /app/etc
-RUN go build -ldflags="-s -w" -o /app/{{.ExeFile}} {{.GoRelPath}}/{{.GoFile}}
+{{end}}RUN go build -ldflags="-s -w" -o /app/{{.ExeFile}} {{.GoRelPath}}/{{.GoFile}}
 
 
 FROM alpine
 
-RUN apk update --no-cache
+RUN apk update --no-cache && apk add --no-cache ca-certificates tzdata
-RUN apk add --no-cache ca-certificates
-RUN apk add --no-cache tzdata
 ENV TZ Asia/Shanghai
 
 WORKDIR /app
-COPY --from=builder /app/{{.ExeFile}} /app/{{.ExeFile}}
+COPY --from=builder /app/{{.ExeFile}} /app/{{.ExeFile}}{{if .Argument}}
-COPY --from=builder /app/etc /app/etc
+COPY --from=builder /app/etc /app/etc{{end}}
-
+{{if .HasPort}}
+EXPOSE {{.Port}}
+{{end}}
 CMD ["./{{.ExeFile}}"{{.Argument}}]
 `
 )
 
+func Clean() error {
+	return util.Clean(category)
+}
+
 func GenTemplates(_ *cli.Context) error {
+	return initTemplate()
+}
+
+func Category() string {
+	return category
+}
+
+func RevertTemplate(name string) error {
+	return util.CreateTemplate(category, name, dockerTemplate)
+}
+
+func Update() error {
+	err := Clean()
+	if err != nil {
+		return err
+	}
+
+	return initTemplate()
+}
+
+func initTemplate() error {
 	return util.InitTemplates(category, map[string]string{
 		dockerTemplateFile: dockerTemplate,
 	})

tools/goctl/goctl.go

@@ -27,7 +27,7 @@ import (
 )
 
 var (
-	BuildVersion = "20201125"
+	BuildVersion = "1.1.1"
 	commands     = []cli.Command{
 		{
 			Name:  "api",
@@ -56,12 +56,10 @@ var (
 						cli.BoolFlag{
 							Name:  "iu",
 							Usage: "ignore update",
-							Required: false,
 						},
 						cli.BoolFlag{
 							Name:  "stdin",
 							Usage: "use stdin to input api doc content, press \"ctrl + d\" to send EOF",
-							Required: false,
 						},
 					},
 					Action: format.GoFormatApi,
@@ -102,7 +100,6 @@ var (
 						},
 						cli.StringFlag{
 							Name:  "style",
-							Required: false,
 							Usage: "the file naming format, see [https://github.com/tal-tech/go-zero/tree/master/tools/goctl/config/readme.md]",
 						},
 					},
@@ -138,17 +135,14 @@ var (
 						cli.StringFlag{
 							Name:  "webapi",
 							Usage: "the web api file path",
-							Required: false,
 						},
 						cli.StringFlag{
 							Name:  "caller",
 							Usage: "the web api caller",
-							Required: false,
 						},
 						cli.BoolFlag{
 							Name:  "unwrap",
 							Usage: "unwrap the webapi caller for import",
-							Required: false,
 						},
 					},
 					Action: tsgen.TsCommand,
@@ -205,7 +199,6 @@ var (
 						},
 						cli.StringFlag{
 							Name:  "style",
-							Required: false,
 							Usage: "the file naming format, see [https://github.com/tal-tech/go-zero/tree/master/tools/goctl/config/readme.md]",
 						},
 					},
@@ -221,6 +214,11 @@ var (
 					Name:  "go",
 					Usage: "the file that contains main function",
 				},
+				cli.IntFlag{
+					Name:  "port",
+					Usage: "the port to expose, default none",
+					Value: 0,
+				},
 			},
 			Action: docker.DockerCommand,
 		},
@@ -249,8 +247,7 @@ var (
 						},
 						cli.StringFlag{
 							Name:  "secret",
-							Usage:    "the image pull secret",
+							Usage: "the secret to image pull from registry",
-							Required: true,
 						},
 						cli.IntFlag{
 							Name:  "requestCpu",
@@ -322,7 +319,6 @@ var (
 					Flags: []cli.Flag{
 						cli.StringFlag{
 							Name:  "style",
-							Required: false,
 							Usage: "the file naming format, see [https://github.com/tal-tech/go-zero/tree/master/tools/goctl/config/readme.md]",
 						},
 						cli.BoolFlag{
@@ -361,7 +357,6 @@ var (
 						},
 						cli.StringFlag{
 							Name:  "style",
-							Required: false,
 							Usage: "the file naming format, see [https://github.com/tal-tech/go-zero/tree/master/tools/goctl/config/readme.md]",
 						},
 						cli.BoolFlag{
@@ -395,7 +390,6 @@ var (
 								},
 								cli.StringFlag{
 									Name:  "style",
-									Required: false,
 									Usage: "the file naming format, see [https://github.com/tal-tech/go-zero/tree/master/tools/goctl/config/readme.md]",
 								},
 								cli.BoolFlag{
@@ -431,7 +425,6 @@ var (
 								},
 								cli.StringFlag{
 									Name:  "style",
-									Required: false,
 									Usage: "the file naming format, see [https://github.com/tal-tech/go-zero/tree/master/tools/goctl/config/readme.md]",
 								},
 								cli.BoolFlag{
@@ -476,7 +469,7 @@ var (
 					Flags: []cli.Flag{
 						cli.StringFlag{
 							Name:  "category,c",
-							Usage: "the category of template, enum [api,rpc,model]",
+							Usage: "the category of template, enum [api,rpc,model,docker,kube]",
 						},
 					},
 					Action: tpl.UpdateTemplates,
@@ -487,7 +480,7 @@ var (
 					Flags: []cli.Flag{
 						cli.StringFlag{
 							Name:  "category,c",
-							Usage: "the category of template, enum [api,rpc,model]",
+							Usage: "the category of template, enum [api,rpc,model,docker,kube]",
 						},
 						cli.StringFlag{
 							Name:  "name,n",

tools/goctl/kube/deployment.go

@@ -47,9 +47,9 @@ spec:
         volumeMounts:
         - name: timezone
           mountPath: /etc/localtime
-      imagePullSecrets:
+      {{if .Secret}}imagePullSecrets:
       - name: {{.Secret}}
-      volumes:
+      {{end}}volumes:
         - name: timezone
           hostPath:
             path: /usr/share/zoneinfo/Asia/Shanghai

tools/goctl/kube/kube.go

@@ -2,8 +2,10 @@ package kube
 
 import (
 	"errors"
+	"fmt"
 	"text/template"
 
+	"github.com/logrusorgru/aurora"
 	"github.com/tal-tech/go-zero/tools/goctl/util"
 	"github.com/urfave/cli"
 )
@@ -16,30 +18,7 @@ const (
 	portLimit          = 32767
 )
 
-var errUnknownServiceType = errors.New("unknown service type")
+type Deployment struct {
-
-type (
-	ServiceType string
-
-	KubeRequest struct {
-		Env                        string
-		ServiceName                string
-		ServiceType                ServiceType
-		Namespace                  string
-		Schedule                   string
-		Replicas                   int
-		RevisionHistoryLimit       int
-		Port                       int
-		LimitCpu                   int
-		LimitMem                   int
-		RequestCpu                 int
-		RequestMem                 int
-		SuccessfulJobsHistoryLimit int
-		HpaMinReplicas             int
-		HpaMaxReplicas             int
-	}
-
-	Deployment struct {
 	Name        string
 	Namespace   string
 	Image       string
@@ -56,7 +35,6 @@ type (
 	MinReplicas int
 	MaxReplicas int
 }
-)
 
 func DeploymentCommand(c *cli.Context) error {
 	nodePort := c.Int("nodePort")
@@ -77,7 +55,7 @@ func DeploymentCommand(c *cli.Context) error {
 	defer out.Close()
 
 	t := template.Must(template.New("deploymentTemplate").Parse(text))
-	return t.Execute(out, Deployment{
+	err = t.Execute(out, Deployment{
 		Name:        c.String("name"),
 		Namespace:   c.String("namespace"),
 		Image:       c.String("image"),
@@ -94,6 +72,20 @@ func DeploymentCommand(c *cli.Context) error {
 		MinReplicas: c.Int("minReplicas"),
 		MaxReplicas: c.Int("maxReplicas"),
 	})
+	if err != nil {
+		return err
+	}
+
+	fmt.Println(aurora.Green("Done."))
+	return nil
+}
+
+func Category() string {
+	return category
+}
+
+func Clean() error {
+	return util.Clean(category)
 }
 
 func GenTemplates(_ *cli.Context) error {
@@ -102,3 +94,19 @@ func GenTemplates(_ *cli.Context) error {
 		jobTemplateFile:    jobTmeplate,
 	})
 }
+
+func RevertTemplate(name string) error {
+	return util.CreateTemplate(category, name, deploymentTemplate)
+}
+
+func Update() error {
+	err := Clean()
+	if err != nil {
+		return err
+	}
+
+	return util.InitTemplates(category, map[string]string{
+		deployTemplateFile: deploymentTemplate,
+		jobTemplateFile:    jobTmeplate,
+	})
+}

tools/goctl/model/sql/gen/template.go

@@ -54,6 +54,14 @@ var templates = map[string]string{
 	errTemplateFile:                       template.Error,
 }
 
+func Category() string {
+	return category
+}
+
+func Clean() error {
+	return util.Clean(category)
+}
+
 func GenTemplates(_ *cli.Context) error {
 	return util.InitTemplates(category, templates)
 }
@@ -66,18 +74,10 @@ func RevertTemplate(name string) error {
 	return util.CreateTemplate(category, name, content)
 }
 
-func Clean() error {
+func Update() error {
-	return util.Clean(category)
-}
-
-func Update(category string) error {
 	err := Clean()
 	if err != nil {
 		return err
 	}
 	return util.InitTemplates(category, templates)
 }
-
-func GetCategory() string {
-	return category
-}

tools/goctl/model/sql/gen/template_test.go

@@ -85,7 +85,7 @@ func TestUpdate(t *testing.T) {
 
 	assert.Equal(t, string(data), modifyData)
 
-	assert.Nil(t, Update(category))
+	assert.Nil(t, Update())
 
 	data, err = ioutil.ReadFile(file)
 	assert.Nil(t, err)

tools/goctl/plugin/plugin.go

@@ -26,6 +26,7 @@ const (
 
 type Plugin struct {
 	Api         *spec.ApiSpec
+	ApiFilePath string
 	Style       string
 	Dir         string
 }
@@ -86,6 +87,12 @@ func prepareArgs(c *cli.Context) ([]byte, error) {
 		transferData.Api = api
 	}
 
+	absApiFilePath, err := filepath.Abs(apiPath)
+	if err != nil {
+		return nil, err
+	}
+
+	transferData.ApiFilePath = absApiFilePath
 	dirAbs, err := filepath.Abs(c.String("dir"))
 	if err != nil {
 		return nil, err

tools/goctl/rpc/generator/gen_test.go

@@ -4,6 +4,7 @@ import (
 	"go/build"
 	"os"
 	"path/filepath"
+	"strings"
 	"testing"
 
 	"github.com/stretchr/testify/assert"
@@ -44,7 +45,9 @@ func TestRpcGenerate(t *testing.T) {
 	assert.Nil(t, err)
 	_, err = execx.Run("go test "+projectName, projectDir)
 	if err != nil {
-		assert.Contains(t, err.Error(), "not in GOROOT")
+		assert.True(t, func() bool {
+			return strings.Contains(err.Error(), "not in GOROOT") || strings.Contains(err.Error(), "cannot find package")
+		}())
 	}
 
 	// case go mod
@@ -61,7 +64,9 @@ func TestRpcGenerate(t *testing.T) {
 	assert.Nil(t, err)
 	_, err = execx.Run("go test "+projectName, projectDir)
 	if err != nil {
-		assert.Contains(t, err.Error(), "not in GOROOT")
+		assert.True(t, func() bool {
+			return strings.Contains(err.Error(), "not in GOROOT") || strings.Contains(err.Error(), "cannot find package")
+		}())
 	}
 
 	// case not in go mod and go path
@@ -69,7 +74,9 @@ func TestRpcGenerate(t *testing.T) {
 	assert.Nil(t, err)
 	_, err = execx.Run("go test "+projectName, projectDir)
 	if err != nil {
-		assert.Contains(t, err.Error(), "not in GOROOT")
+		assert.True(t, func() bool {
+			return strings.Contains(err.Error(), "not in GOROOT") || strings.Contains(err.Error(), "cannot find package")
+		}())
 	}
 
 	// invalid directory

tools/goctl/rpc/generator/template.go

@@ -54,14 +54,15 @@ func Clean() error {
 	return util.Clean(category)
 }
 
-func Update(category string) error {
+func Update() error {
 	err := Clean()
 	if err != nil {
 		return err
 	}
+
 	return util.InitTemplates(category, templates)
 }
 
-func GetCategory() string {
+func Category() string {
 	return category
 }

tools/goctl/rpc/generator/template_test.go

@@ -97,8 +97,7 @@ func TestUpdate(t *testing.T) {
 	}
 	assert.Equal(t, "modify", string(data))
 
-	err = Update(category)
+	assert.Nil(t, Update())
-	assert.Nil(t, err)
 
 	data, err = ioutil.ReadFile(mainTpl)
 	if err != nil {
@@ -109,6 +108,6 @@ func TestUpdate(t *testing.T) {
 
 func TestGetCategory(t *testing.T) {
 	_ = Clean()
-	result := GetCategory()
+	result := Category()
 	assert.Equal(t, category, result)
 }

tools/goctl/tpl/templates.go

@@ -76,12 +76,16 @@ func UpdateTemplates(ctx *cli.Context) (err error) {
 		}
 	}()
 	switch category {
-	case gogen.GetCategory():
+	case docker.Category():
-		return gogen.Update(category)
+		return docker.Update()
-	case rpcgen.GetCategory():
+	case gogen.Category():
-		return rpcgen.Update(category)
+		return gogen.Update()
-	case modelgen.GetCategory():
+	case kube.Category():
-		return modelgen.Update(category)
+		return kube.Update()
+	case rpcgen.Category():
+		return rpcgen.Update()
+	case modelgen.Category():
+		return modelgen.Update()
 	default:
 		err = fmt.Errorf("unexpected category: %s", category)
 		return
@@ -97,11 +101,15 @@ func RevertTemplates(ctx *cli.Context) (err error) {
 		}
 	}()
 	switch category {
-	case gogen.GetCategory():
+	case docker.Category():
+		return docker.RevertTemplate(filename)
+	case kube.Category():
+		return kube.RevertTemplate(filename)
+	case gogen.Category():
 		return gogen.RevertTemplate(filename)
-	case rpcgen.GetCategory():
+	case rpcgen.Category():
 		return rpcgen.RevertTemplate(filename)
-	case modelgen.GetCategory():
+	case modelgen.Category():
 		return modelgen.RevertTemplate(filename)
 	default:
 		err = fmt.Errorf("unexpected category: %s", category)

tools/goctl/util/path.go

@@ -60,7 +60,6 @@ func FindGoModPath(dir string) (string, bool) {
 	var hasGoMod = false
 	for {
 		if FileExists(filepath.Join(tempPath, goModeIdentifier)) {
-			tempPath = filepath.Dir(tempPath)
 			rootPath = strings.TrimPrefix(absDir[len(tempPath):], "/")
 			hasGoMod = true
 			break

tools/goctl/util/string.go

@@ -19,10 +19,11 @@ func Untitle(s string) string {
 }
 
 func Index(slice []string, item string) int {
-	for i, _ := range slice {
+	for i := range slice {
 		if slice[i] == item {
 			return i
 		}
 	}
+
 	return -1
 }