Add login_type to coder_workspace_owner data source #235 (#287)

pmareke · johnstcn · web-flow · commit 2598aa7c653b · 2024-09-11T14:04:22.000+01:00
* feat: add login_type to coder_workspace_owner data source

* feat: remove types check

* feat: update integration test

* feat: run linter

* feat: set empty string as the default value for the login type

* feat: update integration test

* feat: add a warning when the CODER_WORKSPACE_OWNER_LOGIN_TYPE is not set

* feat: create a new diags variable

* feat: add missing comma

* feat: add missing parenthesis

* feat: fix typo in summary field

Co-authored-by: Cian Johnston &lt;public@cianjohnston.ie&gt;

---------

Co-authored-by: Cian Johnston &lt;public@cianjohnston.ie&gt;
diff --git a/docs/data-sources/workspace_owner.md b/docs/data-sources/workspace_owner.md
@@ -50,6 +50,7 @@ resource "coder_env" "git_author_email" {
 - `full_name` (String) The full name of the user.
 - `groups` (List of String) The groups of which the user is a member.
 - `id` (String) The UUID of the workspace owner.
+- `login_type` (String) The type of login the user has.
 - `name` (String) The username of the user.
 - `oidc_access_token` (String) A valid OpenID Connect access token of the workspace owner. This is only available if the workspace owner authenticated with OpenID Connect. If a valid token cannot be obtained, this value will be an empty string.
 - `session_token` (String) Session token for authenticating with a Coder deployment. It is regenerated every time a workspace is started.
diff --git a/integration/integration_test.go b/integration/integration_test.go
@@ -112,6 +112,7 @@ func TestIntegration(t *testing.T) {
 				"workspace_owner.session_token":     `.+`,
 				"workspace_owner.ssh_private_key":   `(?s)^.+?BEGIN OPENSSH PRIVATE KEY.+?END OPENSSH PRIVATE KEY.+?$`,
 				"workspace_owner.ssh_public_key":    `(?s)^ssh-ed25519.+$`,
+				"workspace_owner.login_type":        ``,
 			},
 		},
 		{
diff --git a/integration/workspace-owner/main.tf b/integration/workspace-owner/main.tf
@@ -39,6 +39,7 @@ locals {
     "workspace_owner.session_token" : data.coder_workspace_owner.me.session_token,
     "workspace_owner.ssh_private_key" : data.coder_workspace_owner.me.ssh_private_key,
     "workspace_owner.ssh_public_key" : data.coder_workspace_owner.me.ssh_public_key,
+    "workspace_owner.login_type" : data.coder_workspace_owner.me.login_type,
   }
 }
 
diff --git a/provider/workspace_owner.go b/provider/workspace_owner.go
@@ -15,6 +15,8 @@ func workspaceOwnerDataSource() *schema.Resource {
 	return &schema.Resource{
 		Description: "Use this data source to fetch information about the workspace owner.",
 		ReadContext: func(ctx context.Context, rd *schema.ResourceData, i interface{}) diag.Diagnostics {
+			diags := diag.Diagnostics{}
+
 			if idStr := os.Getenv("CODER_WORKSPACE_OWNER_ID"); idStr != "" {
 				rd.SetId(idStr)
 			} else {
@@ -53,7 +55,15 @@ func workspaceOwnerDataSource() *schema.Resource {
 			_ = rd.Set("session_token", os.Getenv("CODER_WORKSPACE_OWNER_SESSION_TOKEN"))
 			_ = rd.Set("oidc_access_token", os.Getenv("CODER_WORKSPACE_OWNER_OIDC_ACCESS_TOKEN"))
 
-			return nil
+			if os.Getenv("CODER_WORKSPACE_OWNER_LOGIN_TYPE") == "" {
+				diags = append(diags, diag.Diagnostic{
+					Severity: diag.Warning,
+					Summary: "WARNING: The CODER_WORKSPACE_OWNER_LOGIN_TYPE env variable is not set",
+				})
+			}
+			_ = rd.Set("login_type", os.Getenv("CODER_WORKSPACE_OWNER_LOGIN_TYPE"))
+
+			return diags
 		},
 		Schema: map[string]*schema.Schema{
 			"id": {
@@ -107,6 +117,11 @@ func workspaceOwnerDataSource() *schema.Resource {
 					"This is only available if the workspace owner authenticated with OpenID Connect. " +
 					"If a valid token cannot be obtained, this value will be an empty string.",
 			},
+			"login_type": {
+				Type:        schema.TypeString,
+				Computed:    true,
+				Description: "The type of login the user has.",
+			},
 		},
 	}
 }
diff --git a/provider/workspace_owner_test.go b/provider/workspace_owner_test.go
@@ -35,6 +35,7 @@ func TestWorkspaceOwnerDatasource(t *testing.T) {
 		t.Setenv("CODER_WORKSPACE_OWNER_GROUPS", `["group1", "group2"]`)
 		t.Setenv("CODER_WORKSPACE_OWNER_SESSION_TOKEN", `supersecret`)
 		t.Setenv("CODER_WORKSPACE_OWNER_OIDC_ACCESS_TOKEN", `alsosupersecret`)
+		t.Setenv("CODER_WORKSPACE_OWNER_LOGIN_TYPE", `github`)
 
 		resource.Test(t, resource.TestCase{
 			Providers: map[string]*schema.Provider{
@@ -63,6 +64,8 @@ func TestWorkspaceOwnerDatasource(t *testing.T) {
 					assert.Equal(t, `group2`, attrs["groups.1"])
 					assert.Equal(t, `supersecret`, attrs["session_token"])
 					assert.Equal(t, `alsosupersecret`, attrs["oidc_access_token"])
+					assert.Equal(t, `github`, attrs["login_type"])
+
 					return nil
 				},
 			}},
@@ -80,6 +83,7 @@ func TestWorkspaceOwnerDatasource(t *testing.T) {
 			"CODER_WORKSPACE_OWNER_OIDC_ACCESS_TOKEN",
 			"CODER_WORKSPACE_OWNER_SSH_PUBLIC_KEY",
 			"CODER_WORKSPACE_OWNER_SSH_PRIVATE_KEY",
+			"CODER_WORKSPACE_OWNER_LOGIN_TYPE",
 		} { // https://github.com/golang/go/issues/52817
 			t.Setenv(v, "")
 			os.Unsetenv(v)
@@ -111,6 +115,7 @@ func TestWorkspaceOwnerDatasource(t *testing.T) {
 					assert.Empty(t, attrs["groups.0"])
 					assert.Empty(t, attrs["session_token"])
 					assert.Empty(t, attrs["oidc_access_token"])
+					assert.Empty(t, attrs["login_type"])
 					return nil
 				},
 			}},

Original file line number	Diff line number	Diff line change
`@@ -112,6 +112,7 @@ func TestIntegration(t *testing.T) {`
`112`	`112`	"workspace_owner.session_token": `.+`,
`113`	`113`	"workspace_owner.ssh_private_key": `(?s)^.+?BEGIN OPENSSH PRIVATE KEY.+?END OPENSSH PRIVATE KEY.+?$`,
`114`	`114`	"workspace_owner.ssh_public_key": `(?s)^ssh-ed25519.+$`,
	`115`	+ "workspace_owner.login_type": ``,
`115`	`116`	`},`
`116`	`117`	`},`
`117`	`118`	`{`
Original file line number	Diff line number	Diff line change
`@@ -39,6 +39,7 @@ locals {`
`39`	`39`	`"workspace_owner.session_token" : data.coder_workspace_owner.me.session_token,`
`40`	`40`	`"workspace_owner.ssh_private_key" : data.coder_workspace_owner.me.ssh_private_key,`
`41`	`41`	`"workspace_owner.ssh_public_key" : data.coder_workspace_owner.me.ssh_public_key,`
	`42`	`+ "workspace_owner.login_type" : data.coder_workspace_owner.me.login_type,`
`42`	`43`	`}`
`43`	`44`	`}`
`44`	`45`