fix(get_vault_entries): implement pagination for fetching all vault entries (#22)

Author: DannyBedard

galaxy.yml

@@ -1,9 +1,9 @@
 namespace: devolutions
 name: dvls
-version: 1.2.3
+version: 1.2.4
 readme: README.md
 authors:
-- Danny Bédard <[email protected]>
+  - Danny Bédard <[email protected]>
 description: >
   Ansible collection for interacting with Devolutions Server (DVLS). It provides modules for authentication,
   retrieving server information and vaults, and performing create, read and update operations on secrets.

plugins/module_utils/vaults.py

@@ -103,16 +103,34 @@ 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}
+    all_entries = []
+    page = 1
 
-    try:
-        response = requests.get(vault_url, headers=vault_headers)
-        response.raise_for_status()
+    response = requests
 
-        json_data = response.json()
-        if "data" not in json_data:
-            raise ValueError(f"'data' key missing in response: {json_data}")
-
-        return json_data.get("data", [])
+    try:
+        while True:
+            response = requests.get(
+                vault_url,
+                headers=vault_headers,
+                params={"pageNumber": page},
+            )
+            response.raise_for_status()
+            json_data = response.json()
+            if "data" not in json_data:
+                raise ValueError(f"'data' key missing in response: {json_data}")
+            entries = json_data.get("data", [])
+            if not entries:
+                break
+
+            all_entries.extend(entries)
+
+            if page >= json_data.get("totalPage", 0):
+                break
+
+            page += 1
+
+        return all_entries
     except Exception as e:
         raise Exception(f"An error occurred while getting vault entries: {e}")
 

tests/integration/test_manage_secrets.yml

@@ -12,6 +12,10 @@
         vault_id: "{{ lookup('env', 'DVLS_VAULT_ID') }}"
       register: all_secrets
 
+    - name: Check secrets
+      ansible.builtin.debug:
+        msg: "{{ all_secrets }}"
+
     - name: Check secrets
       ansible.builtin.debug:
         msg: "Number of secret in vault: {{ all_secrets | length }}"