Adding test case to test working of tmp_hlq in zos_backup_restore (#2135)

* adding test case for tmp_hlq

* changelog addition and testing

* test changes

* testing with 2.16

* testing with managed user

* checking with updated users.py

* adding changes for to check test failure.

* modifying the ret condition

Author: Rohitcodes28

changelogs/fragments/2135-Test_case_to_check_tmphlq_zos_backup_restore.yml

@@ -0,0 +1,3 @@
+trivial:
+  - test_zos_backup_restore - Added a test case to ensure tmphlq is tested in the module.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/2135).

tests/functional/modules/test_zos_backup_restore.py

@@ -15,6 +15,7 @@
 
 __metaclass__ = type
 
+from ibm_zos_core.tests.helpers.users import ManagedUserType, ManagedUser
 from ibm_zos_core.tests.helpers.dataset import (
     get_tmp_ds_name,
     get_random_q,
@@ -1019,3 +1020,121 @@ def test_backup_tolerate_enqueue(ansible_zos_module):
         hosts.all.shell(cmd=f"kill 9 {pid.strip()}")
         hosts.all.shell(cmd='rm -r {0}'.format(temp_file))
         hosts.all.shell(cmd=f"drm ANSIBLE.* ")
+
+
+@pytest.mark.parametrize(
+    "backup_name,overwrite,recover",
+    [
+        ("DATA_SET", True, True)
+    ],
+)
+def test_backup_and_restore_of_data_set_tmphlq(
+    ansible_zos_module, backup_name, overwrite, recover
+):
+    hlqs = []
+    hosts = ansible_zos_module
+    data_set_name = get_tmp_ds_name()
+    new_hlq  = "N" + get_random_q(4)
+    hlqs.append(new_hlq)
+    if backup_name == "DATA_SET":
+        backup_name = get_tmp_ds_name(1,1)
+    else:
+        backup_name = get_random_file_name(dir=TMP_DIRECTORY, prefix='.dzp')
+    try:
+        delete_data_set_or_file(hosts, data_set_name)
+        delete_data_set_or_file(hosts, backup_name)
+        create_sequential_data_set_with_contents(
+            hosts, data_set_name, DATA_SET_CONTENTS
+        )
+        results = hosts.all.zos_backup_restore(
+            operation="backup",
+            data_sets=dict(include=data_set_name),
+            backup_name=backup_name,
+            overwrite=overwrite,
+            tmp_hlq="TMPHLQ",
+            recover=recover,
+        )
+        assert_module_did_not_fail(results)
+        # NEW: Assert backup_name appears in output
+        for result in results.contacted.values():
+            assert result.get("backup_name") == backup_name, \
+                f"Backup name '{backup_name}' not found in output"
+        # Verify backup file/dataset exists
+        assert_data_set_or_file_exists(hosts, backup_name)
+        if not overwrite:
+            new_hlq = "N" + get_random_q(4)
+            hlqs.append(new_hlq)
+        assert_module_did_not_fail(results)
+        assert_data_set_or_file_exists(hosts, backup_name)
+        results = hosts.all.zos_backup_restore(
+            operation="restore",
+            backup_name=backup_name,
+            hlq=new_hlq,
+            overwrite=overwrite,
+            tmp_hlq="TMPHLQ",
+        )
+        assert_module_did_not_fail(results)
+        for result in results.contacted.values():
+            assert result.get("backup_name") == backup_name, \
+                "Backup name '{backup_name}' not found in restore output"
+    finally:
+        delete_data_set_or_file(hosts, data_set_name)
+        delete_data_set_or_file(hosts, backup_name)
+        delete_remnants(hosts, hlqs)
+
+def test_list_cat_for_existing_data_set_with_tmp_hlq_option_restricted_user(ansible_zos_module, z_python_interpreter):
+    """
+    This tests the error message when a user cannot create data sets with a given HLQ.
+    """
+    managed_user = None
+    managed_user_test_case_name = "managed_user_backup_of_data_set_tmphlq_restricted_user"
+    try:
+        # Initialize the Managed user API from the pytest fixture.
+        managed_user = ManagedUser.from_fixture(ansible_zos_module, z_python_interpreter)
+
+        # Important: Execute the test case with the managed users execution utility.
+        managed_user.execute_managed_user_test(
+            managed_user_test_case = managed_user_test_case_name, debug = True,
+            verbose = True, managed_user_type=ManagedUserType.ZOS_LIMITED_HLQ)
+
+    finally:
+        # Delete the managed user on the remote host to avoid proliferation of users.
+        managed_user.delete_managed_user()
+
+def managed_user_backup_of_data_set_tmphlq_restricted_user(ansible_zos_module):
+    backup_name = "DATA_SET"
+    overwrite = True
+    recover  = True
+    hlqs = []
+    hosts = ansible_zos_module
+    data_set_name = get_tmp_ds_name()
+    new_hlq  = "N" + get_random_q(4)
+    hlqs.append(new_hlq)
+    tmphlq = "NOPERMIT"
+    if backup_name == "DATA_SET":
+        backup_name = get_tmp_ds_name(1,1)
+    try:
+        delete_data_set_or_file(hosts, data_set_name)
+        delete_data_set_or_file(hosts, backup_name)
+        create_sequential_data_set_with_contents(
+            hosts, data_set_name, DATA_SET_CONTENTS
+        )
+        results = hosts.all.zos_backup_restore(
+            operation="backup",
+            data_sets=dict(include=data_set_name),
+            backup_name=backup_name,
+            overwrite=overwrite,
+            tmp_hlq=tmphlq,
+            recover=recover,
+        )
+        # NEW: Assert backup_name appears in output
+        for result in results.contacted.values():
+            assert result.get("backup_name") == '', \
+                f"Backup name '{backup_name}' is there in output so tmphlq failed."
+            print(result)
+            assert result.get("changed", False) is False
+            
+    finally:
+        delete_data_set_or_file(hosts, data_set_name)
+        delete_data_set_or_file(hosts, backup_name)
+        delete_remnants(hosts, hlqs)