Add vcd_rde_behavior_invocation data source to invoke behaviors

.changes/v3.11.0/1117-bug-fixes.md

@@ -0,0 +1,4 @@
+* Fixes a bug that made impossible to delete `vcd_rde_type_behavior_acl` resources when the Access Level is the last one
+  in the Behavior [GH-1117]
+* Fixes the resource `vcd_rde_type_behavior_acl` to avoid race conditions when creating, updating or deleting more than one
+  Access Level [GH-1117]

.changes/v3.11.0/1117-experimental-features.md

@@ -0,0 +1 @@
+* **New Data Source:** `vcd_rde_behavior_invocation` to invoke a Behavior of a given RDE [GH-1117]

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

@@ -0,0 +1 @@
+* Field `rde_type_id` from resource `vcd_rde` does not force a deletion when updated, to allow easier RDE Type version upgrades [GH-1117]

go.mod

@@ -65,3 +65,5 @@ require (
 	google.golang.org/grpc v1.56.0 // indirect
 	google.golang.org/protobuf v1.30.0 // indirect
 )
+
+replace github.com/vmware/go-vcloud-director/v2 => github.com/adambarreiro/go-vcloud-director/v2 v2.17.0-alpha.1.0.20230920072338-346b89c8b042

go.sum

@@ -2,6 +2,8 @@ github.com/Microsoft/go-winio v0.5.2 h1:a9IhgEQBCUEk6QCdml9CiJGhAws+YwffDHEMp1VM
 github.com/ProtonMail/go-crypto v0.0.0-20230217124315-7d5c6f04bbb8 h1:wPbRQzjjwFc0ih8puEVAOFGELsn1zoIIYdxvML7mDxA=
 github.com/ProtonMail/go-crypto v0.0.0-20230217124315-7d5c6f04bbb8/go.mod h1:I0gYDMZ6Z5GRU7l58bNFSkPTFN6Yl12dsUlAZ8xy98g=
 github.com/acomagu/bufpipe v1.0.4 h1:e3H4WUzM3npvo5uv95QuJM3cQspFNtFBzvJ2oNjKIDQ=
+github.com/adambarreiro/go-vcloud-director/v2 v2.17.0-alpha.1.0.20230920072338-346b89c8b042 h1:NyYZ76p2SUDBQrotBdIBGVYkrOTqYRsP7QTsRTzuiK8=
+github.com/adambarreiro/go-vcloud-director/v2 v2.17.0-alpha.1.0.20230920072338-346b89c8b042/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=
@@ -123,8 +125,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.3 h1:dhDv0c8sxd/c4oNzKBs8V1jy9qO2x6JdOHzkW53CwD0=
-github.com/vmware/go-vcloud-director/v2 v2.22.0-alpha.3/go.mod h1:QPxGFgrUcSyzy9IlpwDE4UNT3tsOy2047tJOPEJ4nlw=
 github.com/xanzy/ssh-agent v0.3.3 h1:+/15pJfg/RsTxqYcX6fHqOXZwwMP+2VyYWJeWM2qQFM=
 github.com/zclconf/go-cty v1.13.2 h1:4GvrUxe/QUDYuJKAav4EYqdM47/kZa672LwmXFmEKT0=
 github.com/zclconf/go-cty v1.13.2/go.mod h1:YKQzy/7pZ7iq2jNFzy5go57xdxdWoLLpaEp4u238AE0=

vcd/datasource_vcd_rde_behavior_invocation.go

@@ -0,0 +1,74 @@
+package vcd
+
+import (
+	"context"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+	"github.com/vmware/go-vcloud-director/v2/types/v56"
+)
+
+// This data source is quite special, as it represents an imperative call to a function (aka invoking a behavior)
+// in the declarative world of Terraform. Despite being a data source, whose goal is to perform Read-only operations, invocations
+// can mutate RDE contents. The nature of this one is similar to the built-in "http" provider, which has the "http_http" data source
+// that can perform "PUT"/"POST"/"DELETE" operations.
+func datasourceVcdRdeBehaviorInvocation() *schema.Resource {
+	return &schema.Resource{
+		ReadContext: datasourceVcdRdeBehaviorInvocationRead,
+		Schema: map[string]*schema.Schema{
+			"rde_id": {
+				Type:        schema.TypeString,
+				Required:    true,
+				Description: "The ID of the RDE for which the Behavior will be invoked",
+			},
+			"behavior_id": {
+				Type:        schema.TypeString,
+				Required:    true,
+				Description: "The ID of either a RDE Interface Behavior or RDE Type Behavior to be invoked",
+			},
+			"invoke_on_refresh": {
+				Type:        schema.TypeBool,
+				Optional:    true,
+				Default:     true,
+				Description: "If 'true', invokes the Behavior on every refresh",
+			},
+			"arguments": {
+				Type:        schema.TypeMap,
+				Optional:    true,
+				Description: "The arguments to be passed to the invoked Behavior",
+			},
+			"metadata": {
+				Type:        schema.TypeMap,
+				Optional:    true,
+				Description: "Metadata to be passed to the invoked Behavior",
+			},
+			"result": {
+				Type:        schema.TypeString,
+				Computed:    true,
+				Description: "The raw result of the Behavior invocation",
+			},
+		},
+	}
+}
+
+func datasourceVcdRdeBehaviorInvocationRead(_ context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	vcdClient := meta.(*VCDClient)
+	rdeId := d.Get("rde_id").(string)
+	behaviorId := d.Get("behavior_id").(string)
+
+	if d.Get("invoke_on_refresh").(bool) {
+		rde, err := vcdClient.GetRdeById(rdeId)
+		if err != nil {
+			return diag.Errorf("[RDE Behavior Invocation] could not retrieve the RDE with ID '%s': %s", rdeId, err)
+		}
+		result, err := rde.InvokeBehavior(behaviorId, types.BehaviorInvocation{
+			Arguments: d.Get("arguments").(map[string]interface{}),
+			Metadata:  d.Get("metadata").(map[string]interface{}),
+		})
+		if err != nil {
+			return diag.Errorf("[RDE Behavior Invocation] could not invoke the Behavior of the RDE with ID '%s': %s", rdeId, err)
+		}
+		dSet(d, "result", result)
+	}
+	d.SetId(rdeId + "|" + behaviorId) // Invocations are not real entities, so we make an artificial ID.
+	return nil
+}

vcd/datasource_vcd_rde_behavior_invocation_test.go

@@ -0,0 +1,128 @@
+//go:build rde || ALL || functional
+
+package vcd
+
+import (
+	"fmt"
+	"regexp"
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
+)
+
+func TestAccVcdRdeBehaviorInvocation(t *testing.T) {
+	preTestChecks(t)
+	skipIfNotSysAdmin(t)
+
+	var params = StringMap{
+		"Nss":           "nss",
+		"Version":       "1.0.0",
+		"Vendor":        "vendor",
+		"Name":          t.Name(),
+		"Description":   t.Name(),
+		"SchemaPath":    getCurrentDir() + "/../test-resources/rde_type.json",
+		"EntityPath":    getCurrentDir() + "/../test-resources/rde_instance.json",
+		"ExecutionId":   "MyActivity",
+		"ExecutionType": "noop",
+		"AccessLevels":  "\"urn:vcloud:accessLevel:FullControl\"",
+	}
+	testParamsNotEmpty(t, params)
+
+	configText := templateFill(testAccVcdRdeBehaviorInvocation, params)
+	debugPrintf("#[DEBUG] CONFIGURATION: %s\n", configText)
+
+	if vcdShortTest {
+		t.Skip(acceptanceTestsSkipped)
+		return
+	}
+
+	resource.Test(t, resource.TestCase{
+		ProviderFactories: testAccProviders,
+		CheckDestroy:      testAccCheckRdeInterfaceDestroy("vcd_rde_interface.interface"), // If the interface is destroyed, everything is
+		Steps: []resource.TestStep{
+			{
+				Config: configText,
+				Check: resource.ComposeAggregateTestCheckFunc(
+					resource.TestCheckResourceAttr("vcd_rde.rde", "name", t.Name()),
+					// No-op operations return the original entity data, hence the RDE Type should appear:
+					resource.TestMatchResourceAttr("data.vcd_rde_behavior_invocation.invoke", "result",
+						regexp.MustCompile(fmt.Sprintf("\"urn:vcloud:type:%s:%s:%s\"", params["Vendor"], params["Nss"], params["Version"]))),
+					resource.TestMatchResourceAttr("data.vcd_rde_behavior_invocation.invoke2", "result",
+						regexp.MustCompile(fmt.Sprintf("\"urn:vcloud:type:%s:%s:%s\"", params["Vendor"], params["Nss"], params["Version"]))),
+					resource.TestCheckNoResourceAttr("data.vcd_rde_behavior_invocation.invoke3", "result"),
+				),
+			},
+		},
+	})
+	postTestChecks(t)
+}
+
+const testAccVcdRdeBehaviorInvocation = `
+resource "vcd_rde_interface" "interface" {
+  nss     = "{{.Nss}}"
+  version = "{{.Version}}"
+  vendor  = "{{.Vendor}}"
+  name    = "{{.Name}}"
+}
+
+resource "vcd_rde_interface_behavior" "behavior" {
+  rde_interface_id = vcd_rde_interface.interface.id
+  name             = "{{.Name}}"
+  description      = "{{.Description}}"
+  execution = {
+    "id" : "{{.ExecutionId}}1"
+    "type" : "{{.ExecutionType}}"
+  }
+}
+
+resource "vcd_rde_type" "type" {
+  nss           = "{{.Nss}}"
+  version       = "{{.Version}}"
+  vendor        = "{{.Vendor}}"
+  name          = "{{.Name}}"
+  description   = "{{.Description}}"
+  interface_ids = [vcd_rde_interface.interface.id]
+  schema        = file("{{.SchemaPath}}")
+
+  # Behaviors can't be created after the RDE Interface is used by a RDE Type
+  # so we need to depend on the Behaviors to wait for them to be created first.
+  depends_on = [vcd_rde_interface_behavior.behavior]
+}
+
+resource "vcd_rde" "rde" {
+  org          = "System" # We use System org to avoid using right bundles
+  rde_type_id  = vcd_rde_type.type.id
+  name         = "{{.Name}}"
+  resolve      = true
+  input_entity = file("{{.EntityPath}}")
+}
+
+# Required Access Levels to invoke Behaviors
+resource "vcd_rde_type_behavior_acl" "interface_acl" {
+  rde_type_id = vcd_rde_type.type.id
+  behavior_id = vcd_rde_interface_behavior.behavior.id
+  access_level_ids = [{{.AccessLevels}}]
+}
+
+data "vcd_rde_behavior_invocation" "invoke" {
+  rde_id                  = vcd_rde.rde.id
+  behavior_id             = vcd_rde_interface_behavior.behavior.id
+}
+
+data "vcd_rde_behavior_invocation" "invoke2" {
+  rde_id      = vcd_rde.rde.id
+  behavior_id = vcd_rde_interface_behavior.behavior.id
+  arguments = {
+    "arg1" : "not_used"
+  }
+  metadata = {
+    "meta1" : "not_used"
+  }
+}
+
+data "vcd_rde_behavior_invocation" "invoke3" {
+  rde_id            = vcd_rde.rde.id
+  behavior_id       = vcd_rde_interface_behavior.behavior.id
+  invoke_on_refresh = false
+}
+`

vcd/provider.go

@@ -138,6 +138,7 @@ var globalDataSourceMap = map[string]*schema.Resource{
 	"vcd_rde_interface_behavior":                    datasourceVcdRdeInterfaceBehavior(),             // 3.10
 	"vcd_rde_type_behavior":                         datasourceVcdRdeTypeBehavior(),                  // 3.10
 	"vcd_rde_type_behavior_acl":                     datasourceVcdRdeTypeBehaviorAccessLevel(),       // 3.10
+	"vcd_rde_behavior_invocation":                   datasourceVcdRdeBehaviorInvocation(),            // 3.11
 }
 
 var globalResourceMap = map[string]*schema.Resource{

vcd/resource_vcd_rde.go

@@ -40,7 +40,6 @@ func resourceVcdRde() *schema.Resource {
 			"rde_type_id": {
 				Type:        schema.TypeString,
 				Required:    true,
-				ForceNew:    true,
 				Description: "The Runtime Defined Entity Type ID",
 			},
 			"external_id": {
@@ -121,7 +120,7 @@ func resourceVcdRdeCreate(ctx context.Context, d *schema.ResourceData, meta inte
 	tenantContext := govcd.TenantContext{}
 	org, err := vcdClient.GetOrgFromResource(d)
 	if err != nil {
-		return diag.Errorf("could not create RDE with name '%s', error retrieving Org '%s': %s", name, d.Get("org").(string), err)
+		return diag.Errorf("could not create RDE with name '%s', error retrieving Org: %s", name, err)
 	}
 	tenantContext.OrgId = org.Org.ID
 	tenantContext.OrgName = org.Org.Name
@@ -306,6 +305,7 @@ func resourceVcdRdeUpdate(ctx context.Context, d *schema.ResourceData, meta inte
 
 	err = rde.Update(types.DefinedEntity{
 		Name:       d.Get("name").(string),
+		EntityType: d.Get("rde_type_id").(string),
 		ExternalId: d.Get("external_id").(string),
 		Entity:     jsonEntity,
 	})
@@ -429,6 +429,9 @@ func resourceVcdRdeImport(_ context.Context, d *schema.ResourceData, meta interf
 	}
 
 	d.SetId(rde.DefinedEntity.ID)
+	if rde.DefinedEntity.Org != nil {
+		dSet(d, "org", rde.DefinedEntity.Org.Name)
+	}
 	dSet(d, "rde_type_id", rde.DefinedEntity.EntityType)
 
 	return []*schema.ResourceData{d}, nil