fix: get instances private IPs

Author: Gnoale

.gitignore

@@ -133,3 +133,5 @@ dmypy.json
 
 # Archive files
 *.tar.gz
+
+tests/.../inventory

plugins/inventory/scaleway.py

@@ -62,7 +62,8 @@
             - public_ipv4
         choices:
             - public_ipv4
-            - private_ipv4
+            - vpc_ipv4
+            - vpc_ipv6
             - public_ipv6
             - hostname
             - id
@@ -76,8 +77,8 @@
             - "  - C(state): The server state."
             - "  - C(hostname): The server hostname."
             - "  - C(public_ipv4): The server public ipv4."
-            - "  - C(private_ipv4): The server private ipv4."
-            - "  - C(public_ipv6): The server public ipv6."
+            - "  - C(vpc_ipv4): The server private ipv4."
+            - "  - C(vpc_ipv6): The server public ipv6."
             - "  - C(public_dns): The server public dns."
             - "  - C(private_dns): The server private dns."
             - "If the variable is not found, the host will be ignored."
@@ -100,24 +101,28 @@
 
 import os
 from dataclasses import dataclass, field
-from types import SimpleNamespace
-from typing import List
+from typing import List, Optional
 
 from ansible.errors import AnsibleError
+from ansible.inventory.data import Host
 from ansible.module_utils.basic import missing_required_lib
 from ansible.plugins.inventory import BaseInventoryPlugin, Cacheable, Constructable
 
+from ..module_utils.instance import get_instance_private_ips
+
 try:
-    from scaleway_core.bridge import Zone
     from scaleway import Client, ScalewayException
     from scaleway.applesilicon.v1alpha1 import ApplesiliconV1Alpha1API
     from scaleway.applesilicon.v1alpha1 import Server as ApplesiliconServer
-    from scaleway.baremetal.v1 import BaremetalV1API, IPVersion as BaremetalIPVersion
+    from scaleway.baremetal.v1 import BaremetalV1API
+    from scaleway.baremetal.v1 import IPVersion as BaremetalIPVersion
     from scaleway.baremetal.v1 import Server as BaremetalServer
+    from scaleway.dedibox.v1 import DediboxV1API
+    from scaleway.dedibox.v1 import IPVersion as DediboxIPVersion
+    from scaleway.dedibox.v1 import ServerSummary as DediboxServer
     from scaleway.instance.v1 import InstanceV1API, ServerState
     from scaleway.instance.v1 import Server as InstanceServer
-    from scaleway.dedibox.v1 import DediboxV1API, IPVersion as DediboxIPVersion
-    from scaleway.dedibox.v1 import ServerSummary as DediboxServer
+    from scaleway_core.bridge import Zone
 
     HAS_SCALEWAY_SDK = True
 except ImportError:
@@ -139,16 +144,17 @@ class _Filters:
 
 
 @dataclass
-class _Host:
+class _Host(Host):
     id: str
     tags: List[str]
     zone: "Zone"
     state: "ServerState"
 
     hostname: str
-    public_ipv4: list[str] = field(default_factory=list)
-    private_ipv4: list[str] = field(default_factory=list)
-    public_ipv6: list[str] = field(default_factory=list)
+    public_ipv4: Optional[str] = None
+    public_ipv6: Optional[str] = None
+    vpc_ipv4: Optional[str] = None
+    vpc_ipv6: Optional[str] = None
 
     # Instances-only
     public_dns: str | None = None
@@ -225,7 +231,6 @@ def populate(self, all_hosts: List[_Host]):
                     self.display.warning(
                         f"Skipping host {host.id}: Field {source} is not available."
                     )
-                    self.inventory.remove_host(SimpleNamespace(name=hostname))
                     should_skip = True
                     break
 
@@ -281,17 +286,27 @@ def _get_instances(self, client: "Client", filters: _Filters) -> List[_Host]:
                     )
                 )
 
+        # get vpc private ips
+        vpc_ips = get_instance_private_ips(client, servers)
+
         results: List[_Host] = []
         for server in servers:
+            vpc4 = None
+            vpc6 = None
+            if server.id in vpc_ips:
+                vpc4 = vpc_ips[server.id].ipv4
+                vpc6 = vpc_ips[server.id].ipv6
+
             host = _Host(
                 id=server.id,
                 tags=["instance", *server.tags],
                 zone=server.zone,
                 state=str(server.state),
                 hostname=server.hostname,
-                public_ipv4=[server.public_ip.address] if server.public_ip else [],
-                private_ipv4=[server.private_ip.address] if server.private_ip else [],
-                public_ipv6=[server.ipv6.address] if server.ipv6 else [],
+                public_ipv4=server.public_ip.address if server.public_ip else None,
+                public_ipv6=server.ipv6.address if server.ipv6 else None,
+                vpc_ipv4=vpc4,
+                vpc_ipv6=vpc6,
                 public_dns=f"{server.id}.pub.instances.scw.cloud",
                 private_dns=f"{server.id}.priv.instances.scw.cloud",
             )
@@ -317,22 +332,21 @@ def _get_elastic_metal(self, client: "Client", filters: _Filters) -> List[_Host]
 
         results: List[_Host] = []
         for server in servers:
+            ipv4 = None
+            ipv6 = None
+            for ip in server.ips:
+                if ip.version == BaremetalIPVersion.I_PV4:
+                    ipv4 = ip.address
+                if ip.version == BaremetalIPVersion.I_PV6:
+                    ipv6 = ip.address
             host = _Host(
                 id=server.id,
                 tags=["elastic_metal", *server.tags],
                 zone=server.zone,
                 state=str(server.status),
                 hostname=server.name,
-                public_ipv4=[
-                    ip.address
-                    for ip in server.ips
-                    if ip.version == BaremetalIPVersion.I_PV4
-                ],
-                public_ipv6=[
-                    ip.address
-                    for ip in server.ips
-                    if ip.version == BaremetalIPVersion.I_PV6
-                ],
+                public_ipv4=ipv4,
+                public_ipv6=ipv6,
             )
 
             results.append(host)
@@ -362,9 +376,7 @@ def _get_apple_sillicon(self, client: "Client", filters: _Filters) -> List[_Host
                 zone=server.zone,
                 state=str(server.status),
                 hostname=server.name,
-                public_ipv4=[server.ip],
-                private_ipv4=None,
-                public_ipv6=None,
+                public_ipv4=server.ip,
             )
 
             results.append(host)
@@ -387,15 +399,16 @@ def _get_dedibox(self, client: "Client", filters: _Filters) -> List[_Host]:
 
         results: List[_Host] = []
         for server in servers:
-            public_ipv4 = []
-            public_ipv6 = []
-
+            public_ipv4 = None
+            public_ipv6 = None
             for interface in server.interfaces:
                 for ip in interface.ips:
                     if ip.version == DediboxIPVersion.IPV4:
-                        public_ipv4.append(ip.address)
-                    elif ip.version == DediboxIPVersion.IPV6:
-                        public_ipv6.append(ip.address)
+                        public_ipv4 = ip.address
+                        continue
+                    if ip.version == DediboxIPVersion.IPV6:
+                        public_ipv6 = ip.address
+                        continue
 
             host = _Host(
                 id=server.id,
@@ -404,7 +417,6 @@ def _get_dedibox(self, client: "Client", filters: _Filters) -> List[_Host]:
                 state=str(server.status),
                 hostname=server.name,
                 public_ipv4=public_ipv4,
-                private_ipv4=None,
                 public_ipv6=public_ipv6,
             )
             results.append(host)

plugins/module_utils/instance.py

@@ -0,0 +1,43 @@
+from dataclasses import dataclass
+from typing import Dict, Optional
+
+try:
+    from scaleway import Client
+    from scaleway.instance.v1 import Server as InstanceServer
+    from scaleway.ipam.v1 import IpamV1API
+    from scaleway.vpc.v2 import VpcV2API
+except ImportError:
+    HAS_SCALEWAY_SDK = False
+
+
+@dataclass
+class VpcIps:
+    ipv4: Optional[str] = None
+    ipv6: Optional[str] = None
+
+
+def get_instance_private_ips(
+    client: "Client", servers: list["InstanceServer"]
+) -> Dict[str, VpcIps]:
+    """
+    return a mapping of first found vpc IPs with the instance
+    """
+    vpc_api = VpcV2API(client)
+    ipam_api = IpamV1API(client)
+
+    vpc_ips = {}
+
+    for server in servers:
+        for pnic in server.private_nics:
+            server_pn = vpc_api.get_private_network(
+                private_network_id=pnic.private_network_id
+            )
+            vpc_ips[server.id] = VpcIps
+
+            for ip in ipam_api.list_i_ps(vpc_id=server_pn.vpc_id).ips:
+                if ip.is_ipv6:
+                    vpc_ips[server.id].ipv6 = ip.address.split("/")[0]
+                else:
+                    vpc_ips[server.id].ipv4 = ip.address.split("/")[0]
+
+    return vpc_ips

plugins/module_utils/scaleway.py

@@ -4,6 +4,7 @@
 # SPDX-License-Identifier: GPL-3.0-or-later
 
 from __future__ import absolute_import, division, print_function
+
 import os
 import sys
 from typing import Any, Dict
@@ -45,7 +46,6 @@
 
 try:
     from scaleway import Client
-
     from scaleway_core.profile.env import (
         ENV_KEY_SCW_ACCESS_KEY,
         ENV_KEY_SCW_API_URL,

tests/integration/requirements.txt

@@ -1,2 +1,2 @@
-scaleway>=2.9.0
-pyyaml
+scaleway>=2.10.0
+pyyaml

tests/unit/plugins/conftest.py

@@ -1,15 +1,15 @@
-import tempfile
+import json
 import os
-import yaml
-import pytest
+import tempfile
 import uuid
-import json
+
+import pytest
+import yaml
 from ansible.module_utils import basic
 from ansible.module_utils.common.text.converters import to_bytes
+from scaleway.baremetal.v1.types import IP, IPReverseStatus, IPVersion, Server
 from scaleway_core.profile import Profile
 
-from scaleway.baremetal.v1.types import Server, IP, IPVersion, IPReverseStatus
-
 
 @pytest.fixture()
 def set_module_args(request):
@@ -51,6 +51,7 @@ def create_temporary_scaleway_config() -> Profile:
 def list_bare_metals_fixture():
     return [
         Server(
+            protected=False,
             id="bmc-12345678-1234-1234-1234-123456789012",
             organization_id="org-12345678-1234-1234-1234-123456789012",
             project_id="project-12345678-1234-1234-1234-123456789012",
@@ -89,6 +90,7 @@ def list_bare_metals_fixture():
             ],
         ),
         Server(
+            protected=False,
             id="bmc-12345678-1234-1234-1234-123456789012",
             organization_id="org-12345678-1234-1234-1234-123456789012",
             project_id="project-12345678-1234-1234-1234-123456789012",

tests/unit/plugins/test_inventory.py

@@ -1,9 +1,10 @@
-from ....plugins.inventory import scaleway as scaleway_inventory
-from ....plugins.inventory.scaleway import _Filters
-
 from unittest.mock import patch
-from scaleway.baremetal.v1.api import BaremetalV1API
+
 from scaleway import Client
+from scaleway.baremetal.v1 import BaremetalV1API
+
+from ....plugins.inventory import scaleway as scaleway_inventory
+from ....plugins.inventory.scaleway import _Filters
 
 
 class TestInventory:
@@ -21,14 +22,14 @@ def test_get_elastic_metal(
         mocked_client = Client.from_profile(scaleway_config_profile)
 
         instances = inventory._get_elastic_metal(
-            mocked_client, _Filters(zones=["fr-par"])
+            mocked_client, _Filters(zones=["fr-par-2"])
         )
-        mocked_list_server_all.assert_called_once_with(zone="fr-par", tags=None)
+        mocked_list_server_all.assert_called_once_with(zone="fr-par-2", tags=None)
         assert len(instances) == 2
-        assert instances[0].public_ipv4 == ["1.1.1.1", "192.168.0.1"]
-        assert instances[0].public_ipv6 == []
-        assert instances[1].public_ipv4 == ["1.1.1.1"]
-        assert instances[1].public_ipv6 == ["2001:db8::1"]
+        assert instances[0].public_ipv4 == "192.168.0.1"
+        assert instances[0].public_ipv6 is None
+        assert instances[1].public_ipv4 == "1.1.1.1"
+        assert instances[1].public_ipv6 == "2001:db8::1"
 
     def test_get_host_groups(self):
         inventory = scaleway_inventory.InventoryModule()