Version 1

[yaffs-website] / web / core / tests / README.md

diff --git a/web/core/tests/README.md b/web/core/tests/README.md
new file mode 100644 (file)
index 0000000..5dd6cc6
--- /dev/null
+++ b/web/core/tests/README.md
@@ -0,0 +1,48 @@
+# Running tests
+
+## Functional tests
+
+* Start PhantomJS:
+  ```
+  phantomjs --ssl-protocol=any --ignore-ssl-errors=true ./vendor/jcalderonzumba/gastonjs/src/Client/main.js 8510 1024 768 2>&1 >> /dev/null &
+  ```
+* Run the functional tests:
+  ```
+  export SIMPLETEST_DB='mysql://root@localhost/dev_d8'
+  export SIMPLETEST_BASE_URL='http://d8.dev'
+  ./vendor/bin/phpunit -c core --testsuite functional
+  ./vendor/bin/phpunit -c core --testsuite functional-javascript
+  ```
+
+Note: functional tests have to be invoked with a user in the same group as the
+web server user. You can either configure Apache (or nginx) to run as your own
+system user or run tests as a privileged user instead.
+
+To develop locally, a straightforward - but also less secure - approach is to
+run tests as your own system user. To achieve that, change the default Apache
+user to run as your system user. Typically, you'd need to modify
+`/etc/apache2/envvars` on Linux or `/etc/apache2/httpd.conf` on Mac.
+
+Example for Linux:
+
+```
+export APACHE_RUN_USER=<your-user>
+export APACHE_RUN_GROUP=<your-group>
+```
+
+Example for Mac:
+
+```
+User <your-user>
+Group <your-group>
+```
+
+If the default user is e.g. `www-data`, the above functional tests will have to
+be invoked with sudo instead:
+
+```
+export SIMPLETEST_DB='mysql://root@localhost/dev_d8'
+export SIMPLETEST_BASE_URL='http://d8.dev'
+sudo -u www-data -E ./vendor/bin/phpunit -c core --testsuite functional
+sudo -u www-data -E ./vendor/bin/phpunit -c core --testsuite functional-javascript
+```