Merge #135

135: Browser tests r=bidoubiwa a=sanders41

Closes #130

Co-authored-by: Paul Sanders <[email protected]>

Author: bors[bot]

.github/workflows/tests.yml

@@ -44,7 +44,7 @@ jobs:
       - name: Install dependencies
         run: pipenv install --dev
       - name: Run tests
-        run: pipenv run pytest ./scraper/src -k "not _browser"
+        run: pipenv run pytest
 
   integration_tests:
     strategy:
@@ -70,13 +70,13 @@ jobs:
         env:
           MEILISEARCH_HOST_URL: 'http://127.0.0.1:7700'
           MEILISEARCH_API_KEY: 'masterKey'
-          CONFIG_FILE: 'scraper/src/tests/config_files_examples/docs-basics.config.json'
+          CONFIG_FILE: 'tests/config_files_examples/docs-basics.config.json'
       - name: Run the scraper with custom config
         run: pipenv run ./docs_scraper $CONFIG_FILE
         env:
           MEILISEARCH_HOST_URL: 'http://127.0.0.1:7700'
           MEILISEARCH_API_KEY: 'masterKey'
-          CONFIG_FILE: 'scraper/src/tests/config_files_examples/docs-custom.config.json'
+          CONFIG_FILE: 'tests/config_files_examples/docs-custom.config.json'
 
   image_build:
     name: image-build

CONTRIBUTING.md

@@ -56,14 +56,47 @@ pipenv run ./docs_scraper <path-to-your-config-file>
 pipenv install --dev
 # Linter
 pipenv run pylint scraper
-# Tests
-pipenv run pytest ./scraper/src -k "not _browser"
 ```
 
+If you have [a `chromedriver`](https://sites.google.com/chromium.org/driver/), you can run the full test suite by passing the path to your `chromedriver`.
+
+```bash
+pipenv run pytest --chromedriver=/path/to/your/chromedriver
+```
+
+Where `path/to/your/chromedriver` matches your particular path. If you are unsure of your `chromedriver` path you find it on Linux/Mac with:
+
+
+```bash
+which chromedriver
+```
+
+Or on Windwos with:
+
+```bash
+where chromedriver
+```
+
+It is possible when running the tests that an error occurs if your running chrome browser has a different version than your chromedriver. In which case, please download the adequate [chromedriver](https://sites.google.com/chromium.org/driver/).
+
+If you do not have `chromedriver` installed you can skip the tests that require it by running the tests with:
+
+```bash
+pipenv run pytest -m "not chromedriver"
+```
+
+Note that these tests will still run in CI when you submit your pull request.
+
 Optionally tox can be used to run test on all supported version of Python and linting.
 
 ```bash
-pipenv run tox
+pipenv run tox -- --chromedriver=/path/to/your/chromedriver
+```
+
+Or to run tox if you don't have chromedriver
+
+```bash
+pipenv run tox -- -m "not chromedriver"
 ```
 
 ## Git Guidelines

pytest.ini

@@ -0,0 +1,3 @@
+[pytest]
+markers =
+    chromedriver: mark a test as a test using chromedriver.

scraper/src/tests/__init__.py tests/__init__.pyscraper/src/tests/__init__.py renamed to tests/__init__.py

@@ -1,5 +1,5 @@
 # coding: utf-8
-from ...config.config_loader import ConfigLoader
+from scraper.src.config.config_loader import ConfigLoader
 from .abstract import config
 
 

…g_files_examples/docs-basics.config.json …g_files_examples/docs-basics.config.jsonscraper/src/tests/config_files_examples/docs-basics.config.json renamed to tests/config_files_examples/docs-basics.config.json scraper/src/tests/config_files_examples/docs-basics.config.json renamed to tests/config_files_examples/docs-basics.config.json

@@ -1,5 +1,5 @@
 # coding: utf-8
-from ...config.config_loader import ConfigLoader
+from scraper.src.config.config_loader import ConfigLoader
 from .abstract import config
 import pytest