From db0a4f903976c3e0a4f4d0c5fa7f7a543be0e90e Mon Sep 17 00:00:00 2001 From: Jacob Hoffman-Andrews Date: Tue, 28 Mar 2017 16:15:09 -0700 Subject: [PATCH] Document tests/integration/_common.sh. This makes it much easier to run certbot during development. --- docs/contributing.rst | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/contributing.rst b/docs/contributing.rst index 5cdf86147..cc24ad898 100644 --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -39,17 +39,17 @@ Then in each shell where you're working on the client, do: .. code-block:: shell source ./venv/bin/activate + . tests/integration/_common.sh After that, your shell will be using the virtual environment, and you run the -client by typing: +client by typing `certbot` or `certbot_test`. The latter is an alias that +includes several flags useful for testing. For instance, it sets various output +directories to point to /tmp/, and uses non-privileged ports for challenges, so +root privileges are not required. -.. code-block:: shell - - certbot - -Activating a shell in this way makes it easier to run unit tests -with ``tox`` and integration tests, as described below. To reverse this, you -can type ``deactivate``. More information can be found in the `virtualenv docs`_. +Activating a shell with `venv/bin/activate` sets environment variables so that +Python pulls in the correct versions of various packages needed by Certbot. +More information can be found in the `virtualenv docs`_. .. _`virtualenv docs`: https://virtualenv.pypa.io