Refactor server context (#634)

Author: cbellot000

.github/workflows/scripts/separate_long_core_tests.ps1

@@ -5,24 +5,28 @@ New-Item -Path ".\" -Name "test_multi_server" -ItemType "directory"
 New-Item -Path ".\" -Name "test_workflow" -ItemType "directory"
 New-Item -Path ".\" -Name "test_remote_workflow" -ItemType "directory"
 New-Item -Path ".\" -Name "test_remote_operator" -ItemType "directory"
+New-Item -Path ".\" -Name "test_service" -ItemType "directory"
 Copy-Item -Path "tests\conftest.py" -Destination ".\test_launcher\"
 Copy-Item -Path "tests\conftest.py" -Destination ".\test_server\"
 Copy-Item -Path "tests\conftest.py" -Destination ".\test_local_server\"
 Copy-Item -Path "tests\conftest.py" -Destination ".\test_multi_server\"
 Copy-Item -Path "tests\conftest.py" -Destination ".\test_workflow\"
 Copy-Item -Path "tests\conftest.py" -Destination ".\test_remote_workflow\"
 Copy-Item -Path "tests\conftest.py" -Destination ".\test_remote_operator\"
+Copy-Item -Path "tests\conftest.py" -Destination ".\test_service\"
 Copy-Item -Path "tests\test_launcher.py" -Destination ".\test_launcher\"
 Copy-Item -Path "tests\test_server.py" -Destination ".\test_server\"
 Copy-Item -Path "tests\test_local_server.py" -Destination ".\test_local_server\"
 Copy-Item -Path "tests\test_multi_server.py" -Destination ".\test_multi_server\"
 Copy-Item -Path "tests\test_workflow.py" -Destination ".\test_workflow\"
 Copy-Item -Path "tests\test_remote_workflow.py" -Destination ".\test_remote_workflow\"
 Copy-Item -Path "tests\test_remote_operator.py" -Destination ".\test_remote_operator\"
+Copy-Item -Path "tests\test_service.py" -Destination ".\test_service\"
 Remove-Item -Path "tests\test_server.py"
 Remove-Item -Path "tests\test_launcher.py"
 Remove-Item -Path "tests\test_local_server.py"
 Remove-Item -Path "tests\test_multi_server.py"
 Remove-Item -Path "tests\test_workflow.py"
 Remove-Item -Path "tests\test_remote_workflow.py"
-Remove-Item -Path "tests\test_remote_operator.py"
+Remove-Item -Path "tests\test_remote_operator.py"
+Remove-Item -Path "tests\test_service.py"

.github/workflows/test_docker.yml

@@ -59,23 +59,20 @@ jobs:
         working-directory: test_launcher
         run: |
           pytest $DEBUG --cov=ansys.dpf.core --cov-report=xml --cov-report=html --cov-append --log-level=ERROR --junitxml=../tests/junit/test-results2.xml --reruns 2 .
-        if: always()
         timeout-minutes: 20
 
       - name: "Test API test_server"
         shell: bash
         working-directory: test_server
         run: |
           pytest $DEBUG --cov=ansys.dpf.core --cov-report=xml --cov-report=html --cov-append --log-level=ERROR --junitxml=../tests/junit/test-results4.xml --reruns 2 .
-        if: always()
         timeout-minutes: 10
 
       - name: "Test API test_local_server"
         shell: bash
         working-directory: test_local_server
         run: |
           pytest $DEBUG --cov=ansys.dpf.core --cov-report=xml --cov-report=html --cov-append --log-level=ERROR --junitxml=../tests/junit/test-results5.xml --reruns 2 .
-        if: always()
         timeout-minutes: 20
 
       - name: "Test API test_multi_server"
@@ -104,15 +101,20 @@ jobs:
         working-directory: test_workflow
         run: |
           pytest $DEBUG --cov=ansys.dpf.core --cov-report=xml --cov-report=html --cov-append --log-level=ERROR --junitxml=../tests/junit/test-results3.xml --reruns 3 .
-        if: always()
         timeout-minutes: 20
 
+      - name: "Test API test_service"
+        shell: bash
+        working-directory: test_service
+        run: |
+          pytest $DEBUG --cov=ansys.dpf.core --cov-report=xml --cov-report=html --cov-append --log-level=ERROR --junitxml=../tests/junit/test-results9.xml --reruns 3 .
+
       - name: "Upload Test Results"
         uses: actions/upload-artifact@v3
         with:
           name: ${{ env.PACKAGE_NAME }}_${{ matrix.python-version }}_${{ matrix.os }}_pytest_${{ env.ANSYS_VERSION }}_docker
           path: tests/junit/test-results.xml
-        if: always()
+        timeout-minutes: 20
 
       - name: "Upload coverage to Codecov"
         uses: codecov/codecov-action@v3

.github/workflows/tests.yml

@@ -133,7 +133,6 @@ jobs:
         working-directory: test_launcher
         run: |
           pytest $DEBUG --cov=ansys.dpf.core --cov-report=xml --cov-report=html --cov-append --log-level=ERROR --junitxml=../tests/junit/test-results2.xml --reruns 2 .
-        if: always()
 
       - name: "Kill all servers"
         uses: pyansys/pydpf-actions/[email protected]
@@ -155,7 +154,6 @@ jobs:
         working-directory: test_local_server
         run: |
           pytest $DEBUG --cov=ansys.dpf.core --cov-report=xml --cov-report=html --cov-append --log-level=ERROR --junitxml=../tests/junit/test-results5.xml --reruns 2 .
-        if: always()
 
       - name: "Kill all servers"
         uses: pyansys/pydpf-actions/[email protected]
@@ -166,7 +164,6 @@ jobs:
         working-directory: test_multi_server
         run: |
           pytest $DEBUG --cov=ansys.dpf.core --cov-report=xml --cov-report=html --cov-append --log-level=ERROR --junitxml=../tests/junit/test-results6.xml --reruns 2 .
-        if: always()
 
       - name: "Kill all servers"
         uses: pyansys/pydpf-actions/[email protected]
@@ -177,7 +174,6 @@ jobs:
         working-directory: test_remote_workflow
         run: |
           pytest $DEBUG --cov=ansys.dpf.core --cov-report=xml --cov-report=html --cov-append --log-level=ERROR --junitxml=../tests/junit/test-results7.xml --reruns 2 .
-        if: always()
 
       - name: "Kill all servers"
         uses: pyansys/pydpf-actions/[email protected]
@@ -188,7 +184,6 @@ jobs:
         working-directory: test_remote_operator
         run: |
           pytest $DEBUG --cov=ansys.dpf.core --cov-report=xml --cov-report=html --cov-append --log-level=ERROR --junitxml=../tests/junit/test-results8.xml --reruns 2 .
-        if: always()
 
       - name: "Kill all servers"
         uses: pyansys/pydpf-actions/[email protected]
@@ -205,6 +200,16 @@ jobs:
         uses: pyansys/pydpf-actions/[email protected]
         if: always()
 
+      - name: "Test API test_service"
+        shell: bash
+        working-directory: test_service
+        run: |
+          pytest $DEBUG --cov=ansys.dpf.core --cov-report=xml --cov-report=html --cov-append --log-level=ERROR --junitxml=../tests/junit/test-results9.xml --reruns 3 .
+
+      - name: "Kill all servers"
+        uses: pyansys/pydpf-actions/[email protected]
+        if: always()
+
       - name: "Upload Test Results"
         uses: actions/upload-artifact@v3
         with:

ansys/dpf/core/__init__.py

@@ -81,7 +81,7 @@
 from ansys.dpf.core import path_utilities
 from ansys.dpf.core import settings
 from ansys.dpf.core.server_factory import ServerConfig, AvailableServerConfigs
-from ansys.dpf.core.server_context import apply_server_context, AvailableServerContexts
+from ansys.dpf.core.server_context import set_default_server_context, AvailableServerContexts
 
 # for matplotlib
 # solves "QApplication: invalid style override passed, ignoring it."

ansys/dpf/core/core.py

@@ -439,12 +439,12 @@ def apply_context(self, context):
         if not self._server().meet_version("6.0"):
             raise errors.DpfVersionNotSupported("6.0")
         if self._server().has_client():
-            error = self._api.data_processing_apply_context_on_client(
-                self._server().client, context.context_type.value, context.xml_path
+            self._api.data_processing_apply_context_on_client(
+                self._server().client, int(context.licensing_context_type), context.xml_path
             )
         else:
-            error = self._api.data_processing_apply_context(
-                context.context_type.value, context.xml_path
+            self._api.data_processing_apply_context(
+                int(context.licensing_context_type), context.xml_path
             )
 
     def initialize_with_context(self, context):
@@ -464,14 +464,14 @@ def initialize_with_context(self, context):
         if self._server().has_client():
             if not self._server().meet_version("6.0"):
                 raise errors.DpfVersionNotSupported("6.0")
-            error = self._api.data_processing_initialize_with_context_on_client(
-                self._server().client, context.context_type.value, context.xml_path
+            self._api.data_processing_initialize_with_context_on_client(
+                self._server().client, int(context.licensing_context_type), context.xml_path
             )
         else:
             if not self._server().meet_version("4.0"):
                 raise errors.DpfVersionNotSupported("4.0")
-            error = self._api.data_processing_initialize_with_context(
-                context.context_type.value, context.xml_path
+            self._api.data_processing_initialize_with_context(
+                int(context.licensing_context_type), context.xml_path
             )
 
     @version_requires("6.0")

ansys/dpf/core/custom_operator.py

@@ -19,6 +19,7 @@
     operator_specification,
     dpf_operator,
     collection,
+    AvailableServerContexts,
 )
 from ansys.dpf.core._custom_operators_helpers import __operator_main__, functions_registry, \
     external_operator_api, _type_to_output_method, _type_to_input_method
@@ -46,7 +47,7 @@ def record_operator(operator_type, *args) -> None:
         operator = operator_type
     if dpf.SERVER is None:
         settings.set_server_configuration(server_factory.ServerConfig(None, False))
-        server.start_local_server()
+        server.start_local_server(context=AvailableServerContexts.premium)
     if len(args) == 2:
         external_operator_api.external_operator_record_with_abstract_core_and_wrapper(
             operator._call_back(),

ansys/dpf/core/server.py

@@ -18,6 +18,7 @@
 
 from ansys.dpf.core.server_factory import ServerConfig, ServerFactory, CommunicationProtocols
 from ansys.dpf.core.server_types import DPF_DEFAULT_PORT, LOCALHOST, RUNNING_DOCKER
+from ansys.dpf.core import server_context
 
 
 def shutdown_global_server():
@@ -129,7 +130,8 @@ def start_local_server(
         docker_config=RUNNING_DOCKER,
         timeout=20.,
         config=None,
-        use_pypim_by_default=True
+        use_pypim_by_default=True,
+        context=None
 ):
     """Start a new local DPF server at a given port and IP address.
 
@@ -168,6 +170,10 @@ def start_local_server(
     use_pypim_by_default: bool, optional
         Whether to use PyPIM functionalities by default when a PyPIM environment is detected.
         Defaults to True.
+    context: ServerContext, optional
+        Defines the settings that will be used to load DPF's plugins.
+        A DPF xml file can be used to list the plugins and set up variables. Default is
+        `server_context.SERVER_CONTEXT`.
 
     Returns
     -------
@@ -207,6 +213,9 @@ def start_local_server(
     else:
         docker_config.use_docker = False
 
+    if context is None:
+        context = server_context.SERVER_CONTEXT
+
     server = None
     n_attempts = 3
     timed_out = False
@@ -221,11 +230,11 @@ def start_local_server(
                 server = server_type(
                     ansys_path, ip, port, as_global=as_global, launch_server=True,
                     load_operators=load_operators, docker_config=docker_config, timeout=timeout,
-                    use_pypim=use_pypim)
+                    use_pypim=use_pypim, context=context)
             else:
                 server = server_type(
                     ansys_path, as_global=as_global,
-                    load_operators=load_operators, timeout=timeout)
+                    load_operators=load_operators, timeout=timeout, context=context)
             break
         except errors.InvalidPortError:  # allow socket in use errors
             port += 1
@@ -249,7 +258,14 @@ def start_local_server(
     return server
 
 
-def connect_to_server(ip=LOCALHOST, port=DPF_DEFAULT_PORT, as_global=True, timeout=5, config=None):
+def connect_to_server(
+        ip=LOCALHOST,
+        port=DPF_DEFAULT_PORT,
+        as_global=True,
+        timeout=5,
+        config=None,
+        context=None,
+):
     """Connect to an existing DPF server.
 
     This method sets the global default channel that is then used for the
@@ -273,6 +289,10 @@ def connect_to_server(ip=LOCALHOST, port=DPF_DEFAULT_PORT, as_global=True, timeo
         passes, the connection fails.
     config: ServerConfig, optional
         Manages the type of server connection to use.
+    context: ServerContext, optional
+        Defines the settings that will be used to load DPF's plugins.
+        A DPF xml file can be used to list the plugins and set up variables. Default is
+        `server_context.SERVER_CONTEXT`.
 
     Examples
     --------
@@ -293,17 +313,21 @@ def connect_to_server(ip=LOCALHOST, port=DPF_DEFAULT_PORT, as_global=True, timeo
     >>> #unspecified_server = dpf.connect_to_server(as_global=False)
 
     """
+    if context is None:
+        context = server_context.SERVER_CONTEXT
 
     def connect():
         server_init_signature = inspect.signature(server_type.__init__)
         if "ip" in server_init_signature.parameters.keys() \
                 and "port" in server_init_signature.parameters.keys():
             server = server_type(
-                ip=ip, port=port, as_global=as_global, launch_server=False
+                ip=ip, port=port, as_global=as_global, launch_server=False,
+                context=context
             )
         else:
             server = server_type(
-                as_global=as_global
+                as_global=as_global,
+                context=context
             )
         dpf.core._server_instances.append(weakref.ref(server))
         return server