Set env vars for licensing (#230)

* Set env vars for licensing

* Fix name arg

* Improve load_composites_plugin

* pre-commit checks

* switch to dpf_composites:latest

* Update tests/conftest.py

Co-authored-by: Dominik Gresch <[email protected]>

---------

Co-authored-by: Rene Roos <[email protected]>
Co-authored-by: Dominik Gresch <[email protected]>

Author: 3 people

.github/workflows/ci_cd.yml

@@ -89,14 +89,18 @@ jobs:
         # Only the tox environment specified in the tox.ini gh-actions is run
         run: |
           tox
-
-      - name: "Upload server output"
-        if: always()
-        uses: actions/upload-artifact@v3
-        with:
-          name: server_output
-          path: tests/logs/*_log_*.txt
-          retention-days: 7
+        env:
+          LICENSE_SERVER: ${{ secrets.LICENSE_SERVER }}
+
+      # enable for debugging purposes. Ensure that the output does not contain
+      # pipeline secrets.
+      # - name: "Upload server output"
+      #  if: always()
+      #  uses: actions/upload-artifact@v3
+      #  with:
+      #    name: server_output
+      #    path: tests/logs/*_log_*.txt
+      #    retention-days: 7
 
   tests_minimal_version:
     name: "Test with lower-bound dependency versions"
@@ -123,7 +127,10 @@ jobs:
           python -m pip install --upgrade poetry
 
       - name: Test with tox
-        run: tox -e test-minimal
+        run: |
+          tox -e test-minimal
+        env:
+          LICENSE_SERVER: ${{ secrets.LICENSE_SERVER }}
 
   doc-build:
     name: "Documentation build"
@@ -144,7 +151,7 @@ jobs:
       - name: "Pull and start dpf container"
         run: |
           docker pull ghcr.io/pyansys/pydpf-composites:${{ env.CONTAINER_TAG }}
-          docker run -d --restart always -p 21002:50052 ghcr.io/pyansys/pydpf-composites:${{ env.CONTAINER_TAG }}
+          docker run -d --restart always -p 21002:50052 -e ANSYSLMD_LICENSE_FILE=1055@${{ secrets.LICENSE_SERVER }} -e ANSYS_DPF_ACCEPT_LA=Y ghcr.io/pyansys/pydpf-composites:${{ env.CONTAINER_TAG }}
 
       - name: "Checkout the project"
         uses: actions/checkout@v3

README.rst

@@ -103,6 +103,9 @@ Test
 
    The Docker container referenced in the first option is not yet publicly available.
 
+Set the environment variable `ANSYSLMD_LICENSE_FILE` to configure the licensing or pass it
+as argument (`--license-server=1055@mylicenseserver`) to the pytest call.
+
 There are three ways to run the PyDPF Composites tests, depending on how the DPF
 server is started.
 
@@ -147,7 +150,7 @@ On Windows, build documentation with this code:
 .. code:: bash
 
     docker pull ghcr.io/pyansys/pydpf-composites:latest
-    docker run -d -p 21002:50052  ghcr.io/pyansys/pydpf-composites:latest
+    docker run -d -p 21002:50052 -e ANSYSLMD_LICENSE_FILE=10555@mylicserver -e ANSYS_DPF_ACCEPT_LA=Y ghcr.io/pyansys/pydpf-composites:latest
     tox -e doc-windows
 
 
@@ -156,7 +159,7 @@ On Linux, build documentation with this code:
 .. code:: bash
 
     docker pull ghcr.io/pyansys/pydpf-composites:latest
-    docker run -d -p 21002:50052  ghcr.io/pyansys/pydpf-composites:latest
+    docker run -d -p 21002:50052 -e ANSYSLMD_LICENSE_FILE=10555@mylicserver -e ANSYS_DPF_ACCEPT_LA=Y ghcr.io/pyansys/pydpf-composites:latest
     tox -e doc-linux
 
 

src/ansys/dpf/composites/server_helpers/_connect_to_or_start_server.py

@@ -75,9 +75,11 @@ def connect_to_or_start_server(
         connect_kwargs["ip"] = ip
 
     if len(list(connect_kwargs.keys())) > 0:
-        server = connect_to_server(**connect_kwargs)
-        server.apply_context(
-            _dpf_server.server_context.ServerContext(server_context.LicensingContextType.premium)
+        server = connect_to_server(
+            **connect_kwargs,
+            context=_dpf_server.server_context.ServerContext(
+                server_context.LicensingContextType.premium
+            ),
         )
     else:
         server = start_local_server(

src/ansys/dpf/composites/server_helpers/_load_plugin.py

@@ -1,10 +1,14 @@
 """Helper to load composites plugin."""
 import os
+import pathlib
 from typing import Optional
 
 import ansys.dpf.core as dpf
+from ansys.dpf.core.misc import get_ansys_path
 from ansys.dpf.core.server_types import BaseServer
 
+AWP_ROOT_DOCKER = "/ansys_inc/ansys/dpf/server_2023_2_pre1"
+
 
 def load_composites_plugin(server: BaseServer, ansys_path: Optional[str] = None) -> None:
     r"""Load composites plugins and its dependencies.
@@ -13,20 +17,15 @@ def load_composites_plugin(server: BaseServer, ansys_path: Optional[str] = None)
     ----------
     server:
     ansys_path:
-        Ansys root path, for example C:\Program Files\ANSYS Inc\v231.
+        Ansys root path, for example C:\Program Files\ANSYS Inc\v232.
         If None, it is assumed that all the plugins and their dependencies
         are found in the PATH/LD_LIBRARY_PATH. If ansys_path
         is set, the composite_operators and
         Ans.Dpf.EngineeringData plugins are loaded from their location
         in the installer.
     """
-    # The native plugins need to be loaded because currently,
-    # they are not automatically loaded
-    # in the docker container.
-    # Once we use the dpf core container, that probably already
-    # loads these plugins by default,
-    # we only need to load composite_operators
-    # and Ans.Dpf.EngineeringData.
+    # The automatic load of the plug can be disabled by the user and so
+    # all plugins which are required for dpf composites are loaded
     libs = [
         "Ans.Dpf.Native",
         "mapdlOperatorsCore",
@@ -48,17 +47,31 @@ def get_lib_from_name(name: str) -> str:
             "nt": ["dpf", "plugins", "dpf_composites"],
             "posix": ["dpf", "plugins", "dpf_composites"],
         },
-        "Ans.Dpf.EngineeringData": {
-            "nt": ["dpf", "bin", "winx64"],
-            "posix": ["dpf", "bin", "linx64"],
-        },
     }
 
+    # March 2023 R.Roos
+    # the dpf load_plugin method requires an absolute path because the dfp_composites
+    # plugin is not in the search path. The logic below should support all cases
+    # except a local gRPC sever on linux (local in-process server on Linux is supported)
+    # DPF core team thinks about to expose ANSYS_ROOT_FOLDER so that the absolute path
+    # can be easily constructed here.
+    if not ansys_path:
+        if server.ansys_path:
+            ansys_path = server.ansys_path
+        elif server.os == "posix":
+            ansys_path = AWP_ROOT_DOCKER
+        else:
+            ansys_path = get_ansys_path()
+
+    if not ansys_path:
+        raise RuntimeError("Ansys path is not available. DPF Composites plugin cannot be loaded.")
+
     for name in libs:
-        if ansys_path is not None and name in location_in_installer:
-            relative_installer_location = location_in_installer[name][server.os]
-            absolute_installer_location = os.path.join(ansys_path, *relative_installer_location)
-            library = os.path.join(absolute_installer_location, get_lib_from_name(name))
+        if name in location_in_installer:
+            relative_location = location_in_installer[name][server.os]
+            library = os.path.join(ansys_path, *relative_location, get_lib_from_name(name))
+            if server.os == "posix":
+                library = pathlib.Path(library).as_posix()
         else:
             library = get_lib_from_name(name)
         dpf.load_library(library, name, server=server)

tests/conftest.py

@@ -25,6 +25,8 @@
 SERVER_BIN_OPTION_KEY = "--server-bin"
 PORT_OPTION_KEY = "--port"
 ANSYS_PATH_OPTION_KEY = "--ansys-path"
+LICENSE_SERVER_OPTION_KEY = "--license-server"
+ANSYSLMD_LICENSE_FILE_KEY = "ANSYSLMD_LICENSE_FILE"
 
 
 def pytest_addoption(parser: pytest.Parser) -> None:
@@ -49,6 +51,12 @@ def pytest_addoption(parser: pytest.Parser) -> None:
         r"Example: C:\Program Files\Ansys Inc\v231",
     )
 
+    parser.addoption(
+        LICENSE_SERVER_OPTION_KEY,
+        action="store",
+        help="Value of the ANSYSLMD_LICENSE_FILE for the gRPC server.",
+    )
+
 
 ServerContext = namedtuple("ServerContext", ["port", "platform", "server"])
 
@@ -62,16 +70,22 @@ def __enter__(self):
             cmd += ["-v", f"/{pathlib.Path(source_dir).as_posix().replace(':', '')}:{target_dir}"]
         if sys.platform == "linux":
             cmd += ["-u", f"{os.getuid()}:{os.getgid()}"]
+
         cmd += [
             "-p",
             f"{self.port}:50052/tcp",
             "-e",
-            "HOME=/home/container",
+            "HOME=/tmp",
+            "-e",
+            "ANSYS_DPF_ACCEPT_LA=Y",
+            "-e",
+            f"{ANSYSLMD_LICENSE_FILE_KEY}={self.license_server}",
             "--name",
             self.name,
             self.image_name,
         ]
-        self.process_stdout.write(f"Starting docker container: {cmd}\n\n")
+        # ensure that the output does not contain any pipeline secrets
+        # self.process_stdout.write(f"Starting docker container: {cmd}\n\n")
         self.server_process = subprocess.Popen(
             cmd,
             stdout=self.server_stdout,
@@ -92,6 +106,7 @@ def __init__(
         server_err_file: pathlib.Path,
         process_out_file: pathlib.Path,
         process_err_file: pathlib.Path,
+        license_server: str = "",
         image_name: str = "ghcr.io/pyansys/pydpf-composites:latest",
         mount_directories: Mapping[str, str] = MappingProxyType({}),
     ):
@@ -104,6 +119,8 @@ def __init__(
             Local directories which should be mounted to the Docker container.
             The keys contain the path in the context of the host, and the
             values are the paths as they should appear inside the container.
+        license_server:
+            Definition of the license server. E.g. 1055@my_ansys_license_server
         server_out_file :
             Path (on the host) to which the output of ``docker run`` is redirected.
         server_err_file :
@@ -124,6 +141,7 @@ def __init__(
         self.process_stderr = open(process_err_file, mode="w", encoding="utf-8")
         self.name = str(uuid.uuid4())
         self.mount_directories = mount_directories
+        self.license_server = license_server
         self.image_name = image_name
 
     def __exit__(
@@ -268,6 +286,19 @@ def dpf_server(request: pytest.FixtureRequest):
     server_bin = request.config.getoption(SERVER_BIN_OPTION_KEY)
     running_server_port = request.config.getoption(PORT_OPTION_KEY)
     installer_path = request.config.getoption(ANSYS_PATH_OPTION_KEY)
+    license_server = request.config.getoption(LICENSE_SERVER_OPTION_KEY)
+
+    if not license_server:
+        if ANSYSLMD_LICENSE_FILE_KEY in os.environ.keys():
+            license_server = os.environ[ANSYSLMD_LICENSE_FILE_KEY]
+        else:
+            raise RuntimeError(
+                "License server not set. Either run test with --license-server of "
+                f" set ENV {ANSYSLMD_LICENSE_FILE_KEY}."
+            )
+
+    if "@" not in license_server:
+        license_server = "1055@" + license_server
 
     active_options = [
         option for option in [installer_path, server_bin, running_server_port] if option is not None
@@ -289,11 +320,13 @@ def start_server_process():
 
             process_log_stdout = TEST_ROOT_DIR / "logs" / f"process_log_out-{uid}.txt"
             process_log_stderr = TEST_ROOT_DIR / "logs" / f"process_log_err-{uid}.txt"
+
             return DockerProcess(
                 server_out_file=server_log_stdout,
                 server_err_file=server_log_stderr,
                 process_out_file=process_log_stdout,
                 process_err_file=process_log_stderr,
+                license_server=license_server,
             )
 
     with start_server_process() as server_process:

tox.ini

@@ -31,7 +31,7 @@ setenv =
     coverage: PYTEST_EXTRA_ARGS = --cov=ansys.dpf.composites --cov-report=term --cov-report=xml --cov-report=html
 commands =
     poetry install -E test
-    poetry run pytest {env:PYTEST_MARKERS:} {env:PYTEST_EXTRA_ARGS:} {posargs:-vv}
+    poetry run pytest --license-server={env:LICENSE_SERVER:} {env:PYTEST_MARKERS:} {env:PYTEST_EXTRA_ARGS:} {posargs:-vv}
 
 [testenv:test-minimal]
 description = Checks for project unit tests with minimal package versions
@@ -45,7 +45,7 @@ setenv =
 commands =
     poetry install -E test
     poetry run python -m pip install -r minimum_requirements.txt
-    poetry run pytest {env:PYTEST_MARKERS:} {posargs:-vv}
+    poetry run pytest --license-server={env:LICENSE_SERVER:} {env:PYTEST_MARKERS:} {posargs:-vv}
 
 [testenv:style]
 description = Checks project code style