Merge pull request #119 from AndrewTwydell/main

Added `fail_on_nodata` attribute to the cmci_get task

Author: Tom-Latham

plugins/module_utils/cmci.py

@@ -418,8 +418,8 @@ def handle_response(self, response_dict):  # type: (Dict) -> None
                     feedback = errors_node[FEEDBACK]
                     self.result[FEEDBACK] = read_error_node(feedback)
 
-            # Non-OK CPSM responses fail the module
-            if cpsm_response_code != 1024:
+            # If CPSM response code not in Valid List, fail the module
+            if self.get_ok_cpsm_response_codes().count(cpsm_response_code) == 0:
                 self._fail(
                     'CMCI request failed with response "{0}" reason "{1}"'
                     .format(
@@ -436,6 +436,9 @@ def handle_response(self, response_dict):  # type: (Dict) -> None
                 'Could not parse CMCI response: missing node "{0}"'
                 .format(e.args[0])
             )
+    
+    def get_ok_cpsm_response_codes(self):
+        return [1024]
 
     def init_url(self):  # type: () -> str
         t = self._p.get(TYPE).lower()

plugins/modules/cmci_get.py

@@ -40,6 +40,15 @@
       - The count value must be an integer; a value of zero is not permitted.
     type: int
     required: false
+  fail_on_nodata:
+    description:
+      - Specifies whether the module should fail if no data is returned by the
+        query. If set to true, the module will fail if no data is returned.
+      - Default behaviour is for the module to fail if no data is returned. When 
+        set to false, the module will return OK, just with no records.
+    type: bool
+    required: false
+    default: true
 '''
 
 
@@ -87,6 +96,23 @@
           value: MYGRP
     record_count: 1
 
+- name: pass module even if bundle definition is not found
+  cmci_get:
+    cmci_host: 'winmvs2c.hursley.ibm.com'
+    cmci_port: 10080
+    cmci_cert: './sec/ansible.pem'
+    cmci_key: './sec/ansible.key'
+    context: 'iyk3z0r9'
+    type: cicsdefinitionbundle
+    resources:
+          filter:
+            name: MYBUNDLE
+          get_parameters:
+            - name: csdgroup
+              value: MYGRP
+        record_count: 1
+        fail_on_nodata: "false"
+
 - name: Using complex_filter to combine filter expressions and change operators
   cmci_get:
     cmci_host: 'winmvs2c.hursley.ibm.com'
@@ -496,6 +522,7 @@
 
 
 _RECORD_COUNT = 'record_count'
+_FAIL_ON_NODATA = 'fail_on_nodata'
 
 
 class AnsibleCMCIGetModule(AnsibleCMCIModule):
@@ -507,6 +534,10 @@ def init_argument_spec(self):  # type: () -> Dict
         argument_spec.update({
             _RECORD_COUNT: {
                 'type': 'int'
+            }, 
+            _FAIL_ON_NODATA: {
+                'type': 'bool',
+                'default': True
             }
         })
         argument_spec.update(RESOURCES_ARGUMENT)
@@ -522,6 +553,14 @@ def init_url(self):  # type: () -> str
             url = url + '//' + str(self._p.get(_RECORD_COUNT))
 
         return url
+    
+    def get_ok_cpsm_response_codes(self):
+        ok_codes = super(AnsibleCMCIGetModule, self).get_ok_cpsm_response_codes()
+
+        if not self._p.get(_FAIL_ON_NODATA):
+            ok_codes.append(1027)
+
+        return ok_codes
 
 
 def main():

tests/integration/targets/cics_cmci/cmci-variables.yml.template

@@ -7,4 +7,7 @@ cmci_secure_port: 28951
 cmci_user: __user__
 cmci_password: __password__
 cmci_context: CICSEX56
-cmci_scope: IYCWEMW2
+cmci_scope_https: IYCWEMW2
+cmci_scope_http: IYCWEMW1
+cmci_scope_region_1: IYCWEML1
+cmci_scope_region_2: IYCWEMM1

tests/integration/targets/cics_cmci/playbooks/cics_cmci_http.yml

@@ -5,11 +5,12 @@
   collections:
    - ibm.ibm_zos_cics
   hosts: 'localhost'
-  gather_facts: 'false'
+  gather_facts: false
   vars:
     csdgroup: 'HTTPTEST'
     program: 'HTTPTEST'
-    http_scope: IYCWEMW1
+    program_2: 'HTTPTES2'
+    program_filter: 'HTTPTES*'
 
   module_defaults:
     ibm.ibm_zos_cics.cmci_get:
@@ -18,7 +19,7 @@
       cmci_user: '{{ cmci_user }}'
       cmci_password: '{{ cmci_password }}'
       context: '{{ cmci_context }}'
-      scope: '{{ http_scope }}'
+      scope: '{{ cmci_scope_http }}'
       insecure: true
       scheme: 'http'
 
@@ -29,7 +30,7 @@
       cmci_user: '{{ cmci_user }}'
       cmci_password: '{{ cmci_password }}'
       context: '{{ cmci_context }}'
-      scope: '{{ http_scope }}'
+      scope: '{{ cmci_scope_http }}'
       insecure: true
       scheme: 'http'
 
@@ -40,7 +41,7 @@
       cmci_user: '{{ cmci_user }}'
       cmci_password: '{{ cmci_password }}'
       context: '{{ cmci_context }}'
-      scope: '{{ http_scope }}'
+      scope: '{{ cmci_scope_http }}'
       insecure: true
       scheme: 'http'
 
@@ -51,7 +52,7 @@
       cmci_user: '{{ cmci_user }}'
       cmci_password: '{{ cmci_password }}'
       context: '{{ cmci_context }}'
-      scope: '{{ http_scope }}'
+      scope: '{{ cmci_scope_http }}'
       insecure: true
       scheme: 'http'
 
@@ -62,7 +63,7 @@
       cmci_user: '{{ cmci_user }}'
       cmci_password: '{{ cmci_password }}'
       context: '{{ cmci_context }}'
-      scope: '{{ http_scope }}'
+      scope: '{{ cmci_scope_http }}'
       insecure: true
       scheme: 'http'
 
@@ -169,9 +170,6 @@
           - result.record_count == 1
           - result.records[0].program == program
 
-    - name: debug 1
-      debug:
-        msg: "{{ result }}"
 
     - name: 'HTTP Disable program'
       delegate_to: 'localhost'
@@ -194,13 +192,8 @@
                   - attribute: 'USECOUNT'
                     operator: 'LT'
                     value: '1'
-
       register: result
 
-    - name: debug 2
-      debug:
-        msg: "{{ result }}"
-
     - name: assert 5
       assert:
         that:
@@ -227,6 +220,68 @@
           - result.cpsm_response == 'OK'
           - result.record_count == 1
           - result.success_count == 1
+    
+
+    - name: 'HTTP Create progdef 2'
+      delegate_to: 'localhost'
+      ibm.ibm_zos_cics.cmci_create:
+        type: 'CICSDefinitionProgram'
+        attributes:
+          name: '{{ program_2 }}'
+          csdgroup: '{{ csdgroup }}'
+        create_parameters:
+          - name: 'CSD'
+      register: result
+
+    - name: assert program_2 created
+      assert:
+        that:
+          - result is changed
+          - result.cpsm_response == 'OK'
+          - result.record_count == 1
+          - result.records[0].name == program_2
+
+    
+    - name: 'HTTP Check All Records Returned'
+      delegate_to: 'localhost'
+      ibm.ibm_zos_cics.cmci_get:
+        type: 'CICSDefinitionProgram'
+        resources:
+          filter:
+            name: '{{ program_filter }}'
+          get_parameters:
+            - name: 'CSDGROUP'
+              value: '{{ csdgroup }}'
+      register: result
+
+    - name: assert record_count is 2
+      assert:
+        that:
+          - result is not changed
+          - result.cpsm_response == 'OK'
+          - result.record_count == 2
+    
+
+    - name: 'HTTP Check record count attribute'
+      delegate_to: 'localhost'
+      ibm.ibm_zos_cics.cmci_get:
+        type: 'CICSDefinitionProgram'
+        record_count: 1
+        resources:
+          filter:
+            name: '{{ program_filter }}'
+          get_parameters:
+            - name: 'CSDGROUP'
+              value: '{{ csdgroup }}'
+      register: result
+    
+    - name: assert record_count attribute
+      assert:
+        that:
+          - result is not changed
+          - result.cpsm_response == 'OK'
+          - result.record_count == 2
+          - result.records|length == 1
 
 
     - name: 'HTTP Delete progdef'
@@ -247,4 +302,76 @@
           - result is changed
           - result.cpsm_response == 'OK'
           - result.record_count == 1
-          - result.success_count == 1
+          - result.success_count == 1
+
+
+    - name: 'HTTP Delete progdef2'
+      delegate_to: 'localhost'
+      ibm.ibm_zos_cics.cmci_delete:
+        type: 'CICSDefinitionProgram'
+        resources:
+          filter:
+            NAME: '{{ program_2 }}'
+          get_parameters:
+            - name: 'CSDGROUP'
+              value: '{{ csdgroup }}'
+      register: result
+    
+    - name: assert program_2 deleted
+      assert:
+        that:
+          - result is changed
+          - result.cpsm_response == 'OK'
+          - result.record_count == 1
+          - result.success_count == 1
+
+
+    - name: 'HTTP fail_on_nodata default'
+      delegate_to: 'localhost'
+      ibm.ibm_zos_cics.cmci_get:
+        type: 'CICSDefinitionProgram'
+        resources:
+          filter:
+            name: '{{ program_filter }}'
+          get_parameters:
+            - name: 'CSDGROUP'
+              value: '{{ csdgroup }}'
+      register: result
+      failed_when: >
+        'cpsm_response_code' not in result or result.cpsm_response_code not in [1024, 1027]
+    
+    - name: assert fail_on_nodata attribute default
+      assert:
+        that:
+          - result is not changed
+          - result.failed == false
+          - result.cpsm_response == 'NODATA'
+          - result.cpsm_response_code == 1027
+          - result.record_count == 0
+          - result.msg is defined
+          - result.failed_when_result is defined
+
+
+    - name: 'HTTP fail_on_nodata'
+      delegate_to: 'localhost'
+      ibm.ibm_zos_cics.cmci_get:
+        type: 'CICSDefinitionProgram'
+        fail_on_nodata: False
+        resources:
+          filter:
+            name: '{{ program_filter }}'
+          get_parameters:
+            - name: 'CSDGROUP'
+              value: '{{ csdgroup }}'
+      register: result
+    
+    - name: assert fail_on_nodata attribute false
+      assert:
+        that:
+          - result is not changed
+          - result.failed == false
+          - result.cpsm_response == 'NODATA'
+          - result.cpsm_response_code == 1027
+          - result.record_count == 0
+          - result.msg is not defined
+          - result.failed_when_result is not defined