Skip to content

Wp-env: Add phpunit support #20090

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

Merged
noahtallen merged 9 commits into from
May 15, 2020
Merged

Wp-env: Add phpunit support #20090

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
8c8777d
Create phpunit service in docker config
noahtallen Feb 8, 2020
f3ff266
Add phpunit to run command
noahtallen May 14, 2020
66651c5
Use tests-wordpress for service image
noahtallen May 14, 2020
5d10814
Switch multisite tests over as well
noahtallen May 14, 2020
4027a0a
Update tests port number for travis
noahtallen May 14, 2020
1670045
Add php version support to phpunit command
noahtallen May 14, 2020
cab20b1
Try starting wp-env first.
noahtallen May 14, 2020
1da33f0
Set php binary once more
noahtallen May 14, 2020
1c62809
try chmod on build
noahtallen May 14, 2020
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
7 changes: 6 additions & 1 deletion .travis.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,12 +159,17 @@ jobs:
- npm run test-unit:native -- --ci --maxWorkers=2 --cacheDirectory="$HOME/.jest-cache"

- name: PHP unit tests
env: WP_ENV_TESTS_PORT=8887 WP_ENV_PORT=8886 # TODO: Remove tests port when scripts/env is replaced with wp-env.
script:
- chmod -R 767 ./build
- npm run wp-env start
- npm run test-php && npm run test-unit-php-multisite

- name: PHP unit tests (PHP 5.6)
env: LOCAL_PHP=5.6-fpm
env: LOCAL_PHP=5.6-fpm WP_ENV_TESTS_PORT=8887 WP_ENV_PORT=8886 # TODO: Remove tests port when scripts/env is replaced with wp-env.
script:
- chmod -R 767 ./build
- npm run wp-env start
- npm run test-php && npm run test-unit-php-multisite

- name: E2E tests (Admin) (1/4)
Expand Down
3 changes: 2 additions & 1 deletion composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,8 @@
"squizlabs/php_codesniffer": "^3.5",
"phpcompatibility/php-compatibility": "^9.3",
"wp-coding-standards/wpcs": "^2.2",
"sirbrillig/phpcs-variable-analysis": "^2.8"
"sirbrillig/phpcs-variable-analysis": "^2.8",
"wp-phpunit/wp-phpunit": "^5.4"
},
"require": {
"composer/installers": "~1.0"
Expand Down
47 changes: 45 additions & 2 deletions composer.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -233,8 +233,8 @@
"test-unit:debug": "wp-scripts --inspect-brk test-unit-js --runInBand --no-cache --verbose --config test/unit/jest.config.js ",
"test-unit:update": "npm run test-unit -- --updateSnapshot",
"test-unit:watch": "npm run test-unit -- --watch",
"test-unit-php": "wp-scripts env test-php",
"test-unit-php-multisite": "cross-env WP_MULTISITE=1 wp-scripts env test-php",
"test-unit-php": "wp-env run phpunit 'phpunit -c /var/www/html/wp-content/plugins/gutenberg/phpunit.xml.dist'",
"test-unit-php-multisite": "wp-env run phpunit 'WP_MULTISITE=1 phpunit -c /var/www/html/wp-content/plugins/gutenberg/phpunit.xml.dist'",
"test-unit:native": "cd test/native/ && cross-env NODE_ENV=test jest --config ./jest.config.js",
"test-unit:native:debug": "cd test/native/ && node --inspect-brk ../../node_modules/.bin/jest --runInBand --verbose --config ./jest.config.js",
"prestorybook:build": "npm run build:packages",
Expand Down
1 change: 1 addition & 0 deletions packages/env/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@

### New Feature

- Expose Docker service for running phpunit commands.
- You may now mount local directories to any location within the WordPress install. For example, you may specify `"wp-content/mu-plugins": "./path/to/mu-plugins"` to add mu-plugins.

## 1.1.0 (2020-04-01)
Expand Down
15 changes: 14 additions & 1 deletion packages/env/lib/build-docker-compose-config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,7 @@ module.exports = function buildDockerComposeConfig( config ) {
user: cliUser,
},
'tests-cli': {
depends_on: [ 'wordpress' ],
depends_on: [ 'tests-wordpress' ],
image: 'wordpress:cli',
volumes: testsMounts,
user: cliUser,
Expand All @@ -142,11 +142,24 @@ module.exports = function buildDockerComposeConfig( config ) {
image: 'composer',
volumes: [ `${ config.configDirectoryPath }:/app` ],
},
phpunit: {
image: 'wordpressdevelop/phpunit:${LOCAL_PHP-latest}',
depends_on: [ 'tests-wordpress' ],
volumes: [
...testsMounts,
'phpunit-uploads:/var/www/html/wp-content/uploads',
],
environment: {
LOCAL_DIR: 'html',
WP_PHPUNIT__TESTS_CONFIG: '/var/www/html/wp-config.php',
},
},
},
volumes: {
...( ! config.coreSource && { wordpress: {} } ),
...( ! config.coreSource && { 'tests-wordpress': {} } ),
mysql: {},
'phpunit-uploads': {},
},
};
};
7 changes: 6 additions & 1 deletion packages/env/lib/config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,12 @@ module.exports = {
themes: [],
port: 8888,
testsPort: 8889,
config: { WP_DEBUG: true, SCRIPT_DEBUG: true },
config: {
WP_DEBUG: true,
SCRIPT_DEBUG: true,
WP_TESTS_DOMAIN: 'example.org',
WP_PHP_BINARY: 'php',
Comment on lines +134 to +135
Copy link
Contributor

@ockham ockham Jul 7, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure this is working 🤔 -- at least not for me 🙁

This is the readConfig function, which is used by init-config.js to write the docker-compose.yml file (via build-docker-compose-config.js). But AFAICS, none of those files evaluate the contents of the config object. And if I check my ~/wp-env/12345678/docker-compose.yml, I don't see any of those config constants either. 🤔

Copy link
Member Author

@noahtallen noahtallen Jul 7, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right, the constants are not added to the docker compose config, but set with wp-cli:

gutenberg/packages/env/lib/wordpress.js

Lines 95 to 112 in 066d839

// Set wp-config.php values.
for ( let [ key, value ] of Object.entries( config.config ) ) {
// Ensure correct port setting from config when configure WP urls.
if ( key === 'WP_SITEURL' || key === 'WP_HOME' ) {
const url = new URL( value );
url.port = port;
value = url.toString();
}
const command = [ 'wp', 'config', 'set', key, value ];
if ( typeof value !== 'string' ) {
command.push( '--raw' );
}
await dockerCompose.run(
environment === 'development' ? 'cli' : 'tests-cli',
command,
options
);
}

This function is called during wp-env start

},
mappings: {},
},
config,
Expand Down
8 changes: 8 additions & 0 deletions phpunit/bootstrap.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@
* @package Gutenberg
*/

// Require composer dependencies.
require_once dirname( dirname( __FILE__ ) ) . '/vendor/autoload.php';

// If we're running in WP's build directory, ensure that WP knows that, too.
if ( 'build' === getenv( 'LOCAL_DIR' ) ) {
define( 'WP_RUN_CORE_TESTS', true );
Expand All @@ -14,6 +17,11 @@
// Try the WP_TESTS_DIR environment variable first.
$_tests_dir = getenv( 'WP_TESTS_DIR' );

// Next, try the WP_PHPUNIT composer package.
if ( ! $_tests_dir ) {
$_tests_dir = getenv( 'WP_PHPUNIT__DIR' );
}

// See if we're installed inside an existing WP dev instance.
if ( ! $_tests_dir ) {
$_try_tests_dir = dirname( __FILE__ ) . '/../../../../../tests/phpunit';
Expand Down