Bug Fix - Deprecate resource file for discoveryJobResults resource as it should not have been there

Author: Terraform Team Automation

examples/datasafe/discovery_job_result/discovery_job_result.tf

@@ -8,101 +8,36 @@ variable "private_key_path" {}
 variable "region" {}
 variable "compartment_ocid" {}
 variable "data_safe_target_ocid" {}
+variable "data_safe_discovery_job_ocid" {}
+variable "data_safe_discovery_job_result_key" {}
 
 variable "discovery_jobs_result_column_name" {
   default = []
 }
 
 variable "discovery_jobs_result_discovery_type" {
-  default = "ALL"
+  default = "NEW"
 }
 
 variable "discovery_jobs_result_is_result_applied" {
   default = false
 }
 
-variable "discovery_jobs_result_object" {
-  default = []
-}
-
 variable "discovery_jobs_result_planned_action" {
   default = "NONE"
 }
 
-variable "discovery_jobs_result_schema_name" {
-  default = []
-}
-
-
-
 provider "oci" {
   tenancy_ocid     = var.tenancy_ocid
   user_ocid        = var.user_ocid
   fingerprint      = var.fingerprint
   private_key_path = var.private_key_path
   region           = var.region
 }
-# sensitive data model
-variable "sensitive_data_model_display_name" {
-  default = "displayName"
-}
-
-variable "sensitive_data_model_schemas_for_discovery" {
-  default = []
-}
-
-variable "sensitive_data_model_sensitive_type_ids_for_discovery" {
-  default = []
-}
-
-resource "oci_data_safe_sensitive_data_model" "test_sensitive_data_model" {
-  #Required
-  compartment_id = var.compartment_ocid
-  target_id      = var.data_safe_target_ocid
-
-  #Optional
-  display_name                              = var.sensitive_data_model_display_name
-  schemas_for_discovery                     = var.sensitive_data_model_schemas_for_discovery
-  sensitive_type_ids_for_discovery          = var.sensitive_data_model_sensitive_type_ids_for_discovery
-}
-# ---------
-
-# discovery job
-variable "discovery_job_discovery_type" {
-  default = "ALL"
-}
-
-variable "discovery_job_is_include_all_schemas" {
-  default = true
-}
-
-variable "discovery_job_is_include_all_sensitive_types" {
-  default = true
-}
-
-resource "oci_data_safe_discovery_job" "test_discovery_job" {
-  #Required
-  compartment_id          = var.compartment_ocid
-  sensitive_data_model_id = oci_data_safe_sensitive_data_model.test_sensitive_data_model.id
-
-  #Optional
-  discovery_type                            = var.discovery_job_discovery_type
-  is_include_all_schemas                    = var.discovery_job_is_include_all_schemas
-  is_include_all_sensitive_types            = var.discovery_job_is_include_all_sensitive_types
-}
-
-# -------------
-
-
-
-resource "oci_data_safe_discovery_jobs_result" "test_discovery_jobs_result" {
-  #Required
-  discovery_job_id = oci_data_safe_discovery_job.test_discovery_job.id
-}
 
 data "oci_data_safe_discovery_jobs_results" "test_discovery_jobs_results" {
   #Required
-  discovery_job_id = oci_data_safe_discovery_job.test_discovery_job.id
+  discovery_job_id = var.data_safe_discovery_job_ocid
 
   #Optional
   discovery_type    = var.discovery_jobs_result_discovery_type

internal/integrationtest/data_safe_discovery_jobs_result_test.go

@@ -6,11 +6,8 @@ package integrationtest
 import (
 	"context"
 	"fmt"
-	"strconv"
 	"testing"
 
-	"github.com/oracle/terraform-provider-oci/internal/resourcediscovery"
-
 	"github.com/oracle/terraform-provider-oci/internal/acctest"
 	tf_client "github.com/oracle/terraform-provider-oci/internal/client"
 	"github.com/oracle/terraform-provider-oci/internal/tfresource"
@@ -26,39 +23,22 @@ import (
 )
 
 var (
-	DataSafeDiscoveryJobsResultResourceConfig = DataSafeDiscoveryJobsResultResourceDependencies +
-		acctest.GenerateResourceFromRepresentationMap("oci_data_safe_discovery_jobs_result", "test_discovery_jobs_result", acctest.Optional, acctest.Update, discoveryJobsResultRepresentation)
-
 	DataSafediscoveryJobsResultSingularDataSourceRepresentation = map[string]interface{}{
-		"discovery_job_id": acctest.Representation{RepType: acctest.Required, Create: `${oci_data_safe_discovery_job.test_discovery_job.id}`},
-		"result_key":       acctest.Representation{RepType: acctest.Required, Create: `${oci_data_safe_discovery_jobs_result.test_discovery_jobs_result.key}`},
+		"discovery_job_id": acctest.Representation{RepType: acctest.Required, Create: `${var.discovery_job_id}`},
+		"result_key":       acctest.Representation{RepType: acctest.Required, Create: `${var.discovery_job_result_key}`},
 	}
 
 	DataSafediscoveryJobsResultDataSourceRepresentation = map[string]interface{}{
-		"discovery_job_id":  acctest.Representation{RepType: acctest.Required, Create: `${oci_data_safe_discovery_job.test_discovery_job.id}`},
-		"discovery_type":    acctest.Representation{RepType: acctest.Optional, Create: `ALL`},
+		"discovery_job_id":  acctest.Representation{RepType: acctest.Required, Create: `${var.discovery_job_id}`},
+		"discovery_type":    acctest.Representation{RepType: acctest.Optional, Create: `NEW`},
 		"is_result_applied": acctest.Representation{RepType: acctest.Optional, Create: `false`},
 		"planned_action":    acctest.Representation{RepType: acctest.Optional, Create: `NONE`},
-		"filter":            acctest.RepresentationGroup{RepType: acctest.Required, Group: discoveryJobsResultDataSourceFilterRepresentation}}
-	discoveryJobsResultDataSourceFilterRepresentation = map[string]interface{}{
-		"name":   acctest.Representation{RepType: acctest.Required, Create: `key`},
-		"values": acctest.Representation{RepType: acctest.Required, Create: []string{`${oci_data_safe_discovery_jobs_result.test_discovery_jobs_result.key}`}},
-	}
-
-	discoveryJobsResultRepresentation = map[string]interface{}{
-		"discovery_job_id": acctest.Representation{RepType: acctest.Required, Create: `${oci_data_safe_discovery_job.test_discovery_job.id}`},
-	}
-
-	discoveryJobsResultRepresentation2 = map[string]interface{}{
-		"discovery_job_id": acctest.Representation{RepType: acctest.Optional, Create: `${oci_data_safe_discovery_job.test_discovery_job.id}`},
 	}
-
-	DataSafeDiscoveryJobsResultResourceDependencies = acctest.GenerateResourceFromRepresentationMap("oci_data_safe_discovery_job", "test_discovery_job", acctest.Optional, acctest.Create, discoveryJobRepresentation) +
-		acctest.GenerateResourceFromRepresentationMap("oci_data_safe_sensitive_data_model", "test_sensitive_data_model", acctest.Required, acctest.Create, sensitiveDataModelRepresentation)
 )
 
 // issue-routing-tag: data_safe/default
 func TestDataSafeDiscoveryJobsResultResource_basic(t *testing.T) {
+	t.Skip("Skipping this test as the discovery job result key is hardcoded and may not exist when the test runs")
 	httpreplay.SetScenario("TestDataSafeDiscoveryJobsResultResource_basic")
 	defer httpreplay.SaveScenario()
 
@@ -70,55 +50,38 @@ func TestDataSafeDiscoveryJobsResultResource_basic(t *testing.T) {
 	targetId := utils.GetEnvSettingWithBlankDefault("data_safe_target_ocid")
 	targetIdVariableStr := fmt.Sprintf("variable \"target_id\" { default = \"%s\" }\n", targetId)
 
-	resourceName := "oci_data_safe_discovery_jobs_result.test_discovery_jobs_result"
+	discoveryJobId := utils.GetEnvSettingWithBlankDefault("data_safe_discovery_job_ocid")
+	discoveryJobIdVariableStr := fmt.Sprintf("variable \"discovery_job_id\" { default = \"%s\" }\n", discoveryJobId)
+
+	discoveryJobKey := utils.GetEnvSettingWithBlankDefault("data_safe_discovery_job_result_key")
+	discoveryJobKeyVariableStr := fmt.Sprintf("variable \"discovery_job_result_key\" { default = \"%s\" }\n", discoveryJobKey)
+
 	datasourceName := "data.oci_data_safe_discovery_jobs_results.test_discovery_jobs_results"
 	singularDatasourceName := "data.oci_data_safe_discovery_jobs_result.test_discovery_jobs_result"
 
 	// Save TF content to Create resource with only required properties. This has to be exactly the same as the config part in the create step in the test.
-	acctest.SaveConfigContent(config+compartmentIdVariableStr+DataSafeDiscoveryJobsResultResourceDependencies+
-		acctest.GenerateResourceFromRepresentationMap("oci_data_safe_discovery_jobs_result", "test_discovery_jobs_result", acctest.Required, acctest.Create, discoveryJobsResultRepresentation), "datasafe", "discoveryJobsResult", t)
-
-	acctest.ResourceTest(t, testAccCheckDataSafeDiscoveryJobsResultDestroy, []resource.TestStep{
-		// verify Create
-		{
-			Config: config + compartmentIdVariableStr + DataSafeDiscoveryJobsResultResourceDependencies + targetIdVariableStr +
-				acctest.GenerateResourceFromRepresentationMap("oci_data_safe_discovery_jobs_result", "test_discovery_jobs_result", acctest.Optional, acctest.Create, discoveryJobsResultRepresentation2),
-			Check: acctest.ComposeAggregateTestCheckFuncWrapper(
-
-				func(s *terraform.State) (err error) {
-					var compositeId string
-					compositeId, err = acctest.FromInstanceState(s, resourceName, "id")
-					prefix := "oci_data_safe_discovery_jobs_result:"
-					fullPath := prefix + compositeId
-					if isEnableExportCompartment, _ := strconv.ParseBool(utils.GetEnvSettingWithDefault("enable_export_compartment", "true")); isEnableExportCompartment {
-						if errExport := resourcediscovery.TestExportCompartmentWithResourceName(&fullPath, &compartmentId, resourceName); errExport != nil {
-							return errExport
-						}
-					}
-					return err
-				},
-			),
-		},
+	acctest.SaveConfigContent(config+compartmentIdVariableStr,
+		"datasafe", "discoveryJobsResult", t)
 
+	acctest.ResourceTest(t, nil, []resource.TestStep{
 		// verify datasource
 		{
-			Config: config + targetIdVariableStr +
+			Config: config + targetIdVariableStr + discoveryJobIdVariableStr + discoveryJobKeyVariableStr +
 				acctest.GenerateDataSourceFromRepresentationMap("oci_data_safe_discovery_jobs_results", "test_discovery_jobs_results", acctest.Optional, acctest.Update, DataSafediscoveryJobsResultDataSourceRepresentation) +
-				compartmentIdVariableStr + DataSafeDiscoveryJobsResultResourceDependencies +
-				acctest.GenerateResourceFromRepresentationMap("oci_data_safe_discovery_jobs_result", "test_discovery_jobs_result", acctest.Optional, acctest.Update, discoveryJobsResultRepresentation2),
+				compartmentIdVariableStr,
 			Check: acctest.ComposeAggregateTestCheckFuncWrapper(
 				resource.TestCheckResourceAttrSet(datasourceName, "discovery_job_id"),
-				resource.TestCheckResourceAttr(datasourceName, "discovery_type", "ALL"),
+				resource.TestCheckResourceAttr(datasourceName, "discovery_type", "NEW"),
 				resource.TestCheckResourceAttr(datasourceName, "is_result_applied", "false"),
 				resource.TestCheckResourceAttr(datasourceName, "planned_action", "NONE"),
-				resource.TestCheckResourceAttr(datasourceName, "discovery_job_result_collection.#", "1"),
 			),
 		},
+
 		// verify singular datasource
 		{
-			Config: config + targetIdVariableStr +
+			Config: config + discoveryJobIdVariableStr + targetIdVariableStr + discoveryJobKeyVariableStr +
 				acctest.GenerateDataSourceFromRepresentationMap("oci_data_safe_discovery_jobs_result", "test_discovery_jobs_result", acctest.Required, acctest.Create, DataSafediscoveryJobsResultSingularDataSourceRepresentation) +
-				compartmentIdVariableStr + DataSafeDiscoveryJobsResultResourceConfig,
+				compartmentIdVariableStr,
 			Check: acctest.ComposeAggregateTestCheckFuncWrapper(
 				resource.TestCheckResourceAttrSet(singularDatasourceName, "discovery_job_id"),
 				resource.TestCheckResourceAttrSet(singularDatasourceName, "data_type"),
@@ -135,18 +98,6 @@ func TestDataSafeDiscoveryJobsResultResource_basic(t *testing.T) {
 				resource.TestCheckResourceAttrSet(singularDatasourceName, "sensitive_type_id"),
 			),
 		},
-		// remove singular datasource from previous step so that it doesn't conflict with import tests
-		{
-			Config: config + compartmentIdVariableStr + DataSafeDiscoveryJobsResultResourceConfig + targetIdVariableStr,
-		},
-		// verify resource import
-		{
-			Config:                  config + targetIdVariableStr,
-			ImportState:             true,
-			ImportStateVerify:       true,
-			ImportStateVerifyIgnore: []string{},
-			ResourceName:            resourceName,
-		},
 	})
 }
 

internal/service/data_safe/data_safe_discovery_jobs_result_resource.go

@@ -32,9 +32,10 @@ func DataSafeDiscoveryJobsResultResource() *schema.Resource {
 		Schema: map[string]*schema.Schema{
 			// Required
 			"discovery_job_id": {
-				Type:     schema.TypeString,
-				Required: true,
-				ForceNew: true,
+				Type:       schema.TypeString,
+				Required:   true,
+				ForceNew:   true,
+				Deprecated: tfresource.ResourceDeprecated("oci_data_safe_discovery_jobs_result"),
 			},
 			// Optional
 
@@ -66,8 +67,9 @@ func DataSafeDiscoveryJobsResultResource() *schema.Resource {
 				},
 			},
 			"discovery_type": {
-				Type:     schema.TypeString,
-				Computed: true,
+				Type:       schema.TypeString,
+				Computed:   true,
+				Deprecated: tfresource.ResourceDeprecated("oci_data_safe_discovery_jobs_result"),
 			},
 			"estimated_data_value_count": {
 				Type:     schema.TypeString,
@@ -78,8 +80,9 @@ func DataSafeDiscoveryJobsResultResource() *schema.Resource {
 				Computed: true,
 			},
 			"key": {
-				Type:     schema.TypeString,
-				Computed: true,
+				Type:       schema.TypeString,
+				Computed:   true,
+				Deprecated: tfresource.ResourceDeprecated("oci_data_safe_discovery_jobs_result"),
 			},
 			"modified_attributes": {
 				Type:     schema.TypeList,

internal/tfresource/crud_helpers.go

@@ -557,6 +557,10 @@ func ResourceDeprecatedForAnother(deprecatedResourceName string, newResourceName
 	return fmt.Sprintf("The '%s' resource has been deprecated. Please use '%s' instead.", deprecatedResourceName, newResourceName)
 }
 
+func ResourceDeprecated(deprecatedResourceName string) string {
+	return fmt.Sprintf("The '%s' resource has been deprecated. It is no longer supported.", deprecatedResourceName)
+}
+
 func ResourceNotFoundErrorMessage(resourceName string, reason string) error {
 	// Use this function to generate an error message for any resource that is not found.  The message is specially
 	// formatted so that it is detected by the handleMissingResourceError function correctly.  Do not change the message format.

website/docs/r/data_safe_discovery_jobs_result.html.markdown

@@ -8,6 +8,9 @@ description: |-
 ---
 
 # oci_data_safe_discovery_jobs_result
+
+**Deprecated. This resource does not support create and update operations.**
+
 This resource provides the Discovery Jobs Result resource in Oracle Cloud Infrastructure Data Safe service.