[enabler] [1378] [zos_mount] special charactersupport (#1631)

* initial commit to get pr number

* updated pr number, added innersource references to zos_mount

* added dataset class to enable escape function

* added a series of symbols to test-aggregate file creation
This should test all scenarios for all 4 characters.

* added escape call on generated data set name

* trying to return base/non-escaped string to pass into mount.
working around a better-arg-parser error.

* added pretty print to test output to check on remount pre-test

* corrected pretty print call

* expanding display of results to first mount and unmount.

* it looks like the test assumes absent=unmounted, which is not always true
I'm switching prior testst absent->unmounted, to see if that moves the issue.

* found issue where 'absent' did not delete the aggregate
set tests back to use absent, and left print/pp in

* changing test/create source file

* removing sybols in test to see if the mount still has issues.

* expanding output of pre-process files

* removed escape function from main zos_mount
in one or more of the calls, it is interfering with tso command generation

* adding delete into end of first test.

* changed dataset.delete to shell drm in first test

* corrected ALL tests to use shell/drm to make sure system stays cleaned up

* added symbols in test

* the shell delete required the dsname to be escaped, while mount did not
All mount tests now escape dsname for removal

* cleanup of test output messages
cleanup of escape calls in zos_mount

* removed unused import in mount.  Updated text in the changelog.

* removed unused 'innersource' variables from mount routine, since they were
no longer needed.

* removed self-reference of src=src, cause when removing innersrc

* renamed fragment to contain PR#

Author: richp405

changelogs/fragments/1631-enabler-zos_mount-special-character-support.yml

@@ -0,0 +1,4 @@
+minor_changes:
+  - zos_mount - Added support for data set names with special characters ($, /#, /- and @).
+    This is for both src and backup data set names.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1631).

plugins/modules/zos_mount.py

@@ -546,9 +546,7 @@
     better_arg_parser,
     data_set,
     backup as Backup,
-
 )
-
 from ansible_collections.ibm.ibm_zos_core.plugins.module_utils.copy import (
     copy_ps2uss,
     copy_uss2mvs,
@@ -740,6 +738,7 @@ def run_module(module, arg_def):
     res_args = dict()
 
     src = parsed_args.get("src")
+
     path = parsed_args.get("path")
     fs_type = parsed_args.get("fs_type").upper()
     state = parsed_args.get("state")

tests/functional/modules/test_zos_mount_func.py

@@ -11,7 +11,9 @@
 
 from ibm_zos_core.tests.helpers.volumes import Volume_Handler
 from ibm_zos_core.tests.helpers.dataset import get_tmp_ds_name
-
+from ansible_collections.ibm.ibm_zos_core.plugins.module_utils.data_set import (
+    DataSet,
+)
 
 INITIAL_PRM_MEMBER = """/* Initial file to look like BPXPRM */
 /* some settings at the top */
@@ -29,7 +31,6 @@
       AUTOMOVE
 """
 
-# SHELL_EXECUTABLE = "/usr/lpp/rsusr/ported/bin/bash"
 SHELL_EXECUTABLE = "/bin/sh"
 
 
@@ -57,29 +58,34 @@ def populate_tmpfile():
 
 
 def create_sourcefile(hosts, volume):
+    # returns un-escaped source file name, but uses escaped file name for shell commands
+    # this is intentionally done to test escaping of data set names
     starter = get_sysname(hosts).split(".")[0].upper()
     if len(starter) < 2:
         starter = "IMSTESTU"
-    thisfile = starter + ".TTT.MNT.ZFS"
+    basefile = starter + ".A@$#TO.MNT.ZFS"
+    thisfile = DataSet.escape_data_set_name(basefile)
     print(
-        "csf: starter={0} thisfile={1} is type {2}".format(
+        "\ncsf: starter={0} thisfile={1} is type {2}".format(
             starter, thisfile, str(type(thisfile))
         )
     )
 
-    hosts.all.shell(
+    mount_result = hosts.all.shell(
         cmd="zfsadm define -aggregate "
         + thisfile
         + " -volumes {0} -cylinders 200 1".format(volume),
         executable=SHELL_EXECUTABLE,
         stdin="",
     )
-    hosts.all.shell(
+
+    mount_result = hosts.all.shell(
         cmd="zfsadm format -aggregate " + thisfile,
         executable=SHELL_EXECUTABLE,
         stdin="",
     )
-    return thisfile
+
+    return basefile
 
 
 def test_basic_mount(ansible_zos_module, volumes_on_systems):
@@ -102,8 +108,13 @@ def test_basic_mount(ansible_zos_module, volumes_on_systems):
             fs_type="zfs",
             state="absent",
         )
-        hosts.all.file(path="/pythonx/", state="absent")
+        hosts.all.shell(
+            cmd="drm " + DataSet.escape_data_set_name(srcfn),
+            executable=SHELL_EXECUTABLE,
+            stdin="",
+        )
 
+        hosts.all.file(path="/pythonx/", state="absent")
 
 
 def test_double_mount(ansible_zos_module, volumes_on_systems):
@@ -128,6 +139,12 @@ def test_double_mount(ansible_zos_module, volumes_on_systems):
             fs_type="zfs",
             state="absent",
         )
+        hosts.all.shell(
+            cmd="drm " + DataSet.escape_data_set_name(srcfn),
+            executable=SHELL_EXECUTABLE,
+            stdin="",
+        )
+
         hosts.all.file(path="/pythonx/", state="absent")
 
 
@@ -137,20 +154,29 @@ def test_remount(ansible_zos_module, volumes_on_systems):
     volume_1 = volumes.get_available_vol()
     srcfn = create_sourcefile(hosts, volume_1)
     try:
+        mount_results = hosts.all.zos_mount(src=srcfn, path="/pythonx", fs_type="zfs", state="mounted")
+
         hosts.all.zos_mount(src=srcfn, path="/pythonx", fs_type="zfs", state="mounted")
+
         mount_result = hosts.all.zos_mount(
             src=srcfn, path="/pythonx", fs_type="zfs", state="remounted"
         )
         for result in mount_result.values():
             assert result.get("rc") == 0
             assert result.get("changed") is True
     finally:
-        hosts.all.zos_mount(
+        mount_result = hosts.all.zos_mount(
             src=srcfn,
             path="/pythonx",
             fs_type="zfs",
             state="absent",
         )
+        hosts.all.shell(
+            cmd="drm " + DataSet.escape_data_set_name(srcfn),
+            executable=SHELL_EXECUTABLE,
+            stdin="",
+        )
+
         hosts.all.file(path="/pythonx/", state="absent")
 
 
@@ -212,6 +238,11 @@ def test_basic_mount_with_bpx_nocomment_nobackup(ansible_zos_module, volumes_on_
             fs_type="zfs",
             state="absent",
         )
+        hosts.all.shell(
+            cmd="drm " + DataSet.escape_data_set_name(srcfn),
+            executable=SHELL_EXECUTABLE,
+            stdin="",
+        )
         hosts.all.file(path=tmp_file_filename, state="absent")
         hosts.all.file(path="/pythonx/", state="absent")
         hosts.all.zos_data_set(
@@ -329,6 +360,12 @@ def test_basic_mount_with_bpx_comment_backup(ansible_zos_module, volumes_on_syst
             fs_type="zfs",
             state="absent",
         )
+        hosts.all.shell(
+            cmd="drm " + DataSet.escape_data_set_name(srcfn),
+            executable=SHELL_EXECUTABLE,
+            stdin="",
+        )
+
         hosts.all.file(path=tmp_file_filename, state="absent")
         hosts.all.file(path=test_tmp_file_filename, state="absent")
         hosts.all.file(path="/pythonx/", state="absent")
@@ -367,6 +404,12 @@ def test_basic_mount_with_tmp_hlq_option(ansible_zos_module, volumes_on_systems)
             tmp_hlq=tmphlq,
             persistent=dict(data_store=persist_data_set, backup=True)
         )
+        hosts.all.shell(
+            cmd="drm " + DataSet.escape_data_set_name(srcfn),
+            executable=SHELL_EXECUTABLE,
+            stdin="",
+        )
+
         hosts.all.zos_data_set(name=persist_data_set, state="absent")
         for result in unmount_result.values():
             assert result.get("rc") == 0