Add a PHPUnit Docker Container (#4279)

This allows a Gutenberg dev environment to be created by running `bin/setup-local-env.sh`.

Some scripts that previously assumed they were installed in a local WordPress install have also been updated to make use of the WordPress container.

Author: pento

.travis.yml

@@ -22,18 +22,13 @@ before_install:
 
 jobs:
   include:
-    - stage: test
-      php: 5.6
-      script: composer install && ./vendor/bin/phpcs
-
     - stage: test
       script:
         - npm install || exit 1
         - npm run ci || exit 1
 
     - stage: test
-      php: 7.1
-      env: WP_VERSION=latest
+      env: WP_VERSION=latest DOCKER=true
       script:
         - ./bin/run-wp-unit-tests.sh
 

bin/install-wp-tests.sh

@@ -119,7 +119,7 @@ install_db() {
 	fi
 
 	# create database
-	mysqladmin create $DB_NAME --user="$DB_USER" --password="$DB_PASS"$EXTRA
+	mysql --user="$DB_USER" --password="$DB_PASS"$EXTRA --execute "CREATE DATABASE IF NOT EXISTS $DB_NAME;"
 }
 
 install_wp

bin/run-wp-unit-tests.sh

@@ -3,12 +3,18 @@
 cd "$(dirname "$0")/../"
 
 export PATH="$HOME/.composer/vendor/bin:$PATH"
-bash bin/install-wp-tests.sh wordpress_test root '' localhost $WP_VERSION
-source bin/install-php-phpunit.sh
+if [ ${DOCKER} = "true" ]; then
+	bin/setup-local-env.sh
+else
+	bash bin/install-wp-tests.sh wordpress_test root '' localhost $WP_VERSION
+	source bin/install-php-phpunit.sh
+fi
 # Run the build because otherwise there will be a bunch of warnings about
 # failed `stat` calls from `filemtime()`.
+composer install || exit 1
 npm install || exit 1
 npm run build || exit 1
+
 # Make sure phpegjs parser is up to date
 node bin/create-php-parser.js || exit 1
 if ! git diff --quiet --exit-code lib/parser.php; then
@@ -18,11 +24,24 @@ if ! git diff --quiet --exit-code lib/parser.php; then
 	sleep .2 # Otherwise Travis doesn't want to print the whole message
 	exit 1
 fi
+
 echo Running with the following versions:
-php -v
-phpunit --version
+if [ ${DOCKER} = "true" ]; then
+	docker-compose -f docker/docker-compose.yml run --rm wordpress_phpunit php -v
+	docker-compose -f docker/docker-compose.yml run --rm wordpress_phpunit phpunit --version
+else
+	php -v
+	phpunit --version
+fi
+
 # Check parser syntax
 php lib/parser.php || exit 1
+
 # Run PHPUnit tests
-phpunit || exit 1
-WP_MULTISITE=1 phpunit || exit 1
+if [ ${DOCKER} = "true" ]; then
+	npm run test-php || exit 1
+	npm run test-unit-php-multisite || exit 1
+else
+	phpunit || exit 1
+	WP_MULTISITE=1 phpunit || exit 1
+fi

bin/setup-local-env.sh

@@ -6,7 +6,7 @@ set -e
 # Change to the expected directory
 cd "$(dirname "$0")/../docker"
 
-# Launch the WordPress docker
+# Launch the containers
 docker-compose up -d
 
 # Wait until the docker containers are setup properely
@@ -21,3 +21,6 @@ docker run -it --rm --volumes-from wordpress-dev --network container:wordpress-d
 
 # Activate Gutenberg
 docker run -it --rm --volumes-from wordpress-dev --network container:wordpress-dev wordpress:cli plugin activate gutenberg
+
+# Install the PHPUnit test scaffolding
+docker-compose run --rm wordpress_phpunit /app/bin/install-wp-tests.sh wordpress_test root example mysql latest false

docker/docker-compose.yml

@@ -8,6 +8,7 @@ services:
       - 8888:80
     environment:
       WORDPRESS_DB_PASSWORD: example
+      ABSPATH: /usr/src/wordpress/
     volumes:
       - ../:/var/www/html/wp-content/plugins/gutenberg
     container_name: wordpress-dev
@@ -16,3 +17,15 @@ services:
     image: mysql:5.7
     environment:
       MYSQL_ROOT_PASSWORD: example
+      MYSQL_DATABASE: wordpress_test
+
+  wordpress_phpunit:
+    image: chriszarate/wordpress-phpunit
+    environment:
+      PHPUNIT_DB_HOST: mysql
+    volumes:
+      - ..:/app
+      - testsuite:/tmp
+
+volumes:
+  testsuite: {}

docs/testing-overview.md

@@ -179,14 +179,15 @@ cypress_base_url=http://my-custom-basee-url cypress_username=myusername cypress_
 
 ## PHP Testing
 
-Tests for PHP use [PHPUnit](https://phpunit.de/) as the testing framework. Before starting, you should install PHPUnit and have a copy of [WordPress Develop](https://github.com/WordPress/wordpress-develop) available and setup a [`wp-tests-config.php`](https://make.wordpress.org/core/handbook/testing/automated-testing/phpunit/#setup) file. If the Gutenberg plugin is installed in the context of a WordPress Develop site, you can run `phpunit` directly from the command-line. Otherwise, you will need to specify the path to WordPress Develop's test directory as an environment variable:
+Tests for PHP use [PHPUnit](https://phpunit.de/) as the testing framework. If you're using the built-in [local environment](https://github.com/WordPress/gutenberg/blob/master/CONTRIBUTING.md#local-environment), you can run the PHP tests locally using this command:
 
-```
-WP_TESTS_DIR=/path/to/wordpress-develop/tests/phpunit phpunit
+```bash
+npm run test-php
 ```
 
-Code style in PHP is enforced using [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer). It is recommended that you install PHP_CodeSniffer and the [WordPress Coding Standards for PHP_CodeSniffer](https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards#installation) ruleset using [Composer](https://getcomposer.org/). With Composer installed, run `composer install` from the project directory to install dependencies, then `composer run-script lint` to verify PHP code standards.
+Code style in PHP is enforced using [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer). It is recommended that you install PHP_CodeSniffer and the [WordPress Coding Standards for PHP_CodeSniffer](https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards#installation) ruleset using [Composer](https://getcomposer.org/). With Composer installed, run `composer install` from the project directory to install dependencies. The above `npm run test-php` will execute both unit tests and code linting. Code linting can be verified independently by running `npm run lint-php`.
 
+To run unit tests only, without the linter, use `npm run test-unit-php` instead.
 
 [snapshot testing]: https://facebook.github.io/jest/docs/en/snapshot-testing.html
 [update snapshots]: https://facebook.github.io/jest/docs/en/snapshot-testing.html#updating-snapshots

package.json

@@ -139,16 +139,20 @@
     "build": "cross-env BABEL_ENV=default NODE_ENV=production webpack",
     "gettext-strings": "cross-env BABEL_ENV=gettext webpack",
     "lint": "eslint -f json . | eslines",
+    "lint-php": "vendor/bin/phpcs",
     "predev": "check-node-version --package",
     "dev": "cross-env BABEL_ENV=default webpack --watch",
     "test": "npm run lint && npm run test-unit",
+    "test-php": "npm run lint-php && npm run test-unit-php",
     "ci": "concurrently \"npm run lint && npm run build\" \"npm run test-unit:coverage-ci\"",
     "fixtures:clean": "rimraf \"blocks/test/fixtures/*.+(json|serialized.html)\"",
-    "fixtures:server-registered": "./bin/get-server-blocks.php > blocks/test/server-registered.json",
+    "fixtures:server-registered": "docker-compose -f docker/docker-compose.yml run -w /var/www/html/wp-content/plugins/gutenberg --rm wordpress ./bin/get-server-blocks.php > blocks/test/server-registered.json",
     "fixtures:generate": "npm run fixtures:server-registered && cross-env GENERATE_MISSING_FIXTURES=y npm run test-unit",
     "fixtures:regenerate": "npm run fixtures:clean && npm run fixtures:generate",
     "package-plugin": "./bin/build-plugin-zip.sh",
     "test-unit": "jest",
+    "test-unit-php": "docker-compose -f docker/docker-compose.yml run --rm wordpress_phpunit phpunit",
+    "test-unit-php-multisite": "docker-compose -f docker/docker-compose.yml run -e WP_MULTISITE=1 --rm wordpress_phpunit phpunit",
     "test-unit:coverage": "jest --coverage",
     "test-unit:coverage-ci": "jest --coverage --maxWorkers 1 && codecov",
     "test-unit:watch": "jest --watch",

phpunit/class-parsing-test.php

@@ -13,7 +13,10 @@ function parsing_test_filenames() {
 
 		require_once dirname( dirname( __FILE__ ) ) . '/lib/parser.php';
 
-		$fixture_filenames = glob( self::$fixtures_dir . '/*.{json,html}', GLOB_BRACE );
+		$fixture_filenames = array_merge(
+			glob( self::$fixtures_dir . '/*.json' ),
+			glob( self::$fixtures_dir . '/*.html' )
+		);
 		$fixture_filenames = array_values( array_unique( array_map(
 			array( $this, 'clean_fixture_filename' ),
 			$fixture_filenames

phpunit/class-serializing-test.php

@@ -13,7 +13,10 @@ function serializing_test_filenames() {
 
 		require_once dirname( dirname( __FILE__ ) ) . '/lib/parser.php';
 
-		$fixture_filenames = glob( self::$fixtures_dir . '/*.{json,html}', GLOB_BRACE );
+		$fixture_filenames = array_merge(
+			glob( self::$fixtures_dir . '/*.json' ),
+			glob( self::$fixtures_dir . '/*.html' )
+		);
 		$fixture_filenames = array_values( array_unique( array_map(
 			array( $this, 'clean_fixture_filename' ),
 			$fixture_filenames