Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update development instructions for unit testing #7824

Merged
merged 2 commits into from
Sep 20, 2017
Merged

Update development instructions for unit testing #7824

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
88ae539
Update development instructions for unit testing
gravityrail Sep 20, 2017
a586d85
Update bootstrap to autodetect VVV and /tmp/wordpress-develop
gravityrail Sep 20, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 27 additions & 3 deletions docs/development-environment.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,13 +78,37 @@ $ yarn build-production

Jetpack includes several [unit tests](https://github.com/Automattic/jetpack/tree/master/tests) that you can run in your local environment before to submit a new Pull Request.

To get started, you can follow the instructions [here](https://phpunit.de/getting-started.html) to install PHPUnit on your machine. Once you've done so, you can get the WordPress testing codebase like so:
To get started, you can follow the instructions [here](https://phpunit.de/getting-started.html) to install PHPUnit on your machine. If you are running a recent version of [VVV](https://github.com/Varying-Vagrant-Vagrants/VVV) then Jetpack will automatically detect your wordpress-develop install and you can just run `phpunit` directly.

`svn checkout http://unit-tests.svn.wordpress.org/trunk wordpress-tests`
Otherwise you'll need to manually install the `wordpress-develop` branch, as follows:

```
svn co https://develop.svn.wordpress.org/trunk/ /tmp/wordpress-develop
cd /tmp/wordpress-develop
cp wp-tests-config-sample.php wp-tests-config.php
```

Set the database information for your testing DB in the file `/tmp/wordpress-develop/wp-tests-config.php`. You may need to create this database.

To run tests on your machine, you can run `phpunit` while in the Jetpack directory.

If you need more information, you can follow [this guide](https://jetpack.com/2013/08/20/unit-tests/).
To run Woocommerce integration tests, you'll need the woocommerce plugin installed alongside Jetpack (in `../woocommerce`), and you can run:

```
JETPACK_TEST_WOOCOMMERCE=1 phpunit
```

To run multisite tests, run:

```
phpunit -c tests/php.multisite.xml
```

To filter and run just a particular test, you can run:

```
phpunit --filter my_test_name
```

If you're not familiar with PHP Unit Testing, you can also check [this tutorial](https://pippinsplugins.com/series/unit-tests-wordpress-plugins/)

Expand Down
13 changes: 12 additions & 1 deletion tests/php/bootstrap.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,23 @@
// 2. Plugin installed inside of WordPress.org developer checkout
// 3. Tests checked out to /tmp
if( false !== getenv( 'WP_DEVELOP_DIR' ) ) {
// Defined on command line
$test_root = getenv( 'WP_DEVELOP_DIR' );
} else if ( file_exists( '../../../../tests/phpunit/includes/bootstrap.php' ) ) {
// Installed inside wordpress-develop
$test_root = '../../../../tests/phpunit';
} else if ( file_exists( '/vagrant/www/wordpress-develop/public_html/tests/phpunit/includes/bootstrap.php' ) ) {
// VVV
$test_root = '/vagrant/www/wordpress-develop/public_html/tests/phpunit';
} else if ( file_exists( '/tmp/wordpress-develop/tests/phpunit/includes/bootstrap.php' ) ) {
// Manual checkout
$test_root = '/tmp/wordpress-develop/tests/phpunit';
} else if ( file_exists( '/tmp/wordpress-tests-lib/includes/bootstrap.php' ) ) {
// Legacy tests
$test_root = '/tmp/wordpress-tests-lib';
}
}

echo "Using test root $test_root\n";

if ( '1' != getenv( 'WP_MULTISITE' ) &&
( defined( 'WP_TESTS_MULTISITE') && ! WP_TESTS_MULTISITE ) ) {
Expand Down