feat(vpcgw): add wait_for_dhcp to dhcp reservation datasource (#1456)

Author: Codelax

docs/data-sources/vpc_public_gateway_dhcp_reservation.md

@@ -123,6 +123,7 @@ data "scaleway_vpc_public_gateway_dhcp_reservation" "by_id" {
 
 - `reservation_id`  (Required) The ID of the Reservation to retrieve
 - `mac_address`  (Optional) The MAC address of the reservation to retrieve
+- `wait_for_dhcp` (Optional) Boolean to wait for mac_address to exist in dhcp
 - `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which
   the image exists.
 

go.mod

@@ -13,7 +13,7 @@ require (
 	github.com/hashicorp/terraform-plugin-log v0.7.0
 	github.com/hashicorp/terraform-plugin-sdk/v2 v2.21.0
 	github.com/robfig/cron/v3 v3.0.1
-	github.com/scaleway/scaleway-sdk-go v1.0.0-beta.9.0.20220805144307-2228017fa4e8
+	github.com/scaleway/scaleway-sdk-go v1.0.0-beta.9.0.20220907082605-794394649db9
 	github.com/stretchr/testify v1.8.0
 )
 

go.sum

@@ -15,7 +15,7 @@ func dataSourceScalewayVPCPublicGatewayDHCPReservation() *schema.Resource {
 	dsSchema := datasourceSchemaFromResourceSchema(resourceScalewayVPCPublicGatewayDHCPReservation().Schema)
 
 	// Set 'Optional' schema elements
-	addOptionalFieldsToSchema(dsSchema, "mac_address")
+	addOptionalFieldsToSchema(dsSchema, "mac_address", "gateway_network_id")
 
 	dsSchema["mac_address"].ConflictsWith = []string{"reservation_id"}
 	dsSchema["reservation_id"] = &schema.Schema{
@@ -24,6 +24,12 @@ func dataSourceScalewayVPCPublicGatewayDHCPReservation() *schema.Resource {
 		Description:  "The ID of dhcp entry reservation",
 		ValidateFunc: validationUUIDorUUIDWithLocality(),
 	}
+	dsSchema["wait_for_dhcp"] = &schema.Schema{
+		Type:        schema.TypeBool,
+		Optional:    true,
+		Default:     false,
+		Description: "Wait the the mac address in dhcp entries",
+	}
 
 	// Set 'Optional' schema elements
 	addOptionalFieldsToSchema(dsSchema, "zone")
@@ -42,13 +48,23 @@ func dataSourceScalewayVPCPublicGatewayDHCPReservationRead(ctx context.Context,
 
 	reservationIDRaw, ok := d.GetOk("reservation_id")
 	if !ok {
-		res, err := vpcgwAPI.ListDHCPEntries(
-			&vpcgw.ListDHCPEntriesRequest{
-				MacAddress: expandStringPtr(d.Get("mac_address").(string)),
-			}, scw.WithContext(ctx))
+		var res *vpcgw.ListDHCPEntriesResponse
+		gatewayNetworkID := d.Get("gateway_network_id").(string)
+		macAddress := d.Get("mac_address").(string)
+
+		if d.Get("wait_for_dhcp").(bool) {
+			res, err = waitForDHCPEntries(ctx, vpcgwAPI, zone, gatewayNetworkID, macAddress, d.Timeout(schema.TimeoutRead))
+		} else {
+			res, err = vpcgwAPI.ListDHCPEntries(
+				&vpcgw.ListDHCPEntriesRequest{
+					GatewayNetworkID: expandStringPtr(gatewayNetworkID),
+					MacAddress:       expandStringPtr(macAddress),
+				}, scw.WithContext(ctx))
+		}
 		if err != nil {
 			return diag.FromErr(err)
 		}
+
 		if res.TotalCount == 0 {
 			return diag.FromErr(
 				fmt.Errorf(

scaleway/data_source_vpc_public_gateway_dhcp_reservation.go

@@ -96,6 +96,7 @@ func TestAccScalewayDataSourceVPCPublicGatewayDHCPReservation_Basic(t *testing.T
 	
 					data "scaleway_vpc_public_gateway_dhcp_reservation" "by_mac_address" {
 						mac_address = "${scaleway_instance_server.main.private_network.0.mac_address}"
+						wait_for_dhcp = true
 						depends_on = [scaleway_vpc_gateway_network.main, scaleway_vpc_public_gateway_dhcp.main, scaleway_vpc_private_network.main]
 					}
 				`, pnName),

scaleway/data_source_vpc_public_gateway_dhcp_reservation_test.go

@@ -69,3 +69,24 @@ func waitForVPCGatewayNetwork(ctx context.Context, api *vpcgw.API, zone scw.Zone
 
 	return gatewayNetwork, err
 }
+
+func waitForDHCPEntries(ctx context.Context, api *vpcgw.API, zone scw.Zone, gatewayID string, macAddress string, timeout time.Duration) (*vpcgw.ListDHCPEntriesResponse, error) {
+	retryIntervalDHCPEntries := defaultVPCGatewayRetry
+	if DefaultWaitRetryInterval != nil {
+		retryIntervalDHCPEntries = *DefaultWaitRetryInterval
+	}
+
+	req := &vpcgw.WaitForDHCPEntriesRequest{
+		MacAddress:    macAddress,
+		Zone:          zone,
+		Timeout:       scw.TimeDurationPtr(timeout),
+		RetryInterval: &retryIntervalDHCPEntries,
+	}
+
+	if gatewayID != "" {
+		req.GatewayNetworkID = &gatewayID
+	}
+
+	dhcpEntries, err := api.WaitForDHCPEntries(req, scw.WithContext(ctx))
+	return dhcpEntries, err
+}