Add Api Tokens Data Source

.github/workflows/testacc.yml

@@ -92,6 +92,7 @@ jobs:
           HOSTED_USER_ID: clhpichn8002m01mqa4ocs7g6
           HOSTED_DEPLOYMENT_ID: clyd4zf7g01uu01oxpve7tfvx
           HOSTED_WORKSPACE_ID: clx42sxw501gl01o0gjenthnh
+          HOSTED_API_TOKEN_ID: clxm4836f00ql01me3nigmcr6
           TESTARGS: "-failfast"
         run: make testacc
 
@@ -139,6 +140,7 @@ jobs:
           HOSTED_USER_ID: cljftnljr00i001nl6bnngxdb
           HOSTED_DEPLOYMENT_ID: cly6exz4a00zd01k18t5bo1vf
           HOSTED_WORKSPACE_ID: clx480rvx068u01j9mp7t7fqh
+          HOSTED_API_TOKEN_ID: clxm46ged05b301neuucdqwox
           TESTARGS: "-failfast"
         run: make testacc
 
@@ -186,5 +188,6 @@ jobs:
           HOSTED_USER_ID: clhpichn8002m01mqa4ocs7g6
           HOSTED_DEPLOYMENT_ID: clyd4zf7g01uu01oxpve7tfvx
           HOSTED_WORKSPACE_ID: clx42sxw501gl01o0gjenthnh
+          HOSTED_API_TOKEN_ID: clxm4836f00ql01me3nigmcr6
           TESTARGS: "-failfast"
         run: make testacc

docs/data-sources/api_token.md

@@ -0,0 +1,77 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "astro_api_token Data Source - astro"
+subcategory: ""
+description: |-
+  API Token data source
+---
+
+# astro_api_token (Data Source)
+
+API Token data source
+
+## Example Usage
+
+```terraform
+data "astro_api_token" "example" {
+  id = "clxm4836f00ql01me3nigmcr6"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Required
+
+- `id` (String) API Token identifier
+
+### Read-Only
+
+- `created_at` (String) API Token creation timestamp
+- `created_by` (Attributes) API Token creator (see [below for nested schema](#nestedatt--created_by))
+- `description` (String) API Token description
+- `end_at` (String) time when the API token will expire in UTC
+- `expiry_period_in_days` (Number) API Token expiry period in days
+- `last_used_at` (String) API Token last used timestamp
+- `name` (String) API Token name
+- `roles` (Attributes Set) The roles assigned to the API Token (see [below for nested schema](#nestedatt--roles))
+- `short_token` (String) API Token short token
+- `start_at` (String) time when the API token will become valid in UTC
+- `type` (String) API Token type
+- `updated_at` (String) API Token last updated timestamp
+- `updated_by` (Attributes) API Token updater (see [below for nested schema](#nestedatt--updated_by))
+
+<a id="nestedatt--created_by"></a>
+### Nested Schema for `created_by`
+
+Read-Only:
+
+- `api_token_name` (String)
+- `avatar_url` (String)
+- `full_name` (String)
+- `id` (String)
+- `subject_type` (String)
+- `username` (String)
+
+
+<a id="nestedatt--roles"></a>
+### Nested Schema for `roles`
+
+Read-Only:
+
+- `entity_id` (String) The ID of the entity to assign the role to
+- `entity_type` (String) The type of entity to assign the role to
+- `role` (String) The role to assign to the deployment
+
+
+<a id="nestedatt--updated_by"></a>
+### Nested Schema for `updated_by`
+
+Read-Only:
+
+- `api_token_name` (String)
+- `avatar_url` (String)
+- `full_name` (String)
+- `id` (String)
+- `subject_type` (String)
+- `username` (String)

docs/data-sources/api_tokens.md

@@ -0,0 +1,100 @@
+---
+# generated by https://github.com/hashicorp/terraform-plugin-docs
+page_title: "astro_api_tokens Data Source - astro"
+subcategory: ""
+description: |-
+  API Tokens data source
+---
+
+# astro_api_tokens (Data Source)
+
+API Tokens data source
+
+## Example Usage
+
+```terraform
+data "astro_api_tokens" "example" {}
+
+data "astro_api_tokens" "organization_only_example" {
+  include_only_organization_tokens = true
+}
+
+data "astro_api_tokens" "workspace_example" {
+  workspace_id = "clx42sxw501gl01o0gjenthnh"
+}
+
+data "astro_api_tokens" "deployment_example" {
+  deployment_id = "clx44jyu001m201m5dzsbexqr"
+}
+```
+
+<!-- schema generated by tfplugindocs -->
+## Schema
+
+### Optional
+
+- `deployment_id` (String)
+- `include_only_organization_tokens` (Boolean)
+- `workspace_id` (String)
+
+### Read-Only
+
+- `api_tokens` (Attributes Set) (see [below for nested schema](#nestedatt--api_tokens))
+
+<a id="nestedatt--api_tokens"></a>
+### Nested Schema for `api_tokens`
+
+Required:
+
+- `id` (String) API Token identifier
+
+Read-Only:
+
+- `created_at` (String) API Token creation timestamp
+- `created_by` (Attributes) API Token creator (see [below for nested schema](#nestedatt--api_tokens--created_by))
+- `description` (String) API Token description
+- `end_at` (String) time when the API token will expire in UTC
+- `expiry_period_in_days` (Number) API Token expiry period in days
+- `last_used_at` (String) API Token last used timestamp
+- `name` (String) API Token name
+- `roles` (Attributes Set) The roles assigned to the API Token (see [below for nested schema](#nestedatt--api_tokens--roles))
+- `short_token` (String) API Token short token
+- `start_at` (String) time when the API token will become valid in UTC
+- `type` (String) API Token type
+- `updated_at` (String) API Token last updated timestamp
+- `updated_by` (Attributes) API Token updater (see [below for nested schema](#nestedatt--api_tokens--updated_by))
+
+<a id="nestedatt--api_tokens--created_by"></a>
+### Nested Schema for `api_tokens.created_by`
+
+Read-Only:
+
+- `api_token_name` (String)
+- `avatar_url` (String)
+- `full_name` (String)
+- `id` (String)
+- `subject_type` (String)
+- `username` (String)
+
+
+<a id="nestedatt--api_tokens--roles"></a>
+### Nested Schema for `api_tokens.roles`
+
+Read-Only:
+
+- `entity_id` (String) The ID of the entity to assign the role to
+- `entity_type` (String) The type of entity to assign the role to
+- `role` (String) The role to assign to the deployment
+
+
+<a id="nestedatt--api_tokens--updated_by"></a>
+### Nested Schema for `api_tokens.updated_by`
+
+Read-Only:
+
+- `api_token_name` (String)
+- `avatar_url` (String)
+- `full_name` (String)
+- `id` (String)
+- `subject_type` (String)
+- `username` (String)

examples/data-sources/astro_api_token/data-source.tf

@@ -0,0 +1,3 @@
+data "astro_api_token" "example" {
+  id = "clxm4836f00ql01me3nigmcr6"
+}

examples/data-sources/astro_api_tokens/data-source.tf

@@ -0,0 +1,13 @@
+data "astro_api_tokens" "example" {}
+
+data "astro_api_tokens" "organization_only_example" {
+  include_only_organization_tokens = true
+}
+
+data "astro_api_tokens" "workspace_example" {
+  workspace_id = "clx42sxw501gl01o0gjenthnh"
+}
+
+data "astro_api_tokens" "deployment_example" {
+  deployment_id = "clx44jyu001m201m5dzsbexqr"
+}

internal/provider/datasources/data_source_api_token.go

@@ -0,0 +1,109 @@
+package datasources
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/astronomer/terraform-provider-astro/internal/clients"
+	"github.com/astronomer/terraform-provider-astro/internal/clients/iam"
+	"github.com/astronomer/terraform-provider-astro/internal/provider/models"
+	"github.com/astronomer/terraform-provider-astro/internal/provider/schemas"
+	"github.com/astronomer/terraform-provider-astro/internal/utils"
+	"github.com/hashicorp/terraform-plugin-framework/datasource"
+	"github.com/hashicorp/terraform-plugin-framework/datasource/schema"
+	"github.com/hashicorp/terraform-plugin-log/tflog"
+)
+
+// Ensure provider defined types fully satisfy framework interfaces.
+var _ datasource.DataSource = &apiTokenDataSource{}
+var _ datasource.DataSourceWithConfigure = &apiTokenDataSource{}
+
+func NewApiTokenDataSource() datasource.DataSource {
+	return &apiTokenDataSource{}
+}
+
+// apiTokenDataSource defines the data source implementation.
+type apiTokenDataSource struct {
+	IamClient      iam.ClientWithResponsesInterface
+	OrganizationId string
+}
+
+func (d *apiTokenDataSource) Metadata(
+	ctx context.Context,
+	req datasource.MetadataRequest,
+	resp *datasource.MetadataResponse,
+) {
+	resp.TypeName = req.ProviderTypeName + "_api_token"
+}
+
+func (d *apiTokenDataSource) Schema(
+	ctx context.Context,
+	req datasource.SchemaRequest,
+	resp *datasource.SchemaResponse,
+) {
+	resp.Schema = schema.Schema{
+		// This description is used by the documentation generator and the language server.
+		MarkdownDescription: "API Token data source",
+		Attributes:          schemas.ApiTokenDataSourceSchemaAttributes(),
+	}
+}
+
+func (d *apiTokenDataSource) Configure(
+	ctx context.Context,
+	req datasource.ConfigureRequest,
+	resp *datasource.ConfigureResponse,
+) {
+	// Prevent panic if the provider has not been configured.
+	if req.ProviderData == nil {
+		return
+	}
+
+	apiClients, ok := req.ProviderData.(models.ApiClientsModel)
+	if !ok {
+		utils.DataSourceApiClientConfigureError(ctx, req, resp)
+		return
+	}
+
+	d.IamClient = apiClients.IamClient
+	d.OrganizationId = apiClients.OrganizationId
+}
+
+func (d *apiTokenDataSource) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) {
+	var data models.ApiTokenDataSource
+
+	// Read Terraform configuration data into the model
+	resp.Diagnostics.Append(req.Config.Get(ctx, &data)...)
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	apiToken, err := d.IamClient.GetApiTokenWithResponse(ctx, d.OrganizationId, data.Id.ValueString())
+	if err != nil {
+		tflog.Error(ctx, "Failed to get api token", map[string]interface{}{"error": err})
+		resp.Diagnostics.AddError(
+			"Client Error",
+			fmt.Sprintf("Unable to read api token, got error: %s", err),
+		)
+		return
+	}
+	_, diagnostic := clients.NormalizeAPIError(ctx, apiToken.HTTPResponse, apiToken.Body)
+	if diagnostic != nil {
+		resp.Diagnostics.Append(diagnostic)
+		return
+	}
+	if apiToken.JSON200 == nil {
+		tflog.Error(ctx, "failed to get api token", map[string]interface{}{"error": "nil response"})
+		resp.Diagnostics.AddError("Client Error", "Unable to read api token, got nil response")
+		return
+	}
+
+	// Populate the model with the response data
+	diags := data.ReadFromResponse(ctx, apiToken.JSON200)
+	if diags.HasError() {
+		resp.Diagnostics.Append(diags...)
+		return
+	}
+
+	// Save data into Terraform state
+	resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
+}

internal/provider/datasources/data_source_api_token_test.go

@@ -0,0 +1,51 @@
+package datasources_test
+
+import (
+	"fmt"
+	"os"
+	"testing"
+
+	astronomerprovider "github.com/astronomer/terraform-provider-astro/internal/provider"
+	"github.com/hashicorp/terraform-plugin-testing/helper/resource"
+)
+
+func TestAcc_DataSource_ApiToken(t *testing.T) {
+	apiTokenId := os.Getenv("HOSTED_API_TOKEN_ID")
+	tfVarName := "test_data_api_token"
+	resourceVar := fmt.Sprintf("data.astro_api_token.%v", tfVarName)
+
+	resource.Test(t, resource.TestCase{
+		PreCheck: func() {
+			astronomerprovider.TestAccPreCheck(t)
+		},
+		ProtoV6ProviderFactories: astronomerprovider.TestAccProtoV6ProviderFactories,
+		Steps: []resource.TestStep{
+			{
+				Config: astronomerprovider.ProviderConfig(t, true) + apiToken(apiTokenId, tfVarName),
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttrSet(resourceVar, "id"),
+					resource.TestCheckResourceAttrSet(resourceVar, "name"),
+					resource.TestCheckResourceAttrSet(resourceVar, "short_token"),
+					resource.TestCheckResourceAttrSet(resourceVar, "type"),
+					resource.TestCheckResourceAttrSet(resourceVar, "start_at"),
+					resource.TestCheckResourceAttrSet(resourceVar, "created_at"),
+					resource.TestCheckResourceAttrSet(resourceVar, "updated_at"),
+					resource.TestCheckResourceAttrSet(resourceVar, "created_by.id"),
+					resource.TestCheckResourceAttrSet(resourceVar, "updated_by.id"),
+					resource.TestCheckResourceAttrSet(resourceVar, "last_used_at"),
+					resource.TestCheckResourceAttrWith(resourceVar, "roles.#", CheckAttributeLengthIsNotEmpty),
+					resource.TestCheckResourceAttrSet(resourceVar, "roles.0.entity_id"),
+					resource.TestCheckResourceAttrSet(resourceVar, "roles.0.entity_type"),
+					resource.TestCheckResourceAttrSet(resourceVar, "roles.0.role"),
+				),
+			},
+		},
+	})
+}
+
+func apiToken(apiTokenId string, tfVarName string) string {
+	return fmt.Sprintf(`
+data astro_api_token "%v" {
+	id = "%v"
+}`, tfVarName, apiTokenId)
+}