Use local tooling to run PHPUnit tests instead of wp-dev-lib #1124

kasparsd · 2020-07-03T12:01:59Z

Follow-up to #1123.

Use johnpbloch/wordpress and wp-phpunit/wp-phpunit to run PHPunit tests instead of wp-dev-lib.
Introduce the wait-for-it.sh helper to wait for the MySQL server to come alive in the db_phpunit container.
Simplify helpers and scripts for running tasks in Docker containers and inside the Vagrant wrapper for the Docker.
Add support for running PHPunit tests with different versions of PHP in the wordpress container. Switch Travis to build those containers instead of using different versions of PHP on the host. Sample run https://travis-ci.com/github/xwp/stream/jobs/357370647
Fix coverage reporting on Coveralls https://coveralls.io/github/xwp/stream -- introduce a new helper PHP script to make all file paths in coverage report relative to the project directory instead of absolute since the coverage report is generated inside Docker container and those paths don't exist outside of Docker.

kasparsd · 2020-07-03T12:03:28Z

composer.json

-  "repositories": [
-    {
-      "type": "git",
-      "url": "https://github.com/WordPress/wordpress-develop.git"


We use https://github.com/johnpbloch/wordpress now which doesn't require any build steps and is much faster to install, and can be used in combination of wp-phpunit/wp-phpunit to run the unit tests with any version of WP core.

kasparsd · 2020-07-03T12:04:32Z

composer.json

    }
  },
+  "extra": {
+    "wordpress-install-dir": "local/public"


Previously we were using the WP core files provisioned by the wordpress docker container during the entrypoint setup. We now have full control of the source files used for development which is much more reliable and provisions the container much faster, too.

kasparsd · 2020-07-03T12:04:48Z

composer.json

  "scripts": {
-    "pre-install-cmd": [
-      "Composer\\Config::disableProcessTimeout"


Replaced with a 600 second timeout for all commands as a sane default.

@kasparsd I don't know the original purpose of this timeout.
@kopepasah You implemented this originally. Are you okay with this change?

kasparsd · 2020-07-03T12:05:16Z

docker-compose.yml

-      WORDPRESS_DB_USER: wordpress
-      WORDPRESS_DB_PASSWORD: password
+      WP_TESTS_DIR: /var/www/html/wp-content/plugins/stream-src/vendor/wp-phpunit/wp-phpunit
+      WP_PHPUNIT__TESTS_CONFIG: /var/www/html/wp-tests-config.php


This is required for wp-phpunit/wp-phpunit to find the WP install.

kasparsd · 2020-07-03T12:28:54Z

local/config/wp-tests-config.php

@@ -5,9 +5,6 @@
 * phpcs:disable WordPress.WP.GlobalVariablesOverride.Prohibited
 */

-define( 'ABSPATH', dirname( dirname( __DIR__ ) ) . '/' );
-
-define( 'WP_TESTS_MULTISITE', true );


We use the WP_MULTISITE environment variable to control this behaviour now.

kasparsd · 2020-07-03T12:37:15Z

.travis.yml

-  - WP_VERSION=latest WP_MULTISITE=0
-  - WP_VERSION=latest WP_MULTISITE=1
-  - WP_VERSION=trunk WP_MULTISITE=0
-  - WP_VERSION=trunk WP_MULTISITE=1


We now have npm run phpunit-multisite for this.

kasparsd · 2020-07-03T14:47:14Z

@kidunot89 Could you please code review this? I've left inline comments to explain the changes. This simplifies and unifies the testing approach across environments and we should have much more reliable developer experience going forward.

Here are sample Travis runs https://travis-ci.com/github/xwp/stream/builds/174220409

kasparsd · 2020-07-03T14:48:04Z

.travis.yml

-  - WP_VERSION=latest WP_MULTISITE=1
-  - WP_VERSION=trunk WP_MULTISITE=0
-  - WP_VERSION=trunk WP_MULTISITE=1
+php: "7.4"


Travis jobs now handle the different types of runs we need.

kasparsd · 2020-07-03T14:48:39Z

Vagrantfile

-		env: {
-			"DOCKER_COMPOSE_FILE" => "/vagrant/docker-compose.yml"
-		}
+		inline: "docker-compose -f /vagrant/docker-compose.yml exec -T --user 1000 wordpress xwp_wait mysql:3306 -t 60 -- wp core multisite-install --url=stream.local",


Replaced the bash script with an inline command that does the same thing.

kasparsd · 2020-07-03T14:49:51Z

composer.json

@@ -43,7 +38,12 @@
      "@lint-php"
    ],
    "test": [
-      "phpunit --coverage-text"
+      "phpunit --coverage-text",
+      "php local/scripts/make-clover-relative.php ./tests/reports/clover.xml"


This converts all file paths inside the coverage reports to be relative to the project root instead of absolute paths inside the Docker container which was causing issues to Coveralls reporting.

kasparsd · 2020-07-03T14:50:33Z

local/docker/wordpress/Dockerfile

+
+FROM wordpress:php${PHP_VERSION}-apache
+
+ARG XDEBUG_VERSION=2.9.6


PHP 5.6 needs an earlier version so we provide an ARG to override it as needed on Travis.

kasparsd · 2020-07-03T14:51:12Z

package.json

@@ -43,14 +43,16 @@
    "lint-js": "eslint .",
    "lint-php": "composer lint",
    "lint": "npm run lint-js && npm run lint-php",
-    "cli": "./local/vagrant/cli.sh",
-    "compose": "./local/vagrant/docker-compose.sh",
+    "stop-all": "docker stop $(docker ps -a -q)",


This is a new helper to stop all running containers on a Docker host in case there are port conflicts.

kasparsd · 2020-07-03T14:51:41Z

package.json

-    "phpunit-report": "npm run cli -- composer test-report --working-dir=wp-content/plugins/stream-src",
-    "vcli": "vagrant ssh -- DOCKER_COMPOSE_FILE=/vagrant/docker-compose.yml /vagrant/local/vagrant/cli.sh",
-    "vcompose": "vagrant ssh -- DOCKER_COMPOSE_FILE=/vagrant/docker-compose.yml /vagrant/local/vagrant/docker-compose.sh",
+    "phpunit-multisite": "npm run cli -- composer test-multisite --working-dir=wp-content/plugins/stream-src",


This is a new helper for running the same unit tests with a WP multisite.

kidunot89

@kasparsd I having issue running npm run vphpunit and npm run phpunit locally. I've destroyed the vagrant box using vagrant destroy and deleted the docker images, before run vagrant up then npm run vphpunit.

Here's a snap of the terminal output

kidunot89 · 2020-07-03T15:15:29Z

composer.json

  "scripts": {
-    "pre-install-cmd": [
-      "Composer\\Config::disableProcessTimeout"


@kasparsd I don't know the original purpose of this timeout.
@kopepasah You implemented this originally. Are you okay with this change?

kasparsd · 2020-07-03T18:21:03Z

Thanks for reviewing the code and testing the changes @kidunot89!

Could you please try running composer install after deleting the vendor directory and the local/public directory? I tested both Docker and Vagrant runs locally and they seem to work fine.

kidunot89 · 2020-07-04T00:07:29Z

@kasparsd Sorry about the delayed response, deleting the vendor and local/public did it. 👍

kidunot89 and others added 5 commits July 2, 2020 14:24

PHPUnit tests CI configuration fixed.

93171e6

Docker service added to .travis.yml

576f807

Limit the timeout to 10 minutes instead of unlimited

6f59bdf

Copy right in since we can always rebuild

b966f74

Use dependencies for running PHP unit tests instead of wp-dev-lib

da94955

kasparsd commented Jul 3, 2020

View reviewed changes

kasparsd added 7 commits July 3, 2020 15:20

Add the latest version of PHP 7.4

3002b98

No longer needed since we don’t use wp-dev-lib

4f3072d

Currently not enabled

a773fef

Use the latest version of PHP to create the bundle

9479513

Use environmental variables to control this behaviour

1a8614f

Account for missing terminal

275a83f

Support for multisite tests

c7b8cfc

kasparsd commented Jul 3, 2020

View reviewed changes

kasparsd added 3 commits July 3, 2020 15:33

Use the multisite command instead

d0c1ed9

Pass the current user ID instead

16cf3e0

Use something that is available on all OSes

19c87c4

kasparsd commented Jul 3, 2020

View reviewed changes

kasparsd added 12 commits July 3, 2020 16:09

Allow custom versions of PHP

0fcf906

No longer used

5d65bf8

Test with different versions of PHP

b42cbbc

Use an older version which supports PHP 5.6

cf3d3f1

Use proper comment style here

ac4f172

Pass the current user ID instead

5d0686f

Install a specific version of Xdebug

aaa4054

Do the default build

023b673

Indicate an build arg

942dc4e

Debug the test reports directory

e44f942

Hardcode 1000 since provision happens with root

dc5483c

Introduce a helper to fix coverage reporting

18da2c6

kasparsd requested a review from kidunot89 July 3, 2020 14:44

kasparsd self-assigned this Jul 3, 2020

kasparsd added this to the Version 3.5.0 milestone Jul 3, 2020

Remove the double reference

5e86ca8

kasparsd added the tooling Development and deployment tooling improvements label Jul 3, 2020

kasparsd commented Jul 3, 2020

View reviewed changes

kidunot89 suggested changes Jul 3, 2020

View reviewed changes

kidunot89 self-requested a review July 4, 2020 00:06

kidunot89 approved these changes Jul 4, 2020

View reviewed changes

kasparsd merged commit cb8e5c4 into develop Jul 6, 2020

kasparsd deleted the devops/ci-update branch July 6, 2020 14:36

kasparsd mentioned this pull request Jul 9, 2020

Add .htaccess for the local WP development environment #1135

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use local tooling to run PHPUnit tests instead of wp-dev-lib #1124

Use local tooling to run PHPUnit tests instead of wp-dev-lib #1124

kasparsd commented Jul 3, 2020 •

edited

Loading

kasparsd Jul 3, 2020

kasparsd Jul 3, 2020

kasparsd Jul 3, 2020

kidunot89 Jul 3, 2020 •

edited

Loading

kasparsd Jul 3, 2020

kasparsd Jul 3, 2020

kasparsd Jul 3, 2020

kasparsd commented Jul 3, 2020

kasparsd Jul 3, 2020

kasparsd Jul 3, 2020

kasparsd Jul 3, 2020

kasparsd Jul 3, 2020

kasparsd Jul 3, 2020

kasparsd Jul 3, 2020

kidunot89 left a comment

kidunot89 Jul 3, 2020 •

edited

Loading

kasparsd commented Jul 3, 2020

kidunot89 commented Jul 4, 2020 •

edited

Loading


		FROM wordpress:php${PHP_VERSION}-apache

		ARG XDEBUG_VERSION=2.9.6

Use local tooling to run PHPUnit tests instead of wp-dev-lib #1124

Use local tooling to run PHPUnit tests instead of wp-dev-lib #1124

Conversation

kasparsd commented Jul 3, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kidunot89 Jul 3, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kasparsd commented Jul 3, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

kidunot89 left a comment

Choose a reason for hiding this comment

kidunot89 Jul 3, 2020 • edited Loading

Choose a reason for hiding this comment

kasparsd commented Jul 3, 2020

kidunot89 commented Jul 4, 2020 • edited Loading

kasparsd commented Jul 3, 2020 •

edited

Loading

kidunot89 Jul 3, 2020 •

edited

Loading

kidunot89 Jul 3, 2020 •

edited

Loading

kidunot89 commented Jul 4, 2020 •

edited

Loading