Mostieri/dvs module (#494)

.github/workflows/ci_cd.yml

@@ -83,6 +83,11 @@ jobs:
       - name: docker
         run: docker pull ${{ env.ENSIGHT_IMAGE }}
 
+      #- name: Setup tmate session
+      #  uses: mxschmitt/action-tmate@v3
+      #  env:
+      #    ANSYSLMD_LICENSE_FILE: ${{ format('1055@{0}', secrets.LICENSE_SERVER) }}
+
       - name: Run pytest
         uses: ansys/actions/tests-pytest@v8
         env:

pyproject.toml

@@ -27,7 +27,7 @@ classifiers = [
 
 dependencies = [
     "importlib-metadata>=4.0; python_version<='3.8'",
-    "ansys-api-pyensight==0.4.5",
+    "ansys-api-pyensight==0.4.6",
     "requests>=2.28.2",
     "docker>=6.1.0",
     "urllib3<3.0.0",

src/ansys/pyensight/core/__init__.py

@@ -5,7 +5,7 @@
 __version__ = importlib_metadata.version(__name__.replace(".", "-"))
 
 VERSION = __version__
-DEFAULT_ANSYS_VERSION = "242"
+DEFAULT_ANSYS_VERSION = "251"
 
 # Ansys version number that this release is associated with
 __ansys_version__ = DEFAULT_ANSYS_VERSION

src/ansys/pyensight/core/common.py

@@ -1,5 +1,6 @@
 """ This module provides a list of common utilities shared between different PyEnSight modules."""
 
+import os
 import random
 import re
 import socket
@@ -214,3 +215,19 @@ def pull_image(docker_client: "DockerClient", image_name: str) -> None:
             docker_client.images.pull(image_name)
     except Exception:
         raise RuntimeError(f"Can't pull Docker image: {image_name}")
+
+
+def _is_within_directory(directory, target):
+    """Check if target is inside of the input directory."""
+    abs_directory = os.path.abspath(directory)
+    abs_target = os.path.abspath(target)
+    return os.path.commonprefix([abs_directory, abs_target]) == abs_directory
+
+
+def safe_extract(tar, path=".", members=None, *, numeric_owner=False):
+    """Utility to check tar extraction to avoid bandit check issue."""
+    for member in tar.getmembers():
+        member_path = os.path.join(path, member.name)
+        if not _is_within_directory(path, member_path):
+            raise Exception("Attempted Path Traversal in Tar File")
+    tar.extractall(path, members, numeric_owner=numeric_owner)

src/ansys/pyensight/core/dockerlauncher.py

@@ -325,6 +325,7 @@ def start(self) -> "Session":
                         detach=True,
                         auto_remove=True,
                         remove=True,
+                        user="ensight:ensight",
                     )
             else:
                 logging.debug(f"Running container {self._image_name} with cmd {enshell_cmd}\n")
@@ -340,6 +341,7 @@ def start(self) -> "Session":
                         detach=True,
                         auto_remove=True,
                         remove=True,
+                        user="ensight:ensight",
                     )
                 logging.debug(f"_container = {str(self._container)}\n")
         else:
@@ -357,6 +359,7 @@ def start(self) -> "Session":
                         detach=True,
                         auto_remove=True,
                         remove=True,
+                        user="ensight:ensight",
                     )
             else:  # pragma: no cover
                 logging.debug(
@@ -373,6 +376,7 @@ def start(self) -> "Session":
                         detach=True,
                         auto_remove=True,
                         remove=True,
+                        user="ensight:ensight",
                     )
                 # logging.debug(f"_container = {str(self._container)}\n")
         logging.debug("Container started.\n")