Added - Support for Discovering all resources irrespective of their lifecycle state

Author: vsin12

internal/commonexport/commonexport_functions.go

@@ -489,10 +489,16 @@ func FindResourcesGeneric(ctx *ResourceDiscoveryContext, tfMeta *TerraformResour
 			if itemMap, ok := item.(map[string]interface{}); ok {
 				if state, exists := itemMap["state"].(string); exists && len(tfMeta.DiscoverableLifecycleStates) > 0 {
 					discoverable := false
-					for _, val := range tfMeta.DiscoverableLifecycleStates {
-						if strings.EqualFold(state, val) {
-							discoverable = true
-							break
+
+					if utils.GetEnvSettingWithBlankDefault(globalvar.DiscoverAllStatesEnv) == "1" {
+						utils.Logf("Skipping Lifecycle State Check as TF_DISCOVER_ALL_STATES is set")
+						discoverable = true
+					} else {
+						for _, val := range tfMeta.DiscoverableLifecycleStates {
+							if strings.EqualFold(state, val) {
+								discoverable = true
+								break
+							}
 						}
 					}
 
@@ -609,10 +615,16 @@ func FindResourcesGeneric(ctx *ResourceDiscoveryContext, tfMeta *TerraformResour
 		discoverable := true
 		if state, ok := resource.SourceAttributes["state"]; ok && len(tfMeta.DiscoverableLifecycleStates) > 0 {
 			discoverable = false
-			for _, val := range tfMeta.DiscoverableLifecycleStates {
-				if strings.EqualFold(state.(string), val) {
-					discoverable = true
-					break
+
+			if utils.GetEnvSettingWithBlankDefault(globalvar.DiscoverAllStatesEnv) == "1" {
+				utils.Logf("Skipping Lifecycle State Check as TF_DISCOVER_ALL_STATES is set")
+				discoverable = true
+			} else {
+				for _, val := range tfMeta.DiscoverableLifecycleStates {
+					if strings.EqualFold(state.(string), val) {
+						discoverable = true
+						break
+					}
 				}
 			}
 		}

internal/globalvar/constants.go

@@ -71,6 +71,7 @@ These missing attributes are also added to the lifecycle ignore_changes.
 	EnvOCITFLogFile                     = "OCI_TF_LOG_PATH" // Log path for Custom TF logger - TFProviderLogger
 	TerraformBinPathName                = "terraform_bin_path"
 	MaxInt64                            = 1<<63 - 1 // TODO : Fix needed for GoLang SDK v1.17.2
+	DiscoverAllStatesEnv                = "TF_DISCOVER_ALL_STATES"
 )
 
 const (

internal/resourcediscovery/export_compartment_test.go

@@ -69,6 +69,14 @@ var exportChildDefinition = &tf_export.TerraformResourceHints{
 	RequireResourceRefresh:      true,
 }
 
+var exportChildDefinitionInactive = &tf_export.TerraformResourceHints{
+	ResourceClass:               "oci_test_child_inactive",
+	DatasourceClass:             "oci_test_children",
+	ResourceAbbreviation:        "child",
+	DatasourceItemsAttr:         "item_summaries",
+	DiscoverableLifecycleStates: []string{resourceDiscoveryTestInactiveLifecycle},
+}
+
 var exportParentDefinitionWithFaultyDatasource = &tf_export.TerraformResourceHints{
 	ResourceClass:               "oci_test_parent",
 	DatasourceClass:             "oci_test_error_parents",
@@ -132,6 +140,24 @@ var compartmentTestingResourceGraph = tf_export.TerraformResourceGraph{
 	},
 }
 
+var compartmentTestingResourceInactiveLifeCycleGraphGraph = tf_export.TerraformResourceGraph{
+	"oci_identity_compartment": {
+		{
+			TerraformResourceHints: exportParentDefinition,
+		},
+	},
+	"oci_test_parent": {
+		{
+			TerraformResourceHints: exportChildDefinitionInactive,
+			DatasourceQueryParams:  map[string]string{"parent_id": "id"},
+		},
+		{
+			TerraformResourceHints: exportChildDefinition,
+			DatasourceQueryParams:  map[string]string{"parent_id": "id"},
+		},
+	},
+}
+
 var compartmentTestingResourceGraphWithFaultyParentResource = tf_export.TerraformResourceGraph{
 	"oci_identity_compartment": {
 		{
@@ -1216,6 +1242,60 @@ func TestUnitFindResources_basic(t *testing.T) {
 	}
 }
 
+func TestUnitFindResourcesInActiveLifeCycle_basic(t *testing.T) {
+	initResourceDiscoveryTests()
+	defer cleanupResourceDiscoveryTests()
+	rootResource := getRootCompartmentResource()
+
+	ctx := &tf_export.ResourceDiscoveryContext{
+		ErrorList: tf_export.ErrorList{},
+	}
+	os.Setenv(globalvar.DiscoverAllStatesEnv, "1")
+
+	results, err := findResources(ctx, rootResource, compartmentTestingResourceInactiveLifeCycleGraphGraph, true)
+	if err != nil {
+		t.Logf("got error from findResources: %v", err)
+		t.Fail()
+	}
+
+	foundInactiveResource := false
+	for _, foundResource := range results {
+		if foundResource.TerraformClass == "oci_test_child_inactive" {
+			foundInactiveResource = true
+			break
+		}
+	}
+	if foundInactiveResource == false {
+		t.Logf("Inactive Resources not found")
+		t.Fail()
+	}
+}
+
+func TestUnitFindResourcesInActiveLifeCycleWithGlobalVariableNotSet_basic(t *testing.T) {
+	initResourceDiscoveryTests()
+	defer cleanupResourceDiscoveryTests()
+	rootResource := getRootCompartmentResource()
+
+	ctx := &tf_export.ResourceDiscoveryContext{
+		ErrorList: tf_export.ErrorList{},
+	}
+
+	os.Unsetenv(globalvar.DiscoverAllStatesEnv)
+
+	results, err := findResources(ctx, rootResource, compartmentTestingResourceInactiveLifeCycleGraphGraph, true)
+	if err != nil {
+		t.Logf("got error from findResources: %v", err)
+		t.Fail()
+	}
+
+	for _, foundResource := range results {
+		if foundResource.TerraformClass == "oci_test_child_inactive" {
+			t.Logf("Inactive resource found even when export variable TF_DISCOVER_ALL_STATES is not set to 1: %v", err)
+			t.Fail()
+		}
+	}
+}
+
 // Test that resources can be found using a resource dependency graph
 // issue-routing-tag: terraform/default
 func TestUnitFindResources_filter(t *testing.T) {
@@ -1232,7 +1312,7 @@ func TestUnitFindResources_filter(t *testing.T) {
 			}},
 		},
 	}
-	results, err := findResources(ctx, rootResource, compartmentTestingResourceGraph, true)
+	results, err := findResources(ctx, rootResource, compartmentTestingResourceGraph, false)
 	if err != nil {
 		t.Logf("got error from findResources: %v", err)
 		t.Fail()

website/docs/guides/resource_discovery.html.markdown

@@ -333,6 +333,15 @@ Example for specifying multiple filters
 ```
 --filter="Type=oci_core_vcn" --filter="AttrName=dns_label;Value=test"     // discover resources of type oci_core_vcn such that they have dns_label attribute value as test
 ```
+### Discover all resources
+
+If TF_DISCOVER_ALL_STATES is set to 1, then Resource Discovery will try to discover all resources irrespective of 
+their lifecycle state.
+
+```
+export TF_DISCOVER_ALL_STATES=1
+```
+
 
 ### Supported Resources
 As of this writing, the list of Terraform services and resources that can be discovered by the command is as follows.