feat(vpc): add support for regional private networks (#1975)

* feat(vpc): add support for regional private networks

* fix

* add doc

* Apply suggestions from code review

Co-authored-by: Nathanael Demacon <[email protected]>

* lint

* renaming

* fix

---------

Co-authored-by: Rémy Léone <[email protected]>
Co-authored-by: Nathanael Demacon <[email protected]>
Co-authored-by: Rémy Léone <[email protected]>

Author: 3 people

docs/data-sources/vpc_private_network.md

@@ -9,7 +9,17 @@ Gets information about a private network.
 
 ## Example Usage
 
-N/A, the usage will be meaningful in the next releases of VPC.
+```hcl
+# Get info by name
+data "scaleway_vpc_private_network" "my_name" {
+  name = "foobar"
+}
+
+# Get info by IP ID
+data "scaleway_vpc_private_network" "my_id" {
+  private_network_id_id = "11111111-1111-1111-1111-111111111111"
+}
+```
 
 ## Argument Reference
 
@@ -21,6 +31,7 @@ N/A, the usage will be meaningful in the next releases of VPC.
 In addition to all above arguments, the following attributes are exported:
 
 - `id` - The ID of the private network.
-- `subnets` - The subnets CIDR associated with private network.
+- `ipv4_subnet` - (Optional) The IPv4 subnet associated with the private network.
+- `ipv6_subnets` - (Optional) The IPv6 subnets associated with the private network.
 
-~> **Important:** Private networks' IDs are [zoned](../guides/regions_and_zones.md#resource-ids), which means they are of the form `{zone}/{id}`, e.g. `fr-par-1/11111111-1111-1111-1111-111111111111`
+~> **Important:** Private networks' IDs are [zoned](../guides/regions_and_zones.md#resource-ids) or [regional](../guides/regions_and_zones.md#resource-ids) if using beta, which means they are of the form `{zone}/{id}`, e.g. `fr-par-1/11111111-1111-1111-1111-111111111111` or `{region}/{id}`, e.g. `fr-par/11111111-1111-1111-1111-111111111111

docs/resources/vpc_private_network.md

@@ -17,6 +17,22 @@ resource "scaleway_vpc_private_network" "pn_priv" {
 }
 ```
 
+-> **Note:** Regional Private Network is now in Public Beta. You can create a regional private network directly using this resource by setting `is_regional` to `true`.
+
+```hcl
+resource "scaleway_vpc" "vpc01" {
+  name = "test-vpc"
+  tags = ["terraform", "vpc"]
+}
+
+resource "scaleway_vpc_private_network" "regional_pn" {
+  name        = "my_regiona_pn"
+  tags        = ["terraform", "pn", "regional"]
+  is_regional = true
+  vpc_id      = scaleway_vpc.vpc01.id
+}
+```
+
 ## Arguments Reference
 
 The following arguments are supported:
@@ -25,22 +41,33 @@ The following arguments are supported:
 - `tags` - (Optional) The tags associated with the private network.
 - `zone` - (Defaults to [provider](../index.md#zone) `zone`) The [zone](../guides/regions_and_zones.md#zones) in which the private network should be created.
 - `project_id` - (Defaults to [provider](../index.md#project_id) `project_id`) The ID of the project the private network is associated with.
-- `subnets` - (Optional) The subnets CIDR associated with private network.
+- `ipv4_subnet` - (Optional) The IPv4 subnet associated with the private network.
+- `ipv6_subnets` - (Optional) The IPv6 subnets associated with the private network.
+
+-> **Note:** If using Regional Private Network:
+
+- `region` - (Defaults to [provider](../index.md#region) `region`) The [region](../guides/regions_and_zones.md#regions) of the private network.
+- `vpc_id` - (Optional) The VPC in which to create the private network.
+- `is_regional` - (Optional) Defines whether the private network is Regional. By default, it will be Zonal.
 
 ## Attributes Reference
 
 In addition to all above arguments, the following attributes are exported:
 
 - `id` - The ID of the private network.
 
-~> **Important:** Private networks' IDs are [zoned](../guides/regions_and_zones.md#resource-ids), which means they are of the form `{zone}/{id}`, e.g. `fr-par-1/11111111-1111-1111-1111-111111111111`
+~> **Important:** Private networks' IDs are [zoned](../guides/regions_and_zones.md#resource-ids) or [regional](../guides/regions_and_zones.md#resource-ids) if using beta, which means they are of the form `{zone}/{id}`, e.g. `fr-par-1/11111111-1111-1111-1111-111111111111` or `{region}/{id}`, e.g. `fr-par/11111111-1111-1111-1111-111111111111
 
 - `organization_id` - The organization ID the private network is associated with.
 
 ## Import
 
-Private networks can be imported using the `{zone}/{id}`, e.g.
+Private networks can be imported using the `{zone}/{id}` or `{region}/{id}` using beta, e.g.
 
 ```bash
 $ terraform import scaleway_vpc_private_network.vpc_demo fr-par-1/11111111-1111-1111-1111-111111111111
 ```
+
+```bash
+$ terraform import scaleway_vpc_private_network.vpc_demo fr-par/11111111-1111-1111-1111-111111111111
+```

scaleway/data_source_vpc_private_network_test.go

@@ -43,25 +43,31 @@ func TestAccScalewayDataSourceVPCPrivateNetwork_Basic(t *testing.T) {
 						"scaleway_vpc_private_network.pn_test", "name"),
 					resource.TestCheckResourceAttr(
 						"data.scaleway_vpc_private_network.pn_test_by_name",
-						"subnets.#", "2"),
+						"ipv4_subnet.#", "1"),
+					resource.TestCheckResourceAttr(
+						"data.scaleway_vpc_private_network.pn_test_by_name",
+						"ipv6_subnets.#", "1"),
 					resource.TestCheckTypeSetElemAttrPair(
-						"data.scaleway_vpc_private_network.pn_test_by_name", "subnets.*",
-						"scaleway_vpc_private_network.pn_test", "subnets.0"),
+						"data.scaleway_vpc_private_network.pn_test_by_name", "ipv4_subnet.0.subnet",
+						"scaleway_vpc_private_network.pn_test", "ipv4_subnet.0.subnet"),
 					resource.TestCheckTypeSetElemAttrPair(
-						"data.scaleway_vpc_private_network.pn_test_by_name", "subnets.*",
-						"scaleway_vpc_private_network.pn_test", "subnets.1"),
+						"data.scaleway_vpc_private_network.pn_test_by_name", "ipv6_subnets.0.subnet",
+						"scaleway_vpc_private_network.pn_test", "ipv6_subnets.0.subnet"),
 					resource.TestCheckResourceAttrPair(
 						"data.scaleway_vpc_private_network.pn_test_by_id", "private_network_id",
 						"scaleway_vpc_private_network.pn_test", "id"),
 					resource.TestCheckResourceAttr(
 						"data.scaleway_vpc_private_network.pn_test_by_id",
-						"subnets.#", "2"),
+						"ipv4_subnet.#", "1"),
+					resource.TestCheckResourceAttr(
+						"data.scaleway_vpc_private_network.pn_test_by_id",
+						"ipv6_subnets.#", "1"),
 					resource.TestCheckTypeSetElemAttrPair(
-						"data.scaleway_vpc_private_network.pn_test_by_id", "subnets.*",
-						"scaleway_vpc_private_network.pn_test", "subnets.0"),
+						"data.scaleway_vpc_private_network.pn_test_by_id", "ipv4_subnet.0.subnet",
+						"scaleway_vpc_private_network.pn_test", "ipv4_subnet.0.subnet"),
 					resource.TestCheckTypeSetElemAttrPair(
-						"data.scaleway_vpc_private_network.pn_test_by_id", "subnets.*",
-						"scaleway_vpc_private_network.pn_test", "subnets.1"),
+						"data.scaleway_vpc_private_network.pn_test_by_id", "ipv6_subnets.0.subnet",
+						"scaleway_vpc_private_network.pn_test", "ipv6_subnets.0.subnet"),
 				),
 			},
 		},

scaleway/helpers_vpc.go

@@ -66,28 +66,108 @@ func vpcAPI(m interface{}) (*v1.API, error) {
 	return v1.NewAPI(meta.scwClient), nil
 }
 
-func expandSubnets(data interface{}) ([]scw.IPNet, error) {
-	var ipNets []scw.IPNet
-	for _, s := range data.([]interface{}) {
-		if s == nil {
-			s = ""
+func expandSubnets(d *schema.ResourceData) (ipv4Subnets []scw.IPNet, ipv6Subnets []scw.IPNet, err error) {
+	if v, ok := d.GetOk("ipv4_subnet"); ok {
+		for _, s := range v.([]interface{}) {
+			rawSubnet := s.(map[string]interface{})
+			ipNet, err := expandIPNet(rawSubnet["subnet"].(string))
+			if err != nil {
+				return nil, nil, err
+			}
+			ipv4Subnets = append(ipv4Subnets, ipNet)
 		}
-		ipNet, err := expandIPNet(s.(string))
-		if err != nil {
-			return nil, err
+	}
+
+	if v, ok := d.GetOk("ipv6_subnets"); ok {
+		for _, s := range v.(*schema.Set).List() {
+			rawSubnet := s.(map[string]interface{})
+			ipNet, err := expandIPNet(rawSubnet["subnet"].(string))
+			if err != nil {
+				return nil, nil, err
+			}
+			ipv6Subnets = append(ipv6Subnets, ipNet)
+		}
+	}
+	return
+}
+
+func flattenAndSortSubnets(sub interface{}) (interface{}, interface{}) {
+	switch subnets := sub.(type) {
+	case []scw.IPNet:
+		return flattenAndSortIPNetSubnets(subnets)
+	case []*v2.Subnet:
+		return flattenAndSortSubnetV2s(subnets)
+	default:
+		return "", nil
+	}
+}
+
+func flattenAndSortIPNetSubnets(subnets []scw.IPNet) (interface{}, interface{}) {
+	if subnets == nil {
+		return "", nil
+	}
+
+	flattenedipv4Subnets := []map[string]interface{}(nil)
+	flattenedipv6Subnets := []map[string]interface{}(nil)
+
+	for _, s := range subnets {
+		// If it's an IPv4 subnet
+		if s.IP.To4() != nil {
+			sub, err := flattenIPNet(s)
+			if err != nil {
+				return "", nil
+			}
+			flattenedipv4Subnets = append(flattenedipv4Subnets, map[string]interface{}{
+				"subnet": sub,
+			})
+		} else {
+			sub, err := flattenIPNet(s)
+			if err != nil {
+				return "", nil
+			}
+			flattenedipv6Subnets = append(flattenedipv6Subnets, map[string]interface{}{
+				"subnet": sub,
+			})
 		}
-		ipNets = append(ipNets, ipNet)
 	}
 
-	return ipNets, nil
+	return flattenedipv4Subnets, flattenedipv6Subnets
 }
 
-func flattenSubnets(subnets []scw.IPNet) *schema.Set {
-	var rawSubnets []interface{}
+func flattenAndSortSubnetV2s(subnets []*v2.Subnet) (interface{}, interface{}) {
+	if subnets == nil {
+		return "", nil
+	}
+
+	flattenedipv4Subnets := []map[string]interface{}(nil)
+	flattenedipv6Subnets := []map[string]interface{}(nil)
+
 	for _, s := range subnets {
-		rawSubnets = append(rawSubnets, s.String())
+		// If it's an IPv4 subnet
+		if s.Subnet.IP.To4() != nil {
+			sub, err := flattenIPNet(s.Subnet)
+			if err != nil {
+				return "", nil
+			}
+			flattenedipv4Subnets = append(flattenedipv4Subnets, map[string]interface{}{
+				"id":         s.ID,
+				"created_at": flattenTime(s.CreatedAt),
+				"updated_at": flattenTime(s.UpdatedAt),
+				"subnet":     sub,
+			})
+		} else {
+			sub, err := flattenIPNet(s.Subnet)
+			if err != nil {
+				return "", nil
+			}
+			flattenedipv6Subnets = append(flattenedipv6Subnets, map[string]interface{}{
+				"id":         s.ID,
+				"created_at": flattenTime(s.CreatedAt),
+				"updated_at": flattenTime(s.UpdatedAt),
+				"subnet":     sub,
+			})
+		}
 	}
-	return schema.NewSet(func(i interface{}) int {
-		return StringHashcode(i.(string))
-	}, rawSubnets)
+
+	return flattenedipv4Subnets, flattenedipv6Subnets
 }