Skip to content

feat: add additional patch routes for group and role idp sync #16351

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 7 commits into from
Jan 31, 2025
Merged

feat: add additional patch routes for group and role idp sync #16351

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
17ac733
group sync patching
aslilac Jan 30, 2025
0456644
role sync patching + codersdk
aslilac Jan 30, 2025
dee715c
⚗️
aslilac Jan 31, 2025
c48d416
⚗️
aslilac Jan 31, 2025
da10007
⚗️ x3
aslilac Jan 31, 2025
c765b66
add tests for group setting patching
aslilac Jan 31, 2025
771a1f4
add tests
aslilac Jan 31, 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
add tests for group setting patching
  • Loading branch information
@aslilac
aslilac committed Jan 31, 2025
commit c765b66a4f85bfc915f6b86a8a65fbac09eba215
117 changes: 117 additions & 0 deletions enterprise/coderd/idpsync_internal_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
package coderd

import (
"testing"

"github.com/google/uuid"
"github.com/stretchr/testify/require"

"github.com/coder/coder/v2/codersdk"
)

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

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

id := []uuid.UUID{
uuid.MustParse("00000000-b8bd-46bb-bb6c-6c2b2c0dd2ea"),
uuid.MustParse("01000000-fbe8-464c-9429-fe01a03f3644"),
uuid.MustParse("02000000-0926-407b-9998-39af62e3d0c5"),
uuid.MustParse("03000000-92f6-4bfd-bba6-0f54667b131c"),
}

mapping := applyIDPSyncMappingDiff(map[string][]uuid.UUID{},
[]codersdk.IDPSyncMapping[uuid.UUID]{
{Given: "wibble", Gets: id[0]},
{Given: "wibble", Gets: id[1]},
{Given: "wobble", Gets: id[0]},
{Given: "wobble", Gets: id[1]},
{Given: "wobble", Gets: id[2]},
{Given: "wobble", Gets: id[3]},
{Given: "wooble", Gets: id[0]},
},
// Remove takes priority over Add, so `3` should not actually be added.
[]codersdk.IDPSyncMapping[uuid.UUID]{
{Given: "wobble", Gets: id[3]},
},
)

expected := map[string][]uuid.UUID{
"wibble": {id[0], id[1]},
"wobble": {id[0], id[1], id[2]},
"wooble": {id[0]},
}

require.Equal(t, expected, mapping)

mapping = applyIDPSyncMappingDiff(mapping,
[]codersdk.IDPSyncMapping[uuid.UUID]{
{Given: "wibble", Gets: id[2]},
{Given: "wobble", Gets: id[3]},
{Given: "wooble", Gets: id[0]},
},
[]codersdk.IDPSyncMapping[uuid.UUID]{
{Given: "wibble", Gets: id[0]},
{Given: "wobble", Gets: id[1]},
},
)

expected = map[string][]uuid.UUID{
"wibble": {id[1], id[2]},
"wobble": {id[0], id[2], id[3]},
"wooble": {id[0]},
}

require.Equal(t, expected, mapping)
})

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

mapping := applyIDPSyncMappingDiff(map[string][]string{},
[]codersdk.IDPSyncMapping[string]{
{Given: "wibble", Gets: "group-00"},
{Given: "wibble", Gets: "group-01"},
{Given: "wobble", Gets: "group-00"},
{Given: "wobble", Gets: "group-01"},
{Given: "wobble", Gets: "group-02"},
{Given: "wobble", Gets: "group-03"},
{Given: "wooble", Gets: "group-00"},
},
// Remove takes priority over Add, so `3` should not actually be added.
[]codersdk.IDPSyncMapping[string]{
{Given: "wobble", Gets: "group-03"},
},
)

expected := map[string][]string{
"wibble": {"group-00", "group-01"},
"wobble": {"group-00", "group-01", "group-02"},
"wooble": {"group-00"},
}

require.Equal(t, expected, mapping)

mapping = applyIDPSyncMappingDiff(mapping,
[]codersdk.IDPSyncMapping[string]{
{Given: "wibble", Gets: "group-02"},
{Given: "wobble", Gets: "group-03"},
{Given: "wooble", Gets: "group-00"},
},
[]codersdk.IDPSyncMapping[string]{
{Given: "wibble", Gets: "group-00"},
{Given: "wobble", Gets: "group-01"},
},
)

expected = map[string][]string{
"wibble": {"group-01", "group-02"},
"wobble": {"group-00", "group-02", "group-03"},
"wooble": {"group-00"},
}

require.Equal(t, expected, mapping)
})
}
208 changes: 168 additions & 40 deletions enterprise/coderd/idpsync_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,171 @@ func TestPatchGroupSyncSettings(t *testing.T) {
})
}

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

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

owner, user := coderdenttest.New(t, &coderdenttest.Options{
LicenseOptions: &coderdenttest.LicenseOptions{
Features: license.Features{
codersdk.FeatureCustomRoles: 1,
codersdk.FeatureMultipleOrganizations: 1,
},
},
})

orgID := user.OrganizationID
orgAdmin, _ := coderdtest.CreateAnotherUser(t, owner, orgID, rbac.ScopedRoleOrgAdmin(user.OrganizationID))

mapping := map[string][]uuid.UUID{"wibble": {uuid.New()}}

ctx := testutil.Context(t, testutil.WaitShort)
_, err := orgAdmin.PatchGroupIDPSyncSettings(ctx, orgID.String(), codersdk.GroupSyncSettings{
Field: "wibble",
RegexFilter: regexp.MustCompile("wib{2,}le"),
AutoCreateMissing: false,
Mapping: mapping,
})

require.NoError(t, err)

fetchedSettings, err := orgAdmin.GroupIDPSyncSettings(ctx, orgID.String())
require.NoError(t, err)
require.Equal(t, "wibble", fetchedSettings.Field)
require.Equal(t, "wib{2,}le", fetchedSettings.RegexFilter.String())
require.Equal(t, false, fetchedSettings.AutoCreateMissing)
require.Equal(t, mapping, fetchedSettings.Mapping)

ctx = testutil.Context(t, testutil.WaitShort)
settings, err := orgAdmin.PatchGroupIDPSyncConfig(ctx, orgID.String(), codersdk.PatchGroupIDPSyncConfigRequest{
Field: "wobble",
RegexFilter: regexp.MustCompile("wob{2,}le"),
AutoCreateMissing: true,
})

require.NoError(t, err)
require.Equal(t, "wobble", settings.Field)
require.Equal(t, "wob{2,}le", settings.RegexFilter.String())
require.Equal(t, true, settings.AutoCreateMissing)
require.Equal(t, mapping, settings.Mapping)

fetchedSettings, err = orgAdmin.GroupIDPSyncSettings(ctx, orgID.String())
require.NoError(t, err)
require.Equal(t, "wobble", fetchedSettings.Field)
require.Equal(t, "wob{2,}le", fetchedSettings.RegexFilter.String())
require.Equal(t, true, fetchedSettings.AutoCreateMissing)
require.Equal(t, mapping, fetchedSettings.Mapping)
})

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

owner, user := coderdenttest.New(t, &coderdenttest.Options{
LicenseOptions: &coderdenttest.LicenseOptions{
Features: license.Features{
codersdk.FeatureCustomRoles: 1,
codersdk.FeatureMultipleOrganizations: 1,
},
},
})

member, _ := coderdtest.CreateAnotherUser(t, owner, user.OrganizationID)

ctx := testutil.Context(t, testutil.WaitShort)
_, err := member.PatchGroupIDPSyncConfig(ctx, user.OrganizationID.String(), codersdk.PatchGroupIDPSyncConfigRequest{})
var apiError *codersdk.Error
require.ErrorAs(t, err, &apiError)
require.Equal(t, http.StatusForbidden, apiError.StatusCode())
})
}

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

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

owner, user := coderdenttest.New(t, &coderdenttest.Options{
LicenseOptions: &coderdenttest.LicenseOptions{
Features: license.Features{
codersdk.FeatureCustomRoles: 1,
codersdk.FeatureMultipleOrganizations: 1,
},
},
})

orgID := user.OrganizationID
orgAdmin, _ := coderdtest.CreateAnotherUser(t, owner, orgID, rbac.ScopedRoleOrgAdmin(user.OrganizationID))
// These IDs are easier to visually diff if the test fails than truly random
// ones.
orgs := []uuid.UUID{
uuid.MustParse("00000000-b8bd-46bb-bb6c-6c2b2c0dd2ea"),
uuid.MustParse("01000000-fbe8-464c-9429-fe01a03f3644"),
uuid.MustParse("02000000-0926-407b-9998-39af62e3d0c5"),
}

ctx := testutil.Context(t, testutil.WaitShort)
_, err := orgAdmin.PatchGroupIDPSyncSettings(ctx, orgID.String(), codersdk.GroupSyncSettings{
Field: "wibble",
RegexFilter: regexp.MustCompile("wib{2,}le"),
AutoCreateMissing: true,
Mapping: map[string][]uuid.UUID{"wobble": {orgs[0]}},
})
require.NoError(t, err)

ctx = testutil.Context(t, testutil.WaitShort)
settings, err := orgAdmin.PatchGroupIDPSyncMapping(ctx, orgID.String(), codersdk.PatchGroupIDPSyncMappingRequest{
Add: []codersdk.IDPSyncMapping[uuid.UUID]{
{Given: "wibble", Gets: orgs[0]},
{Given: "wobble", Gets: orgs[1]},
{Given: "wobble", Gets: orgs[2]},
},
// Remove takes priority over Add, so "3" should not actually be added to wooble.
Remove: []codersdk.IDPSyncMapping[uuid.UUID]{
{Given: "wobble", Gets: orgs[1]},
},
})

expected := map[string][]uuid.UUID{
"wibble": {orgs[0]},
"wobble": {orgs[0], orgs[2]},
}

require.NoError(t, err)
require.Equal(t, expected, settings.Mapping)

fetchedSettings, err := orgAdmin.GroupIDPSyncSettings(ctx, orgID.String())
require.NoError(t, err)
require.Equal(t, "wibble", fetchedSettings.Field)
require.Equal(t, "wib{2,}le", fetchedSettings.RegexFilter.String())
require.Equal(t, true, fetchedSettings.AutoCreateMissing)
require.Equal(t, expected, fetchedSettings.Mapping)
})

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

owner, user := coderdenttest.New(t, &coderdenttest.Options{
LicenseOptions: &coderdenttest.LicenseOptions{
Features: license.Features{
codersdk.FeatureCustomRoles: 1,
codersdk.FeatureMultipleOrganizations: 1,
},
},
})

member, _ := coderdtest.CreateAnotherUser(t, owner, user.OrganizationID)

ctx := testutil.Context(t, testutil.WaitShort)
_, err := member.PatchGroupIDPSyncMapping(ctx, user.OrganizationID.String(), codersdk.PatchGroupIDPSyncMappingRequest{})
var apiError *codersdk.Error
require.ErrorAs(t, err, &apiError)
require.Equal(t, http.StatusForbidden, apiError.StatusCode())
})
}

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

Expand Down Expand Up @@ -416,35 +581,25 @@ func TestPatchOrganizationSyncMapping(t *testing.T) {
uuid.MustParse("00000000-b8bd-46bb-bb6c-6c2b2c0dd2ea"),
uuid.MustParse("01000000-fbe8-464c-9429-fe01a03f3644"),
uuid.MustParse("02000000-0926-407b-9998-39af62e3d0c5"),
uuid.MustParse("03000000-92f6-4bfd-bba6-0f54667b131c"),
uuid.MustParse("04000000-b9d0-46fe-910f-6e2ea0c62caa"),
uuid.MustParse("05000000-67c0-4c19-a52d-0dc3f65abee0"),
uuid.MustParse("06000000-a8a8-4a2c-bdd0-b59aa6882b55"),
uuid.MustParse("07000000-5390-4cc7-a9c8-e4330a683ae7"),
}

ctx := testutil.Context(t, testutil.WaitShort)
//nolint:gocritic // Only owners can change Organization IdP sync settings
settings, err := owner.PatchOrganizationIDPSyncMapping(ctx, codersdk.PatchOrganizationIDPSyncMappingRequest{
Add: []codersdk.IDPSyncMapping[uuid.UUID]{
{Given: "wibble", Gets: orgs[0]},
{Given: "wibble", Gets: orgs[1]},
{Given: "wobble", Gets: orgs[0]},
{Given: "wobble", Gets: orgs[1]},
{Given: "wobble", Gets: orgs[2]},
{Given: "wobble", Gets: orgs[3]},
{Given: "wooble", Gets: orgs[0]},
},
// Remove takes priority over Add, so "3" should not actually be added to wooble.
Remove: []codersdk.IDPSyncMapping[uuid.UUID]{
{Given: "wobble", Gets: orgs[3]},
{Given: "wobble", Gets: orgs[1]},
},
})

expected := map[string][]uuid.UUID{
"wibble": {orgs[0], orgs[1]},
"wobble": {orgs[0], orgs[1], orgs[2]},
"wooble": {orgs[0]},
"wibble": {orgs[0]},
"wobble": {orgs[0], orgs[2]},
}

require.NoError(t, err)
Expand All @@ -453,33 +608,6 @@ func TestPatchOrganizationSyncMapping(t *testing.T) {
fetchedSettings, err := owner.OrganizationIDPSyncSettings(ctx)
require.NoError(t, err)
require.Equal(t, expected, fetchedSettings.Mapping)

ctx = testutil.Context(t, testutil.WaitShort)
settings, err = owner.PatchOrganizationIDPSyncMapping(ctx, codersdk.PatchOrganizationIDPSyncMappingRequest{
Add: []codersdk.IDPSyncMapping[uuid.UUID]{
{Given: "wibble", Gets: orgs[2]},
{Given: "wobble", Gets: orgs[3]},
{Given: "wooble", Gets: orgs[0]},
},
// Remove takes priority over Add, so `f` should not actually be added.
Remove: []codersdk.IDPSyncMapping[uuid.UUID]{
{Given: "wibble", Gets: orgs[0]},
{Given: "wobble", Gets: orgs[1]},
},
})

expected = map[string][]uuid.UUID{
"wibble": {orgs[1], orgs[2]},
"wobble": {orgs[0], orgs[2], orgs[3]},
"wooble": {orgs[0]},
}

require.NoError(t, err)
require.Equal(t, expected, settings.Mapping)

fetchedSettings, err = owner.OrganizationIDPSyncSettings(ctx)
require.NoError(t, err)
require.Equal(t, expected, fetchedSettings.Mapping)
})

t.Run("NotAuthorized", func(t *testing.T) {
Expand Down