fix: adds data_process_region field to online archive resource (#1634)

marcosuma · web-flow · commit 1e459ff65ae0 · 2023-11-22T11:01:18.000+01:00
* first commit to add the new fields.

* adds acceptance tests.

* fixes wrong name and adds migration test.

* fixes test expectations and updates documentation.

* changes to computed and optional to deal with migration.

* test.

* test.

* test.

* test.

* address comments.

* address comments.

* fix documentation.

* Update mongodbatlas/resource_mongodbatlas_online_archive.go
diff --git a/mongodbatlas/data_source_mongodbatlas_online_archive.go b/mongodbatlas/data_source_mongodbatlas_online_archive.go
@@ -130,6 +130,22 @@ func schemaOnlineArchive() map[string]*schema.Schema {
 				},
 			},
 		},
+		"data_process_region": {
+			Type:     schema.TypeList,
+			Computed: true,
+			Elem: &schema.Resource{
+				Schema: map[string]*schema.Schema{
+					"cloud_provider": {
+						Type:     schema.TypeString,
+						Computed: true,
+					},
+					"region": {
+						Type:     schema.TypeString,
+						Computed: true,
+					},
+				},
+			},
+		},
 		"schedule": {
 			Type:     schema.TypeList,
 			Computed: true,
diff --git a/mongodbatlas/resource_mongodbatlas_online_archive.go b/mongodbatlas/resource_mongodbatlas_online_archive.go
@@ -112,6 +112,28 @@ func getMongoDBAtlasOnlineArchiveSchema() map[string]*schema.Schema {
 				},
 			},
 		},
+		"data_process_region": {
+			Type:       schema.TypeList,
+			MinItems:   1,
+			MaxItems:   1,
+			ConfigMode: schema.SchemaConfigModeAttr,
+			Optional:   true,
+			Computed:   true,
+			Elem: &schema.Resource{
+				Schema: map[string]*schema.Schema{
+					"region": {
+						Type:     schema.TypeString,
+						Optional: true,
+						Computed: true,
+					},
+					"cloud_provider": {
+						Type:     schema.TypeString,
+						Optional: true,
+						Computed: true,
+					},
+				},
+			},
+		},
 		"schedule": {
 			Type:     schema.TypeList,
 			Optional: true,
@@ -367,6 +389,7 @@ func mapToArchivePayload(d *schema.ResourceData) admin.BackupOnlineArchiveCreate
 
 	requestInput.Criteria = mapCriteria(d)
 	requestInput.DataExpirationRule = mapDataExpirationRule(d)
+	requestInput.DataProcessRegion = mapDataProcessRegion(d)
 	requestInput.Schedule = mapSchedule(d)
 
 	if partitions, ok := d.GetOk("partition_fields"); ok {
@@ -410,12 +433,13 @@ func resourceMongoDBAtlasOnlineArchiveUpdate(ctx context.Context, d *schema.Reso
 	pausedHasChange := d.HasChange("paused")
 	criteriaHasChange := d.HasChange("criteria")
 	dataExpirationRuleHasChange := d.HasChange("data_expiration_rule")
+	dataProcessRegionHasChange := d.HasChange("data_process_region")
 	scheduleHasChange := d.HasChange("schedule")
 
 	collectionTypeHasChange := d.HasChange("collection_type")
 
 	// nothing to do, let's go
-	if !pausedHasChange && !criteriaHasChange && !collectionTypeHasChange && !scheduleHasChange && !dataExpirationRuleHasChange {
+	if !pausedHasChange && !criteriaHasChange && !collectionTypeHasChange && !scheduleHasChange && !dataExpirationRuleHasChange && !dataProcessRegionHasChange {
 		return nil
 	}
 
@@ -441,6 +465,15 @@ func resourceMongoDBAtlasOnlineArchiveUpdate(ctx context.Context, d *schema.Reso
 		}
 	}
 
+	if dataProcessRegionHasChange {
+		newDataProcessRegion := mapDataProcessRegion(d)
+		if newDataProcessRegion == nil {
+			request.DataProcessRegion = &admin.DataProcessRegion{}
+		} else {
+			request.DataProcessRegion = newDataProcessRegion
+		}
+	}
+
 	if scheduleHasChange {
 		request.Schedule = mapSchedule(d)
 	}
@@ -525,6 +558,15 @@ func fromOnlineArchiveToMap(in *admin.BackupOnlineArchive) map[string]any {
 		schemaVals["data_expiration_rule"] = []any{dataExpirationRule}
 	}
 
+	var dataProcessRegion map[string]any
+	if in.DataProcessRegion != nil && (in.DataProcessRegion.CloudProvider != nil || in.DataProcessRegion.Region != nil) {
+		dataProcessRegion = map[string]any{
+			"cloud_provider": in.DataProcessRegion.CloudProvider,
+			"region":         in.DataProcessRegion.Region,
+		}
+		schemaVals["data_process_region"] = []any{dataProcessRegion}
+	}
+
 	// partitions fields
 	if len(in.PartitionFields) == 0 {
 		return schemaVals
@@ -557,6 +599,21 @@ func mapDataExpirationRule(d *schema.ResourceData) *admin.DataExpirationRule {
 	return nil
 }
 
+func mapDataProcessRegion(d *schema.ResourceData) *admin.DataProcessRegion {
+	if dataProcessRegions, ok := d.GetOk("data_process_region"); ok && len(dataProcessRegions.([]any)) > 0 {
+		dataProcessRegion := dataProcessRegions.([]any)[0].(map[string]any)
+		result := admin.DataProcessRegion{}
+		if cloudProvider, ok := dataProcessRegion["cloud_provider"]; ok {
+			result.CloudProvider = pointy.String(cloudProvider.(string))
+		}
+		if region, ok := dataProcessRegion["region"]; ok {
+			result.Region = pointy.String(region.(string))
+		}
+		return &result
+	}
+	return nil
+}
+
 func mapCriteria(d *schema.ResourceData) admin.Criteria {
 	criteriaList := d.Get("criteria").([]any)
 
diff --git a/mongodbatlas/resource_mongodbatlas_online_archive_test.go b/mongodbatlas/resource_mongodbatlas_online_archive_test.go
@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"log"
 	"os"
+	"regexp"
 	"testing"
 	"time"
 
@@ -165,6 +166,55 @@ func TestAccBackupRSOnlineArchiveBasic(t *testing.T) {
 	})
 }
 
+func TestAccBackupRSOnlineArchiveWithProcessRegion(t *testing.T) {
+	var (
+		cluster                     matlas.Cluster
+		resourceName                = "mongodbatlas_cluster.online_archive_test"
+		onlineArchiveResourceName   = "mongodbatlas_online_archive.users_archive"
+		onlineArchiveDataSourceName = "data.mongodbatlas_online_archive.read_archive"
+		orgID                       = os.Getenv("MONGODB_ATLAS_ORG_ID")
+		projectName                 = acctest.RandomWithPrefix("test-acc")
+		name                        = fmt.Sprintf("test-acc-%s", acctest.RandString(10))
+		cloudProvider               = "AWS"
+	)
+
+	resource.ParallelTest(t, resource.TestCase{
+		PreCheck:                 func() { testAccPreCheckBasic(t) },
+		ProtoV6ProviderFactories: testAccProviderV6Factories,
+		CheckDestroy:             testAccCheckMongoDBAtlasClusterDestroy,
+		Steps: []resource.TestStep{
+			{
+				// We need this step to pupulate the cluster with Sample Data
+				// The online archive won't work if the cluster does not have data
+				Config: testAccBackupRSOnlineArchiveConfigFirstStep(orgID, projectName, name),
+				Check: resource.ComposeTestCheckFunc(
+					populateWithSampleData(resourceName, &cluster),
+				),
+			},
+			{
+				Config: testAccBackupRSOnlineArchiveConfigWithProcessRegion(orgID, projectName, name, cloudProvider, "SA_EAST_1"),
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttr(onlineArchiveResourceName, "data_process_region.0.cloud_provider", "AWS"),
+					resource.TestCheckResourceAttr(onlineArchiveResourceName, "data_process_region.0.region", "SA_EAST_1"),
+					resource.TestCheckResourceAttr(onlineArchiveDataSourceName, "data_process_region.0.cloud_provider", "AWS"),
+					resource.TestCheckResourceAttr(onlineArchiveDataSourceName, "data_process_region.0.region", "SA_EAST_1"),
+				),
+			},
+			{
+				Config:      testAccBackupRSOnlineArchiveConfigWithProcessRegion(orgID, projectName, name, cloudProvider, "AP_SOUTH_1"),
+				ExpectError: regexp.MustCompile("ONLINE_ARCHIVE_CANNOT_MODIFY_FIELD"),
+			},
+			{
+				Config: testAccBackupRSOnlineArchiveConfigWithoutSchedule(orgID, projectName, name),
+				Check: resource.ComposeTestCheckFunc(
+					resource.TestCheckResourceAttr(onlineArchiveResourceName, "data_process_region.0.cloud_provider", "AWS"),
+					resource.TestCheckResourceAttr(onlineArchiveResourceName, "data_process_region.0.region", "SA_EAST_1"),
+				),
+			},
+		},
+	})
+}
+
 func populateWithSampleData(resourceName string, cluster *matlas.Cluster) resource.TestCheckFunc {
 	return func(s *terraform.State) error {
 		conn := testMongoDBClient.(*MongoDBClient).Atlas
@@ -331,6 +381,59 @@ func testAccBackupRSOnlineArchiveConfigWithoutSchedule(orgID, projectName, clust
 	`, testAccBackupRSOnlineArchiveConfigFirstStep(orgID, projectName, clusterName))
 }
 
+func testAccBackupRSOnlineArchiveConfigWithProcessRegion(orgID, projectName, clusterName, cloudProvider, region string) string {
+	return fmt.Sprintf(`
+	%s
+	resource "mongodbatlas_online_archive" "users_archive" {
+		project_id = mongodbatlas_cluster.online_archive_test.project_id
+		cluster_name = mongodbatlas_cluster.online_archive_test.name
+		coll_name = "listingsAndReviews"
+		collection_type = "STANDARD"
+		db_name = "sample_airbnb"
+
+		criteria {
+			type = "DATE"
+			date_field = "last_review"
+			date_format = "ISODATE"
+			expire_after_days = 2
+		}
+
+		partition_fields {
+			field_name = "last_review"
+			order = 0
+		}
+
+		partition_fields {
+			field_name = "maximum_nights"
+			order = 1
+		}
+
+		partition_fields {
+			field_name = "name"
+			order = 2
+		}
+
+		data_process_region {
+			cloud_provider = %[2]q
+			region = %[3]q
+		}
+
+		sync_creation = true
+	}
+
+	data "mongodbatlas_online_archive" "read_archive" {
+		project_id =  mongodbatlas_online_archive.users_archive.project_id
+		cluster_name = mongodbatlas_online_archive.users_archive.cluster_name
+		archive_id = mongodbatlas_online_archive.users_archive.archive_id
+	}
+
+	data "mongodbatlas_online_archives" "all" {
+		project_id =  mongodbatlas_online_archive.users_archive.project_id
+		cluster_name = mongodbatlas_online_archive.users_archive.cluster_name
+	}
+	`, testAccBackupRSOnlineArchiveConfigFirstStep(orgID, projectName, clusterName), cloudProvider, region)
+}
+
 func testAccBackupRSOnlineArchiveConfigFirstStep(orgID, projectName, clusterName string) string {
 	return fmt.Sprintf(`
 	resource "mongodbatlas_project" "cluster_project" {
diff --git a/website/docs/d/online_archive.html.markdown b/website/docs/d/online_archive.html.markdown
@@ -36,6 +36,7 @@ data "mongodbatlas_online_archive" "test" {
 * `collection_type`  -  Type of MongoDB collection that you want to return. This value can be "TIMESERIES" or "STANDARD". Default is "STANDARD".
 * `criteria` - Criteria to use for archiving data. See [criteria](#criteria).
 * `data_expiration_rule` - Rule for specifying when data should be deleted from the archive. See [data expiration rule](#data-expiration-rule).
+* `data_process_region` - Settings to configure the region where you wish to store your archived data. See [data process region](#data-process-region).
 * `schedule` - Regular frequency and duration when archiving process occurs. See [schedule](#schedule).
 * `partition_fields` - Fields to use to partition data. You can specify up to two frequently queried fields to use for partitioning data. Queries that don’t contain the specified fields require a full collection scan of all archived documents, which takes longer and increases your costs. To learn more about how partition improves query performance, see [Data Structure in S3](https://docs.mongodb.com/datalake/admin/optimize-query-performance/#data-structure-in-s3). The value of a partition field can be up to a maximum of 700 characters. Documents with values exceeding 700 characters are not archived. See [partition fields](#partition).
 * `paused` - State of the online archive. This is required for pausing an active online archive or resuming a paused online archive. If the collection has another active online archive, the resume request fails.
@@ -51,6 +52,10 @@ data "mongodbatlas_online_archive" "test" {
 ### Data Expiration Rule
 * `expire_after_days` - Number of days used in the date criteria for nominating documents for deletion. Value must be between 7 and 9215.
 
+### Data Process Region
+* `cloud_provider` - Human-readable label that identifies the Cloud service provider where you wish to store your archived data.
+* `region` - Human-readable label that identifies the geographic location of the region where you wish to store your archived data. For allowed values, see [MongoDB Atlas API documentation](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/createOnlineArchive)
+
 
 ### Schedule
 
diff --git a/website/docs/d/online_archives.html.markdown b/website/docs/d/online_archives.html.markdown
@@ -41,6 +41,7 @@ In addition to all arguments above, the following attributes are exported:
 * `collection_type` - Type of MongoDB collection that you want to return. This value can be "TIMESERIES" or "STANDARD". Default is "STANDARD". 
 * `criteria` - Criteria to use for archiving data. See [criteria](#criteria).
 * `data_expiration_rule` - Rule for specifying when data should be deleted from the archive. See [data expiration rule](#data-expiration-rule).
+* `data_process_region` - Settings to configure the region where you wish to store your archived data. See [data process region](#data-process-region).
 * `schedule` - Regular frequency and duration when archiving process occurs. See [schedule](#schedule).
 * `partition_fields` - Fields to use to partition data. You can specify up to two frequently queried fields to use for partitioning data. Queries that don’t contain the specified fields require a full collection scan of all archived documents, which takes longer and increases your costs. To learn more about how partition improves query performance, see [Data Structure in S3](https://docs.mongodb.com/datalake/admin/optimize-query-performance/#data-structure-in-s3). The value of a partition field can be up to a maximum of 700 characters. Documents with values exceeding 700 characters are not archived. See [partition fields](#partition).
 * `paused` - State of the online archive. This is required for pausing an active online archive or resuming a paused online archive. If the collection has another active online archive, the resume request fails.
@@ -56,6 +57,10 @@ In addition to all arguments above, the following attributes are exported:
 ### Data Expiration Rule
 * `expire_after_days` - Number of days used in the date criteria for nominating documents for deletion. Value must be between 7 and 9215.
 
+### Data Process Region
+* `cloud_provider` - Human-readable label that identifies the Cloud service provider where you wish to store your archived data.
+* `region` - Human-readable label that identifies the geographic location of the region where you wish to store your archived data. For allowed values, see [MongoDB Atlas API documentation](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/createOnlineArchive)
+
 ### Schedule
 
 * `type` - Type of schedule (`DAILY`, `MONTHLY`, `WEEKLY`).
diff --git a/website/docs/r/online_archive.html.markdown b/website/docs/r/online_archive.html.markdown
@@ -86,6 +86,7 @@ resource "mongodbatlas_online_archive" "test" {
 * `collection_type` - Type of MongoDB collection that you want to return. This value can be "TIMESERIES" or "STANDARD". Default is "STANDARD". 
 * `criteria` - (Required) Criteria to use for archiving data. See [criteria](#criteria).
 * `data_expiration_rule` - (Optional) Rule for specifying when data should be deleted from the archive. See [data expiration rule](#data-expiration-rule).
+* `data_process_region` - (Optional) Settings to configure the region where you wish to store your archived data. See [data process region](#data-process-region). This field is immutable hence cannot be updated.
 * `schedule` - Regular frequency and duration when archiving process occurs. See [schedule](#schedule).
 * `partition_fields` - (Recommended) Fields to use to partition data. You can specify up to two frequently queried fields to use for partitioning data. Queries that don’t contain the specified fields require a full collection scan of all archived documents, which takes longer and increases your costs. To learn more about how partition improves query performance, see [Data Structure in S3](https://docs.mongodb.com/datalake/admin/optimize-query-performance/#data-structure-in-s3). The value of a partition field can be up to a maximum of 700 characters. Documents with values exceeding 700 characters are not archived. See [partition fields](#partition).
 * `paused` - (Optional) State of the online archive. This is required for pausing an active online archive or resuming a paused online archive. If the collection has another active online archive, the resume request fails.
@@ -113,6 +114,10 @@ The only field required for criteria type `CUSTOM`
 
 * `expire_after_days` - Number of days used in the date criteria for nominating documents for deletion. Value must be between 7 and 9215.
 
+### Data Process Region
+* `cloud_provider` - Human-readable label that identifies the Cloud service provider where you wish to store your archived data.
+* `region` - Human-readable label that identifies the geographic location of the region where you wish to store your archived data. For allowed values, see [MongoDB Atlas API documentation](https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/createOnlineArchive)
+
 ### Schedule
 
 * `type`          - Type of schedule (``DAILY`, `MONTHLY`, `WEEKLY`).
