Merge pull request #364 from KhiopsML/run-runner-init-test-in-conda-ci

Run runner initialization test in conda CI

Author: folmos-at-orange

.github/workflows/conda.yml

@@ -117,7 +117,7 @@ jobs:
           PATH=$(echo $PATH | sed "s#$CONDA_PREFIX/bin:##g")
 
           # Unset *CONDA* environment variables
-          # As a corrolary, CONDA_PREFIX is unset
+          # As a corollary, CONDA_PREFIX is unset
           # Note: There is no way to remove these variables from GITHUB_ENV
           # (see https://github.com/actions/runner/issues/1126)
           for CONDA_VAR in $(env | grep CONDA)
@@ -131,17 +131,17 @@ jobs:
         run: |
           kh-download-datasets \
             --version ${{ inputs.khiops-samples-version || env.DEFAULT_SAMPLES_VERSION }}
-      - name: Test Conda Package on Samples
+      - name: Run Samples
         env:
           # Force > 2 CPU cores to launch mpiexec
           KHIOPS_PROC_NUMBER: 4
         run: |
-          kh-samples core -i train_predictor -e
+          kh-samples core -i deploy_model -e
+          kh-samples core -i deploy_coclustering -e
           kh-samples core -i train_predictor_error_handling -e
-          kh-samples core -i train_coclustering -e
           kh-samples sklearn -i khiops_classifier -e
           kh-samples sklearn -i khiops_coclustering -e
-      - name: Test Conda Package on Some Samples (Conda-Based Environments)
+      - name: Run Samples (Conda-Based Environments)
         env:
           # Force > 2 CPU cores to launch mpiexec
           KHIOPS_PROC_NUMBER: 4
@@ -153,18 +153,57 @@ jobs:
           PATH=$(echo $PATH | sed "s#$CONDA_PREFIX/bin:##g")
 
           # Unset *CONDA* environment variables
-          # As a corrolary, CONDA_PREFIX is unset
+          # As a corollary, CONDA_PREFIX is unset
           # Note: There is no way to remove these variables from GITHUB_ENV
           # (see https://github.com/actions/runner/issues/1126)
           for CONDA_VAR in $(env | grep CONDA)
           do
             unset $(echo $CONDA_VAR | cut -d '=' -f 1)
           done
 
-          # Execute some Khiops and Khiops Coclustering samples
+          # Run samples
           # Note: kh-samples is not reachable as it is not in PATH
           $PYTHON -m khiops.samples.samples -i deploy_model -e
           $PYTHON -m khiops.samples.samples -i deploy_coclustering -e
+          $PYTHON -m khiops.samples.samples -i train_predictor_error_handling -e
+          $PYTHON -m khiops.samples.samples_sklearn -i khiops_classifier -e
+          $PYTHON -m khiops.samples.samples_sklearn -i khiops_coclustering -e
+      # Checkout the sources to obtain the tests
+      # Note: The `sparse-checkout` option of this action is bugged so we checkout all the sources
+      #       See https://github.com/actions/checkout/issues/1628
+      - name: Checkout Sources
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+      # This is needed so python does not retrieve the khiops module from PWD
+      - name: Remove the khiops Module from the Sources
+        run: rm -rf khiops
+      - name: Install the Test Requirements
+        run: conda install -y --file test-requirements.txt
+      - name: Run the Runner Initialization Integration Test
+        run: |
+          python -m unittest -v \
+            tests.test_khiops_integrations.KhiopsRunnerEnvironmentTests.test_runner_environment_initialization
+      - name: Run the Runner Initialization Integration Test (Conda-Based Environments)
+        run: |
+          # Set `python` to the current Conda Python executable
+          PYTHON="$(type -P python)"
+
+          # Remove $CONDA_PREFIX/bin from PATH
+          PATH=$(echo $PATH | sed "s#$CONDA_PREFIX/bin:##g")
+
+          # Unset *CONDA* environment variables
+          # As a corolary, CONDA_PREFIX is unset
+          # Note: There is no way to remove these variables from GITHUB_ENV
+          # (see https://github.com/actions/runner/issues/1126)
+          for CONDA_VAR in $(env | grep CONDA)
+          do
+            unset $(echo $CONDA_VAR | cut -d '=' -f 1)
+          done
+
+          # Execute the runner initialization integration test
+          $PYTHON -m unittest -v \
+            tests.test_khiops_integrations.KhiopsRunnerEnvironmentTests.test_runner_environment_initialization
 
   # Release is only executed on tags
   # Note: For this job to work the secrets variables KHIOPS_ANACONDA_CHANNEL_TOKEN and

.github/workflows/tests.yml

@@ -109,8 +109,9 @@ jobs:
             $CONDA install -y -n "$CONDA_ENV" `grep -v "^\[" khiops.egg-info/requires.txt`
             rm -rf khiops.egg-info
           done
-      - name: Prepare Tests Environment
-        if: github.ref != 'dev' && github.rev != 'dev-v10' && github.ref != 'main' && ! inputs.run-expensive-tests
+      - name: Configure Expensive Tests Setting
+        # Skip expensive tests by default, unless on the `dev`, `dev-v10` or `main` branches
+        if: github.ref != 'dev' && github.ref != 'dev-v10' && github.ref != 'main' && ! inputs.run-expensive-tests
         run: echo "SKIP_EXPENSIVE_TESTS=true" >> "$GITHUB_ENV"
       - name: Prepare Integration Tests on remote files
         env:

.gitignore

@@ -48,6 +48,7 @@ tests/resources/scenario_generation/api/*/output
 tests/resources/scenario_generation/general_options/output
 tests/resources/scenario_generation/runner_version/output
 tests/resources/*/copy_output_kdic
+tests/resources/scenario_generation/system_settings/output
 
 # File generated by documentation scripts/notebooks
 kh_samples

tests/test_khiops_integrations.py

@@ -167,42 +167,14 @@ def test_environment_error_on_bogus_khiops_env_script(self):
         output_msg = str(context.exception)
         self.assertEqual(output_msg, expected_msg)
 
-    def test_runner_with_conda_based_environment(self):
-        """Test that local runner works in non-Conda, Conda-based environments"""
-
-        # Emulate Conda-based environment:
-        # - remove $CONDA_PREFIX/bin from $PATH
-        # - unset `CONDA_PREFIX`
-        # - create new KhiopsLocalRunner and initialize its Khiops binary
-        #   directory
-        # - check that the Khiops binary directory contains the MODL* binaries
-        #   and `mpiexec` (which should be its default location)
-        conda_prefix = None
-        if "CONDA_PREFIX" in os.environ:
-            # Remove `CONDA_PREFIX/bin` from `PATH`
-            conda_prefix_bin = os.path.join(os.environ["CONDA_PREFIX"], "bin")
-            os.environ["PATH"] = os.pathsep.join(
-                path_fragment
-                for path_fragment in os.environ["PATH"].split(os.pathsep)
-                if path_fragment != conda_prefix_bin
-            )
-
-            # Store existing CONDA_PREFIX
-            conda_prefix = os.environ["CONDA_PREFIX"]
-
-            # Unset `CONDA_PREFIX`
-            del os.environ["CONDA_PREFIX"]
-
-        # Create a fresh local runner
-        runner = KhiopsLocalRunner()
-
-        # Restore CONDA_PREFIX
-        if conda_prefix is not None:
-            os.environ["CONDA_PREFIX"] = conda_prefix
+    def test_runner_environment_initialization(self):
+        """Test that local runner initializes/ed its environment properly
 
-            # Restore `CONDA_PREFIX/bin` into `PATH`
-            conda_prefix_bin = os.path.join(conda_prefix, "bin")
-            os.environ["PATH"] = os.pathsep.join([conda_prefix_bin, os.environ["PATH"]])
+        .. note::
+            To test a real initialization this test should be executed alone.
+        """
+        # Obtain the current runner
+        runner = kh.get_runner()
 
         # Check that MODL* files as set in the runner exist and are executable
         self.assertTrue(os.path.isfile(runner.khiops_path))
@@ -211,12 +183,11 @@ def test_runner_with_conda_based_environment(self):
         self.assertTrue(os.access(runner.khiops_coclustering_path, os.X_OK))
 
         # Check that mpiexec is set correctly in the runner:
-        mpi_command_args = runner.mpi_command_args
-        self.assertTrue(len(mpi_command_args) > 0)
-        mpiexec_path = runner.mpi_command_args[0]
-        self.assertTrue(os.path.exists(mpiexec_path))
-        self.assertTrue(os.path.isfile(mpiexec_path))
-        self.assertTrue(os.access(mpiexec_path, os.X_OK))
+        if runner.mpi_command_args:
+            mpiexec_path = runner.mpi_command_args[0]
+            self.assertTrue(os.path.exists(mpiexec_path))
+            self.assertTrue(os.path.isfile(mpiexec_path))
+            self.assertTrue(os.access(mpiexec_path, os.X_OK))
 
 
 class KhiopsMultitableFitTests(unittest.TestCase):