Logout when module finishes

Signed-off-by: Justin Cinkelj <[email protected]>

Author: justinc1

plugins/module_utils/client.py

@@ -12,6 +12,7 @@
 import os
 import ssl
 from typing import Any, Optional, Union
+from types import TracebackType
 from io import BufferedReader
 import enum
 
@@ -142,6 +143,33 @@ def _login_username_password(self) -> dict[str, str]:
         )
         return dict(Cookie=f"sessionID={resp.json['sessionID']}")
 
+    def _logout(self) -> None:
+        if not self._auth_header:
+            return
+        headers = {
+            "Accept": "application/json",
+            "Content-type": "application/json",
+        }
+        self._request(
+            "POST",
+            f"{self.host}/rest/v1/logout",
+            # data=json.dumps({}),
+            headers=headers,
+            timeout=self.timeout,
+        )
+        self._auth_header = None
+
+    def __enter__(self) -> Client:
+        return self
+
+    def __exit__(
+        self,
+        exc_type: type[BaseException] | None,
+        exc_value: BaseException | None,
+        exc_traceback: TracebackType | None,
+    ) -> None:
+        self._logout()
+
     def _request(
         self,
         method: str,

plugins/modules/api.py

@@ -329,10 +329,10 @@ def main():
     )
 
     try:
-        client = Client.get_client(module.params["cluster_instance"])
-        rest_client = RestClient(client)
-        changed, record = run(module, rest_client)
-        module.exit_json(changed=changed, record=record)
+        with Client.get_client(module.params["cluster_instance"]) as client:
+            rest_client = RestClient(client)
+            changed, record = run(module, rest_client)
+            module.exit_json(changed=changed, record=record)
     except errors.ScaleComputingError as e:
         module.fail_json(msg=str(e))
 

plugins/modules/certificate.py

@@ -158,10 +158,10 @@ def main() -> None:
     )
 
     try:
-        client = Client.get_client(module.params["cluster_instance"])
-        rest_client = RestClient(client=client)
-        changed, record, diff = run(module, rest_client)
-        module.exit_json(changed=changed, record=record, diff=diff)
+        with Client.get_client(module.params["cluster_instance"]) as client:
+            rest_client = RestClient(client=client)
+            changed, record, diff = run(module, rest_client)
+            module.exit_json(changed=changed, record=record, diff=diff)
     except errors.ScaleComputingError as e:
         module.fail_json(msg=str(e))
 

plugins/modules/cluster_info.py

@@ -76,10 +76,10 @@ def main() -> None:
     )
 
     try:
-        client = Client.get_client(module.params["cluster_instance"])
-        rest_client = RestClient(client)
-        record = run(rest_client)
-        module.exit_json(changed=False, record=record)
+        with Client.get_client(module.params["cluster_instance"]) as client:
+            rest_client = RestClient(client)
+            record = run(rest_client)
+            module.exit_json(changed=False, record=record)
 
     except errors.ScaleComputingError as e:
         module.fail_json(msg=str(e))

plugins/modules/cluster_name.py

@@ -109,12 +109,12 @@ def main() -> None:
     )
 
     try:
-        client = Client.get_client(module.params["cluster_instance"])
-        rest_client = RestClient(client)
-        hcversion = HyperCoreVersion(rest_client)
-        hcversion.check_version(module, HYPERCORE_VERSION_REQUIREMENTS)
-        changed, record, diff = run(module, rest_client)
-        module.exit_json(changed=changed, record=record, diff=diff)
+        with Client.get_client(module.params["cluster_instance"]) as client:
+            rest_client = RestClient(client)
+            hcversion = HyperCoreVersion(rest_client)
+            hcversion.check_version(module, HYPERCORE_VERSION_REQUIREMENTS)
+            changed, record, diff = run(module, rest_client)
+            module.exit_json(changed=changed, record=record, diff=diff)
     except errors.ScaleComputingError as e:
         module.fail_json(msg=str(e))
 

plugins/modules/cluster_shutdown.py

@@ -72,10 +72,10 @@ def main() -> None:
     )
 
     try:
-        client = Client.get_client(module.params["cluster_instance"])
-        rest_client = RestClient(client)
-        shutdown = run(module, rest_client)
-        module.exit_json(changed=True, shutdown=shutdown)
+        with Client.get_client(module.params["cluster_instance"]) as client:
+            rest_client = RestClient(client)
+            shutdown = run(module, rest_client)
+            module.exit_json(changed=True, shutdown=shutdown)
     except errors.ScaleComputingError as e:
         module.fail_json(msg=str(e))
 

plugins/modules/dns_config.py

@@ -276,10 +276,10 @@ def main() -> None:
     )
 
     try:
-        client = Client.get_client(module.params["cluster_instance"])
-        rest_client = RestClient(client)
-        changed, new_state, diff = run(module, rest_client)
-        module.exit_json(changed=changed, new_state=new_state, diff=diff)
+        with Client.get_client(module.params["cluster_instance"]) as client:
+            rest_client = RestClient(client)
+            changed, new_state, diff = run(module, rest_client)
+            module.exit_json(changed=changed, new_state=new_state, diff=diff)
     except errors.ScaleComputingError as e:
         module.fail_json(msg=str(e))
 

plugins/modules/dns_config_info.py

@@ -97,10 +97,10 @@ def main():
     )
 
     try:
-        client = Client.get_client(module.params["cluster_instance"])
-        rest_client = RestClient(client)
-        record = run(rest_client)
-        module.exit_json(changed=False, record=record)
+        with Client.get_client(module.params["cluster_instance"]) as client:
+            rest_client = RestClient(client)
+            record = run(rest_client)
+            module.exit_json(changed=False, record=record)
     except errors.ScaleComputingError as e:
         module.fail_json(msg=str(e))
 

plugins/modules/email_alert.py

@@ -291,11 +291,11 @@ def main() -> None:
     )
 
     try:
-        client = Client.get_client(module.params["cluster_instance"])
-        rest_client = RestClient(client)
-        validate_params(module)
-        changed, record, diff = run(module, rest_client)
-        module.exit_json(changed=changed, record=record, diff=diff)
+        with Client.get_client(module.params["cluster_instance"]) as client:
+            rest_client = RestClient(client)
+            validate_params(module)
+            changed, record, diff = run(module, rest_client)
+            module.exit_json(changed=changed, record=record, diff=diff)
     except errors.ScaleComputingError as e:
         module.fail_json(msg=str(e))
 

plugins/modules/email_alert_info.py

@@ -104,10 +104,10 @@ def main() -> None:
     )
 
     try:
-        client = Client.get_client(module.params["cluster_instance"])
-        rest_client = RestClient(client)
-        records = run(rest_client)
-        module.exit_json(changed=False, records=records)
+        with Client.get_client(module.params["cluster_instance"]) as client:
+            rest_client = RestClient(client)
+            records = run(rest_client)
+            module.exit_json(changed=False, records=records)
     except errors.ScaleComputingError as e:
         module.fail_json(msg=str(e))