1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
|
package update
import (
"errors"
"fmt"
"gitlab.com/gitlab-org/cli/pkg/iostreams"
"github.com/MakeNowJust/heredoc/v2"
"github.com/spf13/cobra"
gitlab "gitlab.com/gitlab-org/api/client-go"
"gitlab.com/gitlab-org/cli/api"
"gitlab.com/gitlab-org/cli/commands/cmdutils"
"gitlab.com/gitlab-org/cli/commands/variable/variableutils"
"gitlab.com/gitlab-org/cli/internal/glrepo"
)
type UpdateOpts struct {
HTTPClient func() (*gitlab.Client, error)
IO *iostreams.IOStreams
BaseRepo func() (glrepo.Interface, error)
Key string
Value string
Type string
Scope string
Protected bool
Masked bool
Raw bool
Group string
Description string
}
func NewCmdUpdate(f *cmdutils.Factory, runE func(opts *UpdateOpts) error) *cobra.Command {
opts := &UpdateOpts{
IO: f.IO,
}
cmd := &cobra.Command{
Use: "update <key> <value>",
Short: "Update an existing variable for a project or group.",
Args: cobra.RangeArgs(1, 2),
Example: heredoc.Doc(`
glab variable update WITH_ARG "some value"
glab variable update FROM_FLAG -v "some value"
glab variable update FROM_ENV_WITH_ARG "${ENV_VAR}"
glab variable update FROM_ENV_WITH_FLAG -v"${ENV_VAR}"
glab variable update FROM_FILE < secret.txt
cat file.txt | glab variable update SERVER_TOKEN
cat token.txt | glab variable update GROUP_TOKEN -g mygroup --scope=prod
`),
RunE: func(cmd *cobra.Command, args []string) (err error) {
// Supports repo override
opts.HTTPClient = f.HttpClient
opts.BaseRepo = f.BaseRepo
opts.Key = args[0]
if !variableutils.IsValidKey(opts.Key) {
err = cmdutils.FlagError{Err: fmt.Errorf("invalid key provided.\n%s", variableutils.ValidKeyMsg)}
return
}
if opts.Value != "" && len(args) == 2 {
err = cmdutils.FlagError{Err: errors.New("specify value either by the second positional argument or the --value flag.")}
return
}
if cmd.Flags().Changed("scope") && opts.Group != "" {
err = cmdutils.FlagError{Err: errors.New("scope is not required for group variables.")}
return
}
opts.Value, err = variableutils.GetValue(opts.Value, opts.IO, args)
if err != nil {
return
}
if cmd.Flags().Changed("type") {
if opts.Type != "env_var" && opts.Type != "file" {
err = cmdutils.FlagError{Err: fmt.Errorf("invalid type: %s. --type must be one of `env_var` or `file`.", opts.Type)}
return
}
}
if runE != nil {
err = runE(opts)
return
}
err = updateRun(opts)
return
},
}
cmd.Flags().StringVarP(&opts.Value, "value", "v", "", "The value of a variable.")
cmd.Flags().StringVarP(&opts.Type, "type", "t", "env_var", "The type of a variable: env_var, file.")
cmd.Flags().StringVarP(&opts.Scope, "scope", "s", "*", "The environment_scope of the variable. Values: all (*), or specific environments.")
cmd.Flags().StringVarP(&opts.Group, "group", "g", "", "Set variable for a group.")
cmd.Flags().BoolVarP(&opts.Masked, "masked", "m", false, "Whether the variable is masked.")
cmd.Flags().BoolVarP(&opts.Raw, "raw", "r", false, "Whether the variable is treated as a raw string.")
cmd.Flags().BoolVarP(&opts.Protected, "protected", "p", false, "Whether the variable is protected.")
cmd.Flags().StringVarP(&opts.Description, "description", "d", "", "Set description of a variable.")
return cmd
}
func updateRun(opts *UpdateOpts) error {
c := opts.IO.Color()
httpClient, err := opts.HTTPClient()
if err != nil {
return err
}
if opts.Group != "" {
// update group-level variable
updateGroupVarOpts := &gitlab.UpdateGroupVariableOptions{
Value: gitlab.Ptr(opts.Value),
VariableType: gitlab.Ptr(gitlab.VariableTypeValue(opts.Type)),
Masked: gitlab.Ptr(opts.Masked),
Protected: gitlab.Ptr(opts.Protected),
Raw: gitlab.Ptr(opts.Raw),
EnvironmentScope: gitlab.Ptr(opts.Scope),
Description: gitlab.Ptr(opts.Description),
}
_, err = api.UpdateGroupVariable(httpClient, opts.Group, opts.Key, updateGroupVarOpts)
if err != nil {
return err
}
fmt.Fprintf(opts.IO.StdOut, "%s Updated variable %s for group %s.\n", c.GreenCheck(), opts.Key, opts.Group)
return nil
}
// update project-level variable
baseRepo, err := opts.BaseRepo()
if err != nil {
return err
}
updateProjectVarOpts := &gitlab.UpdateProjectVariableOptions{
Value: gitlab.Ptr(opts.Value),
VariableType: gitlab.Ptr(gitlab.VariableTypeValue(opts.Type)),
Masked: gitlab.Ptr(opts.Masked),
Protected: gitlab.Ptr(opts.Protected),
Raw: gitlab.Ptr(opts.Raw),
EnvironmentScope: gitlab.Ptr(opts.Scope),
Description: gitlab.Ptr(opts.Description),
}
_, err = api.UpdateProjectVariable(httpClient, baseRepo.FullName(), opts.Key, updateProjectVarOpts)
if err != nil {
return err
}
fmt.Fprintf(opts.IO.StdOut, "%s Updated variable %s for project %s with scope %s.\n", c.GreenCheck(), opts.Key, baseRepo.FullName(), opts.Scope)
return nil
}
|
