feat: split cmd package code (#1932)

Author: bzp2010

.github/workflows/backend-unit-test.yml

@@ -50,7 +50,7 @@ jobs:
           export GO111MOUDULE=on
           export APISIX_CONF_PATH=$PWD/conf
           sed -i 's/9000/8088/' conf/conf.yaml
-          go build -o ./manager-api ./cmd/manager
+          go build -o ./manager-api ./main.go
           ./manager-api > ./api.log 2>&1 &
           sleep 2
           cat ./api.log

.github/workflows/frontend-e2e-test.yml

@@ -55,7 +55,7 @@ jobs:
         working-directory: ./api
         run: |
           sed -i 's@# - dubbo-proxy@- dubbo-proxy@' ./conf/conf.yaml
-          nohup go run ./cmd/manager &
+          nohup go run ./main.go &
 
       - name: Cache node_modules
         uses: actions/[email protected]

.github/workflows/frontend-plugin-e2e-test.yml

@@ -57,7 +57,7 @@ jobs:
         working-directory: ./api
         run: |
           sed -i 's@# - dubbo-proxy@- dubbo-proxy@' ./conf/conf.yaml
-          nohup go run ./cmd/manager &
+          nohup go run ./main.go &
 
       - name: Cache node_modules
         uses: actions/[email protected]

Makefile

@@ -80,7 +80,7 @@ api-run: api-default
 
 ### api-stop:		Stop the manager-api
 api-stop:
-	cd api && go run -ldflags "${GOLDFLAGS}" ./cmd/manager stop
+	cd api && go run -ldflags "${GOLDFLAGS}" ./main.go stop
 
 ### go-lint:		Lint Go source codes
 .PHONY: go-lint

api/build.sh

@@ -24,7 +24,7 @@ GOLDFLAGS="-X github.com/apisix/manager-api/internal/utils.version=${VERSION} -X
 
 # Enter dry-run mode
 if [ "$1" == "--dry-run" ]; then
-    cd ./api && go run -ldflags "${GOLDFLAGS}" ./cmd/manager
+    cd ./api && go run -ldflags "${GOLDFLAGS}" ./main.go
     exit 0
 fi
 
@@ -42,7 +42,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 "${GOLDFLAGS}" ./cmd/manager && cd ..
+cd ./api && go build -o ../output/manager-api -ldflags "${GOLDFLAGS}" ./main.go && cd ..
 
 cp ./api/conf/schema.json ./output/conf/schema.json
 cp ./api/conf/conf.yaml ./output/conf/conf.yaml

api/cmd/install.go

@@ -0,0 +1,38 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package cmd
+
+import (
+	"fmt"
+
+	"github.com/spf13/cobra"
+)
+
+var service *Service
+
+func newInstallCommand() *cobra.Command {
+	return &cobra.Command{
+		Use:   "install",
+		Short: "re-install Apache APISIX Dashboard service",
+		RunE: func(cmd *cobra.Command, args []string) error {
+			serviceState.installService = true
+			status, err := service.manageService()
+			fmt.Println(status)
+			return err
+		},
+	}
+}

api/cmd/remove.go

@@ -0,0 +1,36 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package cmd
+
+import (
+	"fmt"
+
+	"github.com/spf13/cobra"
+)
+
+func newRemoveCommand() *cobra.Command {
+	return &cobra.Command{
+		Use:   "remove",
+		Short: "remove Apache APISIX Dashboard service",
+		RunE: func(cmd *cobra.Command, args []string) error {
+			serviceState.removeService = true
+			status, err := service.manageService()
+			fmt.Println(status)
+			return err
+		},
+	}
+}

api/cmd/managerapi.go renamed to api/cmd/root.go

@@ -42,30 +42,19 @@ import (
 )
 
 var (
-	showVersion bool
-	Version     string
-	GitHash     string
-	service     *Service
+	configFile string
 )
 
-func printInfo() {
-	fmt.Fprint(os.Stdout, "The manager-api is running successfully!\n\n")
-	printVersion()
-	fmt.Fprintf(os.Stdout, "%-8s: %s:%d\n", "Listen", conf.ServerHost, conf.ServerPort)
-	if conf.SSLCert != "" && conf.SSLKey != "" {
-		fmt.Fprintf(os.Stdout, "%-8s: %s:%d\n", "HTTPS Listen", conf.SSLHost, conf.SSLPort)
-	}
-	fmt.Fprintf(os.Stdout, "%-8s: %s\n", "Loglevel", conf.ErrorLogLevel)
-	fmt.Fprintf(os.Stdout, "%-8s: %s\n\n", "Logfile", conf.ErrorLogPath)
-}
-
-func printVersion() {
-	fmt.Fprintf(os.Stdout, "%-8s: %s\n", "Version", Version)
-	fmt.Fprintf(os.Stdout, "%-8s: %s\n", "GitHash", GitHash)
+var rootCmd = &cobra.Command{
+	Use:   "manager-api [flags]",
+	Short: "Apache APISIX Manager API",
+	RunE: func(cmd *cobra.Command, args []string) error {
+		err := manageAPI()
+		return err
+	},
 }
 
-// NewManagerAPICommand creates the manager-api command.
-func NewManagerAPICommand() *cobra.Command {
+func init() {
 	cobra.OnInitialize(func() {
 		var err error
 		service, err = createService()
@@ -74,25 +63,23 @@ func NewManagerAPICommand() *cobra.Command {
 		}
 	})
 
-	cmd := &cobra.Command{
-		Use:   "manager-api [flags]",
-		Short: "APISIX Manager API",
-		RunE: func(cmd *cobra.Command, args []string) error {
-			GitHash, Version = utils.GetHashAndVersion()
-			if showVersion {
-				printVersion()
-				os.Exit(0)
-			}
-			err := manageAPI()
-			return err
-		},
-	}
-
-	cmd.PersistentFlags().StringVarP(&conf.WorkDir, "work-dir", "p", ".", "current work directory")
-	cmd.PersistentFlags().BoolVarP(&showVersion, "version", "v", false, "show manager-api version")
+	rootCmd.PersistentFlags().StringVarP(&configFile, "config", "c", "./conf/conf.yml", "config file")
+	rootCmd.PersistentFlags().StringVarP(&conf.WorkDir, "work-dir", "p", ".", "current work directory")
+
+	rootCmd.AddCommand(
+		newVersionCommand(),
+		newInstallCommand(),
+		newRemoveCommand(),
+		newStartCommand(),
+		newStopCommand(),
+		newStatusCommand(),
+	)
+}
 
-	cmd.AddCommand(newStartCommand(), newInstallCommand(), newStatusCommand(), newStopCommand(), newRemoveCommand())
-	return cmd
+func Execute() {
+	if err := rootCmd.Execute(); err != nil {
+		_, _ = fmt.Fprintln(os.Stderr, err.Error())
+	}
 }
 
 func manageAPI() error {
@@ -211,80 +198,13 @@ func shutdownServer(server *http.Server) {
 	}
 }
 
-func newStartCommand() *cobra.Command {
-	cmd := &cobra.Command{
-		Use:   "start",
-		Short: "start Apache APISIX Dashboard service",
-		RunE: func(cmd *cobra.Command, args []string) error {
-			serviceState.startService = true
-			status, err := service.manageService()
-			fmt.Println(status)
-			return err
-		},
-	}
-	return cmd
-}
-
-func newInstallCommand() *cobra.Command {
-	cmd := &cobra.Command{
-		Use:   "install",
-		Short: "re-install Apache APISIX Dashboard service",
-		RunE: func(cmd *cobra.Command, args []string) error {
-			serviceState.installService = true
-			status, err := service.manageService()
-			fmt.Println(status)
-			return err
-		},
-	}
-	return cmd
-}
-
-func newStatusCommand() *cobra.Command {
-	cmd := &cobra.Command{
-		Use:   "status",
-		Short: "inspect the status of Apache APISIX Dashboard service",
-		RunE: func(cmd *cobra.Command, args []string) error {
-			serviceState.status = true
-			status, err := service.manageService()
-			fmt.Println(status)
-			return err
-		},
-	}
-	return cmd
-}
-
-func newStopCommand() *cobra.Command {
-	cmd := &cobra.Command{
-		Use:   "stop",
-		Short: "stop Apache APISIX Dashboard service/program",
-		Run: func(cmd *cobra.Command, args []string) {
-			pid, err := utils.ReadPID(conf.PIDPath)
-			if err != nil {
-				if syscall.ENOENT.Error() != err.Error() {
-					fmt.Fprintf(os.Stderr, "failed to get manager-api pid: %s\n", err)
-				} else {
-					fmt.Fprintf(os.Stderr, "pid path %s not found, is manager-api running?\n", conf.PIDPath)
-				}
-				return
-			}
-			if err := syscall.Kill(pid, syscall.SIGINT); err != nil {
-				fmt.Fprintf(os.Stderr, "failed to kill manager-api: %s", err)
-			}
-		},
-	}
-	return cmd
-}
-
-func newRemoveCommand() *cobra.Command {
-	cmd := &cobra.Command{
-		Use:   "remove",
-		Short: "remove Apache APISIX Dashboard service",
-		RunE: func(cmd *cobra.Command, args []string) error {
-			serviceState.removeService = true
-			status, err := service.manageService()
-			fmt.Println(status)
-			return err
-		},
+func printInfo() {
+	fmt.Fprint(os.Stdout, "The manager-api is running successfully!\n\n")
+	printVersion()
+	fmt.Fprintf(os.Stdout, "%-8s: %s:%d\n", "Listen", conf.ServerHost, conf.ServerPort)
+	if conf.SSLCert != "" && conf.SSLKey != "" {
+		fmt.Fprintf(os.Stdout, "%-8s: %s:%d\n", "HTTPS Listen", conf.SSLHost, conf.SSLPort)
 	}
-	return cmd
+	fmt.Fprintf(os.Stdout, "%-8s: %s\n", "Loglevel", conf.ErrorLogLevel)
+	fmt.Fprintf(os.Stdout, "%-8s: %s\n\n", "Logfile", conf.ErrorLogPath)
 }

api/cmd/service.go

@@ -20,8 +20,9 @@ import (
 	"os"
 	"runtime"
 
-	"github.com/apisix/manager-api/internal/conf"
 	"github.com/takama/daemon"
+
+	"github.com/apisix/manager-api/internal/conf"
 )
 
 type Service struct {

api/cmd/start.go

@@ -0,0 +1,36 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package cmd
+
+import (
+	"fmt"
+
+	"github.com/spf13/cobra"
+)
+
+func newStartCommand() *cobra.Command {
+	return &cobra.Command{
+		Use:   "start",
+		Short: "start Apache APISIX Dashboard service",
+		RunE: func(cmd *cobra.Command, args []string) error {
+			serviceState.startService = true
+			status, err := service.manageService()
+			fmt.Println(status)
+			return err
+		},
+	}
+}