Skip to content

Commit 8c9309b

Browse files
authored
Merge pull request #2011 from cglewis/master
update documentation for running only a single integration test
2 parents fcca433 + de67033 commit 8c9309b

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

docs/testing.rst

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ Running the tests
150150
-v /tmp:/tmp \
151151
-ti faucet/tests
152152
153-
Running a single test
153+
Running a single test including pytype, linting, and documentation
154154
~~~~~~~~~~~~~~~~~~~~~
155155

156156
.. code:: console
@@ -175,6 +175,21 @@ in order to complete a faucet test suite run against hardware quicker.
175175
-v /tmp:/tmp \
176176
-ti faucet/tests
177177
178+
Running only a single integration test
179+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
180+
181+
Sometimes you will want to skip the pytype, linting and documenation tests
182+
and simply run a single integration test. Optionally ``-k`` will also save
183+
the results.
184+
185+
.. code:: console
186+
187+
sudo docker run --privileged --net=host \
188+
-e FAUCET_TESTS="-i -n -k FaucetUntaggedLLDPTest" \
189+
-v /etc/faucet:/etc/faucet \
190+
-v /tmp:/tmp \
191+
-ti faucet/tests
192+
178193
Checking test results
179194
~~~~~~~~~~~~~~~~~~~~~
180195

0 commit comments

Comments
 (0)