## Stack Part of [CODAGT-1341](https://linear.app/codercom/issue/CODAGT-1341/support-organization-level-skills-in-coder-agents). This stack adds organization skills to Coder Agents: admins publish a skill once per organization, share it with groups or members, and chats in that organization load it next to personal and workspace skills. It replaces the 21-PR draft stack #30584 to #30604 with five PRs, bottom to top: 1. **#30609** data model: one migration, queries, RBAC and dbauthz (this PR) 2. #30610 organization skill API routes and the scope-neutral SDK 3. #30611 sharing ACL routes 4. #30612 settings UI: shared skills table, admin page, member section 5. #30613 chats: chatd loading, `/` menu, docs ## What changes This PR adds the data model and authorization for organization skills. Personal skills keep working unchanged: `git diff origin/main -- codersdk site` shows only generated RBAC and API key scope additions (`apikey_scopes_gen.go`, `rbacresources_gen.go`, `rbacresourcesGenerated.ts`, the RBAC and scope unions in `typesGenerated.ts`) and `codersdk.ResourceTypeOrganizationSkill` with its friendly string. No personal route, SDK type or site component changes, and `coderd/userskills_test.go` changes only by mechanical constant renames. **One migration, `000621_skills`** (please review it closely): - renames `user_skills` to `skills` with its constraints, index and triggers, and recreates the cap function and `delete_deleted_user_resources`, whose PL/pgSQL bodies name the table; - adds `organization_id` and `project_id` (`ON DELETE CASCADE`), `enabled` (default true), and `group_acl` / `user_acl` (`jsonb`, default `{}`), with CHECKs for exactly one owner, ACLs that are JSON objects, and ACLs that stay empty unless an organization owns the row, plus partial unique name indexes per owner kind; - replaces the cap trigger with `enforce_skills_per_owner_limit()`: 100 rows per owner, disabled rows included, locking the owner row `FOR NO KEY UPDATE` so unrelated foreign key checks are not blocked; - adds a `BEFORE DELETE` trigger on `organization_members` that removes a departing member from `user_acl` on that organization's skills, so rejoining doesn't restore a direct grant; - adds the `organization_skill` `resource_type` and `api_key_scope` enum values last; nothing in the migration uses them. The down migration undoes the three old migrations in reverse order: it drops organization and project rows and restores `user_skills`, its names, the cap function and `user_id NOT NULL`. Authorization: a new RBAC resource `organization_skill` (create, read, update, delete, share). Owner and org admin get it; site and org auditors get read; members read only through the skill's ACL, which applies only to members of its organization. `Skill.RBACObject()` returns the organization object with both ACLs; project rows stay denied to everyone. New sqlc queries cover organization insert, get, list (SQL-filtered through `GetAuthorizedOrganizationSkillMetadata` and a `regosql` converter), update and delete, with dbauthz wrappers and the audit table entries. No routes yet. ## Commits The first commit reproduces the reviewed code from the old stack; each later commit is a labeled trim or fix. - `baa3150e3b7` feat: add the organization skills data model. Reproduction: every non-site file this commit changes equals the reviewed old `authz` head `1e16b3004c4`, except that the old stack's migrations 000615, 000616 and 000617 are merged into one migration (then `000615_skills`, now `000621_skills`) with one fixture (`testdata/fixtures/000621_skills.up.sql`) and one migration test (now `testMigration000621Skills`). At that commit, `dump.sql` was byte-identical to the old head's. - `1b84e83463a` test(coderd/database): keep only the SQL paths of the org skill matrix. `TestOrganizationSkillAuthorization` becomes `TestOrganizationSkillQueries` instead of being deleted, because coverage showed it is this PR's only run of the `GetAuthorizedOrganizationSkillMetadata` row scan (80% to 65% without it) and of the organization update and delete queries (100% to 0%). Swapping `group_acl` and `user_acl` in the converter makes `GrantedMember` fail. The removed cases are decided by `TestRolePermissions`, `TestSkillRBACObjectOrganizationACL` and the dbauthz method suite. - `e2931b412e9` test(coderd/database): fold the skill cap cases into existing coverage. The user case is covered by `TestUserSkillLimit` and `TestUserSkillLimitConcurrentCreates`; the organization case folds into `ConcurrentOrganizationInsertsHonorCap`, which now also checks that disabled rows count and another organization is unaffected (mutation checked); the project case stays. - `be62aea9021` test(coderd/rbac): drop `TestOrganizationSkillReadScope`, covered by `TestExternalScopeNames` and the generated scope file. - `0c275ba37de` merges main at `454a2fcc697`, which took 000615 to 000618: it renumbers the migration to 000619 and resolves `dump.sql`, `check_constraint.go` and the generated API docs. `8f2b4b87ee2` merges main at `ad85646164e`, which took 000619: it renumbers the migration to 000620. - `5248d56b64f` merges main at `e7b76872098`, which took 000620 (`000620_audit_chat_project_instructions_resource_type`): it renumbers the migration, fixture and migration test to `000621_skills` (step `Migration000621Skills`, version 621), and resolves `enterprise/audit/table.go` (keeping main's `AuditableChatProjectInstructions` entries and the `Skill` entry), `dump.sql` and `models.go` (the `resource_type` enum gets `chat_project_instructions`, then `organization_skill`) and the regenerated `schemas.md`. The up and down SQL are unchanged by every renumbering. ## Size Production +549/-67, tests +728/-33, generated +881/-314; total +2158/-414. This is above the 500-line reviewer-friendly limit on purpose: Mike asked for 4 to 5 PRs instead of the 21 small ones this stack replaces. ## Replaces #30584 (rename `user_skills` to `skills`), #30585 (skill owners), #30586 (organization skill authorization). ## Validation - Migration test: up keeps the existing personal row and its ID; down restores the `user_skills` names, cap function and `NOT NULL`, and drops organization rows; soft-deleting a user removes their skills after up, after down, and after re-up. - `go test` passed on `be62aea9021`, before the main merges, for `coderd` (skill tests), `coderd/database`, `dbauthz`, `migrations`, `gentest`, `coderd/rbac/...`, `coderd/x/chatd`, `coderd/x/skills`, `enterprise/audit` and `enterprise/coderd`; `make lint/check-scopes` passed; the four personal skills Vitest files pass unchanged. - On `5248d56b64f`: build, vet, `TestMigrate`, `TestMigrationChain`, the `migrations`, `database`, `dbauthz`, `gentest`, `rbac` and `enterprise/audit` packages pass; `make gen` run twice is clean, and `make pre-commit` passes. - Remote UAT round 7 through Coder Agents passed on the whole stack; see #30613's Validation for scope and findings. > Xum opened this PR on behalf of @ibetitsmike.
320 lines
10 KiB
Go
320 lines
10 KiB
Go
package database
|
|
|
|
import (
|
|
"context"
|
|
"testing"
|
|
|
|
"github.com/google/uuid"
|
|
"github.com/prometheus/client_golang/prometheus"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/coder/coder/v2/coderd/rbac"
|
|
"github.com/coder/coder/v2/coderd/rbac/policy"
|
|
)
|
|
|
|
func TestAPIKeyScopesExpand(t *testing.T) {
|
|
t.Parallel()
|
|
t.Run("builtins", func(t *testing.T) {
|
|
t.Parallel()
|
|
cases := []struct {
|
|
name string
|
|
scopes APIKeyScopes
|
|
want func(t *testing.T, s rbac.Scope)
|
|
}{
|
|
{
|
|
name: "all",
|
|
scopes: APIKeyScopes{ApiKeyScopeCoderAll},
|
|
want: func(t *testing.T, s rbac.Scope) {
|
|
requirePermission(t, s, rbac.ResourceWildcard.Type, policy.Action(policy.WildcardSymbol))
|
|
requireAllowAll(t, s)
|
|
},
|
|
},
|
|
{
|
|
name: "application_connect",
|
|
scopes: APIKeyScopes{ApiKeyScopeCoderApplicationConnect},
|
|
want: func(t *testing.T, s rbac.Scope) {
|
|
requirePermission(t, s, rbac.ResourceWorkspace.Type, policy.ActionApplicationConnect)
|
|
requireAllowAll(t, s)
|
|
},
|
|
},
|
|
}
|
|
for _, tc := range cases {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
t.Parallel()
|
|
s, err := tc.scopes.expandRBACScope()
|
|
require.NoError(t, err)
|
|
tc.want(t, s)
|
|
})
|
|
}
|
|
})
|
|
|
|
t.Run("low_level_pairs", func(t *testing.T) {
|
|
t.Parallel()
|
|
cases := []struct {
|
|
name string
|
|
scopes APIKeyScopes
|
|
res string
|
|
act policy.Action
|
|
}{
|
|
{name: "workspace:read", scopes: APIKeyScopes{ApiKeyScopeWorkspaceRead}, res: rbac.ResourceWorkspace.Type, act: policy.ActionRead},
|
|
{name: "template:use", scopes: APIKeyScopes{ApiKeyScopeTemplateUse}, res: rbac.ResourceTemplate.Type, act: policy.ActionUse},
|
|
}
|
|
for _, tc := range cases {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
t.Parallel()
|
|
s, err := tc.scopes.expandRBACScope()
|
|
require.NoError(t, err)
|
|
requirePermission(t, s, tc.res, tc.act)
|
|
requireAllowAll(t, s)
|
|
})
|
|
}
|
|
})
|
|
|
|
t.Run("merge", func(t *testing.T) {
|
|
t.Parallel()
|
|
scopes := APIKeyScopes{ApiKeyScopeCoderApplicationConnect, ApiKeyScopeCoderAll, ApiKeyScopeWorkspaceRead}
|
|
s, err := scopes.expandRBACScope()
|
|
require.NoError(t, err)
|
|
requirePermission(t, s, rbac.ResourceWildcard.Type, policy.Action(policy.WildcardSymbol))
|
|
requirePermission(t, s, rbac.ResourceWorkspace.Type, policy.ActionApplicationConnect)
|
|
requirePermission(t, s, rbac.ResourceWorkspace.Type, policy.ActionRead)
|
|
requireAllowAll(t, s)
|
|
})
|
|
|
|
t.Run("effective_scope_keep_types", func(t *testing.T) {
|
|
t.Parallel()
|
|
workspaceID := uuid.New()
|
|
|
|
effective := APIKeyScopeSet{
|
|
Scopes: APIKeyScopes{ApiKeyScopeWorkspaceRead},
|
|
AllowList: AllowList{
|
|
{Type: rbac.ResourceWorkspace.Type, ID: workspaceID.String()},
|
|
},
|
|
}
|
|
|
|
expanded, err := effective.Expand()
|
|
require.NoError(t, err)
|
|
require.Len(t, expanded.AllowIDList, 1)
|
|
require.Equal(t, "workspace", expanded.AllowIDList[0].Type)
|
|
require.Equal(t, workspaceID.String(), expanded.AllowIDList[0].ID)
|
|
})
|
|
|
|
t.Run("empty_rejected", func(t *testing.T) {
|
|
t.Parallel()
|
|
_, err := (APIKeyScopes{}).expandRBACScope()
|
|
require.Error(t, err)
|
|
require.ErrorContains(t, err, "no scopes provided")
|
|
})
|
|
|
|
t.Run("allow_list_overrides", func(t *testing.T) {
|
|
t.Parallel()
|
|
allowID := uuid.NewString()
|
|
set := APIKeyScopes{ApiKeyScopeWorkspaceRead}.WithAllowList(AllowList{
|
|
{Type: rbac.ResourceWorkspace.Type, ID: allowID},
|
|
})
|
|
s, err := set.Expand()
|
|
require.NoError(t, err)
|
|
require.Len(t, s.AllowIDList, 1)
|
|
require.Equal(t, rbac.AllowListElement{Type: rbac.ResourceWorkspace.Type, ID: allowID}, s.AllowIDList[0])
|
|
})
|
|
|
|
t.Run("allow_list_wildcard_keeps_merged", func(t *testing.T) {
|
|
t.Parallel()
|
|
set := APIKeyScopes{ApiKeyScopeWorkspaceRead}.WithAllowList(AllowList{
|
|
{Type: policy.WildcardSymbol, ID: policy.WildcardSymbol},
|
|
})
|
|
s, err := set.Expand()
|
|
require.NoError(t, err)
|
|
requirePermission(t, s, rbac.ResourceWorkspace.Type, policy.ActionRead)
|
|
requireAllowAll(t, s)
|
|
})
|
|
|
|
t.Run("scope_set_helper", func(t *testing.T) {
|
|
t.Parallel()
|
|
allowID := uuid.NewString()
|
|
key := APIKey{
|
|
Scopes: APIKeyScopes{ApiKeyScopeWorkspaceRead},
|
|
AllowList: AllowList{
|
|
{Type: rbac.ResourceWorkspace.Type, ID: allowID},
|
|
},
|
|
}
|
|
s, err := key.ScopeSet().Expand()
|
|
require.NoError(t, err)
|
|
require.Len(t, s.AllowIDList, 1)
|
|
require.Equal(t, rbac.AllowListElement{Type: rbac.ResourceWorkspace.Type, ID: allowID}, s.AllowIDList[0])
|
|
})
|
|
}
|
|
|
|
//nolint:tparallel,paralleltest
|
|
func TestChatACLDisabled(t *testing.T) {
|
|
uid := uuid.NewString()
|
|
gid := uuid.NewString()
|
|
|
|
chat := Chat{
|
|
ID: uuid.New(),
|
|
OrganizationID: uuid.New(),
|
|
OwnerID: uuid.New(),
|
|
UserACL: ChatACL{
|
|
uid: ChatACLEntry{Permissions: []policy.Action{policy.ActionRead}},
|
|
},
|
|
GroupACL: ChatACL{
|
|
gid: ChatACLEntry{Permissions: []policy.Action{policy.ActionRead}},
|
|
},
|
|
}
|
|
|
|
t.Run("ACLsOmittedWhenDisabled", func(t *testing.T) {
|
|
rbac.SetChatACLDisabled(true)
|
|
t.Cleanup(func() { rbac.SetChatACLDisabled(false) })
|
|
|
|
obj := chat.RBACObject()
|
|
|
|
require.Empty(t, obj.ACLUserList, "user ACLs should be empty when disabled")
|
|
require.Empty(t, obj.ACLGroupList, "group ACLs should be empty when disabled")
|
|
})
|
|
|
|
t.Run("ACLsIncludedWhenEnabled", func(t *testing.T) {
|
|
rbac.SetChatACLDisabled(false)
|
|
|
|
obj := chat.RBACObject()
|
|
|
|
require.NotEmpty(t, obj.ACLUserList, "user ACLs should be present when enabled")
|
|
require.NotEmpty(t, obj.ACLGroupList, "group ACLs should be present when enabled")
|
|
require.Contains(t, obj.ACLUserList, uid)
|
|
require.Contains(t, obj.ACLGroupList, gid)
|
|
})
|
|
}
|
|
|
|
//nolint:tparallel,paralleltest
|
|
func TestWorkspaceACLDisabled(t *testing.T) {
|
|
uid := uuid.NewString()
|
|
gid := uuid.NewString()
|
|
|
|
ws := WorkspaceTable{
|
|
ID: uuid.New(),
|
|
OrganizationID: uuid.New(),
|
|
OwnerID: uuid.New(),
|
|
UserACL: WorkspaceACL{
|
|
uid: WorkspaceACLEntry{Permissions: []policy.Action{policy.ActionSSH}},
|
|
},
|
|
GroupACL: WorkspaceACL{
|
|
gid: WorkspaceACLEntry{Permissions: []policy.Action{policy.ActionSSH}},
|
|
},
|
|
}
|
|
|
|
t.Run("ACLsOmittedWhenDisabled", func(t *testing.T) {
|
|
rbac.SetWorkspaceACLDisabled(true)
|
|
t.Cleanup(func() { rbac.SetWorkspaceACLDisabled(false) })
|
|
|
|
obj := ws.RBACObject()
|
|
|
|
require.Empty(t, obj.ACLUserList, "user ACLs should be empty when disabled")
|
|
require.Empty(t, obj.ACLGroupList, "group ACLs should be empty when disabled")
|
|
})
|
|
|
|
t.Run("ACLsIncludedWhenEnabled", func(t *testing.T) {
|
|
rbac.SetWorkspaceACLDisabled(false)
|
|
|
|
obj := ws.RBACObject()
|
|
|
|
require.NotEmpty(t, obj.ACLUserList, "user ACLs should be present when enabled")
|
|
require.NotEmpty(t, obj.ACLGroupList, "group ACLs should be present when enabled")
|
|
require.Contains(t, obj.ACLUserList, uid)
|
|
require.Contains(t, obj.ACLGroupList, gid)
|
|
})
|
|
}
|
|
|
|
// TestOAuth2ProviderAppIsPublic pins IsPublic's contract directly, since it is
|
|
// what decides whether the token endpoint validates a client secret at all.
|
|
// Only the exact string "public" may read as public: anything else, including
|
|
// an unset column or a differently-cased value, must read as confidential so
|
|
// that a garbled value cannot silently skip client authentication.
|
|
func TestOAuth2ProviderAppIsPublic(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
tests := []struct {
|
|
name string
|
|
clientType string
|
|
want bool
|
|
}{
|
|
{name: "Public", clientType: "public", want: true},
|
|
{name: "Confidential", clientType: "confidential", want: false},
|
|
{name: "Empty", clientType: "", want: false},
|
|
{name: "MixedCasePublic", clientType: "Public", want: false},
|
|
{name: "AllCapsPublic", clientType: "PUBLIC", want: false},
|
|
{name: "LeadingSpace", clientType: " public", want: false},
|
|
{name: "TrailingSpace", clientType: "public ", want: false},
|
|
{name: "Bogus", clientType: "bogus", want: false},
|
|
}
|
|
|
|
for _, tt := range tests {
|
|
t.Run(tt.name, func(t *testing.T) {
|
|
t.Parallel()
|
|
app := OAuth2ProviderApp{ClientType: tt.clientType}
|
|
require.Equal(t, tt.want, app.IsPublic())
|
|
})
|
|
}
|
|
}
|
|
|
|
// Helpers
|
|
func requirePermission(t *testing.T, s rbac.Scope, resource string, action policy.Action) {
|
|
t.Helper()
|
|
for _, p := range s.Site {
|
|
if p.ResourceType == resource && p.Action == action {
|
|
return
|
|
}
|
|
}
|
|
t.Fatalf("permission not found: %s:%s", resource, action)
|
|
}
|
|
|
|
func requireAllowAll(t *testing.T, s rbac.Scope) {
|
|
t.Helper()
|
|
require.Len(t, s.AllowIDList, 1)
|
|
require.Equal(t, policy.WildcardSymbol, s.AllowIDList[0].ID)
|
|
require.Equal(t, policy.WildcardSymbol, s.AllowIDList[0].Type)
|
|
}
|
|
|
|
func TestSkillRBACObjectProjectRowsDenied(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
orgID := uuid.New()
|
|
skill := Skill{ID: uuid.New(), ProjectID: uuid.NullUUID{UUID: uuid.New(), Valid: true}}
|
|
authz := rbac.NewAuthorizer(prometheus.NewRegistry())
|
|
for name, roles := range map[string]rbac.RoleIdentifiers{
|
|
"SiteOwner": {rbac.RoleOwner(), rbac.RoleMember()},
|
|
"OrgAdmin": {rbac.RoleMember(), rbac.ScopedRoleOrgAdmin(orgID)},
|
|
"Member": {rbac.RoleMember(), rbac.ScopedRoleAgentsAccess(orgID)},
|
|
} {
|
|
subject := rbac.Subject{ID: uuid.NewString(), Roles: roles, Scope: rbac.ScopeAll}
|
|
for _, action := range []policy.Action{policy.ActionRead, policy.ActionUpdate, policy.ActionDelete} {
|
|
err := authz.Authorize(context.Background(), subject, action, skill.RBACObject())
|
|
require.Error(t, err, "%s %s", name, action)
|
|
}
|
|
}
|
|
}
|
|
|
|
func TestSkillRBACObjectOrganizationACL(t *testing.T) {
|
|
t.Parallel()
|
|
|
|
orgID, groupID, userID := uuid.New(), uuid.New(), uuid.New()
|
|
read := ChatACLEntry{Permissions: []policy.Action{policy.ActionRead}}
|
|
authz := rbac.NewAuthorizer(prometheus.NewRegistry())
|
|
for name, tc := range map[string]struct {
|
|
skill Skill
|
|
groups []string
|
|
}{
|
|
"UserGrant": {skill: Skill{UserACL: ChatACL{userID.String(): read}}},
|
|
"GroupGrant": {skill: Skill{GroupACL: ChatACL{groupID.String(): read}}, groups: []string{groupID.String()}},
|
|
} {
|
|
tc.skill.ID = uuid.New()
|
|
tc.skill.OrganizationID = uuid.NullUUID{UUID: orgID, Valid: true}
|
|
subject := rbac.Subject{
|
|
ID: userID.String(),
|
|
Roles: rbac.RoleIdentifiers{rbac.RoleMember(), rbac.ScopedRoleAgentsAccess(orgID)},
|
|
Groups: tc.groups,
|
|
Scope: rbac.ScopeAll,
|
|
}
|
|
require.NoError(t, authz.Authorize(context.Background(), subject, policy.ActionRead, tc.skill.RBACObject()), name)
|
|
require.Error(t, authz.Authorize(context.Background(), subject, policy.ActionUpdate, tc.skill.RBACObject()), name)
|
|
}
|
|
}
|