Skip to content

Latest commit

 

History

History
107 lines (89 loc) · 4.81 KB

unit-tests.md

File metadata and controls

107 lines (89 loc) · 4.81 KB

Unit Tests

For each site you provision, e.g. Sportico, you may run the theme and pmc-plugins unit tests by following the steps below. Do steps 1-3 once, and steps 4+ for each provisioned site, e.g. Sportico, WWD, etc. The basic concept here is that we copy the testing tools from wordpress-develop into each provisioned site.

NOTE, Ideally, we could provision wordpress-trunk into VVV via custom-site-template-develop (by setting skip_provisioning: false in config.yml) as it provides phpunit, test database, and the wp test suite. However, it forces you to use the latest (unreleased) version. Using its master branch can/has lead to issues when running tests with our pmc-unit-test bootstrap.php. Due to this, we setup the test environment manually (steps 1-3 below).

ℹ️ Shortcut available: Instead of following the steps below, you can use the setup-phpunit-wp.sh shell script within Vagrant to automate the process. Make sure you have the appropriate permissions and have reviewed the script before executing it.

  1. Install phpunit

    # If not in VM...
$ vagrant ssh

    In VM...

    $ sudo mkdir -p /usr/share/php/phpunit
$ cd /usr/share/php/phpunit
$ sudo composer require --dev phpunit/phpunit ^9 --update-with-all-dependencies
$ sudo ln -sf /usr/share/php/phpunit/vendor/bin/phpunit /usr/bin/phpunit

  2. Get the WP Test Suite and copy it into each provisioned site

    # If not in VM...
$ vagrant ssh

    In VM...

    # As of Nov 2022 pmc-unit-test is compatible with WP 6.1
$ cd ~
$ git clone --depth 1 [email protected]:WordPress/wordpress-develop.git
$ cp -r ~/wordpress-develop/tests/ /srv/www/sportico-com/public_html/

  3. Install yoasts/phpunit-polyfills. We'll install it in the home directory because we'll use an alternative loading approach.

    # If not in VM...
$ vagrant ssh

    In VM...

    $ cd ~
$ composer require --dev yoast/phpunit-polyfills

  4. Create wp-tests-config.php per site

    # If not in VM...
$ vagrant ssh

    In VM...

    $ cp ~/wordpress-develop/wp-tests-config-sample.php /srv/www/sportico-com/public_html/wp-tests-config.php
    1. open the file you copied wp-tests-config.php in your editor / IDE of choice.
    2. change line 4 to define( 'ABSPATH', dirname( __FILE__ ) . '/' );
    3. Configure DB_* named constants: NOTE the DB_NAME should match your provisioned site (see wp-config.php) 
      define( 'DB_NAME', 'sportico-com' );
define( 'DB_USER', 'wp' );
define( 'DB_PASSWORD', 'wp' );
define( 'DB_HOST', 'localhost' );
    4. Add the following constants: 
      define( 'PMC_IS_VIP_GO_SITE', true );
define( 'VIP_GO_APP_ENVIRONMENT', 'development' );
define( 'WP_TESTS_PHPUNIT_POLYFILLS_PATH', '/home/vagrant/vendor/yoast/phpunit-polyfills/' );

  5. Run tests

    1. Note, we must tell PHPUnit where our test bootstraps are located. Note, this must be done each time you SSH into vagrant (See below PHPStorm docs to automate this). Note, change sportico-com to the site you're testing within.
    2. Note, if xdebug is enabled your tests will run VERY slowly. See xDebug documentation. Only enable xdebug while testing if you wish to step-through debug your tests or generate a code coverage report.
    3. Note, if you only want code coverage, try enabling pcov instead of xdebug switch_php_debugmod pcov. pcov seems to require less memory than xdebug.
    # If not in VM...
$ vagrant ssh

    In VM...

    You can add these variables to your bash, but make sure they are at the bottom of ~/.bash_profile as not to conflict with vvv's settings.
export PMC_PHPUNIT_BOOTSTRAP=/srv/www/artnews-com/public_html/wp-content/plugins/pmc-plugins/pmc-unit-test/bootstrap.php
export WP_TESTS_DIR=/srv/www/artnews-com/public_html/tests/phpunit

# If you edited ~/.bash_profile reload it.
$ source ~/.bash_profile

# Navigate to a pmc-plugin or a theme where `phpunit.xml` exists. E.g.
$ cd /srv/www/sportico-com/public_html/wp-content/plugins/pmc-plugins/pmc-piano/

# Run tests
$ phpunit

You can copy all the PMC_PHPUNIT_BOOTSTRAP and WP_TESTS_DIR settings into your local from here

To run tests in PHPStorm and/or Step-Through debug tests, see here: https://penskemedia.atlassian.net/l/cp/1xy0PFae (this replaces steps 4-7 above)

Testing in PHPStorm