Skip to content

Commit ff0665d

Browse files
mcncllizrabuya
mcncl
and
lizrabuya
authored
api scopes for all build commands (#420)
Co-authored-by: Lizette Rabuya <[email protected]>
1 parent 5e5fcb8 commit ff0665d

File tree

5 files changed

+110
-0
lines changed

5 files changed

+110
-0
lines changed

‎pkg/cmd/build/cancel.go

+22
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ import (
88
buildResolver "github.com/buildkite/cli/v3/internal/build/resolver"
99
"github.com/buildkite/cli/v3/internal/io"
1010
pipelineResolver "github.com/buildkite/cli/v3/internal/pipeline/resolver"
11+
"github.com/buildkite/cli/v3/internal/scopes"
1112
"github.com/buildkite/cli/v3/internal/util"
1213
"github.com/buildkite/cli/v3/pkg/cmd/factory"
1314
"github.com/buildkite/go-buildkite/v4"
@@ -28,6 +29,23 @@ func NewCmdBuildCancel(f *factory.Factory) *cobra.Command {
2829
Long: heredoc.Doc(`
2930
Cancel the given build.
3031
`),
32+
PreRunE: func(cmd *cobra.Command, args []string) error {
33+
// Get the command's required and optional scopes
34+
cmdScopes := scopes.GetCommandScopes(cmd)
35+
36+
// Get the token scopes from the factory
37+
tokenScopes := f.Config.GetTokenScopes()
38+
if len(tokenScopes) == 0 {
39+
return fmt.Errorf("no scopes found in token. Please ensure you're using a token with appropriate scopes")
40+
}
41+
42+
// Validate the scopes
43+
if err := scopes.ValidateScopes(cmdScopes, tokenScopes); err != nil {
44+
return err
45+
}
46+
47+
return nil
48+
},
3149
RunE: func(cmd *cobra.Command, args []string) error {
3250
pipelineRes := pipelineResolver.NewAggregateResolver(
3351
pipelineResolver.ResolveFromFlag(pipeline, f.Config),
@@ -57,6 +75,10 @@ func NewCmdBuildCancel(f *factory.Factory) *cobra.Command {
5775
},
5876
}
5977

78+
cmd.Annotations = map[string]string{
79+
"requiredScopes": string(scopes.WriteBuilds),
80+
}
81+
6082
cmd.Flags().BoolVarP(&web, "web", "w", false, "Open the build in a web browser after it has been cancelled.")
6183
cmd.Flags().StringVarP(&pipeline, "pipeline", "p", "", "The pipeline to cancel a build on. This can be a {pipeline slug} or in the format {org slug}/{pipeline slug}.\n"+
6284
"If omitted, it will be resolved using the current directory.",

‎pkg/cmd/build/download.go

+22
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import (
1111
buildResolver "github.com/buildkite/cli/v3/internal/build/resolver"
1212
"github.com/buildkite/cli/v3/internal/build/resolver/options"
1313
pipelineResolver "github.com/buildkite/cli/v3/internal/pipeline/resolver"
14+
"github.com/buildkite/cli/v3/internal/scopes"
1415
"github.com/buildkite/cli/v3/pkg/cmd/factory"
1516
"github.com/charmbracelet/huh/spinner"
1617
"github.com/spf13/cobra"
@@ -26,6 +27,23 @@ func NewCmdBuildDownload(f *factory.Factory) *cobra.Command {
2627
Short: "Download resources for a build",
2728
Long: "Download allows you to download resources for a build.",
2829
Args: cobra.MaximumNArgs(1),
30+
PreRunE: func(cmd *cobra.Command, args []string) error {
31+
// Get the command's required and optional scopes
32+
cmdScopes := scopes.GetCommandScopes(cmd)
33+
34+
// Get the token scopes from the factory
35+
tokenScopes := f.Config.GetTokenScopes()
36+
if len(tokenScopes) == 0 {
37+
return fmt.Errorf("no scopes found in token. Please ensure you're using a token with appropriate scopes")
38+
}
39+
40+
// Validate the scopes
41+
if err := scopes.ValidateScopes(cmdScopes, tokenScopes); err != nil {
42+
return err
43+
}
44+
45+
return nil
46+
},
2947
RunE: func(cmd *cobra.Command, args []string) error {
3048
// we find the pipeline based on the following rules:
3149
// 1. an explicit flag is passed
@@ -83,6 +101,10 @@ func NewCmdBuildDownload(f *factory.Factory) *cobra.Command {
83101
},
84102
}
85103

104+
cmd.Annotations = map[string]string{
105+
"requiredScopes": fmt.Sprint(string(scopes.ReadBuilds), string(scopes.ReadArtifacts), string(scopes.ReadBuildLogs)),
106+
}
107+
86108
cmd.Flags().BoolVarP(&mine, "mine", "m", false, "Filter builds to only my user.")
87109
cmd.Flags().StringVarP(&branch, "branch", "b", "", "Filter builds to this branch.")
88110
cmd.Flags().StringVarP(&user, "user", "u", "", "Filter builds to this user. You can use name or email.")

‎pkg/cmd/build/rebuild.go

+22
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ import (
88
buildResolver "github.com/buildkite/cli/v3/internal/build/resolver"
99
"github.com/buildkite/cli/v3/internal/build/resolver/options"
1010
pipelineResolver "github.com/buildkite/cli/v3/internal/pipeline/resolver"
11+
"github.com/buildkite/cli/v3/internal/scopes"
1112
"github.com/buildkite/cli/v3/internal/util"
1213
"github.com/buildkite/cli/v3/pkg/cmd/factory"
1314
"github.com/buildkite/go-buildkite/v4"
@@ -28,6 +29,23 @@ func NewCmdBuildRebuild(f *factory.Factory) *cobra.Command {
2829
Rebuild a build.
2930
The web URL to the build will be printed to stdout.
3031
`),
32+
PreRunE: func(cmd *cobra.Command, args []string) error {
33+
// Get the command's required and optional scopes
34+
cmdScopes := scopes.GetCommandScopes(cmd)
35+
36+
// Get the token scopes from the factory
37+
tokenScopes := f.Config.GetTokenScopes()
38+
if len(tokenScopes) == 0 {
39+
return fmt.Errorf("no scopes found in token. Please ensure you're using a token with appropriate scopes")
40+
}
41+
42+
// Validate the scopes
43+
if err := scopes.ValidateScopes(cmdScopes, tokenScopes); err != nil {
44+
return err
45+
}
46+
47+
return nil
48+
},
3149
RunE: func(cmd *cobra.Command, args []string) error {
3250
// we find the pipeline based on the following rules:
3351
// 1. an explicit flag is passed
@@ -72,6 +90,10 @@ func NewCmdBuildRebuild(f *factory.Factory) *cobra.Command {
7290
},
7391
}
7492

93+
cmd.Annotations = map[string]string{
94+
"requiredScopes": string(scopes.WriteBuilds),
95+
}
96+
7597
cmd.Flags().BoolVarP(&mine, "mine", "m", false, "Filter build to only my user.")
7698
cmd.Flags().BoolVarP(&web, "web", "w", false, "Open the build in a web browser after it has been created.")
7799
cmd.Flags().StringVarP(&branch, "branch", "b", "", "Filter builds to this branch.")

‎pkg/cmd/build/view.go

+22
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ import (
1212
"github.com/buildkite/cli/v3/internal/build/resolver/options"
1313
"github.com/buildkite/cli/v3/internal/job"
1414
pipelineResolver "github.com/buildkite/cli/v3/internal/pipeline/resolver"
15+
"github.com/buildkite/cli/v3/internal/scopes"
1516
"github.com/buildkite/cli/v3/pkg/cmd/factory"
1617
"github.com/buildkite/go-buildkite/v4"
1718
"github.com/charmbracelet/huh/spinner"
@@ -53,6 +54,23 @@ func NewCmdBuildView(f *factory.Factory) *cobra.Command {
5354
# to view most recent build by greg on the deploy-pipeline
5455
$ bk build view -p deploy-pipeline -u "greg"
5556
`),
57+
PreRunE: func(cmd *cobra.Command, args []string) error {
58+
// Get the command's required and optional scopes
59+
cmdScopes := scopes.GetCommandScopes(cmd)
60+
61+
// Get the token scopes from the factory
62+
tokenScopes := f.Config.GetTokenScopes()
63+
if len(tokenScopes) == 0 {
64+
return fmt.Errorf("no scopes found in token. Please ensure you're using a token with appropriate scopes")
65+
}
66+
67+
// Validate the scopes
68+
if err := scopes.ValidateScopes(cmdScopes, tokenScopes); err != nil {
69+
return err
70+
}
71+
72+
return nil
73+
},
5674
RunE: func(cmd *cobra.Command, args []string) error {
5775
var err error
5876
// we find the pipeline based on the following rules:
@@ -189,6 +207,10 @@ func NewCmdBuildView(f *factory.Factory) *cobra.Command {
189207
},
190208
}
191209

210+
cmd.Annotations = map[string]string{
211+
"requiredScopes": string(scopes.ReadBuilds),
212+
}
213+
192214
cmd.Flags().BoolVarP(&mine, "mine", "m", false, "Filter builds to only my user.")
193215
cmd.Flags().BoolVarP(&web, "web", "w", false, "Open the build in a web browser.")
194216
cmd.Flags().StringVarP(&branch, "branch", "b", "", "Filter builds to this branch.")

‎pkg/cmd/build/watch.go

+22
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ import (
1010
"github.com/buildkite/cli/v3/internal/build/resolver/options"
1111
"github.com/buildkite/cli/v3/internal/job"
1212
pipelineResolver "github.com/buildkite/cli/v3/internal/pipeline/resolver"
13+
"github.com/buildkite/cli/v3/internal/scopes"
1314
"github.com/buildkite/cli/v3/pkg/cmd/factory"
1415
"github.com/buildkite/go-buildkite/v4"
1516
"github.com/charmbracelet/lipgloss"
@@ -45,6 +46,23 @@ func NewCmdBuildWatch(f *factory.Factory) *cobra.Command {
4546
# Set a custom polling interval (in seconds)
4647
$ bk build watch --interval 5
4748
`),
49+
PreRunE: func(cmd *cobra.Command, args []string) error {
50+
// Get the command's required and optional scopes
51+
cmdScopes := scopes.GetCommandScopes(cmd)
52+
53+
// Get the token scopes from the factory
54+
tokenScopes := f.Config.GetTokenScopes()
55+
if len(tokenScopes) == 0 {
56+
return fmt.Errorf("no scopes found in token. Please ensure you're using a token with appropriate scopes")
57+
}
58+
59+
// Validate the scopes
60+
if err := scopes.ValidateScopes(cmdScopes, tokenScopes); err != nil {
61+
return err
62+
}
63+
64+
return nil
65+
},
4866
RunE: func(cmd *cobra.Command, args []string) error {
4967
pipelineRes := pipelineResolver.NewAggregateResolver(
5068
pipelineResolver.ResolveFromFlag(pipeline, f.Config),
@@ -96,6 +114,10 @@ func NewCmdBuildWatch(f *factory.Factory) *cobra.Command {
96114
},
97115
}
98116

117+
cmd.Annotations = map[string]string{
118+
"requiredeScopes": string(scopes.ReadBuilds),
119+
}
120+
99121
cmd.Flags().StringVarP(&pipeline, "pipeline", "p", "", "The pipeline to watch. This can be a {pipeline slug} or in the format {org slug}/{pipeline slug}.")
100122
cmd.Flags().StringVarP(&branch, "branch", "b", "", "The branch to watch builds for.")
101123
cmd.Flags().IntVar(&intervalSeconds, "interval", 1, "Polling interval in seconds")

0 commit comments

Comments
 (0)