[PATCH 4/4] Write test/README.md to help working with tests

Frédéric Mangano-Tarumi fmang at mg0.fr
Sat Feb 29 00:02:42 UTC 2020

 test/README.md | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)
 create mode 100644 test/README.md

diff --git a/test/README.md b/test/README.md
new file mode 100644
index 00000000..c48001d8
--- /dev/null
+++ b/test/README.md
@@ -0,0 +1,38 @@
+Running tests
+To run all the tests, you may run `make check` under `test/`.
+For more control, you may use the `prove` command, which receives a directory or
+a list of files to run, and produces a report.
+Each test script is standalone, so you may run them individually. Some tests may
+receive command-line options to help debugging. See for example sharness’s
+documentation for shell test scripts:
+### Dependencies
+For all the test to run, the following Arch packages should be installed:
+- pyalpm
+- python-alembic
+- python-bleach
+- python-markdown
+- python-pygit2
+- python-sqlalchemy
+- python-srcinfo
+Writing tests
+Test scripts must follow the Test Anything Protocol specification:
+Tests must support being run from any directory. They may use $0 to determine
+their location. Python scripts should expect aurweb to be installed and
+importable without toying with os.path or PYTHONPATH.
+Tests written in shell should use sharness. In general, new tests should be
+consistent with existing tests unless they have a good reason not to.

More information about the aur-dev mailing list