malhuda/CodeIgniter4
1
0
Fork 0
mirror of https://github.com/codeigniter4/CodeIgniter4.git synced 2025-02-20 11:44:28 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: remove spaces at the end of the lines

Browse Source
This commit is contained in:
kenjis 2022-07-18 08:42:12 +09:00
parent caf48b3728
commit 17b5c3f6dc
No known key found for this signature in database
GPG Key ID: BD254878922AF198
3 changed files with 62 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
admin/module/tests/README.md
View File

@ -1,8 +1,8 @@
# Running Module Tests
This is the quick-start to CodeIgniter testing. Its intent is to describe what
it takes to set up your module and get it ready to run unit tests.
It is not intended to be a full description of the test features that you can
This is the quick-start to CodeIgniter testing. Its intent is to describe what
it takes to set up your module and get it ready to run unit tests.
It is not intended to be a full description of the test features that you can
use to test your module. Those details can be found in the documentation.
## Resources
@ -11,9 +11,9 @@ use to test your module. Those details can be found in the documentation.
## Requirements
It is recommended to use the latest version of PHPUnit. At the time of this
writing we are running version 8.5.13. Support for this has been built into the
**composer.json** file that ships with CodeIgniter and can easily be installed
It is recommended to use the latest version of PHPUnit. At the time of this
writing we are running version 8.5.13. Support for this has been built into the
**composer.json** file that ships with CodeIgniter and can easily be installed
via [Composer](https://getcomposer.org/) if you don't already have it installed globally.
> composer install
@ -27,10 +27,10 @@ for code coverage to be calculated successfully.
## Setting Up
A number of the tests use a running database.
In order to set up the database edit the details for the `tests` group in
A number of the tests use a running database.
In order to set up the database edit the details for the `tests` group in
**phpunit.xml**. Make sure that you provide a database engine that is currently running
on your machine. More details on a test database setup are in the
on your machine. More details on a test database setup are in the
*Docs>>Testing>>Testing Your Database* section of the documentation.
## Running the tests
@ -39,24 +39,24 @@ The entire test suite can be run by simply typing one command-line command from
> ./phpunit
You can limit tests to those within a single test directory by specifying the
directory name after phpunit.
You can limit tests to those within a single test directory by specifying the
directory name after phpunit.
> ./phpunit app/Models
## Generating Code Coverage
To generate coverage information, including HTML reports you can view in your browser,
you can use the following command:
To generate coverage information, including HTML reports you can view in your browser,
you can use the following command:
> ./phpunit --colors --coverage-text=tests/coverage.txt --coverage-html=tests/coverage/ -d memory_limit=1024m
This runs all of the tests again collecting information about how many lines,
functions, and files are tested. It also reports the percentage of the code that is covered by tests.
It is collected in two formats: a simple text file that provides an overview as well
as a comprehensive collection of HTML files that show the status of every line of code in the project.
This runs all of the tests again collecting information about how many lines,
functions, and files are tested. It also reports the percentage of the code that is covered by tests.
It is collected in two formats: a simple text file that provides an overview as well
as a comprehensive collection of HTML files that show the status of every line of code in the project.
The text file can be found at **tests/coverage.txt**.
The text file can be found at **tests/coverage.txt**.
The HTML files can be viewed by opening **tests/coverage/index.html** in your favorite browser.
## PHPUnit XML Configuration
@ -67,7 +67,7 @@ do not have your own configuration file in the project root.
The normal practice would be to copy ``phpunit.xml.dist`` to ``phpunit.xml``
(which is git ignored), and to tailor it as you see fit.
For instance, you might wish to exclude database tests, or automatically generate
For instance, you might wish to exclude database tests, or automatically generate
HTML code coverage reports.
## Test Cases

42
admin/starter/tests/README.md
View File

@ -1,8 +1,8 @@
# Running Application Tests
This is the quick-start to CodeIgniter testing. Its intent is to describe what
it takes to set up your application and get it ready to run unit tests.
It is not intended to be a full description of the test features that you can
This is the quick-start to CodeIgniter testing. Its intent is to describe what
it takes to set up your application and get it ready to run unit tests.
It is not intended to be a full description of the test features that you can
use to test your application. Those details can be found in the documentation.
## Resources
@ -12,9 +12,9 @@ use to test your application. Those details can be found in the documentation.
## Requirements
It is recommended to use the latest version of PHPUnit. At the time of this
writing we are running version 9.x. Support for this has been built into the
**composer.json** file that ships with CodeIgniter and can easily be installed
It is recommended to use the latest version of PHPUnit. At the time of this
writing we are running version 9.x. Support for this has been built into the
**composer.json** file that ships with CodeIgniter and can easily be installed
via [Composer](https://getcomposer.org/) if you don't already have it installed globally.
> composer install
@ -28,14 +28,14 @@ for code coverage to be calculated successfully.
## Setting Up
A number of the tests use a running database.
In order to set up the database edit the details for the `tests` group in
**app/Config/Database.php** or **phpunit.xml**. Make sure that you provide a database engine
A number of the tests use a running database.
In order to set up the database edit the details for the `tests` group in
**app/Config/Database.php** or **phpunit.xml**. Make sure that you provide a database engine
that is currently running on your machine. More details on a test database setup are in the
[Testing Your Database](https://codeigniter4.github.io/userguide/testing/database.html) section of the documentation.
If you want to run the tests without using live database you can
exclude @DatabaseLive group. Or make a copy of **phpunit.dist.xml** -
If you want to run the tests without using live database you can
exclude @DatabaseLive group. Or make a copy of **phpunit.dist.xml** -
call it **phpunit.xml** - and comment out the <testsuite> named "database". This will make
the tests run quite a bit faster.
@ -49,24 +49,24 @@ If you are using Windows, use the following command.
> vendor\bin\phpunit
You can limit tests to those within a single test directory by specifying the
directory name after phpunit.
You can limit tests to those within a single test directory by specifying the
directory name after phpunit.
> ./phpunit app/Models
## Generating Code Coverage
To generate coverage information, including HTML reports you can view in your browser,
you can use the following command:
To generate coverage information, including HTML reports you can view in your browser,
you can use the following command:
> ./phpunit --colors --coverage-text=tests/coverage.txt --coverage-html=tests/coverage/ -d memory_limit=1024m
This runs all of the tests again collecting information about how many lines,
functions, and files are tested. It also reports the percentage of the code that is covered by tests.
It is collected in two formats: a simple text file that provides an overview as well
as a comprehensive collection of HTML files that show the status of every line of code in the project.
This runs all of the tests again collecting information about how many lines,
functions, and files are tested. It also reports the percentage of the code that is covered by tests.
It is collected in two formats: a simple text file that provides an overview as well
as a comprehensive collection of HTML files that show the status of every line of code in the project.
The text file can be found at **tests/coverage.txt**.
The text file can be found at **tests/coverage.txt**.
The HTML files can be viewed by opening **tests/coverage/index.html** in your favorite browser.
## PHPUnit XML Configuration
@ -77,7 +77,7 @@ do not have your own configuration file in the project root.
The normal practice would be to copy ``phpunit.xml.dist`` to ``phpunit.xml``
(which is git ignored), and to tailor it as you see fit.
For instance, you might wish to exclude database tests, or automatically generate
For instance, you might wish to exclude database tests, or automatically generate
HTML code coverage reports.
## Test Cases

44
tests/README.md
View File

@ -1,15 +1,15 @@
# Running System Tests
This is the quick-start to CodeIgniter testing. Its intent is to describe what
it takes to set up your system and get it ready to run unit tests.
It is not intended to be a full description of the test features that you can
use to test your application. Those details can be found in the documentation.
This is the quick-start to CodeIgniter testing. Its intent is to describe what
it takes to set up your system and get it ready to run unit tests.
It is not intended to be a full description of the test features that you can
use to test your application. Those details can be found in the documentation.
## Requirements
It is recommended to use the latest version of PHPUnit. At the time of this
writing we are running version 9.x. Support for this has been built into the
**composer.json** file that ships with CodeIgniter and can easily be installed
It is recommended to use the latest version of PHPUnit. At the time of this
writing we are running version 9.x. Support for this has been built into the
**composer.json** file that ships with CodeIgniter and can easily be installed
via [Composer](https://getcomposer.org/) if you don't already have it installed globally.
> composer install
@ -23,14 +23,14 @@ for code coverage to be calculated successfully. After installing `XDebug`, you
## Setting Up
A number of the tests use a running database.
In order to set up the database edit the details for the `tests` group in
**app/Config/Database.php** or **phpunit.xml**. Make sure that you provide a database engine
that is currently running on your machine. More details on a test database setup are in the
A number of the tests use a running database.
In order to set up the database edit the details for the `tests` group in
**app/Config/Database.php** or **phpunit.xml**. Make sure that you provide a database engine
that is currently running on your machine. More details on a test database setup are in the
[Testing Your Database](https://codeigniter4.github.io/CodeIgniter4/testing/database.html) section of the documentation.
If you want to run the tests without using live database you can
exclude `@DatabaseLive` group. Or make a copy of **phpunit.dist.xml** -
If you want to run the tests without using live database you can
exclude `@DatabaseLive` group. Or make a copy of **phpunit.dist.xml** -
call it **phpunit.xml** - and comment out the `<testsuite>` named `Database`. This will make
the tests run quite a bit faster.
@ -44,7 +44,7 @@ If you are using Windows, use the following command.
> vendor\bin\phpunit
You can limit tests to those within a single test directory by specifying the
You can limit tests to those within a single test directory by specifying the
directory name after phpunit. All core tests are stored under **tests/system**.
> ./phpunit tests/system/HTTP/
@ -59,17 +59,17 @@ You can run the tests without running the live database and the live cache tests
## Generating Code Coverage
To generate coverage information, including HTML reports you can view in your browser,
you can use the following command:
To generate coverage information, including HTML reports you can view in your browser,
you can use the following command:
> ./phpunit --colors --coverage-text=tests/coverage.txt --coverage-html=tests/coverage/ -d memory_limit=1024m
This runs all of the tests again collecting information about how many lines,
functions, and files are tested. It also reports the percentage of the code that is covered by tests.
It is collected in two formats: a simple text file that provides an overview as well
as a comprehensive collection of HTML files that show the status of every line of code in the project.
This runs all of the tests again collecting information about how many lines,
functions, and files are tested. It also reports the percentage of the code that is covered by tests.
It is collected in two formats: a simple text file that provides an overview as well
as a comprehensive collection of HTML files that show the status of every line of code in the project.
The text file can be found at **tests/coverage.txt**.
The text file can be found at **tests/coverage.txt**.
The HTML files can be viewed by opening **tests/coverage/index.html** in your favorite browser.
## PHPUnit XML Configuration
@ -80,5 +80,5 @@ do not have your own configuration file in the project root.
The normal practice would be to copy ``phpunit.xml.dist`` to ``phpunit.xml``
(which is git ignored), and to tailor it as you see fit.
For instance, you might wish to exclude database tests, or automatically generate
For instance, you might wish to exclude database tests, or automatically generate
HTML code coverage reports.