Restructure cli commands (#4467)

cli/pipeline/deploy/deploy.go

@@ -0,0 +1,150 @@
+// Copyright 2022 Woodpecker Authors
+//
+// Licensed 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 deploy
+
+import (
+	"context"
+	"fmt"
+	"html/template"
+	"os"
+	"strconv"
+
+	"github.com/urfave/cli/v3"
+
+	"go.woodpecker-ci.org/woodpecker/v2/cli/common"
+	"go.woodpecker-ci.org/woodpecker/v2/cli/internal"
+	"go.woodpecker-ci.org/woodpecker/v2/woodpecker-go/woodpecker"
+)
+
+// Command exports the deploy command.
+var Command = &cli.Command{
+	Name:      "deploy",
+	Usage:     "trigger a pipeline with the 'deployment' event",
+	ArgsUsage: "<repo-id|repo-full-name> <pipeline> <environment>",
+	Action:    deploy,
+	Flags: []cli.Flag{
+		common.FormatFlag(tmplDeployInfo),
+		&cli.StringFlag{
+			Name:  "branch",
+			Usage: "branch filter",
+		},
+		&cli.StringFlag{
+			Name:  "event",
+			Usage: "event filter",
+			Value: woodpecker.EventPush,
+		},
+		&cli.StringFlag{
+			Name:  "status",
+			Usage: "status filter",
+			Value: woodpecker.StatusSuccess,
+		},
+		&cli.StringSliceFlag{
+			Name:    "param",
+			Aliases: []string{"p"},
+			Usage:   "custom parameters to be injected into the step environment. Format: KEY=value",
+		},
+	},
+}
+
+func deploy(ctx context.Context, c *cli.Command) error {
+	client, err := internal.NewClient(ctx, c)
+	if err != nil {
+		return err
+	}
+
+	repo := c.Args().First()
+	repoID, err := internal.ParseRepo(client, repo)
+	if err != nil {
+		return err
+	}
+
+	branch := c.String("branch")
+	event := c.String("event")
+	status := c.String("status")
+
+	if branch == "" {
+		repo, err := client.Repo(repoID)
+		if err != nil {
+			return err
+		}
+
+		branch = repo.DefaultBranch
+	}
+
+	pipelineArg := c.Args().Get(1)
+	var number int64
+	if pipelineArg == "last" {
+		// Fetch the pipeline number from the last pipeline
+		pipelines, err := client.PipelineList(repoID, woodpecker.PipelineListOptions{})
+		if err != nil {
+			return err
+		}
+		for _, pipeline := range pipelines {
+			if branch != "" && pipeline.Branch != branch {
+				continue
+			}
+			if event != "" && pipeline.Event != event {
+				continue
+			}
+			if status != "" && pipeline.Status != status {
+				continue
+			}
+			if pipeline.Number > number {
+				number = pipeline.Number
+			}
+		}
+		if number == 0 {
+			return fmt.Errorf("cannot deploy failure pipeline")
+		}
+	} else {
+		number, err = strconv.ParseInt(pipelineArg, 10, 64)
+		if err != nil {
+			return err
+		}
+	}
+
+	envArgIndex := 2
+	env := c.Args().Get(envArgIndex)
+	if env == "" {
+		return fmt.Errorf("please specify the target environment (i.e. production)")
+	}
+
+	opt := woodpecker.DeployOptions{
+		DeployTo: env,
+		Params:   internal.ParseKeyPair(c.StringSlice("param")),
+	}
+
+	deploy, err := client.Deploy(repoID, number, opt)
+	if err != nil {
+		return err
+	}
+
+	tmpl, err := template.New("_").Parse(c.String("format"))
+	if err != nil {
+		return err
+	}
+	return tmpl.Execute(os.Stdout, deploy)
+}
+
+// Template for deployment information.
+var tmplDeployInfo = `Number: {{ .Number }}
+Status: {{ .Status }}
+Commit: {{ .Commit }}
+Branch: {{ .Branch }}
+Ref: {{ .Ref }}
+Message: {{ .Message }}
+Author: {{ .Author }}
+Target: {{ .Deploy }}
+`

cli/pipeline/log/log.go

@@ -0,0 +1,28 @@
+// Copyright 2022 Woodpecker Authors
+//
+// Licensed 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 log
+
+import (
+	"github.com/urfave/cli/v3"
+)
+
+// Command exports the log command set.
+var Command = &cli.Command{
+	Name:  "log",
+	Usage: "manage logs",
+	Commands: []*cli.Command{
+		logPurgeCmd,
+	},
+}

cli/pipeline/log/log_purge.go

@@ -0,0 +1,78 @@
+// Copyright 2022 Woodpecker Authors
+//
+// Licensed 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 log
+
+import (
+	"context"
+	"fmt"
+	"strconv"
+
+	"github.com/urfave/cli/v3"
+
+	"go.woodpecker-ci.org/woodpecker/v2/cli/internal"
+)
+
+var logPurgeCmd = &cli.Command{
+	Name:      "purge",
+	Usage:     "purge a log",
+	ArgsUsage: "<repo-id|repo-full-name> <pipeline> [step-number|step-name]",
+	Action:    logPurge,
+}
+
+func logPurge(ctx context.Context, c *cli.Command) (err error) {
+	client, err := internal.NewClient(ctx, c)
+	if err != nil {
+		return err
+	}
+	repoIDOrFullName := c.Args().First()
+	if len(repoIDOrFullName) == 0 {
+		return fmt.Errorf("missing required argument repo-id / repo-full-name")
+	}
+	repoID, err := internal.ParseRepo(client, repoIDOrFullName)
+	if err != nil {
+		return fmt.Errorf("invalid repo '%s': %w", repoIDOrFullName, err)
+	}
+
+	pipelineArg := c.Args().Get(1)
+	if len(pipelineArg) == 0 {
+		return fmt.Errorf("missing required argument pipeline")
+	}
+	number, err := strconv.ParseInt(pipelineArg, 10, 64)
+	if err != nil {
+		return err
+	}
+
+	stepArg := c.Args().Get(2) //nolint:mnd
+	var stepID int64
+	if len(stepArg) != 0 {
+		stepID, err = internal.ParseStep(client, repoID, number, stepArg)
+		if err != nil {
+			return err
+		}
+	}
+
+	if stepID > 0 {
+		fmt.Printf("Purging logs for pipeline %s#%d step %d\n", repoIDOrFullName, number, stepID)
+		err = client.StepLogsPurge(repoID, number, stepID)
+	} else {
+		fmt.Printf("Purging logs for pipeline %s#%d\n", repoIDOrFullName, number)
+		err = client.LogsPurge(repoID, number)
+	}
+	if err != nil {
+		return err
+	}
+
+	return nil
+}

cli/pipeline/pipeline.go

@@ -23,6 +23,8 @@ import (
 	"github.com/urfave/cli/v3"
 
 	"go.woodpecker-ci.org/woodpecker/v2/cli/output"
+	"go.woodpecker-ci.org/woodpecker/v2/cli/pipeline/deploy"
+	"go.woodpecker-ci.org/woodpecker/v2/cli/pipeline/log"
 	"go.woodpecker-ci.org/woodpecker/v2/woodpecker-go/woodpecker"
 )
 
@@ -43,6 +45,8 @@ var Command = &cli.Command{
 		pipelineKillCmd,
 		pipelinePsCmd,
 		pipelineCreateCmd,
+		log.Command,
+		deploy.Command,
 	},
 }