Add test hooks and test cases for maintenance reboot time field.

To support this we, separate out test client configuration logic to allow intercepting
SDK requests.

Author: alexng-canuck

oci/core_instance_resource.go

@@ -714,7 +714,7 @@ func (s *InstanceResourceCrud) SetData() error {
 	if s.Res.TimeMaintenanceRebootDue != nil {
 		s.D.Set("time_maintenance_reboot_due", s.Res.TimeMaintenanceRebootDue.String())
 	} else {
-		// If the maintenance time is cleared after reboot, the service will return a nil. 
+		// If the maintenance time is cleared after reboot, the service will return a nil.
 		// We should explicitly zero it out to avoid returning the previously cached reboot time.
 		s.D.Set("time_maintenance_reboot_due", "")
 	}

oci/core_instance_test.go

@@ -94,7 +94,11 @@ variable "InstanceImageOCID" {
 
 func TestCoreInstanceResource_basic(t *testing.T) {
 	provider := testAccProvider
-	config := testProviderConfig()
+	config := `
+		provider oci {
+			test_time_maintenance_reboot_due = "2030-01-01 00:00:00"
+		}
+	` + commonTestVariables()
 
 	compartmentId := getEnvSettingWithBlankDefault("compartment_ocid")
 	compartmentIdVariableStr := fmt.Sprintf("variable \"compartment_id\" { default = \"%s\" }\n", compartmentId)
@@ -114,13 +118,14 @@ func TestCoreInstanceResource_basic(t *testing.T) {
 		Steps: []resource.TestStep{
 			// verify create
 			{
-				Config: config + compartmentIdVariableStr + InstanceResourceDependencies +
+				Config: testProviderConfig() + compartmentIdVariableStr + InstanceResourceDependencies +
 					generateResourceFromRepresentationMap("oci_core_instance", "test_instance", Required, Create, instanceRepresentation),
 				Check: resource.ComposeAggregateTestCheckFunc(
 					resource.TestCheckResourceAttrSet(resourceName, "availability_domain"),
 					resource.TestCheckResourceAttr(resourceName, "compartment_id", compartmentId),
 					resource.TestCheckResourceAttr(resourceName, "shape", "VM.Standard1.2"),
 					resource.TestCheckResourceAttrSet(resourceName, "subnet_id"),
+					resource.TestCheckResourceAttr(resourceName, "time_maintenance_reboot_due", ""),
 
 					func(s *terraform.State) (err error) {
 						resId, err = fromInstanceState(s, resourceName, "id")
@@ -167,6 +172,7 @@ func TestCoreInstanceResource_basic(t *testing.T) {
 					resource.TestCheckResourceAttrSet(resourceName, "state"),
 					resource.TestCheckResourceAttrSet(resourceName, "subnet_id"),
 					resource.TestCheckResourceAttrSet(resourceName, "time_created"),
+					resource.TestCheckResourceAttrSet(resourceName, "time_maintenance_reboot_due"),
 
 					func(s *terraform.State) (err error) {
 						resId, err = fromInstanceState(s, resourceName, "id")
@@ -250,6 +256,7 @@ func TestCoreInstanceResource_basic(t *testing.T) {
 					resource.TestCheckResourceAttr(datasourceName, "instances.0.source_details.0.source_type", "image"),
 					resource.TestCheckResourceAttrSet(datasourceName, "instances.0.state"),
 					resource.TestCheckResourceAttrSet(datasourceName, "instances.0.time_created"),
+					resource.TestCheckResourceAttrSet(datasourceName, "instances.0.time_maintenance_reboot_due"),
 				),
 			},
 			// verify singular datasource
@@ -277,6 +284,7 @@ func TestCoreInstanceResource_basic(t *testing.T) {
 					resource.TestCheckResourceAttr(singularDatasourceName, "source_details.0.source_type", "image"),
 					resource.TestCheckResourceAttrSet(singularDatasourceName, "state"),
 					resource.TestCheckResourceAttrSet(singularDatasourceName, "time_created"),
+					resource.TestCheckResourceAttrSet(singularDatasourceName, "time_maintenance_reboot_due"),
 
 					resource.TestCheckResourceAttrSet(singularDatasourceName, "public_ip"),
 					resource.TestCheckResourceAttrSet(singularDatasourceName, "private_ip"),

oci/provider_test.go

@@ -4,6 +4,7 @@ package provider
 
 import (
 	"fmt"
+	"net/http"
 	"runtime"
 	"sort"
 	"strings"
@@ -23,21 +24,32 @@ var requiredKeyAuthEnvVars = []string{"tenancy_ocid", "user_ocid", "fingerprint"
 var requiredOboTokenAuthEnvVars = []string{"tenancy_ocid", "obo_token"}
 
 func init() {
-	testAccProvider = Provider(func(d *schema.ResourceData) (interface{}, error) {
-		return GetTestProvider(), nil
+	testAccProvider = testProvider(func(d *schema.ResourceData) (interface{}, error) {
+		return GetTestClients(d), nil
 	}).(*schema.Provider)
 
 	testAccProviders = map[string]terraform.ResourceProvider{
 		"oci": testAccProvider,
 	}
 }
 
-func testProviderConfig() string {
-	return `
-	# Need to have this block even though it's empty; for import testing
-	provider "oci" {
+// Provider is the adapter for terraform, that gives access to all the resources
+func testProvider(configfn schema.ConfigureFunc) terraform.ResourceProvider {
+	result := &schema.Provider{
+		DataSourcesMap: dataSourcesMap(),
+		Schema:         schemaMap(),
+		ResourcesMap:   resourcesMap(),
+		ConfigureFunc:  configfn,
 	}
 
+	// Additions for test parameters
+	result.Schema["test_time_maintenance_reboot_due"] = &schema.Schema{Type: schema.TypeString, Optional: true}
+
+	return result
+}
+
+func commonTestVariables() string {
+	return `
 	variable "tenancy_ocid" {
 		default = "` + getEnvSettingWithBlankDefault("tenancy_ocid") + `"
 	}
@@ -53,6 +65,14 @@ func testProviderConfig() string {
 	`
 }
 
+func testProviderConfig() string {
+	return `
+	# Need to have this block even though it's empty; for import testing
+	provider "oci" {
+	}
+	` + commonTestVariables()
+}
+
 func testAccPreCheck(t *testing.T) {
 	envVarChecklist := []string{}
 	copy(envVarChecklist, requiredTestEnvVars)
@@ -216,7 +236,11 @@ resource "oci_core_instance" "t" {
 ` + DefinedTagsDependencies
 )
 
-func GetTestProvider() *OracleClients {
+const (
+	requestQueryOpcTimeMaintenanceRebootDue = "opc-time-maintenance-reboot-due"
+)
+
+func GetTestClients(data *schema.ResourceData) *OracleClients {
 	r := &schema.Resource{
 		Schema: schemaMap(),
 	}
@@ -240,6 +264,32 @@ func GetTestProvider() *OracleClients {
 	if err != nil {
 		panic(err)
 	}
+
+	// This is a test hook to support creating instances that have a maintenance reboot time set
+	// The test hook allows 'time_maintenance_reboot_due' field to be tested for instance datasources/resources
+	// This is controlled by a provider option rather than environment variable: so that the tests can run in parallel
+	// without affecting one another and also allow individual test steps to alter this
+	//
+	// If we have additional test hooks that need to be supported in this manner, then the following logic should be
+	// compartmentalized and registered with the test provider in a scalable manner.
+	maintenanceRebootTime, ok := data.GetOkExists("test_time_maintenance_reboot_due")
+	if ok {
+		computeClient := client.(*OracleClients).computeClient
+		baseInterceptor := computeClient.Interceptor
+		computeClient.Interceptor = func(r *http.Request) error {
+			if err := baseInterceptor(r); err != nil {
+				return err
+			}
+
+			if r.Method == http.MethodPost && (strings.Contains(r.URL.Path, "/instances")) {
+				query := r.URL.Query()
+				query.Set(requestQueryOpcTimeMaintenanceRebootDue, maintenanceRebootTime.(string))
+				r.URL.RawQuery = query.Encode()
+			}
+			return nil
+		}
+	}
+
 	return client.(*OracleClients)
 }