aboutsummaryrefslogtreecommitdiffstats
path: root/tests/README.md
diff options
context:
space:
mode:
authorKlaus Weidenbach <Klaus.Weidenbach@gmx.net>2016-10-12 21:50:49 +0200
committerKlaus Weidenbach <Klaus.Weidenbach@gmx.net>2016-10-19 00:46:41 +0200
commitb92e3ca3ee3f8bed1ff52311d29b4ce1e4297a83 (patch)
treefe4d742c662b65605d0b6fee8fbf3f5a9e9b66e5 /tests/README.md
parent2e1046220a70bb751c39854b881e86feb5d39149 (diff)
downloadvolse-hubzilla-b92e3ca3ee3f8bed1ff52311d29b4ce1e4297a83.tar.gz
volse-hubzilla-b92e3ca3ee3f8bed1ff52311d29b4ce1e4297a83.tar.bz2
volse-hubzilla-b92e3ca3ee3f8bed1ff52311d29b4ce1e4297a83.zip
[TASK] Restructure tests/ folder.
Move unit tests to tests/unit/. Get the old still working UnitTests into a working state again. Updated composer.json with required-dev packages. Create a new folder tests/acceptance for Behat functional/acceptance testing. Add a first Feature draft of a Behat functional test for local login.
Diffstat (limited to 'tests/README.md')
-rw-r--r--tests/README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/tests/README.md b/tests/README.md
new file mode 100644
index 000000000..395333159
--- /dev/null
+++ b/tests/README.md
@@ -0,0 +1,25 @@
+The folder tests/ contains resources for automated testing tools.
+
+Here you will find PHPUnit, Behat, etc. files to test the functionaly
+of Hubzilla. Right now it only contains some basic tests to see if feasable
+this can help improve the project.
+
+# Contents
+
+* unit/ PHPUnit tests
+These are unit tests to check the smallest parts, like single functions.
+It uses the tool PHPUnit https://phpunit.de/
+
+* acceptance/ functional/acceptance testing
+These are behavioral or so called functional/acceptance testing. They
+are used to test business logic. They are written in Gherkin and use
+the tool Behat http://behat.org/
+
+# How to use?
+You need the dev tools which are defined in the composer.json in the
+require-dev configuration.
+Run ```composer install``` without --no-dev to install these tools.
+
+To run unit tests run ```vendor/bin/phpunit tests/unit/```
+
+To run acceptance tests run ```vendor/bin/behat --config tests/acceptance/behat.yml```