summaryrefslogtreecommitdiff
path: root/BUILD.md
diff options
context:
space:
mode:
authorMicah Lee <micah@micahflee.com>2020-08-21 19:41:29 -0400
committerMicah Lee <micah@micahflee.com>2020-08-21 19:41:29 -0400
commit24b7316b3ea437c60638910f4badd4f2fef2071e (patch)
tree25c36703c83ad9ed96c731cd358ae3f442964a46 /BUILD.md
parent9b78f23ca32feebeec4c866e6a53cd6535c0ebd9 (diff)
downloadonionshare-24b7316b3ea437c60638910f4badd4f2fef2071e.tar.gz
onionshare-24b7316b3ea437c60638910f4badd4f2fef2071e.zip
Updated build instructions for running tests
Diffstat (limited to 'BUILD.md')
-rw-r--r--BUILD.md14
1 files changed, 8 insertions, 6 deletions
diff --git a/BUILD.md b/BUILD.md
index f85b22d1..16c7395d 100644
--- a/BUILD.md
+++ b/BUILD.md
@@ -264,6 +264,8 @@ This will prompt you to codesign three binaries and execute one unsigned binary.
# Running tests
+## Tests in macOS and Linux
+
OnionShare includes PyTest unit tests. To run tests, you can run `pytest` against the `tests/` directory.
```sh
@@ -276,18 +278,18 @@ You can run GUI tests like this:
poetry run ./tests/run.sh --rungui
```
-If you would like to also run the GUI unit tests in 'tor' mode, start Tor Browser in the background, then run:
+If you're using Linux, you can also choose to wrap the tests in `xvfb-run` so that a ton of OnionShare windows don't pop up on your desktop (you may need to install the `xorg-x11-server-Xvfb` package), like this:
```sh
-poetry run ./tests/run.sh --rungui --runtor
+xvfb-run poetry run ./tests/run.sh --rungui
```
-Keep in mind that the Tor tests take a lot longer to run than local mode, but they are also more comprehensive.
+## Tests in Windows
-You can also choose to wrap the tests in `xvfb-run` so that a ton of OnionShare windows don't pop up on your desktop (you may need to install the `xorg-x11-server-Xvfb` package), like this:
+You can run this Windows batch script to run all of the CLI and GUI tests.
-```sh
-xvfb-run poetry run ./tests/run.sh --rungui
+```
+poetry run tests\run.bat
```
# Making releases