Merge pull request #29 from koef/add-labels-support

Add labels support

Author: koef

.github/workflows/tests.yaml

@@ -159,14 +159,14 @@ jobs:
           sync
 
   integration_tests_lb_instances:
-    runs-on: ubuntu-20.04
-    needs: integration_tests_l2
+    runs-on: ubuntu-24.04
+    needs: integration_tests_bm
     concurrency: API
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Set up Python
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v5
         with:
           python-version: "3.13"
       - name: Install dependencies
@@ -195,7 +195,9 @@ jobs:
 
   build:
     runs-on: ubuntu-24.04
-    needs: integration_tests_l2
+    needs:
+      - integration_tests_l2
+      - integration_tests_lb_instances
     outputs:
       version: ${{ steps.version.outputs.version }}
     steps:

ansible_collections/serverscom/sc_api/plugins/module_utils/modules.py

@@ -69,11 +69,19 @@ def run(self):
 
 
 class ScBaremetalServersInfo:
-    def __init__(self, endpoint, token):
+    def __init__(self, search_pattern, label_selector, type, endpoint, token):
+        self.type = type
+        self.search_pattern = search_pattern
+        self.label_selector = label_selector
         self.api = ScApi(token, endpoint)
 
     def run(self):
-        return {"changed": False, "baremetal_servers": list(self.api.list_hosts())}
+        return {
+            "changed": False,
+            "baremetal_servers": list(
+                self.api.list_hosts(self.type, self.search_pattern, self.label_selector)
+            ),
+        }
 
 
 class ScBaremetalLocationsInfo(object):
@@ -150,7 +158,16 @@ def run(self):
 
 class ScSshKey(object):
     def __init__(
-        self, endpoint, token, state, name, fingerprint, public_key, replace, checkmode
+        self,
+        endpoint,
+        token,
+        state,
+        name,
+        fingerprint,
+        public_key,
+        labels,
+        replace,
+        checkmode,
     ):
         self.partial_match = []
         self.full_match = []
@@ -162,6 +179,7 @@ def __init__(
         self.key_name = name
         self.public_key = public_key
         self.fingerprint = fingerprint
+        self.labels = labels
         if public_key:
             self.fingerprint = self.extract_fingerprint(public_key)
             if fingerprint and self.fingerprint != fingerprint:
@@ -205,7 +223,7 @@ def classify_matching_keys(key_list, name, fingerprint):
     def add_key(self):
         if not self.checkmode:
             return self.api.post_ssh_keys(
-                name=self.key_name, public_key=self.public_key
+                name=self.key_name, public_key=self.public_key, labels=self.labels
             )
 
     def delete_keys(self, key_list):
@@ -252,11 +270,15 @@ def run(self):
 
 
 class ScSshKeysInfo:
-    def __init__(self, endpoint, token):
+    def __init__(self, endpoint, token, label_selector):
         self.api = ScApi(token, endpoint)
+        self.label_selector = label_selector
 
     def run(self):
-        return {"changed": False, "ssh_keys": list(self.api.list_ssh_keys())}
+        return {
+            "changed": False,
+            "ssh_keys": list(self.api.list_ssh_keys(self.label_selector)),
+        }
 
 
 class ScDedicatedServerReinstall(object):
@@ -412,14 +434,17 @@ def run(self):
 
 
 class ScCloudComputingInstancesInfo:
-    def __init__(self, endpoint, token, region_id):
+    def __init__(self, endpoint, token, region_id, label_selector):
         self.api = ScApi(token, endpoint)
         self.region_id = region_id
+        self.label_selector = label_selector
 
     def run(self):
         return {
             "changed": False,
-            "cloud_instances": list(self.api.list_instances(self.region_id)),
+            "cloud_instances": list(
+                self.api.list_instances(self.region_id, self.label_selector)
+            ),
         }
 
 
@@ -465,6 +490,7 @@ def __init__(
         ssh_key_name,
         backup_copies,
         user_data,
+        labels,
         wait,
         update_interval,
         checkmode,
@@ -490,6 +516,7 @@ def __init__(
         )
         self.backup_copies = backup_copies
         self.user_data = user_data
+        self.labels = labels
         self.wait = wait
         self.update_interval = update_interval
         self.checkmode = checkmode
@@ -527,6 +554,7 @@ def create_instance(self):
             ssh_key_fingerprint=self.ssh_key_fingerprint,
             backup_copies=self.backup_copies,
             user_data=self.user_data,
+            labels=self.labels,
         )
         return instance
 
@@ -981,11 +1009,15 @@ def run(self):
 
 
 class ScL2SegmentsInfo:
-    def __init__(self, endpoint, token):
+    def __init__(self, endpoint, token, label_selector):
         self.api = ScApi(token, endpoint)
+        self.label_selector = label_selector
 
     def run(self):
-        return {"changed": False, "l2_segments": list(self.api.list_l2_segments())}
+        return {
+            "changed": False,
+            "l2_segments": list(self.api.list_l2_segments(self.label_selector)),
+        }
 
 
 class ScL2SegmentInfo:
@@ -1027,6 +1059,7 @@ def __init__(
         members_present,
         members_absent,
         location_group_id,
+        labels,
         wait,
         update_interval,
         checkmode,
@@ -1040,6 +1073,7 @@ def __init__(
         self.members_present = members_present
         self.members_absent = members_absent
         self.location_group_id = location_group_id
+        self.labels = labels
         self.wait = wait
         self.update_interval = update_interval
         self.checkmode = checkmode
@@ -1134,7 +1168,7 @@ def create(self):
             raise ModuleError("Creation of L2 segment required type")
         if self.checkmode:
             return {"changed": True, "location_group_id": lg}
-        res = self.api.post_l2_segment(self.name, self.type, lg, members)
+        res = self.api.post_l2_segment(self.name, self.type, lg, members, self.labels)
         self.wait_for_active_segment(res["id"])
         res = self.api.get_l2_segment(res["id"])
         res["members_added"] = members
@@ -1175,9 +1209,9 @@ def update_full(self, segment_id):
             changed = True
             if not self.checkmode:
                 if keep_members != existing_members:
-                    self.api.put_l2_segment_update(segment_id, keep_list)
+                    self.api.put_l2_segment_update(segment_id, keep_list, self.labels)
                     self.wait_for_active_segment(segment_id)
-                self.api.put_l2_segment_update(segment_id, self.members)
+                self.api.put_l2_segment_update(segment_id, self.members, self.labels)
                 self.wait_for_active_segment(segment_id)
         res = self.api.get_l2_segment(segment_id)
         res["members_added"] = list(add_list)
@@ -1234,9 +1268,11 @@ def update_partial(self, segment_id):
                 # If member is already with one type and is in members_present with
                 # different type we need to remove it first (API requirement)
                 if del_list and add_list:
-                    self.api.put_l2_segment_update(segment_id, reduced_list)
+                    self.api.put_l2_segment_update(
+                        segment_id, reduced_list, self.labels
+                    )
                     self.wait_for_active_segment(segment_id)
-                self.api.put_l2_segment_update(segment_id, send_list)
+                self.api.put_l2_segment_update(segment_id, send_list, self.labels)
                 self.wait_for_active_segment(segment_id)
         res = self.api.get_l2_segment(segment_id)
         res["members_added"] = list(add_list)
@@ -1398,13 +1434,14 @@ def run(self):
 
 
 class ScLoadBalancerInstancesList:
-    def __init__(self, endpoint, token, name=None, type=None):
+    def __init__(self, endpoint, token, name=None, type=None, label_selector=None):
         self.api = ScApi(token, endpoint)
         self.name = name
         self.type = type
+        self.label_selector = label_selector
 
     def run(self):
-        lb_instances = list(self.api.list_load_balancer_instances())
+        lb_instances = list(self.api.list_load_balancer_instances(self.label_selector))
         if self.name:
             lb_instances = [
                 inst for inst in lb_instances if inst.get("name") == self.name

ansible_collections/serverscom/sc_api/plugins/module_utils/sc_api.py

@@ -321,8 +321,18 @@ def get_dedicated_servers(self, server_id):
             path=f"/hosts/dedicated_servers/{server_id}"
         )
 
-    def list_hosts(self):
-        return self.api_helper.make_multipage_request(path="/hosts")
+    def list_hosts(self, type=None, search_pattern=None, label_selector=None):
+        query = {}
+        if type:
+            query["type"] = type
+        if search_pattern:
+            query["search_pattern"] = search_pattern
+        if label_selector:
+            query["label_selector"] = label_selector
+
+        return self.api_helper.make_multipage_request(
+            path="/hosts", query_parameters=query
+        )
 
     def post_dedicated_server_reinstall(
         self,
@@ -348,14 +358,26 @@ def post_dedicated_server_reinstall(
             good_codes=[202],
         )
 
-    def list_ssh_keys(self):
-        return self.api_helper.make_multipage_request("/ssh_keys")
+    def list_ssh_keys(self, label_selector=None):
+        query = {}
+        if label_selector:
+            query["label_selector"] = label_selector
+        return self.api_helper.make_multipage_request(
+            "/ssh_keys", query_parameters=query
+        )
 
-    def post_ssh_keys(self, name, public_key):
+    def post_ssh_keys(self, name, public_key, labels=None):
+        body = {
+            "name": name,
+            "public_key": public_key,
+        }
+        if labels:
+            body["labels"] = labels
         return self.api_helper.make_post_request(
             path="/ssh_keys",
-            body=None,
-            query_parameters={"name": name, "public_key": public_key},
+            body=body,
+            query_parameters=None,
+            # query_parameters={"name": name, "public_key": public_key},
             good_codes=[201],
         )
 
@@ -387,12 +409,15 @@ def list_images(self, region_id):
             path=f"/cloud_computing/regions/{region_id}/images"
         )
 
-    def list_instances(self, region_id=None):
-        region_query = {}
-        if region_id is not None:
-            region_query["region_id"] = region_id
+    def list_instances(self, region_id=None, label_selector=None):
+        query = {}
+        if region_id:
+            query["region_id"] = region_id
+        if label_selector:
+            query["label_selector"] = label_selector
+
         return self.api_helper.make_multipage_request(
-            path="/cloud_computing/instances", query_parameters=region_query
+            path="/cloud_computing/instances", query_parameters=query
         )
 
     def post_instances_reinstall(self, instance_id, image_id):
@@ -415,6 +440,7 @@ def post_instance(
         ssh_key_fingerprint,
         backup_copies,
         user_data,
+        labels,
     ):
         body = {
             "region_id": region_id,
@@ -434,6 +460,8 @@ def post_instance(
             body["backup_copies"] = backup_copies
         if user_data:
             body["user_data"] = user_data
+        if labels:
+            body["labels"] = labels
         return self.api_helper.make_post_request(
             path="/cloud_computing/instances",
             body=body,
@@ -538,8 +566,13 @@ def post_instances_revert_upgrade(self, instance_id):
             good_codes=[201],
         )
 
-    def list_l2_segments(self):
-        return self.api_helper.make_multipage_request(path="/l2_segments")
+    def list_l2_segments(self, label_selector=None):
+        query = {}
+        if label_selector:
+            query["label_selector"] = label_selector
+        return self.api_helper.make_multipage_request(
+            path="/l2_segments", query_parameters=query
+        )
 
     def list_l2_location_groups(self):
         return self.api_helper.make_multipage_request(
@@ -585,22 +618,28 @@ def delete_l2_segment(self, l2_segment_id):
             good_codes=[202, 204],
         )
 
-    def post_l2_segment(self, name, type, location_group_id, members):
+    def post_l2_segment(self, name, type, location_group_id, members, labels=None):
         body = {
             "name": name,
             "members": members,
             "type": type,
             "location_group_id": location_group_id,
         }
+        if labels:
+            body["labels"] = labels
+
         return self.api_helper.make_post_request(
             path="/l2_segments/",
             body=body,
             query_parameters=None,
             good_codes=[200, 202],
         )
 
-    def put_l2_segment_update(self, l2_segment_id, members):
+    def put_l2_segment_update(self, l2_segment_id, members, labels=None):
         body = {"members": members}
+        if labels:
+            body["labels"] = labels
+
         response = self.api_helper.make_put_request(
             path=f"/l2_segments/{l2_segment_id}",
             body=body,
@@ -609,8 +648,13 @@ def put_l2_segment_update(self, l2_segment_id, members):
         )[1]
         return response
 
-    def list_load_balancer_instances(self):
-        return self.api_helper.make_multipage_request(path="/load_balancers")
+    def list_load_balancer_instances(self, label_selector=None):
+        query = {}
+        if label_selector:
+            query["label_selector"] = label_selector
+        return self.api_helper.make_multipage_request(
+            path="/load_balancers", query_parameters=query
+        )
 
     def get_lb_instance(self, instance_id, lb_instance_type):
         return self.api_helper.make_get_request(