feat(ipam): add ipam ip resource (#2188)

* feat(ipam): add ipam ip resource

* lint & update cassettes

* update cassette

* remove vpc v1

* fix documentation link

Author: yfodil

.github/workflows/nightly.yml

@@ -23,6 +23,7 @@ jobs:
           - Iam
           - Instance
           - Iot
+          - IPAM
           - K8S
           - Lb
           - Marketplace

docs/data-sources/ipam_ip.md

@@ -67,7 +67,7 @@ data "scaleway_ipam_ip" "by_name" {
 
 - `resource` - (Optional) Filter by resource ID, type or name. If specified, `type` is required, and at least one of `id` or `name` must be set.
     - `id` - The ID of the resource that the IP is bound to.
-    - `type` - The type of the resource to get the IP from. [Documentation](https://pkg.go.dev/github.com/scaleway/scaleway-sdk-go@v1.0.0-beta.21.0.20231020161050-699490ebeefd/api/ipam/v1#pkg-constants) with type list.
+    - `type` - The type of the resource to get the IP from. [Documentation](https://pkg.go.dev/github.com/scaleway/scaleway-sdk-go@master/api/ipam/v1#pkg-constants) with type list.
     - `name` - The name of the resource to get the IP from.
 
 - `mac_address` - (Optional) The Mac Address linked to the IP.

docs/resources/ipam_ip.md

@@ -0,0 +1,113 @@
+---
+subcategory: "IPAM"
+page_title: "Scaleway: scaleway_ipam_ip"
+---
+
+# scaleway_ipam_ip
+
+Books and manages Scaleway IPAM IPs.
+
+## Example
+
+### Basic
+
+```hcl
+resource "scaleway_vpc" "vpc01" {
+  name = "my vpc"
+}
+
+resource "scaleway_vpc_private_network" "pn01" {
+  vpc_id = scaleway_vpc.vpc01.id
+  ipv4_subnet {
+    subnet = "172.16.32.0/22"
+  }
+}
+
+resource "scaleway_ipam_ip" "ip01" {
+  source {
+    private_network_id = scaleway_vpc_private_network.pn01.id
+  }
+}
+```
+
+### Request a specific IPv4
+
+```hcl
+resource "scaleway_vpc" "vpc01" {
+  name = "my vpc"
+}
+
+resource "scaleway_vpc_private_network" "pn01" {
+  vpc_id = scaleway_vpc.vpc01.id
+  ipv4_subnet {
+    subnet = "172.16.32.0/22"
+  }
+}
+
+resource "scaleway_ipam_ip" "ip01" {
+  address = "172.16.32.7/22"
+  source {
+    private_network_id = scaleway_vpc_private_network.pn01.id
+  }
+}
+```
+
+### Request an IPv6
+
+```hcl
+resource "scaleway_vpc" "vpc01" {
+  name = "my vpc"
+}
+
+resource "scaleway_vpc_private_network" "pn01" {
+  vpc_id = scaleway_vpc.vpc01.id
+  ipv6_subnets {
+    subnet = "fd46:78ab:30b8:177c::/64"
+  }
+}
+
+resource "scaleway_ipam_ip" "ip01" {
+  is_ipv6 = true
+  source {
+    private_network_id = scaleway_vpc_private_network.pn01.id
+  }
+}
+```
+
+## Arguments Reference
+
+The following arguments are supported:
+
+- `address` - (Optional) Request a specific IP in the requested source pool.
+- `tags` - (Optional) The tags associated with the IP.
+- `source` - (Required) The source in which to book the IP.
+    - `zonal` - The zone the IP lives in if the IP is a public zoned one
+    - `private_network_id` - The private network the IP lives in if the IP is a private IP.
+    - `subnet_id` - The private network subnet the IP lives in if the IP is a private IP in a private network.
+- `is_ipv6` - (Optional) Defines whether to request an IPv6 instead of an IPv4.
+- `region` - (Defaults to [provider](../index.md#region) `region`) The [region](../guides/regions_and_zones.md#regions) of the IP.
+- `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the project the IP is associated with.
+
+## Attributes Reference
+
+In addition to all above arguments, the following attributes are exported:
+
+- `id` - The ID of the IP in IPAM.
+- `resource` - The IP resource.
+    - `id` - The ID of the resource that the IP is bound to.
+    - `type` - The type of resource the IP is attached to.
+    - `name` - The name of the resource the IP is attached to.
+    - `mac_address` - The MAC Address of the resource the IP is attached to.
+- `created_at` - Date and time of IP's creation (RFC 3339 format).
+- `updated_at` - Date and time of IP's last update (RFC 3339 format).
+- `zone` - The zone of the IP.
+
+~> **Important:** IPAM IPs' IDs are [regional](../guides/regions_and_zones.md#resource-ids), which means they are of the form `{region}/{id}`, e.g. `fr-par/11111111-1111-1111-1111-111111111111
+
+## Import
+
+IPAM IPs can be imported using the `{region}/{id}`, e.g.
+
+```bash
+$ terraform import scaleway_ipam_ip.ip_demo fr-par/11111111-1111-1111-1111-111111111111
+```

scaleway/helpers.go

@@ -1137,3 +1137,27 @@ func testAccCheckScalewayResourceIDChanged(resourceName string, resourceID *stri
 		return nil
 	}
 }
+
+// testAccCheckScalewayResourceRawIDMatches asserts the equality of IDs from two specified attributes of two Scaleway resources.
+func testAccCheckScalewayResourceRawIDMatches(res1, attr1, res2, attr2 string) resource.TestCheckFunc {
+	return func(s *terraform.State) error {
+		rs1, ok1 := s.RootModule().Resources[res1]
+		if !ok1 {
+			return fmt.Errorf("not found: %s", res1)
+		}
+
+		rs2, ok2 := s.RootModule().Resources[res2]
+		if !ok2 {
+			return fmt.Errorf("not found: %s", res2)
+		}
+
+		id1 := expandID(rs1.Primary.Attributes[attr1])
+		id2 := expandID(rs2.Primary.Attributes[attr2])
+
+		if id1 != id2 {
+			return fmt.Errorf("ID mismatch: %s from resource %s does not match ID %s from resource %s", id1, res1, id2, res2)
+		}
+
+		return nil
+	}
+}

scaleway/helpers_instance.go

@@ -13,7 +13,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-log/tflog"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
 	"github.com/scaleway/scaleway-sdk-go/api/instance/v1"
-	"github.com/scaleway/scaleway-sdk-go/api/vpc/v1"
+	"github.com/scaleway/scaleway-sdk-go/api/vpc/v2"
 	"github.com/scaleway/scaleway-sdk-go/scw"
 )
 
@@ -292,15 +292,19 @@ func preparePrivateNIC(
 		zonedID, pnExist := r["pn_id"]
 		privateNetworkID := expandID(zonedID.(string))
 		if pnExist {
+			region, err := server.Zone.Region()
+			if err != nil {
+				return nil, err
+			}
 			currentPN, err := vpcAPI.GetPrivateNetwork(&vpc.GetPrivateNetworkRequest{
 				PrivateNetworkID: expandID(privateNetworkID),
-				Zone:             server.Zone,
+				Region:           region,
 			}, scw.WithContext(ctx))
 			if err != nil {
 				return nil, err
 			}
 			query := &instance.CreatePrivateNICRequest{
-				Zone:             currentPN.Zone,
+				Zone:             server.Zone,
 				ServerID:         server.ID,
 				PrivateNetworkID: currentPN.ID,
 			}

scaleway/helpers_ipam.go

@@ -1,6 +1,7 @@
 package scaleway
 
 import (
+	"net"
 	"strings"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
@@ -22,6 +23,18 @@ func ipamAPIWithRegion(d *schema.ResourceData, m interface{}) (*ipam.API, scw.Re
 	return ipamAPI, region, nil
 }
 
+// ipamAPIWithRegionAndID returns a new ipam API with locality and ID extracted from the state
+func ipamAPIWithRegionAndID(m interface{}, id string) (*ipam.API, scw.Region, string, error) {
+	meta := m.(*Meta)
+	ipamAPI := ipam.NewAPI(meta.scwClient)
+
+	region, ID, err := parseRegionalID(id)
+	if err != nil {
+		return nil, "", "", err
+	}
+	return ipamAPI, region, ID, err
+}
+
 // expandLastID expand the last ID in a potential composed ID
 // region/id1/id2 -> id2
 // region/id1 -> id1
@@ -39,3 +52,78 @@ func expandLastID(i interface{}) string {
 
 	return composedID
 }
+
+func expandIPSource(raw interface{}) *ipam.Source {
+	if raw == nil || len(raw.([]interface{})) != 1 {
+		return nil
+	}
+
+	rawMap := raw.([]interface{})[0].(map[string]interface{})
+	return &ipam.Source{
+		Zonal:            expandStringPtr(rawMap["zonal"].(string)),
+		PrivateNetworkID: expandStringPtr(expandID(rawMap["private_network_id"].(string))),
+		SubnetID:         expandStringPtr(rawMap["subnet_id"].(string)),
+	}
+}
+
+func flattenIPSource(source *ipam.Source, privateNetworkID string) interface{} {
+	if source == nil {
+		return nil
+	}
+	return []map[string]interface{}{
+		{
+			"zonal":              flattenStringPtr(source.Zonal),
+			"private_network_id": privateNetworkID,
+			"subnet_id":          flattenStringPtr(source.SubnetID),
+		},
+	}
+}
+
+func flattenIPResource(resource *ipam.Resource) interface{} {
+	if resource == nil {
+		return nil
+	}
+	return []map[string]interface{}{
+		{
+			"type":        resource.Type.String(),
+			"id":          resource.ID,
+			"mac_address": flattenStringPtr(resource.MacAddress),
+			"name":        flattenStringPtr(resource.Name),
+		},
+	}
+}
+
+func checkSubnetIDInFlattenedSubnets(subnetID string, flattenedSubnets interface{}) bool {
+	for _, subnet := range flattenedSubnets.([]map[string]interface{}) {
+		if subnet["id"].(string) == subnetID {
+			return true
+		}
+	}
+	return false
+}
+
+func diffSuppressFuncStandaloneIPandCIDR(_, oldValue, newValue string, _ *schema.ResourceData) bool {
+	oldIP, oldNet, errOld := net.ParseCIDR(oldValue)
+	if errOld != nil {
+		oldIP = net.ParseIP(oldValue)
+	}
+
+	newIP, newNet, errNew := net.ParseCIDR(newValue)
+	if errNew != nil {
+		newIP = net.ParseIP(newValue)
+	}
+
+	if oldIP != nil && newIP != nil && oldIP.Equal(newIP) {
+		return true
+	}
+
+	if oldNet != nil && newIP != nil && oldNet.Contains(newIP) {
+		return true
+	}
+
+	if newNet != nil && oldIP != nil && newNet.Contains(oldIP) {
+		return true
+	}
+
+	return false
+}

scaleway/helpers_vpc.go

@@ -9,28 +9,15 @@ import (
 
 	"github.com/hashicorp/go-cty/cty"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/schema"
-	v1 "github.com/scaleway/scaleway-sdk-go/api/vpc/v1"
-	v2 "github.com/scaleway/scaleway-sdk-go/api/vpc/v2"
+	"github.com/scaleway/scaleway-sdk-go/api/vpc/v2"
 	"github.com/scaleway/scaleway-sdk-go/scw"
 	validator "github.com/scaleway/scaleway-sdk-go/validation"
 )
 
-// vpcAPIWithZoneAndID
-func vpcAPIWithZoneAndID(m interface{}, id string) (*v1.API, scw.Zone, string, error) {
-	meta := m.(*Meta)
-	vpcAPI := v1.NewAPI(meta.scwClient)
-
-	zone, ID, err := parseZonedID(id)
-	if err != nil {
-		return nil, "", "", err
-	}
-	return vpcAPI, zone, ID, err
-}
-
 // vpcAPIWithRegion returns a new VPC API and the region for a Create request
-func vpcAPIWithRegion(d *schema.ResourceData, m interface{}) (*v2.API, scw.Region, error) {
+func vpcAPIWithRegion(d *schema.ResourceData, m interface{}) (*vpc.API, scw.Region, error) {
 	meta := m.(*Meta)
-	vpcAPI := v2.NewAPI(meta.scwClient)
+	vpcAPI := vpc.NewAPI(meta.scwClient)
 
 	region, err := extractRegion(d, meta)
 	if err != nil {
@@ -40,9 +27,9 @@ func vpcAPIWithRegion(d *schema.ResourceData, m interface{}) (*v2.API, scw.Regio
 }
 
 // vpcAPIWithRegionAndID returns a new VPC API with locality and ID extracted from the state
-func vpcAPIWithRegionAndID(m interface{}, id string) (*v2.API, scw.Region, string, error) {
+func vpcAPIWithRegionAndID(m interface{}, id string) (*vpc.API, scw.Region, string, error) {
 	meta := m.(*Meta)
-	vpcAPI := v2.NewAPI(meta.scwClient)
+	vpcAPI := vpc.NewAPI(meta.scwClient)
 
 	region, ID, err := parseRegionalID(id)
 	if err != nil {
@@ -51,13 +38,13 @@ func vpcAPIWithRegionAndID(m interface{}, id string) (*v2.API, scw.Region, strin
 	return vpcAPI, region, ID, err
 }
 
-func vpcAPI(m interface{}) (*v1.API, error) {
+func vpcAPI(m interface{}) (*vpc.API, error) {
 	meta, ok := m.(*Meta)
 	if !ok {
 		return nil, fmt.Errorf("wrong type: %T", m)
 	}
 
-	return v1.NewAPI(meta.scwClient), nil
+	return vpc.NewAPI(meta.scwClient), nil
 }
 
 func expandSubnets(d *schema.ResourceData) (ipv4Subnets []scw.IPNet, ipv6Subnets []scw.IPNet, err error) {
@@ -89,7 +76,7 @@ func flattenAndSortSubnets(sub interface{}) (interface{}, interface{}) {
 	switch subnets := sub.(type) {
 	case []scw.IPNet:
 		return flattenAndSortIPNetSubnets(subnets)
-	case []*v2.Subnet:
+	case []*vpc.Subnet:
 		return flattenAndSortSubnetV2s(subnets)
 	default:
 		return "", nil
@@ -134,7 +121,7 @@ func flattenAndSortIPNetSubnets(subnets []scw.IPNet) (interface{}, interface{})
 	return flattenedipv4Subnets, flattenedipv6Subnets
 }
 
-func flattenAndSortSubnetV2s(subnets []*v2.Subnet) (interface{}, interface{}) {
+func flattenAndSortSubnetV2s(subnets []*vpc.Subnet) (interface{}, interface{}) {
 	if subnets == nil {
 		return "", nil
 	}

scaleway/provider.go

@@ -133,6 +133,7 @@ func Provider(config *ProviderConfig) plugin.ProviderFunc {
 				"scaleway_iot_device":                          resourceScalewayIotDevice(),
 				"scaleway_iot_route":                           resourceScalewayIotRoute(),
 				"scaleway_iot_network":                         resourceScalewayIotNetwork(),
+				"scaleway_ipam_ip":                             resourceScalewayIPAMIP(),
 				"scaleway_k8s_cluster":                         resourceScalewayK8SCluster(),
 				"scaleway_k8s_pool":                            resourceScalewayK8SPool(),
 				"scaleway_lb":                                  resourceScalewayLb(),