Skip to content
This repository was archived by the owner on May 18, 2024. It is now read-only.

Commit 7a52ba0

Browse files
committed
Update docs
1 parent 3b06f99 commit 7a52ba0

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,18 @@ for **CIModuleTests**:
2626

2727
See the provided [composer.json](src/composer.json) for examples.
2828

29+
## Customizing
30+
31+
The **_support** directory comes loaded with easy-to-use examples of test cases and their
32+
support files, but you will probably want to modify or replace these with your own versions.
33+
There is no harm in leaving files in place you do not need.
34+
* **tests/_support/DatabaseTestCase.php**
35+
* **tests/_support/SessionTestCase.php**
36+
* **tests/_support/DatabaseTestCase.php**
37+
* **tests/_support/Database/Migrations/create_test_tables.php**
38+
* **tests/_support/Database/Seeds/ExampleSeeder.php**
39+
* **tests/_support/Models/ExampleModel.php**
40+
2941
## Creating Tests
3042

3143
All tests go in the **tests/** directory. There are two generic subfolders for you,
@@ -79,3 +91,7 @@ Other common modifications would be removing the attributes from the whitelist e
7991
As this repo is updated with bugfixes and improvements you will want to update the code
8092
merged into your modules. Because tests need to be top-level and should not include their
8193
own repository info you will need to handle updates manually.
94+
95+
If you added **CIModuleTests** to your package via Composer you can access the latest
96+
version by running `composer update` and merging files from
97+
**vendor/mgatner/ci-module-tests/src/** into your **tests/** directory.

0 commit comments

Comments
 (0)