Selenium notebook tests

.appveyor.yml

@@ -27,4 +27,4 @@ install:
 
 test_script:
   - pip install -e . --no-deps --force-reinstall
-  - pytest -n 2 -rxXs tests
+  - pytest -n 2 -rxXs tests --ignore=tests/selenium

.github/CONTRIBUTING.md

@@ -71,13 +71,13 @@ The basic workflow for contributing is:
    pip install -r requirements.txt
    pip install -r requirements-dev.txt
    ```
-6. Install Firefox, download [geckodriver](https://github.com/mozilla/geckodriver/releases) 
-   and put it in the PATH.
+6. Install Chrome, download [chromedriver](https://sites.google.com/a/chromium.org/chromedriver/) and put it in the PATH.
 7. Make changes to your local copy of the folium repository
 8. Make sure the tests pass:
    * in the repository folder do `pip install -e . --no-deps`  (needed for notebook tests)
-   * run `python -m pytest tests`
    * run `flake8 folium --max-line-length=120`
+   * run `python -m pytest tests --ignore=tests/selenium`
+   * run `python -m pytest tests/selenium`
    * resolve all errors
 9. Commit those changes
    ```

.gitignore

@@ -14,6 +14,11 @@ examples/results/*
 /_mac/*.xml
 /inspection/*.xml
 geckodriver.log
+geckodriver.exe
 geckodriver.tar.gz
 geckodriver/
+chromedriver.exe
+chromedriver/
 miniconda.sh
+latest_logs/
+*.nbconvert.ipynb

.travis.yml

@@ -7,6 +7,7 @@ env:
 
 addons:
   firefox: latest
+  # chrome addon fails to install
 
 env:
   global:
@@ -21,6 +22,8 @@ matrix:
     env: PY=3.7
   - name: notebooks-code
     env: PY=3.7
+  - name: selenium
+    env: PY=3.7
   - name: latest-branca
     env: PY=3.7
   - name: docs
@@ -54,7 +57,18 @@ before_install:
     mkdir geckodriver
     tar -xzf geckodriver.tar.gz -C geckodriver
     export PATH=$PATH:$PWD/geckodriver
-
+  # Install Chrome
+  - |
+    wget https://dl.google.com/linux/direct/google-chrome-stable_current_amd64.deb
+    sudo dpkg -i google-chrome-stable_current_amd64.deb
+    sudo apt-get install -y -f
+    # sudo dpkg -i google-chrome-stable_current_amd64.deb
+  # Install chromedriver
+  - |
+    wget https://chromedriver.storage.googleapis.com/$(curl https://chromedriver.storage.googleapis.com/LATEST_RELEASE)/chromedriver_linux64.zip -O chromedriver.zip
+    mkdir chromedriver
+    unzip chromedriver.zip -d chromedriver
+    export PATH=$PATH:$PWD/chromedriver
 
 # Test source distribution.
 install:
@@ -72,13 +86,13 @@ script:
     fi
 
   - if [[ $TRAVIS_JOB_NAME == 'default' ]]; then
-      pytest /tmp -vv --ignore=tests/notebooks/test_notebooks.py ;
+      pytest /tmp -vv --ignore=/tmp/tests/selenium ;
     fi
 
   - if [[ $TRAVIS_JOB_NAME == 'latest-branca' ]]; then
       conda uninstall branca ;
       pip install git+https://github.com/python-visualization/branca.git ;
-      pytest /tmp -vv --ignore=tests/notebooks/test_notebooks.py ;
+      pytest /tmp -vv --ignore=/tmp/tests/selenium ;
     fi
 
   - if [[ $TRAVIS_JOB_NAME == 'notebooks-conding-standard' ]]; then
@@ -91,6 +105,10 @@ script:
       pytest --nbval-lax /tmp/examples ;
     fi
 
+  - if [[ $TRAVIS_JOB_NAME == 'selenium' ]]; then
+      pytest /tmp/tests/selenium -vv ;
+    fi
+
 # Docs
   - |
     if [[ $TRAVIS_JOB_NAME == 'docs' ]]; then

tests/selenium/test_selenium.py

@@ -0,0 +1,123 @@
+
+import base64
+import glob
+from html.parser import HTMLParser
+import os
+import subprocess
+
+import nbconvert
+import pytest
+from selenium.webdriver import Chrome, ChromeOptions
+from selenium.common.exceptions import UnexpectedAlertPresentException
+from selenium.webdriver.common.by import By
+from selenium.webdriver.support.ui import WebDriverWait
+from selenium.webdriver.support.expected_conditions import visibility_of_element_located
+
+
+def create_driver():
+    """Create a Selenium WebDriver instance."""
+    options = ChromeOptions()
+    options.add_argument('--no-sandbox')
+    options.add_argument('--disable-dev-shm-usage')
+    options.add_argument('--disable-gpu')
+    options.add_argument('--headless')
+    driver = Chrome(options=options)
+    return driver
+
+
+@pytest.fixture(scope='module')
+def driver():
+    """Pytest fixture that yields a Selenium WebDriver instance"""
+    driver = create_driver()
+    try:
+        yield driver
+    finally:
+        driver.quit()
+
+
+def clean_window(driver):
+    # open new tab
+    driver.execute_script('window.open();')
+    # close old tab
+    driver.close()
+    # switch to new tab
+    driver.switch_to.window(driver.window_handles[0])
+
+
+def find_notebooks():
+    """Return a list of filenames of the example notebooks."""
+    path = os.path.dirname(__file__)
+    pattern = os.path.join(path, '..', '..', 'examples', '*.ipynb')
+    files = glob.glob(pattern)
+    files = [f for f in files if not f.endswith('.nbconvert.ipynb')]
+    if files:
+        return files
+    else:
+        raise IOError('Could not find the notebooks')
+
+
+@pytest.mark.parametrize('filepath', find_notebooks())
+def test_notebook(filepath, driver):
+    for filepath_html in get_notebook_html(filepath):
+        clean_window(driver)
+        driver.get('file://' + filepath_html)
+        wait = WebDriverWait(driver, timeout=10)
+        map_is_visible = visibility_of_element_located((By.CSS_SELECTOR, '.folium-map'))
+        try:
+            assert wait.until(map_is_visible)
+        except UnexpectedAlertPresentException:
+            # in Plugins.ipynb we get an alert about geolocation permission
+            # for some reason it cannot be closed or avoided, so just ignore it
+            print('skipping', filepath_html, 'because of alert')
+            continue
+        logs = driver.get_log('browser')
+        for log in logs:
+            if log['level'] == 'SEVERE':
+                msg = ' '.join(log['message'].split()[2:])
+                raise RuntimeError('Javascript error: "{}".'.format(msg))
+
+
+def get_notebook_html(filepath_notebook, execute=True):
+    """Store iframes from a notebook in html files, remove them when done."""
+    if execute:
+        subprocess.run([
+            'jupyter', 'nbconvert', '--to', 'notebook', '--execute', filepath_notebook,
+        ])
+        filepath_notebook = filepath_notebook.replace('.ipynb', '.nbconvert.ipynb')
+
+    html_exporter = nbconvert.HTMLExporter()
+    html_exporter.template_file = 'basic'
+    body, _ = html_exporter.from_filename(filepath_notebook)
+
+    parser = IframeParser()
+    parser.feed(body)
+    iframes = parser.iframes
+
+    for i, iframe in enumerate(iframes):
+        filepath_html = filepath_notebook.replace('.ipynb', '.{}.html'.format(i))
+        filepath_html = os.path.abspath(filepath_html)
+        with open(filepath_html, 'wb') as f:
+            f.write(iframe)
+        try:
+            yield filepath_html
+        finally:
+            os.remove(filepath_html)
+
+
+class IframeParser(HTMLParser):
+    """Extract the iframes from an html page."""
+
+    def __init__(self):
+        super().__init__()
+        self.iframes = []
+
+    def handle_starttag(self, tag, attrs):
+        if tag == 'iframe':
+            attrs = dict(attrs)
+            if 'data-html' in attrs:
+                html_base64 = attrs['data-html']
+            else:  # legacy, can be removed when all notebooks have `data-html`.
+                src = attrs['src']
+                html_base64 = src.split(',')[-1]
+            html_bytes = base64.b64decode(html_base64)
+            self.iframes.append(html_bytes)