Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix(secrets): abstract populateEvents for secret usage #542
fix(secrets): abstract populateEvents for secret usage #542
Changes from all commits
206a8ffFile filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
Check failure on line 3 in command/secret/add.go
[golangci] command/secret/add.go#L3
Raw output
command/secret/add.go:3: 3-216 lines are duplicate of `command/secret/update.go:3-216` (dupl) package secret import ( "fmt" "slices" "github.com/go-vela/cli/action" "github.com/go-vela/cli/action/secret" "github.com/go-vela/cli/internal" "github.com/go-vela/cli/internal/client" "github.com/go-vela/types/constants" "github.com/urfave/cli/v2" ) // CommandAdd defines the command for creating a secret. var CommandAdd = &cli.Command{ Name: "secret", Description: "Use this command to create a secret.", Usage: "Add a new secret from the provided configuration", Action: add, Flags: []cli.Flag{ // Repo Flags &cli.StringFlag{ EnvVars: []string{"VELA_ORG", "SECRET_ORG"}, Name: internal.FlagOrg, Aliases: []string{"o"}, Usage: "provide the organization for the secret", }, &cli.StringFlag{ EnvVars: []string{"VELA_REPO", "SECRET_REPO"}, Name: internal.FlagRepo, Aliases: []string{"r"}, Usage: "provide the repository for the secret", }, // Secret Flags &cli.StringFlag{ EnvVars: []string{"VELA_ENGINE", "SECRET_ENGINE"}, Name: internal.FlagSecretEngine, Aliases: []string{"e"}, Usage: "provide the engine that stores the secret", Value: constants.DriverNative, }, &cli.StringFlag{ EnvVars: []string{"VELA_TYPE", "SECRET_TYPE"}, Name: internal.FlagSecretType, Aliases: []string{"ty"}, Usage: "provide the type of secret being stored", Value: constants.SecretRepo, }, &cli.StringFlag{ EnvVars: []string{"VELA_TEAM", "SECRET_TEAM"}, Name: "team", Aliases: []string{"t"}, Usage: "provide the team for the secret", }, &cli.StringFlag{ EnvVars: []string{"VELA_NAME", "SECRET_NAME"}, Name: "name", Aliases: []string{"n"}, Usage: "provide the name of the secret", }, &cli.StringFlag{ EnvVars: []string{"VELA_VALUE", "SECRET_VALUE"}, Name: "value", Aliases: []string{"v"}, Usage: "provide the value for the secret", }, &cli.StringSliceFlag{ EnvVars: []string{"VELA_IMAGES", "SECRET_IMAGES"}, Name: "image", Aliases: []string{"i"}, Usage: "Provide the image(s) that can access this secret", }, &cli.StringSliceFlag{ EnvVars: []string{"VELA_EVENTS", "SECRET_EVENTS"}, Name: "event", Aliases: []string{"events", "ev"}, Usage: "provide the event(s) that can access this secret", }, &cli.StringFlag{ EnvVars: []string{"VELA_COMMAND", "SECRET_COMMAND"}, Name: internal.FlagSecretCommands, Aliases: []string{"c"}, Usage: "enable a secret to be used for a step with commands (default is false for shared secrets)", Value: "true", }, &cli.StringFlag{ EnvVars: []string{"VELA_SUBSTITUTION", "SECRET_SUBSTITUTION"}, Name: internal.FlagSecretSubstitution, Aliases: []string{"s"}, Usage: "enable a secret to be substituted (default is false for shared secrets)", Value: "true", }, &cli.StringFlag{ EnvVars: []string{"VELA_FILE", "SECRET_FILE"}, Name: "file", Aliases: []string{"f"}, Usage: "provide a file to add the secret(s)", }, // Output Flags &cli.StringFlag{ EnvVars: []string{"VELA_OUTPUT", "SECRET_OUTPUT"}, Name: internal.FlagOutput, Aliases: []string{"op"}, Usage: "format the output in json, spew or yaml", }, }, CustomHelpTemplate: fmt.Sprintf(`%s EXAMPLES: 1. Add a repository secret. $ {{.HelpName}} --secret.engine native --secret.type repo --org MyOrg --repo MyRepo --name foo --value bar 2. Add a repository secret and disallow usage in commands. $ {{.HelpName}} --secret.engine native --secret.type repo --org MyOrg --repo MyRepo --name foo --value bar --commands false 3. Add an organization secret. $ {{.HelpName}} --secret.engine native --secret.type org --org MyOrg --name foo --value bar 4. Add a shared secret. $ {{.HelpName}} --secret.engine native --secret.type shared --org MyOrg --team octokitties --name foo --value bar 5. Add a repository secret with all event types enabled. $ {{.HelpName}} --secret.engine native --secret.type repo --org MyOrg --repo MyRepo --name foo --value bar --event comment --event deployment --event pull_request --event push --event tag 6. Add a repository secret with an image whitelist. $ {{.HelpName}} --secret.engine native --secret.type repo --org MyOrg --repo MyRepo --name foo --value bar --image alpine --image golang:* --image postgres:latest 7. Add a secret with value from a file. $ {{.HelpName}} --secret.engine native --secret.type repo --org MyOrg --repo MyRepo --name foo --value @secret.txt 8. Add a repository secret with json output. $ {{.HelpName}} --secret.engine native --secret.type repo --org MyOrg --repo MyRepo --name foo --value bar --output json 9. Add a secret or secrets from a file. $ {{.HelpName}} --file secret.yml 10. Add a secret when config or environment variables are set. $ {{.HelpName}} --org MyOrg --repo MyRepo --name foo --value bar DOCUMENTATION: https://go-vela.github.io/docs/reference/cli/secret/add/ `, cli.CommandHelpTemplate), } // helper function to capture the provided input // and create the object used to create a secret. // //nolint:dupl // ignore similar code with update func add(c *cli.Context) error { // load variables from the config file err := action.Load(c) if err != nil { return err } // parse the Vela client from the context // // https://pkg.go.dev/github.com/go-vela/cli/internal/client?tab=doc#Parse client, err := client.Parse(c) if err != nil { return err } // create the secret configuration // // https://pkg.go.dev/github.com/go-vela/cli/action/secret?tab=doc#Config s := &secret.Config{ Action: internal.ActionAdd, Engine: c.String(internal.FlagSecretEngine), Type: c.String(internal.FlagSecretType), Org: c.String(internal.FlagOrg), Repo: c.String(internal.FlagRepo), Team: c.String("team"), Name: c.String("name"), Value: c.String("value"), Images: c.StringSlice("image"), Events: c.StringSlice("event"), File: c.String("file"), Output: c.String(internal.FlagOutput), } // check if allow_command and allow_substitution are provided // if they are not, server will not update the fields if slices.Contains(c.FlagNames(), internal.FlagSecretCommands) { val := c.Bool(internal.FlagSecretCommands) s.AllowCommand = &val } if slices.Contains(c.FlagNames(), internal.FlagSecretSubstitution) { val := c.Bool(internal.FlagSecretSubstitution) s.AllowSubstitution = &val } // validate secret configuration // // https://pkg.go.dev/github.com/go-vela/cli/action/secret?tab=doc#Config.Validate err = s.Validate() if err != nil { return err } // check if secret file is provided if len(s.File) > 0 { // execute the add from file call for the secret configuration // // https://pkg.go.dev/github.com/go-vela/cli/action/secret?tab=doc#Config.AddFromFile return s.AddFromFile(client) } // execute the add call for the secret configuration // // https://pkg.go.dev/github.com/go-vela/cli/action/secret?tab=doc#Config.Add return s.Add(client) }Check failure on line 150 in command/secret/add.go
Check failure on line 150 in command/secret/add.go
Check failure on line 150 in command/secret/add.go
[golangci] command/secret/add.go#L150
Raw output
Check failure on line 3 in command/secret/update.go
[golangci] command/secret/update.go#L3
Raw output
command/secret/update.go:3: 3-216 lines are duplicate of `command/secret/add.go:3-216` (dupl) package secret import ( "fmt" "slices" "github.com/go-vela/cli/action" "github.com/go-vela/cli/action/secret" "github.com/go-vela/cli/internal" "github.com/go-vela/cli/internal/client" "github.com/go-vela/types/constants" "github.com/urfave/cli/v2" ) // CommandUpdate defines the command for updating a secret. var CommandUpdate = &cli.Command{ Name: "secret", Description: "Use this command to update a secret.", Usage: "Update details of the provided secret", Action: update, Flags: []cli.Flag{ // Repo Flags &cli.StringFlag{ EnvVars: []string{"VELA_ORG", "SECRET_ORG"}, Name: internal.FlagOrg, Aliases: []string{"o"}, Usage: "provide the organization for the secret", }, &cli.StringFlag{ EnvVars: []string{"VELA_REPO", "SECRET_REPO"}, Name: internal.FlagRepo, Aliases: []string{"r"}, Usage: "provide the repository for the secret", }, // Secret Flags &cli.StringFlag{ EnvVars: []string{"VELA_ENGINE", "SECRET_ENGINE"}, Name: internal.FlagSecretEngine, Aliases: []string{"e"}, Usage: "provide the engine that stores the secret", Value: constants.DriverNative, }, &cli.StringFlag{ EnvVars: []string{"VELA_TYPE", "SECRET_TYPE"}, Name: internal.FlagSecretType, Aliases: []string{"ty"}, Usage: "provide the type of secret being stored", Value: constants.SecretRepo, }, &cli.StringFlag{ EnvVars: []string{"VELA_TEAM", "SECRET_TEAM"}, Name: "team", Aliases: []string{"t"}, Usage: "provide the team for the secret", }, &cli.StringFlag{ EnvVars: []string{"VELA_NAME", "SECRET_NAME"}, Name: "name", Aliases: []string{"n"}, Usage: "provide the name of the secret", }, &cli.StringFlag{ EnvVars: []string{"VELA_VALUE", "SECRET_VALUE"}, Name: "value", Aliases: []string{"v"}, Usage: "provide the value for the secret", }, &cli.StringSliceFlag{ EnvVars: []string{"VELA_IMAGES", "SECRET_IMAGES"}, Name: "image", Aliases: []string{"i"}, Usage: "provide the image(s) that can access this secret", }, &cli.StringSliceFlag{ EnvVars: []string{"VELA_EVENTS", "SECRET_EVENTS"}, Name: "event", Aliases: []string{"events", "ev"}, Usage: "provide the event(s) that can access this secret", }, &cli.StringFlag{ EnvVars: []string{"VELA_COMMAND", "SECRET_COMMAND"}, Name: internal.FlagSecretCommands, Aliases: []string{"c"}, Usage: "enable a secret to be used for a step with commands", Value: "true", }, &cli.StringFlag{ EnvVars: []string{"VELA_SUBSTITUTION", "SECRET_SUBSTITUTION"}, Name: internal.FlagSecretSubstitution, Aliases: []string{"s"}, Usage: "enable a secret to be substituted", Value: "true", }, &cli.StringFlag{ EnvVars: []string{"VELA_FILE", "SECRET_FILE"}, Name: "file", Aliases: []string{"f"}, Usage: "provide a file to update the secret(s)", }, // Output Flags &cli.StringFlag{ EnvVars: []string{"VELA_OUTPUT", "SECRET_OUTPUT"}, Name: internal.FlagOutput, Aliases: []string{"op"}, Usage: "Print the output in default, yaml or json format", }, }, CustomHelpTemplate: fmt.Sprintf(`%s EXAMPLES: 1. Update a repository secret. $ {{.HelpName}} --secret.engine native --secret.type repo --org MyOrg --repo MyRepo --name foo --value bar 2. Update a repository secret and disallow usage in commands. $ {{.HelpName}} --secret.engine native --secret.type repo --org MyOrg --repo MyRepo --name foo --value bar --commands false 3. Update an organization secret. $ {{.HelpName}} --secret.engine native --secret.type org --org MyOrg --name foo --value bar 4. Update a shared secret. $ {{.HelpName}} --secret.engine native --secret.type shared --org MyOrg --team octokitties --name foo --value bar 5. Update a repository secret with all event types enabled. $ {{.HelpName}} --secret.engine native --secret.type repo --org MyOrg --repo MyRepo --name foo --event comment --event deployment --event pull_request --event push --event tag 6. Update a repository secret with an image whitelist. $ {{.HelpName}} --secret.engine native --secret.type repo --org MyOrg --repo MyRepo --name foo --image alpine --image golang:* --image postgres:latest 7. Update a secret with value from a file. $ {{.HelpName}} --secret.engine native --secret.type repo --org MyOrg --repo MyRepo --name foo --value @secret.txt 8. Update a repository secret with json output. $ {{.HelpName}} --secret.engine native --secret.type repo --org MyOrg --repo MyRepo --name foo --value bar --output json 9. Update a secret or secrets from a file. $ {{.HelpName}} --file secret.yml 10. Update a secret when config or environment variables are set. $ {{.HelpName}} --org MyOrg --repo MyRepo --name foo --value bar DOCUMENTATION: https://go-vela.github.io/docs/reference/cli/secret/update/ `, cli.CommandHelpTemplate), } // helper function to capture the provided input // and create the object used to modify a secret. // //nolint:dupl // ignore similar code with add func update(c *cli.Context) error { // load variables from the config file err := action.Load(c) if err != nil { return err } // parse the Vela client from the context // // https://pkg.go.dev/github.com/go-vela/cli/internal/client?tab=doc#Parse client, err := client.Parse(c) if err != nil { return err } // create the secret configuration // // https://pkg.go.dev/github.com/go-vela/cli/action/secret?tab=doc#Config s := &secret.Config{ Action: internal.ActionUpdate, Engine: c.String(internal.FlagSecretEngine), Type: c.String(internal.FlagSecretType), Org: c.String(internal.FlagOrg), Repo: c.String(internal.FlagRepo), Team: c.String("team"), Name: c.String("name"), Value: c.String("value"), Images: c.StringSlice("image"), Events: c.StringSlice("event"), File: c.String("file"), Output: c.String(internal.FlagOutput), } // check if allow_command and allow_substitution are provided // if they are not, server will not update the fields if slices.Contains(c.FlagNames(), internal.FlagSecretCommands) { val := c.Bool(internal.FlagSecretCommands) s.AllowCommand = &val } if slices.Contains(c.FlagNames(), internal.FlagSecretSubstitution) { val := c.Bool(internal.FlagSecretSubstitution) s.AllowSubstitution = &val } // validate secret configuration // // https://pkg.go.dev/github.com/go-vela/cli/action/secret?tab=doc#Config.Validate err = s.Validate() if err != nil { return err } // check if secret file is provided if len(s.File) > 0 { // execute the update from file call for the secret configuration // // https://pkg.go.dev/github.com/go-vela/cli/action/secret?tab=doc#Config.UpdateFromFile return s.UpdateFromFile(client) } // execute the update call for the secret configuration // // https://pkg.go.dev/github.com/go-vela/cli/action/secret?tab=doc#Config.Update return s.Update(client) }Check failure on line 150 in command/secret/update.go
Check failure on line 150 in command/secret/update.go
Check failure on line 150 in command/secret/update.go
[golangci] command/secret/update.go#L150
Raw output