Add support for Jupyter Server 2 (jupyterlab#1203)

* handler prepare is async in jp server 2

* Print listing output

* Don't install jupyter-archive as it does not support JP server 2

* Migrate to pytest-jupyter

* Skip hybridcontents tests
That package does not support Jupyter Server 2

* Lint the code

Author: fcollonval

.github/workflows/build.yml

@@ -78,8 +78,9 @@ jobs:
 
           # Integration test
           python -m pip install .
+          jupyter server extension list
           jupyter server extension list 2>&1 | grep -ie "jupyterlab_git.*OK"
-
+          jupyter labextension list
           jupyter labextension list 2>&1 | grep -ie "@jupyterlab/git.*OK"
           python -m jupyterlab.browser_check
 

conftest.py

@@ -1,6 +1,6 @@
 import pytest
 
-pytest_plugins = ["jupyter_server.pytest_plugin"]
+pytest_plugins = ["pytest_jupyter.jupyter_server"]
 
 
 @pytest.fixture

jupyterlab_git/handlers.py

@@ -10,7 +10,7 @@
 import tornado
 from jupyter_server.base.handlers import APIHandler, path_regex
 from jupyter_server.services.contents.manager import ContentsManager
-from jupyter_server.utils import url2path, url_path_join
+from jupyter_server.utils import url2path, url_path_join, ensure_async
 from packaging.version import parse
 import fnmatch
 
@@ -38,9 +38,9 @@ class GitHandler(APIHandler):
     def git(self) -> Git:
         return self.settings["git"]
 
-    def prepare(self):
+    async def prepare(self):
         """Check if the path should be skipped"""
-        super().prepare()
+        await ensure_async(super().prepare())
         path = self.path_kwargs.get("path")
         if path is not None:
             excluded_paths = self.git.excluded_paths

jupyterlab_git/tests/test_hybridcontents.py

@@ -9,6 +9,10 @@
 
 
 pytest.importorskip("hybridcontents")
+# FIXME requires hybridcontents update to Jupyter Server 2
+pytestmark = pytest.mark.skipif(
+    True, reason="hybridcontents is not compatible with Jupyter Server 2"
+)
 
 
 @pytest.fixture

setup.cfg

@@ -22,7 +22,7 @@ classifiers =
 [options]
 packages = find:
 install_requires =
-  jupyter_server
+  jupyter_server>=1.21.0,<3
   nbdime~=3.1
   nbformat
   packaging
@@ -42,10 +42,11 @@ dev=
   pytest
   pytest-asyncio
   pytest-cov
-  pytest-tornasync
+  pytest-jupyter[server]>=0.6
 tests=
   %(dev)s
   hybridcontents
-  jupyter-archive
   jupytext
-
+ui-tests=
+  %(tests)s
+  jupyter-archive