Update struct types and functions in terraform provider

Multiple struct types are renamed and added to translate structs in the `terraform_provider` package. The changes affect the `struct.go`, `terraform_provider_file.go` and `template.go` files. Also added instructions in `README.md` file for using the provider locally. Changes also include debugging information in `terraform_provider_file.go` and function renaming/updates in several places in the code.

Author: pimielowski

assets/provider/README.md

@@ -0,0 +1,98 @@
+### How to use it locally
+
+Firstly you need to create `.terraformrc` file in your home directory:
+
+```shell
+touch ~/.terraformrc
+```
+
+The content of the file should look like that: 
+
+```
+provider_installation {
+
+  dev_overrides {
+      "github.com/PaloAltoNetworks/panos" = "/home/USERNAME/go/bin"
+  }
+
+  # For all other providers, install them directly from their origin provider
+  # registries as normal. If you omit this, Terraform will _only_ use
+  # the dev_overrides block, and so no other providers will be available.
+  direct {}
+}
+```
+
+Now when you generate the terraform-provider go to `terraform-provider-panos` folder and follow steps:
+
+Install dependencies:
+```shell
+go mod tidy
+```
+
+Install provider:
+
+```shell
+go install .
+```
+
+Now you can use Terraform with locally built provider.
+
+Example Terraform file: 
+
+`provider.tf`
+```terraform
+# Traditional provider example.
+provider "panos" {
+  hostname = ""
+  username = ""
+  password = ""
+  skip_verify_certificate = true
+}
+
+# Local inspection mode provider example.
+# provider "panos" {
+#   #config_file = file("/tmp/candidate-config.xml")
+#
+#   # This is only used if a "detail-version" attribute is not present in
+#   # the exported XML schema. If it's there, this can be omitted.
+#   panos_version = "10.2.0"
+# }
+
+terraform {
+  required_providers {
+    panos = {
+      source  = "github.com/PaloAltoNetworks/panos"
+      version = "2.0.0"
+    }
+  }
+}
+```
+
+`main.tf`
+
+```terraform
+resource "panos_address_group" "test1" {
+  location = {
+    device_group = {
+      name = "test123"
+    }
+  }
+
+  name = "test123123"
+}
+
+resource "panos_address_object" "test1" {
+  location = {
+    device_group = {
+      name = "test123"
+    }
+  }
+
+  name = "test123123"
+  fqdn = "10.0.0.0"
+  ip_netmask = "8"
+}
+```
+
+### Known issue:
+In early stages of Terraform Provider development helps a lot manually removing the resources and the statefile, after that some errors not occurred again.

pkg/translate/terraform_provider/struct.go

@@ -31,13 +31,43 @@ type deviceGroupLocation struct {
 	PanoramaDevice string
 }
 
-type resourceLocation struct {
+type resourceObjectLocation struct {
 	FromPanorama bool
 	Shared       bool
 	Vsys         vsysLocation
 	DeviceGroup  deviceGroupLocation
 }
 
+type ngfwLocation struct {
+	NgfwDevice string
+}
+
+type templateLocation struct {
+	NgfwDevice     string
+	PanoramaDevice string
+	Template       string
+}
+
+type templateStackLocation struct {
+	NgfwDevice     string
+	PanoramaDevice string
+	TemplateStack  string
+}
+
+type resourceNGFWConfigLocation struct {
+	Ngfw          ngfwLocation
+	Template      templateLocation
+	TemplateStack templateStackLocation
+}
+
+type panoramaLocation struct {
+	PanoramaDevice string
+}
+
+type resourcePanoramaConfigLocation struct {
+	Panorama panoramaLocation
+}
+
 // ParamToModelBasic converts the given parameter name and properties to a model representation.
 func ParamToModelBasic(paramName string, paramProp interface{}) (string, error) {
 	data := map[string]interface{}{
@@ -54,8 +84,8 @@ func ParamToModelBasic(paramName string, paramProp interface{}) (string, error)
 {{- /* Done */ -}}`, "param-to-model", data, nil)
 }
 
-// ParamToSchema converts the given parameter name and properties to a schema representation.
-func ParamToSchema(paramName string, paramProp interface{}) (string, error) {
+// ParamToSchemaProvider converts the given parameter name and properties to a schema representation.
+func ParamToSchemaProvider(paramName string, paramProp interface{}) (string, error) {
 	return processTemplate(`
 {{- /* Begin */ -}}
     "`+paramName+`": schema.{{ CamelCaseType .Type }}Attribute{
@@ -77,11 +107,13 @@ func ParamToSchema(paramName string, paramProp interface{}) (string, error) {
 }
 
 func ParamToSchemaResource(paramName string, paramProp interface{}, terraformProvider *properties.TerraformProviderFile) (string, error) {
-	if paramProp.(properties.SpecParam).Type == "bool" && paramProp.(properties.SpecParam).Default != "" {
-		terraformProvider.ImportManager.AddHashicorpImport("github.com/hashicorp/terraform-plugin-framework/resource/schema/booldefault", "")
-	}
+	switch v := paramProp.(type) {
+	case *properties.SpecParam:
+		if v.Type == "bool" && v.Default != "" {
+			terraformProvider.ImportManager.AddHashicorpImport("github.com/hashicorp/terraform-plugin-framework/resource/schema/booldefault", "")
+		}
 
-	return processTemplate(`
+		return processTemplate(`
 {{- /* Begin */ -}}
 {{- if .Type }}
     "`+strings.ReplaceAll(paramName, "-", "_")+`": rsschema.{{ CamelCaseType .Type }}Attribute{
@@ -102,11 +134,24 @@ func ParamToSchemaResource(paramName string, paramProp interface{}, terraformPro
 		Computed: true ,
 		{{- end }}
     },
-{{- /* Done */ -}}`, "describe-param", paramProp, nil)
-}
+{{- /* Done */ -}}`, "describe-param", v, nil)
+
+	case *properties.Location:
+		return processTemplate(`
+{{- /* Begin */ -}}
+{{- if .Vars }}
+     "`+strings.ReplaceAll(paramName, "-", "_")+`": rsschema.SingleNestedAttribute{
+{{- else }}
+    "`+strings.ReplaceAll(paramName, "-", "_")+`": rsschema.StringAttribute{
+{{- end }}
+        Description: "{{ .Description }}",
+		Required: true,
+    },
+{{- /* Done */ -}}`, "describe-location", v, nil)
 
-func checkForObjectValidation(paramProp interface{}) bool {
-	return true
+	default:
+		return "", fmt.Errorf("unsupported type: %T", paramProp)
+	}
 }
 
 func CreateResourceSchemaLocationAttribute() (string, error) {
@@ -218,6 +263,7 @@ func CreateNestedStruct(paramName string, paramProp *properties.SpecParam, struc
 	return nestedStructString.String(), nil
 }
 
+// CreateLocationStruct generates a corresponding Terraform location struct if the provided value is a struct, otherwise, it returns an error.
 func CreateLocationStruct(v interface{}, structName string) (string, error) {
 	val := reflect.ValueOf(v)
 	t := val.Type()

pkg/translate/terraform_provider/template.go

@@ -130,7 +130,6 @@ type {{ structName }} struct {
 }
 
 type {{ structName }}Tfid struct {
-	//TODO: Generate tfid struct via function
 	{{ CreateTfIdStruct }}
 }
 
@@ -158,7 +157,6 @@ type {{ structName }}DeviceGroupLocation struct {
 }
 
 type {{ structName }}Model struct {
-// TODO: Entry model struct via function
 		{{ CreateTfIdResourceModel }}
 		Name types.String` + "`" + `tfsdk:"name"` + "`" + `
         {{- range $pName, $pParam := $.Spec.Params}}
@@ -190,11 +188,20 @@ func (r *{{ structName }}) Schema(ctx context.Context, req resource.SchemaReques
 		Description: "The name of the resource.",
 		Required:    true,
 	},	
-	{{- range $pName, $pParam := $.Spec.Params }}
-	{{ ResourceParamToSchema $pName $pParam }}
+	"location": rsschema.SingleNestedAttribute{
+		Description: "The location of this object.",
+		Required:    true,
+		Attributes: map[string]rsschema.Attribute{	
+	{{- range $pName, $pParam := $.Locations -}}
+		{{ ResourceParamToSchema $pName $pParam }}
+	{{- end }}
+	}
+},
+	{{- range $pName, $pParam := $.Spec.Params -}}
+		{{ ResourceParamToSchema $pName $pParam }}
 	{{- end }}
-	{{- range $pName, $pParam := $.Spec.OneOf }}
-	{{ ResourceParamToSchema $pName $pParam }}
+	{{- range $pName, $pParam := $.Spec.OneOf -}}
+		{{ ResourceParamToSchema $pName $pParam }}
 	{{- end }}
 		},
 	}
@@ -644,7 +651,7 @@ func (p *PanosProvider) Schema(_ context.Context, _ provider.SchemaRequest, resp
 		Description: "Terraform provider to interact with Palo Alto Networks PAN-OS.",
 		Attributes: map[string]schema.Attribute{
 {{- range $pName, $pParam := ProviderParams }}
-{{ ParamToSchema $pName $pParam }}
+{{ ParamToSchemaProvider $pName $pParam }}
 {{- end }}
 		},
 	}

pkg/translate/terraform_provider/terraform_provider_file.go

@@ -114,12 +114,14 @@ func (g *GenerateTerraformProvider) GenerateTerraformResource(spec *properties.N
 		},
 		"ParamToModelResource": ParamToModelResource,
 		"ModelNestedStruct":    ModelNestedStruct,
-		"ResourceParamToSchema": func(paramName string, paramParameters properties.SpecParam) (string, error) {
+		"ResourceParamToSchema": func(paramName string, paramParameters interface{}) (string, error) {
 			return ParamToSchemaResource(paramName, paramParameters, terraformProvider)
 		},
 		"ResourceSchemaLocationAttribute": CreateResourceSchemaLocationAttribute,
-		"CreateLocationStruct":            func(structName string) (string, error) { return CreateLocationStruct(resourceLocation{}, structName) },
-		"CreateLocationVsysStruct":        func(structName string) (string, error) { return CreateLocationStruct(vsysLocation{}, structName) },
+		"CreateLocationStruct": func(structName string) (string, error) {
+			return CreateLocationStruct(resourceObjectLocation{}, structName)
+		},
+		"CreateLocationVsysStruct": func(structName string) (string, error) { return CreateLocationStruct(vsysLocation{}, structName) },
 		"CreateLocationDeviceGroupStruct": func(structName string) (string, error) {
 			return CreateLocationStruct(deviceGroupLocation{}, structName)
 		},
@@ -165,6 +167,26 @@ func (g *GenerateTerraformProvider) GenerateTerraformResource(spec *properties.N
 			}
 		}
 	}
+
+	// START DEBUG
+
+	log.Printf("Whole properties: %s \n", spec)
+	log.Printf("Whole Location: %s \n", spec.Locations)
+	log.Printf("Location formatted: %v \n", spec.Locations)
+
+	for i := range spec.Locations {
+		log.Printf("Location: %v \n", i)
+		log.Printf("Location spec: %v \n", spec.Locations[i])
+	}
+	for n := range spec.Spec.Params {
+		log.Printf("Spec param: %v \n", n)
+		log.Printf("Spec param spec: %v \n", spec.Spec.Params[n])
+	}
+	for k := range spec.Spec.OneOf {
+		log.Printf("Spec oneof: %v \n", k)
+		log.Printf("Spec oneof spec: %v \n", spec.Spec.OneOf[k])
+	}
+	// END OF DEBUG
 	return nil
 }
 
@@ -235,8 +257,8 @@ func (g *GenerateTerraformProvider) GenerateTerraformProvider(terraformProvider
 		"ParamToModelBasic": func(paramName string, paramProp properties.TerraformProviderParams) (string, error) {
 			return ParamToModelBasic(paramName, paramProp)
 		},
-		"ParamToSchema": func(paramName string, paramProp properties.TerraformProviderParams) (string, error) {
-			return ParamToSchema(paramName, paramProp)
+		"ParamToSchemaProvider": func(paramName string, paramProp properties.TerraformProviderParams) (string, error) {
+			return ParamToSchemaProvider(paramName, paramProp)
 		},
 	}
 	return g.generateTerraformEntityTemplate("ProviderFile", &NameProvider{}, spec, terraformProvider, providerTemplateStr, funcMap)