Skip to content

Commit 7c4a647

Browse files
committed
Merge pull request #13 from VSEphpbb/update
Update README
2 parents d3186af + 945009f commit 7c4a647

1 file changed

Lines changed: 25 additions & 8 deletions

File tree

README.md

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,35 @@ Basic test framework for using Travis CI with phpBB Extensions
55

66
You can setup your extension to use this by following these steps:
77

8-
1. Copy the example.travis.yml file into your extension directory.
9-
2. Rename the file .travis.yml
8+
1. Copy the **example.travis.yml** file into your extension directory.
9+
10+
2. Rename the file **.travis.yml**
11+
1012
3. Edit the file and change the VENDOR= and NAME= lines to fit your extension.
11-
4. Add any tests you wish in your repository under tests/ (the format should be the same as the phpBB tests).
13+
14+
4. Add any tests you wish in your repository under `tests/` (the format should be the same as the phpBB tests).
1215

1316
If you wish to see a simple example: https://github.com/phpbb-extensions/test-framework/tree/example
1417

15-
If you wish to run your tests on your local system (from a checked out copy of phpbb develop):
18+
* * *
19+
20+
If you wish to run your tests on your local system (from a checked out copy of phpBB develop):
1621

1722
Note: Change your/extension to your vendor name/extension name.
1823

19-
1. Copy tests/framework/* to phpBB/ext/your/extension/tests/framework/*
20-
2. Edit tests/bootstrap.php and add these lines at the end:<br />
21-
require_once $phpbb_root_path . 'ext/your/extension/tests/framework/extension_database_test_case.php';<br />
22-
require_once $phpbb_root_path . 'ext/your/extension/tests/framework/extension_functional_test_case.php';
24+
1. Clone your extension into your checked out copy of phpBB develop to:
25+
`phpBB/ext/your/extension/`
26+
27+
2. Copy `tests/framework/*` to `phpBB/ext/your/extension/tests/framework/*`
28+
29+
3. Copy `travis/bootstrap.php` to `phpBB/ext/your/extension/tests/bootstrap.php`
30+
31+
4. Copy `travis/phpunit-mysql-travis.xml` to `phpBB/ext/your/extension/tests/phpunit-mysql-travis.xml`
32+
33+
5. Rename **phpunit-mysql-travis.xml** to **phpunit-mysql-local.xml**
34+
35+
5. Edit **phpunit-mysql-local.xml** changing the server config settings to match your phpBB config.php settings:
36+
37+
6. Run the tests from the command line using:
38+
39+
`phpBB/vendor/bin/phpunit -c phpBB/ext/your/extension/tests/phpunit-mysql-local.xml`

0 commit comments

Comments
 (0)