use Nox to run tests

Author: rmorshea

.github/workflows/release-pkg.yml

@@ -26,5 +26,5 @@ jobs:
           TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
           TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
         run: |
-          python setup.py bdist_wheel
+          python setup.py sdist bdist_wheel
           twine upload dist/*

.github/workflows/test.yml

@@ -23,6 +23,6 @@ jobs:
         with:
           python-version: ${{ matrix.python-version }}
       - name: Install Python Dependencies
-        run: pip install -r requirements/ci.txt
+        run: pip install -r requirements/test-run.txt
       - name: Run Tests
-        run: TOX_PARALLEL_NO_SPINNER=1 tox --parallel -- --headless
+        run: HEADLESS_BROWSER=1 nox

docs/source/installation.rst

@@ -72,13 +72,13 @@ simply run the following to re-evaluate the ``package.json``:
 Running The Tests
 -----------------
 
-The test suite for IDOM is executed using Tox_ and covers:
+The test suite for IDOM is executed using Nox_ and covers:
 
-1. Server-side Python code using PyTest_
+1. Server-side Python code with PyTest_
 
 2. The end-to-end application using Selenium_
 
-3. (`Coming soon <https://github.com/rmorshea/idom/issues/195>`_) Client side Javascript code
+3. (`Coming soon <https://github.com/idom-team/idom/issues/195>`_) Client side Javascript code
 
 To run the full suite of tests you'll need to install:
 
@@ -95,19 +95,13 @@ run:
 
 .. code-block:: bash
 
-    tox --factor py38
-
-.. note::
-
-    You can substitute ``py38`` for your prefered Python version, however only
-    a subset of the tests are configured to run on versions besides 3.8
-
+    nox
 
 If you prefer to run the tests using a headless browser:
 
 .. code-block:: bash
 
-    tox --factor py38 -- --headless
+    HEADLESS_BROWSER=1 nox
 
 
 Building The Documentation
@@ -119,7 +113,7 @@ installed ``docker`` you'll need to build and then run a container with the serv
 .. code-block:: bash
 
     docker build . --file docs/Dockerfile --tag idom-docs:latest
-    docker run -p 5000:5000 -e DEBUG=true -it idom-docs:latest
+    docker run -it -p 5000:5000 -e DEBUG=true --rm idom-docs:latest
 
 You should then navigate to http://127.0.0.1:5000 to see the documentation.
 
@@ -137,4 +131,4 @@ You should then navigate to http://127.0.0.1:5000 to see the documentation.
 .. _pip: https://pypi.org/project/pip/
 .. _PyTest: pytest <https://docs.pytest.org
 .. _Selenium: https://www.seleniumhq.org/
-.. _Tox: https://tox.readthedocs.io/en/latest/
+.. _Nox: https://nox.thea.codes/en/stable/#

idom/core/component.py

@@ -8,7 +8,7 @@
     from .vdom import VdomDict  # noqa
 
 
-ComponentConstructor = Callable[..., "Component"]
+ComponentConstructor = Callable[..., "AbstractComponent"]
 ComponentRenderFunction = Callable[..., Union["AbstractComponent", "VdomDict"]]
 
 

noxfile.py

@@ -0,0 +1,64 @@
+import os
+from typing import Iterable
+
+import nox
+from nox.sessions import Session
+
+
+HEADLESS_BROWSER = bool(int(os.environ.get("HEADLESS_BROWSER", "0")))
+BLACK_DEFAULT_EXCLUDE = r"\.eggs|\.git|\.hg|\.mypy_cache|\.nox|\.tox|\.venv|\.svn|_build|buck-out|build|dist"
+
+
+@nox.session
+def test_without_coverage(session: Session) -> None:
+    _test_setup(session)
+    session.install(".[all]")
+    _test_run(session, extra_args=["--no-cov"])
+
+
+@nox.session
+def test_with_coverage(session: Session) -> None:
+    _test_setup(session)
+    session.install("-e", ".[all]")  # coverage requires a dev install
+    _test_run(session)
+
+
+@nox.session
+def check_types(session: Session) -> None:
+    session.install("-r", "requirements/check-types.txt")
+    session.run("mypy", "--strict", "idom")
+    session.run("mypy", "tests")
+
+
+@nox.session
+def check_style(session: Session) -> None:
+    session.install("-r", "requirements/check-style.txt")
+    session.run(
+        "black",
+        ".",
+        "--check",
+        "--exclude",
+        rf"/({BLACK_DEFAULT_EXCLUDE}|node_modules)/",
+    )
+    session.run("flake8", "idom", "tests", "docs")
+
+
+@nox.session
+def build_docs(session: Session) -> None:
+    session.install("-r", "requirements/build-docs.txt")
+    session.install("-e", ".[all]")
+    session.run("sphinx-build", "-b", "html", "docs/source", "docs/build")
+    session.run("sphinx-build", "-b", "doctest", "docs/source", "docs/build")
+
+
+def _test_setup(session: Session) -> None:
+    session.env.update(os.environ)
+    session.install("-r", "requirements/test-env.txt")
+
+
+def _test_run(session: Session, extra_args: Iterable[str] = ()) -> None:
+    args = ["pytest", "tests"]
+    if HEADLESS_BROWSER:
+        args.append("--headless")
+    args.extend(extra_args)
+    session.run(*args)

requirements.txt

@@ -1,4 +1,11 @@
--r requirements/prod.txt
--r requirements/dev.txt
--r requirements/docs.txt
--r requirements/extras.txt
+pre-commit
+twine
+wheel
+setuptools_scm
+-r requirements/build-docs.txt
+-r requirements/check-style.txt
+-r requirements/check-types.txt
+-r requirements/pkg-deps.txt
+-r requirements/pkg-extras.txt
+-r requirements/test-env.txt
+-r requirements/test-run.txt