Merge pull request #108 from nimblehq/feature/105-add-mock-server-add-on

[#105] [Part3] Add OpenAPI to support creating API documentation with OpenAPI

Author: carryall

cmd/create_test.go

@@ -1142,4 +1142,74 @@ var _ = Describe("Create template", func() {
 			Expect(content).To(ContainSubstring(expectedContent))
 		})
 	})
+
+	Context("given mock_server add-on", func() {
+		It("contains deploy_mock_server.yml file", func() {
+			cookiecutter := tests.Cookiecutter{
+				AppName:       "test-gin-templates",
+				UseMockServer: tests.Yes,
+			}
+			cookiecutter.CreateProjectFromGinTemplate(currentTemplatePath)
+			_, err := os.Stat(".github/workflows/deploy_mock_server.yml")
+
+			Expect(os.IsNotExist(err)).To(BeFalse())
+		})
+
+		It("contains Dockerfile.mock file", func() {
+			cookiecutter := tests.Cookiecutter{
+				AppName:       "test-gin-templates",
+				UseMockServer: tests.Yes,
+			}
+			cookiecutter.CreateProjectFromGinTemplate(currentTemplatePath)
+			_, err := os.Stat("Dockerfile.mock")
+
+			Expect(os.IsNotExist(err)).To(BeFalse())
+		})
+
+		It("contains fly.toml file", func() {
+			cookiecutter := tests.Cookiecutter{
+				AppName:       "test-gin-templates",
+				UseMockServer: tests.Yes,
+			}
+			cookiecutter.CreateProjectFromGinTemplate(currentTemplatePath)
+			_, err := os.Stat("fly.toml")
+
+			Expect(os.IsNotExist(err)).To(BeFalse())
+		})
+	})
+
+	Context("given NO mock_server add-on", func() {
+		It("does NOT contains deploy_mock_server.yml file", func() {
+			cookiecutter := tests.Cookiecutter{
+				AppName:       "test-gin-templates",
+				UseMockServer: tests.No,
+			}
+			cookiecutter.CreateProjectFromGinTemplate(currentTemplatePath)
+			_, err := os.Stat(".github/workflows/deploy_mock_server.yml")
+
+			Expect(os.IsNotExist(err)).To(BeTrue())
+		})
+
+		It("does NOT contains Dockerfile.mock file", func() {
+			cookiecutter := tests.Cookiecutter{
+				AppName:       "test-gin-templates",
+				UseMockServer: tests.No,
+			}
+			cookiecutter.CreateProjectFromGinTemplate(currentTemplatePath)
+			_, err := os.Stat("Dockerfile.mock")
+
+			Expect(os.IsNotExist(err)).To(BeTrue())
+		})
+
+		It("does NOT contains fly.toml file", func() {
+			cookiecutter := tests.Cookiecutter{
+				AppName:       "test-gin-templates",
+				UseMockServer: tests.No,
+			}
+			cookiecutter.CreateProjectFromGinTemplate(currentTemplatePath)
+			_, err := os.Stat("fly.toml")
+
+			Expect(os.IsNotExist(err)).To(BeTrue())
+		})
+	})
 })

cookiecutter.json

@@ -4,6 +4,7 @@
   "css_addon": ["Bootstrap", "Tailwind", "None"],
   "use_logrus": ["yes", "no"],
   "use_heroku": ["yes", "no"],
+  "use_mock_server": ["yes", "no"],
 
   "_api_variant": "no",
   "_web_variant": "no",

hooks/post_gen_project.py

@@ -109,6 +109,15 @@ def init_git(message):
     remove_file(".spectral.yaml")
     remove_file(".github/workflows/lint_docs.yml")
 
+# Remove mock_server if not seleted
+if '{{ cookiecutter.use_mock_server }}' == 'no':
+    print_log('Removing mock_server')
+
+    # mock_server related files
+    remove_file("Dockerfile.mock")
+    remove_file("fly.toml")
+    remove_file(".github/workflows/deploy_mock_server.yml")
+
 # Download the missing dependencies
 print_log('Downloading dependencies')
 subprocess.call(['go', 'mod', 'tidy'])

hooks/pre_gen_project.py

@@ -28,4 +28,13 @@
         {{ cookiecutter.update({ '_tailwind_addon': 'yes' }) }}
     {% endif %}
 {% endif %}
+
+-----------
+Mock Server
+cookiecutter.use_mock_server
+-----------
+Only project with openapi:
+{% if cookiecutter._api_variant == 'no' %}
+    {{ cookiecutter.update({ 'use_mock_server': 'no' }) }}
+{% endif %}
 '''

tests/cookiecutter.go

@@ -25,11 +25,12 @@ const (
 
 // Field and order MUST be the same as cookiecutter.json
 type Cookiecutter struct {
-	AppName   string
-	Variant   Variants
-	CssAddon  CssAddons
-	UseLogrus Choices
-	UseHeroku Choices
+	AppName       string
+	Variant       Variants
+	CssAddon      CssAddons
+	UseLogrus     Choices
+	UseHeroku     Choices
+	UseMockServer Choices
 }
 
 func (c *Cookiecutter) fillDefaultValue() {
@@ -45,6 +46,10 @@ func (c *Cookiecutter) fillDefaultValue() {
 		c.UseHeroku = No
 	}
 
+	if c.UseMockServer != Yes && c.UseMockServer != No {
+		c.UseMockServer = No
+	}
+
 	if c.CssAddon != Bootstrap && c.CssAddon != Tailwind && c.CssAddon != None {
 		c.CssAddon = None
 	}

{{cookiecutter.app_name}}/.github/workflows/deploy_mock_server.yml

@@ -0,0 +1,22 @@
+name: Deploy Mock Server
+
+on:
+  push:
+    branches:
+      - develop
+
+jobs:
+  deploy:
+    name: Deploy mock server
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Set up flyctl
+        uses: superfly/flyctl-actions/setup-flyctl@master
+
+      - name: Deploy to fly
+        run: flyctl deploy --remote-only
+        env:
+          FLY_API_TOKEN: {{ "${{ secrets.FLY_API_TOKEN }}" }}

{{cookiecutter.app_name}}/Dockerfile.mock

@@ -0,0 +1,7 @@
+FROM stoplight/prism:latest
+
+COPY /docs /usr/src/prism/packages/cli/docs/
+
+EXPOSE 80
+
+CMD ["mock", "-h", "0.0.0.0", "-p", "80", "docs/openapi/openapi.yml"]

{{cookiecutter.app_name}}/fly.toml

@@ -0,0 +1,13 @@
+app = "api-mock-server"
+primary_region = "sin"
+
+[build]
+  dockerfile = "Dockerfile.mock"
+
+[http_service]
+  internal_port = 80
+  force_https = true
+  auto_stop_machines = true
+  auto_start_machines = true
+  min_machines_running = 0
+  processes = ["app"]