Use /rest/v2

Signed-off-by: Justin Cinkelj <justin.cinkelj@xlab.si>

Author: justinc1

plugins/inventory/hypercore.py

@@ -148,6 +148,7 @@
 from ..module_utils import errors
 from ..module_utils.client import Client
 from ..module_utils.rest_client import RestClient
+from ..module_utils.utils import REST_API_VERSION
 
 logging.basicConfig(level=logging.ERROR)
 logger = logging.getLogger(__name__)
@@ -247,7 +248,7 @@ def parse(self, inventory, loader, path, cache=False):
             )
         client = Client(host, username, password, timeout, auth_method)
         rest_client = RestClient(client)
-        vms = rest_client.list_records("/rest/v1/VirDomain")
+        vms = rest_client.list_records(f"{REST_API_VERSION}/VirDomain")
 
         for vm in vms:
             groups = []

plugins/module_utils/client.py

@@ -31,6 +31,7 @@
 from .errors import AuthError
 from .errors import ScaleComputingError
 from .errors import UnexpectedAPIResponse
+from .utils import REST_API_VERSION
 
 DEFAULT_HEADERS = dict(Accept="application/json")
 
@@ -128,7 +129,7 @@ def _login_username_password(self) -> dict[str, str]:
         use_oidc = self.auth_method == AuthMethod.oidc.value
         resp = self._request(
             "POST",
-            f"{self.host}/rest/v1/login",
+            f"{self.host}{REST_API_VERSION}/login",
             data=json.dumps(
                 dict(
                     username=self.username,
@@ -150,7 +151,7 @@ def _logout(self) -> None:
         }
         self._request(
             "POST",
-            f"{self.host}/rest/v1/logout",
+            f"{self.host}{REST_API_VERSION}/logout",
             # data=json.dumps({}),
             headers=headers,
             timeout=self.timeout,

plugins/module_utils/cluster.py

@@ -18,6 +18,7 @@
 from ..module_utils.typed_classes import TypedClusterToAnsible
 from ..module_utils.typed_classes import TypedTaskTag
 from ..module_utils.utils import PayloadMapper
+from ..module_utils.utils import REST_API_VERSION
 
 
 class Cluster(PayloadMapper):
@@ -65,18 +66,18 @@ def __eq__(self, other: object) -> bool:
 
     @classmethod
     def get(cls, rest_client: RestClient, must_exist: bool = True) -> Cluster:
-        hypercore_dict = rest_client.get_record("/rest/v1/Cluster", must_exist=must_exist)
+        hypercore_dict = rest_client.get_record(f"{REST_API_VERSION}/Cluster", must_exist=must_exist)
         cluster = cls.from_hypercore(hypercore_dict)  # type: ignore # cluster never None
         return cluster
 
     def update_name(self, rest_client: RestClient, name_new: str, check_mode: bool = False) -> TypedTaskTag:
-        return rest_client.update_record(f"/rest/v1/Cluster/{self.uuid}", dict(clusterName=name_new), check_mode)
+        return rest_client.update_record(f"{REST_API_VERSION}/Cluster/{self.uuid}", dict(clusterName=name_new), check_mode)
 
     @staticmethod
     def shutdown(rest_client: RestClient, force_shutdown: bool = False, check_mode: bool = False) -> None:
         try:
             rest_client.create_record(
-                "/rest/v1/Cluster/shutdown",
+                f"{REST_API_VERSION}/Cluster/shutdown",
                 dict(forceShutdown=force_shutdown),
                 check_mode,
             )

plugins/module_utils/disk.py

@@ -17,6 +17,7 @@
 from ..module_utils import errors
 from ..module_utils.rest_client import RestClient
 from ..module_utils.utils import PayloadMapper
+from ..module_utils.utils import REST_API_VERSION
 
 TIERING_PRIORITY_MAPPING_TO_HYPERCORE = {
     0: 0,
@@ -223,5 +224,5 @@ def needs_reboot(self, action: str, desired_disk=None) -> bool:
 
     @classmethod
     def get_by_uuid(cls, uuid: str, rest_client: RestClient, must_exist: bool) -> Optional[Disk]:
-        hypercore_dict = rest_client.get_record(f"/rest/v1/VirDomainBlockDevice/{uuid}", must_exist=must_exist)
+        hypercore_dict = rest_client.get_record(f"{REST_API_VERSION}/VirDomainBlockDevice/{uuid}", must_exist=must_exist)
         return cls.from_hypercore(hypercore_dict)

plugins/module_utils/dns_config.py

@@ -12,6 +12,7 @@
 from ..module_utils import errors
 from ..module_utils.utils import PayloadMapper
 from ..module_utils.utils import get_query
+from ..module_utils.utils import REST_API_VERSION
 
 
 class DNSConfig(PayloadMapper):
@@ -76,7 +77,7 @@ def __eq__(self, other):
     @classmethod
     def get_by_uuid(cls, ansible_dict, rest_client, must_exist=False):
         query = get_query(ansible_dict, "uuid", ansible_hypercore_map=dict(uuid="uuid"))
-        hypercore_dict = rest_client.get_record("/rest/v1/DNSConfig", query, must_exist=must_exist)
+        hypercore_dict = rest_client.get_record(f"{REST_API_VERSION}/DNSConfig", query, must_exist=must_exist)
         dns_config_from_hypercore = DNSConfig.from_hypercore(hypercore_dict)
         return dns_config_from_hypercore
 
@@ -85,7 +86,7 @@ def get_by_uuid(cls, ansible_dict, rest_client, must_exist=False):
     def get_state(cls, rest_client):
         state = [
             DNSConfig.from_hypercore(hypercore_data=hypercore_dict).to_ansible()
-            for hypercore_dict in rest_client.list_records("/rest/v1/DNSConfig/")
+            for hypercore_dict in rest_client.list_records(f"{REST_API_VERSION}/DNSConfig/")
         ]
 
         # Raise an error if there is more than 1 DNS configuration available

plugins/module_utils/email_alert.py

@@ -23,6 +23,7 @@
 # from .client import Client
 from ..module_utils.utils import PayloadMapper
 from ..module_utils.utils import get_query
+from ..module_utils.utils import REST_API_VERSION
 from .rest_client import RestClient
 
 
@@ -105,7 +106,7 @@ def get_by_uuid(
         must_exist: bool = False,
     ) -> Optional[EmailAlert]:
         query = get_query(ansible_dict, "uuid", ansible_hypercore_map=dict(uuid="uuid"))
-        hypercore_dict = rest_client.get_record("/rest/v1/AlertEmailTarget", query, must_exist=must_exist)
+        hypercore_dict = rest_client.get_record(f"{REST_API_VERSION}/AlertEmailTarget", query, must_exist=must_exist)
         alert_email_from_hypercore = cls.from_hypercore(hypercore_dict)
         return alert_email_from_hypercore
 
@@ -121,7 +122,7 @@ def get_by_email(
             "email",
             ansible_hypercore_map=dict(email="emailAddress"),
         )
-        hypercore_dict = rest_client.get_record("/rest/v1/AlertEmailTarget", query, must_exist=must_exist)
+        hypercore_dict = rest_client.get_record(f"{REST_API_VERSION}/AlertEmailTarget", query, must_exist=must_exist)
 
         alert_email_from_hypercore = EmailAlert.from_hypercore(hypercore_dict)
         return alert_email_from_hypercore
@@ -137,7 +138,7 @@ def list_by_email(
             "email",
             ansible_hypercore_map=dict(email="emailAddress"),
         )
-        hypercore_dict_list = rest_client.list_records("/rest/v1/AlertEmailTarget", query)
+        hypercore_dict_list = rest_client.list_records(f"{REST_API_VERSION}/AlertEmailTarget", query)
 
         alert_email_from_hypercore_list = [EmailAlert.from_hypercore(hc_dict) for hc_dict in hypercore_dict_list]
         return alert_email_from_hypercore_list
@@ -149,7 +150,7 @@ def get_state(
     ):
         state = [
             EmailAlert.from_hypercore(hypercore_data=hypercore_dict).to_ansible()
-            for hypercore_dict in rest_client.list_records("/rest/v1/AlertEmailTarget/")
+            for hypercore_dict in rest_client.list_records(f"{REST_API_VERSION}/AlertEmailTarget/")
         ]
 
         return state
@@ -161,7 +162,7 @@ def create(
         payload: Dict[Any, Any],
         check_mode: bool = False,
     ):
-        task_tag = rest_client.create_record("/rest/v1/AlertEmailTarget/", payload, check_mode)
+        task_tag = rest_client.create_record(f"{REST_API_VERSION}/AlertEmailTarget/", payload, check_mode)
         email_alert = cls.get_by_uuid(
             dict(uuid=task_tag["createdUUID"]),
             rest_client,
@@ -175,18 +176,18 @@ def update(
         payload: Dict[Any, Any],
         check_mode: bool = False,
     ) -> None:
-        rest_client.update_record(f"/rest/v1/AlertEmailTarget/{self.uuid}", payload, check_mode)
+        rest_client.update_record(f"{REST_API_VERSION}/AlertEmailTarget/{self.uuid}", payload, check_mode)
 
     def delete(
         self,
         rest_client: RestClient,
         check_mode: bool = False,
     ) -> None:
-        rest_client.delete_record(f"/rest/v1/AlertEmailTarget/{self.uuid}", check_mode)
+        rest_client.delete_record(f"{REST_API_VERSION}/AlertEmailTarget/{self.uuid}", check_mode)
 
     def test(
         self,
         rest_client: RestClient,
     ) -> TypedTaskTag:
-        response = rest_client.client.post(f"/rest/v1/AlertEmailTarget/{self.uuid}/test", None)
+        response = rest_client.client.post(f"{REST_API_VERSION}/AlertEmailTarget/{self.uuid}/test", None)
         return response

plugins/module_utils/hypercore_version.py

@@ -24,6 +24,7 @@
 from ..module_utils.typed_classes import TypedUpdateStatusToAnsible
 from ..module_utils.typed_classes import TypedUpdateToAnsible
 from ..module_utils.utils import PayloadMapper
+from ..module_utils.utils import REST_API_VERSION
 
 
 class HyperCoreVersion:
@@ -41,7 +42,7 @@ def __init__(self, rest_client: RestClient):
     @property
     def version(self) -> str:
         if not self._version:
-            record = self._rest_client.get_record("/rest/v1/Cluster")
+            record = self._rest_client.get_record(f"{REST_API_VERSION}/Cluster")
             if record is None or "icosVersion" not in record or not isinstance(record["icosVersion"], str):
                 raise AssertionError("HyperCore version not found in REST API response.")
             self._version = record["icosVersion"]
@@ -235,7 +236,7 @@ def get(
     ) -> Optional[Update]:
         # api has a bug - the endpoint "/rest/v1/Update/{uuid}" returns a list of all available updates (and uuid can actually be anything),
         # that is why query is used
-        update = rest_client.get_record(f"/rest/v1/Update/{uuid}", query=dict(uuid=uuid), must_exist=must_exist)
+        update = rest_client.get_record(f"{REST_API_VERSION}/Update/{uuid}", query=dict(uuid=uuid), must_exist=must_exist)
         return cls.from_hypercore(update)
 
     @classmethod
@@ -245,7 +246,7 @@ def apply_update(
         version: str,
         check_mode: bool = False,
     ) -> TypedTaskTag:
-        return rest_client.create_record(f"/rest/v1/Update/{version}/apply", payload=None, check_mode=check_mode)
+        return rest_client.create_record(f"{REST_API_VERSION}/Update/{version}/apply", payload=None, check_mode=check_mode)
 
 
 class UpdateStatus(PayloadMapper):

plugins/module_utils/iso.py

@@ -12,6 +12,7 @@
 
 from ..module_utils.utils import PayloadMapper
 from ..module_utils.utils import get_query
+from ..module_utils.utils import REST_API_VERSION
 
 
 class ISO(PayloadMapper):
@@ -99,7 +100,7 @@ def get_by_name(cls, ansible_dict, rest_client, must_exist=False):
         the record exists. If there is no record with such name, None is returned.
         """
         query = get_query(ansible_dict, "name", ansible_hypercore_map=dict(name="name"))
-        hypercore_dict = rest_client.get_record("/rest/v1/ISO", query, must_exist=must_exist)
+        hypercore_dict = rest_client.get_record(f"{REST_API_VERSION}/ISO", query, must_exist=must_exist)
         iso_from_hypercore = ISO.from_hypercore(hypercore_dict)
         return iso_from_hypercore
 

plugins/module_utils/node.py

@@ -11,6 +11,7 @@
 __metaclass__ = type
 
 from ..module_utils.utils import PayloadMapper
+from ..module_utils.utils import REST_API_VERSION
 
 
 class Node(PayloadMapper):
@@ -63,6 +64,6 @@ def __eq__(self, other):
 
     @classmethod
     def get_node(cls, query, rest_client, must_exist=False):
-        hypercore_dict = rest_client.get_record("/rest/v1/Node", query, must_exist=must_exist)
+        hypercore_dict = rest_client.get_record(f"{REST_API_VERSION}/Node", query, must_exist=must_exist)
         node_from_hypercore = cls.from_hypercore(hypercore_dict)
         return node_from_hypercore

plugins/module_utils/oidc.py

@@ -20,6 +20,7 @@
 from ..module_utils.typed_classes import TypedOidcToAnsible
 from ..module_utils.typed_classes import TypedTaskTag
 from ..module_utils.utils import PayloadMapper
+from ..module_utils.utils import REST_API_VERSION
 
 
 class Oidc(PayloadMapper):
@@ -41,7 +42,7 @@ def __init__(
 
     @classmethod
     def get(cls, rest_client: RestClient) -> Optional[Oidc]:
-        result = rest_client.list_records("/rest/v1/OIDCConfig")
+        result = rest_client.list_records(f"{REST_API_VERSION}/OIDCConfig")
         if result:
             # One OIDC per cluster.
             return cls.from_hypercore(result[0])
@@ -93,8 +94,8 @@ def to_ansible(self) -> TypedOidcToAnsible:
 
     def send_create_request(self, rest_client: RestClient) -> TypedTaskTag:
         payload = self.to_hypercore()
-        return rest_client.create_record("/rest/v1/OIDCConfig", payload, False)
+        return rest_client.create_record(f"{REST_API_VERSION}/OIDCConfig", payload, False)
 
     def send_update_request(self, rest_client: RestClient) -> TypedTaskTag:
         payload = self.to_hypercore()
-        return rest_client.update_record("/rest/v1/OIDCConfig/oidcconfig_uuid", payload, False)
+        return rest_client.update_record(f"{REST_API_VERSION}/OIDCConfig/oidcconfig_uuid", payload, False)