This repository was archived by the owner on May 18, 2024. It is now read-only.
File tree Expand file tree Collapse file tree 2 files changed +12
-5
lines changed Expand file tree Collapse file tree 2 files changed +12
-5
lines changed Original file line number Diff line number Diff line change @@ -5,7 +5,7 @@ PHPUnit testing scaffold for CodeIgniter 4 modules
55## Overview
66
77Not a module itself but a testing scaffold for CodeIgniter 4 modules,
8- ** module-tests ** makes it easy to setup PHPUnit tests in your modules.
8+ ** ModuleTests ** makes it easy to setup PHPUnit tests in your modules.
99
1010To read more on Unit Testing in CodeIgniter 4 visit the
1111[ User Guide] ( https://codeigniter4.github.io/userguide/testing/index.html ) .
@@ -74,3 +74,10 @@ in **build/logs/**.
7474## Code Coverage
7575
7676See the docs on [ Code Coverage] ( docs/COVERAGE.md ) .
77+
78+ ## Project Testing
79+
80+ ** ModuleTests** is designed to be added to your modular library which will be included into
81+ other CodeIgniter 4 projects. If you are looking for a testing scaffold for applications
82+ built using CodeIgniter 4 as their core framework, check out
83+ [ Codeigniter4Projects/ProjectTests] ( https://github.com/codeigniter4projects/project-tests ) .
Original file line number Diff line number Diff line change 55
66## Overview
77
8- ** ci4-module-tests ** comes preconfigured to handle code coverage in addition to the unit tests.
8+ ** ModuleTests ** comes preconfigured to handle code coverage in addition to the unit tests.
99You will need to have a code coverage driver installed to use this feature, such as
1010[ Xdebug] ( https://xdebug.org ) .
1111
1212## Setup
1313
14- ** ci4-module-tests ** assumes your source code is in ** src/** ; if your code is somewhere else
14+ ** ModuleTests ** assumes your source code is in ** src/** ; if your code is somewhere else
1515then you will need to modify the following line in your PHPUnit XML file:
1616```
1717 <directory suffix=".php">./src</directory>
1818```
1919
2020## PHPUnit.xml
2121
22- ** ci4-module-tests ** includes a ready-to-use PHPUnit template in ** phpunit.xml.dist** .
22+ ** ModuleTests ** includes a ready-to-use PHPUnit template in ** phpunit.xml.dist** .
2323Common practice is to create a local copy of this file as ** phpunit.xml** and add any
2424sensitive or environment info (like database connections). Prevent ** phpunit.xml** from
2525being tracked in your repo by adding it to ** .gitignore** .
@@ -30,7 +30,7 @@ being tracked in your repo by adding it to **.gitignore**.
3030
3131In addition to the code source mentioned above, PHPUnit can be configured to exclude files
3232that are not relevant to testing or would otherwise cause the coverage calculations to fail.
33- ** ci4-module-tests ** starts with a few files common to CodeIgniter 4 but you may need to add
33+ ** ModuleTests ** starts with a few files common to CodeIgniter 4 but you may need to add
3434your own:
3535```
3636 <exclude>
You can’t perform that action at this time.
0 commit comments