Support resource discovery for datascience resources

Author: Yi Fan

CHANGELOG.md

@@ -11,6 +11,7 @@
 - Support resource discovery for `marketplace` resources
 - Added resource discovery support for `oce` resources
 - Support resource discovery for `oda` resources
+- Support resource discovery for `datascience` resources
 
 ### Fixed
 - Fixed plan failure in case of missing required attributes in resource discovery. Placeholder values will be added for missing required attributes and the attributes will be added to `lifecycle ignore_changes`

oci/datascience_model_provenance_resource.go

@@ -257,14 +257,14 @@ func (s *DatascienceModelProvenanceResourceCrud) SetData() error {
 
 func getModelProvenanceCompositeId(modelId string) string {
 	modelId = url.PathEscape(modelId)
-	compositeId := "modelProvenances/" + modelId
+	compositeId := "models/" + modelId + "/provenance"
 	return compositeId
 }
 
 func parseModelProvenanceCompositeId(compositeId string) (modelId string, err error) {
 	parts := strings.Split(compositeId, "/")
-	match, _ := regexp.MatchString("modelProvenances/.*", compositeId)
-	if !match || len(parts) != 2 {
+	match, _ := regexp.MatchString("models/.*/provenance", compositeId)
+	if !match || len(parts) != 3 {
 		err = fmt.Errorf("illegal compositeId %s encountered", compositeId)
 		return
 	}

oci/datascience_model_provenance_test.go

@@ -157,6 +157,6 @@ func getDatascienceModelProvenanceCompositeIdForImport(resourceName string) reso
 			return "", fmt.Errorf("not found: %s", resourceName)
 		}
 
-		return fmt.Sprintf("modelProvenances/%s", rs.Primary.Attributes["model_id"]), nil
+		return fmt.Sprintf("models/%s/provenance", rs.Primary.Attributes["model_id"]), nil
 	}
 }

oci/datascience_model_resource.go

@@ -26,6 +26,9 @@ func init() {
 
 func DatascienceModelResource() *schema.Resource {
 	return &schema.Resource{
+		Importer: &schema.ResourceImporter{
+			State: schema.ImportStatePassthrough,
+		},
 		Timeouts: DefaultTimeout,
 		Create:   createDatascienceModel,
 		Read:     readDatascienceModel,

oci/datascience_model_test.go

@@ -43,7 +43,7 @@ var (
 	}
 
 	modelRepresentation = map[string]interface{}{
-		"artifact_content_length":      Representation{repType: Required, create: `14373`},
+		"artifact_content_length":      Representation{repType: Required, create: `14603`},
 		"model_artifact":               Representation{repType: Required, create: `datascience_model_resource.go`},
 		"compartment_id":               Representation{repType: Required, create: `${var.compartment_id}`},
 		"project_id":                   Representation{repType: Required, create: `${oci_datascience_project.test_project.id}`},
@@ -91,7 +91,7 @@ func TestDatascienceModelResource_basic(t *testing.T) {
 				Check: resource.ComposeAggregateTestCheckFunc(
 					resource.TestCheckResourceAttr(resourceName, "compartment_id", compartmentId),
 					resource.TestCheckResourceAttrSet(resourceName, "project_id"),
-					resource.TestCheckResourceAttr(resourceName, "artifact_content_length", "14373"),
+					resource.TestCheckResourceAttr(resourceName, "artifact_content_length", "14603"),
 					resource.TestCheckResourceAttrSet(resourceName, "artifact_content_md5"),
 					resource.TestCheckResourceAttrSet(resourceName, "artifact_last_modified"),
 
@@ -111,7 +111,7 @@ func TestDatascienceModelResource_basic(t *testing.T) {
 				Config: config + compartmentIdVariableStr + ModelResourceDependencies +
 					generateResourceFromRepresentationMap("oci_datascience_model", "test_model", Optional, Create, modelRepresentation),
 				Check: resource.ComposeAggregateTestCheckFunc(
-					resource.TestCheckResourceAttr(resourceName, "artifact_content_length", "14373"),
+					resource.TestCheckResourceAttr(resourceName, "artifact_content_length", "14603"),
 					resource.TestCheckResourceAttrSet(resourceName, "artifact_content_md5"),
 					resource.TestCheckResourceAttrSet(resourceName, "artifact_last_modified"),
 					resource.TestCheckResourceAttr(resourceName, "compartment_id", compartmentId),
@@ -145,7 +145,7 @@ func TestDatascienceModelResource_basic(t *testing.T) {
 							"compartment_id": Representation{repType: Required, create: `${var.compartment_id_for_update}`},
 						})),
 				Check: resource.ComposeAggregateTestCheckFunc(
-					resource.TestCheckResourceAttr(resourceName, "artifact_content_length", "14373"),
+					resource.TestCheckResourceAttr(resourceName, "artifact_content_length", "14603"),
 					resource.TestCheckResourceAttrSet(resourceName, "artifact_content_md5"),
 					resource.TestCheckResourceAttrSet(resourceName, "artifact_last_modified"),
 					resource.TestCheckResourceAttr(resourceName, "compartment_id", compartmentIdU),
@@ -237,6 +237,21 @@ func TestDatascienceModelResource_basic(t *testing.T) {
 					resource.TestCheckResourceAttrSet(singularDatasourceName, "time_created"),
 				),
 			},
+			// verify resource import
+			{Config: config,
+				ImportState:       true,
+				ImportStateVerify: true,
+				ImportStateVerifyIgnore: []string{
+					"artifact_content_disposition",
+					"artifact_content_md5",
+					"artifact_last_modified",
+					"artifact_content_length",
+					"empty_model",
+					"model_artifact",
+					"model_id",
+				},
+				ResourceName: resourceName,
+			},
 		},
 	})
 }

oci/export_definitions.go

@@ -13,6 +13,7 @@ import (
 	oci_datacatalog "github.com/oracle/oci-go-sdk/datacatalog"
 	oci_dataflow "github.com/oracle/oci-go-sdk/dataflow"
 	oci_data_safe "github.com/oracle/oci-go-sdk/datasafe"
+	oci_datascience "github.com/oracle/oci-go-sdk/datascience"
 	oci_dns "github.com/oracle/oci-go-sdk/dns"
 	oci_email "github.com/oracle/oci-go-sdk/email"
 	oci_events "github.com/oracle/oci-go-sdk/events"
@@ -626,6 +627,43 @@ var exportDataflowApplicationHints = &TerraformResourceHints{
 	},
 }
 
+var exportDatascienceProjectHints = &TerraformResourceHints{
+	resourceClass:        "oci_datascience_project",
+	datasourceClass:      "oci_datascience_projects",
+	datasourceItemsAttr:  "projects",
+	resourceAbbreviation: "project",
+	discoverableLifecycleStates: []string{
+		string(oci_datascience.ProjectLifecycleStateActive),
+	},
+}
+
+var exportDatascienceNotebookSessionHints = &TerraformResourceHints{
+	resourceClass:        "oci_datascience_notebook_session",
+	datasourceClass:      "oci_datascience_notebook_sessions",
+	datasourceItemsAttr:  "notebook_sessions",
+	resourceAbbreviation: "notebook_session",
+	discoverableLifecycleStates: []string{
+		string(oci_datascience.NotebookSessionLifecycleStateActive),
+	},
+}
+
+var exportDatascienceModelHints = &TerraformResourceHints{
+	resourceClass:          "oci_datascience_model",
+	datasourceClass:        "oci_datascience_models",
+	datasourceItemsAttr:    "models",
+	resourceAbbreviation:   "model",
+	requireResourceRefresh: true,
+	discoverableLifecycleStates: []string{
+		string(oci_datascience.ModelLifecycleStateActive),
+	},
+}
+
+var exportDatascienceModelProvenanceHints = &TerraformResourceHints{
+	resourceClass:        "oci_datascience_model_provenance",
+	datasourceClass:      "oci_datascience_model_provenance",
+	resourceAbbreviation: "model_provenance",
+}
+
 var exportDnsRecordHints = &TerraformResourceHints{
 	resourceClass:        "oci_dns_record",
 	datasourceClass:      "oci_dns_records",

oci/export_graphs.go

@@ -56,6 +56,7 @@ var compartmentResourceGraphs = map[string]TerraformResourceGraph{
 	"database":            databaseResourceGraph,
 	"datacatalog":         datacatalogResourceGraph,
 	"dataflow":            dataflowResourceGraph,
+	"datascience":         datascienceResourceGraph,
 	"dns":                 dnsResourceGraph,
 	"email":               emailResourceGraph,
 	"events":              eventsResourceGraph,
@@ -301,6 +302,22 @@ var dataflowResourceGraph = TerraformResourceGraph{
 	},
 }
 
+var datascienceResourceGraph = TerraformResourceGraph{
+	"oci_identity_compartment": {
+		{TerraformResourceHints: exportDatascienceProjectHints},
+		{TerraformResourceHints: exportDatascienceNotebookSessionHints},
+		{TerraformResourceHints: exportDatascienceModelHints},
+	},
+	"oci_datascience_model": {
+		{
+			TerraformResourceHints: exportDatascienceModelProvenanceHints,
+			datasourceQueryParams: map[string]string{
+				"model_id": "id",
+			},
+		},
+	},
+}
+
 var dnsResourceGraph = TerraformResourceGraph{
 	"oci_identity_compartment": {
 		{TerraformResourceHints: exportDnsZoneHints},

oci/export_resource_helpers.go

@@ -119,6 +119,8 @@ func init() {
 
 	exportDatabaseVmClusterNetworkHints.getIdFn = getDatabaseVmClusterNetworkId
 
+	exportDatascienceModelProvenanceHints.getIdFn = getModelProvenanceId
+
 	exportIdentityAvailabilityDomainHints.resourceAbbreviation = "ad"
 	exportIdentityAvailabilityDomainHints.alwaysExportable = true
 	exportIdentityAvailabilityDomainHints.processDiscoveredResourcesFn = processAvailabilityDomains
@@ -203,6 +205,12 @@ func getIdentityApiKeyId(resource *OCIResource) (string, error) {
 	return getApiKeyCompositeId(fingerPrint, userId), nil
 }
 
+func getModelProvenanceId(resource *OCIResource) (string, error) {
+	modelId := resource.parent.id
+
+	return getModelProvenanceCompositeId(modelId), nil
+}
+
 func getIdentityAuthTokenId(resource *OCIResource) (string, error) {
 	authTokenId, ok := resource.sourceAttributes["id"].(string)
 	if !ok {

website/docs/guides/resource_discovery.html.markdown

@@ -101,6 +101,7 @@ The generated `.tf` files contain the Terraform configuration with the resources
     * `database` - Discovers database resources within the specified compartment
     * `datacatalog` - Discovers datacatalog resources within the specified compartment
     * `dataflow` - Discovers dataflow resources within the specified compartment
+    * `datascience` - Discovers datascience resources within the specified compartment
     * `dns` - Discovers dns resources (except record) within the specified compartment
     * `email` - Discovers email resources within the specified compartment
     * `events` - Discovers events resources within the specified compartment
@@ -290,6 +291,13 @@ dataflow
 
 * oci\_dataflow\_application
 
+datascience
+    
+* oci\_datascience\_project
+* oci\_datascience\_notebook\_session
+* oci\_datascience\_model
+* oci\_datascience\_model\_provenance
+
 dns
 
 * oci\_dns\_zone

website/docs/r/datascience_model.html.markdown

@@ -70,5 +70,8 @@ The following attributes are exported:
 
 ## Import
 
-Import is not supported for this resource.
+Model can be imported using the `id`, e.g.
 
+```
+$ terraform import oci_datascience_model.test_model "id" 
+```