Skip to content

Commit

Permalink
Add bootstrap pip spec to the integration test docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jtpio committed Apr 27, 2020
1 parent 01ba348 commit 8af92e4
Showing 1 changed file with 10 additions and 9 deletions.
19 changes: 10 additions & 9 deletions docs/contributing/tests.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,17 @@ Unit and integration tests are a core part of TLJH, as important as
the code & documentation. They help validate that the code works as
we think it does, and continues to do so when changes occur. They
also help communicate in precise terms what we expect our code
to do.
to do.

Integration tests
=================

TLJH is a *distribution* where the primary value is the many
TLJH is a *distribution* where the primary value is the many
opinionated choices we have made on components to use and how
they fit together. Integration tests are perfect for testing
that the various components fit together and work as they should.
So we write a lot of integration tests, and put in more effort
towards them than unit tests.
towards them than unit tests.

All integration tests are run on `CircleCI <https://circleci.com>`_
for each PR and merge, making sure we don't have broken tests
Expand All @@ -33,24 +33,25 @@ Running integration tests locally
---------------------------------

You need ``docker`` installed and callable by the user running
the integration tests without needing sudo.
the integration tests without needing sudo.

You can then run the tests with:

.. code-block:: bash
.circleci/integration-test run-test <name-of-run> <test-file-names>
.circleci/integration-test.py run-test <name-of-run> <bootstrap-pip-spec> <test-file-names>
``<name-of-run>`` is an identifier for the tests - you can choose
anything you want. ``<test-file-names>>`` is list of test files
(under ``integration-tests``) that should be run in one go.
- ``<name-of-run>`` is an identifier for the tests - you can choose anything you want
- ``<bootstrap-pip-spec>`` is the pip spec for the bootstrap script. An empty value (``""``) defaults to
``git+https://github.com/jupyterhub/the-littlest-jupyterhub.git``.
- ``<test-file-names>>`` is list of test files (under ``integration-tests``) that should be run in one go.

For example, to run all the basic tests, you would write:

.. code-block:: bash
.circleci/integration-test.py run-test basic-tests \
.circleci/integration-test.py run-test basic-tests "" \
test_hub.py \
test_install.py \
test_extensions.py
Expand Down

0 comments on commit 8af92e4

Please sign in to comment.