Merge pull request #309 from bollwyvl/gh-308-fix-geckodriver

add env var for firefox, fallback to known locations or which

Author: krassowski

CONTRIBUTING.md

@@ -279,6 +279,19 @@ python scripts/combine.py
   and change `create_console('browser')` to `create_console('floating')` in `VirtualEditor`
   constructor (please feel free to add a config option for this).
 
+- If you see:
+
+  > `SessionNotCreatedException: Message: Unable to find a matching set of capabilities`
+
+  `geckodriver >=0.27.0` requires an _actual_ Firefox executable. Several places
+  will be checked (including where `conda-forge` installs, as in CI): to test
+  a Firefox _not_ on your `PATH`, set the following enviroment variable:
+
+  ```bash
+  export FIREFOX_BINARY=/path/to/firefox      # ... unix
+  set FIREFOX_BINARY=C:\path\to\firefox.exe   # ... windows
+  ```
+
 ### Formatting
 
 Minimal code style is enforced with `pytest-flake8` during unit testing. If installed,

atest/Keywords.robot

@@ -84,11 +84,22 @@ Wait For Splash
 
 Open JupyterLab
     Set Environment Variable    MOZ_HEADLESS    ${HEADLESS}
-    ${firefox} =    Which    firefox
+    ${firefox} =    Get Firefox Binary
     ${geckodriver} =    Which    geckodriver
-    Create WebDriver    Firefox    executable_path=${geckodriver}    firefox_binary=${firefox}    service_log_path=${OUTPUT DIR}${/}geckodriver.log
+    ${service args} =    Create List    --log    debug
+    Create WebDriver    Firefox
+    ...    executable_path=${geckodriver}
+    ...    firefox_binary=${firefox}
+    ...    service_log_path=${OUTPUT DIR}${/}geckodriver.log
+    ...    service_args=${service args}
     Wait Until Keyword Succeeds    3x    5s    Wait For Splash
 
+Get Firefox Binary
+    [Documentation]    Get Firefox path from the environment... or hope for the best
+    ${from which} =    Which    firefox
+    ${firefox} =    Set Variable If    "%{FIREFOX_BINARY}"    %{FIREFOX_BINARY}    ${from which}
+    [Return]    ${firefox}
+
 Close JupyterLab
     Close All Browsers
 

py_src/jupyter_lsp/tests/conftest.py

@@ -3,13 +3,14 @@
 import shutil
 from typing import Text
 
-# local imports
-from jupyter_lsp import LanguageServerManager
-from jupyter_lsp.handlers import LanguageServersHandler, LanguageServerWebSocketHandler
 from notebook.notebookapp import NotebookApp
 from pytest import fixture
 from tornado.queues import Queue
 
+# local imports
+from jupyter_lsp import LanguageServerManager
+from jupyter_lsp.handlers import LanguageServersHandler, LanguageServerWebSocketHandler
+
 # these should always be available in a test environment ()
 KNOWN_SERVERS = [
     "bash-language-server",

py_src/jupyter_lsp/tests/test_bad_spec.py

@@ -1,5 +1,6 @@
 import pytest
 import traitlets
+
 from jupyter_lsp.session import LanguageServerSession
 
 

py_src/jupyter_lsp/tests/test_listener.py

@@ -3,9 +3,10 @@
 
 import pytest
 import traitlets
-from jupyter_lsp import lsp_message_listener
 from tornado.queues import Queue
 
+from jupyter_lsp import lsp_message_listener
+
 
 @pytest.mark.parametrize("bad_string", ["not-a-function", "jupyter_lsp.__version__"])
 @pytest.mark.asyncio

scripts/atest.py

@@ -6,6 +6,7 @@
 import shutil
 import sys
 import time
+from os.path import join
 from pathlib import Path
 
 import robot
@@ -45,6 +46,24 @@ def get_stem(attempt, extra_args):
 def atest(attempt, extra_args):
     """ perform a single attempt of the acceptance tests
     """
+
+    if "FIREFOX_BINARY" not in os.environ:
+        os.environ["FIREFOX_BINARY"] = shutil.which("firefox")
+
+        prefix = os.environ.get("CONDA_PREFIX")
+
+        if prefix:
+            app_dir = join(prefix, "bin", "FirefoxApp")
+            os.environ["FIREFOX_BINARY"] = {
+                "Windows": join(prefix, "Library", "bin", "firefox.exe"),
+                "Linux": join(app_dir, "firefox"),
+                "Darwin": join(app_dir, "Contents", "MacOS", "firefox"),
+            }[OS]
+
+    print("Will use firefox at", os.environ["FIREFOX_BINARY"])
+
+    assert os.path.exists(os.environ["FIREFOX_BINARY"])
+
     extra_args += OS_PY_ARGS.get((OS, PY), [])
 
     stem = get_stem(attempt, extra_args)