aboutsummaryrefslogtreecommitdiff
path: root/docs/en
diff options
context:
space:
mode:
authorGravatar Marien Fressinaud <dev@marienfressinaud.fr> 2019-12-29 13:55:45 +0100
committerGravatar Alexandre Alapetite <alexandre@alapetite.fr> 2019-12-29 13:55:45 +0100
commit6bc963569beb58d0799df4f747a2dcf1bcf8bf7b (patch)
treedf68b961134d8907e98a9970eee249951b156231 /docs/en
parent518672fd279e97afeee0756ea812cd7f89c2f778 (diff)
tec: Add a test target to Makefile (#2725)
* tec: Add a test target to Makefile Minor edit put php7-phar on third line I try to keep on the third line the Alpine-specific PHP extensions (i.e. that are not by default in Ubuntu), and in alphabetic order Co-Authored-By: Alexandre Alapetite <alexandre@alapetite.fr> * Allow to run make test without Docker
Diffstat (limited to 'docs/en')
-rw-r--r--docs/en/developers/03_Running_tests.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/docs/en/developers/03_Running_tests.md b/docs/en/developers/03_Running_tests.md
new file mode 100644
index 000000000..ce061cc5b
--- /dev/null
+++ b/docs/en/developers/03_Running_tests.md
@@ -0,0 +1,25 @@
+# Running tests
+
+FreshRSS is tested with [PHPUnit](https://phpunit.de/). No code should be merged in `master` if the tests don't pass.
+
+## Locally
+
+As a developer, you can run the test suite on your PC easily with `make` commands. You can run the test suite with:
+
+```console
+$ make test
+```
+
+This command downloads the PHPUnit binary and verifies its checksum. If the verification fails, the file is deleted. In this case, you should [open an issue on GitHub](https://github.com/FreshRSS/FreshRSS/issues/new) to let maintainers know about the problem.
+
+Then, it executes PHPUnit in a Docker container. If you don't use Docker, you can run the command directly with:
+
+```console
+$ NO_DOCKER=true make test
+```
+
+## Travis
+
+Tests are automatically run when you open a pull request on GitHub. It is done with [Travis CI](https://travis-ci.org/FreshRSS/FreshRSS/). This is done to ensure there is no regressions in your code. We cannot merge a PR if the tests fail so we'll ask you to fix bugs before to review your code.
+
+If you're interested in, you can take a look at [the configuration file](https://github.com/FreshRSS/FreshRSS/blob/master/.travis.yml).