Add the 'deployment' command into CLI (#325)

* Upgrade the 'GJSON' package

* Add the 'deployment' command

* Add the subcommands: 'get', 'list', 'deploy', and 'update'

* Add unit tests for deployment

Author: Noah Lee

cmd/cli/deployment.go

@@ -0,0 +1,15 @@
+package main
+
+import "github.com/urfave/cli/v2"
+
+var deploymentCommand = &cli.Command{
+	Name:    "deployment",
+	Aliases: []string{"d"},
+	Usage:   "Manage deployments.",
+	Subcommands: []*cli.Command{
+		deploymentListCommand,
+		deploymentGetCommand,
+		deploymentDeployCommand,
+		deploymentUpdateCommand,
+	},
+}

cmd/cli/deployment_deploy.go

@@ -0,0 +1,48 @@
+package main
+
+import (
+	"github.com/urfave/cli/v2"
+
+	"github.com/gitploy-io/gitploy/pkg/api"
+)
+
+var deploymentDeployCommand = &cli.Command{
+	Name:      "deploy",
+	Usage:     "Deploy a specific ref(branch, SHA, tag) to the environment.",
+	ArgsUsage: "<owner>/<repo>",
+	Flags: []cli.Flag{
+		&cli.StringFlag{
+			Name:     "type",
+			Usage:    "The type of the ref: 'commit', 'branch', or 'tag'.",
+			Required: true,
+		},
+		&cli.StringFlag{
+			Name:     "env",
+			Usage:    "The name of the environment.",
+			Required: true,
+		},
+		&cli.StringFlag{
+			Name:     "ref",
+			Usage:    "The specific ref. It can be any any named branch, tag, or SHA.",
+			Required: true,
+		},
+	},
+	Action: func(cli *cli.Context) error {
+		ns, n, err := splitFullName(cli.Args().First())
+		if err != nil {
+			return err
+		}
+
+		c := buildClient(cli)
+		d, err := c.Deployment.Create(cli.Context, ns, n, api.DeploymentCreateRequest{
+			Type: cli.String("type"),
+			Ref:  cli.String("ref"),
+			Env:  cli.String("env"),
+		})
+		if err != nil {
+			return err
+		}
+
+		return printJson(d, cli.String("query"))
+	},
+}

cmd/cli/deployment_get.go

@@ -0,0 +1,33 @@
+package main
+
+import (
+	"strconv"
+
+	"github.com/urfave/cli/v2"
+)
+
+var deploymentGetCommand = &cli.Command{
+	Name:      "get",
+	Usage:     "Show the deployment",
+	ArgsUsage: "<owner>/<repo> <number>",
+	Action: func(cli *cli.Context) error {
+		// Validate arguments.
+		ns, n, err := splitFullName(cli.Args().First())
+		if err != nil {
+			return err
+		}
+
+		number, err := strconv.Atoi(cli.Args().Get(1))
+		if err != nil {
+			return err
+		}
+
+		c := buildClient(cli)
+		d, err := c.Deployment.Get(cli.Context, ns, n, number)
+		if err != nil {
+			return err
+		}
+
+		return printJson(d, cli.String("query"))
+	},
+}

cmd/cli/deployment_list.go

@@ -0,0 +1,54 @@
+package main
+
+import (
+	"github.com/urfave/cli/v2"
+
+	"github.com/gitploy-io/gitploy/model/ent/deployment"
+	"github.com/gitploy-io/gitploy/pkg/api"
+)
+
+var deploymentListCommand = &cli.Command{
+	Name:      "list",
+	Aliases:   []string{"ls"},
+	Usage:     "Show the deployments under the repository.",
+	ArgsUsage: "<owner>/<repo>",
+	Flags: []cli.Flag{
+		&cli.IntFlag{
+			Name:  "page",
+			Value: 1,
+			Usage: "The page of list.",
+		},
+		&cli.IntFlag{
+			Name:  "per-page",
+			Value: 30,
+			Usage: "The item count per page.",
+		},
+		&cli.StringFlag{
+			Name:  "env",
+			Usage: "The name of environment. It only shows deployments for the environment.",
+		},
+		&cli.StringFlag{
+			Name:  "status",
+			Usage: "The deployment status: 'waiting', 'created', 'queued', 'running', 'success', or 'failure'. It only shows deployments the status is matched. ",
+		},
+	},
+	Action: func(cli *cli.Context) error {
+		c := buildClient(cli)
+
+		ns, n, err := splitFullName(cli.Args().First())
+		if err != nil {
+			return err
+		}
+
+		ds, err := c.Deployment.List(cli.Context, ns, n, api.DeploymentListOptions{
+			ListOptions: api.ListOptions{Page: cli.Int("page"), PerPage: cli.Int("per-page")},
+			Env:         cli.String("env"),
+			Status:      deployment.Status(cli.String("status")),
+		})
+		if err != nil {
+			return err
+		}
+
+		return printJson(ds, cli.String("query"))
+	},
+}

cmd/cli/deployment_update.go

@@ -0,0 +1,32 @@
+package main
+
+import (
+	"strconv"
+
+	"github.com/urfave/cli/v2"
+)
+
+var deploymentUpdateCommand = &cli.Command{
+	Name:      "update",
+	Usage:     "Trigger the deployment which has approved by reviews.",
+	ArgsUsage: "<owner>/<repo> <number>",
+	Action: func(cli *cli.Context) error {
+		ns, n, err := splitFullName(cli.Args().First())
+		if err != nil {
+			return err
+		}
+
+		number, err := strconv.Atoi(cli.Args().Get(1))
+		if err != nil {
+			return err
+		}
+
+		c := buildClient(cli)
+		d, err := c.Deployment.Update(cli.Context, ns, n, number)
+		if err != nil {
+			return err
+		}
+
+		return printJson(d, cli.String("query"))
+	},
+}

cmd/cli/main.go

@@ -33,6 +33,7 @@ func main() {
 		},
 		Commands: []*cli.Command{
 			repoCommand,
+			deploymentCommand,
 		},
 	}
 

cmd/cli/repo.go

@@ -6,7 +6,7 @@ import (
 
 var repoCommand *cli.Command = &cli.Command{
 	Name:  "repo",
-	Usage: "Manage repos.",
+	Usage: "Manage repositories.",
 	Subcommands: []*cli.Command{
 		repoListCommand,
 		repoGetCommand,

cmd/cli/shared.go

@@ -1,9 +1,11 @@
 package main
 
 import (
+	"encoding/json"
 	"fmt"
 	"strings"
 
+	"github.com/tidwall/gjson"
 	"github.com/urfave/cli/v2"
 	"golang.org/x/oauth2"
 
@@ -20,6 +22,7 @@ func buildClient(cli *cli.Context) *api.Client {
 	return api.NewClient(cli.String("host"), tc)
 }
 
+// splitFullName splits the full name into namespace, and name.
 func splitFullName(name string) (string, string, error) {
 	ss := strings.Split(name, "/")
 	if len(ss) != 2 {
@@ -28,3 +31,19 @@ func splitFullName(name string) (string, string, error) {
 
 	return ss[0], ss[1], nil
 }
+
+// printJson prints the object as JSON-format.
+func printJson(v interface{}, query string) error {
+	output, err := json.MarshalIndent(v, "", "  ")
+	if err != nil {
+		return fmt.Errorf("Failed to marshal: %w", err)
+	}
+
+	if query != "" {
+		fmt.Println(gjson.GetBytes(output, query))
+		return nil
+	}
+
+	fmt.Println(string(output))
+	return nil
+}

go.mod

@@ -61,7 +61,7 @@ require (
 	github.com/russross/blackfriday/v2 v2.0.1 // indirect
 	github.com/shurcooL/graphql v0.0.0-20200928012149-18c5c3165e3a // indirect
 	github.com/shurcooL/sanitized_anchor_name v1.0.0 // indirect
-	github.com/tidwall/gjson v1.13.0 // indirect
+	github.com/tidwall/gjson v1.14.0 // indirect
 	github.com/tidwall/match v1.1.1 // indirect
 	github.com/tidwall/pretty v1.2.0 // indirect
 	github.com/ugorji/go/codec v1.2.6 // indirect

go.sum

@@ -448,6 +448,8 @@ github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/
 github.com/subosito/gotenv v1.2.0/go.mod h1:N0PQaV/YGNqwC0u51sEeR/aUtSLEXKX9iv69rRypqCw=
 github.com/tidwall/gjson v1.13.0 h1:3TFY9yxOQShrvmjdM76K+jc66zJeT6D3/VFFYCGQf7M=
 github.com/tidwall/gjson v1.13.0/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk=
+github.com/tidwall/gjson v1.14.0 h1:6aeJ0bzojgWLa82gDQHcx3S0Lr/O51I9bJ5nv6JFx5w=
+github.com/tidwall/gjson v1.14.0/go.mod h1:/wbyibRr2FHMks5tjHJ5F8dMZh3AcwJEMf5vlfC0lxk=
 github.com/tidwall/match v1.1.1 h1:+Ho715JplO36QYgwN9PGYNhgZvoUSc9X2c80KVTi+GA=
 github.com/tidwall/match v1.1.1/go.mod h1:eRSPERbgtNPcGhD8UCthc6PmLEQXEWd3PRB5JTxsfmM=
 github.com/tidwall/pretty v1.2.0 h1:RWIZEg2iJ8/g6fDDYzMpobmaoGh5OLl4AXtGUGPcqCs=