chore: adjust directory structure of api (#1108)

chore: adjust directory structure of api
apache · Dec 25, 2020 · cc9eb35 · cc9eb35
1 parent 78b4031
commit cc9eb35
Show file tree

Hide file tree

Showing 35 changed files with 61 additions and 42 deletions.
diff --git a/.github/workflows/backend-unit-test.yml b/.github/workflows/backend-unit-test.yml
@@ -51,7 +51,7 @@ jobs:
           export GO111MOUDULE=on
           export APISIX_CONF_PATH=$PWD/conf
           sed -i 's/9000/8088/' conf/conf.yaml
-          go build -o ./manager-api
+          go build -o ./manager-api ./cmd/manager
           ./manager-api > ./api.log 2>&1 &
           sleep 2
           cat ./api.log

diff --git a/.github/workflows/frontend-e2e-test.yml b/.github/workflows/frontend-e2e-test.yml
@@ -41,7 +41,7 @@ jobs:
 
       - name: Start manager-api
         working-directory: ./api
-        run: nohup go run . &
+        run: nohup go run ./cmd/manager &
 
       - name: Install front-end dependencies
         run: yarn install

diff --git a/Dockerfile b/Dockerfile
@@ -45,7 +45,7 @@ RUN wget https://github.com/api7/dag-to-lua/archive/v1.1.tar.gz -O /tmp/v1.1.tar
 RUN if [ "$ENABLE_PROXY" = "true" ] ; then go env -w GOPROXY=https://goproxy.io,direct ; fi
 
 RUN go env -w GO111MODULE=on \
-    && CGO_ENABLED=0 go build -o ../output/manager-api .
+    && CGO_ENABLED=0 go build -o ../output/manager-api ./cmd/manager
 
 FROM node:14-alpine as fe-builder
 

diff --git a/Makefile b/Makefile
@@ -64,7 +64,7 @@ api-test: api-default
 ### api-run:		Run the manager-api
 .PHONY: api-run
 api-run: api-default
-	cd api/ && go run .
+	cd api/ && go run ./cmd/manager
 
 ### api-stop:		Stop the manager-api
 api-stop:

diff --git a/api/README.md b/api/README.md
@@ -24,3 +24,26 @@ This is a backend project which the dashboard depends on, implemented by Golang.
 ## Installation
 
 [Please refer to the doc](../README.md)
+
+## Project structure
+
+```text
+├── README.md
+├── VERSION
+├── build-tools
+├── build.sh
+├── cmd
+├── conf
+├── entry.sh
+├── go.mod
+├── go.sum
+├── internal
+├── run.sh
+└── test
+```
+
+1. The `cmd` directory is the project entrance.
+2. The `internal` directory contains the main logic of manager-api.
+3. The `conf` directory contains the default configuration file.
+4. The `test` directory contains E2E test cases.
+
diff --git a/api/build.sh b/api/build.sh
@@ -31,7 +31,7 @@ if [[ ! -f "dag-to-lua-1.1/lib/dag-to-lua.lua" ]]; then
 fi
 
 # build
-cd ./api && go build -o ../output/manager-api -ldflags "-X github.com/apisix/manager-api/cmd.Version=${VERSION}" . && cd ..
+cd ./api && go build -o ../output/manager-api -ldflags "-X github.com/apisix/manager-api/cmd.Version=${VERSION}" ./cmd/manager && cd ..
 
 cp ./api/conf/schema.json ./output/conf/schema.json
 cp ./api/conf/conf.yaml ./output/conf/conf.yaml

diff --git a/api/main.go → api/cmd/manager/main.go b/api/main.go → api/cmd/manager/main.go
diff --git a/api/cmd/managerapi.go b/api/cmd/managerapi.go
@@ -25,16 +25,15 @@ import (
 	"syscall"
 	"time"
 
-	"github.com/shiningrush/droplet"
-	"github.com/spf13/cobra"
-
-	"github.com/apisix/manager-api/conf"
 	"github.com/apisix/manager-api/internal"
+	"github.com/apisix/manager-api/internal/conf"
 	"github.com/apisix/manager-api/internal/core/storage"
 	"github.com/apisix/manager-api/internal/core/store"
 	"github.com/apisix/manager-api/internal/handler"
+	"github.com/apisix/manager-api/internal/log"
 	"github.com/apisix/manager-api/internal/utils"
-	"github.com/apisix/manager-api/log"
+	"github.com/shiningrush/droplet"
+	"github.com/spf13/cobra"
 )
 
 var Version string
@@ -47,7 +46,6 @@ func printInfo() {
 	fmt.Fprintf(os.Stdout, "%-8s: %s\n\n", "Logfile", conf.ErrorLogPath)
 }
 
-
 // NewManagerAPICommand creates the manager-api command.
 func NewManagerAPICommand() *cobra.Command {
 	cmd := &cobra.Command{

diff --git a/api/conf/conf.go → api/internal/conf/conf.go b/api/conf/conf.go → api/internal/conf/conf.go
diff --git a/api/internal/core/entity/format.go b/api/internal/core/entity/format.go
@@ -20,7 +20,7 @@ import (
 	"net"
 	"strconv"
 
-	"github.com/apisix/manager-api/log"
+	"github.com/apisix/manager-api/internal/log"
 )
 
 func mapKV2Node(key string, val float64) (*Node, error) {

diff --git a/api/internal/core/storage/etcd.go b/api/internal/core/storage/etcd.go
@@ -23,9 +23,9 @@ import (
 
 	"go.etcd.io/etcd/clientv3"
 
-	"github.com/apisix/manager-api/conf"
+	"github.com/apisix/manager-api/internal/conf"
+	"github.com/apisix/manager-api/internal/log"
 	"github.com/apisix/manager-api/internal/utils"
-	"github.com/apisix/manager-api/log"
 )
 
 var (

diff --git a/api/internal/core/store/query.go b/api/internal/core/store/query.go
@@ -16,7 +16,7 @@ package store
 
 import (
 	"github.com/apisix/manager-api/internal/core/entity"
-	"github.com/apisix/manager-api/log"
+	"github.com/apisix/manager-api/internal/log"
 )
 
 type Query struct {

diff --git a/api/internal/core/store/store.go b/api/internal/core/store/store.go
@@ -30,8 +30,8 @@ import (
 
 	"github.com/apisix/manager-api/internal/core/entity"
 	"github.com/apisix/manager-api/internal/core/storage"
+	"github.com/apisix/manager-api/internal/log"
 	"github.com/apisix/manager-api/internal/utils"
-	"github.com/apisix/manager-api/log"
 )
 
 type Interface interface {

diff --git a/api/internal/core/store/storehub.go b/api/internal/core/store/storehub.go
@@ -21,8 +21,8 @@ import (
 	"reflect"
 
 	"github.com/apisix/manager-api/internal/core/entity"
+	"github.com/apisix/manager-api/internal/log"
 	"github.com/apisix/manager-api/internal/utils"
-	"github.com/apisix/manager-api/log"
 )
 
 type HubKey string

diff --git a/api/internal/core/store/validate.go b/api/internal/core/store/validate.go
@@ -25,9 +25,9 @@ import (
 	"github.com/xeipuuv/gojsonschema"
 	"go.uber.org/zap/buffer"
 
-	"github.com/apisix/manager-api/conf"
+	"github.com/apisix/manager-api/internal/conf"
 	"github.com/apisix/manager-api/internal/core/entity"
-	"github.com/apisix/manager-api/log"
+	"github.com/apisix/manager-api/internal/log"
 )
 
 type Validator interface {

diff --git a/api/filter/authentication.go → api/internal/filter/authentication.go b/api/filter/authentication.go → api/internal/filter/authentication.go
@@ -22,9 +22,8 @@ import (
 
 	"github.com/dgrijalva/jwt-go"
 	"github.com/gin-gonic/gin"
-
-	"github.com/apisix/manager-api/conf"
-	"github.com/apisix/manager-api/log"
+	"github.com/apisix/manager-api/internal/conf"
+	"github.com/apisix/manager-api/internal/log"
 )
 
 func Authentication() gin.HandlerFunc {

diff --git a/api/filter/cors.go → api/internal/filter/cors.go b/api/filter/cors.go → api/internal/filter/cors.go
diff --git a/api/filter/logging.go → api/internal/filter/logging.go b/api/filter/logging.go → api/internal/filter/logging.go
diff --git a/api/filter/logging_test.go → api/internal/filter/logging_test.go b/api/filter/logging_test.go → api/internal/filter/logging_test.go
@@ -24,7 +24,7 @@ import (
 	"github.com/gin-gonic/gin"
 	"github.com/stretchr/testify/assert"
 
-	"github.com/apisix/manager-api/log"
+	"github.com/apisix/manager-api/internal/log"
 )
 
 func performRequest(r http.Handler, method, path string) *httptest.ResponseRecorder {

diff --git a/api/filter/recover.go → api/internal/filter/recover.go b/api/filter/recover.go → api/internal/filter/recover.go
@@ -24,8 +24,8 @@ import (
 	"runtime"
 	"time"
 
-	"github.com/apisix/manager-api/log"
 	"github.com/gin-gonic/gin"
+	"github.com/apisix/manager-api/internal/log"
 )
 
 var (

diff --git a/api/filter/request_id.go → api/internal/filter/request_id.go b/api/filter/request_id.go → api/internal/filter/request_id.go
diff --git a/api/filter/schema.go → api/internal/filter/schema.go b/api/filter/schema.go → api/internal/filter/schema.go
@@ -32,8 +32,8 @@ import (
 
 	"github.com/apisix/manager-api/internal/core/entity"
 	"github.com/apisix/manager-api/internal/core/store"
+	"github.com/apisix/manager-api/internal/log"
 	"github.com/apisix/manager-api/internal/utils/consts"
-	"github.com/apisix/manager-api/log"
 )
 
 var resources = map[string]string{

diff --git a/api/internal/handler/authentication/authentication.go b/api/internal/handler/authentication/authentication.go
@@ -27,7 +27,7 @@ import (
 	"github.com/shiningrush/droplet/wrapper"
 	wgin "github.com/shiningrush/droplet/wrapper/gin"
 
-	"github.com/apisix/manager-api/conf"
+	"github.com/apisix/manager-api/internal/conf"
 	"github.com/apisix/manager-api/internal/handler"
 )
 

diff --git a/api/internal/handler/plugin/plugin.go b/api/internal/handler/plugin/plugin.go
@@ -24,7 +24,7 @@ import (
 	"github.com/shiningrush/droplet/wrapper"
 	wgin "github.com/shiningrush/droplet/wrapper/gin"
 
-	"github.com/apisix/manager-api/conf"
+	"github.com/apisix/manager-api/internal/conf"
 	"github.com/apisix/manager-api/internal/handler"
 )
 

diff --git a/api/internal/handler/route/route.go b/api/internal/handler/route/route.go
@@ -29,16 +29,15 @@ import (
 	"github.com/shiningrush/droplet"
 	"github.com/shiningrush/droplet/data"
 	"github.com/shiningrush/droplet/wrapper"
-	wgin "github.com/shiningrush/droplet/wrapper/gin"
 	"github.com/yuin/gopher-lua"
-
-	"github.com/apisix/manager-api/conf"
+	wgin "github.com/shiningrush/droplet/wrapper/gin"
+	"github.com/apisix/manager-api/internal/conf"
 	"github.com/apisix/manager-api/internal/core/entity"
 	"github.com/apisix/manager-api/internal/core/store"
 	"github.com/apisix/manager-api/internal/handler"
+	"github.com/apisix/manager-api/internal/log"
 	"github.com/apisix/manager-api/internal/utils"
 	"github.com/apisix/manager-api/internal/utils/consts"
-	"github.com/apisix/manager-api/log"
 )
 
 type Handler struct {

diff --git a/api/internal/handler/route/route_test.go b/api/internal/handler/route/route_test.go
@@ -27,7 +27,7 @@ import (
 	"github.com/shiningrush/droplet/data"
 	"github.com/stretchr/testify/assert"
 
-	"github.com/apisix/manager-api/conf"
+	"github.com/apisix/manager-api/internal/conf"
 	"github.com/apisix/manager-api/internal/core/entity"
 	"github.com/apisix/manager-api/internal/core/storage"
 	"github.com/apisix/manager-api/internal/core/store"

diff --git a/api/internal/handler/service/service_test.go b/api/internal/handler/service/service_test.go
@@ -25,7 +25,7 @@ import (
 	"github.com/shiningrush/droplet"
 	"github.com/stretchr/testify/assert"
 
-	"github.com/apisix/manager-api/conf"
+	"github.com/apisix/manager-api/internal/conf"
 	"github.com/apisix/manager-api/internal/core/entity"
 	"github.com/apisix/manager-api/internal/core/storage"
 	"github.com/apisix/manager-api/internal/core/store"

diff --git a/api/internal/handler/ssl/ssl.go b/api/internal/handler/ssl/ssl.go
@@ -33,7 +33,7 @@ import (
 	"github.com/shiningrush/droplet/wrapper"
 	wgin "github.com/shiningrush/droplet/wrapper/gin"
 
-	"github.com/apisix/manager-api/conf"
+	"github.com/apisix/manager-api/internal/conf"
 	"github.com/apisix/manager-api/internal/core/entity"
 	"github.com/apisix/manager-api/internal/core/store"
 	"github.com/apisix/manager-api/internal/handler"

diff --git a/api/internal/handler/ssl/ssl_test.go b/api/internal/handler/ssl/ssl_test.go
@@ -25,7 +25,7 @@ import (
 	"github.com/shiningrush/droplet"
 	"github.com/stretchr/testify/assert"
 
-	"github.com/apisix/manager-api/conf"
+	"github.com/apisix/manager-api/internal/conf"
 	"github.com/apisix/manager-api/internal/core/entity"
 	"github.com/apisix/manager-api/internal/core/storage"
 	"github.com/apisix/manager-api/internal/core/store"

diff --git a/api/internal/handler/upstream/upstream_test.go b/api/internal/handler/upstream/upstream_test.go
@@ -25,7 +25,7 @@ import (
 	"github.com/shiningrush/droplet"
 	"github.com/stretchr/testify/assert"
 
-	"github.com/apisix/manager-api/conf"
+	"github.com/apisix/manager-api/internal/conf"
 	"github.com/apisix/manager-api/internal/core/entity"
 	"github.com/apisix/manager-api/internal/core/storage"
 	"github.com/apisix/manager-api/internal/core/store"

diff --git a/api/log/log.go → api/internal/log/log.go b/api/log/log.go → api/internal/log/log.go
diff --git a/api/log/zap.go → api/internal/log/zap.go b/api/log/zap.go → api/internal/log/zap.go
@@ -22,7 +22,7 @@ import (
 	"go.uber.org/zap"
 	"go.uber.org/zap/zapcore"
 
-	"github.com/apisix/manager-api/conf"
+	"github.com/apisix/manager-api/internal/conf"
 )
 
 var logger *zap.SugaredLogger

diff --git a/api/internal/route.go b/api/internal/route.go
@@ -26,8 +26,8 @@ import (
 	"github.com/gin-contrib/static"
 	"github.com/gin-gonic/gin"
 
-	"github.com/apisix/manager-api/conf"
-	"github.com/apisix/manager-api/filter"
+	"github.com/apisix/manager-api/internal/conf"
+	"github.com/apisix/manager-api/internal/filter"
 	"github.com/apisix/manager-api/internal/handler"
 	"github.com/apisix/manager-api/internal/handler/authentication"
 	"github.com/apisix/manager-api/internal/handler/consumer"
@@ -40,7 +40,7 @@ import (
 	"github.com/apisix/manager-api/internal/handler/service"
 	"github.com/apisix/manager-api/internal/handler/ssl"
 	"github.com/apisix/manager-api/internal/handler/upstream"
-	"github.com/apisix/manager-api/log"
+	"github.com/apisix/manager-api/internal/log"
 )
 
 func SetUpRouter() *gin.Engine {

diff --git a/api/test/docker/Dockerfile b/api/test/docker/Dockerfile
@@ -25,7 +25,7 @@ RUN mkdir -p /go/manager-api/conf \
     && mkdir -p /go/manager-api/build-tools \
     && go env -w GOPROXY=https://goproxy.io,direct \
     && export GOPROXY=https://goproxy.io \
-    && go build -o /go/manager-api/manager-api \
+    && go build -o /go/manager-api/manager-api ./cmd/manager \
     && mv /go/src/github.com/apisix/manager-api/entry.sh /go/manager-api/ \
     && mv /go/src/github.com/apisix/manager-api/build-tools/* /go/manager-api/build-tools/ \
     && mv /go/src/github.com/apisix/manager-api/conf/conf.yaml /go/manager-api/conf/conf.yaml \

diff --git a/api/test/shell/cli_test.sh b/api/test/shell/cli_test.sh
@@ -40,7 +40,7 @@ clean_logfile() {
 trap clean_up EXIT
 
 export GO111MODULE=on
-go build -o ./manager-api -ldflags "-X github.com/apisix/manager-api/cmd.Version=${VERSION}" .
+go build -o ./manager-api -ldflags "-X github.com/apisix/manager-api/cmd.Version=${VERSION}" ./cmd/manager
 
 # default level: warn, path: logs/error.log