add workspaces data source (v1beta1 list workspaces equivalent) #6

vandyliu · 2024-04-04T02:49:03Z

Description

Add the workspaces data source to the terraform provider
Make some repo structural changes: update README, move some files around, change some import names

Describe the purpose of this pull request.

🎟 Issue(s)

(https://github.com/astronomer/astro/issues/19655)

🧪 Functional Testing

main.tf file:

data "astronomer_workspaces" "list_workspaces" {
}

output "list_workspaces" {
  value = data.astronomer_workspaces.list_workspaces
}

output:

list_workspaces = {
  "names" = tolist(null) /* of string */
  "workspace_ids" = tolist(null) /* of string */
  "workspaces" = tolist([
    {
      "cicd_enforced_default" = false
      "created_at" = "2024-04-05 21:41:04.673 +0000 UTC"
      "created_by" = {
        "api_token_name" = "tf"
        "avatar_url" = tostring(null)
        "full_name" = tostring(null)
        "id" = "clthx7ect001l01i2bns855s2"
        "subject_type" = "SERVICEKEY"
        "username" = tostring(null)
      }
      "description" = "hi kushal"
      "id" = "clun6x735000701m5g5grj3sj"
      "name" = "tf-workspace-12"
      "organization_name" = "hosted123"
      "updated_at" = "2024-04-05 21:41:04.673 +0000 UTC"
      "updated_by" = {
        "api_token_name" = "tf"
        "avatar_url" = tostring(null)
        "full_name" = tostring(null)
        "id" = "clthx7ect001l01i2bns855s2"
        "subject_type" = "SERVICEKEY"
        "username" = tostring(null)
      }
    },
}]

List the functional testing steps to confirm this feature or fix.

📸 Screenshots

Add screenshots to illustrate the validity of these changes.

📋 Checklist

Rebased from the main (or release if patching) branch (before testing)
Ran make test before taking out of draft
Ran make fmt before taking out of draft
Added/updated applicable tests
Tested against Astro-API (if necessary).
Communicated to/tagged owners of respective clients potentially impacted by these changes.
Updated any related documentation

ichung08 · 2024-04-05T23:37:12Z

internal/provider/datasources/data_source_workspaces.go

+	if resp.Diagnostics.HasError() {
+		return
+	}


does this print the error msg out too?

yep, whatever is in resp.Diagnostics gets printed out at the end

sometimes, you'll see that i add my own error thats because the error didnt come from terraform but from somewhere else so terraform doesnt know an error occured, eg. if we called the api and there was an error, so in that case I add our own error to resp.Diagnostics

ichung08 · 2024-04-05T23:41:34Z

internal/provider/datasources/data_source_workspace.go

@@ -107,7 +107,11 @@ func (d *workspaceDataSource) Read(
 	}

 	// Populate the model with the response data
-	data.ReadFromResponse(ctx, workspace.JSON200)
+	diags := data.ReadFromResponse(ctx, workspace.JSON200)


what is workspace.JSON200? and why is it called JSON200 (is it supposed to represent a 200 resp code?)

notice this being referenced and used a lot

workspace is the response object from the API client, workspace.JSON200 gives us the platformv1beta1.Workspace object

we use a different client here than we do for the component tests, which is why there are these syntax differences

ichung08 · 2024-04-05T23:53:47Z

internal/provider/schemas/workspace.go

-		"id": datasource.StringAttribute{
+func WorkspaceDataSourceSchemaAttributes() map[string]datasourceSchema.Attribute {
+	return map[string]datasourceSchema.Attribute{
+		"id": datasourceSchema.StringAttribute{
 			MarkdownDescription: "Workspace identifier",


general q - with the MarkdownDescription for all the Schema Attributes, how does this actually look, like do you have an example? will this operate similar to doc strings in our models?

its in docs/data-sources/workspaces.md

.github/ISSUE_TEMPLATE/feature_request.md

Makefile

kushalmalani · 2024-04-08T05:41:50Z

README.md

@@ -35,6 +35,7 @@ Then commit the changes to `go.mod` and `go.sum`.
 ## Using the provider

 ```shell
+export ASTRI_API_TOKEN=<token>


Suggested change

export ASTRI_API_TOKEN=<token>

export ASTRO_API_TOKEN=<token>

Should we add a note and link to the doc on how to create this token?

https://docs.astronomer.io/astro/automation-authentication#step-1-create-an-api-token

kushalmalani · 2024-04-08T05:44:18Z

docs/data-sources/workspaces.md

+
+### Optional
+
+- `names` (List of String)


Is this supposed to be list of workspace names?

yep that you can query if you want

kushalmalani · 2024-04-08T06:02:08Z

internal/provider/schemas/workspace.go

-func WorkspaceDataSourceSchemaAttributes() map[string]datasource.Attribute {
-	return map[string]datasource.Attribute{
-		"id": datasource.StringAttribute{
+func WorkspaceDataSourceSchemaAttributes() map[string]datasourceSchema.Attribute {


Can we add some tests for both get workspace and list workspaces?

terraform unit tests aren't really a thing with the framework - they just do acceptance integration tests
those will be set up in the near future

kushalmalani

Thanks for addressing the comments.

fredzhy · 2024-04-08T21:10:05Z

README.md

+terraform {
+  required_providers {
+    astronomer = {
+      source = "registry.terraform.io/astronomer/astronomer"


should this be astronomer/astro since the provider is for astro the product?

sure we can change it

what do you think @sunkickr ?

astronomer/astro makes more sense to me as well

vandyliu added 2 commits April 3, 2024 19:48

add workspaces data source

2c8451e

update unit tests

815d1b8

vandyliu changed the title ~~add workspaces data source~~ add (list) workspaces data source Apr 5, 2024

vandyliu added 4 commits April 5, 2024 14:34

repo updates

638a320

update

58804f7

add comments

c2d2c80

fix test

b30375d

vandyliu changed the title ~~add (list) workspaces data source~~ add workspaces data source (v1beta1 list workspaces equivalent) Apr 5, 2024

vandyliu marked this pull request as ready for review April 5, 2024 21:49

vandyliu requested review from sunkickr and a team as code owners April 5, 2024 21:49

ichung08 reviewed Apr 5, 2024

View reviewed changes

kushalmalani reviewed Apr 8, 2024

View reviewed changes

.github/ISSUE_TEMPLATE/feature_request.md Outdated Show resolved Hide resolved

kushalmalani reviewed Apr 8, 2024

View reviewed changes

Makefile Outdated Show resolved Hide resolved

kushalmalani reviewed Apr 8, 2024

View reviewed changes

kushal pr comments

b5a6a5b

kushalmalani approved these changes Apr 8, 2024

View reviewed changes

vandyliu merged commit 5c6a204 into main Apr 8, 2024
4 checks passed

vandyliu deleted the workspaces-datasource branch April 8, 2024 18:02

fredzhy reviewed Apr 8, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add workspaces data source (v1beta1 list workspaces equivalent) #6

add workspaces data source (v1beta1 list workspaces equivalent) #6

vandyliu commented Apr 4, 2024 •

edited

Loading

ichung08 Apr 5, 2024

vandyliu Apr 6, 2024

ichung08 Apr 5, 2024

vandyliu Apr 6, 2024

ichung08 Apr 5, 2024

vandyliu Apr 6, 2024

kushalmalani Apr 8, 2024

kushalmalani Apr 8, 2024

vandyliu Apr 8, 2024

kushalmalani Apr 8, 2024

vandyliu Apr 8, 2024

kushalmalani Apr 8, 2024

vandyliu Apr 8, 2024

kushalmalani left a comment

fredzhy Apr 8, 2024

vandyliu Apr 9, 2024

vandyliu Apr 10, 2024

kushalmalani Apr 10, 2024

	export ASTRI_API_TOKEN=<token>
	export ASTRO_API_TOKEN=<token>

add workspaces data source (v1beta1 list workspaces equivalent) #6

add workspaces data source (v1beta1 list workspaces equivalent) #6

Conversation

vandyliu commented Apr 4, 2024 • edited Loading

Description

🎟 Issue(s)

🧪 Functional Testing

📸 Screenshots

📋 Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kushalmalani left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vandyliu commented Apr 4, 2024 •

edited

Loading