Skip to content

Commit 15af00a

Browse files
committed
Update README instructions
1 parent d3186af commit 15af00a

1 file changed

Lines changed: 21 additions & 6 deletions

File tree

README.md

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,32 @@ Basic test framework for using Travis CI with phpBB Extensions
66
You can setup your extension to use this by following these steps:
77

88
1. Copy the example.travis.yml file into your extension directory.
9-
2. Rename the file .travis.yml
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

18+
* * *
19+
1520
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/*` to `phpBB/ext/your/extension/travis/*`
30+
31+
4. Duplicate `travis/phpunit-mysql-travis.xml` and rename it to `phpunit-mysql-local.xml`
32+
33+
5. Edit `phpunit-mysql-local.xml` changing the SERVER CONFIG settings to match your phpBB config.php settings:
34+
35+
6. Run the tests from the command line using:
36+
37+
`phpBB/vendor/bin/phpunit -c phpBB/ext/your/extension/travis/phpunit-mysql-local.xml`

0 commit comments

Comments
 (0)