Add SSOTeamID to Team structs #364

xlgmokha · 2022-03-18T21:52:53Z

Description

The teams API is being updated to include a new attribute called
sso-team-id to allow SSO enabled organizations to use unique identifiers from
external systems to control team membership.

Output from tests (HashiCorp employees only)

モ ENABLE_BETA=1 TFE_ADDRESS=https://... TF_ACC=1 go test -v ./... -tags=integration -run TestTeams
=== RUN   TestTeamsList
=== RUN   TestTeamsList/without_list_options
    team_integration_test.go:37: paging not supported yet in API
=== RUN   TestTeamsList/with_list_options
    team_integration_test.go:43: paging not supported yet in API
=== RUN   TestTeamsList/without_a_valid_organization
--- PASS: TestTeamsList (2.35s)
    --- SKIP: TestTeamsList/without_list_options (0.30s)
    --- SKIP: TestTeamsList/with_list_options (0.00s)
    --- PASS: TestTeamsList/without_a_valid_organization (0.00s)
=== RUN   TestTeamsCreate
=== RUN   TestTeamsCreate/with_valid_options
=== RUN   TestTeamsCreate/with_sso-team-id
=== RUN   TestTeamsCreate/when_options_is_missing_name
=== RUN   TestTeamsCreate/when_options_has_an_invalid_organization
--- PASS: TestTeamsCreate (1.47s)
    --- PASS: TestTeamsCreate/with_valid_options (0.40s)
    --- PASS: TestTeamsCreate/with_sso-team-id (0.21s)
    --- PASS: TestTeamsCreate/when_options_is_missing_name (0.00s)
    --- PASS: TestTeamsCreate/when_options_has_an_invalid_organization (0.00s)
=== RUN   TestTeamsRead
=== RUN   TestTeamsRead/when_the_team_exists
=== RUN   TestTeamsRead/when_the_team_exists/visibility_is_returned
=== RUN   TestTeamsRead/when_the_team_exists/permissions_are_properly_decoded
=== RUN   TestTeamsRead/when_the_team_exists/organization_access_is_properly_decoded
=== RUN   TestTeamsRead/when_the_team_exists/SSO_team_id_is_returned
=== RUN   TestTeamsRead/when_the_team_does_not_exist
=== RUN   TestTeamsRead/without_a_valid_team_ID
--- PASS: TestTeamsRead (2.03s)
    --- PASS: TestTeamsRead/when_the_team_exists (0.19s)
        --- PASS: TestTeamsRead/when_the_team_exists/visibility_is_returned (0.00s)
        --- PASS: TestTeamsRead/when_the_team_exists/permissions_are_properly_decoded (0.00s)
        --- PASS: TestTeamsRead/when_the_team_exists/organization_access_is_properly_decoded (0.00s)
        --- PASS: TestTeamsRead/when_the_team_exists/SSO_team_id_is_returned (0.00s)
    --- PASS: TestTeamsRead/when_the_team_does_not_exist (0.16s)
    --- PASS: TestTeamsRead/without_a_valid_team_ID (0.00s)
=== RUN   TestTeamsUpdate
=== RUN   TestTeamsUpdate/with_valid_options
=== RUN   TestTeamsUpdate/when_the_team_does_not_exist
=== RUN   TestTeamsUpdate/without_a_valid_team_ID
--- PASS: TestTeamsUpdate (1.84s)
    --- PASS: TestTeamsUpdate/with_valid_options (0.39s)
    --- PASS: TestTeamsUpdate/when_the_team_does_not_exist (0.16s)
    --- PASS: TestTeamsUpdate/without_a_valid_team_ID (0.00s)
=== RUN   TestTeamsDelete
=== RUN   TestTeamsDelete/with_valid_options
=== RUN   TestTeamsDelete/without_valid_team_ID
--- PASS: TestTeamsDelete (1.39s)
    --- PASS: TestTeamsDelete/with_valid_options (0.35s)
    --- PASS: TestTeamsDelete/without_valid_team_ID (0.00s)
PASS
ok      github.com/hashicorp/go-tfe     9.080s
?       github.com/hashicorp/go-tfe/examples/organizations      [no test files]
?       github.com/hashicorp/go-tfe/examples/workspaces [no test files]
?       github.com/hashicorp/go-tfe/mocks       [no test files]

hashicorp-cla · 2022-03-18T21:52:56Z

All committers have signed the CLA.

xlgmokha · 2022-03-21T20:56:54Z

team.go

@@ -49,6 +49,7 @@ type Team struct {
 	Visibility         string              `jsonapi:"attr,visibility"`
 	Permissions        *TeamPermissions    `jsonapi:"attr,permissions"`
 	UserCount          int                 `jsonapi:"attr,users-count"`
+	SSOTeamID          *string             `jsonapi:"attr,sso-team-id"`


I chose *string instead of string because SSOTeamID can be nil.

Good choice!

team_integration_test.go

sebasslash

Changes look good! Some minor things mentioned below...

Another thing to note is to squash the test: commits for a cleaner commit history!

sebasslash · 2022-03-22T15:07:51Z

team.go

@@ -49,6 +49,7 @@ type Team struct {
 	Visibility         string              `jsonapi:"attr,visibility"`
 	Permissions        *TeamPermissions    `jsonapi:"attr,permissions"`
 	UserCount          int                 `jsonapi:"attr,users-count"`
+	SSOTeamID          *string             `jsonapi:"attr,sso-team-id"`


Good choice!

sebasslash · 2022-03-22T15:08:48Z

team.go

@@ -117,6 +121,9 @@ type TeamUpdateOptions struct {
 	// Optional: New name for the team
 	Name *string `jsonapi:"attr,name,omitempty"`

+	// Optional: Unique Identifier to control team membership via SAML
+	SSOTeamID *string `jsonapi:"attr,sso-team-id"`


If the field is optional add omitempty in the struct tag

xlgmokha · 2022-03-22T19:50:30Z

I squashed the commits and added omitempty where I think it's appropriate.

モ ENABLE_BETA=1 TFE_ADDRESS=https://... TF_ACC=1 go test -v ./... -tags=integration -run TestTeams
=== RUN   TestTeamsList
=== RUN   TestTeamsList/without_list_options
    team_integration_test.go:37: paging not supported yet in API
=== RUN   TestTeamsList/with_list_options
    team_integration_test.go:43: paging not supported yet in API
=== RUN   TestTeamsList/without_a_valid_organization
--- PASS: TestTeamsList (2.13s)
    --- SKIP: TestTeamsList/without_list_options (0.25s)
    --- SKIP: TestTeamsList/with_list_options (0.00s)
    --- PASS: TestTeamsList/without_a_valid_organization (0.00s)
=== RUN   TestTeamsCreate
=== RUN   TestTeamsCreate/with_valid_options
=== RUN   TestTeamsCreate/with_sso-team-id
=== RUN   TestTeamsCreate/when_options_is_missing_name
=== RUN   TestTeamsCreate/when_options_has_an_invalid_organization
--- PASS: TestTeamsCreate (1.48s)
    --- PASS: TestTeamsCreate/with_valid_options (0.40s)
    --- PASS: TestTeamsCreate/with_sso-team-id (0.23s)
    --- PASS: TestTeamsCreate/when_options_is_missing_name (0.00s)
    --- PASS: TestTeamsCreate/when_options_has_an_invalid_organization (0.00s)
=== RUN   TestTeamsRead
=== RUN   TestTeamsRead/when_the_team_exists
=== RUN   TestTeamsRead/when_the_team_exists/visibility_is_returned
=== RUN   TestTeamsRead/when_the_team_exists/permissions_are_properly_decoded
=== RUN   TestTeamsRead/when_the_team_exists/organization_access_is_properly_decoded
=== RUN   TestTeamsRead/when_the_team_exists/SSO_team_id_is_returned
=== RUN   TestTeamsRead/when_the_team_does_not_exist
=== RUN   TestTeamsRead/without_a_valid_team_ID
--- PASS: TestTeamsRead (1.96s)
    --- PASS: TestTeamsRead/when_the_team_exists (0.18s)
        --- PASS: TestTeamsRead/when_the_team_exists/visibility_is_returned (0.00s)
        --- PASS: TestTeamsRead/when_the_team_exists/permissions_are_properly_decoded (0.00s)
        --- PASS: TestTeamsRead/when_the_team_exists/organization_access_is_properly_decoded (0.00s)
        --- PASS: TestTeamsRead/when_the_team_exists/SSO_team_id_is_returned (0.00s)
    --- PASS: TestTeamsRead/when_the_team_does_not_exist (0.16s)
    --- PASS: TestTeamsRead/without_a_valid_team_ID (0.00s)
=== RUN   TestTeamsUpdate
=== RUN   TestTeamsUpdate/with_valid_options
=== RUN   TestTeamsUpdate/when_the_team_does_not_exist
=== RUN   TestTeamsUpdate/without_a_valid_team_ID
--- PASS: TestTeamsUpdate (1.72s)
    --- PASS: TestTeamsUpdate/with_valid_options (0.38s)
    --- PASS: TestTeamsUpdate/when_the_team_does_not_exist (0.18s)
    --- PASS: TestTeamsUpdate/without_a_valid_team_ID (0.00s)
=== RUN   TestTeamsDelete
=== RUN   TestTeamsDelete/with_valid_options
=== RUN   TestTeamsDelete/without_valid_team_ID
--- PASS: TestTeamsDelete (1.31s)
    --- PASS: TestTeamsDelete/with_valid_options (0.34s)
    --- PASS: TestTeamsDelete/without_valid_team_ID (0.00s)
PASS
ok      github.com/hashicorp/go-tfe     (cached)
?       github.com/hashicorp/go-tfe/examples/organizations      [no test files]
?       github.com/hashicorp/go-tfe/examples/workspaces [no test files]
?       github.com/hashicorp/go-tfe/mocks       [no test files]

sebasslash

We're not in Kansas anymore 🔥

xlgmokha · 2022-03-23T20:35:47Z

team_integration_test.go

@@ -321,7 +346,7 @@ func TestTeamCreateOptions_Marshal(t *testing.T) {
 	bodyBytes, err := req.BodyBytes()
 	require.NoError(t, err)

-	expectedBody := `{"data":{"type":"teams","attributes":{"name":"team name","organization-access":{"manage-policies":true},"visibility":"organization"}}}
+	expectedBody := `{"data":{"type":"teams","attributes":{"name":"team name","organization-access":{"manage-policies":true},"sso-team-id":null,"visibility":"organization"}}}


I think this change might cause failures when run from CI because the associated feature flag is disabled by default. Should I undo this change?

We can bring this back once we remove the feature flag and officially un-beta-fy this field!

~~You can use the skipIfBeta(t) helper for tests that require a feature sitting behind a feature flag! I think it still eludes me which feature flags are enabled for CI.~~ Disregard, you are using the helper. You could add it to this test, and to be honest I'm not sure why this test exists (since other tests already indirectly validate [un]marshaling)

radditude

This looks great to me! Though I will defer to a maintainer for final approval 😆

sebasslash

Not from a Jedi! 🔥 Good work

github-actions · 2022-03-24T18:21:22Z

Reminder to the contributor that merged this PR: if your changes have added important functionality or fixed a relevant bug, open a follow-up PR to update CHANGELOG.md with a note on your changes.

xlgmokha self-assigned this Mar 18, 2022

xlgmokha commented Mar 21, 2022

View reviewed changes

xlgmokha marked this pull request as ready for review March 21, 2022 21:00

xlgmokha changed the title ~~Add SSOTeamID to Team struct~~ Add SSOTeamID to Team structs Mar 21, 2022

sebasslash requested changes Mar 22, 2022

View reviewed changes

xlgmokha requested a review from sebasslash March 23, 2022 03:31

sebasslash previously approved these changes Mar 23, 2022

View reviewed changes

feat: add SSOTeamID to Team structs

7521ee2

xlgmokha commented Mar 23, 2022

View reviewed changes

xlgmokha dismissed sebasslash’s stale review via 7521ee2 March 23, 2022 22:15

radditude approved these changes Mar 24, 2022

View reviewed changes

sebasslash approved these changes Mar 24, 2022

View reviewed changes

xlgmokha merged commit c1df079 into hashicorp:main Mar 24, 2022

xlgmokha deleted the xlgmokha/team-sso-id branch March 24, 2022 18:21

This was referenced Mar 24, 2022

Start v1.1.0 CHANGELOG #366

Merged

Add docs for sso-team-id to the Teams API hashicorp/terraform-website#2210

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add SSOTeamID to Team structs #364

Add SSOTeamID to Team structs #364

xlgmokha commented Mar 18, 2022 •

edited

hashicorp-cla commented Mar 18, 2022 •

edited

xlgmokha Mar 21, 2022

sebasslash Mar 22, 2022

sebasslash left a comment

sebasslash Mar 22, 2022

sebasslash Mar 22, 2022

xlgmokha commented Mar 22, 2022

sebasslash left a comment

xlgmokha Mar 23, 2022

radditude Mar 24, 2022

sebasslash Mar 24, 2022 •

edited

radditude left a comment

sebasslash left a comment

github-actions bot commented Mar 24, 2022

Add SSOTeamID to Team structs #364

Add SSOTeamID to Team structs #364

Conversation

xlgmokha commented Mar 18, 2022 • edited

Description

Output from tests (HashiCorp employees only)

hashicorp-cla commented Mar 18, 2022 • edited

xlgmokha Mar 21, 2022

Choose a reason for hiding this comment

sebasslash Mar 22, 2022

Choose a reason for hiding this comment

sebasslash left a comment

Choose a reason for hiding this comment

sebasslash Mar 22, 2022

Choose a reason for hiding this comment

sebasslash Mar 22, 2022

Choose a reason for hiding this comment

xlgmokha commented Mar 22, 2022

sebasslash left a comment

Choose a reason for hiding this comment

xlgmokha Mar 23, 2022

Choose a reason for hiding this comment

radditude Mar 24, 2022

Choose a reason for hiding this comment

sebasslash Mar 24, 2022 • edited

Choose a reason for hiding this comment

radditude left a comment

Choose a reason for hiding this comment

sebasslash left a comment

Choose a reason for hiding this comment

github-actions bot commented Mar 24, 2022

xlgmokha commented Mar 18, 2022 •

edited

hashicorp-cla commented Mar 18, 2022 •

edited

sebasslash Mar 24, 2022 •

edited