Implement DHCP Forwarding Resource and Data source

.changes/v3.10.0/1056-features.md

@@ -0,0 +1,2 @@
+* **New Resource:** `vcd_nsxt_edgegateway_dhcp_forwarding` to manage NSX-T Edge Gateway DHCP Forwarding configuration [GH-1056]
+* **New Data Source:** `vcd_nsxt_edgegateway_dhcp_forwarding` to read NSX-T Edge Gateway DHCP Forwarding configuration [GH-1056]

go.mod

@@ -60,3 +60,5 @@ require (
 	google.golang.org/grpc v1.51.0 // indirect
 	google.golang.org/protobuf v1.28.1 // indirect
 )
+
+replace github.com/vmware/go-vcloud-director/v2 => github.com/adezxc/go-vcloud-director/v2 v2.20.0-alpha.15.0.20230503092536-680538e15fdc

go.sum

@@ -11,6 +11,8 @@ github.com/ProtonMail/go-crypto v0.0.0-20210428141323-04723f9f07d7 h1:YoJbenK9C6
 github.com/ProtonMail/go-crypto v0.0.0-20210428141323-04723f9f07d7/go.mod h1:z4/9nQmJSSwwds7ejkxaJwO37dru3geImFUdJlaLzQo=
 github.com/acomagu/bufpipe v1.0.3 h1:fxAGrHZTgQ9w5QqVItgzwj235/uYZYgbXitB+dLupOk=
 github.com/acomagu/bufpipe v1.0.3/go.mod h1:mxdxdup/WdsKVreO5GpW4+M/1CE2sMG4jeGJ2sYmHc4=
+github.com/adezxc/go-vcloud-director/v2 v2.20.0-alpha.15.0.20230503092536-680538e15fdc h1:nkYTb+2LD+Fu4NN2044N/eLHCQYNxFjih7eHqSY14gk=
+github.com/adezxc/go-vcloud-director/v2 v2.20.0-alpha.15.0.20230503092536-680538e15fdc/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/anmitsu/go-shlex v0.0.0-20161002113705-648efa622239/go.mod h1:2FmKhYUyUczH0OGQWaF5ceTx0UBShxjsH6f8oGKYe2c=
@@ -194,8 +196,6 @@ github.com/vmihailenco/msgpack/v4 v4.3.12 h1:07s4sz9IReOgdikxLTKNbBdqDMLsjPKXwvC
 github.com/vmihailenco/msgpack/v4 v4.3.12/go.mod h1:gborTTJjAo/GWTqqRjrLCn9pgNN+NXzzngzBKDPIqw4=
 github.com/vmihailenco/tagparser v0.1.1 h1:quXMXlA39OCbd2wAdTsGDlK9RkOk6Wuw+x37wVyIuWY=
 github.com/vmihailenco/tagparser v0.1.1/go.mod h1:OeAg3pn3UbLjkWt+rN9oFYB6u/cQgqMEUPoW2WPyhdI=
-github.com/vmware/go-vcloud-director/v2 v2.20.0 h1:vT1vmh6uxJPE5a4d2nSj8KmF3C0kb/1UF2hn6hp7vr0=
-github.com/vmware/go-vcloud-director/v2 v2.20.0/go.mod h1:QPxGFgrUcSyzy9IlpwDE4UNT3tsOy2047tJOPEJ4nlw=
 github.com/xanzy/ssh-agent v0.3.0 h1:wUMzuKtKilRgBAD1sUb8gOwwRr2FGoBVumcjoOACClI=
 github.com/xanzy/ssh-agent v0.3.0/go.mod h1:3s9xbODqPuuhK9JV1R321M/FlMZSBvE5aY6eAcqrDh0=
 github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=

vcd/config.go

@@ -375,6 +375,34 @@ func (cli *VCDClient) unLockParentEdgeGtw(d *schema.ResourceData) {
 	vcdMutexKV.kvUnlock(edgeGtwIdValue)
 }
 
+// lockParentVdcGroupOrEdgeGateway handles lock of parent Edge Gateway or parent VDC group, depending
+// if the parent Edge Gateway is in a VDC or a VDC group. Returns a function that contains the needed
+// unlock function, so that it can be deferred and called after the work with the resource has been
+// done.
+func (cli *VCDClient) lockParentVdcGroupOrEdgeGateway(d *schema.ResourceData) (func(), error) {
+	parentEdgeGatewayOwnerId, _, err := getParentEdgeGatewayOwnerId(cli, d)
+	if err != nil {
+		return nil, fmt.Errorf("error finding parent Edge Gateway: %s", err)
+	}
+
+	// Handling locks is conditional. There are two scenarios:
+	// * When the parent Edge Gateway is in a VDC - a lock on parent Edge Gateway must be acquired
+	// * When the parent Edge Gateway is in a VDC Group - a lock on parent VDC Group must be acquired
+	// To find out parent lock object, Edge Gateway must be looked up and its OwnerRef must be checked
+	// Note. It is not safe to do multiple locks in the same resource as it can result in a deadlock
+	if govcd.OwnerIsVdcGroup(parentEdgeGatewayOwnerId) {
+		cli.lockById(parentEdgeGatewayOwnerId)
+		return func() {
+			cli.unlockById(parentEdgeGatewayOwnerId)
+		}, nil
+	} else {
+		cli.lockParentEdgeGtw(d)
+		return func() {
+			cli.unLockParentEdgeGtw(d)
+		}, nil
+	}
+}
+
 func (cli *VCDClient) lockParentOrgNetwork(d *schema.ResourceData) {
 	orgNetworkId := d.Get("org_network_id").(string)
 	vcdMutexKV.kvLock(orgNetworkId)

vcd/datasource_not_found_test.go

@@ -184,8 +184,7 @@ func addMandatoryParams(dataSourceName string, mandatoryFields []string, t *test
 		}
 
 		if (dataSourceName == "vcd_nsxt_edgegateway_bgp_configuration" || dataSourceName == "vcd_nsxt_alb_settings" ||
-			dataSourceName == "vcd_nsxt_firewall" || dataSourceName == "vcd_nsxt_route_advertisement" ||
-			dataSourceName == "vcd_nsxt_edgegateway_rate_limiting") &&
+			dataSourceName == "vcd_nsxt_edgegateway_rate_limiting" || dataSourceName == "vcd_nsxt_edgegateway_dhcp_forwarding") &&
 			mandatoryFields[fieldIndex] == "edge_gateway_id" {
 			// injecting fake Edge Gateway ID
 			templateFields = templateFields + `edge_gateway_id = "urn:vcloud:gateway:784feb3d-87e4-4905-202a-bfe9faa5476f"` + "\n"

vcd/datasource_vcd_nsxt_edgegateway_dhcp_forwarding.go

@@ -0,0 +1,44 @@
+package vcd
+
+import (
+	"context"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/diag"
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
+)
+
+func datasourceVcdNsxtEdgegatewayDhcpForwarding() *schema.Resource {
+	return &schema.Resource{
+		ReadContext: datasourceVcdNsxtEdgegatewayDhcpForwardingRead,
+		Schema: map[string]*schema.Schema{
+			"org": {
+				Type:     schema.TypeString,
+				Required: true,
+				Description: "The name of organization to use, optional if defined at provider " +
+					"level. Useful when connected as sysadmin working across different organizations",
+			},
+			"edge_gateway_id": {
+				Type:        schema.TypeString,
+				Required:    true,
+				Description: "Edge gateway ID for DHCP forwarding configuration",
+			},
+			"enabled": {
+				Type:        schema.TypeBool,
+				Computed:    true,
+				Description: "Status of DHCP Forwarding for the Edge Gateway",
+			},
+			"dhcp_servers": {
+				Type:        schema.TypeSet,
+				Computed:    true,
+				Description: "IP addresses of the DHCP servers",
+				Elem: &schema.Schema{
+					Type: schema.TypeString,
+				},
+			},
+		},
+	}
+}
+
+func datasourceVcdNsxtEdgegatewayDhcpForwardingRead(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics {
+	return genericVcdNsxtEdgegatewayDhcpForwardingRead(ctx, d, meta, "datasource")
+}

vcd/datasource_vcd_nsxt_edgegateway_dhcp_forwarding_test.go

@@ -0,0 +1,96 @@
+//go:build gateway || network || nsxt || ALL || functional
+
+package vcd
+
+import (
+	"testing"
+
+	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
+)
+
+// TestAccVcdDataSourceNsxtEdgeRateLimiting is a test for datasource
+// vcd_nsxt_edgegateway_rate_limiting It only check if ingress and egress profile IDs are empty
+// ("unlimited" rate). Other values are tested in resource test.
+func TestAccVcdDataSourceNsxtEdgeDhcpForwarding(t *testing.T) {
+	preTestChecks(t)
+	skipIfNotSysAdmin(t)
+
+	vcdClient := createTemporaryVCDConnection(true)
+	if vcdClient == nil {
+		t.Skip(acceptanceTestsSkipped)
+	}
+	if vcdClient.Client.APIVCDMaxVersionIs("< 36.1") {
+		t.Skipf("This test tests VCD 10.3.1+ (API V36.1+) features. Skipping.")
+	}
+
+	// String map to fill the template
+	var params = StringMap{
+		"Org":                  testConfig.VCD.Org,
+		"NsxtVdc":              testConfig.Nsxt.Vdc,
+		"NsxtVdcGroup":         testConfig.Nsxt.VdcGroup,
+		"NsxtEdgeGwInVdcGroup": testConfig.Nsxt.VdcGroupEdgeGateway,
+		"NsxtEdgeGw":           testConfig.Nsxt.EdgeGateway,
+		"TestName":             t.Name(),
+	}
+	testParamsNotEmpty(t, params)
+
+	configText1 := templateFill(testAccVcdDataSourceNsxtEdgeDhcpForwarding, params)
+	debugPrintf("#[DEBUG] CONFIGURATION for step 1: %s", configText1)
+
+	if vcdShortTest {
+		t.Skip(acceptanceTestsSkipped)
+		return
+	}
+
+	resource.Test(t, resource.TestCase{
+		ProviderFactories: testAccProviders,
+		Steps: []resource.TestStep{
+			{
+				Config: configText1,
+				Check: resource.ComposeAggregateTestCheckFunc(
+					resource.TestCheckResourceAttrSet("data.vcd_nsxt_edgegateway_dhcp_forwarding.testing-in-vdc", "id"),
+					resource.TestCheckResourceAttr("data.vcd_nsxt_edgegateway_dhcp_forwarding.testing-in-vdc", "enabled", "false"),
+
+					resource.TestCheckResourceAttrSet("data.vcd_nsxt_edgegateway_dhcp_forwarding.testing-in-vdc-group", "id"),
+					resource.TestCheckResourceAttr("data.vcd_nsxt_edgegateway_dhcp_forwarding.testing-in-vdc-group", "enabled", "false"),
+				),
+			},
+		},
+	})
+}
+
+const testAccVcdDataSourceNsxtEdgeDhcpForwarding = `
+data "vcd_vdc_group" "g1" {
+  org  = "{{.Org}}"
+  name = "{{.NsxtVdcGroup}}"
+}
+
+data "vcd_nsxt_edgegateway" "testing-in-vdc-group" {
+  org      = "{{.Org}}"
+  owner_id = data.vcd_vdc_group.g1.id
+
+  name = "{{.NsxtEdgeGwInVdcGroup}}"
+}
+
+data "vcd_org_vdc" "v1" {
+  org  = "{{.Org}}"
+  name = "{{.NsxtVdc}}"
+}
+
+data "vcd_nsxt_edgegateway" "testing-in-vdc" {
+  org      = "{{.Org}}"
+  owner_id = data.vcd_org_vdc.v1.id
+
+  name = "{{.NsxtEdgeGw}}"
+}
+
+data "vcd_nsxt_edgegateway_dhcp_forwarding" "testing-in-vdc" {
+  org             = "{{.Org}}"
+  edge_gateway_id = data.vcd_nsxt_edgegateway.testing-in-vdc.id
+}
+
+data "vcd_nsxt_edgegateway_dhcp_forwarding" "testing-in-vdc-group" {
+  org             = "{{.Org}}"
+  edge_gateway_id = data.vcd_nsxt_edgegateway.testing-in-vdc-group.id
+}
+`

vcd/provider.go

@@ -120,6 +120,7 @@ var globalDataSourceMap = map[string]*schema.Resource{
 	"vcd_nsxt_edgegateway_qos_profile":              datasourceVcdNsxtEdgeGatewayQosProfile(),        // 3.9
 	"vcd_nsxt_edgegateway_rate_limiting":            datasourceVcdNsxtEdgegatewayRateLimiting(),      // 3.9
 	"vcd_nsxt_network_dhcp_binding":                 datasourceVcdNsxtDhcpBinding(),                  // 3.9
+	"vcd_nsxt_edgegateway_dhcp_forwarding":          datasourceVcdNsxtEdgegatewayDhcpForwarding(),    // 3.10
 }
 
 var globalResourceMap = map[string]*schema.Resource{
@@ -204,6 +205,7 @@ var globalResourceMap = map[string]*schema.Resource{
 	"vcd_rde":                                       resourceVcdRde(),                              // 3.9
 	"vcd_nsxt_edgegateway_rate_limiting":            resourceVcdNsxtEdgegatewayRateLimiting(),      // 3.9
 	"vcd_nsxt_network_dhcp_binding":                 resourceVcdNsxtDhcpBinding(),                  // 3.9
+	"vcd_nsxt_edgegateway_dhcp_forwarding":          resourceVcdNsxtEdgegatewayDhcpForwarding(),    // 3.10
 }
 
 // Provider returns a terraform.ResourceProvider.
@@ -216,7 +218,6 @@ func Provider() *schema.Provider {
 				DefaultFunc: schema.EnvDefaultFunc("VCD_USER", nil),
 				Description: "The user name for VCD API operations.",
 			},
-
 			"password": {
 				Type:        schema.TypeString,
 				Optional:    true,

vcd/resource_vcd_network_routed_v2.go

@@ -403,7 +403,7 @@ func getOpenApiOrgVdcRoutedNetworkType(d *schema.ResourceData, vcdClient *VCDCli
 func getParentEdgeGatewayOwnerId(vcdClient *VCDClient, d *schema.ResourceData) (string, *govcd.Org, error) {
 	org, err := vcdClient.GetOrgFromResource(d)
 	if err != nil {
-		return "", nil, fmt.Errorf("[routed network create v2] error retrieving Org: %s", err)
+		return "", nil, fmt.Errorf("error retrieving Org: %s", err)
 	}
 
 	anyEdgeGateway, err := org.GetAnyTypeEdgeGatewayById(d.Get("edge_gateway_id").(string))