Implement repo level, user level and global environment variables support

cli/variable/variable.go

@@ -0,0 +1,83 @@
+// Copyright 2023 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 variable
+
+import (
+	"fmt"
+	"strconv"
+	"strings"
+
+	"github.com/urfave/cli/v3"
+
+	"go.woodpecker-ci.org/woodpecker/v2/cli/internal"
+	"go.woodpecker-ci.org/woodpecker/v2/woodpecker-go/woodpecker"
+)
+
+// Command exports the variable command.
+var Command = &cli.Command{
+	Name:  "variable",
+	Usage: "manage variables",
+	Commands: []*cli.Command{
+		variableCreateCmd,
+		variableDeleteCmd,
+		variableUpdateCmd,
+		variableInfoCmd,
+		variableListCmd,
+	},
+}
+
+func parseTargetArgs(client woodpecker.Client, c *cli.Command) (global bool, orgID, repoID int64, err error) {
+	if c.Bool("global") {
+		return true, -1, -1, nil
+	}
+
+	repoIDOrFullName := c.String("repository")
+	if repoIDOrFullName == "" {
+		repoIDOrFullName = c.Args().First()
+	}
+
+	orgIDOrName := c.String("organization")
+	if orgIDOrName == "" && repoIDOrFullName == "" {
+		if err := cli.ShowSubcommandHelp(c); err != nil {
+			return false, -1, -1, err
+		}
+
+		return false, -1, -1, fmt.Errorf("missing arguments")
+	}
+
+	if orgIDOrName != "" && repoIDOrFullName == "" {
+		if orgID, err := strconv.ParseInt(orgIDOrName, 10, 64); err == nil {
+			return false, orgID, -1, nil
+		}
+
+		org, err := client.OrgLookup(orgIDOrName)
+		if err != nil {
+			return false, -1, -1, err
+		}
+
+		return false, org.ID, -1, nil
+	}
+
+	if orgIDOrName != "" && !strings.Contains(repoIDOrFullName, "/") {
+		repoIDOrFullName = orgIDOrName + "/" + repoIDOrFullName
+	}
+
+	repoID, err = internal.ParseRepo(client, repoIDOrFullName)
+	if err != nil {
+		return false, -1, -1, err
+	}
+
+	return false, -1, repoID, nil
+}

cli/variable/variable_add.go

@@ -0,0 +1,88 @@
+// Copyright 2023 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 variable
+
+import (
+	"context"
+	"os"
+	"strings"
+
+	"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"
+)
+
+var variableCreateCmd = &cli.Command{
+	Name:      "add",
+	Usage:     "adds a variable",
+	ArgsUsage: "[repo-id|repo-full-name]",
+	Action:    variableCreate,
+	Flags: []cli.Flag{
+		&cli.BoolFlag{
+			Name:  "global",
+			Usage: "global variable",
+		},
+		common.OrgFlag,
+		common.RepoFlag,
+		&cli.StringFlag{
+			Name:  "name",
+			Usage: "variable name",
+		},
+		&cli.StringFlag{
+			Name:  "value",
+			Usage: "variable value",
+		},
+	},
+}
+
+func variableCreate(ctx context.Context, c *cli.Command) error {
+	client, err := internal.NewClient(ctx, c)
+	if err != nil {
+		return err
+	}
+
+	variable := &woodpecker.Variable{
+		Name:  strings.ToLower(c.String("name")),
+		Value: c.String("value"),
+	}
+	if strings.HasPrefix(variable.Value, "@") {
+		path := strings.TrimPrefix(variable.Value, "@")
+		out, err := os.ReadFile(path)
+		if err != nil {
+			return err
+		}
+		variable.Value = string(out)
+	}
+
+	global, orgID, repoID, err := parseTargetArgs(client, c)
+	if err != nil {
+		return err
+	}
+
+	if global {
+		_, err = client.GlobalVariableCreate(variable)
+		return err
+	}
+
+	if orgID != -1 {
+		_, err = client.OrgVariableCreate(orgID, variable)
+		return err
+	}
+
+	_, err = client.VariableCreate(repoID, variable)
+	return err
+}

cli/variable/variable_info.go

@@ -0,0 +1,94 @@
+// Copyright 2023 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 variable
+
+import (
+	"context"
+	"fmt"
+	"html/template"
+	"os"
+
+	"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"
+)
+
+var variableInfoCmd = &cli.Command{
+	Name:      "info",
+	Usage:     "display variable info",
+	ArgsUsage: "[repo-id|repo-full-name]",
+	Action:    variableInfo,
+	Flags: []cli.Flag{
+		&cli.BoolFlag{
+			Name:  "global",
+			Usage: "global variable",
+		},
+		common.OrgFlag,
+		common.RepoFlag,
+		&cli.StringFlag{
+			Name:  "name",
+			Usage: "variable name",
+		},
+		common.FormatFlag(tmplVariableList, true),
+	},
+}
+
+func variableInfo(ctx context.Context, c *cli.Command) error {
+	var (
+		variableName = c.String("name")
+		format       = c.String("format") + "\n"
+	)
+
+	if variableName == "" {
+		return fmt.Errorf("variable name is missing")
+	}
+
+	client, err := internal.NewClient(ctx, c)
+	if err != nil {
+		return err
+	}
+
+	global, orgID, repoID, err := parseTargetArgs(client, c)
+	if err != nil {
+		return err
+	}
+
+	var variable *woodpecker.Variable
+	switch {
+	case global:
+		variable, err = client.GlobalVariable(variableName)
+		if err != nil {
+			return err
+		}
+	case orgID != -1:
+		variable, err = client.OrgVariable(orgID, variableName)
+		if err != nil {
+			return err
+		}
+	default:
+		variable, err = client.Variable(repoID, variableName)
+		if err != nil {
+			return err
+		}
+	}
+
+	tmpl, err := template.New("_").Funcs(variableFuncMap).Parse(format)
+	if err != nil {
+		return err
+	}
+	return tmpl.Execute(os.Stdout, variable)
+}

cli/variable/variable_list.go

@@ -0,0 +1,99 @@
+// Copyright 2023 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 variable
+
+import (
+	"context"
+	"html/template"
+	"os"
+	"strings"
+
+	"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"
+)
+
+var variableListCmd = &cli.Command{
+	Name:      "ls",
+	Usage:     "list variables",
+	ArgsUsage: "[repo-id|repo-full-name]",
+	Action:    variableList,
+	Flags: []cli.Flag{
+		&cli.BoolFlag{
+			Name:  "global",
+			Usage: "global variable",
+		},
+		common.OrgFlag,
+		common.RepoFlag,
+		common.FormatFlag(tmplVariableList, true),
+	},
+}
+
+func variableList(ctx context.Context, c *cli.Command) error {
+	format := c.String("format") + "\n"
+
+	client, err := internal.NewClient(ctx, c)
+	if err != nil {
+		return err
+	}
+
+	global, orgID, repoID, err := parseTargetArgs(client, c)
+	if err != nil {
+		return err
+	}
+
+	var list []*woodpecker.Variable
+	switch {
+	case global:
+		list, err = client.GlobalVariableList()
+		if err != nil {
+			return err
+		}
+	case orgID != -1:
+		list, err = client.OrgVariableList(orgID)
+		if err != nil {
+			return err
+		}
+	default:
+		list, err = client.VariableList(repoID)
+		if err != nil {
+			return err
+		}
+	}
+
+	tmpl, err := template.New("_").Funcs(variableFuncMap).Parse(format)
+	if err != nil {
+		return err
+	}
+	for _, registry := range list {
+		if err := tmpl.Execute(os.Stdout, registry); err != nil {
+			return err
+		}
+	}
+	return nil
+}
+
+// Template for variable list items.
+var tmplVariableList = "\x1b[33m{{ .Name }} \x1b[0m" + `
+Value: {{ .Value }}
+`
+
+var variableFuncMap = template.FuncMap{
+	"list": func(s []string) string {
+		return strings.Join(s, ", ")
+	},
+}