[bug][zos_fetch]Handle_relative_path (#1769)

* Handle relative path

* Add fragment

* Fix module mvs_raw test case

* Restore

* Fix paths for fetch

* Fix paths for fetch

* Fix unarchive

* Fix fetch handle paths

* Fix declaration

* Fix error handle relative paths

* Final solution

* Update changelogs/fragments/1769_handle_relative_path.yml

Co-authored-by: Fernando Flores <[email protected]>

* Update changelogs/fragments/1769_handle_relative_path.yml

Co-authored-by: Fernando Flores <[email protected]>

* Update zos_fetch.py

* Fix lint

* Add flake8 and bug fix venv in the AC tool. (#1784)

* Update venv.sh to add a custom galaxy config to enable flake8

Signed-off-by: ddimatos <[email protected]>

* update galaxy config with comments

Signed-off-by: ddimatos <[email protected]>

* Update ac export var for galaxy config

Signed-off-by: ddimatos <[email protected]>

* Update ac so that a venv will find the locally venv installed collection

Signed-off-by: ddimatos <[email protected]>

* fragment added

Signed-off-by: ddimatos <[email protected]>

* Change flake8 design

Signed-off-by: ddimatos <[email protected]>

* change flake8 design

Signed-off-by: ddimatos <[email protected]>

---------

Signed-off-by: ddimatos <[email protected]>

* Add test case

* Fix tmp dest

* Fix test

* Fix fetch

* Fix fetch

* Fix test case

* Fix test case

* Add all relative paths

* Add last test for relative

* Add last test for relative

* Fix tilde

* Fix tilde

* Fix tilde

* Fix tilde

* Add comments

* Update tests/functional/modules/test_zos_fetch_func.py

* Update tests/functional/modules/test_zos_fetch_func.py

---------

Signed-off-by: ddimatos <[email protected]>
Co-authored-by: Fernando Flores <[email protected]>
Co-authored-by: Demetri <[email protected]>

Author: 3 people

changelogs/fragments/1769_handle_relative_path.yml

@@ -0,0 +1,4 @@
+bugfixes:
+  - zos_fetch - Some relative paths were not accepted as a parameter e.g. C(files/fetched_file).
+    Change now allows the user to use different types of relative paths as a parameter.
+    (https://github.com/ansible-collections/ibm_zos_core/pull/1769).

plugins/action/zos_fetch.py

@@ -157,10 +157,19 @@ def run(self, tmp=None, task_vars=None):
         src = self._connection._shell.join_path(src)
         src = self._remote_expand_user(src)
 
+        # To manage relative paths we verify and add the current directory
+        # Required to be cast to str
+        if not (dest.startswith("/")):
+            if dest.startswith("~"):
+                dest = os.path.expanduser(dest)
+            dest = os.path.realpath(dest)
+            dest = os.path.join(os.getcwd(), dest)
+            dest = f"{dest}/" if os.path.isdir(dest) else str(dest)
         # ********************************************************** #
         #                Execute module on remote host               #
         # ********************************************************** #
         new_module_args = self._task.args.copy()
+        new_module_args.update(dest=dest)
         encoding_to = None
         if encoding:
             encoding_to = encoding.get("to", None)

tests/functional/modules/test_zos_fetch_func.py

@@ -939,3 +939,47 @@ def test_fetch_gdg(ansible_zos_module):
 
         if os.path.exists(dest_path):
             shutil.rmtree(dest_path)
+
+
+@pytest.mark.parametrize("relative_path", ["tmp/", ".", "../tmp/", "~/tmp/"])
+def test_fetch_uss_file_relative_path_not_present_on_local_machine(ansible_zos_module, relative_path):
+    hosts = ansible_zos_module
+    current_working_directory = os.getcwd()
+    src = "/etc/profile"
+
+    # If the test suite is running on root to avoid an issue we check the current directory
+    # Also, user can run the tests from ibm_zos_core or tests folder, so this will give us the absolute path of our working dir.
+    if relative_path == "../tmp/":
+        aux = os.path.basename(os.path.normpath(current_working_directory))
+        relative_path = "../" + aux + "/tmp/"
+
+    params = {
+        "src": src,
+        "dest": relative_path,
+        "flat":True
+    }
+
+    # Case to create the dest path to verify allow running on any path.
+    # There are some relative paths for which we need to change our cwd to be able to validate that
+    # the path returned by the module is correct.
+    if relative_path == "~/tmp/":
+        dest = os.path.expanduser("~")
+        dest = dest + "/tmp"
+    elif relative_path == ".":
+        dest = current_working_directory + "/profile"
+    else:
+        dest = current_working_directory + "/tmp"
+
+    try:
+        results = hosts.all.zos_fetch(**params)
+
+        for result in results.contacted.values():
+            assert result.get("changed") is True
+            assert result.get("data_set_type") == "USS"
+            assert result.get("module_stderr") is None
+            assert dest == result.get("dest")
+            dest = result.get("dest")
+
+    finally:
+        if os.path.exists(dest):
+            os.remove(dest)