aboutsummaryrefslogtreecommitdiffstats
path: root/tests/RUNNING_TESTS.md
diff options
context:
space:
mode:
authorMarc Alexander <admin@m-a-styles.de>2018-01-14 12:59:01 +0100
committerMarc Alexander <admin@m-a-styles.de>2018-01-14 12:59:01 +0100
commit3469545e3ad934bcb1fc9ac0c527b59aa97c072b (patch)
treef283aced4a8b10b5be78528d6b338e9243d6ab37 /tests/RUNNING_TESTS.md
parent7f6ececf95da25ce37e6f1359755d62820a3b2ce (diff)
downloadforums-3469545e3ad934bcb1fc9ac0c527b59aa97c072b.tar
forums-3469545e3ad934bcb1fc9ac0c527b59aa97c072b.tar.gz
forums-3469545e3ad934bcb1fc9ac0c527b59aa97c072b.tar.bz2
forums-3469545e3ad934bcb1fc9ac0c527b59aa97c072b.tar.xz
forums-3469545e3ad934bcb1fc9ac0c527b59aa97c072b.zip
[ticket/15516] Add instructions for running UI tests
PHPBB3-15516
Diffstat (limited to 'tests/RUNNING_TESTS.md')
-rw-r--r--tests/RUNNING_TESTS.md25
1 files changed, 23 insertions, 2 deletions
diff --git a/tests/RUNNING_TESTS.md b/tests/RUNNING_TESTS.md
index c9941d61e5..3bff4f5d26 100644
--- a/tests/RUNNING_TESTS.md
+++ b/tests/RUNNING_TESTS.md
@@ -143,14 +143,14 @@ If you want all tests, run:
Functional tests
------------------
+================
Functional tests test software the way a user would. They simulate a user
browsing the website, but they do these steps in an automated way.
phpBB allows you to write such tests.
Running
-=======
+-------
Running the tests requires your phpBB3 repository to be accessible through a
local web server. You will need to supply the URL to the webserver in
@@ -170,6 +170,27 @@ If you only want the functional tests, run:
This will change your board's config.php file, but it makes a backup at
config_dev.php, so you can restore it after the test run is complete.
+UI tests
+========
+
+UI tests are functional tests that also support running JavaScript in a
+headless browser. These should be used when functionality that is only
+executed using JS needs to be tested. The require a running
+[PhantomJS WebDriver instance](http://phantomjs.org/). The executable can
+either be downloaded from [PhantomJS](http://phantomjs.org/download.html)
+or alternatively be installed with npm:
+
+ $ npm install -g phantomjs-prebuilt
+
+You might have to run the command as superuser / administrator on some
+systems. Afterwards, a new WebDriver instance can be started via command
+line:
+
+ $ phantomjs --webdriver=127.0.0.1:8910
+
+Port 8910 is the default port that will be used by UI tests to connect
+to the WebDriver instance.
+
More Information
================