From a5cc8a172a34921c98cafe1a0c56458bb8d0033b Mon Sep 17 00:00:00 2001 From: McKayla Washburn Date: Tue, 30 Jan 2024 15:27:43 -0700 Subject: [PATCH 1/4] feat: add `optional` property to `coder_external_auth` --- provider/externalauth.go | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/provider/externalauth.go b/provider/externalauth.go index 89ab5ecc..d1485ade 100644 --- a/provider/externalauth.go +++ b/provider/externalauth.go @@ -32,8 +32,13 @@ func externalAuthDataSource() *schema.Resource { }, "access_token": { Type: schema.TypeString, - Computed: true, Description: "The access token returned by the external auth provider. This can be used to pre-authenticate command-line tools.", + Computed: true, + }, + "optional": { + Type: schema.TypeBool, + Description: "Connecting to the external auth provider is not required, and can be skipped by users.", + Optional: true, }, }, } From 7002472eacff3ac96c88b26ac520f64ae5601417 Mon Sep 17 00:00:00 2001 From: McKayla Washburn Date: Tue, 30 Jan 2024 15:30:52 -0700 Subject: [PATCH 2/4] update generated documentation for `coder_external_auth` Adds documentation for the `optional` property --- docs/data-sources/external_auth.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/data-sources/external_auth.md b/docs/data-sources/external_auth.md index b875b874..338a37df 100644 --- a/docs/data-sources/external_auth.md +++ b/docs/data-sources/external_auth.md @@ -19,6 +19,10 @@ Use this data source to require users to authenticate with an external service p - `id` (String) The ID of a configured external auth provider set up in your Coder deployment. +### Optional + +- `optional` (Boolean) Connecting to the external auth provider is not required, and can be skipped by users. + ### Read-Only - `access_token` (String) The access token returned by the external auth provider. This can be used to pre-authenticate command-line tools. From 7b6606aee25ef21a050f76cd53697fd2d34fb891 Mon Sep 17 00:00:00 2001 From: McKayla Washburn Date: Mon, 5 Feb 2024 13:33:55 -0700 Subject: [PATCH 3/4] tests --- provider/externalauth_test.go | 34 ++++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) diff --git a/provider/externalauth_test.go b/provider/externalauth_test.go index a320684b..826f0a91 100644 --- a/provider/externalauth_test.go +++ b/provider/externalauth_test.go @@ -36,6 +36,40 @@ func TestExternalAuth(t *testing.T) { attribs := resource.Primary.Attributes require.Equal(t, "github", attribs["id"]) + require.Equal(t, "", attribs["optional"]) + + return nil + }, + }}, + }) +} + +func TestOptionalExternalAuth(t *testing.T) { + t.Parallel() + + resource.Test(t, resource.TestCase{ + Providers: map[string]*schema.Provider{ + "coder": provider.New(), + }, + IsUnitTest: true, + Steps: []resource.TestStep{{ + Config: ` + provider "coder" { + } + data "coder_external_auth" "github" { + id = "github" + optional = true + } + `, + Check: func(state *terraform.State) error { + require.Len(t, state.Modules, 1) + require.Len(t, state.Modules[0].Resources, 1) + resource := state.Modules[0].Resources["data.coder_external_auth.github"] + require.NotNil(t, resource) + + attribs := resource.Primary.Attributes + require.Equal(t, "github", attribs["id"]) + require.Equal(t, "true", attribs["optional"]) return nil }, From fc047fd7f9fb8105323e95745326b96970f761eb Mon Sep 17 00:00:00 2001 From: McKayla Washburn Date: Mon, 5 Feb 2024 16:24:39 -0700 Subject: [PATCH 4/4] tweak docs --- docs/data-sources/external_auth.md | 2 +- provider/externalauth.go | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/data-sources/external_auth.md b/docs/data-sources/external_auth.md index 338a37df..af4df43b 100644 --- a/docs/data-sources/external_auth.md +++ b/docs/data-sources/external_auth.md @@ -21,7 +21,7 @@ Use this data source to require users to authenticate with an external service p ### Optional -- `optional` (Boolean) Connecting to the external auth provider is not required, and can be skipped by users. +- `optional` (Boolean) Authenticating with the external auth provider is not required, and can be skipped by users when creating or updating workspaces ### Read-Only diff --git a/provider/externalauth.go b/provider/externalauth.go index d1485ade..31dadd66 100644 --- a/provider/externalauth.go +++ b/provider/externalauth.go @@ -37,7 +37,7 @@ func externalAuthDataSource() *schema.Resource { }, "optional": { Type: schema.TypeBool, - Description: "Connecting to the external auth provider is not required, and can be skipped by users.", + Description: "Authenticating with the external auth provider is not required, and can be skipped by users when creating or updating workspaces", Optional: true, }, },