[ignore] temporary commit for review of new list resources

Author: akinross

docs/list-resources/relation_to_domain.md

@@ -0,0 +1,60 @@
+---
+# Documentation generated by "gen/generator.go"; DO NOT EDIT.
+# In order to regenerate this file execute `go generate` from the repository root.
+# More details can be found in the [README](https://github.com/CiscoDevNet/terraform-provider-aci/blob/master/README.md).
+subcategory: "Application Management"
+layout: "aci"
+page_title: "ACI: aci_relation_to_domain"
+sidebar_current: "docs-aci-list-resource-aci_relation_to_domain"
+description: |-
+  Manages ACI Relation To Domain
+---
+
+# aci_relation_to_domain #
+
+List existing ACI Relation To Domain objects with the [terraform query](https://developer.hashicorp.com/terraform/cli/commands/query) command.
+
+For more information about the usage see the official Hashicorp documentation for [importing existing resources in bulk](https://developer.hashicorp.com/terraform/language/v1.14.x/import/bulk?page=import&page=bulk).
+
+## API Information ##
+
+* Class: [fvRsDomAtt](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvRsDomAtt/overview)
+
+* Supported in ACI versions: 1.0(1e) and later.
+
+* Distinguished Name Format: `uni/tn-{name}/ap-{name}/epg-{name}/rsdomAtt-[{tDn}]`
+
+## GUI Information ##
+
+* Location: `Tenants -> Application Profiles -> Application EPGs -> Domains (VMs and Bare-Metals)`
+
+## Example Usage ##
+
+The configuration snippet below shows an example for Relation To Domain with only required attributes.
+
+```hcl
+list "aci_relation_to_domain" "example" {
+  provider = aci
+}
+```
+
+The configuration snippet below shows an example for Relation To Domain with filter capabilties.
+
+```hcl
+list "aci_relation_to_domain" "example" {
+  provider = aci
+  config {
+    filter = "query-target-filter=eq(fvRsDomAtt.dn,\"uni/tn-{name}/ap-{name}/epg-{name}/rsdomAtt-[{tDn}]\")"
+  }
+}
+```
+
+## Schema ##
+
+### Optional ###
+
+* `config` - (map) A map that contains all configurable options for the list resource.
+    
+    ### Optional ###
+
+    * `filter` - (string) A filter to restrict the results of the class query to APIC. See [Cisco APIC REST API Configuration Guide, Release 4.2(x) and Later](https://www.cisco.com/c/en/us/td/docs/dcn/aci/apic/all/apic-rest-api-configuration-guide/cisco-apic-rest-api-configuration-guide-42x-and-later/m_using_the_rest_api.html#concept_1B75A78853DD46AABC15B048AAFAD1AD) for more information about composing filter query expressions.

docs/list-resources/tenant.md

@@ -0,0 +1,60 @@
+---
+# Documentation generated by "gen/generator.go"; DO NOT EDIT.
+# In order to regenerate this file execute `go generate` from the repository root.
+# More details can be found in the [README](https://github.com/CiscoDevNet/terraform-provider-aci/blob/master/README.md).
+subcategory: "Application Management"
+layout: "aci"
+page_title: "ACI: aci_tenant"
+sidebar_current: "docs-aci-list-resource-aci_tenant"
+description: |-
+  Manages ACI Tenant
+---
+
+# aci_tenant #
+
+List existing ACI Tenant objects with the [terraform query](https://developer.hashicorp.com/terraform/cli/commands/query) command.
+
+For more information about the usage see the official Hashicorp documentation for [importing existing resources in bulk](https://developer.hashicorp.com/terraform/language/v1.14.x/import/bulk?page=import&page=bulk).
+
+## API Information ##
+
+* Class: [fvTenant](https://pubhub.devnetcloud.com/media/model-doc-latest/docs/app/index.html#/objects/fvTenant/overview)
+
+* Supported in ACI versions: 1.0(1e) and later.
+
+* Distinguished Name Format: `uni/tn-{name}`
+
+## GUI Information ##
+
+* Location: `Tenants`
+
+## Example Usage ##
+
+The configuration snippet below shows an example for Tenant with only required attributes.
+
+```hcl
+list "aci_tenant" "example" {
+  provider = aci
+}
+```
+
+The configuration snippet below shows an example for Tenant with filter capabilties.
+
+```hcl
+list "aci_tenant" "example" {
+  provider = aci
+  config {
+    filter = "query-target-filter=eq(fvTenant.dn,\"uni/tn-{name}\")"
+  }
+}
+```
+
+## Schema ##
+
+### Optional ###
+
+* `config` - (map) A map that contains all configurable options for the list resource.
+    
+    ### Optional ###
+
+    * `filter` - (string) A filter to restrict the results of the class query to APIC. See [Cisco APIC REST API Configuration Guide, Release 4.2(x) and Later](https://www.cisco.com/c/en/us/td/docs/dcn/aci/apic/all/apic-rest-api-configuration-guide/cisco-apic-rest-api-configuration-guide-42x-and-later/m_using_the_rest_api.html#concept_1B75A78853DD46AABC15B048AAFAD1AD) for more information about composing filter query expressions.

gen/definitions/properties.yaml

@@ -96,6 +96,7 @@ global:
 
 resource_name_overwrite:
   relation_from_l3out_consumer_label_to_external_epg: "external_network_instance_profile"
+  relation_from_attachable_access_entity_profile_to_domain: "domain"
   relation_to_external_epgs: "external_network_instance_profile"
   relation_from_l3out_consumer_label_to_route_control_profile: "route_control_profile"
   relation_to_vrf: "vrf"

gen/generator.go

@@ -70,6 +70,7 @@ const (
 	datasourcesExamplesPath = "./examples/data-sources"
 	docsPath                = "./docs"
 	resourcesDocsPath       = "./docs/resources"
+	listResourcesDocsPath   = "./docs/list-resources"
 	datasourcesDocsPath     = "./docs/data-sources"
 	providerPath            = "./internal/provider/"
 )
@@ -155,6 +156,8 @@ var templateFuncs = template.FuncMap{
 	"getCustomTestDependency":                  GetCustomTestDependency,
 	"getIgnoreInLegacy":                        GetIgnoreInLegacy,
 	"isSensitiveAttribute":                     IsSensitiveAttribute,
+	"getChildClassNames":                       GetChildClassNames,
+	"getRnForListTesting":                      GetRnForListTesting,
 }
 
 func IsSensitiveAttribute(attributeName string, properties map[string]Property) bool {
@@ -167,6 +170,25 @@ func IsSensitiveAttribute(attributeName string, properties map[string]Property)
 	return false
 }
 
+func GetChildClassNames(model Model, childClassNames []string) []string {
+
+	if childClassNames == nil {
+		childClassNames = []string{}
+	}
+
+	for _, child := range model.Children {
+		if !slices.Contains(childClassNames, child.PkgName) {
+			childClassNames = append(childClassNames, child.PkgName)
+		}
+
+		if child.HasChild {
+			childClassNames = GetChildClassNames(child, childClassNames)
+		}
+
+	}
+	return childClassNames
+}
+
 func GetDeprecatedExplanation(attributeName, replacedByAttributeName string) string {
 	return fmt.Sprintf("Attribute '%s' is deprecated, please refer to '%s' instead. The attribute will be removed in the next major version of the provider.", attributeName, replacedByAttributeName)
 }
@@ -762,12 +784,14 @@ func LookupTestValue(classPkgName, originalPropertyName string, testVars map[str
 	// Referencing is done based on target_dn logic
 	// This lookup is created as a workaround to reference in an examples on non target_dn attributes
 	// Redesign of testing / example creation logic should be done to cover this reference use-case
-	if classDetails, ok := definitions.Properties[classPkgName]; ok {
-		for key, value := range classDetails.(map[interface{}]interface{}) {
-			if key.(string) == "example_value_overwrite" {
-				for k, v := range value.(map[interface{}]interface{}) {
-					if k.(string) == propertyName {
-						return v.(string)
+	if testVars["overwriteTestValue"].(bool) {
+		if classDetails, ok := definitions.Properties[classPkgName]; ok {
+			for key, value := range classDetails.(map[interface{}]interface{}) {
+				if key.(string) == "example_value_overwrite" {
+					for k, v := range value.(map[interface{}]interface{}) {
+						if k.(string) == propertyName {
+							return v.(string)
+						}
 					}
 				}
 			}
@@ -1040,9 +1064,50 @@ func getTestVars(model Model) (map[string]interface{}, error) {
 	// Adds the resource name and resource class name to the testVars map to be used in test template rendering
 	testVarsMap["resourceName"] = model.ResourceName
 	testVarsMap["resourceClassName"] = model.ResourceClassName
+	testVarsMap["pkgName"] = model.PkgName
+	// allow access to the model from testvars
+	testVarsMap["model"] = model
+	// bool to prevent/allow overwriting during value lookup for list resource testing
+	testVarsMap["overwriteTestValue"] = true
 	return testVarsMap, nil
 }
 
+func GetRnForListTesting(targetClasses interface{}, testVars map[string]interface{}) string {
+	model := testVars["model"].(Model)
+	rn := model.RnFormat
+	for _, property := range model.Properties {
+		if property.IsNaming {
+			var testValue string
+			if property.PropertyName == "tDn" {
+				testValue = GetTestTargetDn(testVars["targets"].([]interface{}), GetTargetResourceName(model.ResourceName), testValue, false, targetClasses, 0, false)
+			} else {
+				testVars["overwriteTestValue"] = false
+				testValue = LookupTestValue(model.PkgName, property.PropertyName, testVars, model.Definitions, model.Properties).(string)
+				if testValue == "test_value" {
+					testValue = LookupTestValue(model.PkgName, property.SnakeCaseName, testVars, model.Definitions, model.Properties).(string)
+				}
+				if testValue == "test_value" {
+					testValue = fmt.Sprintf("test_%s", property.SnakeCaseName)
+				}
+				testVars["overwriteTestValue"] = true
+			}
+			if len(testValue) > 0 && testValue[0] == '"' {
+				testValue = testValue[1 : len(testValue)-1]
+			}
+			rn = strings.ReplaceAll(rn, fmt.Sprintf("{%s}", property.PropertyName), testValue)
+		}
+	}
+
+	if len(model.ContainedBy) == 1 {
+		defaultParentValue := GetDefaultValues(model.PkgName, "parent_dn", model.Definitions)
+		if defaultParentValue != "" && strings.HasPrefix(defaultParentValue, "uni/") {
+			rn = fmt.Sprintf("%s/%s", defaultParentValue[4:], rn)
+		}
+	}
+
+	return rn
+}
+
 // Retrieves the property and classs overwrite definitions from the definitions YAML files
 func getDefinitions() Definitions {
 	definitions := Definitions{}
@@ -1143,9 +1208,10 @@ func migrateLegacyDocumentation() {
 
 // Container function to clean all directories properly
 func cleanDirectories() {
-	cleanDirectory(docsPath, []string{"resources", "data-sources", "guides"})
+	cleanDirectory(docsPath, []string{"list-resources", "resources", "data-sources", "guides"})
 	cleanDirectory(providerPath, []string{"provider_test.go", "utils.go", "test_constants.go", "resource_aci_rest_managed.go", "resource_aci_rest_managed_test.go", "data_source_aci_rest_managed.go", "data_source_aci_rest_managed_test.go", "annotation_unsupported.go", "data_source_aci_system.go", "data_source_aci_system_test.go", "function_compare_versions.go", "function_compare_versions_test.go"})
 	cleanDirectory(resourcesDocsPath, []string{})
+	cleanDirectory(listResourcesDocsPath, []string{})
 	cleanDirectory(datasourcesDocsPath, []string{"system.md"})
 	cleanDirectory(testVarsPath, []string{})
 	cleanDirectory("./internal/custom_types", []string{})
@@ -1330,6 +1396,7 @@ func main() {
 				}
 			}
 			renderTemplate("resource.go.tmpl", fmt.Sprintf("resource_%s_%s.go", providerName, model.ResourceName), providerPath, model)
+			renderTemplate("resource_list.go.tmpl", fmt.Sprintf("resource_%s_%s_list.go", providerName, model.ResourceName), providerPath, model)
 			renderTemplate("datasource.go.tmpl", fmt.Sprintf("data_source_%s_%s.go", providerName, model.ResourceName), providerPath, model)
 
 			os.Mkdir(fmt.Sprintf("%s/%s_%s", resourcesExamplesPath, providerName, model.ResourceName), 0755)
@@ -1342,6 +1409,7 @@ func main() {
 			// Leverage the hclwrite package to format the example code
 			model.ExampleResource = string(hclwrite.Format(getExampleCode(fmt.Sprintf("%s/%s_%s/resource.tf", resourcesExamplesPath, providerName, model.ResourceName))))
 			renderTemplate("resource.md.tmpl", fmt.Sprintf("%s.md", model.ResourceName), resourcesDocsPath, model)
+			renderTemplate("resource_list.md.tmpl", fmt.Sprintf("%s.md", model.ResourceName), listResourcesDocsPath, model)
 
 			os.Mkdir(fmt.Sprintf("%s/%s_%s", datasourcesExamplesPath, providerName, model.ResourceName), 0755)
 			renderTemplate("provider_example.tf.tmpl", fmt.Sprintf("%s_%s/provider.tf", providerName, model.ResourceName), datasourcesExamplesPath, model)
@@ -1351,6 +1419,7 @@ func main() {
 			renderTemplate("datasource.md.tmpl", fmt.Sprintf("%s.md", model.ResourceName), datasourcesDocsPath, model)
 			renderTemplate("resource_test.go.tmpl", fmt.Sprintf("resource_%s_%s_test.go", providerName, model.ResourceName), providerPath, model)
 			renderTemplate("datasource_test.go.tmpl", fmt.Sprintf("data_source_%s_%s_test.go", providerName, model.ResourceName), providerPath, model)
+			renderTemplate("resource_list_test.go.tmpl", fmt.Sprintf("resource_%s_%s_list_test.go", providerName, model.ResourceName), providerPath, model)
 		}
 	}
 }

gen/templates/provider.go.tmpl

@@ -17,9 +17,11 @@ import (
 	// "github.com/hashicorp/terraform-plugin-framework-validators/int64validator"
 
 	"github.com/hashicorp/terraform-plugin-framework/datasource"
+	"github.com/hashicorp/terraform-plugin-framework/list"
 	"github.com/hashicorp/terraform-plugin-framework/provider"
 	"github.com/hashicorp/terraform-plugin-framework/provider/schema"
 	"github.com/hashicorp/terraform-plugin-framework/resource"
+	"github.com/hashicorp/terraform-plugin-framework/resource/identityschema"
 	// temporary unused until muxing is removed
 	// "github.com/hashicorp/terraform-plugin-framework/schema/validator"
 	"github.com/hashicorp/terraform-plugin-framework/types"
@@ -33,6 +35,7 @@ var globalAllowExistingOnCreate bool
 // Ensure AciProvider satisfies various provider interfaces.
 var _ provider.Provider = &AciProvider{}
 var _ provider.ProviderWithFunctions = &AciProvider{}
+var _ provider.ProviderWithListResources = (*AciProvider)(nil)
 
 // Struct model for identity data handling
 type IdentityModel struct {
@@ -217,6 +220,17 @@ func (p *AciProvider) Configure(ctx context.Context, req provider.ConfigureReque
 
 	resp.DataSourceData = aciClient
 	resp.ResourceData = aciClient
+	resp.ListResourceData = aciClient
+}
+
+func (p *AciProvider) ListResources(ctx context.Context) []func() list.ListResource {
+	return []func() list.ListResource{
+		{{- range . }}
+			{{- if or (and .IdentifiedBy (not (and .MaxOneClassAllowed (hasPrefix .RnFormat  "rs")))) .Include}}
+		New{{.ResourceClassName}}ListResource,
+			{{- end }}
+		{{- end }}
+	}
 }
 
 func (p *AciProvider) Resources(ctx context.Context) []func() resource.Resource {