Merge branch 'dev' into bug/1940/mount_handle_fsumf168

Author: richp405

changelogs/fragments/2030-Set_dynamic_volumes_for_volume_init.yml

@@ -0,0 +1,3 @@
+trivial:
+  - test_zos_volume_init.py - Adds support dynamic volumes and allocations for testing.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2030).

changelogs/fragments/2057-zos_data_set&data_set-Ensure-Dataset-Volume-Validation.yml

@@ -0,0 +1,15 @@
+bugfixes:
+   - zos_data_set - Attempting to create a data set with the same name on a 
+     different volume did not work, nor did it report a failure. 
+     The fix now informs the user that if the data set is cataloged on a 
+     different volume, it needs to be uncataloged before using the data 
+     set module to create a new data set on a different volume.
+     (https://github.com/ansible-collections/ibm_zos_core/pull/2057).
+trivial:     
+   - data_set - added validation logic to compare requested volumes against
+     cataloged volumes.
+     Improved error messaging when volume conflicts occur during data set creation on
+     different volume.
+     (https://github.com/ansible-collections/ibm_zos_core/pull/2057).
+   - zos_data_set - Added documentation about potential false positive scenarios.
+     (https://github.com/ansible-collections/ibm_zos_core/pull/2057).

plugins/module_utils/data_set.py

@@ -203,6 +203,19 @@ def ensure_present(
         changed = False
         if DataSet.data_set_cataloged(name, tmphlq=tmp_hlq):
             present = True
+        # Validate volume conflicts when:
+        # 1. Dataset exists in catalog (present=True).
+        # 2. User hasn't requested replacement (replace=False).
+        # 3. Specific volumes were requested (volumes parameter provided).
+        if present and not replace and volumes:
+            cataloged_volumes = DataSet.data_set_cataloged_volume_list(name, tmphlq=tmp_hlq)
+            requested_volumes = [vol.upper() for vol in volumes]
+            if not any(vol.upper() in requested_volumes for vol in cataloged_volumes):
+                raise DatasetCatalogedOnDifferentVolumeError(
+                    name=name,
+                    existing_volumes=cataloged_volumes,
+                    requested_volumes=volumes
+                )
 
         if not present:
             try:
@@ -3121,6 +3134,17 @@ def __init__(self, data_set, volumes, rc, message=""):
         super().__init__(self.msg)
 
 
+class DatasetCatalogedOnDifferentVolumeError(Exception):
+    def __init__(self, name, existing_volumes, requested_volumes):
+        existing_vol_str = ", ".join(existing_volumes) if existing_volumes else "none"
+        requested_vol_str = ", ".join(requested_volumes) if requested_volumes else "none"
+        self.msg = (
+            "Data set {0} is cataloged with volume {1}, if you want to create data set {0} "
+            "in volume {2} uncatalog the data set first and then create it."
+        ).format(name, existing_vol_str, requested_vol_str)
+        super().__init__(self.msg)
+
+
 class DatasetUncatalogError(Exception):
     def __init__(self, data_set, rc):
         """Error during uncaloging of a data set.

plugins/modules/zos_data_set.py

@@ -104,6 +104,16 @@
       - >
         If I(state=uncataloged) and the data set is found, the data set is uncataloged,
         module completes successfully with I(changed=True).
+      - >
+        If I(state=present), the data set is already cataloged and I(volumes) is provided,
+        the module will compare the volumes where it is cataloged against the provided I(volumes).
+        If they don't match, the module will fail with an error indicating the data set is cataloged
+        on a different volume.
+        To resolve this, you must first uncatalog the data set before creating it on the new volume.
+      - >
+        If I(state=present), the data set is already cataloged, I(volumes) is provided,
+        and the volumes match exactly, no action is taken and the module completes successfully
+        with I(changed=False).
     required: false
     type: str
     default: present
@@ -1905,18 +1915,18 @@ def run_module():
             for data_set_params in data_set_param_list:
                 # this returns MVSDataSet, Member or GenerationDataGroup
                 data_set = get_data_set_handler(**data_set_params)
-                result["changed"] = perform_data_set_operations(
+                current_changed = perform_data_set_operations(
                     data_set=data_set,
                     state=data_set_params.get("state"),
                     replace=data_set_params.get("replace"),
                     tmp_hlq=data_set_params.get("tmp_hlq"),
                     force=data_set_params.get("force"),
-                ) or result.get("changed", False)
+                )
+                result["changed"] = result["changed"] or current_changed
         except Exception as e:
             module.fail_json(msg=repr(e), **result)
-    else:
-        if module.params.get("replace"):
-            result["changed"] = True
+    if module.params.get("replace"):
+        result["changed"] = True
     module.exit_json(**result)
 
 

tests/conftest.py

@@ -14,7 +14,7 @@
 __metaclass__ = type
 import pytest
 from ibm_zos_core.tests.helpers.ztest import ZTestHelper
-from ibm_zos_core.tests.helpers.volumes import get_volumes, get_volumes_with_vvds
+from ibm_zos_core.tests.helpers.volumes import get_volumes, get_volumes_with_vvds, get_volume_and_unit
 from ansible.plugins.action import ActionBase
 import sys
 from mock import MagicMock
@@ -158,6 +158,20 @@ def volumes_with_vvds(ansible_zos_module, request):
     yield volumes_with_vvds
 
 
+@pytest.fixture(scope="session")
+def volumes_unit_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 = None
+
+    if path is None:
+        src = request.config.getoption("--zinventory-raw")
+        helper = ZTestHelper.from_args(src)
+        list_volumes = helper.get_volume_and_unit()
+    else:
+        list_volumes = get_volume_and_unit(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

tests/functional/modules/test_zos_data_set_func.py

@@ -751,7 +751,6 @@ def test_multi_volume_creation_uncatalog_and_catalog_nonvsam(ansible_zos_module,
     finally:
         hosts.all.zos_data_set(name=default_data_set_name, state="absent")
 
-
 def test_multi_volume_creation_uncatalog_and_catalog_vsam(ansible_zos_module, volumes_on_systems):
     volumes = Volume_Handler(volumes_on_systems)
     volume_1 = volumes.get_available_vol()
@@ -789,6 +788,36 @@ def test_multi_volume_creation_uncatalog_and_catalog_vsam(ansible_zos_module, vo
     finally:
         hosts.all.zos_data_set(name=default_data_set_name, state="absent")
 
+def test_creation_conflict_same_name_diff_volume(ansible_zos_module, volumes_on_systems):
+    volumes = Volume_Handler(volumes_on_systems)
+    volume_1 = volumes.get_available_vol()
+    volume_2 = volumes.get_available_vol()
+    assert volume_1 != volume_2, "Need two different volumes for this test"
+
+    hosts = ansible_zos_module
+    data_set_name = get_tmp_ds_name()
+    try:
+        # Step 1: Create PDS on volume_1
+        results = hosts.all.zos_data_set(
+            name=data_set_name,
+            state="present",
+            type="pds",
+            volumes=[volume_1]
+        )
+        for result in results.contacted.values():
+            assert result.get("changed") is True
+        results = hosts.all.zos_data_set(
+            name=data_set_name,
+            state="present",
+            type="pds",
+            volumes=[volume_2]
+        )
+        for result in results.contacted.values():
+            assert result.get("failed") is True
+            assert "datasetcatalogedondifferentvolumeerror" in result.get("msg", "").lower()
+    finally:
+        # Cleanup
+        hosts.all.zos_data_set(name=data_set_name, state="absent")
 
 def test_data_set_temp_data_set_name(ansible_zos_module):
     try: