├── .gitignore
├── .travis.yml
├── README.md
├── composer.json
├── example-plugin.php
├── phpunit.xml.dist
├── src
    └── Plugin.php
└── tests
    ├── bootstrap.php
    ├── test-example.php
    └── wp-config.php


/.gitignore:
--------------------------------------------------------------------------------
1 | /vendor/
2 | /wordpress/
3 | composer.lock
4 | phpunit.xml
5 | 


--------------------------------------------------------------------------------
/.travis.yml:
--------------------------------------------------------------------------------
 1 | branches:
 2 |   only:
 3 |     - master
 4 | 
 5 | language: php
 6 | 
 7 | services:
 8 |   - mysql
 9 | 
10 | env:
11 |   global:
12 |     - WP_DB_USER=wp
13 |     - WP_DB_PASS=password
14 |     - WP_DB_NAME=wp_tests
15 |     - WP_VERSION=*
16 | 
17 | php:
18 |   - 8.0
19 |   - 7.4
20 |   - 5.6
21 | 
22 | matrix:
23 |   include:
24 |     - php: 5.6
25 |       env: WP_VERSION=4.9.*
26 | 
27 | before_script:
28 |   - mysql -u root -e "GRANT ALL PRIVILEGES ON ${WP_DB_NAME}.* TO ${WP_DB_USER} IDENTIFIED BY '${WP_DB_PASS}';"
29 |   - mysql -u root -e "CREATE DATABASE ${WP_DB_NAME};"
30 | 
31 | install:
32 |   - composer validate --strict
33 |   - composer require --no-update --dev roots/wordpress:${WP_VERSION} wp-phpunit/wp-phpunit:${WP_VERSION}
34 |   - "[ $TRAVIS_PHP_VERSION == '8.0' ] || composer install"
35 |   # Temporary hack to allow installing PHPUnit 7 with PHP 8 until WP 5.9.
36 |   # as WP PHPUnit does not allow PHPUnit higher than 7 yet.
37 |   # See https://github.com/WordPress/wordpress-develop/commit/8def694fe4c5df95f8e20e40389faf9cb92b6dca
38 |   - "[ $TRAVIS_PHP_VERSION != '8.0' ] || composer install --ignore-platform-reqs"
39 |   - composer show
40 | 
41 | script:
42 |   - composer test
43 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Example Plugin
 2 | 
 3 | [![Build Status](https://app.travis-ci.com/wp-phpunit/example-plugin.svg?branch=master)](https://app.travis-ci.com/wp-phpunit/example-plugin)
 4 | 
 5 | A complete example for using WP PHPUnit in the context of plugin development.
 6 | 
 7 | ## Features
 8 | 
 9 | **Travis CI Configuration**
10 | 
11 | A ready to use `.travis.yml` configured with a reasonable test matrix
12 | - Includes all currently supported versions of PHP (7.4 and 8.0) and the current WP minimum required PHP 5.6
13 | - Tests against the latest version of WordPress, as well as an older version (4.9) although it could be easily extended to include multiple older versions, multisite, etc.
14 | 
15 | **Just Add Tests**
16 | 
17 | This project includes a working example `test-example.php` test case. Adding tests is as simple as adding methods to this example class! Getting up and running couldn't be easier.
18 | 
19 | ## Local Development
20 | 
21 | Install Composer dependencies
22 | 
23 | ```sh
24 | $ composer install
25 | ```
26 | 
27 | Create a database for your tests to use and update your `tests/wp-config.php` as necessary.
28 | 
29 | ```sh
30 | $ mysqladmin create wp_phpunit_tests -u root
31 | ```
32 | 
33 | The database name defaults to `wp_phpunit_tests`, but you can change this in the `tests/wp-config.php` without affecting the Travis configuration which is environment variable-based.
34 | 
35 | Run the tests
36 | 
37 | ```sh
38 | $ composer test
39 | ```
40 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "wp-phpunit/example-plugin",
 3 |     "description": "Example plugin using WP PHPUnit",
 4 |     "type": "wordpress-plugin",
 5 |     "license": "MIT",
 6 |     "authors": [
 7 |         {
 8 |             "name": "Evan Mattson",
 9 |             "email": "me@aaemnnost.tv"
10 |         }
11 |     ],
12 |     "autoload": {
13 |         "psr-4": {
14 |             "Example\\": "src"
15 |         }
16 |     },
17 |     "require": {
18 |         "php": "^5.6 || ^7.0 || ^8.0"
19 |     },
20 |     "require-dev": {
21 |         "phpunit/phpunit": "^5 || ^6 || ^7",
22 |         "roots/wordpress": "^5.0",
23 |         "wp-phpunit/wp-phpunit": "^5.0",
24 |         "yoast/phpunit-polyfills": "^1.0"
25 |     },
26 |     "scripts": {
27 |         "test": "phpunit"
28 |     }
29 | }
30 | 


--------------------------------------------------------------------------------
/example-plugin.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * Plugin Name: WP PHPUnit Example Plugin
 4 |  * Description: A complete example for using WP PHPUnit with plugin development
 5 |  * Plugin URI: https://github.com/wp-phpunit/
 6 |  * Author: Evan Mattson
 7 |  * Author URI: https://aaemnnost.tv
 8 |  * Version: 1.0
 9 |  */
10 | 
11 | function example_plugin_file() {
12 |     return __FILE__;
13 | }
14 | 


--------------------------------------------------------------------------------
/phpunit.xml.dist:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0"?>
 2 | <phpunit
 3 |     bootstrap="tests/bootstrap.php"
 4 |     backupGlobals="false"
 5 |     colors="true"
 6 |     convertErrorsToExceptions="true"
 7 |     convertNoticesToExceptions="true"
 8 |     convertWarningsToExceptions="true"
 9 |     >
10 |     <testsuites>
11 |         <testsuite name="unit">
12 |             <directory prefix="test-" suffix=".php">./tests/</directory>
13 |         </testsuite>
14 |     </testsuites>
15 | 
16 |     <php>
17 |         <env name="WP_PHPUNIT__TESTS_CONFIG" value="tests/wp-config.php" />
18 |     </php>
19 | </phpunit>
20 | 
21 | 


--------------------------------------------------------------------------------
/src/Plugin.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace Example;
 4 | 
 5 | class Plugin {
 6 | 	public function do_stuff() {
 7 | 
 8 | 	}
 9 | }
10 | 


--------------------------------------------------------------------------------
/tests/bootstrap.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * PHPUnit bootstrap file
 4 |  */
 5 | 
 6 | // Composer autoloader must be loaded before WP_PHPUNIT__DIR will be available
 7 | require_once dirname( __DIR__ ) . '/vendor/autoload.php';
 8 | 
 9 | // Give access to tests_add_filter() function.
10 | require_once getenv( 'WP_PHPUNIT__DIR' ) . '/includes/functions.php';
11 | 
12 | tests_add_filter( 'muplugins_loaded', function() {
13 |     // test set up, plugin activation, etc.
14 |     require dirname( __DIR__ ) . '/example-plugin.php';
15 | } );
16 | 
17 | // Start up the WP testing environment.
18 | require getenv( 'WP_PHPUNIT__DIR' ) . '/includes/bootstrap.php';
19 | 


--------------------------------------------------------------------------------
/tests/test-example.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | class Example_Test extends WP_UnitTestCase {
 4 | 
 5 | 	function test_wordpress_and_plugin_are_loaded() {
 6 | 		$this->assertTrue( function_exists( 'do_action' ) );
 7 | 		$this->assertTrue( function_exists( 'example_plugin_file' ) );
 8 | 		$this->assertTrue( class_exists( 'Example\\Plugin' ) );
 9 | 	}
10 | 
11 | 	function test_wp_phpunit_is_loaded_via_composer() {
12 | 		$this->assertStringStartsWith(
13 | 			dirname( __DIR__ ) . '/vendor/',
14 | 			getenv( 'WP_PHPUNIT__DIR' )
15 | 		);
16 | 
17 | 		$this->assertStringStartsWith(
18 | 			dirname( __DIR__ ) . '/vendor/',
19 | 			( new ReflectionClass( 'WP_UnitTestCase' ) )->getFileName()
20 | 		);
21 | 	}
22 | }


--------------------------------------------------------------------------------
/tests/wp-config.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /* Path to the WordPress codebase you'd like to test. Add a forward slash in the end. */
 4 | define( 'ABSPATH', dirname( dirname( __FILE__ ) ) . '/wordpress/' );
 5 | 
 6 | /*
 7 |  * Path to the theme to test with.
 8 |  *
 9 |  * The 'default' theme is symlinked from test/phpunit/data/themedir1/default into
10 |  * the themes directory of the WordPress installation defined above.
11 |  */
12 | define( 'WP_DEFAULT_THEME', 'default' );
13 | 
14 | // Test with multisite enabled.
15 | // Alternatively, use the tests/phpunit/multisite.xml configuration file.
16 | // define( 'WP_TESTS_MULTISITE', true );
17 | 
18 | // Force known bugs to be run.
19 | // Tests with an associated Trac ticket that is still open are normally skipped.
20 | // define( 'WP_TESTS_FORCE_KNOWN_BUGS', true );
21 | 
22 | // Test with WordPress debug mode (default).
23 | define( 'WP_DEBUG', true );
24 | 
25 | // ** MySQL settings ** //
26 | 
27 | // This configuration file will be used by the copy of WordPress being tested.
28 | // wordpress/wp-config.php will be ignored.
29 | 
30 | // WARNING WARNING WARNING!
31 | // These tests will DROP ALL TABLES in the database with the prefix named below.
32 | // DO NOT use a production database or one that is shared with something else.
33 | 
34 | define( 'DB_NAME'       , getenv( 'WP_DB_NAME' ) ?: 'wp_phpunit_tests' );
35 | define( 'DB_USER'       , getenv( 'WP_DB_USER' ) ?: 'root' );
36 | define( 'DB_PASSWORD'   , getenv( 'WP_DB_PASS' ) ?: '' );
37 | define( 'DB_HOST'       , 'localhost' );
38 | define( 'DB_CHARSET'    , 'utf8' );
39 | define( 'DB_COLLATE'    , '' );
40 | 
41 | /**#@+
42 |  * Authentication Unique Keys and Salts.
43 |  *
44 |  * Change these to different unique phrases!
45 |  * You can generate these using the {@link https://api.wordpress.org/secret-key/1.1/salt/ WordPress.org secret-key service}
46 |  */
47 | define( 'AUTH_KEY',         'put your unique phrase here' );
48 | define( 'SECURE_AUTH_KEY',  'put your unique phrase here' );
49 | define( 'LOGGED_IN_KEY',    'put your unique phrase here' );
50 | define( 'NONCE_KEY',        'put your unique phrase here' );
51 | define( 'AUTH_SALT',        'put your unique phrase here' );
52 | define( 'SECURE_AUTH_SALT', 'put your unique phrase here' );
53 | define( 'LOGGED_IN_SALT',   'put your unique phrase here' );
54 | define( 'NONCE_SALT',       'put your unique phrase here' );
55 | 
56 | $table_prefix = 'wpphpunittests_';   // Only numbers, letters, and underscores please!
57 | 
58 | define( 'WP_TESTS_DOMAIN', 'example.org' );
59 | define( 'WP_TESTS_EMAIL', 'admin@example.org' );
60 | define( 'WP_TESTS_TITLE', 'Test Blog' );
61 | 
62 | define( 'WP_PHP_BINARY', 'php' );
63 | 
64 | define( 'WPLANG', '' );
65 | 


--------------------------------------------------------------------------------