Cherry picked removed hard coded content from staging-v1.9.0-beta.1

Added preferred volumes changes

[v1.10.0] [zos_copy] Enhance zos_copy performance when copying multiple PDS members  (#1183)

* [v1.9.0] [zos_copy] Enhancement/764/copy members (#1176)

* Changed member copy into a bulk call

* Modified copy to members

* Cleaned code

* Removed hardcoded content from zos_copy tests

* Added fix for uss files

* Added distinction between uss and mvs

* Added alias fix

* Moved the copy section to below

* Modified for seq test

* Added fix for copy dest lock

* Added msgs for debugging

* Added final changes to member copy

* Added copy for when seq to pdse

* Add changelog

* Added a line into docs

* Modified doc

* Modified doc

* Update changelog

* Created a new changelog

* Corrected typo

Fix for empty volumes on test_config

Added comment to remind uncomment test case in the future

Add more validation

Add more validation

Add more validation

Add to config volumes and remove upper case variable name

Author: fernandofloresg

changelogs/fragments/1183-copy-members.yml

@@ -0,0 +1,3 @@
+minor_changes:
+  - zos_copy - Improve zos_copy performance when copying multiple members from one PDS/E to another.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1183).

plugins/modules/zos_copy.py

@@ -1,7 +1,7 @@
 #!/usr/bin/python
 # -*- coding: utf-8 -*-
 
-# Copyright (c) IBM Corporation 2019 - 2023
+# Copyright (c) IBM Corporation 2019 - 2024
 # 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
@@ -283,6 +283,8 @@
       - If C(src) is a directory and ends with "/", the contents of it will be copied
         into the root of C(dest). If it doesn't end with "/", the directory itself
         will be copied.
+      - If C(src) is a directory or a file, file names will be truncated and/or modified
+        to ensure a valid name for a data set or member.
       - If C(src) is a VSAM data set, C(dest) must also be a VSAM.
       - Wildcards can be used to copy multiple PDS/PDSE members to another
         PDS/PDSE.
@@ -1705,33 +1707,56 @@ def copy_to_pdse(
         existing_members = datasets.list_members(dest)  # fyi - this list includes aliases
         overwritten_members = []
         new_members = []
+        bulk_src_members = ""
+        result = dict()
 
         for src_member, destination_member in zip(src_members, dest_members):
             if destination_member in existing_members:
                 overwritten_members.append(destination_member)
             else:
                 new_members.append(destination_member)
-
+            bulk_src_members += "{0} ".format(src_member)
+
+        # Copy section
+        if src_ds_type == "USS" or self.asa_text or len(src_members) == 1:
+            """
+            USS -> MVS : Was kept on member by member basis bc file names longer than 8
+            characters will throw an error when copying to a PDS, because of the member name
+            character limit.
+            MVS -> MVS (asa only): This has to be copied on member by member basis bc OPUT
+            does not allow for bulk member copy or entire PDS to PDS copy.
+            """
+            for src_member, destination_member in zip(src_members, dest_members):
+                result = self.copy_to_member(
+                    src_member,
+                    "{0}({1})".format(dest, destination_member),
+                    src_ds_type
+                )
+        else:
+            """
+            MVS -> MVS
+            Copies a list of members into a PDS, using this list of members greatly
+            enhances performance of datasets_copy.
+            """
             result = self.copy_to_member(
-                src_member,
-                "{0}({1})".format(dest, destination_member),
+                bulk_src_members,
+                dest,
                 src_ds_type
             )
 
-            if result["rc"] != 0:
-                msg = "Unable to copy source {0} to data set member {1}({2})".format(
-                    new_src,
-                    dest,
-                    destination_member
-                )
-                raise CopyOperationError(
-                    msg=msg,
-                    rc=result["rc"],
-                    stdout=result["out"],
-                    stderr=result["err"],
-                    overwritten_members=overwritten_members,
-                    new_members=new_members
-                )
+        if result["rc"] != 0:
+            msg = "Unable to copy source {0} to {1}.".format(
+                new_src,
+                dest
+            )
+            raise CopyOperationError(
+                msg=msg,
+                rc=result["rc"],
+                stdout=result["out"],
+                stderr=result["err"],
+                overwritten_members=overwritten_members,
+                new_members=new_members
+            )
 
     def copy_to_member(
         self,

tests/conftest.py

@@ -12,9 +12,9 @@
 from __future__ import absolute_import, division, print_function
 
 __metaclass__ = type
-
 import pytest
 from ibm_zos_core.tests.helpers.ztest import ZTestHelper
+from ibm_zos_core.tests.helpers.volumes import get_volumes
 import sys
 from mock import MagicMock
 import importlib
@@ -84,6 +84,14 @@ def ansible_zos_module(request, z_python_interpreter):
     except Exception:
         pass
 
+    # Call of the class by the class ls_Volume (volumes.py file) as many times needed
+    # one time the array is filled
+@pytest.fixture(scope="session")
+def volumes_on_systems(ansible_zos_module, request):
+    """ Call the pytest-ansible plugin to check volumes on the system and work properly a list by session."""
+    path = request.config.getoption("--zinventory")
+    list_Volumes = get_volumes(ansible_zos_module, path)
+    yield list_Volumes
 
 # * We no longer edit sys.modules directly to add zoautil_py mock
 # * because automatic teardown is not performed, leading to mock pollution
@@ -108,4 +116,4 @@ def perform_imports(imports):
             newimp = [importlib.import_module(x) for x in imports]
         return newimp
 
-    yield (mocker, perform_imports)
+    yield (mocker, perform_imports)