Pull in functionality from lookup plugin get_id into tower_api itself

awx_collection/plugins/lookup/tower_api.py

@@ -24,11 +24,41 @@ options:
       - The query parameters to search for in the form of key/value pairs.
     type: dict
     required: False
-  get_all:
+    aliases: [query, data, filter, params]
+  expect_objects:
     description:
-      - If the resulting query is paginated, return all pages.
+      - Error if the response does not contain either a detail view or a list view.
     type: boolean
     default: False
+    aliases: [expect_object]
+  expect_one:
+    description:
+      - Error if the response contains more than one object.
+    type: boolean
+    default: False
+  return_objects:
+    description:
+      - If a list view is returned, promote the list of results to the top-level of list returned.
+      - Allows using this lookup plugin to loop over objects without additional work.
+    type: boolean
+    default: True
+  return_all:
+    description:
+      - If the response is paginated, return all pages.
+    type: boolean
+    default: False
+  return_ids:
+    description:
+      - If response contains objects, promote the id key to the top-level entries in the list.
+      - Allows looking up a related object and passing it as a parameter to another module.
+    type: boolean
+    aliases: [return_id]
+    default: False
+  max_objects:
+    description:
+      - if C(return_all) is true, this is the maximum of number of objects to return from the list.
+    type: integer
+    default: 1000
 
 notes:
   - If the query is not filtered properly this can cause a performance impact.
@@ -88,15 +118,51 @@ class LookupModule(LookupBase):
 
         self.set_options(direct=kwargs)
 
-        if self.get_option('get_all'):
-            return_data = module.get_all_endpoint(terms[0], data=self.get_option('query_params', {} ), none_is_not_fatal=True)
+        response = module.get_endpoint(terms[0], data=self.get_option('query_params', {}))
+
+        if 'status_code' not in response:
+            raise AnsibleError("Unclear response from API: {0}".format(response))
+
+        if response['status_code'] != 200:
+            raise AnsibleError("Failed to query the API: {0}".format(return_data.get('detail', return_data)))
+
+        return_data = response['json']
+
+        if self.get_option('expect_objects') or self.get_option('expect_one'):
+            if ('id' not in return_data) and ('results' not in return_data):
+                raise AnsibleError(
+                    'Did not obtain a list or detail view at {0}, and '
+                    'expect_objects or expect_one is set to True'.format(terms[0])
+                )
+
+        if self.get_option('expect_one'):
+            if 'results' in return_data and len(return_data['results']) != 1:
+                raise AnsibleError(
+                    'Expected one object from endpoint {0}, '
+                    'but obtained {1} from API'.format(terms[0], len(return_data['results']))
+                )
+
+        if self.get_option('return_all') and 'results' in return_data:
+            if return_data['count'] > self.get_option('max_objects'):
+                raise AnsibleError(
+                    'List view at {0} returned {1} objects, which is more than the maximum allowed '
+                    'by max_objects, {2}'.format(terms[0], return_data['count'], self.get_option('max_objects'))
+                )
+
+            next_page = return_data['next']
+            while next_page is not None:
+                next_response = module.get_endpoint(next_page)
+                return_data['results'] += next_response['json']['results']
+                next_page = next_response['json']['next']
+            return_data['next'] = None
+
+        if self.get_option('return_ids'):
+            if 'results' in return_data:
+                return_data['results'] = [item['id'] for item in return_data['results']]
+            elif 'id' in return_data:
+                return_data = return_data['id']
+
+        if self.get_option('return_objects') and 'results' in return_data:
+            return return_data['results']
         else:
-            return_data = module.get_endpoint(terms[0], data=self.get_option('query_params', {} ))
-
-        if return_data['status_code'] != 200:
-            error = return_data
-            if return_data.get('json', {}).get('detail', False):
-                error = return_data['json']['detail']
-            raise AnsibleError("Failed to query the API: {0}".format(error))
-
-        return return_data['json']
+            return [return_data]

awx_collection/plugins/module_utils/tower_api.py

@@ -274,10 +274,7 @@ class TowerModule(AnsibleModule):
     def get_all_endpoint(self, endpoint, *args, **kwargs):
         response = self.get_endpoint(endpoint, *args, **kwargs)
         if 'next' not in response['json']:
-            if not 'none_is_not_fatal' in kwargs or not kwargs['none_is_not_fatal']:
-                raise RuntimeError('Expected list from API at {0}, got: {1}'.format(endpoint, response))
-            else:
-                return response
+            raise RuntimeError('Expected list from API at {0}, got: {1}'.format(endpoint, response))
         next_page = response['json']['next']
 
         if response['json']['count'] > 10000:

awx_collection/tests/integration/targets/tower_lookup_api_plugin/tasks/main.yml

@@ -42,9 +42,9 @@
           - result is failed
           - "'The requested object could not be found at' in result.msg"
 
-    - name: Load user of a specific name
+    - name: Load user of a specific name without promoting objects
       set_fact:
-        users: "{{ query('awx.awx.tower_api', 'users', query_params={ 'username' : user_creation_results['results'][0]['item'] }) }}"
+        users: "{{ lookup('awx.awx.tower_api', 'users', query_params={ 'username' : user_creation_results['results'][0]['item'] }, return_objects=False) }}"
 
     - assert:
         that:
@@ -52,34 +52,66 @@
           - users['count'] == 1
           - users['results'][0]['id'] == user_creation_results['results'][0]['id']
 
-    - name: Get a page of users
-      set_fact:
-        users: "{{ query('awx.awx.tower_api', 'users', query_params={ 'username__endswith': test_id, 'page_size': 2 } ) }}"
+    - name: Loop over one user with the loop syntax
+      assert:
+        that:
+          - item['id'] == user_creation_results['results'][0]['id']
+      loop: "{{ query('awx.awx.tower_api', 'users', query_params={ 'username' : user_creation_results['results'][0]['item'] }) }}"
+      loop_control:
+        label: "{{ item['id'] }}"
 
-    - assert:
-        that: users['results'] | length() == 2
+    - name: Get a page of users as just ids
+      set_fact:
+        users: "{{ query('awx.awx.tower_api', 'users', query_params={ 'username__endswith': test_id, 'page_size': 2 }, return_ids=True ) }}"
+
+    - name: Assert that user list has 2 integer ids only
+      assert:
+        that:
+          - users | length() == 2
+          - user_creation_results['results'][0]['id'] in users
 
     - name: Get all users of a system through next attribute
       set_fact:
-        users: "{{ query('awx.awx.tower_api', 'users', query_params={ 'username__endswith': test_id, 'page_size': 1 }, get_all=true ) }}"
+        users: "{{ query('awx.awx.tower_api', 'users', query_params={ 'username__endswith': test_id, 'page_size': 1 }, return_all=true ) }}"
 
     - assert:
         that:
-          - users['results'] | length() >= 3
+          - users | length() >= 3
+
+    - name: Get the ID of the first user created and verify that it is correct
+      assert:
+        that: "{{ query('awx.awx.tower_api', 'users', query_params={ 'username' : user_creation_results['results'][0]['item'] }, return_ids=True) }}[0] == {{ user_creation_results['results'][0]['id'] }}"
+
+    - name: Try to get an ID of someone who does not exist
+      set_fact:
+        failed_user_id: "{{ query('awx.awx.tower_api', 'users', query_params={ 'username': 'john jacob jingleheimer schmidt' }, expect_one=True) }}"
+      register: result
+      ignore_errors: true
+
+    - assert:
+        that:
+          - result is failed
+          - "'Expected one object from endpoint users' in result['msg']"
+
+    - name: Lookup too many users
+      set_fact:
+        too_many_user_ids: " {{ query('awx.awx.tower_api', 'users', query_params={ 'username__endswith': test_id }, expect_one=True) }}"
+      register: results
+      ignore_errors: true
+
+    - assert:
+        that:
+          - results is failed
+          - "'Expected one object from endpoint users, but obtained 3' in results['msg']"
 
     - name: Get the settings page
-      set_fact:
-        settings: "{{ query('awx.awx.tower_api', 'settings/ui' ) }}"
-      register: results
-
-    - assert:
+      assert:
         that:
-          - results is succeeded
-          - "'CUSTOM_LOGO' in settings"
+          - "'CUSTOM_LOGO' in {{ lookup('awx.awx.tower_api', 'settings/ui' ) }}"
 
     - name: Get the ping page
       set_fact:
-        ping_data: "{{ query('awx.awx.tower_api', 'ping' ) }}"
+        ping_data: "{{ lookup('awx.awx.tower_api', 'ping' ) }}"
       register: results
 
     - assert: