Skip to content

feat: split cli roles edit command into create and update commands #17121

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 11 commits into from
Apr 4, 2025
Merged

feat: split cli roles edit command into create and update commands #17121

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
1ba6157
feat: split the org role edit command into two commands
brettkolodny Mar 26, 2025
566d432
chore: update tests and generate new golden files
brettkolodny Mar 26, 2025
3aabba3
chore: make gen
brettkolodny Mar 27, 2025
62b9d57
feat: add tests for update and create CLI
brettkolodny Apr 1, 2025
c90838f
fix: add call to Parallel in test
brettkolodny Apr 1, 2025
9f0a8f1
Merge branch 'main' into brett-14239/refactor-cli-roles-edit-command
brettkolodny Apr 1, 2025
d26c0d2
fix: spelling and grammar
brettkolodny Apr 3, 2025
bb7212d
Merge branch 'main' into brett-14239/refactor-cli-roles-edit-command
brettkolodny Apr 3, 2025
f6559b3
fix: fix build errors
brettkolodny Apr 3, 2025
c21e49b
Merge branch 'main' into brett-14239/refactor-cli-roles-edit-command
brettkolodny Apr 4, 2025
38bbc69
fix: update string in org roles cli test to reflect real output
brettkolodny Apr 4, 2025
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
feat: add tests for update and create CLI
  • Loading branch information
@brettkolodny
brettkolodny committed Apr 1, 2025
commit 62b9d571efc0f36554a0360c2e9249bc8486e50b
102 changes: 102 additions & 0 deletions enterprise/cli/organization_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,13 @@
"fmt"
"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/database/dbgen"
"github.com/coder/coder/v2/coderd/rbac"
"github.com/coder/coder/v2/codersdk"
"github.com/coder/coder/v2/enterprise/coderd/coderdenttest"
Expand Down Expand Up @@ -185,3 +188,102 @@
pty.ExpectMatch(orgs["bar"].ID.String())
})
}

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

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

Check failure on line 195 in enterprise/cli/organization_test.go

View workflow job for this annotation

GitHub Actions / lint 

Function TestUpdateOrganizationRoles missing the call to method parallel in the test run (paralleltest)
ownerClient, db, owner := coderdenttest.NewWithDatabase(t, &coderdenttest.Options{
LicenseOptions: &coderdenttest.LicenseOptions{
Features: license.Features{
codersdk.FeatureCustomRoles: 1,
},
},
})
client, _ := coderdtest.CreateAnotherUser(t, ownerClient, owner.OrganizationID, rbac.RoleOwner())

// Create a role in the DB with no permissions
const expectedRole = "test-role"
dbgen.CustomRole(t, db, database.CustomRole{
Name: expectedRole,
DisplayName: "Expected",
SitePermissions: nil,
OrgPermissions: nil,
UserPermissions: nil,
OrganizationID: uuid.NullUUID{
UUID: owner.OrganizationID,
Valid: true,
},
})

// Update the new role via JSON
ctx := testutil.Context(t, testutil.WaitMedium)
inv, root := clitest.New(t, "organization", "roles", "update", "--stdin")
inv.Stdin = bytes.NewBufferString(fmt.Sprintf(`{
"name": "test-role",
"organization_id": "%s",
"display_name": "",
"site_permissions": [],
"organization_permissions": [
{
"resource_type": "workspace",
"action": "read"
}
],
"user_permissions": [],
"assignable": false,
"built_in": false
}`, owner.OrganizationID.String()))

//nolint:gocritic // only owners can edit roles
clitest.SetupConfig(t, client, root)

buf := new(bytes.Buffer)
inv.Stdout = buf
err := inv.WithContext(ctx).Run()
require.NoError(t, err)
require.Contains(t, buf.String(), "test-role")
require.Contains(t, buf.String(), "1 permissions")
})

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

ownerClient, _, owner := coderdenttest.NewWithDatabase(t, &coderdenttest.Options{
LicenseOptions: &coderdenttest.LicenseOptions{
Features: license.Features{
codersdk.FeatureCustomRoles: 1,
},
},
})
client, _ := coderdtest.CreateAnotherUser(t, ownerClient, owner.OrganizationID, rbac.RoleOwner())

// Update the new role via JSON
ctx := testutil.Context(t, testutil.WaitMedium)
inv, root := clitest.New(t, "organization", "roles", "update", "--stdin")
inv.Stdin = bytes.NewBufferString(fmt.Sprintf(`{
"name": "test-role",
"organization_id": "%s",
"display_name": "",
"site_permissions": [],
"organization_permissions": [
{
"resource_type": "workspace",
"action": "read"
}
],
"user_permissions": [],
"assignable": false,
"built_in": false
}`, owner.OrganizationID.String()))

//nolint:gocritic // only owners can edit roles
clitest.SetupConfig(t, client, root)

buf := new(bytes.Buffer)
inv.Stdout = buf
err := inv.WithContext(ctx).Run()
require.Error(t, err)
require.ErrorContains(t, err, "The role test-role does not exist exists.")
})
}
Loading