Minor typo and text styling fixes (#44583)
* Fix typos in PHP comments * Fix styling of tests/README.md * Other linting fixes * Add changelog file
This commit is contained in:
Albert Juhé Lluveras
GitHub
parent
cb1ae99a77
commit
13ded5be76
|
|
@ -0,0 +1,3 @@
|
|||
Significance: patch
|
||||
Type: update
|
||||
Comment: Minor typo and text styling fixes in PHP and MD files.
|
||||
|
|
@ -15,7 +15,7 @@ use Automattic\WooCommerce\Blocks\Domain\Services\FeatureGating;
|
|||
* In the context of this plugin, it handles init and is called from the main
|
||||
* plugin file (woocommerce-gutenberg-products-block.php).
|
||||
*
|
||||
* In the context of WooCommere core, it handles init and is called from
|
||||
* In the context of WooCommerce core, it handles init and is called from
|
||||
* WooCommerce's package loader. The main plugin file is _not_ loaded.
|
||||
*
|
||||
* @since 2.5.0
|
||||
|
|
|
|||
|
|
@ -5,23 +5,22 @@ This document discusses unit tests. See [the e2e README](https://github.com/wooc
|
|||
## Table of contents
|
||||
|
||||
- [WooCommerce Tests](#woocommerce-tests)
|
||||
- [Table of contents](#table-of-contents)
|
||||
- [Initial Setup](#initial-setup)
|
||||
- [MySQL database](#mysql-database)
|
||||
- [Setup instructions](#setup-instructions)
|
||||
- [Running Unit Tests](#running-unit-tests)
|
||||
- [Troubleshooting](#troubleshooting)
|
||||
- [Running tests in PHP 8](#running-tests-in-php-8)
|
||||
- [Guide for Writing Unit Tests](#guide-for-writing-unit-tests)
|
||||
- [Automated Tests](#automated-tests)
|
||||
- [Code Coverage](#code-coverage)
|
||||
|
||||
- [Table of contents](#table-of-contents)
|
||||
- [Initial Setup](#initial-setup)
|
||||
- [MySQL database](#mysql-database)
|
||||
- [Setup instructions](#setup-instructions)
|
||||
- [Running Unit Tests](#running-unit-tests)
|
||||
- [Troubleshooting](#troubleshooting)
|
||||
- [Guide for Writing Unit Tests](#guide-for-writing-unit-tests)
|
||||
- [Automated Tests](#automated-tests)
|
||||
- [Code Coverage](#code-coverage)
|
||||
|
||||
## Initial Setup
|
||||
|
||||
### MySQL database
|
||||
|
||||
To run the tests, you need to create a test database. You can:
|
||||
|
||||
- Access a database on a server
|
||||
- Connect to your local database on your machine
|
||||
- Use a solution like VVV - if you are using VVV you might need to `vagrant ssh` first
|
||||
|
|
@ -31,23 +30,22 @@ To run the tests, you need to create a test database. You can:
|
|||
|
||||
Once you have database, from the WooCommerce root directory "cd" into `plugins/woocommerce` directory and run the following:
|
||||
|
||||
1. Install [PHPUnit](http://phpunit.de/) via Composer by running:
|
||||
```
|
||||
$ composer install
|
||||
```
|
||||
|
||||
1. Install [PHPUnit](http://phpunit.de/) via Composer by running: `composer install`
|
||||
2. Install WordPress and the WP Unit Test lib using the `install.sh` script:
|
||||
```
|
||||
$ tests/bin/install.sh <db-name> <db-user> <db-password> [db-host]
|
||||
```
|
||||
|
||||
```sh
|
||||
tests/bin/install.sh <db-name> <db-user> <db-password> [db-host]
|
||||
```
|
||||
|
||||
You may need to quote strings with backslashes to prevent them from being processed by the shell or other programs.
|
||||
|
||||
Example:
|
||||
|
||||
$ tests/bin/install.sh woocommerce_tests root root
|
||||
```sh
|
||||
tests/bin/install.sh woocommerce_tests root root
|
||||
|
||||
# woocommerce_tests is the database name and root is both the MySQL user and its password.
|
||||
# woocommerce_tests is the database name and root is both the MySQL user and its password.
|
||||
```
|
||||
|
||||
**Important**: The `<db-name>` database will be created if it doesn't exist and all data will be removed during testing.
|
||||
|
||||
|
|
@ -55,44 +53,56 @@ Example:
|
|||
|
||||
Change to the plugin root directory and type:
|
||||
|
||||
$ vendor/bin/phpunit
|
||||
```sh
|
||||
vendor/bin/phpunit
|
||||
```
|
||||
|
||||
The tests will execute and you'll be presented with a summary.
|
||||
|
||||
You can run specific tests by providing the path and filename to the test class:
|
||||
|
||||
$ vendor/bin/phpunit tests/legacy/unit-tests/importer/product.php
|
||||
```sh
|
||||
vendor/bin/phpunit tests/legacy/unit-tests/importer/product.php
|
||||
```
|
||||
|
||||
A text code coverage summary can be displayed using the `--coverage-text` option:
|
||||
|
||||
$ vendor/bin/phpunit --coverage-text
|
||||
```sh
|
||||
vendor/bin/phpunit --coverage-text
|
||||
```
|
||||
|
||||
### Troubleshooting
|
||||
|
||||
In case you're unable to run the unit tests, you might see an error message similar to:
|
||||
|
||||
```
|
||||
```sh
|
||||
Fatal error: require_once(): Failed opening required '/var/folders/qr/3cnz_5_j3j1cljph_246ty1h0000gn/T/wordpress-tests-lib/includes/functions.php' (include_path='.:/usr/local/Cellar/php@7.4/7.4.23/share/php@7.4/pear') in /Users/nielslange/Plugins/woocommerce/tests/legacy/bootstrap.php on line 59
|
||||
```
|
||||
|
||||
If you run into this problem, simply delete the WordPress test directory and run the installer again. In this particular case, you'd run the following command:
|
||||
If you run into this problem, simply delete the WordPress test directory and run the installer again. In this particular case, you'd run the following commands:
|
||||
|
||||
```sh
|
||||
rm -rf /var/folders/qr/3cnz_5_j3j1cljph_246ty1h0000gn/T/wordpress-tests-lib
|
||||
```
|
||||
$ rm -rf /var/folders/qr/3cnz_5_j3j1cljph_246ty1h0000gn/T/wordpress-tests-lib
|
||||
$ tests/bin/install.sh woocommerce_tests_1 root root
|
||||
|
||||
```sh
|
||||
tests/bin/install.sh woocommerce_tests_1 root root
|
||||
```
|
||||
|
||||
Or if you run into this error:
|
||||
|
||||
```
|
||||
```sh
|
||||
PHP Fatal error: require_once(): Failed opening required '/var/folders/n_/ksp7kpt9475byx0vs665j6gc0000gn/T/wordpress//wp-includes/PHPMailer/PHPMailer.php' (include_path='.:/usr/local/Cellar/php@7.4/7.4.26_1/share/php@7.4/pear') in /private/var/folders/n_/ksp7kpt9475byx0vs665j6gc0000gn/T/wordpress-tests-lib/includes/mock-mailer.php on line 2]
|
||||
```
|
||||
|
||||
You will want to delete the wordpress folder
|
||||
|
||||
```sh
|
||||
rm -rf /var/folders/qr/3cnz_5_j3j1cljph_246ty1h0000gn/T/wordpress
|
||||
```
|
||||
$ rm -rf /var/folders/qr/3cnz_5_j3j1cljph_246ty1h0000gn/T/wordpress
|
||||
$ tests/bin/install.sh woocommerce_tests_1 root root
|
||||
|
||||
```sh
|
||||
tests/bin/install.sh woocommerce_tests_1 root root
|
||||
```
|
||||
|
||||
Note that `woocommerce_tests` changed to `woocommerce_tests_1` as the `woocommerce_tests` database already exists due to the prior command.
|
||||
|
|
@ -106,25 +116,26 @@ There are three different unit test directories:
|
|||
- `tests/php/src` is where all the tests for code in the `src` directory should be written.
|
||||
|
||||
Each test file should correspond to an associated source file and be named accordingly:
|
||||
* For `src` code: The base namespace for tests is `Automattic\WooCommerce\Tests`. A class named `Automattic\WooCommerce\TheNamespace\TheClass` should have a test named `Automattic\WooCommerce\Tests\TheNamespace\TheClassTest`.
|
||||
* For `includes` code:
|
||||
* When testing classes: use the same approach as for `src` except that namespaces are not used. So a `WC_Something` class in `includes/somefolder/class-wc-something.php` should have its tests in `tests/src/internal/somefolder/class-wc-something-test.php`.
|
||||
* When testing functions: use one test file per functions group file, for example `wc-formatting-functions-test.php` for code in the `wc-formatting-functions.php` file.
|
||||
|
||||
- For `src` code: The base namespace for tests is `Automattic\WooCommerce\Tests`. A class named `Automattic\WooCommerce\TheNamespace\TheClass` should have a test named `Automattic\WooCommerce\Tests\TheNamespace\TheClassTest`.
|
||||
- For `includes` code:
|
||||
- When testing classes: use the same approach as for `src` except that namespaces are not used. So a `WC_Something` class in `includes/somefolder/class-wc-something.php` should have its tests in `tests/src/internal/somefolder/class-wc-something-test.php`.
|
||||
- When testing functions: use one test file per functions group file, for example `wc-formatting-functions-test.php` for code in the `wc-formatting-functions.php` file.
|
||||
|
||||
|
||||
See also [the guidelines for writing unit tests for `src` code](https://github.com/woocommerce/woocommerce/tree/trunk/plugins/woocommerce/src/README.md#writing-unit-tests) and [the guidelines for `includes` code](https://github.com/woocommerce/woocommerce/tree/trunk/plugins/woocommerce/includes/README.md#writing-unit-tests).
|
||||
|
||||
General guidelines for all the unit tests:
|
||||
|
||||
* Each test method should cover a single method or function with one or more assertions
|
||||
* A single method or function can have multiple associated test methods if it's a large or complex method
|
||||
* Use the test coverage HTML report (under `tmp/coverage/index.html`) to examine which lines your tests are covering and aim for 100% coverage
|
||||
* For code that cannot be tested (e.g. they require a certain PHP version), you can exclude them from coverage using a comment: `// @codeCoverageIgnoreStart` and `// @codeCoverageIgnoreEnd`. For example, see [`wc_round_tax_total()`](https://github.com/woocommerce/woocommerce/blob/35f83867736713955fa2c4f463a024578bb88795/includes/wc-formatting-functions.php#L208-L219)
|
||||
* In addition to covering each line of a method/function, make sure to test common input and edge cases.
|
||||
* Prefer `assertSame()` where possible as it tests both type and value
|
||||
* Remember that only methods prefixed with `test` will be run so use helper methods liberally to keep test methods small and reduce code duplication. If there is a common helper method used in multiple test files, consider adding it to the `WC_Unit_Test_Case` class so it can be shared by all test cases
|
||||
* Filters persist between test cases so be sure to remove them in your test method or in the `tearDown()` method.
|
||||
* Use data providers where possible. Be sure that their name is like `data_provider_function_to_test` (i.e. the data provider for `test_is_postcode` would be `data_provider_test_is_postcode`). Read more about data providers [here](https://phpunit.de/manual/current/en/writing-tests-for-phpunit.html#writing-tests-for-phpunit.data-providers).
|
||||
- Each test method should cover a single method or function with one or more assertions
|
||||
- A single method or function can have multiple associated test methods if it's a large or complex method
|
||||
- Use the test coverage HTML report (under `tmp/coverage/index.html`) to examine which lines your tests are covering and aim for 100% coverage
|
||||
- For code that cannot be tested (e.g. they require a certain PHP version), you can exclude them from coverage using a comment: `// @codeCoverageIgnoreStart` and `// @codeCoverageIgnoreEnd`. For example, see [`wc_round_tax_total()`](https://github.com/woocommerce/woocommerce/blob/35f83867736713955fa2c4f463a024578bb88795/includes/wc-formatting-functions.php#L208-L219)
|
||||
- In addition to covering each line of a method/function, make sure to test common input and edge cases.
|
||||
- Prefer `assertSame()` where possible as it tests both type and value
|
||||
- Remember that only methods prefixed with `test` will be run so use helper methods liberally to keep test methods small and reduce code duplication. If there is a common helper method used in multiple test files, consider adding it to the `WC_Unit_Test_Case` class so it can be shared by all test cases
|
||||
- Filters persist between test cases so be sure to remove them in your test method or in the `tearDown()` method.
|
||||
- Use data providers where possible. Be sure that their name is like `data_provider_function_to_test` (i.e. the data provider for `test_is_postcode` would be `data_provider_test_is_postcode`). Read more about data providers [here](https://phpunit.de/manual/current/en/writing-tests-for-phpunit.html#writing-tests-for-phpunit.data-providers).
|
||||
|
||||
## Automated Tests
|
||||
|
||||
|
|
|
|||
|
|
@ -49,7 +49,7 @@ class MainFile extends WP_UnitTestCase {
|
|||
}
|
||||
|
||||
/**
|
||||
* Asserts that the bootstrap class is returned from the container.
|
||||
* Asserts that the bootstrap class is returned from the container.
|
||||
*/
|
||||
public function wc_blocks_bootstrap() {
|
||||
$this->assertInstanceOf( Bootstrap::class, wc_blocks_bootstrap() );
|
||||
|
|
|
|||
Loading…
Reference in New Issue