fix: adapt tenant_v4 resource to actual implementation

Author: henryde

CHANGELOG.md

@@ -3,6 +3,8 @@
 FEATURES:
 - Added `meshstack_workspace` resource.
 - Added `meshstack_workspace` data source.
+- Added `meshstack_tenant_v4` resource.
+- Added `meshstack_tenant_v4` data source.
 
 FIXES:
 - Allow `value_code` in `meshstack_building_block_v2` and `meshstack_building_block` resources.

client/tenant_v4.go

@@ -87,7 +87,7 @@ func (c *MeshStackProviderClient) ReadTenantV4(uuid string) (*MeshTenantV4, erro
 		return nil, nil
 	}
 
-	if res.StatusCode != 200 {
+	if !isSuccessHTTPStatus(res) {
 		return nil, fmt.Errorf("unexpected status code: %d, %s", res.StatusCode, data)
 	}
 

docs/data-sources/tenant_v4.md

@@ -3,18 +3,23 @@
 page_title: "meshstack_tenant_v4 Data Source - terraform-provider-meshstack"
 subcategory: ""
 description: |-
-  Fetches details of a single tenant by UUID (v4).
+  Fetches details of a single tenant by UUID.
+  ~> Note: This resource is in preview and may change in the near future.
 ---
 
 # meshstack_tenant_v4 (Data Source)
 
-Fetches details of a single tenant by UUID (v4).
+Fetches details of a single tenant by UUID.
+
+~> **Note:** This resource is in preview and may change in the near future.
 
 ## Example Usage
 
 ```terraform
 data "meshstack_tenant_v4" "example" {
-  uuid = "00000000-0000-0000-0000-000000000000"
+  metadata = {
+    uuid = "00000000-0000-0000-0000-000000000000" # Tenant UUID
+  }
 }
 ```
 
@@ -23,21 +28,27 @@ data "meshstack_tenant_v4" "example" {
 
 ### Required
 
-- `uuid` (String) UUID of the tenant.
+- `metadata` (Attributes) Tenant metadata. (see [below for nested schema](#nestedatt--metadata))
 
 ### Read-Only
 
-- `metadata` (Attributes) Tenant metadata. (see [below for nested schema](#nestedatt--metadata))
+- `api_version` (String) Tenant datatype version
+- `kind` (String) meshObject type, always `meshTenant`.
 - `spec` (Attributes) Tenant specification. (see [below for nested schema](#nestedatt--spec))
 - `status` (Attributes) Tenant status. (see [below for nested schema](#nestedatt--status))
 
 <a id="nestedatt--metadata"></a>
 ### Nested Schema for `metadata`
 
+Required:
+
+- `uuid` (String) UUID of the tenant.
+
 Read-Only:
 
 - `created_on` (String) The date the tenant was created.
 - `deleted_on` (String) If the tenant has been submitted for deletion by a workspace manager, the date is shown here.
+- `marked_for_deletion_on` (String) Date when the tenant was marked for deletion.
 - `owned_by_project` (String) Identifier of the project the tenant belongs to.
 - `owned_by_workspace` (String) Identifier of the workspace the tenant belongs to.
 
@@ -48,8 +59,8 @@ Read-Only:
 Read-Only:
 
 - `landing_zone_identifier` (String) Identifier of landing zone to assign to this tenant.
-- `local_id` (String) Tenant ID local to the platform.
 - `platform_identifier` (String) Identifier of the target platform.
+- `platform_tenant_id` (String) Platform-specific tenant ID.
 - `quotas` (Attributes List) Set of applied tenant quotas. (see [below for nested schema](#nestedatt--spec--quotas))
 
 <a id="nestedatt--spec--quotas"></a>
@@ -67,6 +78,7 @@ Read-Only:
 
 Read-Only:
 
-- `current_replication_status` (String) The current replication status of the tenant.
-- `last_replicated` (String) The last time the tenant was replicated.
+- `platform_type_identifier` (String) Identifier of the platform type.
+- `platform_workspace_identifier` (String) Identifier of the platform workspace.
 - `tags` (Map of List of String) Tags assigned to this tenant.
+- `tenant_name` (String) Name of the tenant.

docs/resources/tenant_v4.md

@@ -3,12 +3,15 @@
 page_title: "meshstack_tenant_v4 Resource - terraform-provider-meshstack"
 subcategory: ""
 description: |-
-  Single tenant by workspace, project, and platform (v4).
+  Manages a meshTenant with API version 4.
+  ~> Note: This resource is in preview and may change in the near future.
 ---
 
 # meshstack_tenant_v4 (Resource)
 
-Single tenant by workspace, project, and platform (v4).
+Manages a `meshTenant` with API version 4.
+
+~> **Note:** This resource is in preview and may change in the near future.
 
 ## Example Usage
 
@@ -22,7 +25,6 @@ data "meshstack_project" "example" {
 
 resource "meshstack_tenant_v4" "example" {
   metadata = {
-    uuid               = "1234-5345234-213123-123123"
     owned_by_workspace = data.meshstack_project.example.metadata.owned_by_workspace
     owned_by_project   = data.meshstack_project.example.metadata.name
   }
@@ -39,28 +41,29 @@ resource "meshstack_tenant_v4" "example" {
 
 ### Required
 
-- `metadata` (Attributes) Tenant metadata. Workspace, project and platform of the target tenant must be set here. (see [below for nested schema](#nestedatt--metadata))
+- `metadata` (Attributes) Metadata of the tenant. The `owned_by_workspace` and `owned_by_project` attributes must be set here. (see [below for nested schema](#nestedatt--metadata))
 - `spec` (Attributes) Tenant specification. (see [below for nested schema](#nestedatt--spec))
 
 ### Read-Only
 
-- `api_version` (String) Tenant datatype version
-- `kind` (String) meshObject type, always `meshTenant`.
+- `api_version` (String) API version of the tenant resource.
+- `kind` (String) The kind of the meshObject, always `meshTenant`.
 - `status` (Attributes) Tenant status. (see [below for nested schema](#nestedatt--status))
 
 <a id="nestedatt--metadata"></a>
 ### Nested Schema for `metadata`
 
 Required:
 
-- `owned_by_project` (String) Identifier of the project the tenant belongs to.
-- `owned_by_workspace` (String) Identifier of the workspace the tenant belongs to.
-- `uuid` (String) UUID of the tenant.
+- `owned_by_project` (String) The identifier of the project that the tenant belongs to.
+- `owned_by_workspace` (String) The identifier of the workspace that the tenant belongs to.
 
 Read-Only:
 
-- `created_on` (String) The date the tenant was created (e.g. 2020-12-22T09:37:43Z).
-- `deleted_on` (String) If the tenant has been submitted for deletion by a workspace manager, the date is shown here (e.g. 2020-12-22T09:37:43Z).
+- `created_on` (String) The creation timestamp of the meshTenant (e.g. `2020-12-22T09:37:43Z`).
+- `deleted_on` (String) The deletion timestamp of the tenant (e.g. `2020-12-22T09:37:43Z`).
+- `marked_for_deletion_on` (String) The timestamp when the tenant was marked for deletion (e.g. `2020-12-22T09:37:43Z`).
+- `uuid` (String) The unique identifier (UUID) of the tenant.
 
 
 <a id="nestedatt--spec"></a>
@@ -72,14 +75,14 @@ Required:
 
 Optional:
 
-- `landing_zone_identifier` (String) Identifier of landing zone to assign to this tenant.
-- `local_id` (String) Tenant ID local to the platform (e.g. GCP project ID, Azure subscription ID). Setting the local ID means that a tenant with this ID should be imported into meshStack. Not setting a local ID means that a new tenant should be created. Field will be empty until a successful replication has run.
-- `quotas` (Attributes List) Set of applied tenant quotas. By default the landing zone quotas are applied to new tenants. (see [below for nested schema](#nestedatt--spec--quotas))
+- `landing_zone_identifier` (String) The identifier of the landing zone to assign to this tenant.
+- `platform_tenant_id` (String) The identifier of the tenant on the platform (e.g. GCP project ID or Azure subscription ID). If this is not set, a new tenant will be created. If this is set, an existing tenant will be imported. Otherwise, this field will be empty until a successful replication has run.
+- `quotas` (Attributes Set) Landing zone quota settings will be applied by default but can be changed here. (see [below for nested schema](#nestedatt--spec--quotas))
 
 <a id="nestedatt--spec--quotas"></a>
 ### Nested Schema for `spec.quotas`
 
-Read-Only:
+Required:
 
 - `key` (String)
 - `value` (Number)
@@ -91,15 +94,25 @@ Read-Only:
 
 Read-Only:
 
-- `current_replication_status` (String) The current replication status of the tenant.
-- `last_replicated` (String) The last time the tenant was replicated (e.g. 2020-12-22T09:37:43Z).
+- `platform_type_identifier` (String) Identifier of the platform type.
+- `platform_workspace_identifier` (String) Some platforms create representations of workspaces, in such cases this will contain the identifier of the workspace on the platform.
+- `quotas` (Attributes Set) The effective quotas applied to the tenant. (see [below for nested schema](#nestedatt--status--quotas))
 - `tags` (Map of List of String) Tags assigned to this tenant.
+- `tenant_name` (String) The full tenant name, a concatenation of the workspace identifier, project identifier and platform identifier.
+
+<a id="nestedatt--status--quotas"></a>
+### Nested Schema for `status.quotas`
+
+Read-Only:
+
+- `key` (String)
+- `value` (Number)
 
 ## Import
 
 Import is supported using the following syntax:
 
 ```shell
 # import via uuid
-terraform import 'meshstack_tenant.example' '00000000-0000-0000-0000-000000000000'
+terraform import 'meshstack_tenant_v4.example' '00000000-0000-0000-0000-000000000000'
 ```

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

@@ -1,3 +1,5 @@
 data "meshstack_tenant_v4" "example" {
-  uuid = "00000000-0000-0000-0000-000000000000"
+  metadata = {
+    uuid = "00000000-0000-0000-0000-000000000000" # Tenant UUID
+  }
 }

examples/resources/meshstack_tenant_v4/import.sh

@@ -1,2 +1,2 @@
 # import via uuid
-terraform import 'meshstack_tenant.example' '00000000-0000-0000-0000-000000000000'
+terraform import 'meshstack_tenant_v4.example' '00000000-0000-0000-0000-000000000000'

examples/resources/meshstack_tenant_v4/resource.tf

@@ -7,7 +7,6 @@ data "meshstack_project" "example" {
 
 resource "meshstack_tenant_v4" "example" {
   metadata = {
-    uuid               = "1234-5345234-213123-123123"
     owned_by_workspace = data.meshstack_project.example.metadata.owned_by_workspace
     owned_by_project   = data.meshstack_project.example.metadata.name
   }

internal/provider/buildingblock_resource.go

@@ -366,7 +366,7 @@ func (r *buildingBlockResource) Create(ctx context.Context, req resource.CreateR
 		)
 		return
 	}
-	resp.Diagnostics.Append(setStateFromResponse(&ctx, &resp.State, created)...)
+	resp.Diagnostics.Append(r.setStateFromResponse(&ctx, &resp.State, created)...)
 
 	// ensure that user inputs are passed along
 	resp.Diagnostics.Append(resp.State.SetAttribute(ctx, path.Root("spec").AtName("inputs"), plan.Spec.Inputs)...)
@@ -389,7 +389,7 @@ func (r *buildingBlockResource) Read(ctx context.Context, req resource.ReadReque
 		return
 	}
 
-	resp.Diagnostics.Append(setStateFromResponse(&ctx, &resp.State, bb)...)
+	resp.Diagnostics.Append(r.setStateFromResponse(&ctx, &resp.State, bb)...)
 }
 
 func (r *buildingBlockResource) Update(ctx context.Context, req resource.UpdateRequest, resp *resource.UpdateResponse) {
@@ -489,7 +489,7 @@ func toResourceModel(io *client.MeshBuildingBlockIO) (*buildingBlockIoModel, err
 	return nil, fmt.Errorf("Input '%s' with value type '%s' does not match actual value.", io.Key, io.ValueType)
 }
 
-func setStateFromResponse(ctx *context.Context, state *tfsdk.State, bb *client.MeshBuildingBlock) diag.Diagnostics {
+func (r *buildingBlockResource) setStateFromResponse(ctx *context.Context, state *tfsdk.State, bb *client.MeshBuildingBlock) diag.Diagnostics {
 	diags := make(diag.Diagnostics, 0)
 
 	diags.Append(state.SetAttribute(*ctx, path.Root("api_version"), bb.ApiVersion)...)

internal/provider/tenant_resource.go

@@ -3,6 +3,7 @@ package provider
 import (
 	"context"
 	"fmt"
+	"slices"
 	"strings"
 
 	"github.com/meshcloud/terraform-provider-meshstack/client"
@@ -255,14 +256,12 @@ func (r *tenantResource) Delete(ctx context.Context, req resource.DeleteRequest,
 func (r *tenantResource) ImportState(ctx context.Context, req resource.ImportStateRequest, resp *resource.ImportStateResponse) {
 	identifier := strings.Split(req.ID, ".")
 
-	for _, s := range identifier {
-		if s == "" {
-			resp.Diagnostics.AddError(
-				"Incomplete Import Identifier",
-				fmt.Sprintf("Encountered empty import identifier field. Got: %q", req.ID),
-			)
-			return
-		}
+	if slices.Contains(identifier, "") {
+		resp.Diagnostics.AddError(
+			"Incomplete Import Identifier",
+			fmt.Sprintf("Encountered empty import identifier field. Got: %q", req.ID),
+		)
+		return
 	}
 
 	if len(identifier) != 4 {

internal/provider/tenant_v4_data_source.go

@@ -6,9 +6,11 @@ import (
 
 	"github.com/meshcloud/terraform-provider-meshstack/client"
 
+	"github.com/hashicorp/terraform-plugin-framework-validators/stringvalidator"
 	"github.com/hashicorp/terraform-plugin-framework/datasource"
 	"github.com/hashicorp/terraform-plugin-framework/datasource/schema"
 	"github.com/hashicorp/terraform-plugin-framework/path"
+	"github.com/hashicorp/terraform-plugin-framework/schema/validator"
 	"github.com/hashicorp/terraform-plugin-framework/types"
 )
 
@@ -48,16 +50,29 @@ func (d *tenantV4DataSource) Configure(_ context.Context, req datasource.Configu
 
 func (d *tenantV4DataSource) Schema(_ context.Context, _ datasource.SchemaRequest, resp *datasource.SchemaResponse) {
 	resp.Schema = schema.Schema{
-		MarkdownDescription: "Fetches details of a single tenant by UUID (v4).",
+		MarkdownDescription: "Fetches details of a single tenant by UUID.\n\n~> **Note:** This resource is in preview and may change in the near future.",
 		Attributes: map[string]schema.Attribute{
-			"uuid": schema.StringAttribute{
-				MarkdownDescription: "UUID of the tenant.",
-				Required:            true,
+			"api_version": schema.StringAttribute{
+				MarkdownDescription: "Tenant datatype version",
+				Computed:            true,
+			},
+
+			"kind": schema.StringAttribute{
+				MarkdownDescription: "meshObject type, always `meshTenant`.",
+				Computed:            true,
+				Validators: []validator.String{
+					stringvalidator.OneOf([]string{"meshTenant"}...),
+				},
 			},
+
 			"metadata": schema.SingleNestedAttribute{
 				MarkdownDescription: "Tenant metadata.",
-				Computed:            true,
+				Required:            true,
 				Attributes: map[string]schema.Attribute{
+					"uuid": schema.StringAttribute{
+						MarkdownDescription: "UUID of the tenant.",
+						Required:            true,
+					},
 					"owned_by_workspace": schema.StringAttribute{
 						MarkdownDescription: "Identifier of the workspace the tenant belongs to.",
 						Computed:            true,
@@ -66,6 +81,10 @@ func (d *tenantV4DataSource) Schema(_ context.Context, _ datasource.SchemaReques
 						MarkdownDescription: "Identifier of the project the tenant belongs to.",
 						Computed:            true,
 					},
+					"marked_for_deletion_on": schema.StringAttribute{
+						MarkdownDescription: "Date when the tenant was marked for deletion.",
+						Computed:            true,
+					},
 					"deleted_on": schema.StringAttribute{
 						MarkdownDescription: "If the tenant has been submitted for deletion by a workspace manager, the date is shown here.",
 						Computed:            true,
@@ -84,8 +103,8 @@ func (d *tenantV4DataSource) Schema(_ context.Context, _ datasource.SchemaReques
 						MarkdownDescription: "Identifier of the target platform.",
 						Computed:            true,
 					},
-					"local_id": schema.StringAttribute{
-						MarkdownDescription: "Tenant ID local to the platform.",
+					"platform_tenant_id": schema.StringAttribute{
+						MarkdownDescription: "Platform-specific tenant ID.",
 						Computed:            true,
 					},
 					"landing_zone_identifier": schema.StringAttribute{
@@ -108,17 +127,21 @@ func (d *tenantV4DataSource) Schema(_ context.Context, _ datasource.SchemaReques
 				MarkdownDescription: "Tenant status.",
 				Computed:            true,
 				Attributes: map[string]schema.Attribute{
-					"tags": schema.MapAttribute{
-						MarkdownDescription: "Tags assigned to this tenant.",
-						ElementType:         types.ListType{ElemType: types.StringType},
+					"tenant_name": schema.StringAttribute{
+						MarkdownDescription: "Name of the tenant.",
 						Computed:            true,
 					},
-					"last_replicated": schema.StringAttribute{
-						MarkdownDescription: "The last time the tenant was replicated.",
+					"platform_type_identifier": schema.StringAttribute{
+						MarkdownDescription: "Identifier of the platform type.",
 						Computed:            true,
 					},
-					"current_replication_status": schema.StringAttribute{
-						MarkdownDescription: "The current replication status of the tenant.",
+					"platform_workspace_identifier": schema.StringAttribute{
+						MarkdownDescription: "Identifier of the platform workspace.",
+						Computed:            true,
+					},
+					"tags": schema.MapAttribute{
+						MarkdownDescription: "Tags assigned to this tenant.",
+						ElementType:         types.ListType{ElemType: types.StringType},
 						Computed:            true,
 					},
 				},
@@ -129,7 +152,7 @@ func (d *tenantV4DataSource) Schema(_ context.Context, _ datasource.SchemaReques
 
 func (d *tenantV4DataSource) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) {
 	var uuid string
-	resp.Diagnostics.Append(req.Config.GetAttribute(ctx, path.Root("uuid"), &uuid)...)
+	resp.Diagnostics.Append(req.Config.GetAttribute(ctx, path.Root("metadata").AtName("uuid"), &uuid)...)
 
 	if resp.Diagnostics.HasError() {
 		return