Bug fix - purge_trigger and purge_queue bugs in Queue provider

Author: Mohini Limbodia

examples/queue/main.tf

@@ -25,35 +25,36 @@ resource "oci_queue_queue" "test_queue1" {
   #Optional
   custom_encryption_key_id         = var.queue_custom_encryption_key_id # We can have dependency on the oci_kms_key and get the key id from that
   dead_letter_queue_delivery_count = var.queue_dead_letter_queue_delivery_count
+  purge_trigger                    = var.purge_trigger
+  purge_type                       = var.purge_type
   freeform_tags                    = var.queue_freeform_tags
   retention_in_seconds             = var.queue_retention_in_seconds
   timeout_in_seconds               = var.queue_timeout_in_seconds
   visibility_in_seconds            = var.queue_visibility_in_seconds
   channel_consumption_limit        = var.queue_channel_consumption_limit
 }
 
-# Purging the queue immediately after create if requried. We are using the purge queue optional parameter
+# Purging the queue immediately after create if required. Queue is purged if purge trigger is set to any integer value. We are using the purge trigger and purge type optional parameter.
+# We are purging the queue immediately after create.
 resource "oci_queue_queue" "test_queue2" {
   #Required
   compartment_id = var.compartment_id
   display_name   = var.queue_display_name
 
   #Optional
-  purge_queue = true
+  purge_trigger = 1
   purge_type = "normal"
 
 }
 
-# Normal queue creation if purge queue parameter is set to false. This will not trigger the purge queue operation. In addition, presence of purge type if purge queue is false or absent is a no-op.
+# Normal queue creation if purge trigger parameter is unset. This will not trigger the purge queue operation. In addition, presence of purge type if purge trigger is unset is a no-op.
 resource "oci_queue_queue" "test_queue3" {
   #Required
   compartment_id = var.compartment_id
   display_name   = var.queue_display_name
 
   #Optional
-  purge_queue = false
   purge_type = "normal"
-
 }
 
 data "oci_queue_queues" "test_queues" {

examples/queue/variables.tf

@@ -48,4 +48,12 @@ variable "queue_visibility_in_seconds" {
 
 variable "queue_channel_consumption_limit" {
   default = 10
+}
+
+variable "purge_type" {
+  default = "NORMAL"
+}
+
+variable "purge_trigger" {
+  default = 1
 }

internal/integrationtest/queue_queue_test.go

@@ -182,13 +182,14 @@ func TestQueueQueueResource_basic(t *testing.T) {
 			Config: config + compartmentIdVariableStr + customEncryptionKeyIdVariableStr + compartmentIdUVariableStr + QueueQueueResourceDependencies +
 				acctest.GenerateResourceFromRepresentationMap("oci_queue_queue", "test_queue", acctest.Optional, acctest.Create,
 					acctest.RepresentationCopyWithNewProperties(QueueQueueRepresentation, map[string]interface{}{
-						"purge_queue": acctest.Representation{RepType: acctest.Required, Create: `true`},
-						"purge_type":  acctest.Representation{RepType: acctest.Required, Create: `normal`},
+						"purge_trigger": acctest.Representation{RepType: acctest.Required, Create: `0`},
+						"purge_type":    acctest.Representation{RepType: acctest.Required, Create: `normal`},
 					})),
 			Check: acctest.ComposeAggregateTestCheckFuncWrapper(
 				resource.TestCheckResourceAttr(resourceName, "compartment_id", compartmentId),
 				resource.TestCheckResourceAttrSet(resourceName, "custom_encryption_key_id"),
-				resource.TestCheckResourceAttrSet(resourceName, "purge_queue"),
+				resource.TestCheckResourceAttr(resourceName, "purge_trigger", "0"),
+				resource.TestCheckResourceAttr(resourceName, "purge_type", "normal"),
 				resource.TestCheckResourceAttr(resourceName, "dead_letter_queue_delivery_count", "10"),
 				resource.TestCheckResourceAttr(resourceName, "display_name", "displayName"),
 				resource.TestCheckResourceAttr(resourceName, "freeform_tags.%", "1"),
@@ -211,15 +212,16 @@ func TestQueueQueueResource_basic(t *testing.T) {
 			),
 		},
 
-		// verify updates to updatable parameters and we are not setting  the purge queue related
-		// parameters. So it should not trigger purge queue.
+		// verify updates to updatable parameters and we are not setting the purge trigger and purge_type parameters.
+		// so it should not trigger purge queue.
 		{
 			Config: config + compartmentIdVariableStr + customEncryptionKeyIdVariableStr + QueueQueueResourceDependencies +
 				acctest.GenerateResourceFromRepresentationMap("oci_queue_queue", "test_queue", acctest.Optional, acctest.Update, QueueQueueRepresentation),
 			Check: acctest.ComposeAggregateTestCheckFuncWrapper(
 				resource.TestCheckResourceAttr(resourceName, "channel_consumption_limit", "11"),
 				resource.TestCheckResourceAttr(resourceName, "compartment_id", compartmentId),
 				resource.TestCheckResourceAttrSet(resourceName, "custom_encryption_key_id"),
+				resource.TestCheckResourceAttr(resourceName, "purge_trigger", "0"),
 				resource.TestCheckResourceAttr(resourceName, "dead_letter_queue_delivery_count", "11"),
 				resource.TestCheckResourceAttr(resourceName, "display_name", "displayName2"),
 				resource.TestCheckResourceAttr(resourceName, "freeform_tags.%", "1"),
@@ -287,7 +289,7 @@ func TestQueueQueueResource_basic(t *testing.T) {
 			ImportState:       true,
 			ImportStateVerify: true,
 			ImportStateVerifyIgnore: []string{
-				"purge_queue",
+				"purge_trigger",
 				"purge_type",
 			},
 			ResourceName: resourceName,

internal/service/queue/queue_queue_resource.go

@@ -85,10 +85,11 @@ func QueueQueueResource() *schema.Resource {
 				Optional: true,
 				Computed: true,
 			},
-			"purge_queue": {
-				Type:     schema.TypeBool,
+			"purge_trigger": {
+				Type:     schema.TypeInt,
 				Optional: true,
 			},
+			// purge_type is an optional value that can be one of [NORMAL, DLQ, BOTH], default: normal
 			"purge_type": {
 				Type:     schema.TypeString,
 				Optional: true,
@@ -133,14 +134,16 @@ func createQueueQueue(d *schema.ResourceData, m interface{}) error {
 		return e
 	}
 
-	if value, ok := sync.D.GetOkExists("purge_queue"); ok && value.(bool) {
+	// Purging the queue immediately after creating is optional and is done if purge_trigger is set
+	// Call purge_queue if "purge_trigger" exists
+	if _, ok := sync.D.GetOk("purge_trigger"); ok {
 		err := sync.PurgeQueue()
 		if err != nil {
 			return err
 		}
 	}
-	return nil
 
+	return nil
 }
 
 func readQueueQueue(d *schema.ResourceData, m interface{}) error {
@@ -156,11 +159,20 @@ func updateQueueQueue(d *schema.ResourceData, m interface{}) error {
 	sync.D = d
 	sync.Client = m.(*client.OracleClients).QueueAdminClient()
 
-	// Checking only if the purge queue key exists in configuration and is set to true.
-	if value, ok := sync.D.GetOkExists("purge_queue"); ok && value.(bool) {
-		err := sync.PurgeQueue()
-		if err != nil {
-			return err
+	// Check if purge_trigger has a change and call purge_queue if the new value is greater than old value
+	if _, ok := sync.D.GetOk("purge_trigger"); ok && sync.D.HasChange("purge_trigger") {
+		oldRaw, newRaw := sync.D.GetChange("purge_trigger")
+		oldValue := oldRaw.(int)
+		newValue := newRaw.(int)
+		if newValue > oldValue {
+			err := sync.PurgeQueue()
+			if err != nil {
+				return err
+			}
+		} else {
+			// Set the value back to the old value in Terraform state
+			sync.D.Set("purge_trigger", oldRaw)
+			return fmt.Errorf("new value of purge_trigger should be greater than the old value to trigger purge")
 		}
 	}
 
@@ -603,6 +615,13 @@ func (s *QueueQueueResourceCrud) PurgeQueue() error {
 		request.PurgeType, _ = oci_queue.GetMappingPurgeQueueDetailsPurgeTypeEnum(purgeType.(string))
 	}
 
+	// Check if "purge_type" exists in the state and set its value in the request, set default NORMAL
+	if purgeType, ok := s.D.GetOk("purge_type"); ok {
+		request.PurgeType, _ = oci_queue.GetMappingPurgeQueueDetailsPurgeTypeEnum(purgeType.(string))
+	} else {
+		request.PurgeType, _ = oci_queue.GetMappingPurgeQueueDetailsPurgeTypeEnum("NORMAL")
+	}
+
 	idTmp := s.D.Id()
 	request.QueueId = &idTmp
 
@@ -617,9 +636,6 @@ func (s *QueueQueueResourceCrud) PurgeQueue() error {
 		return waitErr
 	}
 
-	val := s.D.Get("purge_queue")
-	s.D.Set("purge_queue", val)
-
 	workId := response.OpcWorkRequestId
 	return s.getQueueFromWorkRequest(workId, tfresource.GetRetryPolicy(s.DisableNotFoundRetries, "queue"), oci_queue.ActionTypeUpdated, s.D.Timeout(schema.TimeoutUpdate))
 }

website/docs/r/queue_queue.html.markdown

@@ -25,6 +25,8 @@ resource "oci_queue_queue" "test_queue" {
 	channel_consumption_limit = var.queue_channel_consumption_limit
 	custom_encryption_key_id = oci_kms_key.test_key.id
 	dead_letter_queue_delivery_count = var.queue_dead_letter_queue_delivery_count
+	purge_trigger = var.purge_trigger
+	purge_type = var.purge_type
 	defined_tags = {"foo-namespace.bar-key"= "value"}
 	freeform_tags = {"bar-key"= "value"}
 	retention_in_seconds = var.queue_retention_in_seconds
@@ -48,7 +50,7 @@ The following arguments are supported:
 * `timeout_in_seconds` - (Optional) (Updatable) The default polling timeout of the messages in the queue, in seconds.
 * `visibility_in_seconds` - (Optional) (Updatable) The default visibility timeout of the messages consumed from the queue, in seconds.
 * `purge_trigger` - (Optional) (Updatable) An optional property when incremented triggers Purge. Could be set to any integer value.
-
+* `purge_type` - (Optional) (Updatable) An optional value that specifies the purge behavior for the Queue. Could be set to NORMAL, DLQ or BOTH. If unset, the default value is NORMAL
 
 ** IMPORTANT **
 Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values