Merge pull request #757 from SumoLogic/raghav-fix-disallow-updates-to-partitions-tier

SUMO-258848: disallow updates to partition's analytics tier other than in case of flex migration

Author: raghavxk

CHANGELOG.md

@@ -4,6 +4,10 @@
 FEATURES:
 * **New Data Source:** sumologic_apps
 
+BUG FIXES:
+* Prevent user-initiated updates to the analytics_tier field in the partition resource, while allowing Terraform to reconcile state changes resulting from backend-driven updates (e.g., Flex migrations).
+
+
 ENHANCEMENTS:
 * Improve error message when an API URL is constructed with missing parameters
 

sumologic/resource_sumologic_partition.go

@@ -1,6 +1,7 @@
 package sumologic
 
 import (
+	"fmt"
 	"log"
 	"strings"
 
@@ -135,11 +136,23 @@ func resourceSumologicPartitionDelete(d *schema.ResourceData, meta interface{})
 	return c.DecommissionPartition(d.Id())
 }
 func resourceSumologicPartitionUpdate(d *schema.ResourceData, meta interface{}) error {
+	c := meta.(*Client)
+
+	partitionId := d.Id()
+
 	spartition := resourceToPartition(d)
+	if d.HasChange("analytics_tier") {
+		currPartitionState, err := c.GetPartition(partitionId)
+		if err != nil {
+			return fmt.Errorf("error loading partition with id %s for analytics_tier update validation", partitionId)
+		}
 
-	c := meta.(*Client)
-	err := c.UpdatePartition(spartition)
+		if !areAnalyticsTierEqual(currPartitionState.AnalyticsTier, spartition.AnalyticsTier) {
+			return fmt.Errorf("analytics_tier of a partition can only be updated post creation if partition has been moved to flex tier")
+		}
+	}
 
+	err := c.UpdatePartition(spartition)
 	if err != nil {
 		return err
 	}
@@ -183,3 +196,15 @@ func resourceToPartition(d *schema.ResourceData) Partition {
 		IsIncludedInDefaultSearch:        isIncludedInDefaultSearchPtr,
 	}
 }
+
+func areAnalyticsTierEqual(a, b *string) bool {
+	coerceToStr := func(s *string) string {
+		if s == nil {
+			return ""
+		}
+		return *s
+	}
+
+	return strings.EqualFold(coerceToStr(a), coerceToStr(b))
+}
+

sumologic/resource_sumologic_partition_test.go

@@ -2,6 +2,7 @@ package sumologic
 
 import (
 	"fmt"
+	"regexp"
 	"testing"
 
 	"github.com/hashicorp/terraform-plugin-sdk/helper/acctest"
@@ -50,6 +51,28 @@ func TestAccSumoLogicPartition_basic(t *testing.T) {
 						"sumologic_partition.foo", "is_compliant", "false"),
 				),
 			},
+			// allow change in casing of analytics_tier
+			{
+				Config: updatePartitionAnalyticsTierCase(testName),
+				Check: resource.ComposeTestCheckFunc(
+					testAccCheckPartitionExists("sumologic_partition.foo"),
+					resource.TestCheckResourceAttr(
+						"sumologic_partition.foo", "name", "terraform_acctest_"+testName),
+					resource.TestCheckResourceAttr(
+						"sumologic_partition.foo", "routing_expression", "_sourcecategory=*/Terraform"),
+					resource.TestCheckResourceAttr(
+						"sumologic_partition.foo", "analytics_tier", "continuous"),
+					resource.TestCheckResourceAttr(
+						"sumologic_partition.foo", "retention_period", "366"),
+					resource.TestCheckResourceAttr(
+						"sumologic_partition.foo", "is_compliant", "false"),
+				),
+			},
+			// Update analytics tier to a different value and assert error
+			{
+				Config:      updatePartitionAnalyticsTierConfig(testName),
+				ExpectError: regexp.MustCompile(`(?i)analytics_tier of a partition can only be updated post creation if partition has been moved to flex tier`),
+			},
 		},
 	})
 }
@@ -107,3 +130,27 @@ resource "sumologic_partition" "foo" {
 }
 `, testName)
 }
+
+func updatePartitionAnalyticsTierConfig(testName string) string {
+	return fmt.Sprintf(`
+resource "sumologic_partition" "foo" {
+    name = "terraform_acctest_%s"
+    routing_expression = "_sourcecategory=*/Terraform"
+	retention_period = 365
+	is_compliant = false
+	analytics_tier = "infrequent" // Changed from "continuous" to trigger error
+}
+`, testName)
+}
+
+func updatePartitionAnalyticsTierCase(testName string) string {
+	return fmt.Sprintf(`
+	resource "sumologic_partition" "foo" {
+		name = "terraform_acctest_%s"
+		routing_expression = "_sourcecategory=*/Terraform"
+		retention_period = 366
+		is_compliant = false
+		analytics_tier = "ContinuouS" // Changed case for "continuous"
+	}
+	`, testName)
+}

website/docs/r/partition.html.markdown

@@ -29,6 +29,7 @@ The following arguments are supported:
 - `name` - (Required, Forces new resource) The name of the partition.
 - `routing_expression` - (Required) The query that defines the data to be included in the partition.
 - `analytics_tier` - (Optional) The cloud flex analytics tier for your data; only relevant if your account has basic analytics enabled. If no value is supplied, partition will be created in continuous tier. Other possible values are : "frequent" and "infrequent". For flex partition, you can leave it empty or send flex.
+This field is set during partition creation and cannot be modified later by the user. However, Terraform can detect and reconcile backend-driven changes, such as those resulting from a Flex migration.
 - `retention_period` - (Optional) The number of days to retain data in the partition, or -1 to use the default value for your account. Only relevant if your account has variable retention enabled.
 - `is_compliant` - (Optional) Whether the partition is compliant or not. Mark a partition as compliant if it contains data used for compliance or audit purpose. Retention for a compliant partition can only be increased and cannot be reduced after the partition is marked compliant. A partition once marked compliant, cannot be marked non-compliant later.
 - `reduce_retention_period_immediately` - (Optional) This is required on update if the newly specified retention period is less than the existing retention period. In such a situation, a value of true says that data between the existing retention period and the new retention period should be deleted immediately; if false, such data will be deleted after seven days. This property is optional and ignored if the specified retentionPeriod is greater than or equal to the current retention period.