Added - Support for Cancel a full or incremental automatic backup

Author: alex-mui

internal/integrationtest/database_backup_cancel_management_test.go

@@ -0,0 +1,137 @@
+// Copyright (c) 2017, 2023, Oracle and/or its affiliates. All rights reserved.
+// Licensed under the Mozilla Public License v2.0
+
+package integrationtest
+
+import (
+	"context"
+	"fmt"
+	"testing"
+	"time"
+
+	"github.com/oracle/terraform-provider-oci/internal/acctest"
+	"github.com/oracle/terraform-provider-oci/internal/client"
+	"github.com/oracle/terraform-provider-oci/internal/utils"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/terraform"
+	"github.com/oracle/oci-go-sdk/v65/common"
+	oci_database "github.com/oracle/oci-go-sdk/v65/database"
+
+	"github.com/oracle/terraform-provider-oci/httpreplay"
+)
+
+var (
+	DatabaseCancelExacsBackupDatabaseRepresentation = map[string]interface{}{
+		"backup_id":             acctest.Representation{RepType: acctest.Required, Create: `unknown`},
+		"cancel_backup_trigger": acctest.Representation{RepType: acctest.Optional, Create: `1`},
+	}
+
+	GetBackupIdDataSourceRepresentation = map[string]interface{}{
+		"database_id": acctest.Representation{RepType: acctest.Optional, Create: `${oci_database_database.test_database.id}`},
+	}
+
+	DatabaseCancelExacsBackupDatabaseResourceDependencies = DatabaseDatabaseResourceDependencies +
+		acctest.GenerateResourceFromRepresentationMap("oci_database_database", "test_database", acctest.Optional, acctest.Create, DatabaseDatabaseRepresentation)
+)
+
+// issue-routing-tag: database/default
+func TestDatabaseBackupCancelManagementResource_basic(t *testing.T) {
+	httpreplay.SetScenario("TestDatabaseBackupCancelManagementResource_basic")
+	defer httpreplay.SaveScenario()
+
+	provider := acctest.TestAccProvider
+	config := acctest.ProviderTestConfig()
+
+	compartmentId := utils.GetEnvSettingWithBlankDefault("compartment_ocid")
+	compartmentIdVariableStr := fmt.Sprintf("variable \"compartment_id\" { default = \"%s\" }\n", compartmentId)
+
+	kmsKeyId := utils.GetEnvSettingWithBlankDefault("kms_key_id")
+	kmsKeyIdVariableStr := fmt.Sprintf("variable \"kms_key_id\" { default = \"%s\" }\n", kmsKeyId)
+
+	resourceName := "oci_database_backup_cancel_management.test_cancel_backup"
+	databaseName := "oci_database_database.test_database"
+	listBackupName := "data.oci_database_backups.test_backups"
+
+	var resId string
+	// Save TF content to create resource with optional properties. This has to be exactly the same as the config part in the "create with optionals" step in the test.
+	acctest.SaveConfigContent(config+compartmentIdVariableStr+DatabaseCancelExacsBackupDatabaseResourceDependencies+kmsKeyIdVariableStr+
+		acctest.GenerateResourceFromRepresentationMap("oci_database_backup_cancel_management", "test_cancel_backup", acctest.Optional, acctest.Create, DatabaseCancelExacsBackupDatabaseRepresentation), "database", "backup", t)
+
+	resource.Test(t, resource.TestCase{
+		PreCheck: func() { acctest.PreCheck(t) },
+		Providers: map[string]*schema.Provider{
+			"oci": provider,
+		},
+		Steps: []resource.TestStep{
+
+			// Creating dependencies and most importantly the database with autoBackups enabled
+			{
+				Config: config + compartmentIdVariableStr + DatabaseCancelExacsBackupDatabaseResourceDependencies + kmsKeyIdVariableStr,
+				Check: acctest.ComposeAggregateTestCheckFuncWrapper(
+					resource.TestCheckResourceAttr(databaseName, "db_backup_config.0.auto_backup_enabled", "true"),
+
+					func(s *terraform.State) (err error) {
+						resId, err = acctest.FromInstanceState(s, databaseName, "id")
+						return err
+					},
+				),
+			},
+			// Poll the database until it reaches a backup_in_progress state and then call list backup on the databaseId to get the backup_id
+			{
+				PreConfig: acctest.WaitTillCondition(acctest.TestAccProvider, &resId, databaseWaitTillBackupInProgressConditionExa, time.Duration(1*time.Minute),
+					databaseResponseFetchOperationExa, "database", true),
+				Config: config + compartmentIdVariableStr + DatabaseCancelExacsBackupDatabaseResourceDependencies + kmsKeyIdVariableStr + acctest.GenerateDataSourceFromRepresentationMap("oci_database_backups", "test_backups", acctest.Optional, acctest.Update, GetBackupIdDataSourceRepresentation),
+				Check: acctest.ComposeAggregateTestCheckFuncWrapper(
+					resource.TestCheckResourceAttr(listBackupName, "backups.#", "1"),
+				),
+			},
+
+			// populate the cancel_backup request with the backup id
+			{
+				Config: config + compartmentIdVariableStr + DatabaseCancelExacsBackupDatabaseResourceDependencies + kmsKeyIdVariableStr +
+					acctest.GenerateDataSourceFromRepresentationMap("oci_database_backups", "test_backups", acctest.Optional, acctest.Update, GetBackupIdDataSourceRepresentation) +
+					acctest.GenerateResourceFromRepresentationMap("oci_database_backup_cancel_management", "test_cancel_backup", acctest.Required, acctest.Create,
+						acctest.RepresentationCopyWithNewProperties(acctest.RepresentationCopyWithRemovedProperties(DatabaseCancelExacsBackupDatabaseRepresentation, []string{"backup_id"}), map[string]interface{}{
+							"backup_id": acctest.Representation{RepType: acctest.Required, Create: `${data.oci_database_backups.test_backups.backups.0.id}`},
+						})),
+				Check: acctest.ComposeAggregateTestCheckFuncWrapper(
+					resource.TestCheckResourceAttrSet(resourceName, "backup_id"),
+				),
+			},
+
+			// test if retries of cancel_backup on a backup that has already completed or been canceled will fail
+			{
+				Config: config + compartmentIdVariableStr + DatabaseCancelExacsBackupDatabaseResourceDependencies + kmsKeyIdVariableStr +
+					acctest.GenerateDataSourceFromRepresentationMap("oci_database_backups", "test_backups", acctest.Optional, acctest.Update, GetBackupIdDataSourceRepresentation) +
+					acctest.GenerateResourceFromRepresentationMap("oci_database_backup_cancel_management", "test_cancel_backup", acctest.Optional, acctest.Create,
+						acctest.RepresentationCopyWithNewProperties(acctest.RepresentationCopyWithRemovedProperties(DatabaseCancelExacsBackupDatabaseRepresentation, []string{"backup_id"}), map[string]interface{}{
+							"backup_id": acctest.Representation{RepType: acctest.Required, Create: `${data.oci_database_backups.test_backups.backups.0.id}`},
+						})),
+				Check: acctest.ComposeAggregateTestCheckFuncWrapper(
+					resource.TestCheckResourceAttrSet(resourceName, "backup_id"),
+					resource.TestCheckResourceAttrSet(resourceName, "cancel_backup_trigger"),
+				),
+			},
+		},
+	})
+}
+
+func databaseWaitTillBackupInProgressConditionExa(response common.OCIOperationResponse) bool {
+	if databaseResponse, ok := response.Response.(oci_database.GetDatabaseResponse); ok {
+		fmt.Print("Checking whether the state of resource is BACKUP_IN_PROGRESS: ", databaseResponse.LifecycleState == oci_database.DatabaseLifecycleStateBackupInProgress, "\n")
+		return (databaseResponse.LifecycleState != oci_database.DatabaseLifecycleStateBackupInProgress)
+	}
+	return false
+}
+
+func databaseResponseFetchOperationExa(client *client.OracleClients, resourceId *string, retryPolicy *common.RetryPolicy) error {
+	_, err := client.DatabaseClient().GetDatabase(context.Background(), oci_database.GetDatabaseRequest{
+		DatabaseId: resourceId,
+		RequestMetadata: common.RequestMetadata{
+			RetryPolicy: retryPolicy,
+		},
+	})
+	return err
+}

internal/integrationtest/database_database_backup_test.go

@@ -113,7 +113,7 @@ var (
 		acctest.GenerateResourceFromRepresentationMap("oci_database_database", "db", acctest.Optional, acctest.Create, DatabaseDatabaseRepresentation) +
 		acctest.GenerateResourceFromRepresentationMap("oci_database_backup", "test_backup", acctest.Required, acctest.Create, backupDatabaseRepresentation)
 
-	DatabaseBackupResourceDbHomeDependencies = ExaBaseDependencies + DefinedTagsDependencies + AvailabilityDomainConfig + databaseKeyConfig +
+	DatabaseBackupResourceDbHomeDependencies = ExaBaseDependencies + DefinedTagsDependencies + AvailabilityDomainConfig + KeyResourceDependencyConfig2 +
 		acctest.GenerateResourceFromRepresentationMap("oci_database_db_home", "test_db_home", acctest.Required, acctest.Create, dbHomeRepresentationSourceBackup) +
 		acctest.GenerateResourceFromRepresentationMap("oci_database_database", "db", acctest.Optional, acctest.Create, DatabaseDatabaseBackupRepresentation) +
 		acctest.GenerateResourceFromRepresentationMap("oci_database_backup", "test_backup", acctest.Required, acctest.Create, backupDatabaseRepresentation)

internal/integrationtest/database_database_test.go

@@ -225,38 +225,13 @@ var (
 		"db_version": acctest.Representation{RepType: acctest.Required, Create: `19.16.0.0`},
 	})
 
-	databaseKeyConfig = KmsKeyResourceDependencies + `
-	data "oci_kms_keys" "test_keys_dependency" {
-		#Required
-		compartment_id = "${var.compartment_id}"
-		management_endpoint = "${data.oci_kms_vault.test_vault.management_endpoint}"
-		algorithm = "AES"
-
-		filter {
-    		name = "state"
-    		values = ["ENABLED", "UPDATING"]
-        }
-	}
-	data "oci_kms_keys" "test_keys_dependency_RSA" {
-		#Required
-		compartment_id = "${var.compartment_id}"
-		management_endpoint = "${data.oci_kms_vault.test_vault.management_endpoint}"
-		algorithm = "RSA"
-
-		filter {
-    		name = "state"
-    		values = ["ENABLED", "UPDATING"]
-        }
-	}
-	`
-
-	DatabaseDatabaseResourceDependencies = ExaBaseDependencies + DefinedTagsDependencies + AvailabilityDomainConfig + databaseKeyConfig +
+	DatabaseDatabaseResourceDependencies = ExaBaseDependencies + DefinedTagsDependencies + AvailabilityDomainConfig + KeyResourceDependencyConfig2 +
 		acctest.GenerateResourceFromRepresentationMap("oci_database_db_home", "test_db_home", acctest.Required, acctest.Create, dbHomeRepresentationSourceNone)
 
 	DatabaseExacsDatabaseResourceDependencies = DbHomeResourceVmClusterDependencies +
 		acctest.GenerateResourceFromRepresentationMap("oci_database_db_home", "test_db_home_vm_cluster_no_db", acctest.Required, acctest.Create, dbHomeRepresentationSourceVmCluster)
 
-	DatabaseDatabaseResourceDbrsDependencies = ExaBaseDependencies + DefinedTagsDependencies + AvailabilityDomainConfig + databaseKeyConfig +
+	DatabaseDatabaseResourceDbrsDependencies = ExaBaseDependencies + DefinedTagsDependencies + AvailabilityDomainConfig + KeyResourceDependencyConfig2 +
 		acctest.GenerateResourceFromRepresentationMap("oci_database_db_home", "test_db_home_dbrs", acctest.Required, acctest.Create, dbHomeDbrsRepresentation)
 )
 
@@ -307,7 +282,7 @@ func TestDatabaseDatabaseResource_basic(t *testing.T) {
 		//},
 		// delete dbrs db
 		//{
-		//	Config: config + compartmentIdVariableStr + ExaBaseDependencies + DefinedTagsDependencies + AvailabilityDomainConfig + databaseKeyConfig,
+		//	Config: config + compartmentIdVariableStr + ExaBaseDependencies + DefinedTagsDependencies + AvailabilityDomainConfig + KeyResourceDependencyConfig2,
 		//},
 
 		// verify create
@@ -370,6 +345,7 @@ func TestDatabaseDatabaseResource_basic(t *testing.T) {
 
 				func(s *terraform.State) (err error) {
 					resId, err = acctest.FromInstanceState(s, resourceName, "id")
+					// commenting out because ListCompartment policies not re-added to tf user
 					//if isEnableExportCompartment, _ := strconv.ParseBool(utils.GetEnvSettingWithDefault("enable_export_compartment", "true")); isEnableExportCompartment {
 					//	if errExport := resourcediscovery.TestExportCompartmentWithResourceName(&resId, &compartmentId, resourceName); errExport != nil {
 					//		return errExport

internal/service/database/database_backup_cancel_management_resource.go

@@ -0,0 +1,129 @@
+// Copyright (c) 2017, 2023, Oracle and/or its affiliates. All rights reserved.
+// Licensed under the Mozilla Public License v2.0
+
+package database
+
+import (
+	"context"
+	"fmt"
+	"log"
+	"strings"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+
+	oci_database "github.com/oracle/oci-go-sdk/v65/database"
+
+	"github.com/oracle/terraform-provider-oci/internal/client"
+	"github.com/oracle/terraform-provider-oci/internal/tfresource"
+)
+
+func DatabaseBackupCancelManagementResource() *schema.Resource {
+	return &schema.Resource{
+		Timeouts: tfresource.DefaultTimeout,
+		Create:   createDatabaseBackupCancelManagement,
+		Read:     readDatabaseBackupCancelManagement,
+		Delete:   deleteDatabaseBackupCancelManagement,
+		Schema: map[string]*schema.Schema{
+			// Required
+			"backup_id": {
+				Type:     schema.TypeString,
+				Required: true,
+				ForceNew: true,
+			},
+
+			"cancel_backup_trigger": {
+				Type:     schema.TypeInt,
+				Optional: true,
+				ForceNew: true,
+			},
+
+			// Optional
+
+			// Computed
+		},
+	}
+}
+
+func createDatabaseBackupCancelManagement(d *schema.ResourceData, m interface{}) error {
+	sync := &DatabaseBackupCancelManagementResourceCrud{}
+	sync.D = d
+	sync.Client = m.(*client.OracleClients).DatabaseClient()
+
+	return tfresource.CreateResource(d, sync)
+}
+
+func readDatabaseBackupCancelManagement(d *schema.ResourceData, m interface{}) error {
+	return nil
+}
+
+func deleteDatabaseBackupCancelManagement(d *schema.ResourceData, m interface{}) error {
+	return nil
+}
+
+type DatabaseBackupCancelManagementResourceCrud struct {
+	tfresource.BaseCrud
+	Client                 *oci_database.DatabaseClient
+	Res                    *oci_database.Backup
+	DisableNotFoundRetries bool
+}
+
+func (s *DatabaseBackupCancelManagementResourceCrud) ID() string {
+	return tfresource.GenerateDataSourceHashID("DatabaseBackupCancelManagementResource-", DatabaseBackupCancelManagementResource(), s.D)
+}
+
+func (s *DatabaseBackupCancelManagementResourceCrud) Create() error {
+	request := oci_database.CancelBackupRequest{}
+
+	if backupId, ok := s.D.GetOkExists("backup_id"); ok {
+		err := s.getBackupInfo(backupId.(string))
+		if err != nil {
+			return fmt.Errorf("[ERROR] Could not get Backup for the : %v", err)
+		}
+
+		backupType := string(s.Res.Type)
+
+		if !s.IsAutomaticBackup(backupType) {
+			return fmt.Errorf("[ERROR] Cancel backup only supported on automatic backups")
+		}
+
+		tmp := backupId.(string)
+		request.BackupId = &tmp
+	}
+
+	request.RequestMetadata.RetryPolicy = tfresource.GetRetryPolicy(s.DisableNotFoundRetries, "database")
+	_, err := s.Client.CancelBackup(context.Background(), request)
+
+	if err != nil {
+		log.Printf("Error occurred during cancel backup: %s", err)
+	}
+	trigger := s.D.Get("cancel_backup_trigger")
+	s.D.Set("cancel_backup_trigger", trigger)
+	val := s.D.Get("backup_id")
+	s.D.Set("backup_id", val)
+
+	return nil
+}
+
+func (s *DatabaseBackupCancelManagementResourceCrud) SetData() error {
+	return nil
+}
+
+func (s *DatabaseBackupCancelManagementResourceCrud) getBackupInfo(backupId string) error {
+	request := oci_database.GetBackupRequest{}
+
+	request.BackupId = &backupId
+
+	response, err := s.Client.GetBackup(context.Background(), request)
+	if err != nil {
+		return err
+	}
+
+	s.Res = &response.Backup
+
+	return nil
+}
+
+func (s *DatabaseBackupCancelManagementResourceCrud) IsAutomaticBackup(backupType string) bool {
+	// Only allowing cancelation of automatic backups
+	return strings.EqualFold(backupType, "INCREMENTAL")
+}

internal/service/database/register_resource.go

@@ -17,6 +17,7 @@ func RegisterResource() {
 	tfresource.RegisterResource("oci_database_autonomous_exadata_infrastructure", DatabaseAutonomousExadataInfrastructureResource())
 	tfresource.RegisterResource("oci_database_autonomous_vm_cluster", DatabaseAutonomousVmClusterResource())
 	tfresource.RegisterResource("oci_database_backup", DatabaseBackupResource())
+	tfresource.RegisterResource("oci_database_backup_cancel_management", DatabaseBackupCancelManagementResource())
 	tfresource.RegisterResource("oci_database_backup_destination", DatabaseBackupDestinationResource())
 	tfresource.RegisterResource("oci_database_cloud_autonomous_vm_cluster", DatabaseCloudAutonomousVmClusterResource())
 	tfresource.RegisterResource("oci_database_cloud_database_management", DatabaseCloudDatabaseManagementResource())

website/docs/d/database_autonomous_database.html.markdown

@@ -108,7 +108,14 @@ The following attributes are exported:
 * `is_dedicated` - True if the database uses [dedicated Exadata infrastructure](https://docs.oracle.com/en/cloud/paas/autonomous-database/index.html). 
 * `is_free_tier` - Indicates if this is an Always Free resource. The default value is false. Note that Always Free Autonomous Databases have 1 CPU and 20GB of memory. For Always Free databases, memory and CPU cannot be scaled. 
 * `is_local_data_guard_enabled` - Indicates whether the Autonomous Database has local (in-region) Data Guard enabled. Not applicable to cross-region Autonomous Data Guard associations, or to Autonomous Databases using dedicated Exadata infrastructure or Exadata Cloud@Customer infrastructure.
-* `is_mtls_connection_required` - Indicates whether the Autonomous Database requires mTLS connections.
+* `is_mtls_connection_required` - Specifies if the Autonomous Database requires mTLS connections.
+
+	This may not be updated in parallel with any of the following: licenseModel, databaseEdition, cpuCoreCount, computeCount, maxCpuCoreCount, dataStorageSizeInTBs, whitelistedIps, openMode, permissionLevel, db-workload, privateEndpointLabel, nsgIds, customerContacts, dbVersion, scheduledOperations, dbToolsDetails, isLocalDataGuardEnabled, or isFreeTier.
+
+	Service Change: The default value of the isMTLSConnectionRequired attribute will change from true to false on July 1, 2023 in the following APIs:
+	* CreateAutonomousDatabase
+	* GetAutonomousDatabase
+	* UpdateAutonomousDatabase Details: Prior to the July 1, 2023 change, the isMTLSConnectionRequired attribute default value was true. This applies to Autonomous Databases on shared Exadata infrastructure. Does this impact me? If you use or maintain custom scripts or Terraform scripts referencing the CreateAutonomousDatabase, GetAutonomousDatabase, or UpdateAutonomousDatabase APIs, you want to check, and possibly modify, the scripts for the changed default value of the attribute. Should you choose not to leave your scripts unchanged, the API calls containing this attribute will continue to work, but the default value will switch from true to false. How do I make this change? Using either Oracle Cloud Infrastructure SDKs or command line tools, update your custom scripts to explicitly set the isMTLSConnectionRequired attribute to true. 
 * `is_preview` - Indicates if the Autonomous Database version is a preview version.
 * `is_reconnect_clone_enabled` - Indicates if the refreshable clone can be reconnected to its source database.
 * `is_refreshable_clone` - Indicates whether the Autonomous Database is a refreshable clone.