Merge staging-v1.8.0-tasks into staging-v1.8.0 (#1090)

* Modified galaxy version * mofidied meta * Update copyright year * Generated module docs * Created changelog * Removed changelog fragments * Updated changelog and release notes * Fixed newline sequences * Update CHANGELOG.rst * Update CHANGELOG.rst * Corrected release notes
ansible-collections · Dec 13, 2023 · a03f440 · a03f440
1 parent 647beb2
commit a03f440
Show file tree

Hide file tree

Showing 29 changed files with 121 additions and 80 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -5,13 +5,13 @@ ibm.ibm_zos_core Release Notes
 .. contents:: Topics
 
 
-v1.8.0-beta.1
-=============
+v1.8.0
+======
 
 Release Summary
 ---------------
 
-Release Date: '2023-10-24'
+Release Date: '2023-12-08'
 This changelog describes all changes made to the modules and plugins included
 in this collection. The release date is the date the changelog is created.
 For additional details such as required dependencies and availability review
@@ -31,18 +31,31 @@ Minor Changes
 - zos_job_submit - Change action plugin call from copy to zos_copy. (https://github.com/ansible-collections/ibm_zos_core/pull/951)
 - zos_operator - Changed system to call 'wait=true' parameter to zoau call. Requires zoau 1.2.5 or later. (https://github.com/ansible-collections/ibm_zos_core/pull/976)
 - zos_operator_action_query - Add a max delay of 5 seconds on each part of the operator_action_query. Requires zoau 1.2.5 or later. (https://github.com/ansible-collections/ibm_zos_core/pull/976)
+- zos_script - add support for remote_tmp from the Ansible configuration to setup where temporary files will be created, replacing the module option tmp_path. (https://github.com/ansible-collections/ibm_zos_core/pull/1068).
+- zos_submit_job - Previous code did not return output, but still requested job data from the target system. This changes to honor return_output=false by not querying the job dd segments at all. (https://github.com/ansible-collections/ibm_zos_core/pull/1063).
+- zos_tso_command - add example for executing explicitly a REXX script from a data set. (https://github.com/ansible-collections/ibm_zos_core/pull/1072).
 - zos_unarchive -  Add validation into path joins to detect unauthorized path traversals. (https://github.com/ansible-collections/ibm_zos_core/pull/1029)
 - zos_unarchive - Enhanced test cases to use test lines the same length of the record length. (https://github.com/ansible-collections/ibm_zos_core/pull/965)
-- zos_copy - add support in zos_copy for text files and data sets containing ASA control characters. (https://github.com/ansible-collections/ibm_zos_core/pull/1028)
+
+Deprecated Features
+-------------------
+
+- zos_blockinfile - debug is deprecated in favor of 'as_json' (https://github.com/ansible-collections/ibm_zos_core/pull/904).
 
 Bugfixes
 --------
 
 - zos_copy - Update option limit to include LIBRARY as dest_dataset/suboption value. Documentation updated to reflect this change. (https://github.com/ansible-collections/ibm_zos_core/pull/968).
+- zos_copy - When copying an executable data set from controller to managed node, copy operation failed with an encoding error. Fix now avoids encoding when executable option is selected. (https://github.com/ansible-collections/ibm_zos_core/pull/1079).
+- zos_copy - When copying an executable data set with aliases and destination did not exist, destination data set was created with wrong attributes. Fix now creates destination data set with the same attributes as the source. (https://github.com/ansible-collections/ibm_zos_core/pull/1067).
+- zos_copy - When performing a copy operation to an existing file, the copied file resulted in having corrupted contents. Fix now implements a workaround to not use the specific copy routine that corrupts the file contents. (https://github.com/ansible-collections/ibm_zos_core/pull/1069).
 - zos_job_submit - Temporary files were created in tmp directory. Fix now ensures the deletion of files every time the module run. (https://github.com/ansible-collections/ibm_zos_core/pull/951)
 - zos_job_submit - The last line of the jcl was missing in the input. Fix now ensures the presence of the full input in job_submit. (https://github.com/ansible-collections/ibm_zos_core/pull/952)
 - zos_lineinfile - A duplicate entry was made even if line was already present in the target file. Fix now prevents a duplicate entry if the line already exists in the target file. (https://github.com/ansible-collections/ibm_zos_core/pull/916)
 - zos_operator - The last line of the operator was missing in the response of the module. The fix now ensures the presence of the full output of the operator. https://github.com/ansible-collections/ibm_zos_core/pull/918)
+- zos_operator - The module was ignoring the wait time argument. The module now passes the wait time argument to ZOAU. (https://github.com/ansible-collections/ibm_zos_core/pull/1063).
+- zos_operator_action_query - The module was ignoring the wait time argument. The module now passes the wait time argument to ZOAU. (https://github.com/ansible-collections/ibm_zos_core/pull/1063).
+- zos_unarchive - When zos_unarchive fails during unpack either with xmit or terse it does not clean the temporary data sets created. Fix now removes the temporary data sets. (https://github.com/ansible-collections/ibm_zos_core/pull/1054).
 
 Known Issues
 ------------

diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml
@@ -1023,6 +1023,55 @@ releases:
     - 930-archive-post-beta.yml
     - v1.7.0-beta.2_summary.yml
     release_date: '2023-08-21'
+  1.8.0:
+    changes:
+      bugfixes:
+      - zos_copy - When copying an executable data set from controller to managed
+        node, copy operation failed with an encoding error. Fix now avoids encoding
+        when executable option is selected. (https://github.com/ansible-collections/ibm_zos_core/pull/1079).
+      - zos_copy - When copying an executable data set with aliases and destination
+        did not exist, destination data set was created with wrong attributes. Fix
+        now creates destination data set with the same attributes as the source. (https://github.com/ansible-collections/ibm_zos_core/pull/1067).
+      - zos_copy - When performing a copy operation to an existing file, the copied
+        file resulted in having corrupted contents. Fix now implements a workaround
+        to not use the specific copy routine that corrupts the file contents. (https://github.com/ansible-collections/ibm_zos_core/pull/1069).
+      - zos_operator - The module was ignoring the wait time argument. The module
+        now passes the wait time argument to ZOAU. (https://github.com/ansible-collections/ibm_zos_core/pull/1063).
+      - zos_operator_action_query - The module was ignoring the wait time argument.
+        The module now passes the wait time argument to ZOAU. (https://github.com/ansible-collections/ibm_zos_core/pull/1063).
+      - zos_unarchive - When zos_unarchive fails during unpack either with xmit or
+        terse it does not clean the temporary data sets created. Fix now removes the
+        temporary data sets. (https://github.com/ansible-collections/ibm_zos_core/pull/1054).
+      minor_changes:
+      - zos_script - Add support for remote_tmp from the Ansible configuration to
+        setup where temporary files will be created, replacing the module option tmp_path.
+        (https://github.com/ansible-collections/ibm_zos_core/pull/1068).
+      - zos_job_submit - Previous code did not return output, but still requested
+        job data from the target system. This changes to honor return_output=false
+        by not querying the job dd segments at all. (https://github.com/ansible-collections/ibm_zos_core/pull/1063).
+      - zos_tso_command - Add example for executing explicitly a REXX script from
+        a data set. (https://github.com/ansible-collections/ibm_zos_core/pull/1072).
+      release_summary: 'Release Date: ''2023-12-08''
+
+        This changelog describes all changes made to the modules and plugins included
+
+        in this collection. The release date is the date the changelog is created.
+
+        For additional details such as required dependencies and availability review
+
+        the collections `release notes <https://ibm.github.io/z_ansible_collections_doc/ibm_zos_core/docs/source/release_notes.html>`__'
+    fragments:
+    - 1041-bug-zos-submit-job-honor-return-output-literally.yml
+    - 1043-bug-title-zos_operator-is-passing-wrong-value-to-zoauopercmd.yml
+    - 1049-xmit-temporary-data-sets.yml
+    - 1060-remote_tmp_zos_script.yml
+    - 1067-mvs_to_non_existent_mvs_copy_verify_destination_attrs_match.yml
+    - 1069-corrupted-second-copy.yml
+    - 1072-rexx-exec-tso_command.yml
+    - 1079-zos-copy-local-executable.yml
+    - 1089-update-managed_node_doc.yml
+    - v1.8.0-summary.yml
+    release_date: '2023-12-08'
   1.8.0-beta.1:
     changes:
       bugfixes:

diff --git a/changelogs/fragments/1041-bug-zos-submit-job-honor-return-output-literally.yml b/changelogs/fragments/1041-bug-zos-submit-job-honor-return-output-literally.yml
diff --git a/changelogs/fragments/1043-bug-title-zos_operator-is-passing-wrong-value-to-zoauopercmd.yml b/changelogs/fragments/1043-bug-title-zos_operator-is-passing-wrong-value-to-zoauopercmd.yml
diff --git a/changelogs/fragments/1049-xmit-temporary-data-sets.yml b/changelogs/fragments/1049-xmit-temporary-data-sets.yml
diff --git a/changelogs/fragments/1060-remote_tmp_zos_script.yml b/changelogs/fragments/1060-remote_tmp_zos_script.yml
diff --git a/changelogs/fragments/1067-mvs_to_non_existent_mvs_copy_verify_destination_attrs_match.yml b/changelogs/fragments/1067-mvs_to_non_existent_mvs_copy_verify_destination_attrs_match.yml
diff --git a/changelogs/fragments/1069-corrupted-second-copy.yml b/changelogs/fragments/1069-corrupted-second-copy.yml
diff --git a/changelogs/fragments/1072-rexx-exec-tso_command.yml b/changelogs/fragments/1072-rexx-exec-tso_command.yml
diff --git a/changelogs/fragments/1079-zos-copy-local-executable.yml b/changelogs/fragments/1079-zos-copy-local-executable.yml
diff --git a/changelogs/fragments/1089-update-managed_node_doc.yml b/changelogs/fragments/1089-update-managed_node_doc.yml
diff --git a/docs/source/modules/zos_copy.rst b/docs/source/modules/zos_copy.rst
@@ -554,6 +554,7 @@ template_parameters
     | **choices**: \\n, \\r, \\r\\n
 
 
+
   auto_reload
     Whether to reload a template file when it has changed after the task has started.
 

diff --git a/docs/source/modules/zos_job_submit.rst b/docs/source/modules/zos_job_submit.rst
@@ -259,6 +259,7 @@ template_parameters
     | **choices**: \\n, \\r, \\r\\n
 
 
+
   auto_reload
     Whether to reload a template file when it has changed after the task has started.
 

diff --git a/docs/source/modules/zos_script.rst b/docs/source/modules/zos_script.rst
@@ -221,6 +221,7 @@ template_parameters
     | **choices**: \\n, \\r, \\r\\n
 
 
+
   auto_reload
     Whether to reload a template file when it has changed after the task has started.
 

diff --git a/docs/source/release_notes.rst b/docs/source/release_notes.rst
@@ -6,8 +6,8 @@
 Releases
 ========
 
-Version 1.8.0-beta.1
-====================
+Version 1.8.0
+=============
 
 New Modules
 -----------
@@ -22,29 +22,46 @@ Minor Changes
     - Enhanced test cases to use test lines the same length of the record length.
 - ``zos_copy``
 
-    -  Add validation into path joins to detect unauthorized path traversals.
+    - Add validation into path joins to detect unauthorized path traversals.
     - Add new option `force_lock` that can copy into data sets that are already in use by other processes (DISP=SHR). User needs to use with caution because this is subject to race conditions and can lead to data loss.
-    - includes a new option `executable` that enables copying of executables such as load modules or program objects to both USS and partitioned data sets. When the `dest` option contains a non-existent data set, `zos_copy` will create a data set with the appropriate attributes for an executable.
-    - introduces a new option 'aliases' to enable preservation of member aliases when copying data to partitioned data sets (PDS) destinations from USS or other PDS sources. Copying aliases of text based members to/from USS is not supported.
-    - add support in zos_copy for text files and data sets containing ASA control characters.
+    - Includes a new option `executable` that enables copying of executables such as load modules or program objects to both USS and partitioned data sets. When the `dest` option contains a non-existent data set, `zos_copy` will create a data set with the appropriate attributes for an executable.
+    - Introduces a new option 'aliases' to enable preservation of member aliases when copying data to partitioned data sets (PDS) destinations from USS or other PDS sources. Copying aliases of text based members to/from USS is not supported.
+    - Add support in zos_copy for text files and data sets containing ASA control characters.
 - ``zos_fetch`` - Add validation into path joins to detect unauthorized path traversals.
-- ``zos_job_submit`` - Change action plugin call from copy to zos_copy.
-- ``zos_operator`` - Changed system to call 'wait=true' parameter to zoau call. Requires zoau 1.2.5 or later.
+- ``zos_job_submit``
+
+    - Change action plugin call from copy to zos_copy.
+    - Previous code did not return output, but still requested job data from the target system. This changes to honor `return_output=false` by not querying the job dd segments at all.
+- ``zos_operator`` - Changed system to call `wait=true` parameter to zoau call. Requires zoau 1.2.5 or later.
 - ``zos_operator_action_query`` - Add a max delay of 5 seconds on each part of the operator_action_query. Requires zoau 1.2.5 or later.
 - ``zos_unarchive``
 
-    -  Add validation into path joins to detect unauthorized path traversals.
+    - Add validation into path joins to detect unauthorized path traversals.
     - Enhanced test cases to use test lines the same length of the record length.
 - ``module_utils/template`` - Add validation into path joins to detect unauthorized path traversals.
+- ``zos_tso_command`` - Add example for executing explicitly a REXX script from a data set.
+- ``zos_script`` - Add support for remote_tmp from the Ansible configuration to setup where temporary files will be created, replacing the module option tmp_path.
 
 Bugfixes
 --------
 
-- ``zos_copy`` - Update option limit to include LIBRARY as dest_dataset/suboption value. Documentation updated to reflect this change.
-- ``zos_job_submit`` - Temporary files were created in tmp directory. Fix now ensures the deletion of files every time the module run.
-- ``zos_job_submit`` - The last line of the jcl was missing in the input. Fix now ensures the presence of the full input in job_submit.
+- ``zos_copy``
+
+    - Update option to include `LIBRARY` as dest_dataset/suboption value. Documentation updated to reflect this change.
+    - When copying an executable data set from controller to managed node, copy operation failed with an encoding error. Fix now avoids encoding when `executable` option is selected.
+    - When copying an executable data set with aliases and destination did not exist, destination data set was created with wrong attributes. Fix now creates destination data set with the same attributes as the source.
+    - When performing a copy operation to an existing file, the copied file resulted in having corrupted contents. Fix now implements a workaround to not use the specific copy routine that corrupts the file contents.
+- ``zos_job_submit``
+
+    - Temporary files were created in tmp directory. Fix now ensures the deletion of files every time the module run.
+    - The last line of the jcl was missing in the input. Fix now ensures the presence of the full input in job_submit.
 - ``zos_lineinfile`` - A duplicate entry was made even if line was already present in the target file. Fix now prevents a duplicate entry if the line already exists in the target file.
-- ``zos_operator`` - The last line of the operator was missing in the response of the module. The fix now ensures the presence of the full output of the operator.
+- ``zos_operator``
+
+    - The last line of the operator was missing in the response of the module. The fix now ensures the presence of the full output of the operator.
+    - The module was ignoring the wait time argument. The module now passes the wait time argument to ZOAU.
+- ``zos_operator_action_query`` - The module was ignoring the wait time argument. The module now passes the wait time argument to ZOAU.
+- ``zos_unarchive`` - When zos_unarchive fails during unpack either with xmit or terse it does not clean the temporary data sets created. Fix now removes the temporary data sets.
 
 Known Issues
 ------------
@@ -55,6 +72,7 @@ Known Issues
 Availability
 ------------
 
+* `Automation Hub`_
 * `Galaxy`_
 * `GitHub`_
 

diff --git a/docs/source/requirements-single.rst b/docs/source/requirements-single.rst
@@ -12,15 +12,15 @@ Requirements
 The **IBM z/OS core collection** requires both a **control node** and
 **managed node** be configured with a minimum set of requirements. The
 control node is often referred to as the **controller** and the
-managed node as the **host**.
+managed node as the **host** or **target**.
 
 Control node
 ============
 The controller is where the Ansible engine that runs the playbook is installed.
 Refer to RedHat Ansible Certified Content documentation for more on the `controllers dependencies`_.
 
 .. _controllers dependencies:
-   https://ibm.github.io/z_ansible_collections_doc/requirements/requirements.html#control-node
+   https://ibm.github.io/z_ansible_collections_doc/requirements/requirements_controller.html
 .. ...........................................................................
 .. © Copyright IBM Corporation 2020                                          .
 .. ...........................................................................
@@ -38,11 +38,12 @@ some dependencies are required to be installed on z/OS such as:
 * `IBM Open Enterprise SDK for Python`_
 * `IBM Z Open Automation Utilities`_
 
-   .. note::
 
-     Each release of the IBM z/OS core collection depends on specific dependency
-     versions. For information on the dependencies or the versions, review the
-     `release notes`_ reference section. 
+.. note::
+
+   Each release of the IBM z/OS core collection depends on specific dependency
+   versions. For information on the dependencies or the versions, review the
+   `release notes`_ reference section. 
 
 z/OS shell
 ----------

diff --git a/galaxy.yml b/galaxy.yml
@@ -6,7 +6,7 @@ namespace: ibm
 name: ibm_zos_core
 
 # The collection version
-version: 1.8.0-beta.1
+version: 1.8.0
 
 # Collection README file
 readme: README.md

diff --git a/meta/ibm_zos_core_meta.yml b/meta/ibm_zos_core_meta.yml
@@ -1,10 +1,10 @@
 name: ibm_zos_core
-version: "1.8.0-beta.1"
+version: "1.8.0"
 managed_requirements:
     -
         name: "IBM Open Enterprise SDK for Python"
         version: ">=3.9"
     -
         name: "Z Open Automation Utilities"
         version:
-            - "1.2.3"
+            - "1.2.4"
diff --git a/plugins/module_utils/data_set.py b/plugins/module_utils/data_set.py
@@ -1,4 +1,4 @@
-# Copyright (c) IBM Corporation 2020, 2023
+# Copyright (c) IBM Corporation 2020 - 2023
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at

diff --git a/plugins/module_utils/encode.py b/plugins/module_utils/encode.py
@@ -1,4 +1,4 @@
-# Copyright (c) IBM Corporation 2020, 2023
+# Copyright (c) IBM Corporation 2020 - 2023
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
 # You may obtain a copy of the License at