Added Support for - OCI - Data Labeling Service [DLS]

Author: Nagendra

internal/integrationtest/data_labeling_service_dataset_test.go

@@ -10,6 +10,12 @@ import (
 	"testing"
 	"time"
 
+	"github.com/terraform-providers/terraform-provider-oci/internal/acctest"
+	tf_client "github.com/terraform-providers/terraform-provider-oci/internal/client"
+	"github.com/terraform-providers/terraform-provider-oci/internal/resourcediscovery"
+	"github.com/terraform-providers/terraform-provider-oci/internal/tfresource"
+	"github.com/terraform-providers/terraform-provider-oci/internal/utils"
+
 	"github.com/hashicorp/terraform-plugin-sdk/helper/resource"
 	"github.com/hashicorp/terraform-plugin-sdk/helper/schema"
 	"github.com/hashicorp/terraform-plugin-sdk/terraform"
@@ -18,11 +24,6 @@ import (
 	"github.com/oracle/oci-go-sdk/v55/objectstorage"
 
 	"github.com/terraform-providers/terraform-provider-oci/httpreplay"
-	"github.com/terraform-providers/terraform-provider-oci/internal/acctest"
-	tf_client "github.com/terraform-providers/terraform-provider-oci/internal/client"
-	"github.com/terraform-providers/terraform-provider-oci/internal/resourcediscovery"
-	"github.com/terraform-providers/terraform-provider-oci/internal/tfresource"
-	"github.com/terraform-providers/terraform-provider-oci/internal/utils"
 )
 
 var (
@@ -48,6 +49,10 @@ var (
 		"values": acctest.Representation{RepType: acctest.Required, Create: []string{`${oci_data_labeling_service_dataset.test_dataset.id}`}},
 	}
 
+	datasetIgnoreDefinedTagsChangesRep = map[string]interface{}{
+		"ignore_changes": acctest.Representation{RepType: acctest.Required, Create: []string{`defined_tags`}},
+	}
+
 	datasetRepresentation = map[string]interface{}{
 		"annotation_format":      acctest.Representation{RepType: acctest.Required, Create: `BOUNDING_BOX`},
 		"compartment_id":         acctest.Representation{RepType: acctest.Required, Create: `${var.compartment_id}`},
@@ -58,7 +63,9 @@ var (
 		"description":            acctest.Representation{RepType: acctest.Optional, Create: `description`, Update: `description2`},
 		"display_name":           acctest.Representation{RepType: acctest.Optional, Create: `displayName`, Update: `displayName2`},
 		"freeform_tags":          acctest.Representation{RepType: acctest.Optional, Create: map[string]string{"bar-key": "value"}, Update: map[string]string{"Department": "Accounting"}},
-		//"initial_record_generation_configuration": acctest.RepresentationGroup{RepType: acctest.Optional, Group: datasetInitialRecordGenerationConfigurationRepresentation},
+		//"initial_record_generation_configuration": acctest.RepresentationGroup{acctest.Optional, datasetInitialRecordGenerationConfigurationRepresentation},
+		//"labeling_instructions": acctest.Representation{RepType: acctest.Optional, Create: `labelingInstructions`, Update: `labelingInstructions2`},
+		"lifecycle": acctest.RepresentationGroup{RepType: acctest.Required, Group: datasetIgnoreDefinedTagsChangesRep},
 	}
 	datasetDatasetFormatDetailsRepresentation = map[string]interface{}{
 		"format_type": acctest.Representation{RepType: acctest.Required, Create: `IMAGE`},
@@ -100,7 +107,8 @@ func TestDataLabelingServiceDatasetResource_basic(t *testing.T) {
 	config := acctest.ProviderTestConfig()
 
 	compartmentId := utils.GetEnvSettingWithBlankDefault("compartment_ocid")
-	compartmentIdVariableStr := fmt.Sprintf("variable \"compartment_id\" { default = \"%s\" }\n", compartmentId)
+	compartmentIdVariableStr := fmt.Sprintf("variable \"compartment_id" +
+		"\" { default = \"%s\" }\n", compartmentId)
 
 	compartmentIdU := utils.GetEnvSettingWithDefault("compartment_id_for_Update", compartmentId)
 	compartmentIdUVariableStr := fmt.Sprintf("variable \"compartment_id_for_Update\" { default = \"%s\" }\n", compartmentIdU)
@@ -113,7 +121,7 @@ func TestDataLabelingServiceDatasetResource_basic(t *testing.T) {
 	objectstorageBucket := "tf_dataset_objectstoragebucket"
 
 	var resId, resId2 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.
+	// Save TF content to Create resource with optional propeTestCheckResourceAttrrties. This has to be exactly the same as the config part in the "Create with optionals" step in the test.
 	acctest.SaveConfigContent(config+compartmentIdVariableStr+DatasetResourceDependencies+
 		acctest.GenerateResourceFromRepresentationMap("oci_data_labeling_service_dataset", "test_dataset", acctest.Optional, acctest.Create, datasetRepresentation), "datalabelingservice", "dataset", t)
 
@@ -168,6 +176,7 @@ func TestDataLabelingServiceDatasetResource_basic(t *testing.T) {
 				resource.TestCheckResourceAttr(resourceName, "label_set.#", "1"),
 				resource.TestCheckResourceAttr(resourceName, "label_set.0.items.#", "1"),
 				resource.TestCheckResourceAttr(resourceName, "label_set.0.items.0.name", "name"),
+				//resource.TestCheckResourceAttr(resourceName, "labeling_instructions", "labelingInstructions"),
 				resource.TestCheckResourceAttrSet(resourceName, "state"),
 				resource.TestCheckResourceAttrSet(resourceName, "time_created"),
 				resource.TestCheckResourceAttrSet(resourceName, "time_updated"),
@@ -209,6 +218,7 @@ func TestDataLabelingServiceDatasetResource_basic(t *testing.T) {
 				resource.TestCheckResourceAttr(resourceName, "label_set.#", "1"),
 				resource.TestCheckResourceAttr(resourceName, "label_set.0.items.#", "1"),
 				resource.TestCheckResourceAttr(resourceName, "label_set.0.items.0.name", "name"),
+				//resource.TestCheckResourceAttr(resourceName, "labeling_instructions", "labelingInstructions"),
 				resource.TestCheckResourceAttrSet(resourceName, "state"),
 				resource.TestCheckResourceAttrSet(resourceName, "time_created"),
 				resource.TestCheckResourceAttrSet(resourceName, "time_updated"),
@@ -245,6 +255,7 @@ func TestDataLabelingServiceDatasetResource_basic(t *testing.T) {
 				resource.TestCheckResourceAttr(resourceName, "label_set.#", "1"),
 				resource.TestCheckResourceAttr(resourceName, "label_set.0.items.#", "1"),
 				resource.TestCheckResourceAttr(resourceName, "label_set.0.items.0.name", "name2"),
+				//resource.TestCheckResourceAttr(resourceName, "labeling_instructions", "labelingInstructions2"),
 				resource.TestCheckResourceAttrSet(resourceName, "state"),
 				resource.TestCheckResourceAttrSet(resourceName, "time_created"),
 				resource.TestCheckResourceAttrSet(resourceName, "time_updated"),
@@ -300,6 +311,7 @@ func TestDataLabelingServiceDatasetResource_basic(t *testing.T) {
 				resource.TestCheckResourceAttr(singularDatasourceName, "label_set.#", "1"),
 				resource.TestCheckResourceAttr(singularDatasourceName, "label_set.0.items.#", "1"),
 				resource.TestCheckResourceAttr(singularDatasourceName, "label_set.0.items.0.name", "name2"),
+				//resource.TestCheckResourceAttr(singularDatasourceName, "labeling_instructions", "labelingInstructions2"),
 				resource.TestCheckResourceAttrSet(singularDatasourceName, "state"),
 				resource.TestCheckResourceAttrSet(singularDatasourceName, "time_created"),
 				resource.TestCheckResourceAttrSet(singularDatasourceName, "time_updated"),

internal/service/data_labeling_service/data_labeling_service_dataset_data_source.go

@@ -120,6 +120,10 @@ func (s *DataLabelingServiceDatasetDataSourceCrud) SetData() error {
 		s.D.Set("label_set", nil)
 	}
 
+	if s.Res.LabelingInstructions != nil {
+		s.D.Set("labeling_instructions", *s.Res.LabelingInstructions)
+	}
+
 	if s.Res.LifecycleDetails != nil {
 		s.D.Set("lifecycle_details", *s.Res.LifecycleDetails)
 	}

internal/service/data_labeling_service/data_labeling_service_dataset_resource.go

@@ -179,6 +179,11 @@ func DataLabelingServiceDatasetResource() *schema.Resource {
 					},
 				},
 			},
+			"labeling_instructions": {
+				Type:     schema.TypeString,
+				Optional: true,
+				Computed: true,
+			},
 
 			// Computed
 			"lifecycle_details": {
@@ -349,6 +354,11 @@ func (s *DataLabelingServiceDatasetResourceCrud) Create() error {
 		}
 	}
 
+	if labelingInstructions, ok := s.D.GetOkExists("labeling_instructions"); ok {
+		tmp := labelingInstructions.(string)
+		request.LabelingInstructions = &tmp
+	}
+
 	request.RequestMetadata.RetryPolicy = tfresource.GetRetryPolicy(s.DisableNotFoundRetries, "data_labeling_service")
 
 	response, err := s.Client.CreateDataset(context.Background(), request)
@@ -547,6 +557,11 @@ func (s *DataLabelingServiceDatasetResourceCrud) Update() error {
 		request.FreeformTags = utils.ObjectMapToStringMap(freeformTags.(map[string]interface{}))
 	}
 
+	if labelingInstructions, ok := s.D.GetOkExists("labeling_instructions"); ok {
+		tmp := labelingInstructions.(string)
+		request.LabelingInstructions = &tmp
+	}
+
 	request.RequestMetadata.RetryPolicy = tfresource.GetRetryPolicy(s.DisableNotFoundRetries, "data_labeling_service")
 
 	response, err := s.Client.UpdateDataset(context.Background(), request)
@@ -633,6 +648,10 @@ func (s *DataLabelingServiceDatasetResourceCrud) SetData() error {
 		s.D.Set("label_set", nil)
 	}
 
+	if s.Res.LabelingInstructions != nil {
+		s.D.Set("labeling_instructions", *s.Res.LabelingInstructions)
+	}
+
 	if s.Res.LifecycleDetails != nil {
 		s.D.Set("lifecycle_details", *s.Res.LifecycleDetails)
 	}

website/docs/d/data_labeling_service_dataset.html.markdown

@@ -39,19 +39,24 @@ The following attributes are exported:
 * `dataset_source_details` - This allows the customer to specify the source of the dataset.
 	* `bucket` - The object storage bucket that contains the dataset data source
 	* `namespace` - Namespace of the bucket that contains the dataset data source
-	* `prefix` - A common path prefix shared by the objects that make up the dataset.
+	* `prefix` - A common path prefix shared by the objects that make up the dataset. Records will not be generated for objects whose name match exactly with prefix.
 	* `source_type` - Source type.  OBJECT_STORAGE allows the customer to describe where the dataset is in object storage.
-* `defined_tags` - Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` 
+* `defined_tags` - The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` 
 * `description` - A user provided description of the dataset
 * `display_name` - A user-friendly display name for the resource.
-* `freeform_tags` - Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` 
+* `freeform_tags` - A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` 
 * `id` - The OCID of the Dataset.
 * `initial_record_generation_configuration` - Initial Generate Records configuration, generates records from the Dataset's source.
 * `label_set` - An ordered collection of Labels that are unique by name. 
 	* `items` - An ordered collection of Labels that are unique by name.
 		* `name` - An unique name for a label within its dataset.
+* `labeling_instructions` - The labeling instructions for human labelers in rich text format
 * `lifecycle_details` - A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in FAILED or NEEDS_ATTENTION state.
 * `state` - The state of a dataset. CREATING - The dataset is being created.  It will transition to ACTIVE when it is ready for labeling. ACTIVE   - The dataset is ready for labeling. UPDATING - The dataset is being updated.  It and its related resources may be unavailable for other updates until it returns to ACTIVE. NEEDS_ATTENTION - A dataset updation operation has failed due to validation or other errors and needs attention. DELETING - The dataset and its related resources are being deleted. DELETED  - The dataset has been deleted and is no longer available. FAILED   - The dataset has failed due to validation or other errors. 
+<<<<<<< ours
+* `system_tags` - The usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{"orcl-cloud": {"free-tier-retained": "true"}}` 
+=======
+>>>>>>> theirs
 * `time_created` - The date and time the resource was created, in the timestamp format defined by RFC3339.
 * `time_updated` - The date and time the resource was last updated, in the timestamp format defined by RFC3339.
 

website/docs/d/data_labeling_service_datasets.html.markdown

@@ -56,19 +56,24 @@ The following attributes are exported:
 * `dataset_source_details` - This allows the customer to specify the source of the dataset.
 	* `bucket` - The object storage bucket that contains the dataset data source
 	* `namespace` - Namespace of the bucket that contains the dataset data source
-	* `prefix` - A common path prefix shared by the objects that make up the dataset.
+	* `prefix` - A common path prefix shared by the objects that make up the dataset. Records will not be generated for objects whose name match exactly with prefix.
 	* `source_type` - Source type.  OBJECT_STORAGE allows the customer to describe where the dataset is in object storage.
-* `defined_tags` - Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace.bar-key": "value"}` 
+* `defined_tags` - The defined tags for this resource. Each key is predefined and scoped to a namespace. For example: `{"foo-namespace": {"bar-key": "value"}}` 
 * `description` - A user provided description of the dataset
 * `display_name` - A user-friendly display name for the resource.
-* `freeform_tags` - Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` 
+* `freeform_tags` - A simple key-value pair that is applied without any predefined name, type, or scope. It exists for cross-compatibility only. For example: `{"bar-key": "value"}` 
 * `id` - The OCID of the Dataset.
 * `initial_record_generation_configuration` - Initial Generate Records configuration, generates records from the Dataset's source.
 * `label_set` - An ordered collection of Labels that are unique by name. 
 	* `items` - An ordered collection of Labels that are unique by name.
 		* `name` - An unique name for a label within its dataset.
+* `labeling_instructions` - The labeling instructions for human labelers in rich text format
 * `lifecycle_details` - A message describing the current state in more detail. For example, it can be used to provide actionable information for a resource in FAILED or NEEDS_ATTENTION state.
 * `state` - The state of a dataset. CREATING - The dataset is being created.  It will transition to ACTIVE when it is ready for labeling. ACTIVE   - The dataset is ready for labeling. UPDATING - The dataset is being updated.  It and its related resources may be unavailable for other updates until it returns to ACTIVE. NEEDS_ATTENTION - A dataset updation operation has failed due to validation or other errors and needs attention. DELETING - The dataset and its related resources are being deleted. DELETED  - The dataset has been deleted and is no longer available. FAILED   - The dataset has failed due to validation or other errors. 
+<<<<<<< ours
+* `system_tags` - The usage of system tag keys. These predefined keys are scoped to namespaces. For example: `{"orcl-cloud": {"free-tier-retained": "true"}}` 
+=======
+>>>>>>> theirs
 * `time_created` - The date and time the resource was created, in the timestamp format defined by RFC3339.
 * `time_updated` - The date and time the resource was last updated, in the timestamp format defined by RFC3339.