1195cf9eee
This commit improves WC_Customer_Download_Data_Store::get_downloads() performance by changing the way the SQL query is built. Before this change, this method would get all table fields even when just the permission_id field is returned. Now the method will get from the database only the fields that will be returned. The fields retrieved from the database can be controlled using the parameter `$args['return']`: - 'objects' (default): all fields are retrieved from the database and an array of WC_Customer_Download objects is returned. - 'ids': gets and return only permision_ids - comma separated list of fields (new option added by this commit): gets and return only the required fields. Examples: 'user_email,download_id,order_id' or 'order_id,download_count'. |
||
|---|---|---|
| .. | ||
| bin | ||
| cli | ||
| e2e-tests | ||
| framework | ||
| unit-tests | ||
| README.md | ||
| bootstrap.php | ||
README.md
WooCommerce Unit Tests
Initial Setup
-
Install PHPUnit by following their installation guide. If you've installed it correctly, this should display the version:
$ phpunit --version -
Install WordPress and the WP Unit Test lib using the
install.shscript. Change to the plugin root directory and type:$ tests/bin/install.sh <db-name> <db-user> <db-password> [db-host]
Sample usage:
$ tests/bin/install.sh woocommerce_tests root root
Important: The <db-name> database will be created if it doesn't exist and all data will be removed during testing.
Running Tests
Simply change to the plugin root directory and type:
$ phpunit
The tests will execute and you'll be presented with a summary. Code coverage documentation is automatically generated as HTML in the tmp/coverage directory.
You can run specific tests by providing the path and filename to the test class:
$ phpunit tests/unit-tests/api/orders
A text code coverage summary can be displayed using the --coverage-text option:
$ phpunit --coverage-text
Writing Tests
- Each test file should roughly correspond to an associated source file, e.g. the
formatting/functions.phptest file covers code in thewc-formatting-functions.phpfile - 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:
// @codeCoverageIgnoreStartand// @codeCoverageIgnoreEnd. For example, seewc_round_tax_total() - In addition to covering each line of a method/function, make sure to test common input and edge cases.
- Prefer
assertsEquals()where possible as it tests both type & equality - Remember that only methods prefixed with
testwill 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 theWC_Unit_Test_Caseclass 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 fortest_is_postcodewould bedata_provider_test_is_postcode). Read more about data providers here.
Automated Tests
Tests are automatically run with Travis-CI for each commit and pull request.
Code Coverage
Code coverage is available on Scrutinizer and Code Climate which receives updated data after each Travis build.