Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
woocommerce/tests
History
Paul Kilmurray cb12623fa7 Compound tax calculation test 
There is either an error in the calculation for compound taxes, or
there is something wrong with my understanding of how compound taxes
should work - I’m definitely not discounting the later.

Given a price of $9.99 exclusive of tax, applying a 10% tax will give
9.99 + 0.999 = 10.989. Then applying a compound tax of 2% should give
10.989 + 0.2198 = 11.2088.

The result of the WC_Tax::calc_tax on the 2% compound tax is 0.1998
which seems to be in error.

Likewise for prices exclusive of tax.

Note: rounding to 4 decimal places on all calculations
 		2015-02-23 14:40:10 +08:00
..
bin Download WordPress files over HTTPS. 2014-09-17 12:12:14 +02:00
framework Cleanup WC_Unit_Test_Case 2015-02-04 22:07:52 +05:45
unit-tests Compound tax calculation test 2015-02-23 14:40:10 +08:00
README.md update tests readme 2014-09-07 15:18:16 -04:00
bootstrap.php Revert back to original wp_test_dir 2014-12-22 13:34:43 +01:00

README.md

WooCommerce Unit Tests

Initial Setup

  1. Install PHPUnit by following their installation guide. If you've installed it correctly, this should display the version:

    $ phpunit --version

  2. Install WordPress and the WP Unit Test lib using the install.sh script. Change to the plugin root directory and type:

    $ tests/bin/install.sh [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/webhooks

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.php test file covers code in the wc-formatting-functions.php file
  • 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()
  • 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 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.

Automated Tests

Tests are automatically run with Travis-CI for each commit and pull request.

Code Coverage

Code coverage is available on Coveralls which receives updated data after each Travis build.