aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorWojtek Kosior <koszko@koszko.org>2022-02-17 16:05:20 +0100
committerWojtek Kosior <koszko@koszko.org>2022-02-17 16:09:57 +0100
commit3e4bde861cdee3312e1d410dc08f67d8e7c9168c (patch)
tree2b3da5e016a7354410d9003a96923d5e1a0c3347 /README.md
parent753fd58a5778b634dcc9849d3ecb3fb5feb62154 (diff)
downloadbrowser-extension-3e4bde861cdee3312e1d410dc08f67d8e7c9168c.tar.gz
browser-extension-3e4bde861cdee3312e1d410dc08f67d8e7c9168c.zip
fix test-environment* targets
Diffstat (limited to 'README.md')
-rw-r--r--README.md9
1 files changed, 9 insertions, 0 deletions
diff --git a/README.md b/README.md
index c122dd3..888990c 100644
--- a/README.md
+++ b/README.md
@@ -116,6 +116,15 @@ python3 -m pytest -vv -k popup
As of Haketilo 1.0-beta1 some tests may spuriously fail. This is the result it being notoriously difficult to avoid some weirdnesses when driving Firefox using Selenium. To make sure a failed test is not the result of some more serious bug, you might want to rerun the test suite.
+### Setting up an environment for manual testing
+
+The automated tests are run with browser's all network requests going through a Python proxy. The proxy allows us to mock websites that are then navigated to in the browser. At times you might want to replicate this test environment while playing manually with the browser. A poor man's approach is to add something like:
+``` python
+from time import sleep
+sleep(100000)
+```
+inside one of the test functions and then run that test function from Pytest (with `MOZ_HEADLESS` unset!). This might make sense when debugging some particular test case. For general experiments we have instead provided convenience targets `make test-environment` and `make test-environment-with-haketilo`. Running any of those will spawn a browser window *together* with a Python shell where `driver` variable will hold Selenium driver object controlling that browser. In case of the `test-environment-with-haketilo` target the browser will additionally appear with Haketilo loaded into it.
+
## Copying
All copyright information is gathered in the `copyright` file which follows the [format of debian/copyright file](https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/). License notices are also present in all text files of the extension.