New Resource: azurerm_email_communication_service_domain (#26179)

* New Resource: `azurerm_email_communication_service_domain` * Update internal/services/communication/client/client.go Co-authored-by: jackofallops <[email protected]> * Update internal/services/communication/helper/domain_record.go Co-authored-by: jackofallops <[email protected]> * Update internal/services/communication/email_service_domain_resource_test.go Co-authored-by: jackofallops <[email protected]> * Update internal/services/communication/email_service_domain_resource_test.go Co-authored-by: jackofallops <[email protected]> * Update internal/services/communication/email_service_domain_resource_test.go Co-authored-by: jackofallops <[email protected]> * Update internal/services/communication/email_service_domain_resource.go Co-authored-by: jackofallops <[email protected]> * Update internal/services/communication/email_service_domain_resource.go Co-authored-by: jackofallops <[email protected]> * Update internal/services/communication/helper/domain_record.go Co-authored-by: jackofallops <[email protected]> * New Resource: `azurerm_email_communication_service_domain` * make terrafmt * added empty list test * remove linked_domain property --------- Co-authored-by: jackofallops <[email protected]>
hashicorp · Jun 21, 2024 · 3c25ede · 3c25ede
1 parent 23e0ec3
commit 3c25ede
Show file tree

Hide file tree

Showing 30 changed files with 2,020 additions and 0 deletions.
diff --git a/internal/services/communication/client/client.go b/internal/services/communication/client/client.go
@@ -7,6 +7,7 @@ import (
 	"fmt"
 
 	"github.com/hashicorp/go-azure-sdk/resource-manager/communication/2023-03-31/communicationservices"
+	"github.com/hashicorp/go-azure-sdk/resource-manager/communication/2023-03-31/domains"
 	"github.com/hashicorp/go-azure-sdk/resource-manager/communication/2023-03-31/emailservices"
 	"github.com/hashicorp/terraform-provider-azurerm/internal/common"
 )
@@ -15,6 +16,7 @@ type Client struct {
 	ServiceClient *communicationservices.CommunicationServicesClient
 
 	EmailServicesClient *emailservices.EmailServicesClient
+	DomainClient        *domains.DomainsClient
 }
 
 func NewClient(o *common.ClientOptions) (*Client, error) {
@@ -30,8 +32,15 @@ func NewClient(o *common.ClientOptions) (*Client, error) {
 	}
 	o.Configure(emailServicesClient.Client, o.Authorizers.ResourceManager)
 
+	domainsClient, err := domains.NewDomainsClientWithBaseURI(o.Environment.ResourceManager)
+	if err != nil {
+		return nil, fmt.Errorf("building Domais client: %+v", err)
+	}
+	o.Configure(domainsClient.Client, o.Authorizers.ResourceManager)
+
 	return &Client{
 		ServiceClient:       servicesClient,
 		EmailServicesClient: emailServicesClient,
+		DomainClient:        domainsClient,
 	}, nil
 }
diff --git a/internal/services/communication/email_service_domain_resource.go b/internal/services/communication/email_service_domain_resource.go
@@ -0,0 +1,313 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+package communication
+
+import (
+	"context"
+	"fmt"
+	"time"
+
+	"github.com/hashicorp/go-azure-helpers/lang/pointer"
+	"github.com/hashicorp/go-azure-helpers/lang/response"
+	"github.com/hashicorp/go-azure-helpers/resourcemanager/commonschema"
+	"github.com/hashicorp/go-azure-helpers/resourcemanager/location"
+	"github.com/hashicorp/go-azure-sdk/resource-manager/communication/2023-03-31/domains"
+	"github.com/hashicorp/go-azure-sdk/resource-manager/communication/2023-03-31/emailservices"
+	"github.com/hashicorp/terraform-provider-azurerm/internal/sdk"
+	"github.com/hashicorp/terraform-provider-azurerm/internal/services/communication/helper"
+	"github.com/hashicorp/terraform-provider-azurerm/internal/tf/pluginsdk"
+	"github.com/hashicorp/terraform-provider-azurerm/internal/tf/validation"
+)
+
+var _ sdk.ResourceWithUpdate = EmailCommunicationServiceDomainResource{}
+
+type EmailCommunicationServiceDomainResource struct{}
+
+type EmailCommunicationServiceDomainResourceModel struct {
+	Name                          string            `tfschema:"name"`
+	EMailServiceID                string            `tfschema:"email_service_id"`
+	DomainManagement              string            `tfschema:"domain_management"`
+	UserEngagementTrackingEnabled bool              `tfschema:"user_engagement_tracking_enabled"`
+	Tags                          map[string]string `tfschema:"tags"`
+
+	FromSenderDomain     string                           `tfschema:"from_sender_domain"`
+	MailFromSenderDomain string                           `tfschema:"mail_from_sender_domain"`
+	VerificationRecords  []EmailDomainVerificationRecords `tfschema:"verification_records"`
+}
+
+type EmailDomainVerificationRecords struct {
+	Domain []helper.DomainVerificationRecords `tfschema:"domain"`
+	SPF    []helper.DomainVerificationRecords `tfschema:"spf"`
+	DMARC  []helper.DomainVerificationRecords `tfschema:"dmarc"`
+	DKIM   []helper.DomainVerificationRecords `tfschema:"dkim"`
+	DKIM2  []helper.DomainVerificationRecords `tfschema:"dkim2"`
+}
+
+func (EmailCommunicationServiceDomainResource) Arguments() map[string]*pluginsdk.Schema {
+	return map[string]*pluginsdk.Schema{
+		"name": {
+			Type:     pluginsdk.TypeString,
+			Required: true,
+			ForceNew: true,
+		},
+
+		"email_service_id": {
+			Type:         pluginsdk.TypeString,
+			Required:     true,
+			ForceNew:     true,
+			ValidateFunc: domains.ValidateEmailServiceID,
+		},
+
+		"domain_management": {
+			Type:         pluginsdk.TypeString,
+			Required:     true,
+			ForceNew:     true,
+			ValidateFunc: validation.StringInSlice(domains.PossibleValuesForDomainManagement(), false),
+		},
+
+		"user_engagement_tracking_enabled": {
+			Type:     pluginsdk.TypeBool,
+			Optional: true,
+		},
+
+		"tags": commonschema.Tags(),
+	}
+}
+
+func (EmailCommunicationServiceDomainResource) Attributes() map[string]*pluginsdk.Schema {
+	return map[string]*pluginsdk.Schema{
+		"from_sender_domain": {
+			Type:     pluginsdk.TypeString,
+			Computed: true,
+		},
+
+		"mail_from_sender_domain": {
+			Type:     pluginsdk.TypeString,
+			Computed: true,
+		},
+
+		"verification_records": {
+			Type:     pluginsdk.TypeList,
+			Computed: true,
+			Elem: &pluginsdk.Resource{
+				Schema: map[string]*pluginsdk.Schema{
+					"domain": helper.DomainVerificationRecordsCommonSchema(),
+					"dkim":   helper.DomainVerificationRecordsCommonSchema(),
+					"dkim2":  helper.DomainVerificationRecordsCommonSchema(),
+					"dmarc":  helper.DomainVerificationRecordsCommonSchema(),
+					"spf":    helper.DomainVerificationRecordsCommonSchema(),
+				},
+			},
+		},
+	}
+}
+
+func (EmailCommunicationServiceDomainResource) ModelObject() interface{} {
+	return &EmailCommunicationServiceDomainResourceModel{}
+}
+
+func (EmailCommunicationServiceDomainResource) ResourceType() string {
+	return "azurerm_email_communication_service_domain"
+}
+
+func (r EmailCommunicationServiceDomainResource) Create() sdk.ResourceFunc {
+	return sdk.ResourceFunc{
+		Timeout: 30 * time.Minute,
+		Func: func(ctx context.Context, metadata sdk.ResourceMetaData) error {
+			subscriptionId := metadata.Client.Account.SubscriptionId
+			client := metadata.Client.Communication.DomainClient
+
+			var model EmailCommunicationServiceDomainResourceModel
+			if err := metadata.Decode(&model); err != nil {
+				return err
+			}
+
+			eMailServiceID, err := emailservices.ParseEmailServiceID(model.EMailServiceID)
+			if err != nil {
+				return fmt.Errorf("parsing parent email_service_id: %+v", err)
+			}
+
+			id := domains.NewDomainID(subscriptionId, eMailServiceID.ResourceGroupName, eMailServiceID.EmailServiceName, model.Name)
+
+			existing, err := client.Get(ctx, id)
+			if err != nil && !response.WasNotFound(existing.HttpResponse) {
+				return fmt.Errorf("checking for presence of existing %s: %+v", id, err)
+			}
+			if !response.WasNotFound(existing.HttpResponse) {
+				return metadata.ResourceRequiresImport(r.ResourceType(), id)
+			}
+
+			properties := &domains.DomainProperties{
+				DomainManagement: domains.DomainManagement(model.DomainManagement),
+			}
+
+			properties.UserEngagementTracking = pointer.To(domains.UserEngagementTrackingDisabled)
+			if model.UserEngagementTrackingEnabled {
+				properties.UserEngagementTracking = pointer.To(domains.UserEngagementTrackingEnabled)
+			}
+
+			param := domains.DomainResource{
+				// The location is always `global` from the Azure Portal
+				Location:   location.Normalize("global"),
+				Properties: properties,
+				Tags:       pointer.To(model.Tags),
+			}
+
+			if err := client.CreateOrUpdateThenPoll(ctx, id, param); err != nil {
+				return fmt.Errorf("creating %s: %+v", id, err)
+			}
+
+			metadata.SetID(id)
+
+			return nil
+		},
+	}
+}
+
+func (r EmailCommunicationServiceDomainResource) Update() sdk.ResourceFunc {
+	return sdk.ResourceFunc{
+		Timeout: 30 * time.Minute,
+		Func: func(ctx context.Context, metadata sdk.ResourceMetaData) error {
+			client := metadata.Client.Communication.DomainClient
+
+			var model EmailCommunicationServiceDomainResourceModel
+
+			if err := metadata.Decode(&model); err != nil {
+				return err
+			}
+
+			id, err := domains.ParseDomainID(metadata.ResourceData.Id())
+			if err != nil {
+				return err
+			}
+
+			existing, err := client.Get(ctx, *id)
+			if err != nil || existing.Model == nil {
+				return fmt.Errorf("retrieving %s: %+v", *id, err)
+			}
+
+			domain := *existing.Model
+
+			props := pointer.From(domain.Properties)
+
+			if metadata.ResourceData.HasChange("user_engagement_tracking_enabled") {
+				userEngagementTracking := domains.UserEngagementTrackingDisabled
+				if model.UserEngagementTrackingEnabled {
+					userEngagementTracking = domains.UserEngagementTrackingEnabled
+				}
+
+				props.UserEngagementTracking = pointer.To(userEngagementTracking)
+			}
+
+			if metadata.ResourceData.HasChange("tags") {
+				domain.Tags = pointer.To(model.Tags)
+			}
+
+			domain.Properties = &props
+
+			if err := client.CreateOrUpdateThenPoll(ctx, *id, domain); err != nil {
+				return fmt.Errorf("updating %s: %+v", id, err)
+			}
+
+			return nil
+		},
+	}
+}
+
+func (EmailCommunicationServiceDomainResource) Read() sdk.ResourceFunc {
+	return sdk.ResourceFunc{
+		Timeout: 5 * time.Minute,
+		Func: func(ctx context.Context, metadata sdk.ResourceMetaData) error {
+			client := metadata.Client.Communication.DomainClient
+
+			state := EmailCommunicationServiceDomainResourceModel{}
+
+			id, err := domains.ParseDomainID(metadata.ResourceData.Id())
+			if err != nil {
+				return err
+			}
+
+			resp, err := client.Get(ctx, *id)
+			if err != nil {
+				if response.WasNotFound(resp.HttpResponse) {
+					return metadata.MarkAsGone(id)
+				}
+
+				return fmt.Errorf("retrieving %s: %+v", id, err)
+			}
+
+			state.Name = id.DomainName
+			state.EMailServiceID = emailservices.NewEmailServiceID(id.SubscriptionId, id.ResourceGroupName, id.EmailServiceName).ID()
+
+			if model := resp.Model; model != nil {
+				if props := model.Properties; props != nil {
+					state.DomainManagement = string(props.DomainManagement)
+
+					state.FromSenderDomain = pointer.From(props.FromSenderDomain)
+
+					state.MailFromSenderDomain = pointer.From(props.MailFromSenderDomain)
+
+					if props.UserEngagementTracking != nil {
+						state.UserEngagementTrackingEnabled = *props.UserEngagementTracking == domains.UserEngagementTrackingEnabled
+
+					}
+
+					domainVerificationRecords := EmailDomainVerificationRecords{}
+
+					if verificationRecords := props.VerificationRecords; verificationRecords != nil {
+						if record := verificationRecords.DKIM; record != nil {
+							domainVerificationRecords.DKIM = helper.DomainVerificationRecordsToModel(record)
+						}
+
+						if record := verificationRecords.DKIM2; record != nil {
+							domainVerificationRecords.DKIM2 = helper.DomainVerificationRecordsToModel(record)
+						}
+
+						if record := verificationRecords.DMARC; record != nil {
+							domainVerificationRecords.DMARC = helper.DomainVerificationRecordsToModel(record)
+						}
+
+						if record := verificationRecords.Domain; record != nil {
+							domainVerificationRecords.Domain = helper.DomainVerificationRecordsToModel(record)
+						}
+
+						if record := verificationRecords.SPF; record != nil {
+							domainVerificationRecords.SPF = helper.DomainVerificationRecordsToModel(record)
+						}
+					}
+
+					state.VerificationRecords = []EmailDomainVerificationRecords{domainVerificationRecords}
+				}
+
+				state.Tags = pointer.From(model.Tags)
+			}
+
+			return metadata.Encode(&state)
+		},
+	}
+}
+
+func (EmailCommunicationServiceDomainResource) Delete() sdk.ResourceFunc {
+	return sdk.ResourceFunc{
+		Timeout: 30 * time.Minute,
+		Func: func(ctx context.Context, metadata sdk.ResourceMetaData) error {
+			client := metadata.Client.Communication.DomainClient
+
+			id, err := domains.ParseDomainID(metadata.ResourceData.Id())
+			if err != nil {
+				return err
+			}
+
+			if err := client.DeleteThenPoll(ctx, *id); err != nil {
+				return fmt.Errorf("deleting %s: %+v", *id, err)
+			}
+
+			return nil
+		},
+	}
+}
+
+func (EmailCommunicationServiceDomainResource) IDValidationFunc() pluginsdk.SchemaValidateFunc {
+	return domains.ValidateDomainID
+}