Merge pull request #808 from marle3003/develop

Develop

Author: marle3003

.github/actions/build-mokapi-image/action.yml

@@ -14,6 +14,18 @@ inputs:
 runs:
   using: "composite"
   steps:
+    - uses: actions/setup-go@v5
+      with:
+        go-version: 1.25.5
+    - name: Build CLI doc
+      run: go run ./cmd/internal/gen-cli-docs/main.go
+      shell: bash
+    - name: Add CLI Flags nav entry
+      run: |
+        jq '.Configuration.items.Static.items["CLI Flags"] = "configuration/static/mokapi.md"' ./config.json > ./tmp.json
+        mv ./tmp.json ./config.json
+      working-directory: ./docs
+      shell: bash
     - name: Build docker alpha image
       run: docker build --build-arg VERSION=${{ inputs.version }} -t ${{ inputs.image-name }} -t mokapi/mokapi:alpha -f ./images/alpha.Dockerfile .
       shell: bash

.github/actions/publish-website/action.yml

@@ -29,6 +29,15 @@ runs:
         repository: marle3003/mokapi
         excludes: prerelease, draft
         token: ${{ inputs.token }}
+    - name: Download image
+      id: download
+      uses: actions/download-artifact@v4
+      with:
+        name: ${{ env.image-artifact-name }}
+        path: /tmp
+    - name: Load image
+      run: docker load --input /tmp/mokapi.tar
+      shell: bash
     - name: Run mokapi image
       run: docker run --name mokapi --rm -d -p 80:80 -p 8080:8080 -p 9092:9092 -p 8389:8389 -p 8025:8025 --mount type=bind,source=$(pwd)/webui/scripts/dashboard-demo/demo-configs,target=/data --env MOKAPI_Providers_File_Directory=/data ${{ inputs.image-name }}
       shell: bash
@@ -42,11 +51,25 @@ runs:
       if: always()
       run: docker stop mokapi || true
       shell: bash
-    - name: build website
+    - name: build webui
       working-directory: ./webui
       run: |
         npm install
         npm version ${{ steps.release.outputs.release }}
+        npm run build
+      shell: bash
+    - name: Build CLI doc
+      run: go run ./cmd/internal/gen-cli-docs/main.go
+      shell: bash
+    - name: Add CLI Flags nav entry
+      run: |
+         jq '.Configuration.items.Static.items["CLI Flags"] = "configuration/static/mokapi.md"' ./config.json > ./tmp.json
+         mv ./tmp.json ./config.json
+      working-directory: ./docs
+      shell: bash
+    - name: build website
+      working-directory: ./webui
+      run: |
         npm run copy-docs
         npm run build-sitemap
         npm run build-website
@@ -55,6 +78,16 @@ runs:
       working-directory: ./webui
       run: npx playwright install --with-deps
       shell: bash
+    - name: test website
+      working-directory: ./webui
+      run: npx playwright test --project=website
+      shell: bash
+    - name: Upload test results
+      if: always()
+      uses: actions/upload-artifact@v4
+      with:
+        name: website-test-report
+        path: webui/playwright-report
     - name: prerender
       working-directory: ./webui/ssg
       run: node index.js

acceptance/ldap_test.go

@@ -2,13 +2,14 @@ package acceptance
 
 import (
 	"fmt"
-	"github.com/stretchr/testify/require"
 	"mokapi/config/static"
 	"mokapi/ldap"
 	"mokapi/runtime/metrics"
 	"mokapi/try"
 	"net/http"
 	"time"
+
+	"github.com/stretchr/testify/require"
 )
 
 type LdapSuite struct {
@@ -18,8 +19,7 @@ type LdapSuite struct {
 
 func (suite *LdapSuite) SetupSuite() {
 	cfg := static.NewConfig()
-	port := try.GetFreePort()
-	cfg.Api.Port = fmt.Sprintf("%v", port)
+	cfg.Api.Port = try.GetFreePort()
 	cfg.Providers.File.Directories = []string{"./ldap"}
 	suite.initCmd(cfg)
 	// ensure scripts are executed

acceptance/mail_test.go

@@ -23,8 +23,7 @@ type MailSuite struct{ BaseSuite }
 
 func (suite *MailSuite) SetupSuite() {
 	cfg := static.NewConfig()
-	port := try.GetFreePort()
-	cfg.Api.Port = fmt.Sprintf("%v", port)
+	cfg.Api.Port = try.GetFreePort()
 	wd, err := os.Getwd()
 	require.NoError(suite.T(), err)
 	cfg.ConfigFile = path.Join(wd, "mokapi.yaml")

acceptance/petstore_test.go

@@ -23,8 +23,7 @@ type PetStoreSuite struct{ BaseSuite }
 
 func (suite *PetStoreSuite) SetupSuite() {
 	cfg := static.NewConfig()
-	port := try.GetFreePort()
-	cfg.Api.Port = fmt.Sprintf("%v", port)
+	cfg.Api.Port = try.GetFreePort()
 	cfg.Providers.File.Directories = []string{"./petstore"}
 	cfg.Api.Search.Enabled = true
 	suite.initCmd(cfg)
@@ -172,7 +171,7 @@ func (suite *PetStoreSuite) TestJsHttpHandler() {
 		try.BodyContains(`"name":"Zoe"`))
 
 	// test http metrics
-	try.GetRequest(suite.T(), fmt.Sprintf("http://127.0.0.1:%s/api/metrics/http?path=/pet/{petId}", suite.cfg.Api.Port), nil,
+	try.GetRequest(suite.T(), fmt.Sprintf("http://127.0.0.1:%d/api/metrics/http?path=/pet/{petId}", suite.cfg.Api.Port), nil,
 		try.BodyContains(`http_requests_total{service=\"Swagger Petstore\",endpoint=\"/pet/{petId}\"}","value":4}`),
 	)
 }
@@ -307,12 +306,12 @@ func (suite *PetStoreSuite) TestKafkaEventAndMetrics() {
 	time.Sleep(3 * time.Second)
 
 	// test kafka metrics
-	try.GetRequest(suite.T(), fmt.Sprintf("http://127.0.0.1:%s/api/metrics/kafka", suite.cfg.Api.Port), nil,
+	try.GetRequest(suite.T(), fmt.Sprintf("http://127.0.0.1:%d/api/metrics/kafka", suite.cfg.Api.Port), nil,
 		try.BodyContains(`kafka_messages_total{service=\"A sample AsyncApi Kafka streaming api\",topic=\"petstore.order-event\"}","value":1}`),
 	)
 
 	// test kafka events, header added by JavaScript event handler
-	try.GetRequest(suite.T(), fmt.Sprintf("http://127.0.0.1:%s/api/events?namespace=kafka", suite.cfg.Api.Port), nil,
+	try.GetRequest(suite.T(), fmt.Sprintf("http://127.0.0.1:%d/api/events?namespace=kafka", suite.cfg.Api.Port), nil,
 		try.BodyContains(`"headers":{"foo":{"value":"bar","binary":"YmFy"}`),
 		try.BodyContains(`"messageId":"order"`),
 	)

api/handler_test.go

@@ -1,7 +1,6 @@
 package api_test
 
 import (
-	"github.com/stretchr/testify/require"
 	"mokapi/api"
 	"mokapi/config/static"
 	"mokapi/providers/openapi"
@@ -11,6 +10,8 @@ import (
 	"net/http"
 	"net/http/httptest"
 	"testing"
+
+	"github.com/stretchr/testify/require"
 )
 
 func TestHandler_ServeHTTP(t *testing.T) {
@@ -57,7 +58,7 @@ func TestHandler_ServeHTTP(t *testing.T) {
 					h,
 					try.HasStatusCode(200),
 					try.HasHeader("Content-Type", "application/json"),
-					try.HasBody(`{"version":"","buildTime":"","search":{"enabled":false}}`))
+					try.HasBody(`{"version":"0.0.0","buildTime":"","search":{"enabled":false}}`))
 			},
 		},
 		{
@@ -120,7 +121,7 @@ func TestHandler_Api_Info(t *testing.T) {
 					h,
 					try.HasStatusCode(200),
 					try.HasHeader("Content-Type", "application/json"),
-					try.HasBody(`{"version":"","buildTime":"","activeServices":["http"],"search":{"enabled":false}}`))
+					try.HasBody(`{"version":"0.0.0","buildTime":"","activeServices":["http"],"search":{"enabled":false}}`))
 			},
 		},
 		{
@@ -135,7 +136,7 @@ func TestHandler_Api_Info(t *testing.T) {
 					h,
 					try.HasStatusCode(200),
 					try.HasHeader("Content-Type", "application/json"),
-					try.HasBody(`{"version":"","buildTime":"","activeServices":["kafka"],"search":{"enabled":false}}`))
+					try.HasBody(`{"version":"0.0.0","buildTime":"","activeServices":["kafka"],"search":{"enabled":false}}`))
 			},
 		},
 		{
@@ -150,7 +151,7 @@ func TestHandler_Api_Info(t *testing.T) {
 					h,
 					try.HasStatusCode(200),
 					try.HasHeader("Content-Type", "application/json"),
-					try.HasBody(`{"version":"","buildTime":"","activeServices":["mail"],"search":{"enabled":false}}`))
+					try.HasBody(`{"version":"0.0.0","buildTime":"","activeServices":["mail"],"search":{"enabled":false}}`))
 			},
 		},
 		{
@@ -165,7 +166,7 @@ func TestHandler_Api_Info(t *testing.T) {
 					h,
 					try.HasStatusCode(200),
 					try.HasHeader("Content-Type", "application/json"),
-					try.HasBody(`{"version":"","buildTime":"","activeServices":["ldap"],"search":{"enabled":false}}`))
+					try.HasBody(`{"version":"0.0.0","buildTime":"","activeServices":["ldap"],"search":{"enabled":false}}`))
 			},
 		},
 	}
@@ -204,5 +205,5 @@ func TestHandler_SearchEnabled(t *testing.T) {
 		h,
 		try.HasStatusCode(200),
 		try.HasHeader("Content-Type", "application/json"),
-		try.HasBody(`{"version":"","buildTime":"","search":{"enabled":true}}`))
+		try.HasBody(`{"version":"0.0.0","buildTime":"","search":{"enabled":true}}`))
 }

cmd/internal/gen-cli-docs/main.go

@@ -0,0 +1,13 @@
+package main
+
+import (
+	"mokapi/pkg/cmd/mokapi"
+	"os"
+)
+
+func main() {
+	err := mokapi.NewGenCliDocCmd().Execute()
+	if err != nil {
+		_, _ = os.Stderr.Write([]byte(err.Error()))
+	}
+}