Test chrome as well as firefox

Author: manics

.github/workflows/build.yml

@@ -106,8 +106,11 @@ jobs:
         run: |
           python -mpip install dist/*.whl
 
-      - name: Run pytest
-        run: pytest -vs tests
+      - name: Run pytest (firefox)
+        run: python -mpytest -vs tests --browser=firefox
+
+      - name: Run pytest (chrome)
+        run: python -mpytest -vs tests --browser=chrome
 
   # https://packaging.python.org/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
   publish-pypi:

README.md

@@ -59,7 +59,6 @@ This extension can be configured in `jupyter_notebook_config.py` by setting the
 # Warning
 
 This extension is still in development.
-It is only tested on Firefox.
 Breaking changes may occur in future.
 
 There are [several major limitations](https://github.com/manics/jupyter-offlinenotebook/issues) including:
@@ -75,7 +74,6 @@ This extension stores notebooks in browser storage using the [IndexedDB API](htt
 One server API call is made during initialisation to obtain the storage configuration.
 Everything else is done client-side so should work even if the server is disconnected.
 
-The CI pipeline builds the extension with JupyterLab 4, but the build package works with JupyterLab 3 and NBclassic.
 Install the development dependencies:
 
     pip install -r dev-requirements-jl4.txt

tests/conftest.py

@@ -0,0 +1,16 @@
+import pytest
+
+
+def pytest_addoption(parser):
+    parser.addoption(
+        "--browser",
+        action="store",
+        default="firefox",
+        help="browser to run tests on",
+        choices=("firefox", "chrome"),
+    )
+
+
+@pytest.fixture
+def browser(request):
+    return request.config.getoption("--browser")

tests/test_offlinenotebook.py

@@ -14,7 +14,8 @@
 from selenium.webdriver.common.by import By
 
 from selenium.webdriver.firefox.firefox_profile import FirefoxProfile
-from selenium.webdriver.firefox.options import Options
+from selenium.webdriver.firefox.options import Options as FirefoxOptions
+from selenium.webdriver.chrome.options import Options as ChromeOptions
 
 
 PORT = 18888
@@ -111,7 +112,7 @@ def initialise_firefox(self, downloaddir, url):
             "browser.helperApps.neverAsk.saveToDisk", "application/x-ipynb+json"
         )
 
-        options = Options()
+        options = FirefoxOptions()
         if HEADLESS:
             options.add_argument("-headless")
 
@@ -124,7 +125,28 @@ def initialise_firefox(self, downloaddir, url):
         self.driver.get(url)
         print("Firefox Initialized")
 
-    def initialise(self, tmpdir, app, url):
+    def initialise_chrome(self, downloaddir, url):
+        """Initialises a Chrome webdriver with download preferences."""
+        options = ChromeOptions()
+        if HEADLESS:
+            options.add_argument("--headless=new")
+
+        prefs = {
+            "download.default_directory": downloaddir,
+            "download.prompt_for_download": False,
+            "safebrowsing.enabled": True,
+        }
+        options.add_experimental_option("prefs", prefs)
+
+        self.driver = webdriver.Chrome(options=options)
+        self.wait = WebDriverWait(self.driver, TIMEOUT)
+
+        self.driver.get(url)
+        # Default size is too narrow, so toolbar is partially hidden
+        self.driver.set_window_size(1024, 768)
+        print("Chrome Initialized")
+
+    def initialise(self, tmpdir, app, url, browser):
         jupyterdir = (tmpdir / "jupyter").mkdir()
         downloaddir = (tmpdir / "download").mkdir()
 
@@ -136,7 +158,12 @@ def initialise(self, tmpdir, app, url):
         self.expected_download = str(downloaddir / "example.ipynb")
 
         self.start_jupyter(jupyterdir, app)
-        self.initialise_firefox(str(downloaddir), url)
+        if browser == "firefox":
+            self.initialise_firefox(str(downloaddir), url)
+        elif browser == "chrome":
+            self.initialise_chrome(str(downloaddir), url)
+        else:
+            pytest.fail(f"Unsupported browser: {browser}")
 
 
 class TestOfflineLab(FirefoxTestBase):
@@ -201,11 +228,11 @@ def restore_from_browser_storage(self):
     @pytest.mark.flaky(max_runs=3)
     # Notebook 7 is based on JupyterLab
     @pytest.mark.parametrize("app", ["lab", "notebook"])
-    def test_offline_lab(self, tmpdir, app):
+    def test_offline_lab(self, tmpdir, app, browser):
         # Selenium can't access IndexedDB so instead check save/load by
         # downloading the updated notebook
 
-        self.initialise(tmpdir, app, JUPYTER_URL[app])
+        self.initialise(tmpdir, app, JUPYTER_URL[app], browser)
         self.toolbar_button = "jp-button"
 
         # Wait for the loading logo to appear, then disappear