Improve ignore_metadata_changes by adding support to OpenAPI entries

.changes/v3.11.0/1018-improvements.md

@@ -0,0 +1 @@
+* Add `metadata_entry` attribute to `vcd_rde` resource and data source to manage metadata entries in Runtime Defined Entities [GH-1018]

go.mod

@@ -65,3 +65,5 @@ require (
 	google.golang.org/grpc v1.57.1 // indirect
 	google.golang.org/protobuf v1.31.0 // indirect
 )
+
+replace github.com/vmware/go-vcloud-director/v2 => github.com/adambarreiro/go-vcloud-director/v2 v2.17.0-alpha.1.0.20231123112752-60218453cedb

go.sum

@@ -3,6 +3,8 @@ github.com/Microsoft/go-winio v0.6.1 h1:9/kr64B9VUZrLm5YYwbGtUJnMgqWVOdUAXu6Migc
 github.com/ProtonMail/go-crypto v0.0.0-20230717121422-5aa5874ade95 h1:KLq8BE0KwCL+mmXnjLWEAOYO+2l2AE4YMmqG1ZpZHBs=
 github.com/ProtonMail/go-crypto v0.0.0-20230717121422-5aa5874ade95/go.mod h1:EjAoLdwvbIOoOQr3ihjnSoLZRtE8azugULFRteWMNc0=
 github.com/acomagu/bufpipe v1.0.4 h1:e3H4WUzM3npvo5uv95QuJM3cQspFNtFBzvJ2oNjKIDQ=
+github.com/adambarreiro/go-vcloud-director/v2 v2.17.0-alpha.1.0.20231123112752-60218453cedb h1:jRIRygFh2Q/AKwR3gFkETfmz2p2J/wZszo+QcOHOav0=
+github.com/adambarreiro/go-vcloud-director/v2 v2.17.0-alpha.1.0.20231123112752-60218453cedb/go.mod h1:QPxGFgrUcSyzy9IlpwDE4UNT3tsOy2047tJOPEJ4nlw=
 github.com/agext/levenshtein v1.2.2 h1:0S/Yg6LYmFJ5stwQeRp6EeOcCbj7xiqQSdNelsXvaqE=
 github.com/agext/levenshtein v1.2.2/go.mod h1:JEDfjyjHDjOF/1e4FlBE/PkbqA9OfWu2ki2W0IB5558=
 github.com/apparentlymart/go-textseg/v12 v12.0.0/go.mod h1:S/4uRK2UtaQttw1GenVJEynmyUenKwP++x/+DdGV/Ec=
@@ -124,8 +126,6 @@ github.com/vmihailenco/msgpack/v5 v5.3.5 h1:5gO0H1iULLWGhs2H5tbAHIZTV8/cYafcFOr9
 github.com/vmihailenco/msgpack/v5 v5.3.5/go.mod h1:7xyJ9e+0+9SaZT0Wt1RGleJXzli6Q/V5KbhBonMG9jc=
 github.com/vmihailenco/tagparser/v2 v2.0.0 h1:y09buUbR+b5aycVFQs/g70pqKVZNBmxwAhO7/IwNM9g=
 github.com/vmihailenco/tagparser/v2 v2.0.0/go.mod h1:Wri+At7QHww0WTrCBeu4J6bNtoV6mEfg5OIWRZA9qds=
-github.com/vmware/go-vcloud-director/v2 v2.22.0-alpha.11 h1:Q71HXQSRSKKf5gcKGHQKvldFRyiOO7MpLJOaIIKCosg=
-github.com/vmware/go-vcloud-director/v2 v2.22.0-alpha.11/go.mod h1:QPxGFgrUcSyzy9IlpwDE4UNT3tsOy2047tJOPEJ4nlw=
 github.com/xanzy/ssh-agent v0.3.3 h1:+/15pJfg/RsTxqYcX6fHqOXZwwMP+2VyYWJeWM2qQFM=
 github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
 github.com/zclconf/go-cty v1.14.0 h1:/Xrd39K7DXbHzlisFP9c4pHao4yyf+/Ug9LEz+Y/yhc=

vcd/datasource_vcd_catalog.go

@@ -190,6 +190,7 @@ func getCatalogFromResource(catalogName string, d *schema.ResourceData, meta int
 
 func datasourceVcdCatalogRead(_ context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
 	var (
+		diags                 diag.Diagnostics
 		vcdClient             = meta.(*VCDClient)
 		catalog               *govcd.AdminCatalog
 		err                   error
@@ -257,9 +258,14 @@ func datasourceVcdCatalogRead(_ context.Context, d *schema.ResourceData, meta in
 		return diag.FromErr(err)
 	}
 
-	diagErr := updateMetadataInStateDeprecated(d, vcdClient, "vcd_catalog", catalog)
-	if diagErr != nil {
-		return diagErr
+	diags = append(diags, updateMetadataInStateDeprecated(d, vcdClient, "vcd_catalog", catalog)...)
+	if diags != nil && diags.HasError() {
+		return diags
+	}
+
+	// This must be checked at the end as updateMetadataInStateDeprecated can throw Warning diagnostics
+	if len(diags) > 0 {
+		return diags
 	}
 
 	return nil

vcd/datasource_vcd_independent_disk.go

@@ -168,11 +168,16 @@ func dataSourceVcdIndependentDiskRead(_ context.Context, d *schema.ResourceData,
 		return diag.Errorf("unable to find queried disk with name %s: and href: %s, %s", identifier, disk.Disk.HREF, err)
 	}
 
-	diagErr := setMainData(d, vcdClient, disk, diskRecord)
-	if diagErr != nil {
-		return diagErr
+	diags := setMainData(d, vcdClient, disk, diskRecord)
+	if diags != nil && diags.HasError() {
+		return diags
 	}
 
 	log.Printf("[TRACE] Disk read completed.")
+
+	// This must be checked at the end as setMainData can throw Warning diagnostics
+	if len(diags) > 0 {
+		return diags
+	}
 	return nil
 }

vcd/datasource_vcd_network_isolated_v2.go

@@ -2,11 +2,9 @@ package vcd
 
 import (
 	"context"
-	"github.com/vmware/go-vcloud-director/v2/govcd"
-	"log"
-
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	"github.com/vmware/go-vcloud-director/v2/govcd"
 )
 
 func datasourceVcdNetworkIsolatedV2() *schema.Resource {
@@ -130,6 +128,7 @@ func datasourceVcdNetworkIsolatedV2() *schema.Resource {
 }
 
 func datasourceVcdNetworkIsolatedV2Read(_ context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	var diags diag.Diagnostics
 	vcdClient := meta.(*VCDClient)
 
 	org, err := vcdClient.GetOrgFromResource(d)
@@ -203,12 +202,16 @@ func datasourceVcdNetworkIsolatedV2Read(_ context.Context, d *schema.ResourceDat
 
 	// Metadata is not supported when the network is in a VDC Group
 	if !govcd.OwnerIsVdcGroup(network.OpenApiOrgVdcNetwork.OwnerRef.ID) {
-		diagErr := updateMetadataInStateDeprecated(d, vcdClient, "vcd_network_isolated_v2", network)
-		if diagErr != nil {
-			log.Printf("[DEBUG] Unable to set isolated network v2 metadata: %s", err)
-			return diagErr
+		diags = append(diags, updateMetadataInStateDeprecated(d, vcdClient, "vcd_network_isolated_v2", network)...)
+		if diags != nil && diags.HasError() {
+			return diags
 		}
 	}
 
+	// This must be checked at the end as updateMetadataInStateDeprecated can throw Warning diagnostics
+	if len(diags) > 0 {
+		return diags
+	}
+
 	return nil
 }

vcd/datasource_vcd_network_routed_v2.go

@@ -2,11 +2,9 @@ package vcd
 
 import (
 	"context"
-	"github.com/vmware/go-vcloud-director/v2/govcd"
-	"log"
-
 	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	"github.com/vmware/go-vcloud-director/v2/govcd"
 )
 
 func datasourceVcdNetworkRoutedV2() *schema.Resource {
@@ -150,6 +148,7 @@ var networkV2IpRangeComputed = &schema.Resource{
 }
 
 func datasourceVcdNetworkRoutedV2Read(_ context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	var diags diag.Diagnostics
 	vcdClient := meta.(*VCDClient)
 
 	org, err := vcdClient.GetOrgFromResource(d)
@@ -255,12 +254,16 @@ func datasourceVcdNetworkRoutedV2Read(_ context.Context, d *schema.ResourceData,
 
 	// Metadata is not supported when the network is in a VDC Group
 	if !govcd.OwnerIsVdcGroup(network.OpenApiOrgVdcNetwork.OwnerRef.ID) {
-		diagErr := updateMetadataInStateDeprecated(d, vcdClient, "vcd_network_routed_v2", network)
-		if diagErr != nil {
-			log.Printf("[DEBUG] Unable to set routed network v2 metadata: %s", err)
-			return diagErr
+		diags = append(diags, updateMetadataInStateDeprecated(d, vcdClient, "vcd_network_routed_v2", network)...)
+		if diags != nil && diags.HasError() {
+			return diags
 		}
 	}
 
+	// This must be checked at the end as updateMetadataInStateDeprecated can throw Warning diagnostics
+	if len(diags) > 0 {
+		return diags
+	}
+
 	return nil
 }

vcd/datasource_vcd_org.go

@@ -142,8 +142,6 @@ func datasourceVcdOrg() *schema.Resource {
 }
 
 func datasourceVcdOrgRead(_ context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
-	var diags diag.Diagnostics
-
 	vcdClient := meta.(*VCDClient)
 
 	identifier := d.Get("name").(string)
@@ -158,9 +156,14 @@ func datasourceVcdOrgRead(_ context.Context, d *schema.ResourceData, meta interf
 	log.Printf("Org with id %s found", identifier)
 	d.SetId(adminOrg.AdminOrg.ID)
 
-	diagErr := setOrgData(d, vcdClient, adminOrg)
-	if diagErr != nil {
-		return diagErr
+	diags := setOrgData(d, vcdClient, adminOrg)
+	if diags != nil && diags.HasError() {
+		return diags
+	}
+
+	// This must be checked at the end as setOrgData can throw Warning diagnostics
+	if len(diags) > 0 {
+		return diags
 	}
 	return diags
 }

vcd/datasource_vcd_org_vdc.go

@@ -251,9 +251,9 @@ func datasourceVcdOrgVdcRead(_ context.Context, d *schema.ResourceData, meta int
 
 	d.SetId(adminVdc.AdminVdc.ID)
 
-	diagErr := setOrgVdcData(d, vcdClient, adminVdc)
-	if diagErr != nil {
-		return diagErr
+	diags := setOrgVdcData(d, vcdClient, adminVdc)
+	if diags != nil && diags.HasError() {
+		return diags
 	}
 
 	err = setEdgeClusterData(d, adminVdc, "data.vcd_org_vdc")
@@ -266,9 +266,14 @@ func datasourceVcdOrgVdcRead(_ context.Context, d *schema.ResourceData, meta int
 		dfw := govcd.NewNsxvDistributedFirewall(&vcdClient.Client, adminVdc.AdminVdc.ID)
 		enabled, err := dfw.IsEnabled()
 		if err != nil {
-			return diag.Errorf("error retrieving NSX-V distributed firewall state for VDC '%s': %s", vdcName, err)
+			return append(diags, diag.Errorf("error retrieving NSX-V distributed firewall state for VDC '%s': %s", vdcName, err)...)
 		}
 		dSet(d, "enable_nsxv_distributed_firewall", enabled)
 	}
+
+	// This must be checked at the end as setOrgVdcData can throw Warning diagnostics
+	if len(diags) > 0 {
+		return diags
+	}
 	return nil
 }

vcd/datasource_vcd_rde.go

@@ -52,6 +52,7 @@ func datasourceVcdRde() *schema.Resource {
 				Description: "Specifies whether the entity is correctly resolved or not. One of PRE_CREATED, RESOLVED or RESOLUTION_ERROR",
 				Computed:    true,
 			},
+			"metadata_entry": openApiMetadataEntryDatasourceSchema("Runtime Defined Entity"),
 		},
 	}
 }
@@ -83,6 +84,11 @@ func datasourceVcdRdeRead(_ context.Context, d *schema.ResourceData, meta interf
 		dSet(d, "owner_user_id", rde.DefinedEntity.Owner.ID)
 	}
 
+	diagErr := updateOpenApiMetadataInState(d, vcdClient, "vcd_rde", rde)
+	if diagErr != nil {
+		return diagErr
+	}
+
 	d.SetId(rde.DefinedEntity.ID)
 
 	return nil

vcd/metadata.go

@@ -133,6 +133,7 @@ var resourceMetadataApiRelation = map[string]string{
 	"vcd_vapp":                  "vApp",
 	"vcd_vapp_vm":               "vApp",
 	"vcd_vm":                    "vApp",
+	"vcd_rde":                   "entity",
 }
 
 // metadataEntryDatasourceSchema returns the schema associated to metadata_entry for a given data source.
@@ -358,7 +359,7 @@ func checkIgnoredMetadataConflicts(d *schema.ResourceData, vcdClient *VCDClient,
 					Severity: severity,
 					Summary:  "Found a conflict between 'ignore_metadata_changes' and 'metadata_entry'",
 					Detail: fmt.Sprintf("There is an 'ignored_metadata' block: %s\n"+
-						"and there is a 'metadata_entry' with key '%s' and value '%s' in your Terraform configuration that matches the criteria, hence it will be ignored.\n"+
+						"and there is a 'metadata_entry' with key '%s' and value '%s' in your Terraform configuration or state that matches that criteria, hence it will be ignored.\n"+
 						"This will cause the entry to be present in Terraform state but it won't have any effect in VCD, causing an inconsistency.\n"+
 						"Please use a more fine-grained 'ignore_metadata_changes' configuration or change your metadata entry.", ignoredMetadata, newEntry["key"].(string), newEntry["value"].(string)),
 					AttributePath: cty.Path{},
@@ -373,6 +374,7 @@ func checkIgnoredMetadataConflicts(d *schema.ResourceData, vcdClient *VCDClient,
 // This can be done as both are Computed, for compatibility reasons.
 // TODO: Remove this function once "metadata" attribute is deleted in a future major release.
 func updateMetadataInStateDeprecated(d *schema.ResourceData, vcdClient *VCDClient, resourceType string, receiverObject metadataCompatible) diag.Diagnostics {
+	var diags diag.Diagnostics
 
 	// We temporarily remove the ignored metadata filter to retrieve the deprecated metadata contents,
 	// which should not be affected by it.
@@ -405,24 +407,29 @@ func updateMetadataInStateDeprecated(d *schema.ResourceData, vcdClient *VCDClien
 	}
 
 	// We get metadata again with the original metadata ignore filtering
-	diagErr := updateMetadataInState(d, vcdClient, resourceType, receiverObject)
-	if diagErr != nil {
-		return diagErr
+	diags = append(diags, updateMetadataInState(d, vcdClient, resourceType, receiverObject)...)
+	if diags != nil && diags.HasError() {
+		return diags
+	}
+
+	// This must be checked at the end as updateMetadataInState can throw Warning diagnostics
+	if len(diags) > 0 {
+		return diags
 	}
 
 	return nil
 }
 
 // updateMetadataInState updates ONLY metadata_entry in the Terraform state for the given receiver object.
 func updateMetadataInState(d *schema.ResourceData, vcdClient *VCDClient, resourceType string, receiverObject metadataCompatible) diag.Diagnostics {
-	diagErr := checkIgnoredMetadataConflicts(d, vcdClient, resourceType)
-	if diagErr != nil {
-		return diagErr
+	diags := checkIgnoredMetadataConflicts(d, vcdClient, resourceType)
+	if diags != nil && diags.HasError() {
+		return diags
 	}
 
 	metadata, err := receiverObject.GetMetadata()
 	if err != nil {
-		return diag.Errorf("error getting metadata to save in state: %s", err)
+		return append(diags, diag.Errorf("error getting metadata to save in state: %s", err)...)
 	}
 
 	// VMs can have special metadata automatically set by VCD that require to be filtered out and
@@ -431,13 +438,16 @@ func updateMetadataInState(d *schema.ResourceData, vcdClient *VCDClient, resourc
 		inheritedMetadataBlock := filterAndGetVcdInheritedMetadata(metadata)
 		err = d.Set("inherited_metadata", inheritedMetadataBlock)
 		if err != nil {
-			return diag.Errorf("could not set 'inherited_metadata' attribute: %s", err)
+			return append(diags, diag.Errorf("could not set 'inherited_metadata' attribute: %s", err)...)
 		}
 	}
 
 	err = setMetadataEntryInState(d, metadata.MetadataEntry)
 	if err != nil {
-		return diag.Errorf("error setting metadata entry in state: %s", err)
+		return append(diags, diag.Errorf("error setting metadata entry in state: %s", err)...)
+	}
+	if len(diags) > 0 {
+		return diags
 	}
 	return nil
 }