Skip to content

Commit

Permalink
feat: add optional property to coder_external_auth (#185)
Browse files Browse the repository at this point in the history
  • Loading branch information
aslilac authored Feb 12, 2024
1 parent 1797a03 commit 99ba884
Show file tree
Hide file tree
Showing 3 changed files with 44 additions and 1 deletion.
4 changes: 4 additions & 0 deletions docs/data-sources/external_auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) Authenticating with the external auth provider is not required, and can be skipped by users when creating or updating workspaces

### Read-Only

- `access_token` (String) The access token returned by the external auth provider. This can be used to pre-authenticate command-line tools.
7 changes: 6 additions & 1 deletion provider/externalauth.go
Original file line number Diff line number Diff line change
Expand Up @@ -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: "Authenticating with the external auth provider is not required, and can be skipped by users when creating or updating workspaces",
Optional: true,
},
},
}
Expand Down
34 changes: 34 additions & 0 deletions provider/externalauth_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
},
Expand Down

0 comments on commit 99ba884

Please sign in to comment.