Merged PR 291029: Automatically launch server on docker and run tests on it

Related work items: #577200

# Conflicts:
#	tests/test_operator.py

Author: cbellot000

ansys/dpf/core/__init__.py

@@ -71,28 +71,19 @@
 
 # Setup data directory
 USER_DATA_PATH = None
-EXAMPLES_PATH = None
-if os.environ.get("DPF_DOCKER", False):  # pragma: no cover
-    # Running DPF within docker (likely for CI)
-    # path must be relative to DPF directory
-    #
-    # assumes the following docker mount:
-    # -v /tmp:/dpf/_cache
-    EXAMPLES_PATH = "/tmp"
-else:
-    try:
-        import appdirs
+LOCAL_DOWNLOADED_EXAMPLES_PATH = None
+try:
+    import appdirs
 
-        USER_DATA_PATH = appdirs.user_data_dir("ansys-dpf-core")
-        if not os.path.exists(USER_DATA_PATH):  # pragma: no cover
-            os.makedirs(USER_DATA_PATH)
-
-        EXAMPLES_PATH = os.path.join(USER_DATA_PATH, "examples")
-        if not os.path.exists(EXAMPLES_PATH):  # pragma: no cover
-            os.makedirs(EXAMPLES_PATH)
-    except:  # pragma: no cover
-        pass
+    USER_DATA_PATH = appdirs.user_data_dir("ansys-dpf-core")
+    if not os.path.exists(USER_DATA_PATH):  # pragma: no cover
+        os.makedirs(USER_DATA_PATH)
 
+    LOCAL_DOWNLOADED_EXAMPLES_PATH = os.path.join(USER_DATA_PATH, "examples")
+    if not os.path.exists(LOCAL_DOWNLOADED_EXAMPLES_PATH):  # pragma: no cover
+        os.makedirs(LOCAL_DOWNLOADED_EXAMPLES_PATH)
+except:  # pragma: no cover
+    pass
 
 SERVER = None
 

ansys/dpf/core/examples/downloads.py

@@ -3,15 +3,15 @@
 import os
 import urllib.request
 
-from ansys.dpf.core import EXAMPLES_PATH
 
 EXAMPLE_REPO = "https://github.com/pyansys/example-data/raw/master/result_files/"
 
 
 def delete_downloads():
     """Delete all downloaded examples to free space or update the files"""
-    shutil.rmtree(EXAMPLES_PATH)
-    os.makedirs(EXAMPLES_PATH)
+    from ansys.dpf.core import LOCAL_DOWNLOADED_EXAMPLES_PATH
+    shutil.rmtree(LOCAL_DOWNLOADED_EXAMPLES_PATH)
+    os.makedirs(LOCAL_DOWNLOADED_EXAMPLES_PATH)
 
 
 def _get_file_url(directory, filename):
@@ -20,11 +20,15 @@ def _get_file_url(directory, filename):
 
 def _retrieve_file(url, filename, directory):
     """Download a file from a url"""
+    from ansys.dpf.core import LOCAL_DOWNLOADED_EXAMPLES_PATH, path_utilities
+
     # First check if file has already been downloaded
-    local_path = os.path.join(EXAMPLES_PATH, directory, os.path.basename(filename))
+    local_path = os.path.join(LOCAL_DOWNLOADED_EXAMPLES_PATH, directory, os.path.basename(filename))
     local_path_no_zip = local_path.replace(".zip", "")
     if os.path.isfile(local_path_no_zip) or os.path.isdir(local_path_no_zip):
-        return local_path_no_zip
+        return path_utilities.to_server_os(local_path_no_zip.replace(
+            LOCAL_DOWNLOADED_EXAMPLES_PATH,
+            path_utilities.downloaded_example_path()))
 
     # grab the correct url retriever
     urlretrieve = urllib.request.urlretrieve
@@ -35,21 +39,14 @@ def _retrieve_file(url, filename, directory):
 
     # Perform download
     _, resp = urlretrieve(url, local_path)
-    return local_path
+    return path_utilities.to_server_os(local_path.replace(
+        LOCAL_DOWNLOADED_EXAMPLES_PATH,
+        path_utilities.downloaded_example_path()))
 
 
 def _download_file(directory, filename):
     url = _get_file_url(directory, filename)
     local_path = _retrieve_file(url, filename, directory)
-
-    if os.environ.get("DPF_DOCKER", False):  # pragma: no cover
-        # override path if running on docker as path must be relative
-        # to docker mount
-        #
-        # Assumes the following mapping in docker
-        # DWN_CSH=/tmp/dpf_cache
-        # -v $DWN_CSH:/dpf/_cache
-        local_path = os.path.join("/dpf/_cache", directory, filename)
     return local_path
 
 

ansys/dpf/core/path_utilities.py

@@ -1,7 +1,9 @@
-from ansys.dpf import core
+import os
 
+from ansys.dpf.core import server as server_module
 
-def join(left_path, right_path, server=None):
+
+def join(*args, **kwargs):
     """Join two strings to form a path, following the server
     architecture.
     Using a server version below 3.0, please ensure that the
@@ -10,11 +12,11 @@ def join(left_path, right_path, server=None):
 
     Parameters
     ----------
-    left_path : str
-        Left part of the final requested path.
+    args : str, DPFServer
+        Path to join and optionally a server.
 
-    right_path : str
-        Right path of the final requested path.
+    kwargs : DPFServer
+        server=.
 
     server : Server
         Specific server to use.
@@ -25,15 +27,53 @@ def join(left_path, right_path, server=None):
         left_path + right_path concatenated into a single string value.
 
     """
+    server = None
+    parts = []
+    for a in args:
+        if isinstance(a, str) and len(a) > 0:
+            parts.append(a)
+        elif isinstance(a, server_module.DpfServer):
+            server = a
+    if "server" in kwargs:
+        server = kwargs["server"]
     if not server:
-        server = core.SERVER
+        server = server_module._global_server()
     if not server:
-        raise RuntimeError("A server must be connected to use this method.")
+        if server_module.RUNNING_DOCKER["use_docker"]:
+            current_os = "posix"
+        else:
+            return os.path.join(*args)
+    else:
+        current_os = server.os
 
-    os_info = server.os
+    if len(parts) == 0:
+        return ""
     separator = "\\"
-    if os_info == 'posix':
+    if current_os == 'posix':
         separator = "/"
-
-    path_to_return = left_path + separator + right_path
+    path_to_return = parts[0]
+    for ipath in range(1, len(parts)):
+        path_to_return += separator + parts[ipath]
     return path_to_return
+
+def to_server_os(path, server=None):
+    if not server:
+        server = server_module._global_server()
+    if not server:
+        return path
+    if server.os == 'posix':
+        return path.replace("\\", "/")
+    else:
+        return path.replace("/", "\\")
+
+def downloaded_example_path(server = None):
+    on_docker = server_module.RUNNING_DOCKER["use_docker"]
+    if not server:
+        server = server_module._global_server()
+    if server:
+        on_docker = server.on_docker
+    if on_docker:  # pragma: no cover
+        return "/tmp/downloaded_examples"
+    else:
+        from ansys.dpf.core import LOCAL_DOWNLOADED_EXAMPLES_PATH
+        return LOCAL_DOWNLOADED_EXAMPLES_PATH