support default docker tag (#75)

longfangsong · web-flow · commit b08c51c1dbb3 · 2020-08-25T02:58:40.000+08:00
diff --git a/.github/workflows/integration-tests.yml b/.github/workflows/integration-tests.yml
@@ -164,3 +164,31 @@ jobs:
         run: python3 ./integration/non-integer-pk/test.py ./integration/non-integer-pk/golang/mysql.yml
         env:
           DB_ADDRESS: user:password@tcp(localhost:3306)/database?allowCleartextPasswords=true&allowNativePasswords=true&parseTime=true
+  docker:
+    needs: smoke_test
+    runs-on: ubuntu-latest
+    name: Run generating docker test
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v2
+      - uses: actions/setup-go@v2
+        with:
+          go-version: 1.14
+      - name: Build
+        run: make build
+      - name: Run the test case
+        run: python3 ./integration/docker/test.py
+  cicd:
+    needs: smoke_test
+    runs-on: ubuntu-latest
+    name: Run generating cicd test
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v2
+      - uses: actions/setup-go@v2
+        with:
+          go-version: 1.14
+      - name: Build
+        run: make build
+      - name: Run the test case
+        run: python3 ./integration/cicd/test.py
diff --git a/Makefile b/Makefile
@@ -1,5 +1,5 @@
 build: generate
-	go build
+	CGO_ENABLED=0 go build
 
 generate: 
 	go generate
@@ -12,9 +12,9 @@ clean:
 	rm -rf ./autoAPI
 
 build-release: generate
-	GOOS=windows GOARCH=amd64 go build -o autoAPI.exe
+	CGO_ENABLED=0 GOOS=windows GOARCH=amd64 go build -o autoAPI.exe
 	zip autoAPI-windows-amd64.zip autoAPI.exe
-	GOOS=darwin GOARCH=amd64 go build -o autoAPI
+	CGO_ENABLED=0 GOOS=darwin GOARCH=amd64 go build -o autoAPI
 	zip autoAPI-darwin-amd64.zip autoAPI
-	GOOS=linux GOARCH=amd64 go build -o autoAPI
+	CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -o autoAPI
 	zip autoAPI-linux-amd64.zip autoAPI
diff --git a/config/config.go b/config/config.go
@@ -28,14 +28,21 @@ func FromCommandLine(c *cli.Context) (*Config, error) {
 		return nil, err
 	}
 	result.Docker, err = docker.FromCommandLine(c)
+	if err != nil {
+		return nil, err
+	}
+	result.CICD, err = cicd.FromCommandLine(c)
 	return &result, err
 }
 
 func (c *Config) MergeWithEnv() error {
 	if err := c.Database.MergeWithEnv(); err != nil {
 		return err
 	}
-	return c.Docker.MergeWithEnv()
+	if c.Docker != nil {
+		return c.Docker.MergeWithEnv()
+	}
+	return nil
 }
 
 func (c *Config) MergeWithConfig(path string) error {
@@ -119,7 +126,7 @@ func (c *Config) MergeWith(other *Config) {
 }
 
 func (c *Config) Validate() error {
-	if c.CICD != nil && c.CICD.K8s == nil && c.CICD.GithubAction == nil {
+	if (c.CICD != nil && c.CICD.K8s == nil && c.CICD.GithubAction == nil) || (c.Docker == nil || c.Docker.Username == nil && c.Docker.Tag == nil) {
 		c.CICD = nil
 	}
 	err := c.Database.Validate()
diff --git a/config/fields/cicd/cicd.go b/config/fields/cicd/cicd.go
@@ -1,5 +1,7 @@
 package cicd
 
+import "github.com/urfave/cli/v2"
+
 type CICD struct {
 	GithubAction *bool `yaml:"GitHubAction" json:"GitHubAction"`
 	K8s          *bool `yaml:"k8s" json:"k8s"`
@@ -27,3 +29,12 @@ func (cicd *CICD) MergeWith(other *CICD) {
 		cicd.K8s = other.K8s
 	}
 }
+
+func FromCommandLine(c *cli.Context) (*CICD, error) {
+	t := true
+	f := false
+	return &CICD{
+		GithubAction: &t,
+		K8s:          &f,
+	}, nil
+}
diff --git a/config/fields/docker/docker.go b/config/fields/docker/docker.go
@@ -23,14 +23,18 @@ func (docker *Docker) MergeWith(other *Docker) {
 }
 
 func (docker *Docker) MergeWithEnv() error {
-	if os.Getenv("DOCKER_USERNAME") != "" {
+	if docker.Username == nil && os.Getenv("DOCKER_USERNAME") != "" {
 		username := os.Getenv("DOCKER_USERNAME")
 		docker.Username = &username
 	}
-	if os.Getenv("DOCKER_TAG") != "" {
+	if docker.Tag == nil && os.Getenv("DOCKER_TAG") != "" {
 		tag := os.Getenv("DOCKER_TAG")
 		docker.Tag = &tag
 	}
+	if docker.Tag == nil && os.Getenv("GITHUB_RUN_NUMBER") != "" {
+		tag := "ci-v" + os.Getenv("GITHUB_RUN_NUMBER")
+		docker.Tag = &tag
+	}
 	return nil
 }
 
@@ -42,7 +46,7 @@ func FromCommandLine(c *cli.Context) (*Docker, error) {
 	if tag := c.String("dockertag"); tag != "" {
 		result.Tag = &tag
 	}
-	if result.Username == nil && result.Tag == nil {
+	if c.Bool("nodocker") {
 		return nil, nil
 	}
 	return &result, nil
diff --git a/integration/cicd/default.yml b/integration/cicd/default.yml
@@ -0,0 +1,9 @@
+database:
+  tablename: student
+  fields:
+    - name: name
+      type: varchar(24)
+    - name: birthday
+      type: date
+    - name: school_id
+      type: int
diff --git a/integration/cicd/test.py b/integration/cicd/test.py
@@ -0,0 +1,54 @@
+import os
+import subprocess
+import unittest
+
+
+class CICDGeneratingTest(unittest.TestCase):
+    def test_default(self):
+        subprocess.run("./autoAPI --force -f ./integration/docker/default.yml --force -o ./api".split(' '))
+        self.assertFalse(os.path.exists("./api/.github/workflows/dockerimage.yml"))
+
+    def test_command_line(self):
+        # force noDocker
+        subprocess.run(
+            "./autoAPI --force -f ./integration/docker/default.yml --force --nodocker -o ./api".split(' '))
+        self.assertTrue(os.path.exists("./api"))
+        self.assertFalse(os.path.exists("./api/.github/workflows/dockerimage.yml"))
+
+        subprocess.run(
+            "./autoAPI --force -f ./integration/docker/default.yml --force -nd -o ./api".split(' '))
+        self.assertTrue(os.path.exists("./api"))
+        self.assertFalse(os.path.exists("./api/.github/workflows/dockerimage.yml"))
+
+    def test_docker_image_name(self):
+        # set docker info by command
+        subprocess.run(
+            "./autoAPI --force -f ./integration/docker/default.yml --force -du testuser -dt v0 -o ./api".split(
+                ' '))
+        self.assertTrue(os.path.exists("./api/.github/workflows/dockerimage.yml"))
+        with open("./api/.github/workflows/dockerimage.yml") as f:
+            content = f.read()
+            self.assertEqual(content.count("testuser/student:v0"), 2)
+            self.assertIn('--username "testuser"', content)
+        # set docker info by env
+        subprocess.run(
+            "./autoAPI --force -f ./integration/docker/default.yml --force -o ./api".split(' '),
+            env={'DOCKER_USERNAME': 'testuser', 'DOCKER_TAG': 'v0'})
+        with open("./api/.github/workflows/dockerimage.yml") as f:
+            content = f.read()
+            self.assertEqual(content.count("testuser/student:v0"), 2)
+            self.assertIn('--username "testuser"', content)
+        # simulate GitHub Actions env
+        subprocess.run(
+            "./autoAPI --force -f ./integration/docker/default.yml --force -o ./api".split(' '),
+            env={'DOCKER_USERNAME': 'testuser', 'GITHUB_RUN_NUMBER': '7'})
+        with open("./api/.github/workflows/dockerimage.yml") as f:
+            content = f.read()
+            self.assertEqual(content.count("testuser/student:ci-v7"), 2)
+            self.assertIn('--username "testuser"', content)
+
+
+if __name__ == '__main__':
+    loader = unittest.TestLoader()
+    loader.sortTestMethodsUsing = None
+    unittest.main(testLoader=loader)
diff --git a/integration/docker/default.yml b/integration/docker/default.yml
@@ -0,0 +1,9 @@
+database:
+  tablename: student
+  fields:
+    - name: name
+      type: varchar(24)
+    - name: birthday
+      type: date
+    - name: school_id
+      type: int
diff --git a/integration/docker/test.py b/integration/docker/test.py
@@ -0,0 +1,23 @@
+import os
+import subprocess
+import unittest
+
+
+# todo: check whether the dockerfile generated is right, ie. can build and work
+class DockerfileGeneratingTest(unittest.TestCase):
+    def test_default(self):
+        subprocess.run("./autoAPI --force -f ./integration/docker/default.yml --force -o ./api".split(' '))
+        self.assertTrue(os.path.exists("./api/Dockerfile"))
+
+    def test_command_line(self):
+        # force noDocker
+        subprocess.run(
+            "./autoAPI --force -f ./integration/docker/default.yml --force --nodocker -o ./api".split(' '))
+        self.assertTrue(os.path.exists("./api"))
+        self.assertFalse(os.path.exists("./api/Dockerfile"))
+
+
+if __name__ == '__main__':
+    loader = unittest.TestLoader()
+    loader.sortTestMethodsUsing = None
+    unittest.main(testLoader=loader)
diff --git a/main.go b/main.go
@@ -8,20 +8,20 @@ import (
 	"autoAPI/generator/apiGenerator/golang"
 	"autoAPI/generator/cicdGenerator"
 	"errors"
+	"fmt"
 	"github.com/urfave/cli/v2"
-	"log"
 	"os"
 )
 
 func main() {
 	err := (&cli.App{
 		Flags: []cli.Flag{
-			&cli.StringFlag{
+			&cli.PathFlag{
 				Name:    "file",
 				Aliases: []string{"f"},
 				Usage:   "Load configuration from `FILE`",
 			},
-			&cli.StringFlag{
+			&cli.PathFlag{
 				Name:     "output",
 				Aliases:  []string{"o"},
 				Usage:    "Put the output code in `PATH`",
@@ -32,6 +32,31 @@ func main() {
 				Value: false,
 				Usage: "If the output PATH dir exists, use '--force' to overwrite it",
 			},
+			&cli.StringFlag{
+				Name:     "dockerusername",
+				Aliases:  []string{"du"},
+				Usage:    "Your DockerHub's username",
+				Required: false,
+			},
+			&cli.StringFlag{
+				Name:     "dockertag",
+				Aliases:  []string{"dt"},
+				Usage:    "Tag of the generated docker image",
+				Required: false,
+			},
+			&cli.BoolFlag{
+				Name:     "nodocker",
+				Aliases:  []string{"nd"},
+				Usage:    "Force not generating docker",
+				Required: false,
+				Value:    false,
+			},
+			&cli.StringFlag{
+				Name:     "dbengine",
+				Aliases:  []string{"dbms"},
+				Usage:    "The dbengine you want use",
+				Required: false,
+			},
 		},
 		Name:  "autoAPI",
 		Usage: "Generate an CRUD api endpoint program automatically!",
@@ -89,6 +114,6 @@ func main() {
 		},
 	}).Run(os.Args)
 	if err != nil {
-		log.Fatal(err)
+		_ = fmt.Errorf("%s", err.Error())
 	}
 }
diff --git a/template/cicd/dockerimage.qtpl b/template/cicd/dockerimage.qtpl
@@ -12,7 +12,7 @@ jobs:
       - name: Build the Docker image
         run: |
           docker build . -t {%v config.Database.Table.Name.KebabCase() %}
-          docker tag {%v config.Database.Table.Name.KebabCase() %} {%v config.Docker.Username %}/{%v config.Database.Table.Name.KebabCase() %}:{%v config.Docker.Tag %}
-          echo "${{ secrets.DOCKER_PASSWORD }}" | docker login --username "{%v config.Docker.Username %}" --password-stdin
-          docker push {%v config.Docker.Username %}/{%v config.Database.Table.Name.KebabCase() %}:{%v config.Docker.Tag %}
+          docker tag {%v config.Database.Table.Name.KebabCase() %} {%v *config.Docker.Username %}/{%v config.Database.Table.Name.KebabCase() %}:{%v *config.Docker.Tag %}
+          echo "${{ secrets.DOCKER_PASSWORD }}" | docker login --username "{%v *config.Docker.Username %}" --password-stdin
+          docker push {%v *config.Docker.Username %}/{%v config.Database.Table.Name.KebabCase() %}:{%v *config.Docker.Tag %}
 {% endfunc %}

Original file line number	Diff line number	Diff line change
`@@ -28,14 +28,21 @@ func FromCommandLine(c cli.Context) (Config, error) {`
`28`	`28`	`return nil, err`
`29`	`29`	`}`
`30`	`30`	`result.Docker, err = docker.FromCommandLine(c)`
	`31`	`+ if err != nil {`
	`32`	`+ return nil, err`
	`33`	`+ }`
	`34`	`+ result.CICD, err = cicd.FromCommandLine(c)`
`31`	`35`	`return &result, err`
`32`	`36`	`}`
`33`	`37`
`34`	`38`	`func (c *Config) MergeWithEnv() error {`
`35`	`39`	`if err := c.Database.MergeWithEnv(); err != nil {`
`36`	`40`	`return err`
`37`	`41`	`}`
`38`		`- return c.Docker.MergeWithEnv()`
	`42`	`+ if c.Docker != nil {`
	`43`	`+ return c.Docker.MergeWithEnv()`
	`44`	`+ }`
	`45`	`+ return nil`
`39`	`46`	`}`
`40`	`47`
`41`	`48`	`func (c *Config) MergeWithConfig(path string) error {`
`@@ -119,7 +126,7 @@ func (c Config) MergeWith(other Config) {`
`119`	`126`	`}`
`120`	`127`
`121`	`128`	`func (c *Config) Validate() error {`
`122`		`- if c.CICD != nil && c.CICD.K8s == nil && c.CICD.GithubAction == nil {`
	`129`	`+ if (c.CICD != nil && c.CICD.K8s == nil && c.CICD.GithubAction == nil) \|\| (c.Docker == nil \|\| c.Docker.Username == nil && c.Docker.Tag == nil) {`
`123`	`130`	`c.CICD = nil`
`124`	`131`	`}`
`125`	`132`	`err := c.Database.Validate()`
Original file line number	Diff line number	Diff line change
`@@ -23,14 +23,18 @@ func (docker Docker) MergeWith(other Docker) {`
`23`	`23`	`}`
`24`	`24`
`25`	`25`	`func (docker *Docker) MergeWithEnv() error {`
`26`		`- if os.Getenv("DOCKER_USERNAME") != "" {`
	`26`	`+ if docker.Username == nil && os.Getenv("DOCKER_USERNAME") != "" {`
`27`	`27`	`username := os.Getenv("DOCKER_USERNAME")`
`28`	`28`	`docker.Username = &username`
`29`	`29`	`}`
`30`		`- if os.Getenv("DOCKER_TAG") != "" {`
	`30`	`+ if docker.Tag == nil && os.Getenv("DOCKER_TAG") != "" {`
`31`	`31`	`tag := os.Getenv("DOCKER_TAG")`
`32`	`32`	`docker.Tag = &tag`
`33`	`33`	`}`
	`34`	`+ if docker.Tag == nil && os.Getenv("GITHUB_RUN_NUMBER") != "" {`
	`35`	`+ tag := "ci-v" + os.Getenv("GITHUB_RUN_NUMBER")`
	`36`	`+ docker.Tag = &tag`
	`37`	`+ }`
`34`	`38`	`return nil`
`35`	`39`	`}`
`36`	`40`
`@@ -42,7 +46,7 @@ func FromCommandLine(c cli.Context) (Docker, error) {`
`42`	`46`	`if tag := c.String("dockertag"); tag != "" {`
`43`	`47`	`result.Tag = &tag`
`44`	`48`	`}`
`45`		`- if result.Username == nil && result.Tag == nil {`
	`49`	`+ if c.Bool("nodocker") {`
`46`	`50`	`return nil, nil`
`47`	`51`	`}`
`48`	`52`	`return &result, nil`