Merge pull request #338 from breml/cleanup-generated-datasources-projects-targets

Cleanup generated datasources project and target attributes

Author: stgraber

cmd/generate-datasources/config.go

@@ -49,6 +49,11 @@ type Entity struct {
 	// `has-no-project` needs to be set to `true`.
 	HasNoProject bool `yaml:"has-no-project"`
 
+	// If a resource has a target.
+	// Most resources do not have a target attribute. If a resource does have a
+	// target, `has-target` needs to be set to `true`.
+	HasTarget bool `yaml:"has-target"`
+
 	// If a resource has no status attribute.
 	// Most resources do have a status attribute. If this is not the case,
 	// `has-no-status` needs to be set to `true`.

cmd/generate-datasources/main.go

@@ -113,6 +113,9 @@ type entityArgs struct {
 	// Inverted value from `has-no-project`.
 	HasProject bool
 
+	// Value from `has-target`.
+	HasTarget bool
+
 	// Inverted value from `has-no-status`.
 	HasStatus bool
 
@@ -189,6 +192,7 @@ func main() {
 			HasParent:                      entity.ParentName != "",
 			ParentName:                     entity.ParentName,
 			HasProject:                     !entity.HasNoProject,
+			HasTarget:                      entity.HasTarget,
 			HasStatus:                      !entity.HasNoStatus,
 			HasLocation:                    entity.HasLocation,
 			HasLocations:                   entity.HasLocations,

cmd/generate-datasources/tmpl/datasource.go.gotmpl

@@ -89,14 +89,22 @@ import (
 	"context"
 	"fmt"
 
+	{{ if or .HasProject .HasTarget -}}
 	"github.com/hashicorp/terraform-plugin-framework-validators/stringvalidator"
-	{{ if $requireAttr }}"github.com/hashicorp/terraform-plugin-framework/attr"{{ end }}
+	{{ end -}}
+	{{ if $requireAttr -}}
+	"github.com/hashicorp/terraform-plugin-framework/attr"
+	{{ end -}}
 	"github.com/hashicorp/terraform-plugin-framework/datasource"
 	"github.com/hashicorp/terraform-plugin-framework/datasource/schema"
+	{{ if or .HasProject .HasTarget -}}
 	"github.com/hashicorp/terraform-plugin-framework/schema/validator"
+	{{ end -}}
 	"github.com/hashicorp/terraform-plugin-framework/diag"
 	"github.com/hashicorp/terraform-plugin-framework/types"
-	{{ if $requireBasetypes }}"github.com/hashicorp/terraform-plugin-framework/types/basetypes"{{ end }}
+	{{ if $requireBasetypes -}}
+	"github.com/hashicorp/terraform-plugin-framework/types/basetypes"
+	{{ end }}
 
 	"github.com/lxc/terraform-provider-incus/internal/common"
 	"github.com/lxc/terraform-provider-incus/internal/errors"
@@ -114,7 +122,9 @@ type {{ .Name | pascalcase }}DataSourceModel struct {
 	{{- if .HasProject }}
 		Project     types.String `tfsdk:"project"`
 	{{- end }}
+	{{- if .HasTarget }}
 	Target      types.String `tfsdk:"target"`
+	{{- end }}
 	Remote      types.String `tfsdk:"remote"`
 
 	Description types.String `tfsdk:"description"`
@@ -182,13 +192,15 @@ func (d *{{ .Name | pascalcase }}DataSource) Schema(ctx context.Context, req dat
 			"remote": schema.StringAttribute{
 				Optional: true,
 			},
+			{{- if .HasTarget }}
 
 			"target": schema.StringAttribute{
 				Optional: true,
 				Validators: []validator.String{
 					stringvalidator.LengthAtLeast(1),
 				},
 			},
+			{{- end }}
 
 			"description": schema.StringAttribute{
 				Optional: true,
@@ -304,7 +316,11 @@ func (d *{{ .Name | pascalcase }}DataSource) Read(ctx context.Context, req datas
 	{{- else }}
 		providerProjectName := ""
 	{{- end }}
+	{{- if .HasTarget }}
 	providerTarget := state.Target.ValueString()
+	{{- else }}
+	providerTarget := ""
+	{{- end }}
 	server, err := d.provider.InstanceServer(providerRemote, providerProjectName, providerTarget)
 	if err != nil {
 		resp.Diagnostics.Append(errors.NewInstanceServerError(err))

cmd/generate-datasources/tmpl/docs.md.gotmpl

@@ -59,11 +59,13 @@ output "{{ .Name }}_{{ .ObjectNamePropertyName }}" {
 {{- with $.ExtraDescriptions.remote }}
 {{ . | indent 2 }}
 {{- end }}
+{{- if .HasTarget }}
 
 * `target` - *Optional* - Specify a target node in a cluster.
 {{- with $.ExtraDescriptions.target }}
 {{ . | indent 2 }}
 {{- end }}
+{{- end }}
 
 ## Attribute Reference
 

docs/data-sources/instance.md

@@ -24,8 +24,6 @@ output "instance_name" {
 * `remote` - *Optional* - The remote in which the resource was created. If
   not provided, the provider's default remote will be used.
 
-* `target` - *Optional* - Specify a target node in a cluster.
-
 ## Attribute Reference
 
 * `description` - Description of the instance.

docs/data-sources/network_acl.md

@@ -24,8 +24,6 @@ output "network_acl_name" {
 * `remote` - *Optional* - The remote in which the resource was created. If
   not provided, the provider's default remote will be used.
 
-* `target` - *Optional* - Specify a target node in a cluster.
-
 ## Attribute Reference
 
 * `description` - Description of the network ACL.

docs/data-sources/network_address_set.md

@@ -24,8 +24,6 @@ output "network_address_set_name" {
 * `remote` - *Optional* - The remote in which the resource was created. If
   not provided, the provider's default remote will be used.
 
-* `target` - *Optional* - Specify a target node in a cluster.
-
 ## Attribute Reference
 
 * `description` - Description of the network address set.

docs/data-sources/network_integration.md

@@ -19,13 +19,9 @@ output "network_integration_name" {
 
 * `name` - **Required** - Name of the network integration.
 
-* `project` - *Optional* - Name of the project where the network integration is be stored.
-
 * `remote` - *Optional* - The remote in which the resource was created. If
   not provided, the provider's default remote will be used.
 
-* `target` - *Optional* - Specify a target node in a cluster.
-
 ## Attribute Reference
 
 * `description` - Description of the network integration.

docs/data-sources/network_load_balancer.md

@@ -27,8 +27,6 @@ output "network_load_balancer_listen_address" {
 * `remote` - *Optional* - The remote in which the resource was created. If
   not provided, the provider's default remote will be used.
 
-* `target` - *Optional* - Specify a target node in a cluster.
-
 ## Attribute Reference
 
 * `description` - Description of the network load balancer.

docs/data-sources/network_peer.md

@@ -27,8 +27,6 @@ output "network_peer_name" {
 * `remote` - *Optional* - The remote in which the resource was created. If
   not provided, the provider's default remote will be used.
 
-* `target` - *Optional* - Specify a target node in a cluster.
-
 ## Attribute Reference
 
 * `description` - Description of the network peer.