-
Notifications
You must be signed in to change notification settings - Fork 894
feat: add provisioner key cli commands #13875
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
Merged
Merged
Changes from 7 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
83e3868
add api routes
f0ssel e4cf813
feat: add provisioner key cli commands
f0ssel 9fd47c8
fix imports
f0ssel 3d1b075
fmt
f0ssel c67ed19
add tests
f0ssel adffefd
make golden
f0ssel da95666
hide commands
f0ssel 90412c7
pr comments
f0ssel 86c0d02
remove rows type
f0ssel File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,196 @@ | ||
package cli | ||
|
||
import ( | ||
"fmt" | ||
"strings" | ||
"time" | ||
|
||
"github.com/google/uuid" | ||
"golang.org/x/xerrors" | ||
|
||
agpl "github.com/coder/coder/v2/cli" | ||
"github.com/coder/coder/v2/cli/cliui" | ||
"github.com/coder/coder/v2/codersdk" | ||
"github.com/coder/pretty" | ||
"github.com/coder/serpent" | ||
) | ||
|
||
func (r *RootCmd) provisionerKeys() *serpent.Command { | ||
cmd := &serpent.Command{ | ||
Use: "keys", | ||
Short: "Manage provisioner keys", | ||
Handler: func(inv *serpent.Invocation) error { | ||
return inv.Command.HelpHandler(inv) | ||
}, | ||
Hidden: true, | ||
Aliases: []string{"key"}, | ||
Children: []*serpent.Command{ | ||
r.provisionerKeysCreate(), | ||
r.provisionerKeysList(), | ||
r.provisionerKeysDelete(), | ||
}, | ||
} | ||
|
||
return cmd | ||
} | ||
|
||
func (r *RootCmd) provisionerKeysCreate() *serpent.Command { | ||
orgContext := agpl.NewOrganizationContext() | ||
|
||
client := new(codersdk.Client) | ||
cmd := &serpent.Command{ | ||
Use: "create <name>", | ||
Short: "Create a new provisioner key", | ||
Middleware: serpent.Chain( | ||
serpent.RequireNArgs(1), | ||
r.InitClient(client), | ||
), | ||
Handler: func(inv *serpent.Invocation) error { | ||
ctx := inv.Context() | ||
|
||
org, err := orgContext.Selected(inv, client) | ||
if err != nil { | ||
return xerrors.Errorf("current organization: %w", err) | ||
} | ||
|
||
res, err := client.CreateProvisionerKey(ctx, org.ID, codersdk.CreateProvisionerKeyRequest{ | ||
Name: inv.Args[0], | ||
}) | ||
if err != nil { | ||
return xerrors.Errorf("create provisioner key: %w", err) | ||
} | ||
|
||
_, _ = fmt.Fprintf(inv.Stdout, "Successfully created provisioner key %s!\n\n%s\n", pretty.Sprint(cliui.DefaultStyles.Keyword, strings.ToLower(inv.Args[0])), pretty.Sprint(cliui.DefaultStyles.Keyword, res.Key)) | ||
|
||
return nil | ||
}, | ||
} | ||
|
||
cmd.Options = serpent.OptionSet{} | ||
orgContext.AttachOptions(cmd) | ||
|
||
return cmd | ||
} | ||
|
||
type provisionerKeysTableRow struct { | ||
// For json output: | ||
Key codersdk.ProvisionerKey `table:"-"` | ||
|
||
// For table output: | ||
Name string `json:"-" table:"name,default_sort"` | ||
CreatedAt time.Time `json:"-" table:"created_at"` | ||
OrganizationID uuid.UUID `json:"-" table:"organization_id"` | ||
} | ||
f0ssel marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
func provisionerKeysToRows(keys ...codersdk.ProvisionerKey) []provisionerKeysTableRow { | ||
rows := make([]provisionerKeysTableRow, 0, len(keys)) | ||
for _, key := range keys { | ||
rows = append(rows, provisionerKeysTableRow{ | ||
Name: key.Name, | ||
CreatedAt: key.CreatedAt, | ||
OrganizationID: key.OrganizationID, | ||
}) | ||
} | ||
|
||
return rows | ||
} | ||
|
||
func (r *RootCmd) provisionerKeysList() *serpent.Command { | ||
var ( | ||
orgContext = agpl.NewOrganizationContext() | ||
formatter = cliui.NewOutputFormatter( | ||
cliui.TableFormat([]provisionerKeysTableRow{}, nil), | ||
cliui.JSONFormat(), | ||
) | ||
) | ||
|
||
client := new(codersdk.Client) | ||
cmd := &serpent.Command{ | ||
Use: "list", | ||
Short: "List provisioner keys", | ||
f0ssel marked this conversation as resolved.
Show resolved
Hide resolved
|
||
Aliases: []string{"ls"}, | ||
Middleware: serpent.Chain( | ||
serpent.RequireNArgs(0), | ||
r.InitClient(client), | ||
), | ||
Handler: func(inv *serpent.Invocation) error { | ||
ctx := inv.Context() | ||
|
||
org, err := orgContext.Selected(inv, client) | ||
if err != nil { | ||
return xerrors.Errorf("current organization: %w", err) | ||
} | ||
|
||
keys, err := client.ListProvisionerKeys(ctx, org.ID) | ||
if err != nil { | ||
return xerrors.Errorf("list provisioner keys: %w", err) | ||
} | ||
|
||
if len(keys) == 0 { | ||
_, _ = fmt.Fprintln(inv.Stdout, "No provisioner keys found") | ||
return nil | ||
} | ||
|
||
rows := provisionerKeysToRows(keys...) | ||
out, err := formatter.Format(inv.Context(), rows) | ||
if err != nil { | ||
return xerrors.Errorf("display provisioner keys: %w", err) | ||
} | ||
|
||
_, _ = fmt.Fprintln(inv.Stdout, out) | ||
|
||
return nil | ||
}, | ||
} | ||
|
||
cmd.Options = serpent.OptionSet{} | ||
orgContext.AttachOptions(cmd) | ||
|
||
return cmd | ||
} | ||
|
||
func (r *RootCmd) provisionerKeysDelete() *serpent.Command { | ||
orgContext := agpl.NewOrganizationContext() | ||
|
||
client := new(codersdk.Client) | ||
cmd := &serpent.Command{ | ||
Use: "delete <name>", | ||
Short: "Delete a provisioner key", | ||
Middleware: serpent.Chain( | ||
serpent.RequireNArgs(1), | ||
r.InitClient(client), | ||
), | ||
Handler: func(inv *serpent.Invocation) error { | ||
ctx := inv.Context() | ||
|
||
org, err := orgContext.Selected(inv, client) | ||
if err != nil { | ||
return xerrors.Errorf("current organization: %w", err) | ||
} | ||
|
||
_, err = cliui.Prompt(inv, cliui.PromptOptions{ | ||
Text: fmt.Sprintf("Are you sure you want to delete provisioner key %s?", pretty.Sprint(cliui.DefaultStyles.Keyword, inv.Args[0])), | ||
IsConfirm: true, | ||
}) | ||
if err != nil { | ||
return err | ||
} | ||
|
||
err = client.DeleteProvisionerKey(ctx, org.ID, inv.Args[0]) | ||
if err != nil { | ||
return xerrors.Errorf("delete provisioner key: %w", err) | ||
} | ||
|
||
_, _ = fmt.Fprintf(inv.Stdout, "Successfully deleted provisioner key %s!\n", pretty.Sprint(cliui.DefaultStyles.Keyword, strings.ToLower(inv.Args[0]))) | ||
|
||
return nil | ||
}, | ||
} | ||
|
||
cmd.Options = serpent.OptionSet{ | ||
cliui.SkipPromptOption(), | ||
} | ||
orgContext.AttachOptions(cmd) | ||
|
||
return cmd | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,111 @@ | ||
package cli_test | ||
|
||
import ( | ||
"strings" | ||
"testing" | ||
|
||
"github.com/google/uuid" | ||
"github.com/stretchr/testify/require" | ||
|
||
"github.com/coder/coder/v2/cli/clitest" | ||
"github.com/coder/coder/v2/coderd/coderdtest" | ||
"github.com/coder/coder/v2/coderd/rbac" | ||
"github.com/coder/coder/v2/codersdk" | ||
"github.com/coder/coder/v2/enterprise/coderd/coderdenttest" | ||
"github.com/coder/coder/v2/enterprise/coderd/license" | ||
"github.com/coder/coder/v2/pty/ptytest" | ||
"github.com/coder/coder/v2/testutil" | ||
) | ||
|
||
func TestProvisionerKeys(t *testing.T) { | ||
t.Parallel() | ||
|
||
t.Run("CRUD", func(t *testing.T) { | ||
t.Parallel() | ||
|
||
dv := coderdtest.DeploymentValues(t) | ||
dv.Experiments = []string{string(codersdk.ExperimentMultiOrganization)} | ||
client, owner := coderdenttest.New(t, &coderdenttest.Options{ | ||
Options: &coderdtest.Options{ | ||
DeploymentValues: dv, | ||
}, | ||
LicenseOptions: &coderdenttest.LicenseOptions{ | ||
Features: license.Features{ | ||
codersdk.FeatureMultipleOrganizations: 1, | ||
}, | ||
}, | ||
}) | ||
orgAdminClient, _ := coderdtest.CreateAnotherUser(t, client, owner.OrganizationID, rbac.ScopedRoleOrgAdmin(owner.OrganizationID)) | ||
|
||
name := "dont-TEST-me" | ||
ctx := testutil.Context(t, testutil.WaitMedium) | ||
inv, conf := newCLI( | ||
t, | ||
"provisioner", "keys", "create", name, | ||
) | ||
|
||
pty := ptytest.New(t) | ||
inv.Stdout = pty.Output() | ||
clitest.SetupConfig(t, orgAdminClient, conf) | ||
|
||
err := inv.WithContext(ctx).Run() | ||
require.NoError(t, err) | ||
|
||
line := pty.ReadLine(ctx) | ||
require.Contains(t, line, "Successfully created provisioner key") | ||
require.Contains(t, line, strings.ToLower(name)) | ||
// empty line | ||
_ = pty.ReadLine(ctx) | ||
key := pty.ReadLine(ctx) | ||
require.NotEmpty(t, key) | ||
parts := strings.Split(key, ":") | ||
require.Len(t, parts, 2, "expected 2 parts") | ||
_, err = uuid.Parse(parts[0]) | ||
require.NoError(t, err, "expected token to be a uuid") | ||
|
||
inv, conf = newCLI( | ||
t, | ||
"provisioner", "keys", "ls", | ||
) | ||
pty = ptytest.New(t) | ||
inv.Stdout = pty.Output() | ||
clitest.SetupConfig(t, orgAdminClient, conf) | ||
|
||
err = inv.WithContext(ctx).Run() | ||
require.NoError(t, err) | ||
line = pty.ReadLine(ctx) | ||
require.Contains(t, line, "NAME") | ||
require.Contains(t, line, "CREATED AT") | ||
require.Contains(t, line, "ORGANIZATION ID") | ||
line = pty.ReadLine(ctx) | ||
require.Contains(t, line, strings.ToLower(name)) | ||
|
||
inv, conf = newCLI( | ||
t, | ||
"provisioner", "keys", "delete", "-y", name, | ||
) | ||
|
||
pty = ptytest.New(t) | ||
inv.Stdout = pty.Output() | ||
clitest.SetupConfig(t, orgAdminClient, conf) | ||
|
||
err = inv.WithContext(ctx).Run() | ||
require.NoError(t, err) | ||
line = pty.ReadLine(ctx) | ||
require.Contains(t, line, "Successfully deleted provisioner key") | ||
require.Contains(t, line, strings.ToLower(name)) | ||
|
||
inv, conf = newCLI( | ||
t, | ||
"provisioner", "keys", "ls", | ||
) | ||
pty = ptytest.New(t) | ||
inv.Stdout = pty.Output() | ||
clitest.SetupConfig(t, orgAdminClient, conf) | ||
|
||
err = inv.WithContext(ctx).Run() | ||
require.NoError(t, err) | ||
line = pty.ReadLine(ctx) | ||
require.Contains(t, line, "No provisioner keys found") | ||
}) | ||
} |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,6 +5,8 @@ USAGE: | |
|
||
Manage provisioner daemons | ||
|
||
Aliases: provisioner | ||
|
||
SUBCOMMANDS: | ||
start Run a provisioner daemon | ||
|
||
|
16 changes: 16 additions & 0 deletions
16
enterprise/cli/testdata/coder_provisionerd_keys_--help.golden
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
coder v0.0.0-devel | ||
|
||
USAGE: | ||
coder provisionerd keys | ||
|
||
Manage provisioner keys | ||
|
||
Aliases: key | ||
|
||
SUBCOMMANDS: | ||
create Create a new provisioner key | ||
delete Delete a provisioner key | ||
list List provisioner keys | ||
|
||
——— | ||
Run `coder --help` for a list of global options. |
13 changes: 13 additions & 0 deletions
13
enterprise/cli/testdata/coder_provisionerd_keys_create_--help.golden
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,13 @@ | ||
coder v0.0.0-devel | ||
|
||
USAGE: | ||
coder provisionerd keys create [flags] <name> | ||
|
||
Create a new provisioner key | ||
|
||
OPTIONS: | ||
-O, --org string, $CODER_ORGANIZATION | ||
Select which organization (uuid or name) to use. | ||
|
||
——— | ||
Run `coder --help` for a list of global options. |
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.