Merge pull request #1276 from dannysepler/contributing

✏️ Fill in missing steps in CONTRIBUTING.md

Author: alexcjohnson

.circleci/config.yml

@@ -59,7 +59,7 @@ jobs:
           name: 🐍 Python Unit Tests & ☕ JS Unit Tests
           command: |
             . venv/bin/activate
-            npm run test.unit
+            npm run citest.unit
 
   lint-unit-36:
       <<: *lint-unit
@@ -349,7 +349,7 @@ jobs:
           name: 🧪 Run Integration Tests
           command: |
             . venv/bin/activate
-            npm run test.integration
+            npm run citest.integration
       - store_artifacts:
           path: test-reports
       - store_test_results:

CONTRIBUTING.md

@@ -16,10 +16,13 @@ $ pip install -e .[testing,dev]  # in some shells you need \ to escape []
 $ cd dash-renderer
 # build renderer bundles, this will build all bundles from source code
 # the only true source of npm version is defined in package.json
+$ npm install
 $ npm run build  # or `renderer build`
 # install dash-renderer for development
 $ pip install -e .
 # build and install components used in tests
+$ cd .. # should be back in dash/ root directory
+$ npm install
 $ npm run setup-tests
 # you should see both dash and dash-renderer are pointed to local source repos
 $ pip list | grep dash
@@ -48,9 +51,7 @@ When a change in renderer code doesn't reflect in your browser as expected, this
 
 Writing Python 2/3 compatible code might be a challenging task for contributors used to working on one particular version, especially new learners who start directly with Python 3.
 
-From the #892, we started to adopt `python-future` instead of `six` as our tool to better achieve the goal where we can mainly write Python 3 code and make it back-compatible in Python 2.7 (last Python 2 version Dash supports before it gets deprecated).
-
-Please refer to [this list of idioms](https://python-future.org/compatible_idioms.html "https://python-future.org/compatible_idioms.html") for more details on working with `python-future`.
+We use `python-future` as our tool to  mainly write Python 3 code and make it back-compatible to Python 2.7 (the only Python 2 version Dash supports). Please refer to [this list of idioms](https://python-future.org/compatible_idioms.html "https://python-future.org/compatible_idioms.html") for more details on working with `python-future`.
 
 ## Git
 
@@ -98,13 +99,15 @@ Emojis make the commit messages :cherry_blossom:. If you have no idea about what
 
 ### Coding Style
 
-We use both `flake8` and `pylint` for basic linting check, please refer to the relevant steps in `.circleci/config.yml`.
-
-Note that we also start using [`black`](https://black.readthedocs.io/en/stable/) as formatter during the test code migration.
+We use `flake8`, `pylint`, and [`black`](https://black.readthedocs.io/en/stable/) for linting. please refer to the relevant steps in `.circleci/config.yml`.
 
 ## Tests
 
-We started migrating to [pytest](https://docs.pytest.org/en/latest/) from `unittest` as our test automation framework. You will see more testing enhancements in the near future.
+Our tests use Google Chrome via Selenium. You will need to install [ChromeDriver](http://chromedriver.chromium.org/getting-started) matching the version of Chrome installed on your system. Here are some helpful tips for [Mac](https://www.kenst.com/2015/03/installing-chromedriver-on-mac-osx/) and [Windows](http://jonathansoma.com/lede/foundations-2018/classes/selenium/selenium-windows-install/).
+
+We use [pytest](https://docs.pytest.org/en/latest/) as our test automation framework, plus [jest](https://jestjs.io/) for a few renderer unit tests. You can `npm run test` to run them all, but this command simply runs `pytest` with no arguments, then `cd dash-renderer && npm run test` for the renderer unit tests.
+
+Most of the time, however, you will want to just run a few relevant tests and let CI run the whole suite. `pytest` lets you specify a directory or file to run tests from (eg `pytest tests/unit`) or a part of the test case name using `-k` - for example `pytest -k cbcx004` will run a single test, or `pytest -k cbcx` will run that whole file. See the [testing tutorial](https://dash.plotly.com/testing) to learn about the test case ID convention we use.
 
 ### Unit Tests
 

package.json

@@ -16,16 +16,17 @@
     "private::test.py.deploy-standard": "npm run private::test.setup-standard && cd \\@plotly/dash-generator-test-component-standard && pip install -e .",
     "private::test.R.deploy-nested": "npm run private::test.setup-nested && cd \\@plotly/dash-generator-test-component-nested && sudo R CMD INSTALL .",
     "private::test.R.deploy-standard": "npm run private::test.setup-standard && cd \\@plotly/dash-generator-test-component-standard && sudo R CMD INSTALL .",
-    "private::test.unit-dash": "PYTHONPATH=~/dash/tests/assets pytest tests/unit",
+    "private::test.unit-dash": "pytest tests/unit",
     "private::test.unit-renderer": "cd dash-renderer && npm run test",
     "private::test.integration-dash": "TESTFILES=$(circleci tests glob \"tests/integration/**/test_*.py\" | circleci tests split --split-by=timings) && pytest --headless --nopercyfinalize --junitxml=test-reports/junit_intg.xml ${TESTFILES}",
     "format": "run-s private::format.*",
     "initialize": "run-s private::initialize.*",
     "lint": "run-s private::lint.*",
     "setup-tests.py": "run-s private::test.py.deploy-*",
     "setup-tests.R": "run-s private::test.R.deploy-*",
-    "test.integration": "run-s setup-tests.py private::test.integration-*",
-    "test.unit": "run-s private::test.unit-**"
+    "citest.integration": "run-s setup-tests.py private::test.integration-*",
+    "citest.unit": "run-s private::test.unit-**",
+    "test": "pytest && cd dash-renderer && npm run test"
   },
   "devDependencies": {
     "husky": "4.2.3"

tests/unit/test_app_runners.py

@@ -1,3 +1,4 @@
+import os
 import sys
 import requests
 import pytest
@@ -25,7 +26,14 @@ def test_threaded_server_smoke(dash_thread_server):
     sys.version_info < (3,), reason="requires python3 for process testing"
 )
 def test_process_server_smoke(dash_process_server):
-    dash_process_server("simple_app")
-    r = requests.get(dash_process_server.url)
-    assert r.status_code == 200, "the server is reachable"
-    assert 'id="react-entry-point"' in r.text, "the entrypoint is present"
+    cwd = os.getcwd()
+    this_dir = os.path.dirname(__file__)
+    assets_dir = os.path.abspath(os.path.join(this_dir, "..", "assets"))
+    try:
+        os.chdir(assets_dir)
+        dash_process_server("simple_app")
+        r = requests.get(dash_process_server.url)
+        assert r.status_code == 200, "the server is reachable"
+        assert 'id="react-entry-point"' in r.text, "the entrypoint is present"
+    finally:
+        os.chdir(cwd)