net, libs: Refactor random ip address helpers

Return CIDR strings directly from the low-level helpers.
Callers that need a plain IP call the relevant helper with
cidr_required=False.
callers that need a non-standard mask may strip the cidr and
reapply it.

Remove random_ip_addresses_by_family — it became identical to
random_cidr_addresses_by_family after this change.

Signed-off-by: Asia Khromov <azhivovk@redhat.com>
Assisted-by: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

Author: azhivovk

libs/net/ip.py

@@ -30,34 +30,15 @@ def random_cidr_addresses_by_family(net_seed: int, host_address: int) -> list[st
     Returns:
         List of CIDR strings (e.g. ["192.168.1.1/24", "fd00::1/64"]).
     """
-    return [
-        f"{ip}/64" if ipaddress.ip_address(ip).version == 6 else f"{ip}/24"
-        for ip in random_ip_addresses_by_family(net_seed=net_seed, host_address=host_address)
-    ]
-
-
-def random_ip_addresses_by_family(
-    net_seed: int,
-    host_address: int,
-) -> list[str]:
-    """Generate IP addresses for each IP family supported by the cluster network stack.
-
-    Args:
-        net_seed: Seed index for selecting the random network portion of the address.
-        host_address: Host portion of the address, used to place VMs on the same subnet.
-
-    Returns:
-        List of IP address strings, one per IP family supported by the cluster.
-    """
-    ips = []
+    addresses = []
     if ipv4_supported_cluster():
-        ips.append(random_ipv4_address(net_seed=net_seed, host_address=host_address))
+        addresses.append(random_ipv4_address(net_seed=net_seed, host_address=host_address))
     if ipv6_supported_cluster():
-        ips.append(random_ipv6_address(net_seed=net_seed, host_address=host_address))
-    return ips
+        addresses.append(random_ipv6_address(net_seed=net_seed, host_address=host_address))
+    return addresses
 
 
-def random_ipv4_address(net_seed: int, host_address: int) -> str:
+def random_ipv4_address(net_seed: int, host_address: int, cidr_required: bool = True) -> str:
     """Construct a random IPv4 address using a cached list of random third octets.
 
     Uses a pre-defined network address, a cached random third octet and the given
@@ -66,12 +47,14 @@ def random_ipv4_address(net_seed: int, host_address: int) -> str:
     Args:
         net_seed (int): The index used to select a random third octet from the cached list.
         host_address (int): The last (fourth) octet of the IPv4 address.
+        cidr_required (bool): When True (default), appends /24 prefix length to the address.
 
     Returns:
-        str: A string representing a randomized IPv4 address.
+        str: A randomized IPv4 address, optionally in CIDR notation.
     """
     third_octets = _random_octets(count=_MAX_NUM_OF_RANDOM_OCTETS_PER_SESSION)
-    return f"{_IPV4_ADDRESS_SUBNET_PREFIX_VMI}.{third_octets[net_seed]}.{host_address}"
+    subnet_length = "/24" if cidr_required else ""
+    return f"{_IPV4_ADDRESS_SUBNET_PREFIX_VMI}.{third_octets[net_seed]}.{host_address}{subnet_length}"
 
 
 @cache
@@ -90,7 +73,7 @@ def _random_octets(count: int) -> list[int]:
     return random.sample(range(1, 254), count)
 
 
-def random_ipv6_address(net_seed: int, host_address: int) -> str:
+def random_ipv6_address(net_seed: int, host_address: int, cidr_required: bool = True) -> str:
     """Construct a random IPv6 address using a cached list of random seventh hextets.
 
     Uses a pre-defined network prefix, a cached random seventh hextet and the given
@@ -99,12 +82,14 @@ def random_ipv6_address(net_seed: int, host_address: int) -> str:
     Args:
         net_seed (int): The index used to select a random seventh hextet from the cached list.
         host_address (int): The last (eighth) hextet of the IPv6 address.
+        cidr_required (bool): When True (default), appends /64 prefix length to the address.
 
     Returns:
-        str: A string representing a randomized IPv6 address.
+        str: A randomized IPv6 address, optionally in CIDR notation.
     """
     seventh_hextets = _random_hextets(count=_MAX_NUM_OF_RANDOM_HEXTETS_PER_SESSION)
-    return f"{_IPV6_ADDRESS_SUBNET_PREFIX_VMI}::{seventh_hextets[net_seed]:x}:{host_address:x}"
+    subnet_length = "/64" if cidr_required else ""
+    return f"{_IPV6_ADDRESS_SUBNET_PREFIX_VMI}::{seventh_hextets[net_seed]:x}:{host_address:x}{subnet_length}"
 
 
 @cache

tests/conftest.py

@@ -1648,8 +1648,8 @@ def running_vm_upgrade_a(
             "ethernets": {
                 "eth1": {
                     "addresses": [
-                        f"{random_ipv4_address(net_seed=0, host_address=1)}/24",
-                        f"{random_ipv6_address(net_seed=0, host_address=1)}/64",
+                        random_ipv4_address(net_seed=0, host_address=1),
+                        random_ipv6_address(net_seed=0, host_address=1),
                     ]
                 }
             }
@@ -1692,8 +1692,8 @@ def running_vm_upgrade_b(
             "ethernets": {
                 "eth1": {
                     "addresses": [
-                        f"{random_ipv4_address(net_seed=0, host_address=2)}/24",
-                        f"{random_ipv6_address(net_seed=0, host_address=2)}/64",
+                        random_ipv4_address(net_seed=0, host_address=2),
+                        random_ipv6_address(net_seed=0, host_address=2),
                     ]
                 }
             }

tests/network/bgp/conftest.py

@@ -40,8 +40,8 @@
 BGP_DATA_PATH: Final[Path] = Path(__file__).resolve().parent / "data" / "frr-config"
 CUDN_BGP_LABEL: Final[dict] = {"cudn-bgp": "blue"}
 CUDN_SUBNET_IPV4: Final[str] = "192.168.10.0/24"
-EXTERNAL_PROVIDER_SUBNET_IPV4: Final[str] = f"{random_ipv4_address(net_seed=1, host_address=0)}/24"
-EXTERNAL_PROVIDER_IP_V4: Final[str] = f"{random_ipv4_address(net_seed=1, host_address=150)}/24"
+EXTERNAL_PROVIDER_SUBNET_IPV4: Final[str] = random_ipv4_address(net_seed=1, host_address=0)
+EXTERNAL_PROVIDER_IP_V4: Final[str] = random_ipv4_address(net_seed=1, host_address=150)
 IPERF3_SERVER_PORT: Final[int] = 2354
 LOCALNET_NETWORK_NAME: Final[str] = "localnet-network-bgp"
 

tests/network/bgp/evpn/conftest.py

@@ -41,8 +41,8 @@
 EVPN_ADVERTISE_LABEL: Final[dict] = {"advertise": "evpn"}
 APP_EVPN_CUDN_LABEL: Final[dict] = {**EVPN_ADVERTISE_LABEL, "app": "cudn-evpn"}
 CUDN_EVPN_BGP_LABEL: Final[dict] = {"cudn-bgp": "evpn"}
-EXTERNAL_L2_ENDPOINT_IPV4: Final[str] = f"{random_ipv4_address(net_seed=5, host_address=250)}/24"
-EXTERNAL_L2_ENDPOINT_IPV6: Final[str] = f"{random_ipv6_address(net_seed=5, host_address=250)}/64"
+EXTERNAL_L2_ENDPOINT_IPV4: Final[str] = random_ipv4_address(net_seed=5, host_address=250)
+EXTERNAL_L2_ENDPOINT_IPV6: Final[str] = random_ipv6_address(net_seed=5, host_address=250)
 EXTERNAL_L3_ENDPOINT_IPV4: Final[str] = "192.168.100.100/24"
 EXTERNAL_L3_ENDPOINT_IPV6: Final[str] = "fd01:1234:5678::64/64"
 EXTERNAL_L3_GATEWAY_IPV4: Final[str] = "192.168.100.1/24"

tests/network/bgp/evpn/libevpn.py

@@ -24,8 +24,8 @@
 
 LOGGER = logging.getLogger(__name__)
 
-CUDN_EVPN_SUBNET_IPV4: str = f"{random_ipv4_address(net_seed=5, host_address=0)}/24"
-CUDN_EVPN_SUBNET_IPV6: str = f"{random_ipv6_address(net_seed=5, host_address=0)}/64"
+CUDN_EVPN_SUBNET_IPV4: str = random_ipv4_address(net_seed=5, host_address=0)
+CUDN_EVPN_SUBNET_IPV6: str = random_ipv6_address(net_seed=5, host_address=0)
 
 _BRIDGE_NAME: str = "br0"
 _VXLAN_NAME: str = "vxlan0"

tests/network/bond/test_l2_bridge_over_bond.py

@@ -142,7 +142,7 @@ def ovs_linux_bond_bridge_attached_vma(
     networks = OrderedDict()
     networks[ovs_linux_br1bond_nad.name] = ovs_linux_br1bond_nad.name
     netdata = netcloud.NetworkData(
-        ethernets={"eth1": netcloud.EthernetDevice(addresses=[f"{random_ipv4_address(net_seed=0, host_address=1)}/24"])}
+        ethernets={"eth1": netcloud.EthernetDevice(addresses=[random_ipv4_address(net_seed=0, host_address=1)])}
     )
 
     with VirtualMachineForTests(
@@ -170,9 +170,7 @@ def ovs_linux_bond_bridge_attached_vmb(
     name = "bond-vmb"
     networks = OrderedDict()
     networks[ovs_linux_br1bond_nad.name] = ovs_linux_br1bond_nad.name
-    network_data_data = {
-        "ethernets": {"eth1": {"addresses": [f"{random_ipv4_address(net_seed=0, host_address=2)}/24"]}}
-    }
+    network_data_data = {"ethernets": {"eth1": {"addresses": [random_ipv4_address(net_seed=0, host_address=2)]}}}
     cloud_init_data = cloud_init_network_data(data=network_data_data)
 
     with VirtualMachineForTests(

tests/network/connectivity/utils.py

@@ -41,9 +41,9 @@ def secondary_interfaces_cloud_init_data(
         interface_name = f"eth{i + 1}"
         addresses = []
         if ipv4_supported_cluster():
-            addresses.append(f"{random_ipv4_address(net_seed=i, host_address=host_id)}/24")
+            addresses.append(random_ipv4_address(net_seed=i, host_address=host_id))
         if ipv6_supported_cluster():
-            addresses.append(f"{random_ipv6_address(net_seed=i, host_address=host_id)}/64")
+            addresses.append(random_ipv6_address(net_seed=i, host_address=host_id))
 
         ethernets[interface_name] = {"addresses": addresses}
 

tests/network/flat_overlay/conftest.py

@@ -322,7 +322,7 @@ def vmb_ingress_multi_network_policy(
         network_name=flat_overlay_vma_vmb_nad.name,
         policy_types=["Ingress"],
         ingress=create_ip_block(
-            ip_address=f"{random_ipv4_address(net_seed=0, host_address=123)}/{SPECIFIC_HOST_MASK}",
+            ip_address=f"{random_ipv4_address(net_seed=0, host_address=123, cidr_required=False)}/{SPECIFIC_HOST_MASK}",
         ),
         client=admin_client,
     ) as mnp:

tests/network/flat_overlay/utils.py

@@ -34,7 +34,7 @@ def create_flat_overlay_vm(
     networks = {nad_name: nad_name}
     network_data = {
         "ethernets": {
-            "eth1": {"addresses": [f"{random_ipv4_address(net_seed=0, host_address=host_ip_suffix)}/24"]},
+            "eth1": {"addresses": [random_ipv4_address(net_seed=0, host_address=host_ip_suffix)]},
         }
     }
     cloud_init_data = compose_cloud_init_data_dict(network_data=network_data)

tests/network/general/test_cnv_tuning_regression.py

@@ -36,9 +36,7 @@ def linux_bridge_device(nmstate_dependent_placeholder, admin_client, worker_node
 def cnv_tuning_vm(unprivileged_client, worker_node1, linux_bridge_nad, linux_bridge_device):
     name = "tuning-vma"
     networks = {"net1": linux_bridge_nad.name}
-    network_data_data = {
-        "ethernets": {"eth1": {"addresses": [f"{random_ipv4_address(net_seed=0, host_address=1)}/24"]}}
-    }
+    network_data_data = {"ethernets": {"eth1": {"addresses": [random_ipv4_address(net_seed=0, host_address=1)]}}}
 
     with VirtualMachineForTests(
         namespace=linux_bridge_nad.namespace,