Merge pull request #366 from bollwyvl/gh-362-explicit-jp-server-2-robot

Fix tests against jupyter_server 2

Author: consideRatio

.github/workflows/test.yaml

@@ -79,7 +79,7 @@ jobs:
         if: always()
         uses: actions/upload-artifact@v3
         with:
-          name: unit-tests-${{matrix.python }}-${{ matrix.jupyter-app }}-${{matrix.jupyterlab-version}}-${{ github.run_number }}
+          name: unit-tests-${{ matrix.python-version }}-${{ matrix.jupyter-app }}-${{ matrix.jupyterlab-version }}-${{ github.run_number }}
           path: |
             ./build/pytest
             ./build/coverage
@@ -103,6 +103,12 @@ jobs:
           jupyter lab build --minimize=False --debug
 
       - name: Check the lab extension
+        # We test the labextension thoroughly in the acceptance tests below, so
+        # we have conditionally disabled this basic check is to avoid issues in
+        # jupyterlab.browser_check with jupyterlab 2 and a modern version of
+        # python (3.11+).
+        #
+        if: ${{ !(matrix.jupyterlab-version == '2' && startsWith(matrix.python-version, '3.1')) }}
         run: |
           jupyter labextension list
           jupyter labextension list 2>&1 | grep -ie '@jupyterlab/server-proxy.*OK.*'
@@ -111,7 +117,7 @@ jobs:
       - name: Install Acceptance test dependencies
         run: |
           # the acceptance test requires notebook to run
-          pip install "notebook<7" robotframework-jupyterlibrary
+          pip install "notebook<7" "robotframework-jupyterlibrary>=0.4.2"
 
       - name: Run acceptance tests
         run: |
@@ -121,6 +127,6 @@ jobs:
         if: always()
         uses: actions/upload-artifact@v3
         with:
-          name: acceptance-tests-${{ matrix.python }}-${{ matrix.jupyter-app }}-${{ matrix.jupyterlab-version }}-${{ github.run_number }}
+          name: acceptance-tests-${{ matrix.python-version }}-${{ matrix.jupyter-app }}-${{ matrix.jupyterlab-version }}-${{ github.run_number }}
           path: |
             ./build/robot

setup.py

@@ -97,7 +97,7 @@
             "pytest-html"
         ],
         "acceptance": [
-            "robotframework-jupyterlibrary"
+            "robotframework-jupyterlibrary>=0.4.2"
         ]
     },
     zip_safe=False,

tests/acceptance/__init__.robot

@@ -13,10 +13,12 @@ Suite Teardown    Clean Up
 Set Up
     ${notebook dir} =    Set Variable    ${OUTPUT DIR}${/}notebooks
     Copy Directory    resources    ${notebook dir}
+    Set Screenshot Directory   EMBED
     Set Environment Variable
     ...    name=JUPYTER_CONFIG_DIR
     ...    value=${notebook dir}
     Wait For New Jupyter Server To Be Ready
+    ...    %{JUPYTER_LIBRARY_APP_COMMAND}
     ...    stdout=${OUTPUT DIR}${/}server.log
     ...    notebook_dir=${notebook dir}
     ...    cwd=${notebook dir}

tests/acceptance/resources/jupyter_notebook_config.json renamed to tests/acceptance/resources/jupyter_config.json

@@ -1,22 +1,48 @@
-import subprocess
-import pytest
 from pathlib import Path
+import os
 import shutil
+import subprocess
+
+import pytest
 
 HERE = Path(__file__).parent
 OUTPUT = HERE.parent.parent / "build/robot"
+JUPYTER_SERVER_INFO = None
+
+try:
+    import jupyter_server
+    JUPYTER_SERVER_INFO = jupyter_server.version_info
+except ImportError:
+    pass
 
 
 def test_robot():
     """run acceptance tests with robotframework"""
     with_robot = pytest.importorskip("JupyterLibrary")
 
+    env = dict(**os.environ)
+
+    # JUPYTER_LIBRARY_* env vars documentation:
+    # https://robotframework-jupyterlibrary.readthedocs.io/en/stable/LIMITS.html#notebookapp-vs-serverapp
+    if JUPYTER_SERVER_INFO is None:
+        env.update(
+            JUPYTER_LIBRARY_APP_COMMAND="jupyter-notebook",
+            JUPYTER_LIBRARY_APP="NotebookApp",
+        )
+    else:
+        env.update(
+            JUPYTER_LIBRARY_APP_COMMAND="jupyter-server",
+            JUPYTER_LIBRARY_APP="ServerApp",
+        )
+
+
     if OUTPUT.exists():
         shutil.rmtree(OUTPUT)
 
     return_code = subprocess.call(
         ["robot", "--consolecolors=on", f"--outputdir={OUTPUT}", str(HERE)],
-        cwd=str(HERE)
+        cwd=str(HERE),
+        env=env
     )
 
     assert return_code == 0