Skip to content

feat: add cli support for --require-active-version #10337

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.

Sign up for GitHub

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 10 commits into from
Oct 19, 2023
Merged

feat: add cli support for --require-active-version #10337

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
825b827
feat: add cli support for --require-active-version
sreya Oct 18, 2023
8644201
add support for template edit
sreya Oct 19, 2023
e9c7b2f
make gen
sreya Oct 19, 2023
e0e28a2
golden files
sreya Oct 19, 2023
de17520
add test for start
sreya Oct 19, 2023
202d29a
add tests for start/restart
sreya Oct 19, 2023
a67768f
fix race
sreya Oct 19, 2023
8e19b79
pr comments
sreya Oct 19, 2023
9b96767
pr comments
sreya Oct 19, 2023
0ed711e
fix tests
sreya Oct 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
add test for start
  • Loading branch information
@sreya
sreya committed Oct 19, 2023
commit de17520c05ebe4e4514b635ccd68b41ed405e7d8
37 changes: 31 additions & 6 deletions cli/restart.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,19 +40,44 @@ func (r *RootCmd) restart() *clibase.Cmd {
return err
}

template, err := client.Template(inv.Context(), workspace.TemplateID)
buildOptions, err := asWorkspaceBuildParameters(parameterFlags.buildOptions)
if err != nil {
return err
return xerrors.Errorf("can't parse build options: %w", err)
}

buildOptions, err := asWorkspaceBuildParameters(parameterFlags.buildOptions)
template, err := client.Template(inv.Context(), workspace.TemplateID)
if err != nil {
return xerrors.Errorf("can't parse build options: %w", err)
return xerrors.Errorf("get template: %w", err)
}

versionID := workspace.LatestBuild.TemplateVersionID
if template.RequireActiveVersion {
key := "template"
resp, err := client.AuthCheck(inv.Context(), codersdk.AuthorizationRequest{
Checks: map[string]codersdk.AuthorizationCheck{
key: {
Object: codersdk.AuthorizationObject{
ResourceType: codersdk.ResourceTemplate,
OwnerID: workspace.OwnerID.String(),
OrganizationID: workspace.OrganizationID.String(),
ResourceID: template.ID.String(),
},
Action: "update",
},
},
})
if err != nil {
return xerrors.Errorf("auth check: %w", err)
}
// We don't have template admin privileges.
if !resp[key] {
versionID = template.ActiveVersionID
}
}

buildParameters, err := prepStartWorkspace(inv, client, prepStartWorkspaceArgs{
Action: WorkspaceRestart,
Template: template,
Action: WorkspaceRestart,
TemplateVersionID: versionID,

LastBuildParameters: lastBuildParameters,

Expand Down
40 changes: 34 additions & 6 deletions cli/start.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ import (

"golang.org/x/xerrors"

"github.com/google/uuid"

"github.com/coder/coder/v2/cli/clibase"
"github.com/coder/coder/v2/cli/cliui"
"github.com/coder/coder/v2/codersdk"
Expand Down Expand Up @@ -37,7 +39,32 @@ func (r *RootCmd) start() *clibase.Cmd {

template, err := client.Template(inv.Context(), workspace.TemplateID)
if err != nil {
return err
return xerrors.Errorf("get template: %w", err)
}

versionID := workspace.LatestBuild.TemplateVersionID
if template.RequireActiveVersion {
key := "template"
resp, err := client.AuthCheck(inv.Context(), codersdk.AuthorizationRequest{
Checks: map[string]codersdk.AuthorizationCheck{
key: {
Object: codersdk.AuthorizationObject{
ResourceType: codersdk.ResourceTemplate,
OwnerID: workspace.OwnerID.String(),
OrganizationID: workspace.OrganizationID.String(),
ResourceID: template.ID.String(),
},
Action: "update",
},
},
})
if err != nil {
return xerrors.Errorf("auth check: %w", err)
}
// We don't have template admin privileges.
if !resp[key] {
versionID = template.ActiveVersionID
}
}

buildOptions, err := asWorkspaceBuildParameters(parameterFlags.buildOptions)
Expand All @@ -46,8 +73,8 @@ func (r *RootCmd) start() *clibase.Cmd {
}

buildParameters, err := prepStartWorkspace(inv, client, prepStartWorkspaceArgs{
Action: WorkspaceStart,
Template: template,
Action: WorkspaceStart,
TemplateVersionID: versionID,

LastBuildParameters: lastBuildParameters,

Expand All @@ -61,6 +88,7 @@ func (r *RootCmd) start() *clibase.Cmd {
build, err := client.CreateWorkspaceBuild(inv.Context(), workspace.ID, codersdk.CreateWorkspaceBuildRequest{
Transition: codersdk.WorkspaceTransitionStart,
RichParameterValues: buildParameters,
TemplateVersionID: versionID,
})
if err != nil {
return err
Expand All @@ -82,8 +110,8 @@ func (r *RootCmd) start() *clibase.Cmd {
}

type prepStartWorkspaceArgs struct {
Action WorkspaceCLIAction
Template codersdk.Template
Action WorkspaceCLIAction
TemplateVersionID uuid.UUID

LastBuildParameters []codersdk.WorkspaceBuildParameter

Expand All @@ -94,7 +122,7 @@ type prepStartWorkspaceArgs struct {
func prepStartWorkspace(inv *clibase.Invocation, client *codersdk.Client, args prepStartWorkspaceArgs) ([]codersdk.WorkspaceBuildParameter, error) {
ctx := inv.Context()

templateVersion, err := client.TemplateVersion(ctx, args.Template.ActiveVersionID)
templateVersion, err := client.TemplateVersion(ctx, args.TemplateVersionID)
if err != nil {
return nil, xerrors.Errorf("get template version: %w", err)
}
Expand Down
165 changes: 165 additions & 0 deletions enterprise/cli/start_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,165 @@
package cli_test

import (
"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/database"
"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/testutil"
)

func TestStart(t *testing.T) {
t.Parallel()

t.Run("RequireActiveVersion", func(t *testing.T) {
t.Parallel()

ctx := testutil.Context(t, testutil.WaitMedium)
ownerClient, owner := coderdenttest.New(t, &coderdenttest.Options{
Options: &coderdtest.Options{
IncludeProvisionerDaemon: true,
},
LicenseOptions: &coderdenttest.LicenseOptions{
Features: license.Features{
codersdk.FeatureAccessControl: 1,
codersdk.FeatureTemplateRBAC: 1,
codersdk.FeatureAdvancedTemplateScheduling: 1,
},
},
})

// Create an initial version.
oldVersion := coderdtest.CreateTemplateVersion(t, ownerClient, owner.OrganizationID, nil)
// Create a template that mandates the promoted version.
// This should be enforced for everyone except template admins.
template := coderdtest.CreateTemplate(t, ownerClient, owner.OrganizationID, oldVersion.ID)
coderdtest.AwaitTemplateVersionJobCompleted(t, ownerClient, oldVersion.ID)
require.Equal(t, oldVersion.ID, template.ActiveVersionID)
template, err := ownerClient.UpdateTemplateMeta(ctx, template.ID, codersdk.UpdateTemplateMeta{
RequireActiveVersion: true,
})
require.NoError(t, err)
require.True(t, template.RequireActiveVersion)

// Create a new version that we will promote.
activeVersion := coderdtest.CreateTemplateVersion(t, ownerClient, owner.OrganizationID, nil, func(ctvr *codersdk.CreateTemplateVersionRequest) {
ctvr.TemplateID = template.ID
})
coderdtest.AwaitTemplateVersionJobCompleted(t, ownerClient, activeVersion.ID)
err = ownerClient.UpdateActiveTemplateVersion(ctx, template.ID, codersdk.UpdateActiveTemplateVersion{
ID: activeVersion.ID,
})
require.NoError(t, err)
err = ownerClient.UpdateActiveTemplateVersion(ctx, template.ID, codersdk.UpdateActiveTemplateVersion{
ID: activeVersion.ID,
})
require.NoError(t, err)

templateAdminClient, templateAdmin := coderdtest.CreateAnotherUser(t, ownerClient, owner.OrganizationID, rbac.RoleTemplateAdmin())
templateACLAdminClient, templateACLAdmin := coderdtest.CreateAnotherUser(t, ownerClient, owner.OrganizationID)
templateGroupACLAdminClient, templateGroupACLAdmin := coderdtest.CreateAnotherUser(t, ownerClient, owner.OrganizationID)
memberClient, member := coderdtest.CreateAnotherUser(t, ownerClient, owner.OrganizationID)

// Create a group so we can also test group template admin ownership.
group, err := ownerClient.CreateGroup(ctx, owner.OrganizationID, codersdk.CreateGroupRequest{
Name: "test",
})
require.NoError(t, err)

// Add the user who gains template admin via group membership.
group, err = ownerClient.PatchGroup(ctx, group.ID, codersdk.PatchGroupRequest{
AddUsers: []string{templateGroupACLAdmin.ID.String()},
})
require.NoError(t, err)

// Update the template for both users and groups.
err = ownerClient.UpdateTemplateACL(ctx, template.ID, codersdk.UpdateTemplateACL{
UserPerms: map[string]codersdk.TemplateRole{
templateACLAdmin.ID.String(): codersdk.TemplateRoleAdmin,
},
GroupPerms: map[string]codersdk.TemplateRole{
group.ID.String(): codersdk.TemplateRoleAdmin,
},
})
require.NoError(t, err)

type testcase struct {
Name string
Client *codersdk.Client
WorkspaceOwner uuid.UUID
ExpectedVersion uuid.UUID
}

cases := []testcase{
{
Name: "OwnerUnchanged",
Client: ownerClient,
WorkspaceOwner: owner.UserID,
ExpectedVersion: oldVersion.ID,
},
{
Name: "TemplateAdminUnchanged",
Client: templateAdminClient,
WorkspaceOwner: templateAdmin.ID,
ExpectedVersion: oldVersion.ID,
},
{
Name: "TemplateACLAdminUnchanged",
Client: templateACLAdminClient,
WorkspaceOwner: templateACLAdmin.ID,
ExpectedVersion: oldVersion.ID,
},
{
Name: "TemplateGroupACLAdminUnchanged",
Client: templateGroupACLAdminClient,
WorkspaceOwner: templateGroupACLAdmin.ID,
ExpectedVersion: oldVersion.ID,
},
{
Name: "MemberUpdates",
Client: memberClient,
WorkspaceOwner: member.ID,
ExpectedVersion: activeVersion.ID,
},
}

for _, c := range cases {
t.Run(c.Name, func(t *testing.T) {
// Instantiate a new context for each subtest since
// they can potentially be lengthy.
ctx = testutil.Context(t, testutil.WaitMedium)
// Create the workspace using the admin since we want
// to force the old version.
ws, err := ownerClient.CreateWorkspace(ctx, owner.OrganizationID, c.WorkspaceOwner.String(), codersdk.CreateWorkspaceRequest{
TemplateVersionID: oldVersion.ID,
Name: "abc123",
AutomaticUpdates: codersdk.AutomaticUpdatesNever,
})
require.NoError(t, err)
coderdtest.AwaitWorkspaceBuildJobCompleted(t, c.Client, ws.LatestBuild.ID)
// Stop the workspace so that we can start it.
coderdtest.MustTransitionWorkspace(t, c.Client, ws.ID, database.WorkspaceTransitionStart, database.WorkspaceTransitionStop, func(req *codersdk.CreateWorkspaceBuildRequest) {
req.TemplateVersionID = oldVersion.ID
})

// Start the workspace. Every test permutation should
// pass.
inv, conf := newCLI(t, "start", ws.Name)
clitest.SetupConfig(t, c.Client, conf)
err = inv.Run()
require.NoError(t, err)

ws = coderdtest.MustWorkspace(t, c.Client, ws.ID)
require.Equal(t, c.ExpectedVersion, ws.LatestBuild.TemplateVersionID)
})
}
})
}