Merge pull request #144 from ansible-collections/release-v1.3.0

Sync latest changes from release v1.3.0 into dev

Author: ddgandhi

README.md

@@ -40,7 +40,7 @@ and ansible-doc to automate tasks on IMS.
 Ansible version compatibility
 ==============================
 
-This collection has been tested against the following Ansible versions: >=2.14.0,<2.16.0.
+This collection has been tested against the following Ansible versions: >=2.14.0,<2.17.0.
 
 
 Copyright

ansible.cfg

@@ -22,7 +22,7 @@
 forks = 25
 # remote_tmp = /u/ansible/tmp
 # remote_port = 2022
-callback_enabled = ansible.posix.profile_tasks
+# callback_enabled = ansible.posix.profile_tasks
 
 [connection]
 pipelining = False

changelogs/changelog.yaml

@@ -69,7 +69,6 @@ releases:
         \n"
     fragments:
     - v1.2.0_summary.yml
-    - v1.2.0_summary.yml
     release_date: '2023-03-31'
   1.2.0-beta.1:
     changes:
@@ -93,3 +92,33 @@ releases:
     fragments:
     - v1.2.0-beta2_summary.yml
     release_date: '2022-12-22'
+  1.3.0:
+    changes:
+      release_summary: "Release Date: '2024-04-10'\nThis changelog describes all changes
+        made to the modules and plugins included\nin this collection.\nFor additional
+        details such as required dependencies and availability review\nthe collections
+        `release notes <https://github.com/ansible-collections/ibm_zos_ims/blob/dev/docs/source/release_notes.rst>`__
+        \n"
+    fragments:
+    - v1.3.0_summary.yml
+    release_date: '2024-04-10'     
+  1.3.0-beta.1:
+    changes:
+      major_changes:
+      - Added new module 'ims_ddl'
+      - Added new member dfsdf_member in the ims_catalog_populate and ims_catalog_purge modules.
+        The DFSDFxxx member is in the IMS.PROCLIB data set where the CATALOG section is defined.
+      - Documentation update, minor updates to compression parameter in the ims_acbgen module where
+        PRECOMP,POSTCOMP, in any combination, cause the required in-place compression.
+        The choices are not mutually exclusive -- PRECOMP or POSTCOMP or PRECOMP,POSTCOMP can be used.
+      - Improved test and ansible-sanity coverage.
+      - Subset of the test cases were updated to support for Ansible 2.15.
+      - Additional support for test cases in ims_catalog_populate and ims_catalog_purge modules to 
+        support dfsdf_member parameter.
+      - This update also has updated prerequisites for Ansible 2.14 or newer and ZOAU 1.2.2 or newer 
+        but prior to version 1.3.
+    fragments:
+    - v1.3.0-beta1_summary.yml
+    release_date: '2023-12-15'
+  
+    

docs/source/modules/ims_acb_gen.rst

@@ -16,8 +16,8 @@ ims_acb_gen -- Generate IMS ACB
 
 Synopsis
 --------
-- The ims_acb_gen module generates an IMS application control block (ACB) necessary for an IMS application program to be scheduled and run.
-- The ims_dbd_gen and ims_psb_gen modules can be used to generate the associated IMS database descriptors (DBDs) and program specification block (PSBs) to be used with the ims_acb_gen module.
+- The ims\_acb\_gen module generates an IMS application control block (ACB) necessary for an IMS application program to be scheduled and run.
+- The ims\_dbd\_gen and ims\_psb\_gen modules can be used to generate the associated IMS database descriptors (DBDs) and program specification block (PSBs) to be used with the ims\_acb\_gen module.
 - The DBD and PSB control blocks will be merged and expanded into an IMS internal format called application control blocks (ACBs).
 
 
@@ -43,17 +43,15 @@ command_input
 compression
   PRECOMP,POSTCOMP, in any combination, cause the required in-place compression.
 
-  The choices are not mutually exclusive -- PRECOMP or POSTCOMP or PRECOMP,POSTCOMP can be used
-
   The default is none.
 
   | **required**: False
   | **type**: str
-  | **choices**: PRECOMP, POSTCOMP
+  | **choices**: precomp, postcomp, precomp,postcomp, PRECOMP, POSTCOMP, PRECOMP,POSTCOMP
 
 
 psb_name
-  The name of the PS**s**. Specifies that blocks are built or deleted for all PSBs that are named on this control statement.
+  The name of the PSB(s). Specifies that blocks are built or deleted for all PSBs that are named on this control statement.
 
   This field requires "ALL" or a list of psb names to be specified.
 
@@ -73,7 +71,7 @@ dbd_name
 acb_lib
   The ACB Maintenance utility maintains the prebuilt blocks (ACB) library (IMS.ACBLIB). The ACB library is a consolidated library of program (PSB) and database (DBD) descriptions.
 
-  The IMS acb_lib must be used exclusively. The module can only be executed using an ACB library which is not concurrently allocated to an active IMS system.
+  The IMS acb\_lib must be used exclusively. The module can only be executed using an ACB library which is not concurrently allocated to an active IMS system.
 
   | **required**: True
   | **type**: str
@@ -82,7 +80,7 @@ acb_lib
 psb_lib
   The ACB Maintenance utility receives input from the IMS PSBLIB data set.
 
-  The ACB Maintenance utility does not change the PS**s** in PSBLIB. If changes are made in PSBs or DBDs that require changes in the associated PSB, make these changes before running the module.
+  The ACB Maintenance utility does not change the PSB(s) in PSBLIB. If changes are made in PSBs or DBDs that require changes in the associated PSB, make these changes before running the module.
 
   Changes in PSBs might also require modifications to the affected application programs. For example, if a DBD has a segment name changed, all PSBs which are sensitive to that segment must have their SENSEG statements changed.
 
@@ -102,11 +100,11 @@ dbd_lib
 
 
 steplib
-  Points to the IMS SDFSRESL data set, which contains the IMS nucleus and required IMS modules. If STEPLIB is unauthorized by having unauthorized libraries that are concatenated to SDFSRESL, you must specify the *reslib* parameter.
+  Points to the IMS SDFSRESL data set, which contains the IMS nucleus and required IMS modules. If STEPLIB is unauthorized by having unauthorized libraries that are concatenated to SDFSRESL, you must specify the \ :emphasis:`reslib`\  parameter.
 
-  The steplib parameter can also be specified in the target inventory's environment_vars.
+  The steplib parameter can also be specified in the target inventory's environment\_vars.
 
-  The steplib input parameter to the module will take precedence over the value specified in the environment_vars.
+  The steplib input parameter to the module will take precedence over the value specified in the environment\_vars.
 
   | **required**: False
   | **type**: list
@@ -122,11 +120,11 @@ reslib
 
 
 build_psb
-  Specifies whether ims_acb_gen rebuilds all PSBs that reference a changed DBD in the *dbdname* parameter.
+  Specifies whether ims\_acb\_gen rebuilds all PSBs that reference a changed DBD in the \ :emphasis:`dbdname`\  parameter.
 
-  TRUE indicates that ims_acb_gen rebuilds all PSBs that reference the changed DBD on the *dbdname* parameter.
+  TRUE indicates that ims\_acb\_gen rebuilds all PSBs that reference the changed DBD on the \ :emphasis:`dbdname`\  parameter.
 
-  FALSE indicates that ims_acb_gen does not rebuild PSBs that reference the changed DBD if the changed DBD does not change the physical structure of the database.
+  FALSE indicates that ims\_acb\_gen does not rebuild PSBs that reference the changed DBD if the changed DBD does not change the physical structure of the database.
 
   | **required**: False
   | **type**: bool
@@ -201,15 +199,15 @@ Notes
 -----
 
 .. note::
-   The *steplib* parameter can also be specified in the target inventory's environment_vars.
+   The \ :emphasis:`steplib`\  parameter can also be specified in the target inventory's environment\_vars.
 
-   The *steplib* input parameter to the module will take precedence over the value specified in the environment_vars.
+   The \ :emphasis:`steplib`\  input parameter to the module will take precedence over the value specified in the environment\_vars.
 
-   If only the *steplib* parameter is specified, then only the *steplib* concatenation will be used to resolve the IMS RESLIB dataset.
+   If only the \ :emphasis:`steplib`\  parameter is specified, then only the \ :emphasis:`steplib`\  concatenation will be used to resolve the IMS RESLIB dataset.
 
-   If both *steplib* and *reslib* are specified, then both parameters will be used by the ACB Maintenenace Utility and *reslib* will be used to resolve the IMS RESLIB dataset.
+   If both \ :emphasis:`steplib`\  and \ :emphasis:`reslib`\  are specified, then both parameters will be used by the ACB Maintenenace Utility and \ :emphasis:`reslib`\  will be used to resolve the IMS RESLIB dataset.
 
-   Specifying only *reslib* without *steplib* is not supported.
+   Specifying only \ :emphasis:`reslib`\  without \ :emphasis:`steplib`\  is not supported.
 
    The ACB Maintenenace utility SYSUT3/SYSUT4 DD options are not supported by this module.
 
@@ -224,7 +222,7 @@ Return Values
 
 
 msg
-  Execution result message from the ims_acb_gen module.
+  Execution result message from the ims\_acb\_gen module.
 
   | **returned**: always
   | **type**: str
@@ -254,7 +252,7 @@ changed
 debug
   additional messages returned from ZOAU.
 
-  For more information, refer to the `ZOAU messages documentation <https://www.ibm.com/support/knowledgecenter/en/SSKFYE_1.0.0/bgy.html>`_
+  For more information, refer to the \ `ZOAU messages documentation <https://www.ibm.com/support/knowledgecenter/en/SSKFYE_1.0.0/bgy.html>`__\ 
 
   | **returned**: always
   | **type**: str

docs/source/modules/ims_ddl.rst

@@ -66,9 +66,9 @@ proclib
 steplib
   Points to IMS.SDFSRESL, which contains the IMS nucleus and required IMS modules.
 
-  The steplib parameter can also be specified in the target inventory's environment_vars.
+  The steplib parameter can also be specified in the target inventory's environment\_vars.
 
-  The steplib input parameter to the module will take precedence over the value specified in the environment_vars.
+  The steplib input parameter to the module will take precedence over the value specified in the environment\_vars.
 
   | **required**: False
   | **type**: list
@@ -133,7 +133,7 @@ Examples
 
 
    - name: Example of DDL statements are in a dataset
-     ims_data_definition:
+     ims_ddl:
        online: True
        ims_id: IMS1
        reslib:
@@ -144,7 +144,7 @@ Examples
          - SOME.IMS.PROCLIB
        sql_input: SOME.IMS.SQL
    - name: Example of DDL statements in which VERBOSE and AUTOCOMMIT control options are specified
-     ims_data_definition:
+     ims_ddl:
        online: True
        ims_id: IMS1
        reslib:
@@ -158,7 +158,7 @@ Examples
        auto_commit: true
 
    - name: Example of DDL statements in which SIMULATE control options is specified
-     ims_data_definition:
+     ims_ddl:
        online: True
        ims_id: IMS1
        reslib:
@@ -171,7 +171,7 @@ Examples
        simulate: true
 
    - name: Example of DDL statements in which DYNAMIC_PROGRAMVIEW control option is specified
-     ims_data_definition:
+     ims_ddl:
        online: True
        ims_id: IMS1
        reslib:
@@ -191,13 +191,13 @@ Notes
 -----
 
 .. note::
-   The *steplib* parameter can also be specified in the target inventory's environment_vars.
+   The \ :emphasis:`steplib`\  parameter can also be specified in the target inventory's environment\_vars.
 
-   The *steplib* input parameter to the module will take precedence over the value specified in the environment_vars.
+   The \ :emphasis:`steplib`\  input parameter to the module will take precedence over the value specified in the environment\_vars.
 
-   If only the *steplib* parameter is specified, then only the *steplib* concatenation will be used to resolve the IMS RESLIB data set.
+   If only the \ :emphasis:`steplib`\  parameter is specified, then only the \ :emphasis:`steplib`\  concatenation will be used to resolve the IMS RESLIB data set.
 
-   Specifying only *reslib* without *steplib* is not supported.
+   Specifying only \ :emphasis:`reslib`\  without \ :emphasis:`steplib`\  is not supported.
 
    Currently ddl error messages are returned within the content block of the module response.
 

docs/source/release_notes.rst

@@ -6,6 +6,46 @@
 Releases
 ========
 
+
+Version 1.3.0
+====================
+
+Notes
+-----
+
+* Update recommended
+
+  * type() was replaced by isinstance() in the code for gen utilities since ansible-core 2.16 supports Python 3.12 and that version deprecated type() function. 
+  * No other changes from version 1.3.0-beta.1 release. Collection promoted to certified content with version 1.3.0.
+
+Availability
+------------
+
+* `Automation Hub`_
+* `Galaxy`_
+* `GitHub`_
+
+Reference
+---------
+
+* Supported by IBM z/OS core collection v1.5.0 or later
+* Supported by IBM Z Open Enterprise Python for z/OS 3.9 - 3.12
+* Supported by IBM Z Open Automation Utilities 1.2.2 or later (but prior to 1.3)
+
+  * ZOAU minimum supported version may vary depending on the z/OS core collection version that is chosen. For details on z/OS core collection requirements, see: https://github.com/ansible-collections/ibm_zos_core/releases
+* Supported by z/OS V2R4 (or later) but prior to version V3R1
+* The z/OS® shell
+
+.. _centralized content:
+   https://ibm.github.io/z_ansible_collections_doc/index.html
+
+.. _GitHub:
+   https://github.com/ansible-collections/ibm_zos_ims
+
+.. _Galaxy:
+   https://galaxy.ansible.com/ibm/ibm_zos_ims
+
+
 Version 1.3.0-beta.1
 ====================
 
@@ -43,7 +83,9 @@ Reference
 * Supported by IBM z/OS core collection v1.5.0 or later
 * Supported by IBM Z Open Enterprise Python for z/OS: 3.9 or later
 * Supported by IBM Z Open Automation Utilities 1.2.2 or later (but prior to 1.3)
-* Supported by z/OS V2R4
+
+  * ZOAU minimum supported version may vary depending on the z/OS core collection version that is chosen. For details on z/OS core collection requirements, see: https://github.com/ansible-collections/ibm_zos_core/releases
+* Supported by z/OS V2R4 (or later) but prior to version V3R1
 * The z/OS® shell
 
 .. _centralized content:

galaxy.yml

@@ -6,7 +6,7 @@ namespace: ibm
 name: ibm_zos_ims
 
 # The collection version
-version: 1.3.0-beta.1
+version: 1.3.0
 
 # Collection README file
 readme: README.md
@@ -33,7 +33,7 @@ tags: [ibm, z, zos, z_os, core, zos_core, data_set, jcl, uss, mvs, ims, zos_ims,
 
 # Collections that this collection requires to be installed for it to be usable.
 dependencies:
-    "ibm.ibm_zos_core": ">=1.5.0"
+  "ibm.ibm_zos_core": ">=1.5.0"
 
 # The URL of the originating SCM repository
 repository: https://github.com/ansible-collections/ibm_zos_ims

meta/execution-environment.yml

@@ -7,4 +7,4 @@
 ################################################################################
 dependencies:
   python: requirements-zos-ims.txt
-version: 1
+version: 1

meta/runtime.yml

@@ -1,2 +1,2 @@
 ---
-requires_ansible: '>=2.14.0'
+requires_ansible: '>=2.14.0'

plugins/module_utils/ims_gen_utils.py

@@ -328,7 +328,7 @@ def execute_gen_command(source, dest, syslib_list, run_command, module, result):
                         return src, return_code, return_text, failed
 
                     for item in source['member_list']:
-                        if type(item) == str:
+                        if isinstance(item, str):
                             # set target name same as src
                             src_member = item
                             target_name = item