feat(instance): ip: document and test IPv6 specificity

Author: Mia-Cross

docs/resources/instance_ip.md

@@ -30,6 +30,11 @@ In addition to all arguments above, the following attributes are exported:
 ~> **Important:** Instance IPs' 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`
 
 - `address` - The IP address.
+
+~> **Important:** For IPv6 addresses, the full address is not readable from the "scaleway_instance_ip" resource, only the prefix.
+To get the full address, the IP must be attached to another resource and read from the latter.
+For example, for a server, the address will be listed in the "public_ips" or "private_ips" attribute of the "scaleway_instance_server".
+
 - `prefix` - The IP Prefix.
 - `reverse` - The reverse dns attached to this IP
 - `organization_id` - The organization ID the IP is associated with.

internal/services/instance/helpers_instance.go

@@ -599,3 +599,15 @@ func DeleteASGServers(
 
 	return nil
 }
+
+// FindIPInList looks for an IP in a list to avoid using the deprecated server.PublicIP field
+func FindIPInList(ipID string, ips []*instance.ServerIP) *instance.ServerIP {
+	id := zonal.ExpandID(ipID).ID
+	for _, ip := range ips {
+		if ip.ID == id {
+			return ip
+		}
+	}
+
+	return nil
+}

internal/services/instance/ip_test.go

@@ -3,6 +3,7 @@ package instance_test
 import (
 	"fmt"
 	"net"
+	"strings"
 	"testing"
 
 	"github.com/hashicorp/terraform-plugin-testing/helper/resource"
@@ -120,7 +121,41 @@ func TestAccIP_RoutedIPV6(t *testing.T) {
 					resource.TestCheckResourceAttr("scaleway_instance_ip.main", "type", "routed_ipv6"),
 					resource.TestCheckResourceAttrSet("scaleway_instance_ip.main", "address"),
 					resource.TestCheckResourceAttrSet("scaleway_instance_ip.main", "prefix"),
-					isIPValid("scaleway_instance_ip.main", "address"),
+					isIPValid("scaleway_instance_ip.main", "address", true),
+					isIPCIDRValid("scaleway_instance_ip.main", "prefix"),
+				),
+			},
+		},
+	})
+}
+
+func TestAccIP_RoutedIPV6_Attached(t *testing.T) {
+	tt := acctest.NewTestTools(t)
+	defer tt.Cleanup()
+
+	resource.ParallelTest(t, resource.TestCase{
+		ProviderFactories: tt.ProviderFactories,
+		CheckDestroy:      instancechecks.IsIPDestroyed(tt),
+		Steps: []resource.TestStep{
+			{
+				Config: `
+						resource "scaleway_instance_ip" "main" {
+							type = "routed_ipv6"
+						}
+						resource "scaleway_instance_server" "main" {
+							type = "PRO2-S"
+							image = "ubuntu_noble"
+							ip_id = scaleway_instance_ip.main.id
+						}
+					`,
+				Check: resource.ComposeTestCheckFunc(
+					instancechecks.CheckIPExists(tt, "scaleway_instance_ip.main"),
+					resource.TestCheckResourceAttr("scaleway_instance_ip.main", "type", "routed_ipv6"),
+					resource.TestCheckResourceAttrSet("scaleway_instance_ip.main", "address"),
+					resource.TestCheckResourceAttrSet("scaleway_instance_ip.main", "prefix"),
+					resource.TestCheckResourceAttrSet("scaleway_instance_server.main", "public_ips.0.address"),
+					isIPValid("scaleway_instance_ip.main", "address", true),
+					isIPValid("scaleway_instance_server.main", "public_ips.0.address", false),
 					isIPCIDRValid("scaleway_instance_ip.main", "prefix"),
 				),
 			},
@@ -149,7 +184,7 @@ func isIPCIDRValid(name string, key string) resource.TestCheckFunc {
 	}
 }
 
-func isIPValid(name string, key string) resource.TestCheckFunc {
+func isIPValid(name string, key string, acceptPrefixFormat bool) resource.TestCheckFunc {
 	return func(s *terraform.State) error {
 		rs, ok := s.RootModule().Resources[name]
 		if !ok {
@@ -161,6 +196,10 @@ func isIPValid(name string, key string) resource.TestCheckFunc {
 			return fmt.Errorf("requested attribute %s[%q] does not exist", name, key)
 		}
 
+		if !acceptPrefixFormat && strings.HasSuffix(ip, "::") {
+			return fmt.Errorf("ip has prefix format (%s) in %s[%s]", ip, name, key)
+		}
+
 		parsedIP := net.ParseIP(ip)
 		if parsedIP == nil {
 			return fmt.Errorf("invalid ip (%s) in %s[%q]", ip, name, key)
@@ -203,8 +242,9 @@ func isIPAttachedToServer(tt *acctest.TestTools, ipResource, serverResource stri
 			return err
 		}
 
-		if server.Server.PublicIP != nil && server.Server.PublicIP.Address.String() != ip.IP.Address.String() { //nolint:staticcheck
-			return fmt.Errorf("IPs should be the same in %s and %s: %v is different than %v", ipResource, serverResource, server.Server.PublicIP.Address, ip.IP.Address) //nolint:staticcheck
+		publicIP := instance.FindIPInList(ID, server.Server.PublicIPs)
+		if publicIP != nil && publicIP.Address.String() != ip.IP.Address.String() {
+			return fmt.Errorf("IPs should be the same in %s and %s: %v is different than %v", ipResource, serverResource, publicIP.Address, ip.IP.Address)
 		}
 
 		return nil
@@ -231,7 +271,8 @@ func serverHasNoIPAssigned(tt *acctest.TestTools, serverResource string) resourc
 			return err
 		}
 
-		if server.Server.PublicIP != nil && !server.Server.PublicIP.Dynamic { //nolint:staticcheck
+		publicIP := instance.FindIPInList(ID, server.Server.PublicIPs)
+		if publicIP != nil && !publicIP.Dynamic {
 			return fmt.Errorf("no flexible IP should be assigned to %s", serverResource)
 		}
 

internal/services/instance/testdata/ip-routed-ipv6-attached.cassette.yaml

@@ -31,6 +31,11 @@ In addition to all arguments above, the following attributes are exported:
 ~> **Important:** Instance IPs' 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`
 
 - `address` - The IP address.
+
+~> **Important:** For IPv6 addresses, the full address is not readable from the "scaleway_instance_ip" resource, only the prefix.
+To get the full address, the IP must be attached to another resource and read from the latter.
+For example, for a server, the address will be listed in the "public_ips" or "private_ips" attribute of the "scaleway_instance_server".
+
 - `prefix` - The IP Prefix.
 - `reverse` - The reverse dns attached to this IP
 - `organization_id` - The organization ID the IP is associated with.