Merge pull request #114 from ansible-collections/dfsdfmember_input

Dfsdfmember input

Author: ddgandhi

plugins/module_utils/catalog.py

@@ -162,12 +162,18 @@ def _constructPurgeDDStatements(self):
                 self.result['rc'] = 1
                 self.module.fail_json(**self.result)
         else:
-            if self.parsed_args.get("buffer_pool_param_dataset") is None:
-                self.result['msg'] = "You must specify a buffer pool parameter dataset when running as DLI."
-                self.result['rc'] = 1
-                self.module.fail_json(**self.result)
-            else:
-                self.paramString = "DLI,DFS3PU10,DFSCP001,,,,,,,,,,,{0},{1},{2},,,,,,,,,,,'DFSDF=CAT'".format(dbrc, irlm_flag, irlm_id)
+            if self.parsed_args.get("buffer_pool_param_dataset") is not None and self.parsed_args.get("dfsdf_member") is not None:
+                dfsdf_member = self.parsed_args.get("dfsdf_member")
+                self.paramString = "DLI,DFS3PU10,DFSCP001,,,,,,,,,,,{0},{1},{2},,,,,,,,,,,'DFSDF={3}'".format(dbrc, irlm_flag, irlm_id, dfsdf_member)
+            else: 
+                if self.parsed_args.get("buffer_pool_param_dataset") is None:
+                    self.result['msg'] = "You must specify a buffer pool parameter dataset when running as DLI."
+                    self.result['rc'] = 1
+                    self.module.fail_json(**self.result)
+                if self.parsed_args.get("dfsdf_member") is None: 
+                    self.result['msg'] = "You must specify the suffix for the DFSDFxxx member when running as DLI."
+                    self.result['rc'] = 1
+                    self.module.fail_json(**self.result) 
 
         self.dDStatements = self.dDStatements + dDStatementList
 
@@ -315,13 +321,19 @@ def _constructCatalogDDStatements(self):
                 self.result['msg'] = "You must specify an ims_id when running in a BMP region (online_batch=true)"
                 self.result['rc'] = 1
                 self.module.fail_json(**self.result)
-        else:
-            if self.parsed_args.get("buffer_pool_param_dataset") is None:
-                self.result['msg'] = "You must specify a buffer pool parameter dataset when running as DLI."
-                self.result['rc'] = 1
-                self.module.fail_json(**self.result)
-            else:
-                self.paramString = "DLI,DFS3PU00,{0},,,,,,,,,,,{1},{2},{3},,,,,,,,,,,'DFSDF=CAT'".format(mode, dbrc, irlm_flag, irlm_id)
+        else: 
+            if self.parsed_args.get("buffer_pool_param_dataset") is not None and self.parsed_args.get("dfsdf_member") is not None:
+                dfsdf_member = self.parsed_args.get("dfsdf_member")
+                self.paramString = "DLI,DFS3PU00,{0},,,,,,,,,,,{1},{2},{3},,,,,,,,,,,'DFSDF={4}'".format(mode, dbrc, irlm_flag, irlm_id, dfsdf_member)
+            else: 
+                if self.parsed_args.get("buffer_pool_param_dataset") is None:
+                    self.result['msg'] = "You must specify a buffer pool parameter dataset when running as DLI."
+                    self.result['rc'] = 1
+                    self.module.fail_json(**self.result)
+                if self.parsed_args.get("dfsdf_member") is None: 
+                    self.result['msg'] = "You must specify the suffix for the DFSDFxxx member when running as DLI."
+                    self.result['rc'] = 1
+                    self.module.fail_json(**self.result)         
 
         self.dDStatements = self.dDStatements + dDStatementList
 

plugins/module_utils/catalog_parser.py

@@ -1,6 +1,7 @@
 from __future__ import (absolute_import, division, print_function)
 from ansible.module_utils.basic import AnsibleModule
 from ansible_collections.ibm.ibm_zos_core.plugins.module_utils.better_arg_parser import BetterArgParser   # pylint: disable=import-error
+from zoautil_py import datasets
 
 __metaclass__ = type
 
@@ -20,6 +21,7 @@ def _validate_common_input(self):
                 irlm_id=dict(arg_type="str", required=False),
                 reslib=dict(arg_type="list", elements="data_set", required=False),
                 buffer_pool_param_dataset=dict(arg_type="data_set", required=False),
+                dfsdf_member=dict(arg_type="str", required=False),
                 primary_log_dataset=dict(arg_type="dict", required=False,
                                          options=dict(
                                              dataset_name=dict(arg_type="data_set", required=True),
@@ -53,6 +55,11 @@ def _validate_common_input(self):
             parser = BetterArgParser(module_defs)
             self.parsed_args = parser.parse_args(self.params)
 
+            if self.parsed_args.get("dfsdf_member") is not None: 
+                self._validate_length("dfsdf_member", 3)
+                self._validate_alphanumeric("dfsdf_member")
+                self._validate_member_exist("dfsdf_member", self.parsed_args.get("proclib"))
+
         except ValueError as error:
             self.result['msg'] = error.args
             self.result['rc'] = 1
@@ -297,6 +304,27 @@ def validate_purge_input(self):
 
         return self.parsed_args
 
+    def _validate_length(self, input, length): 
+        if len(self.parsed_args.get(input)) != length: 
+            self.result['msg'] = str(self.parsed_args.get(input)) + " is not equal to length " + str(length)
+            self.result['rc'] = 1
+            self.module.fail_json(**self.result)
+            
+    def _validate_alphanumeric(self, input):
+        if not (self.parsed_args.get(input)).isalnum(): 
+            self.result['msg'] = str(input) + " input cannot contain special characters, it must be alphanumeric"
+            self.result['rc'] = 1
+            self.module.fail_json(**self.result)
+    
+    def _validate_member_exist(self, input, proc): 
+        member = self.parsed_args.get(input)
+        member = "DFSDF" + member
+        rc = datasets.find_member(member, proc[0])
+        if rc == None: 
+            self.result['msg'] = str(input) + " " + str(member) + " input does not exist"
+            self.result['rc'] = 1
+            self.module.fail_json(**self.result)
+
     def _validate_directory_staging_dataset(self):
         if len(self.parsed_args.get("directory_datasets")) > 20:
             self.result['msg'] = "You cannot specify more than 20 IMS directory datasets"

plugins/modules/ims_catalog_populate.py

@@ -68,6 +68,11 @@
       - Defines the buffer pool parameters data set. This option is required if you are running the utility as a DLI.
     type: str
     required: false
+  dfsdf_member:
+    description:
+      - The DFSDFxxx member in the IMS.PROCLIB data set where the CATALOG section is defined. For example, desdf_member: "CAT" specifies the DFSDFCAT member of the PROCLIB data set.
+    type: str
+    required: false
   primary_log_dataset:
     description:
       - Defines the primary IMS log data set. This is required if dbrc is set to true or if
@@ -880,6 +885,7 @@
     psb_lib:
       - SOME.IMS.PSBLIB
     buffer_pool_param_dataset: "SOME.IMS.PROCLIB(DFSVSMHP)"
+    dfsdf_member: "CAT"
     primary_log_dataset:
       dataset_name: SOME.IMS.LOG
 
@@ -899,6 +905,7 @@
     psb_lib:
       - SOME.IMS.PSBLIB
     buffer_pool_param_dataset: "SOME.IMS.PROCLIB(DFSVSMHP)"
+    dfsdf_member: "CAT"
     control_statements:
       managed_acbs:
         setup: true
@@ -919,6 +926,7 @@
     psb_lib:
       - SOME.IMS.PSBLIB
     buffer_pool_param_dataset: "SOME.IMS.PROCLIB(DFSVSMHP)"
+    dfsdf_member: "CAT"
     primary_log_dataset:
       dataset_name: SOME.IMS.LOG
     control_statements:
@@ -968,6 +976,7 @@ def run_module():
         modstat=dict(type="str", required=False),
         reslib=dict(type="list", elements="str", required=False),
         buffer_pool_param_dataset=dict(type="str", required=False),
+        dfsdf_member=dict(type="str", required=False),
         primary_log_dataset=dict(type="dict", required=False),
         secondary_log_dataset=dict(type="dict", required=False),
         psb_lib=dict(type="list", elements="str", required=True),

plugins/modules/ims_catalog_purge.py

@@ -67,6 +67,11 @@
       - Defines the buffer pool parameters data set. This option is required if you are running the utility as a DLI.
     type: str
     required: false
+  dfsdf_member: 
+    description:
+      - The DFSDFxxx member in the IMS.PROCLIB data set where the CATALOG section is defined. For example, desdf_member: "CAT" specifies the DFSDFCAT member of the PROCLIB data set.
+    type: str
+    required: false
   primary_log_dataset:
     description:
       - Defines the primary IMS log data set. This option is required if you are running the utility as a DLI.
@@ -440,6 +445,7 @@
     psb_lib:
       - SOME.IMS.PSBLIB
     buffer_pool_param_dataset: "SOME.IMS1.PROCLIB(DFSVSMHP)"
+    dfsdf_member: "CAT"
     primary_log_dataset:
       dataset_name: SOME.IMS.LOG1
     mode: PURGE
@@ -461,6 +467,7 @@
     psb_lib:
       - SOME.IMS.PSBLIB
     buffer_pool_param_dataset: "SOME.IMS1.PROCLIB(DFSVSMHP)"
+    dfsdf_member: "CAT"
     primary_log_dataset:
       dataset_name: SOME.IMS.LOG1
     mode: PURGE
@@ -483,6 +490,7 @@
     psb_lib:
       - SOME.IMS.PSBLIB
     buffer_pool_param_dataset: "SOME.IMS1.PROCLIB(DFSVSMHP)"
+    dfsdf_member: "CAT"
     primary_log_dataset:
       dataset_name: SOME.IMS.LOG1
     mode: ANALYSIS
@@ -502,6 +510,7 @@
     psb_lib:
       - SOME.IMS.PSBLIB
     buffer_pool_param_dataset: "SOME.IMS1.PROCLIB(DFSVSMHP)"
+    dfsdf_member: "CAT"
     primary_log_dataset:
       dataset_name: SOME.IMS.LOG1
     mode: ANALYSIS
@@ -554,6 +563,7 @@ def run_module():
         irlm_id=dict(type="str", required=False),
         reslib=dict(type="list", elements="str", required=False),
         buffer_pool_param_dataset=dict(type="str", required=False),
+        dfsdf_member=dict(type="str", required=False),
         primary_log_dataset=dict(type="dict", required=True),
         psb_lib=dict(type="list", elements="str", required=True),
         dbd_lib=dict(type="list", elements="str", required=True),

tests/functional/module_utils/ims_test_catalog_utils.py

@@ -6,7 +6,7 @@
 
 
 def load_catalog(hosts, validation_msg, mode, psb_lib, dbd_lib, steplib, reslib, proclib, primary_log_dataset,
-                 buffer_pool_param_dataset, acb_lib, modstat=None, online_batch=None, dbrc=None, ims_id=None, irlm_id=None,
+                 buffer_pool_param_dataset, dfsdf_member, acb_lib, modstat=None, online_batch=None, dbrc=None, ims_id=None, irlm_id=None,
                  control_statements=None, bootstrap_dataset=None,
                  directory_datasets=None, temp_acb_dataset=None, directory_staging_dataset=None,
                  secondary_log_dataset=None, sysabend=None, check_timestamp=None, rc=0, changed=True):
@@ -26,6 +26,7 @@ def load_catalog(hosts, validation_msg, mode, psb_lib, dbd_lib, steplib, reslib,
         sysabend=sysabend,
         check_timestamp=check_timestamp,
         buffer_pool_param_dataset=buffer_pool_param_dataset,
+        dfsdf_member=dfsdf_member,
         mode=mode,
         control_statements=control_statements,
         bootstrap_dataset=bootstrap_dataset,
@@ -37,15 +38,15 @@ def load_catalog(hosts, validation_msg, mode, psb_lib, dbd_lib, steplib, reslib,
     )
     for result in response.contacted.values():
         pprint(result)
-        assert result['rc'] == rc
+        assert result['rc'] == rc # continue the execution while the rc equals to 0
         if rc == 0:
             assert validation_msg in result['content']
         else:
             assert validation_msg in result['msg']
 
 
 def purge_catalog(hosts, validation_msg, primary_log_dataset, psb_lib, dbd_lib, steplib, reslib, proclib,
-                  buffer_pool_param_dataset, online_batch=None, dbrc=None, ims_id=None, irlm_id=None, sysut1=None, update_retention_criteria=None,
+                  buffer_pool_param_dataset, dfsdf_member, online_batch=None, dbrc=None, ims_id=None, irlm_id=None, sysut1=None, update_retention_criteria=None,
                   delete=None, managed_acbs=None, delete_dbd_by_version=None, resource_chkp_freq=None, mode='PURGE', rc=0, changed=True):
 
     response = hosts.all.ims_catalog_purge(
@@ -62,6 +63,7 @@ def purge_catalog(hosts, validation_msg, primary_log_dataset, psb_lib, dbd_lib,
         update_retention_criteria=update_retention_criteria,
         delete_dbd_by_version=delete_dbd_by_version,
         buffer_pool_param_dataset=buffer_pool_param_dataset,
+        dfsdf_member=dfsdf_member,
         mode=mode,
         primary_log_dataset=primary_log_dataset,
         delete=delete,
@@ -92,6 +94,7 @@ class CatalogInputParameters():
     PROCLIB = HLQ1 + HLQ2 + "PROCLIB"
     RESLIB = [HLQ1 + HLQ2 + "SDFSRESL"]
     BUFFERPOOL = HLQ1 + HLQ2 + "PROCLIB(DFSVSMHP)"
+    DFSDF_DEFAULT = "CAT"
     MODSTAT = HLQ1 + HLQ2 + "MODSTAT"
     PSB_NAME = ["PGSAM1"]
     LOADMODE = "LOAD"