Release tasks v1.14.0 GA (#2189)

fernandofloresg · web-flow · commit acd878decd33 · 2025-06-30T10:35:53.000-06:00
* [v1.14.0] Avoid failures when default dir ~/.ansible/tmp/ is not previously created and fix failures when using become in zos_job_submit (#2109) * Updated plugins in zos_copy * Updated action zos_job_submit * Updated tests * Updated permissions * Added fix for content * Added changelogs * Updated zos_job_submit action plugin * Fixed sanity issue * Updated zos_copy * Started release process * Updated lifecylce * Updated meta * Updated zos_mount docs * Updated docs * Updated data set utils * Updated release notes * Updaded lifecycle
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -4,13 +4,13 @@ ibm.ibm\_zos\_core Release Notes
 
 .. contents:: Topics
 
-v1.14.0-beta.1
-==============
+v1.14.0
+=======
 
 Release Summary
 ---------------
 
-Release Date: '2025-04-30'
+Release Date: '2025-06-30'
 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
@@ -43,12 +43,14 @@ Bugfixes
 
 - zos_apf - When trying to add a library into the APF list that was already added, the module would fail. Fix now will not fail the module, and will inform the user that the library is already on the APF list. (https://github.com/ansible-collections/ibm_zos_core/pull/1893)
 - zos_copy - Previously, if the dataset name included special characters such as $, validation would fail when force_lock was false. This has been changed to allow the use of special characters when force_lock option is false. (https://github.com/ansible-collections/ibm_zos_core/pull/1908)
+- zos_copy - Previously, when trying to copy into remote and ansible's default temporary directory was not created before execution the copy task would fail. Fix now creates the temporary directory if possible. (https://github.com/ansible-collections/ibm_zos_core/pull/2109)
 - zos_copy - When ``asa_text`` was set to true at the same time as ``force_lock``, a copy would fail saying the destination was already in use. Fix now opens destination data sets up with disposition SHR when ``force_lock`` and ``asa_text`` are set to true. (https://github.com/ansible-collections/ibm_zos_core/pull/1941).
 - zos_copy - the carriage return characters were being removed from only first 1024 bytes of a file. Now fixed that issue to support removal of the carriage return characters from the complete file content if the file size is more than 1024 bytes. (https://github.com/ansible-collections/ibm_zos_core/pull/1954).
 - zos_data_set - Module would fail when trying to delete a non-existent Generation Data Group. Fix now provides a successful response with `changed=false`. (https://github.com/ansible-collections/ibm_zos_core/pull/1971).
 - zos_data_set - Module would fail with TypeError when trying to replace an existing GDG. Fix now allows to replacing a GDG. (https://github.com/ansible-collections/ibm_zos_core/pull/1964).
 - zos_job_output - When searching for a job name, module performed a '*' (find all), then filtered the results. Fix now asks for specific job name, making the return faster and more precise. (https://github.com/ansible-collections/ibm_zos_core/pull/1916).
 - zos_job_query - When searching for a job name, module performed a '*' (find all), then filtered the results. Fix now asks for specific job name, making the return faster and more precise. (https://github.com/ansible-collections/ibm_zos_core/pull/1916).
+- zos_job_submit - Previously, the use of `become` would result in a permissions error while trying to execute a job from a local file. Fix now allows a user to escalate privileges when executing a job transferred from the controller node. (https://github.com/ansible-collections/ibm_zos_core/pull/2109)
 - zos_job_submit - When searching for a job name, module performed a '*' (find all), then filtered the results. Fix now asks for specific job name, making the return faster and more precise. (https://github.com/ansible-collections/ibm_zos_core/pull/1916).
 - zos_mount - Module failed when using persistent option with a data set that contains non UTF-8 characters. Fix now can use a data set with non UTF-8 characters as data_store. (https://github.com/ansible-collections/ibm_zos_core/pull/1871).
 
diff --git a/changelogs/changelog.yaml b/changelogs/changelog.yaml
@@ -679,6 +679,29 @@ releases:
       name: zos_zfs_resize
       namespace: ''
     release_date: '2025-01-30'
+  1.14.0:
+    changes:
+      bugfixes:
+      - zos_copy - Previously, when trying to copy into remote and ansible's default
+        temporary directory was not created before execution the copy task would fail.
+        Fix now creates the temporary directory if possible. (https://github.com/ansible-collections/ibm_zos_core/pull/2109)
+      - zos_job_submit - Previously, the use of `become` would result in a permissions
+        error while trying to execute a job from a local file. Fix now allows a user
+        to escalate privileges when executing a job transferred from the controller
+        node. (https://github.com/ansible-collections/ibm_zos_core/pull/2109)
+      release_summary: 'Release Date: ''2025-06-30''
+
+        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:
+    - 2109-copy-fix-tmp-dir.yml
+    - v1.14.0_summary.yml
+    release_date: '2025-06-24'
   1.14.0-beta.1:
     changes:
       bugfixes:
diff --git a/changelogs/fragments/2109-copy-fix-tmp-dir.yml b/changelogs/fragments/2109-copy-fix-tmp-dir.yml
@@ -0,0 +1,8 @@
+bugfixes:
+  - zos_job_submit - Previously, the use of `become` would result in a permissions error
+    while trying to execute a job from a local file. Fix now allows a user to escalate
+    privileges when executing a job transferred from the controller node.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2109)
+  - zos_copy - Previously, when trying to copy into remote and ansible's default temporary directory
+    was not created before execution the copy task would fail. Fix now creates the temporary directory if possible.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2109)
diff --git a/docs/source/life-cycle.rst b/docs/source/life-cycle.rst
@@ -27,9 +27,9 @@ its critical dates, and which type of support it's currently eligible for.
 +------------+----------------+-----------------------+------------------+-------------------+-------------------------+
 | Version    | Status         | Changelogs            | GA Date          | EOL Date          | Life Cycle Phase        |
 +============+================+=======================+==================+===================+=========================+
-| 1.14.x     | In preview     | `1.14.x changelogs`_  | TBD              | TBD               |  Beta phase             |
+| 1.14.x     | Released       | `1.14.x changelogs`_  | 30 June 2025     | 30 June 2027      | `Full support`_         |
 +------------+----------------+-----------------------+------------------+-------------------+-------------------------+
-| 1.13.x     | Released       | `1.13.x changelogs`_  | 31 March 2025    | 31 March 2026     | `Full support`_         |
+| 1.13.x     | Released       | `1.13.x changelogs`_  | 31 March 2025    | 31 March 2027     | `Full support`_         |
 +------------+----------------+-----------------------+------------------+-------------------+-------------------------+
 | 1.12.x     | Released       | `1.12.x changelogs`_  | 06 December 2024 | 06 December 2026  | `Full support`_         |
 +------------+----------------+-----------------------+------------------+-------------------+-------------------------+
@@ -41,6 +41,8 @@ its critical dates, and which type of support it's currently eligible for.
 .. .............................................................................
 .. Global Links
 .. .............................................................................
+.. _1.14.x changelogs:
+    https://github.com/ansible-collections/ibm_zos_core/blob/v1.14.0/CHANGELOG.rst
 .. _1.13.x changelogs:
     https://github.com/ansible-collections/ibm_zos_core/blob/v1.13.0/CHANGELOG.rst
 .. _1.12.x changelogs:
diff --git a/docs/source/modules/zos_mount.rst b/docs/source/modules/zos_mount.rst
@@ -316,16 +316,16 @@ Examples
        path: /u/omvsadm/core
        fs_type: zfs
        state: unmounted
-       unmount_opts: REMOUNT
-       opts: same
+       unmount_opts: remount
+       mount_opts: same
 
    - name: Mount a filesystem readonly.
      zos_mount:
        src: SOMEUSER.VVV.ZFS
        path: /u/omvsadm/core
        fs_type: zfs
        state: mounted
-       mount_opts: RO
+       mount_opts: ro
 
    - name: Mount a filesystem and record change in BPXPRMAA.
      zos_mount:
@@ -363,23 +363,23 @@ Examples
        path: /u/omvsadm/core
        fs_type: zfs
        state: mounted
-       opts: nowait
+       mount_opts: nowait
 
    - name: Mount a filesystem with no security checks.
      zos_mount:
        src: SOMEUSER.VVV.ZFS
        path: /u/omvsadm/core
        fs_type: zfs
        state: mounted
-       mount_opts: NOSECURITY
+       mount_opts: nosecurity
 
    - name: Mount a filesystem, limiting automove to 4 devices.
      zos_mount:
        src: SOMEUSER.VVV.ZFS
        path: /u/omvsadm/core
        fs_type: zfs
        state: mounted
-       automove: AUTOMOVE
+       automove: automove
        automove_list: I,DEV1,DEV2,DEV3,DEV9
 
    - name: Mount a filesystem, limiting automove to all except 4 devices.
@@ -388,7 +388,7 @@ Examples
        path: /u/omvsadm/core
        fs_type: zfs
        state: mounted
-       automove: AUTOMOVE
+       automove: automove
        automove_list: EXCLUDE,DEV4,DEV5,DEV6,DEV7
 
 
@@ -500,14 +500,14 @@ unmount_opts
 
   | **returned**: changed and if state=unmounted
   | **type**: str
-  | **sample**: DRAIN
+  | **sample**: drain
 
 mount_opts
   Options available to the mount.
 
   | **returned**: whenever non-None
   | **type**: str
-  | **sample**: RW,NOSECURITY
+  | **sample**: rw,nosecurity
 
 src_params
   Specifies a parameter string to be passed to the file system type.
@@ -554,7 +554,7 @@ automove
 
   | **returned**: if Non-None
   | **type**: str
-  | **sample**: AUTOMOVE
+  | **sample**: automove
 
 automove_list
   This specifies the list of servers to include or exclude as destinations.
diff --git a/docs/source/release_notes.rst b/docs/source/release_notes.rst
@@ -6,8 +6,8 @@
 Releases
 ========
 
-Version 1.14.0-beta.1
-=====================
+Version 1.14.0
+==============
 
 Minor Changes
 -------------
@@ -18,6 +18,7 @@ Minor Changes
    - Adds logging of Jinja rendered template content when `use_template` is true and verbosity level `-vvv` is used.
    - Adds support for copying in asynchronous mode inside playbooks.
    - Removes the need to allow READ access to MVS.MCSOPER.ZOAU to execute the module by changing how the module checks if a data set is locked.
+   - Previously, when trying to copy into remote and ansible's default temporary directory was not created before execution the copy task would fail. Fix now creates the temporary directory if possible.
 
 - ``zos_job_output`` - Add execution_time return value in the modules response.
 - ``zos_job_query``
@@ -31,6 +32,7 @@ Minor Changes
    - Adds logging of Jinja rendered template content when `use_template` is true and verbosity level `-vvv` is used.
    - Add execution_time return value in the modules response.
    - Loads correct bytes size value for dds when using zoau 1.3.4 or later.
+   - Previously, the use of `become` would result in a permissions error while trying to execute a job from a local file. Fix now allows a user to escalate privileges when executing a job transferred from the controller node.
 
 - ``zos_script``
 
@@ -70,12 +72,18 @@ New Modules
 Availability
 ------------
 
+* `Ansible Automation Platform`_
 * `Galaxy`_
 * `GitHub`_
 
 Known Issues
 ------------
 - ``zos_copy`` - Copying from a sequential data set that is in use will result in a false positive and destination data set will be empty. The same is true when ``type=gdg`` and source GDS is a sequential data set in use.
+- ``zos_copy`` - When elevating privileges using the `become` keyword, the module would attempt to connect using the elevated user id, if the user cannot connect to the managed node through ssh the module would fail.
+- ``zos_job_submit`` - When elevating privileges using the `become` keyword, the module would attempt to connect using the elevated user id, if the user cannot connect to the managed node through ssh the module would fail.
+- ``zos_script`` - When elevating privileges using the `become` keyword, the module would attempt to connect using the elevated user id, if the user cannot connect to the managed node through ssh the module would fail.
+- ``zos_unarchive`` - When elevating privileges using the `become` keyword, the module would attempt to connect using the elevated user id, if the user cannot connect to the managed node through ssh the module would fail.
+- ``zos_fetch`` - When elevating privileges using the `become` keyword, the module would attempt to connect using the elevated user id, if the user cannot connect to the managed node through ssh the module would fail.
 
 
 
diff --git a/galaxy.yml b/galaxy.yml
@@ -6,7 +6,7 @@ namespace: ibm
 name: ibm_zos_core
 
 # The collection version
-version: "1.14.0-beta.1"
+version: "1.14.0"
 
 # Collection README file
 readme: README.md
diff --git a/meta/ibm_zos_core_meta.yml b/meta/ibm_zos_core_meta.yml
@@ -1,9 +1,9 @@
 name: ibm_zos_core
-version: "1.14.0-beta.1"
+version: "1.14.0"
 managed_requirements:
     -
         name: "IBM Open Enterprise SDK for Python"
-        version: ">=3.11"
+        version: ">=3.12"
     -
         name: "Z Open Automation Utilities"
         version:
diff --git a/plugins/action/zos_copy.py b/plugins/action/zos_copy.py
@@ -155,7 +155,7 @@ def run(self, tmp=None, task_vars=None):
                 try:
                     local_content = _write_content_to_temp_file(content)
                     transfer_res = self._copy_to_remote(
-                        local_content, ignore_stderr=ignore_sftp_stderr
+                        local_content, ignore_stderr=ignore_sftp_stderr, task_vars=task_vars
                     )
                 finally:
                     os.remove(local_content)
@@ -243,7 +243,7 @@ def run(self, tmp=None, task_vars=None):
 
                 display.vvv(u"ibm_zos_copy calculated size: {0}".format(os.stat(src).st_size), host=self._play_context.remote_addr)
                 transfer_res = self._copy_to_remote(
-                    src, is_dir=is_src_dir, ignore_stderr=ignore_sftp_stderr
+                    src, is_dir=is_src_dir, ignore_stderr=ignore_sftp_stderr, task_vars=task_vars
                 )
 
             temp_path = transfer_res.get("temp_path")
@@ -291,7 +291,26 @@ def run(self, tmp=None, task_vars=None):
         # Remove temporary directory from remote
         if self.tmp_dir is not None:
             path = os.path.normpath(f"{self.tmp_dir}/ansible-zos-copy")
-            self._connection.exec_command(f"rm -rf {path}*")
+            # If another user created the temporary files, we'll need to run rm
+            # with it too, lest we get a permissions issue.
+            if self._connection.become:
+                # We get the dirname from temp_path and not path = os.path.normpath(f"{self.tmp_dir}/ansible-zos-copy")
+                # because if default is ~/.ansible/tmp/ when using become it would be similar to /root/.ansible/tmp
+                # but the original tmp directory was resolved when user is non escalated yet. Meaning, the original
+                # tmp directory is similar to /u/usrt001/.ansible/tmp.
+                path = os.path.dirname(temp_path)
+                self._connection.set_option('remote_user', self._play_context._become_user)
+                display.vvv(
+                    u"ibm_zos_copy SSH cleanup user updated to {0}".format(self._play_context._become_user),
+                    host=self._play_context.remote_addr
+                )
+            rm_res = self._connection.exec_command(f"rm -rf {path}*")
+            if self._connection.become:
+                self._connection.set_option('remote_user', self._play_context._remote_user)
+                display.vvv(
+                    u"ibm_zos_copy SSH cleanup user restored to {0}".format(self._play_context._remote_user),
+                    host=self._play_context.remote_addr
+                )
 
         if copy_res.get("note") and not force:
             result["note"] = copy_res.get("note")
@@ -319,18 +338,21 @@ def run(self, tmp=None, task_vars=None):
 
         return copy_res
 
-    def _copy_to_remote(self, src, is_dir=False, ignore_stderr=False):
+    def _copy_to_remote(self, src, is_dir=False, ignore_stderr=False, task_vars=None):
         """Copy a file or directory to the remote z/OS system """
         self.tmp_dir = self._connection._shell._options.get("remote_tmp")
-        rc, stdout, stderr = self._connection.exec_command("cd {0} && pwd".format(self.tmp_dir))
-        if rc > 0:
-            msg = f"Failed to resolve remote temporary directory {self.tmp_dir}. Ensure that the directory exists and user has proper access."
-            return self._exit_action({}, msg, failed=True)
-        self.tmp_dir = stdout.decode("utf-8").replace("\r", "").replace("\n", "")
-        temp_path = os.path.join(self.tmp_dir, _create_temp_path_name(), os.path.basename(src))
-        self._connection.exec_command("mkdir -p {0}".format(os.path.dirname(temp_path)))
-        _src = src.replace("#", "\\#")
+        temp_path = os.path.join(self.tmp_dir, _create_temp_path_name())
+        tempfile_args = {"path": temp_path, "state": "directory", "mode": "666"}
+        # Reverted this back to using file ansible module so ansible would handle all temporary dirs
+        # creation with correct permissions.
+        tempfile = self._execute_module(
+            module_name="file", module_args=tempfile_args, task_vars=task_vars, wrap_async=self._task.async_val
+        )
         _sftp_action = 'put'
+        was_user_updated = False
+
+        temp_path = os.path.join(tempfile.get("path"), os.path.basename(src))
+        _src = src.replace("#", "\\#")
         full_temp_path = temp_path
 
         if is_dir:
@@ -370,6 +392,13 @@ def _copy_to_remote(self, src, is_dir=False, ignore_stderr=False):
                             sftp_transfer_method), host=self._play_context.remote_addr)
 
             display.vvv(u"ibm_zos_copy: {0} {1} TO {2}".format(_sftp_action, _src, temp_path), host=self._play_context.remote_addr)
+            if self._connection.become:
+                was_user_updated = True
+                self._connection.set_option('remote_user', self._play_context._become_user)
+                display.vvv(
+                    u"ibm_zos_copy SSH transfer user updated to {0}".format(self._play_context._become_user),
+                    host=self._play_context.remote_addr
+                )
             (returncode, stdout, stderr) = self._connection._file_transport_command(_src, temp_path, _sftp_action)
 
             display.vvv(u"ibm_zos_copy return code: {0}".format(returncode), host=self._play_context.remote_addr)
@@ -400,7 +429,7 @@ def _copy_to_remote(self, src, is_dir=False, ignore_stderr=False):
 
             if returncode != 0 or (err and not ignore_stderr):
                 return dict(
-                    msg="Error transfering source '{0}' to remote z/OS system".format(src),
+                    msg="Error transferring source '{0}' to remote z/OS system".format(src),
                     rc=returncode,
                     stderr=err,
                     stderr_lines=err.splitlines(),
@@ -409,6 +438,12 @@ def _copy_to_remote(self, src, is_dir=False, ignore_stderr=False):
 
         finally:
             # Restore the users defined option `ssh_transfer_method` if it was overridden
+            if was_user_updated:
+                self._connection.set_option('remote_user', self._play_context._remote_user)
+                display.vvv(
+                    u"ibm_zos_copy SSH transfer user restored to {0}".format(self._play_context._remote_user),
+                    host=self._play_context.remote_addr
+                )
 
             if is_ssh_transfer_method_updated:
                 if version_major == 2 and version_minor >= 11:
diff --git a/plugins/action/zos_job_submit.py b/plugins/action/zos_job_submit.py
diff --git a/plugins/module_utils/data_set.py b/plugins/module_utils/data_set.py
diff --git a/tests/functional/modules/test_zos_copy_func.py b/tests/functional/modules/test_zos_copy_func.py

Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,9 @@`
`1`	`1`	`name: ibm_zos_core`
`2`		`-version: "1.14.0-beta.1"`
	`2`	`+version: "1.14.0"`
`3`	`3`	`managed_requirements:`
`4`	`4`	`-`
`5`	`5`	`name: "IBM Open Enterprise SDK for Python"`
`6`		`- version: ">=3.11"`
	`6`	`+ version: ">=3.12"`
`7`	`7`	`-`
`8`	`8`	`name: "Z Open Automation Utilities"`
`9`	`9`	`version:`