feat: add meshstack_building_block_definition, meshstack_integration resource

.golangci.yml

@@ -60,23 +60,30 @@ linters:
           files:
             - "!$test"
             - "!**/client/**/*.go"
+            - "!**/internal/clientmock/*.go"
           list-mode: strict
           deny:
             - pkg: log # as $gostd is allowed
               desc: Always use 'hclog' or SDK logging
+            - pkg: github.com/meshcloud/terraform-provider-meshstack/internal/clientmock
+              desc: clientmock package must only be used in tests
           allow:
             - $gostd
-            # explicitly specifying 'client' and 'internal' suffixes prevents 'examples' package to be included in non-test files
+            # explicitly specifying 'client' and 'internal' suffixes
+            # prevents 'examples' package to be included in non-test files
             - github.com/meshcloud/terraform-provider-meshstack/client
             - github.com/meshcloud/terraform-provider-meshstack/internal
             - github.com/hashicorp/terraform-plugin-framework/
+            - github.com/hashicorp/terraform-plugin-sdk/v2/helper/retry
+            - github.com/hashicorp/terraform-plugin-framework-jsontypes/jsontypes # for 'any' value support
             - github.com/hashicorp/terraform-plugin-framework-validators
             - github.com/hashicorp/terraform-plugin-go
-            - github.com/hashicorp/terraform-plugin-sdk
             - github.com/hashicorp/terraform-plugin-log
         provider-test:
           files:
             - "$test"
+            - "**/internal/clientmock/**/*.go"
+            - "!**/internal/types/**/*.go"
             - "!**/client/**/*_test.go"
             - "!**/internal/provider/provider_test.go" # contains common adapters for all tests, using non-testing deps.
           list-mode: strict
@@ -87,4 +94,35 @@ linters:
             - $gostd
             - github.com/meshcloud/terraform-provider-meshstack # any packages are included in tests
             - github.com/hashicorp/terraform-plugin-testing
+            - github.com/hashicorp/terraform-plugin-framework/diag
+            - github.com/stretchr/testify
+        types:
+          files:
+            - "**/internal/types/**/*.go"
+            - "!$test"
+          list-mode: strict
+          deny:
+            - pkg: log # as $gostd is allowed
+              desc: Always use 'hclog' or SDK logging
+          allow:
+            - $gostd
+            - github.com/meshcloud/terraform-provider-meshstack/client/types # only types should be used from client, if at all!
+            - github.com/meshcloud/terraform-provider-meshstack/internal/util/
+            - github.com/meshcloud/terraform-provider-meshstack/internal/types/
+            - github.com/hashicorp/terraform-plugin-framework/
+            - github.com/hashicorp/terraform-plugin-go/tftypes
+        types-test:
+          files:
+            - "**/internal/types/**/*_test.go"
+          list-mode: strict
+          deny:
+            - pkg: log # as $gostd is allowed
+              desc: Always use 'hclog' or SDK logging
+          allow:
+            - $gostd
+            - github.com/meshcloud/terraform-provider-meshstack/internal/util/
+            - github.com/meshcloud/terraform-provider-meshstack/internal/types/
+            - github.com/hashicorp/terraform-plugin-framework/
+            - github.com/hashicorp/terraform-plugin-framework-jsontypes/jsontypes
+            - github.com/hashicorp/terraform-plugin-go/tftypes
             - github.com/stretchr/testify

CHANGELOG.md

@@ -1,3 +1,19 @@
+## v0.18.0
+
+FEATURES:
+
+- New resource: `meshstack_building_block_definition`
+- New resource: `meshstack_integration`
+
+FIXES:
+
+- `meshstack_platform`: Support custom platform in datasource as well
+
+BREAKING CHANGES:
+
+- Proper secret handling for data source `meshstack_integrations`, 
+  as only the hash is returned from the API now.
+
 ## v0.17.5
 
 FEATURES:

Taskfile.yml

@@ -3,11 +3,6 @@ version: '3'
 dotenv: ['.env']
 
 tasks:
-  default:
-    desc: Run acceptance tests (default task)
-    cmds:
-      - task: testacc
-
   testacc:
     desc: Run acceptance tests
     env:

client/api_permissions.go

@@ -0,0 +1,86 @@
+package client
+
+import (
+	"github.com/meshcloud/terraform-provider-meshstack/client/types/enum"
+)
+
+// API Permissions as defined in https://docs.meshcloud.io/api/authentication/api-permissions/
+
+type ApiPermission string
+
+// Workspace Permissions (non-admin).
+var (
+	WorkspacePermissions = enum.Enum[ApiPermission]{}
+
+	PermissionBuildingBlockDefinitionDelete = WorkspacePermissions.Entry("BUILDINGBLOCKDEFINITION_DELETE")
+	PermissionBuildingBlockDefinitionList   = WorkspacePermissions.Entry("BUILDINGBLOCKDEFINITION_LIST")
+	PermissionBuildingBlockDefinitionSave   = WorkspacePermissions.Entry("BUILDINGBLOCKDEFINITION_SAVE")
+
+	PermissionBuildingBlockRunnerDelete = WorkspacePermissions.Entry("BUILDINGBLOCKRUNNER_DELETE")
+	PermissionBuildingBlockRunnerList   = WorkspacePermissions.Entry("BUILDINGBLOCKRUNNER_LIST")
+	PermissionBuildingBlockRunnerSave   = WorkspacePermissions.Entry("BUILDINGBLOCKRUNNER_SAVE")
+
+	PermissionBuildingBlockDelete = WorkspacePermissions.Entry("BUILDINGBLOCK_DELETE")
+	PermissionBuildingBlockList   = WorkspacePermissions.Entry("BUILDINGBLOCK_LIST")
+	PermissionBuildingBlockSave   = WorkspacePermissions.Entry("BUILDINGBLOCK_SAVE")
+
+	PermissionCommunicationDefinitionDelete = WorkspacePermissions.Entry("COMMUNICATIONDEFINITION_DELETE")
+	PermissionCommunicationDefinitionList   = WorkspacePermissions.Entry("COMMUNICATIONDEFINITION_LIST")
+	PermissionCommunicationDefinitionSave   = WorkspacePermissions.Entry("COMMUNICATIONDEFINITION_SAVE")
+
+	PermissionCommunicationDelete = WorkspacePermissions.Entry("COMMUNICATION_DELETE")
+	PermissionCommunicationList   = WorkspacePermissions.Entry("COMMUNICATION_LIST")
+	PermissionCommunicationSave   = WorkspacePermissions.Entry("COMMUNICATION_SAVE")
+
+	PermissionEventLogList = WorkspacePermissions.Entry("EVENTLOG_LIST")
+
+	PermissionIntegrationDelete = WorkspacePermissions.Entry("INTEGRATION_DELETE")
+	PermissionIntegrationList   = WorkspacePermissions.Entry("INTEGRATION_LIST")
+	PermissionIntegrationSave   = WorkspacePermissions.Entry("INTEGRATION_SAVE")
+
+	PermissionLandingZoneDelete = WorkspacePermissions.Entry("LANDINGZONE_DELETE")
+	PermissionLandingZoneList   = WorkspacePermissions.Entry("LANDINGZONE_LIST")
+	PermissionLandingZoneSave   = WorkspacePermissions.Entry("LANDINGZONE_SAVE")
+
+	PermissionManagedBuildingBlockRunSourceSave = WorkspacePermissions.Entry("MANAGED_BUILDINGBLOCKRUNSOURCE_SAVE")
+	PermissionManagedBuildingBlockRunList       = WorkspacePermissions.Entry("MANAGED_BUILDINGBLOCKRUN_LIST")
+	PermissionManagedBuildingBlockRunSave       = WorkspacePermissions.Entry("MANAGED_BUILDINGBLOCKRUN_SAVE")
+	PermissionManagedBuildingBlockList          = WorkspacePermissions.Entry("MANAGED_BUILDINGBLOCK_LIST")
+	PermissionManagedTenantImport               = WorkspacePermissions.Entry("MANAGED_TENANT_IMPORT")
+
+	PermissionPaymentMethodList = WorkspacePermissions.Entry("PAYMENTMETHOD_LIST")
+
+	PermissionPlatformInstanceDelete = WorkspacePermissions.Entry("PLATFORMINSTANCE_DELETE")
+	PermissionPlatformInstanceList   = WorkspacePermissions.Entry("PLATFORMINSTANCE_LIST")
+	PermissionPlatformInstanceSave   = WorkspacePermissions.Entry("PLATFORMINSTANCE_SAVE")
+
+	PermissionProjectPrincipalRoleDelete = WorkspacePermissions.Entry("PROJECTPRINCIPALROLE_DELETE")
+	PermissionProjectPrincipalRoleList   = WorkspacePermissions.Entry("PROJECTPRINCIPALROLE_LIST")
+	PermissionProjectPrincipalRoleSave   = WorkspacePermissions.Entry("PROJECTPRINCIPALROLE_SAVE")
+
+	PermissionProjectDelete = WorkspacePermissions.Entry("PROJECT_DELETE")
+	PermissionProjectList   = WorkspacePermissions.Entry("PROJECT_LIST")
+	PermissionProjectSave   = WorkspacePermissions.Entry("PROJECT_SAVE")
+
+	PermissionServiceInstanceDelete = WorkspacePermissions.Entry("SERVICEINSTANCE_DELETE")
+	PermissionServiceInstanceList   = WorkspacePermissions.Entry("SERVICEINSTANCE_LIST")
+	PermissionServiceInstanceSave   = WorkspacePermissions.Entry("SERVICEINSTANCE_SAVE")
+
+	PermissionTenantDelete = WorkspacePermissions.Entry("TENANT_DELETE")
+	PermissionTenantList   = WorkspacePermissions.Entry("TENANT_LIST")
+	PermissionTenantSave   = WorkspacePermissions.Entry("TENANT_SAVE")
+
+	PermissionTfStateDelete = WorkspacePermissions.Entry("TFSTATE_DELETE")
+	PermissionTfStateList   = WorkspacePermissions.Entry("TFSTATE_LIST")
+	PermissionTfStateSave   = WorkspacePermissions.Entry("TFSTATE_SAVE")
+
+	PermissionWorkspacePrincipalBindingDelete = WorkspacePermissions.Entry("WORKSPACEPRINCIPALBINDING_DELETE")
+	PermissionWorkspacePrincipalBindingList   = WorkspacePermissions.Entry("WORKSPACEPRINCIPALBINDING_LIST")
+	PermissionWorkspacePrincipalBindingSave   = WorkspacePermissions.Entry("WORKSPACEPRINCIPALBINDING_SAVE")
+
+	PermissionWorkspaceUserGroupList = WorkspacePermissions.Entry("WORKSPACEUSERGROUP_LIST")
+
+	PermissionWorkspaceDelete = WorkspacePermissions.Entry("WORKSPACE_DELETE")
+	PermissionWorkspaceList   = WorkspacePermissions.Entry("WORKSPACE_LIST")
+	PermissionWorkspaceSave   = WorkspacePermissions.Entry("WORKSPACE_SAVE")
+)

client/buildingblock_definition.go

@@ -0,0 +1,110 @@
+package client
+
+import (
+	"context"
+
+	"github.com/meshcloud/terraform-provider-meshstack/client/internal"
+	"github.com/meshcloud/terraform-provider-meshstack/client/types/enum"
+)
+
+type MeshBuildingBlockType string
+
+var (
+	MeshBuildingBlockTypes              = enum.Enum[MeshBuildingBlockType]{}
+	MeshBuildingBlockTypeTenantLevel    = MeshBuildingBlockTypes.Entry("TENANT_LEVEL")
+	MeshBuildingBlockTypeWorkspaceLevel = MeshBuildingBlockTypes.Entry("WORKSPACE_LEVEL")
+)
+
+type MeshBuildingBlockDefinitionMetadata struct {
+	Uuid             *string             `json:"uuid,omitempty" tfsdk:"uuid"`
+	OwnedByWorkspace string              `json:"ownedByWorkspace" tfsdk:"owned_by_workspace"`
+	Tags             map[string][]string `json:"tags" tfsdk:"tags"`
+}
+
+type BuildingBlockDefinitionSupportedPlatform string
+
+type MeshBuildingBlockDefinitionSpec struct {
+	DisplayName           string                `json:"displayName" tfsdk:"display_name"`
+	TargetType            MeshBuildingBlockType `json:"targetType" tfsdk:"target_type"`
+	Description           string                `json:"description" tfsdk:"description"`
+	Readme                *string               `json:"readme,omitempty" tfsdk:"readme"`
+	RunTransparency       bool                  `json:"runTransparency" tfsdk:"run_transparency"`
+	UseInLandingZonesOnly bool                  `json:"useInLandingZonesOnly" tfsdk:"use_in_landing_zones_only"`
+	SupportURL            *string               `json:"supportUrl,omitempty" tfsdk:"support_url"`
+	DocumentationURL      *string               `json:"documentationUrl,omitempty" tfsdk:"documentation_url"`
+	// NotificationSubscribers can also specify emails with prefix 'email:', so it's not only usernames (as the JSON field name suggests)!
+	NotificationSubscribers []string `json:"notificationSubscriberUsernames,omitempty" tfsdk:"notification_subscribers"`
+	Symbol                  *string  `json:"symbol,omitempty" tfsdk:"symbol"`
+	// SupportedPlatforms are currently platform types only. Specifying single platforms is currently unsupported.
+	// Have this list of string with a dedicated type, to convert it to/from Platform Type refs.
+	SupportedPlatforms []BuildingBlockDefinitionSupportedPlatform `json:"supportedPlatforms" tfsdk:"supported_platforms"`
+}
+
+type MeshBuildingBlockDefinitionStatusVersion struct {
+	VersionUuid   string                                  `json:"versionUuid"`
+	VersionNumber int64                                   `json:"versionNumber"`
+	State         MeshBuildingBlockDefinitionVersionState `json:"state"`
+}
+
+type MeshBuildingBlockDefinitionStatus struct {
+	UsageCount                *int64                                     `json:"usageCount"`
+	Versions                  []MeshBuildingBlockDefinitionStatusVersion `json:"versions"`
+	LatestVersion             int64                                      `json:"latestVersion"`
+	LatestVersionUuid         string                                     `json:"latestVersionUuid"`
+	LatestReleasedVersion     *int64                                     `json:"latestReleasedVersion"`
+	LatestReleasedVersionUuid *string                                    `json:"latestReleasedVersionUuid"`
+}
+
+type MeshBuildingBlockDefinition struct {
+	ApiVersion string                              `json:"apiVersion"`
+	Kind       string                              `json:"kind"`
+	Metadata   MeshBuildingBlockDefinitionMetadata `json:"metadata"`
+	Spec       MeshBuildingBlockDefinitionSpec     `json:"spec"`
+	Status     *MeshBuildingBlockDefinitionStatus  `json:"status,omitempty"`
+}
+
+type MeshBuildingBlockDefinitionClient interface {
+	List(ctx context.Context, workspaceIdentifier *string) ([]MeshBuildingBlockDefinition, error)
+	Read(ctx context.Context, uuid string) (*MeshBuildingBlockDefinition, error)
+	Create(ctx context.Context, definition MeshBuildingBlockDefinition) (*MeshBuildingBlockDefinition, error)
+	Update(ctx context.Context, uuid string, definition MeshBuildingBlockDefinition) (*MeshBuildingBlockDefinition, error)
+	Delete(ctx context.Context, uuid string) error
+}
+
+type meshBuildingBlockDefinitionClient struct {
+	meshObject internal.MeshObjectClient[MeshBuildingBlockDefinition]
+}
+
+func newBuildingBlockDefinitionClient(ctx context.Context, httpClient *internal.HttpClient) MeshBuildingBlockDefinitionClient {
+	return meshBuildingBlockDefinitionClient{
+		meshObject: internal.NewMeshObjectClient[MeshBuildingBlockDefinition](ctx, httpClient, "v1-preview"),
+	}
+}
+
+func (c meshBuildingBlockDefinitionClient) List(ctx context.Context, workspaceIdentifier *string) ([]MeshBuildingBlockDefinition, error) {
+	var options []internal.RequestOption
+	if workspaceIdentifier != nil {
+		options = append(options, internal.WithUrlQuery("workspaceIdentifier", *workspaceIdentifier))
+	}
+	return c.meshObject.List(ctx, options...)
+}
+
+func (c meshBuildingBlockDefinitionClient) Read(ctx context.Context, uuid string) (*MeshBuildingBlockDefinition, error) {
+	return c.meshObject.Get(ctx, uuid)
+}
+
+func (c meshBuildingBlockDefinitionClient) Create(ctx context.Context, definition MeshBuildingBlockDefinition) (*MeshBuildingBlockDefinition, error) {
+	definition.Kind = c.meshObject.Kind
+	definition.ApiVersion = c.meshObject.ApiVersion
+	return c.meshObject.Post(ctx, definition)
+}
+
+func (c meshBuildingBlockDefinitionClient) Update(ctx context.Context, uuid string, definition MeshBuildingBlockDefinition) (*MeshBuildingBlockDefinition, error) {
+	definition.Kind = c.meshObject.Kind
+	definition.ApiVersion = c.meshObject.ApiVersion
+	return c.meshObject.Put(ctx, uuid, definition)
+}
+
+func (c meshBuildingBlockDefinitionClient) Delete(ctx context.Context, uuid string) error {
+	return c.meshObject.Delete(ctx, uuid)
+}