chore: lint python files with Ruff

Author: Sylfwood

.ruff.toml

@@ -0,0 +1 @@
+ignore = ["E402"]

galaxy.yml

@@ -16,4 +16,4 @@ repository: https://github.com/Devolutions/ansible-dvls
 documentation: https://github.com/Devolutions/ansible-dvls
 homepage: https://github.com/Devolutions/ansible-dvls
 issues: https://github.com/Devolutions/ansible-dvls/issues
-build_ignore: [.github, requirements.txt, tests]
+build_ignore: [.github, .ruff.toml, requirements.txt, tests]

plugins/module_utils/auth.py

@@ -1,36 +1,34 @@
 import requests
 import json
 
+
 def login(server_base_url, app_key, app_secret):
     login_url = f"{server_base_url}/api/v1/login"
-    login_data = {
-        "appKey": app_key,
-        "appSecret": app_secret
-    }
-    login_headers = {
-        "Content-Type": "application/json"
-    }
+    login_data = {"appKey": app_key, "appSecret": app_secret}
+    login_headers = {"Content-Type": "application/json"}
 
     try:
-        response = requests.post(login_url, headers=login_headers, data=json.dumps(login_data))
+        response = requests.post(
+            login_url, headers=login_headers, data=json.dumps(login_data)
+        )
         response.raise_for_status()
     except Exception as e:
-        raise Exception(f"Failed to login: Unable to reach the server. Verify your network connection and server URL: {e}")
+        raise Exception(
+            f"Failed to login: Unable to reach the server. Verify your network connection and server URL: {e}"
+        )
 
     auth_response = response.json()
-    token = auth_response.get('tokenId')
+    token = auth_response.get("tokenId")
 
     if not token or token == "null":
         raise Exception("Failed to login or obtain token.")
 
     return token
 
+
 def logout(server_base_url, token):
     logout_url = f"{server_base_url}/api/v1/logout"
-    logout_headers = {
-        "Content-Type": "application/json",
-        "tokenId": token
-    }
+    logout_headers = {"Content-Type": "application/json", "tokenId": token}
 
     requests.post(logout_url, headers=logout_headers)
     return None

plugins/module_utils/server.py

@@ -1,28 +1,28 @@
 import requests
 
+
 def public_instance_information(server_base_url, token):
     url = f"{server_base_url}/api/public-instance-information"
-    headers = {
-        "Content-Type": "application/json",
-        "tokenId": token
-    }
+    headers = {"Content-Type": "application/json", "tokenId": token}
 
     try:
         response = requests.get(url, headers=headers)
         return response.json()
     except Exception as e:
-        raise Exception(f"An error occurred while fetching public instance information: {e}")
+        raise Exception(
+            f"An error occurred while fetching public instance information: {e}"
+        )
+
 
 def private_instance_information(server_base_url, token):
     url = f"{server_base_url}/api/private-instance-information"
-    headers = {
-        "Content-Type": "application/json",
-        "tokenId": token
-    }
+    headers = {"Content-Type": "application/json", "tokenId": token}
 
     try:
         response = requests.get(url, headers=headers)
         response.raise_for_status()
         return response.json()
     except Exception as e:
-        raise Exception(f"An error occurred while fetching private instance information: {e}")
+        raise Exception(
+            f"An error occurred while fetching private instance information: {e}"
+        )

plugins/module_utils/utils.py

@@ -1,10 +1,13 @@
-from ansible_collections.devolutions.dvls.plugins.module_utils.vaults import get_vault_entry
+from ansible_collections.devolutions.dvls.plugins.module_utils.vaults import (
+    get_vault_entry,
+)
+
 
 def get_sensible_value(server_base_url, token, vault_id, entries):
     fetched_secrets = {}
 
-    if isinstance(entries, dict) and 'data' in entries:
-        entries = entries.get('data', [])
+    if isinstance(entries, dict) and "data" in entries:
+        entries = entries.get("data", [])
 
     if not isinstance(entries, list):
         return {"error": f"Expected list of entries, got {type(entries).__name__}"}
@@ -13,14 +16,14 @@ def get_sensible_value(server_base_url, token, vault_id, entries):
         if not isinstance(secret, dict):
             continue
 
-        entry_name = secret.get('name')
-        if not entry_name or 'id' not in secret:
+        entry_name = secret.get("name")
+        if not entry_name or "id" not in secret:
             continue
 
         try:
-            entry = get_vault_entry(server_base_url, token, vault_id, secret['id'])
-            if isinstance(entry, dict) and 'data' in entry:
-                fetched_secrets[entry_name] = entry['data']
+            entry = get_vault_entry(server_base_url, token, vault_id, secret["id"])
+            if isinstance(entry, dict) and "data" in entry:
+                fetched_secrets[entry_name] = entry["data"]
         except Exception as e:
             fetched_secrets[entry_name] = {"error": str(e)}
 

plugins/module_utils/vaults.py

@@ -1,30 +1,26 @@
 import requests
 
+
 def get_vaults(server_base_url, token):
     vaults_url = f"{server_base_url}/api/v1/vault"
-    vaults_headers = {
-        "Content-Type": "application/json",
-        "tokenId": token
-    }
+    vaults_headers = {"Content-Type": "application/json", "tokenId": token}
 
     try:
         response = requests.get(vaults_url, headers=vaults_headers)
         response.raise_for_status()
 
         json_data = response.json()
-        if 'data' not in json_data:
+        if "data" not in json_data:
             raise ValueError(f"'data' key missing in response: {json_data}")
 
-        return json_data.get('data', [])
+        return json_data.get("data", [])
     except Exception as e:
         raise Exception(f"An error occurred while getting vaults: {e}")
 
+
 def get_vault_entry(server_base_url, token, vault_id, entry_id):
     vault_url = f"{server_base_url}/api/v1/vault/{vault_id}/entry/{entry_id}"
-    vault_headers = {
-        "Content-Type": "application/json",
-        "tokenId": token
-    }
+    vault_headers = {"Content-Type": "application/json", "tokenId": token}
 
     try:
         response = requests.get(vault_url, headers=vault_headers)
@@ -34,60 +30,60 @@ def get_vault_entry(server_base_url, token, vault_id, entry_id):
     except Exception as e:
         raise Exception(f"An error occurred while getting a vault entry: {e}")
 
+
 def get_vault_entry_from_name(server_base_url, token, vault_id, entry_name):
     vault_url = f"{server_base_url}/api/v1/vault/{vault_id}/entry"
-    vault_headers = {
-        "Content-Type": "application/json",
-        "tokenId": token
-    }
+    vault_headers = {"Content-Type": "application/json", "tokenId": token}
 
     try:
-        response = requests.get(vault_url, headers=vault_headers, params={'name': entry_name})
+        response = requests.get(
+            vault_url, headers=vault_headers, params={"name": entry_name}
+        )
         response.raise_for_status()
 
         return response.json()
     except Exception as e:
         raise Exception(f"An error occurred while getting a vault entry: {e}")
 
+
 def get_vault_entry_from_tag(server_base_url, token, vault_id, entry_tag):
     vault_url = f"{server_base_url}/api/v1/vault/{vault_id}/entry"
-    vault_headers = {
-        "Content-Type": "application/json",
-        "tokenId": token
-    }
+    vault_headers = {"Content-Type": "application/json", "tokenId": token}
 
     try:
-        response = requests.get(vault_url, headers=vault_headers, params={'tag': entry_tag})
+        response = requests.get(
+            vault_url, headers=vault_headers, params={"tag": entry_tag}
+        )
         response.raise_for_status()
 
         return response.json()
     except Exception as e:
         raise Exception(f"An error occurred while getting a vault entry: {e}")
 
+
 def get_vault_entry_from_path(server_base_url, token, vault_id, entry_path):
     vault_url = f"{server_base_url}/api/v1/vault/{vault_id}/entry"
-    vault_headers = {
-        "Content-Type": "application/json",
-        "tokenId": token
-    }
+    vault_headers = {"Content-Type": "application/json", "tokenId": token}
 
     try:
-        response = requests.get(vault_url, headers=vault_headers, params={'path': entry_path})
+        response = requests.get(
+            vault_url, headers=vault_headers, params={"path": entry_path}
+        )
         response.raise_for_status()
 
         return response.json()
     except Exception as e:
         raise Exception(f"An error occurred while getting a vault entry: {e}")
 
+
 def get_vault_entry_from_type(server_base_url, token, vault_id, entry_type):
     vault_url = f"{server_base_url}/api/v1/vault/{vault_id}/entry"
-    vault_headers = {
-        "Content-Type": "application/json",
-        "tokenId": token
-    }
+    vault_headers = {"Content-Type": "application/json", "tokenId": token}
 
     try:
-        response = requests.get(vault_url, headers=vault_headers, params={'type': entry_type})
+        response = requests.get(
+            vault_url, headers=vault_headers, params={"type": entry_type}
+        )
         response.raise_for_status()
 
         return response.json()
@@ -97,25 +93,23 @@ def get_vault_entry_from_type(server_base_url, token, vault_id, entry_type):
 
 def get_vault_entries(server_base_url, token, vault_id):
     vault_url = f"{server_base_url}/api/v1/vault/{vault_id}/entry"
-    vault_headers = {
-        "Content-Type": "application/json",
-        "tokenId": token
-    }
+    vault_headers = {"Content-Type": "application/json", "tokenId": token}
 
     try:
         response = requests.get(vault_url, headers=vault_headers)
         response.raise_for_status()
 
         json_data = response.json()
-        if 'data' not in json_data:
+        if "data" not in json_data:
             raise ValueError(f"'data' key missing in response: {json_data}")
 
-        return json_data.get('data', [])
+        return json_data.get("data", [])
     except Exception as e:
         raise Exception(f"An error occurred while getting vault entries: {e}")
 
+
 def find_entry_by_name(entries, name):
     for entry in entries:
-        if entry.get('name') == name:
+        if entry.get("name") == name:
             return entry
     return None

plugins/modules/create_secret.py

@@ -1,17 +1,5 @@
 #!/usr/bin/python
 
-from __future__ import absolute_import, division, print_function
-
-__metaclass__ = type
-
-from ansible.module_utils.basic import AnsibleModule
-from ansible_collections.devolutions.dvls.plugins.module_utils.auth import login, logout
-from ansible_collections.devolutions.dvls.plugins.module_utils.vaults import (
-    get_vault_entries,
-    find_entry_by_name,
-)
-import requests
-
 DOCUMENTATION = r"""
 ---
 module: create_secret
@@ -96,6 +84,14 @@
     returned: changed
 """
 
+from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.devolutions.dvls.plugins.module_utils.auth import login, logout
+from ansible_collections.devolutions.dvls.plugins.module_utils.vaults import (
+    get_vault_entries,
+    find_entry_by_name,
+)
+import requests
+
 
 def run_module():
     module_args = dict(

plugins/modules/fetch_secrets.py

@@ -1,24 +1,5 @@
 #!/usr/bin/python
 
-from __future__ import absolute_import, division, print_function
-
-__metaclass__ = type
-
-from ansible.module_utils.basic import AnsibleModule
-from ansible_collections.devolutions.dvls.plugins.module_utils.auth import login, logout
-from ansible_collections.devolutions.dvls.plugins.module_utils.utils import (
-    get_sensible_value,
-)
-from ansible_collections.devolutions.dvls.plugins.module_utils.vaults import (
-    get_vault_entry,
-    get_vault_entry_from_name,
-    get_vault_entry_from_tag,
-    get_vault_entry_from_type,
-    get_vault_entry_from_path,
-    get_vault_entries,
-)
-
-
 DOCUMENTATION = r"""
 ---
 module: fetch_secrets
@@ -86,6 +67,20 @@
     returned: always
 """
 
+from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.devolutions.dvls.plugins.module_utils.auth import login, logout
+from ansible_collections.devolutions.dvls.plugins.module_utils.utils import (
+    get_sensible_value,
+)
+from ansible_collections.devolutions.dvls.plugins.module_utils.vaults import (
+    get_vault_entry,
+    get_vault_entry_from_name,
+    get_vault_entry_from_tag,
+    get_vault_entry_from_type,
+    get_vault_entry_from_path,
+    get_vault_entries,
+)
+
 
 def run_module():
     module_args = dict(

plugins/modules/fetch_server.py

@@ -1,18 +1,5 @@
 #!/usr/bin/python
 
-from __future__ import absolute_import, division, print_function
-
-__metaclass__ = type
-
-from ansible.module_utils.basic import AnsibleModule
-from ansible_collections.devolutions.dvls.plugins.module_utils.auth import login, logout
-from ansible_collections.devolutions.dvls.plugins.module_utils.vaults import get_vaults
-from ansible_collections.devolutions.dvls.plugins.module_utils.server import (
-    public_instance_information,
-    private_instance_information,
-)
-
-
 DOCUMENTATION = r"""
 ---
 module: fetch_server
@@ -57,6 +44,14 @@
     returned: always
 """
 
+from ansible.module_utils.basic import AnsibleModule
+from ansible_collections.devolutions.dvls.plugins.module_utils.auth import login, logout
+from ansible_collections.devolutions.dvls.plugins.module_utils.vaults import get_vaults
+from ansible_collections.devolutions.dvls.plugins.module_utils.server import (
+    public_instance_information,
+    private_instance_information,
+)
+
 
 def run_module():
     module_args = dict(

requirements.txt

@@ -1,2 +1,3 @@
-ansible==11.3.0
+ansible~=11.3
+ansible-lint~=25.1
 requests==2.32.3