Changeset 49528

Timestamp:

11/06/2020 05:24:43 PM (4 years ago)

Author:

desrosj

Message:

Build/Test Tools: Backport the local Docker environment to the 5.2 branch.

This commit introduces the Docker-based local WordPress development environment to the 5.2 branch and converts the Travis test jobs to utilize this environment for easier and more consistent testing.

Merges [45745,45762,45783-45784,45800,45819,45885,46320,46999,47225,47912,48121,49335,49358,49360,49362] to the 5.1 branch.
See #48301, #47767.

Location:

branches/5.1

Files:

• . (modified) (1 prop)
• .env (added)
• .travis.yml (modified) (3 diffs)
• docker-compose.yml (added)
• package-lock.json (modified) (4 diffs)
• package.json (modified) (3 diffs)
• tests/phpunit/includes/object-cache.php (modified) (1 diff)
• tests/phpunit/tests/ajax/CustomizeMenus.php (modified) (2 diffs)
• tools/local-env (added)
• tools/local-env/default.template (added)
• tools/local-env/mysql-init.sql (added)
• tools/local-env/php-config.ini (added)
• tools/local-env/phpunit-config.ini (added)
• tools/local-env/scripts (added)
• tools/local-env/scripts/docker.js (added)
• tools/local-env/scripts/install.js (added)
• tools/local-env/scripts/start.js (added)

branches/5.1/.travis.yml

@@ -1 @@
-sudo: false
-dist: trusty
 language: php
+
+services:
+  - docker
+
 cache:
   apt: true
@@ -7 +9 @@
     - $HOME/.npm
     - vendor
-    - $HOME/.composer/cache
+
 env:
   global:
-    - WP_TRAVISCI=travis:phpunit
+    - LOCAL_DIR: build
+    - COMPOSER_INSTALL: false
+    - NPM_INSTALL: true
+    - WP_INSTALL: true
+    - PHP_FPM_UID: "`id -u`"
+    - PHP_FPM_GID: "`id -g`"
+
 matrix:
   include:
-  - php: 7.2
-    env: WP_TRAVISCI=travis:format
-  - php: 7.1
-    env: WP_TRAVISCI=travis:js
-  - php: 7.3
-  - php: 7.0
-    env: WP_TEST_REPORTER=true
-  - php: 5.6
-    env: WP_TRAVIS_OBJECT_CACHE=true
-    services: memcached
-  - php: 5.2
-    dist: precise
+    - env: WP_TRAVISCI=travis:format LOCAL_PHP=7.2-fpm LOCAL_PHPUNIT=7.2-fpm COMPOSER_INSTALL=true WP_INSTALL=false
+      name: "PHP Linting"
+    - env: WP_TRAVISCI=travis:js LOCAL_PHP=7.1-fpm WP_INSTALL=false
+      name: "JS Tests"
+    - env: LOCAL_PHP_MEMCACHED=true LOCAL_PHPUNIT=7.3-fpm WP_TRAVISCI=test:php
+      name: "PHPUnit Tests: PHP 7.3 with Memcached"
+    - env: LOCAL_PHP=7.0-fpm LOCAL_PHPUNIT=6-php-7.0-fpm WP_TEST_REPORTER=true WP_TRAVISCI=test:php
+      name: "PHPUnit Tests: PHP 7.0"
+    - env: LOCAL_PHP=5.6-fpm LOCAL_PHPUNIT=4-php-5.6-fpm WP_TRAVISCI=test:php
+      name: "PHPUnit Tests: PHP 5.6"
+    - env: WP_TRAVISCI=travis:phpunit WP_INSTALL=false
+      php: 5.2
+      dist: precise
+  fast_finish: true
+
 before_install:
-- |
-  if [[ "$WP_TRAVISCI" == "travis:phpunit" ]]; then
+  - |
+    if [[ "$WP_TRAVISCI" == "test:php" ]]; then
+      travis_retry svn checkout https://plugins.svn.wordpress.org/wordpress-importer/tags/0.6.3/ tests/phpunit/data/plugins/wordpress-importer
+    fi
+  - |
+    if [[ "$WP_TRAVISCI" != "travis:phpunit" ]]; then
+      curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -
+      sudo add-apt-repository "deb [arch=amd64] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable"
+      sudo apt-get update
+      sudo apt-get -y -o Dpkg::Options::="--force-confnew" install docker-ce
+    fi
+  - |
+    sudo rm /usr/local/bin/docker-compose
+    curl -L https://github.com/docker/compose/releases/download/1.24.0/docker-compose-`uname -s`-`uname -m` > docker-compose
+    chmod +x docker-compose
+    sudo mv docker-compose /usr/local/bin
+  - |
+    if [[ "$WP_TRAVISCI" == "travis:phpunit" ]]; then
       mysql -u root -e "CREATE DATABASE wordpress_tests;"
       cp wp-tests-config-sample.php wp-tests-config.php
@@ -34 +61 @@
       sed -i "s/yourpasswordhere//" wp-tests-config.php
       travis_retry svn checkout https://plugins.svn.wordpress.org/wordpress-importer/tags/0.6.3/ tests/phpunit/data/plugins/wordpress-importer
-  fi
-- |
-  if [[ "$WP_TRAVIS_OBJECT_CACHE" == "true" ]]; then
-    cp tests/phpunit/includes/object-cache.php src/wp-content/object-cache.php
-    echo "extension = memcached.so" >> ~/.phpenv/versions/$(phpenv version-name)/etc/php.ini
-  fi
+    fi
+
 before_script:
-- |
-  # Remove Xdebug for a huge performance increase:
-  if [ -f ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/xdebug.ini ]; then
-    phpenv config-rm xdebug.ini
-  else
-    echo "xdebug.ini does not exist"
-  fi
-- |
-  # Export Composer's global bin dir to PATH, but not on PHP 5.2:
-  if [[ ${TRAVIS_PHP_VERSION:0:3} != "5.2" ]]; then
-    composer config --list --global
-    export PATH=`composer config --list --global | grep '\[home\]' | { read a; echo "${a#* }/vendor/bin:$PATH"; }`
-  fi
-- |
-  # Install the specified version of PHPUnit depending on the PHP version:
-  if [[ "$WP_TRAVISCI" == "travis:phpunit" ]]; then
-    case "$TRAVIS_PHP_VERSION" in
-      7.3|7.2|7.1)
-        echo "Using PHPUnit 7.x"
-        travis_retry composer global require "phpunit/phpunit:^7"
-        ;;
-      7.0)
-        echo "Using PHPUnit 6.x"
-        travis_retry composer global require "phpunit/phpunit:^6"
-        ;;
-      5.6|5.5|5.4|5.3)
-        echo "Using PHPUnit 4.x"
-        travis_retry composer global require "phpunit/phpunit:^4"
-        ;;
-      5.2)
-        # Do nothing, use default PHPUnit 3.6.x
-        echo "Using default PHPUnit, hopefully 3.6"
-        ;;
-      *)
-        echo "No PHPUnit version handling for PHP version $TRAVIS_PHP_VERSION"
-        exit 1
-        ;;
-    esac
-  fi
-- |
-  # We only need to run composer install on the code formatting job.
-  if [[ "$WP_TRAVISCI" == "travis:format" ]]; then
-    composer --version
-    travis_retry composer install
-  fi
-- npm --version
-- node --version
-- nvm install
-- npm install -g grunt-cli
-- npm install
-- npm prune
-- mysql --version
-- phpenv versions
-- php --version
-- php -m
-- npm --version
-- node --version
-- |
-  # Display PHPUnit information (for PHP tests only).
-  if [[ "$WP_TRAVISCI" == "travis:phpunit" ]]; then
-    which phpunit
-    phpunit --version
-  fi
-- curl --version
-- grunt --version
-- git --version
-- svn --version
-- locale -a
-script: grunt $WP_TRAVISCI
+  - |
+    if [[ "$COMPOSER_INSTALL" == "true" ]]; then
+      docker-compose run --rm php composer --version
+      docker-compose run --rm php composer install
+    fi
+  - npm --version
+  - node --version
+  - nvm install
+  - |
+    if [[ "$WP_TRAVISCI" == "travis:phpunit" ]]; then
+      phpenv config-rm xdebug.ini
+      npm install -g grunt-cli
+      mysql --version
+      phpenv versions
+      php --version
+      php -m
+    fi
+  - |
+    if [[ "$NPM_INSTALL" == "true" ]]; then
+      npm install
+    fi
+  - |
+    if [[ "$WP_TRAVISCI" == "test:php" ]]; then
+      npm run env:start
+      npm run build
+      docker-compose run --rm mysql mysql --version
+      docker-compose run --rm php php --version
+      docker-compose run --rm php php -m
+      docker-compose run --rm phpunit phpunit --version
+    fi
+  - |
+    if [[ "$LOCAL_PHP_MEMCACHED" == "true" ]]; then
+      cp tests/phpunit/includes/object-cache.php build/wp-content/object-cache.php
+      # The memcached server needs to start after `npm run env:start`, which sets up the Docker network.
+      docker run --name memcached --net $(basename "$PWD")_wpdevnet -d memcached
+    fi
+  - |
+    if [[ "$WP_INSTALL" == "true" ]]; then
+      # Run the install process after memcached has started.
+      npm run env:install
+    fi
+  - npm --version
+  - node --version
+  - curl --version
+  - git --version
+  - svn --version
+  - php --version
+  - php -i
+  - locale -a
+
+script:
+  - |
+    if [[ "$WP_TRAVISCI" == "test:php" ]]; then
+      npm run test:php -- --verbose -c phpunit.xml.dist &&
+      npm run test:php -- --verbose -c phpunit.xml.dist --group ajax &&
+      npm run test:php -- --verbose -c tests/phpunit/multisite.xml &&
+      npm run test:php -- --verbose -c tests/phpunit/multisite.xml --group ms-files &&
+      npm run test:php -- --verbose -c phpunit.xml.dist --group external-http &&
+      npm run test:php -- --verbose -c phpunit.xml.dist --group restapi-jsclient &&
+      # __fakegroup__ is excluded to force PHPUnit to ignore the <exclude> settings in phpunit.xml.dist.
+      LOCAL_PHP_XDEBUG=true npm run test:php -- -v --group xdebug --exclude-group __fakegroup__
+    elif [[ "$WP_TRAVISCI" == "travis:format" ]]; then
+      docker-compose run --rm php composer format
+    else
+      npm run grunt $WP_TRAVISCI
+    fi
+
 after_script:
-- |
-  if [[ "$WP_TEST_REPORTER" == "true" ]]; then
-    git clone https://github.com/WordPress/phpunit-test-runner.git test-runner
-    export WPT_PREPARE_DIR=$(pwd)
-    export WPT_TEST_DIR=$(pwd)
-    php test-runner/report.php
-  fi
+  - |
+    if [[ "$WP_TEST_REPORTER" == "true" ]]; then
+      git clone https://github.com/WordPress/phpunit-test-runner.git test-runner
+      docker-compose run --rm -e WPT_PREPARE_DIR=/var/www -e WPT_TEST_DIR=/var/www php php test-runner/report.php
+    fi
+
 notifications:
   slack:

branches/5.1/package-lock.json

@@ -33 +33 @@
             "resolved": "https://registry.npmjs.org/@financial-times/useragent_parser/-/useragent_parser-1.0.2.tgz",
             "integrity": "sha512-zuJMxn5Qnk7CKl+zrVXDqXs0F+p4tshO6B4s8VenJj34EEVuV4iZIbkGiEFJUbn29z9Mcn6k8yfj9qSCNDcPPQ=="
+        },
+        "@hapi/address": {
+            "version": "2.1.4",
+            "resolved": "https://registry.npmjs.org/@hapi/address/-/address-2.1.4.tgz",
+            "integrity": "sha512-QD1PhQk+s31P1ixsX0H0Suoupp3VMXzIVMSwobR3F3MSUO2YCV0B7xqLcUw/Bh8yuvd3LhpyqLQWTNcRmp6IdQ==",
+            "dev": true
+        },
+        "@hapi/bourne": {
+            "version": "1.3.2",
+            "resolved": "https://registry.npmjs.org/@hapi/bourne/-/bourne-1.3.2.tgz",
+            "integrity": "sha512-1dVNHT76Uu5N3eJNTYcvxee+jzX4Z9lfciqRRHCU27ihbUcYi+iSc2iml5Ke1LXe1SyJCLA0+14Jh4tXJgOppA==",
+            "dev": true
+        },
+        "@hapi/hoek": {
+            "version": "8.5.1",
+            "resolved": "https://registry.npmjs.org/@hapi/hoek/-/hoek-8.5.1.tgz",
+            "integrity": "sha512-yN7kbciD87WzLGc5539Tn0sApjyiGHAJgKvG9W8C7O+6c7qmoQMfVs0W4bX17eqz6C78QJqqFrtgdK5EWf6Qow==",
+            "dev": true
+        },
+        "@hapi/joi": {
+            "version": "15.1.1",
+            "resolved": "https://registry.npmjs.org/@hapi/joi/-/joi-15.1.1.tgz",
+            "integrity": "sha512-entf8ZMOK8sc+8YfeOlM8pCfg3b5+WZIKBfUaaJT8UsjAAPjartzxIYm3TIbjvA4u+u++KbcXD38k682nVHDAQ==",
+            "dev": true,
+            "requires": {
+                "@hapi/address": "2.x.x",
+                "@hapi/bourne": "1.x.x",
+                "@hapi/hoek": "8.x.x",
+                "@hapi/topo": "3.x.x"
+            }
+        },
+        "@hapi/topo": {
+            "version": "3.1.6",
+            "resolved": "https://registry.npmjs.org/@hapi/topo/-/topo-3.1.6.tgz",
+            "integrity": "sha512-tAag0jEcjwH+P2quUfipd7liWCNX2F8NvYjQp2wtInsZxnMlypdw0FtAOLxtvvkO+GSRRbmNi8m/5y42PQJYCQ==",
+            "dev": true,
+            "requires": {
+                "@hapi/hoek": "^8.3.0"
+            }
         },
         "@tannin/compile": {
@@ -4684 +4723 @@
             }
         },
+        "dotenv": {
+            "version": "8.2.0",
+            "resolved": "https://registry.npmjs.org/dotenv/-/dotenv-8.2.0.tgz",
+            "integrity": "sha512-8sJ78ElpbDJBHNeBzUbUVLsqKdccaa/BXF1uPTw3GrvQTBgrQrtObr2mUrE38vzYd8cEv+m/JBfDLioYcfXoaw==",
+            "dev": true
+        },
+        "dotenv-expand": {
+            "version": "5.1.0",
+            "resolved": "https://registry.npmjs.org/dotenv-expand/-/dotenv-expand-5.1.0.tgz",
+            "integrity": "sha512-YXQl1DSa4/PQyRfgrv6aoNjhasp/p4qs9FjJ4q4cQk+8m4r6k4ZSiEyytKG8f8W9gi8WsQtIObNmKd+tMzNTmA==",
+            "dev": true
+        },
         "download": {
             "version": "4.4.3",
@@ -13296 +13347 @@
             "integrity": "sha1-QAwJ6+kU57F+C27zJjQA/Cq8fLM="
         },
+        "rx": {
+            "version": "4.1.0",
+            "resolved": "https://registry.npmjs.org/rx/-/rx-4.1.0.tgz",
+            "integrity": "sha1-pfE/957zt0D+MKqAP7CfmIBdR4I=",
+            "dev": true
+        },
         "rxjs": {
             "version": "5.5.10",
@@ -15838 +15895 @@
             "requires": {
                 "indexof": "0.0.1"
+            }
+        },
+        "wait-on": {
+            "version": "3.3.0",
+            "resolved": "https://registry.npmjs.org/wait-on/-/wait-on-3.3.0.tgz",
+            "integrity": "sha512-97dEuUapx4+Y12aknWZn7D25kkjMk16PbWoYzpSdA8bYpVfS6hpl2a2pOWZ3c+Tyt3/i4/pglyZctG3J4V1hWQ==",
+            "dev": true,
+            "requires": {
+                "@hapi/joi": "^15.0.3",
+                "core-js": "^2.6.5",
+                "minimist": "^1.2.0",
+                "request": "^2.88.0",
+                "rx": "^4.1.0"
+            },
+            "dependencies": {
+                "core-js": {
+                    "version": "2.6.11",
+                    "resolved": "https://registry.npmjs.org/core-js/-/core-js-2.6.11.tgz",
+                    "integrity": "sha512-5wjnpaT/3dV+XB4borEsnAYQchn00XSgTAWKDkEqv+K8KevjbzmofK6hfJ9TZIlpj2N0xQpazy7PiRQiWHqzWg==",
+                    "dev": true
+                }
             }
         },

branches/5.1/package.json

@@ -20 +20 @@
         "copy-webpack-plugin": "^4.6.0",
         "cssnano": "4.1.8",
+        "dotenv": "^8.2.0",
+        "dotenv-expand": "^5.1.0",
         "grunt": "~1.0.3",
         "grunt-banner": "^0.6.0",
@@ -49 +51 @@
         "uglify-js": "^3.4.9",
         "uglifyjs-webpack-plugin": "2.1.1",
+        "wait-on": "^3.3.0",
         "webpack": "4.29.2",
         "webpack-dev-server": "3.1.14",
@@ -111 +114 @@
     },
     "scripts": {
-        "grunt": "grunt"
+        "build": "grunt build",
+        "build:dev": "grunt build --dev",
+        "dev": "grunt watch --dev",
+        "test": "grunt test",
+        "watch": "grunt watch",
+        "grunt": "grunt",
+        "env:start": "node ./tools/local-env/scripts/start.js",
+        "env:stop": "node ./tools/local-env/scripts/docker.js down",
+        "env:restart": "npm run env:stop && npm run env:start",
+        "env:clean": "node ./tools/local-env/scripts/docker.js down -v --remove-orphans",
+        "env:reset": "node ./tools/local-env/scripts/docker.js down --rmi all -v --remove-orphans",
+        "env:install": "node ./tools/local-env/scripts/install.js",
+        "env:cli": "node ./tools/local-env/scripts/docker.js run cli",
+        "env:logs": "node ./tools/local-env/scripts/docker.js logs",
+        "env:pull": "node ./tools/local-env/scripts/docker.js pull",
+        "test:php": "node ./tools/local-env/scripts/docker.js run --rm phpunit phpunit"
     }
 }

branches/5.1/tests/phpunit/includes/object-cache.php

@@ -835 +835 @@
             $this->servers = $memcached_servers;
         } else {
-            $this->servers = array( array( '127.0.0.1', 11211 ) );
+            $this->servers = array( array( 'memcached', 11211 ) );
         }
 

branches/5.1/tests/phpunit/tests/ajax/CustomizeMenus.php

@@ -55 +55 @@
         if ( 'administrator' != $role ) {
             // If we're not an admin, we should get a wp_die(-1).
-            $this->setExpectedException( 'WPAjaxDieStopException' );
+            $this->setExpectedException( 'WPAjaxDieStopException', '-1' );
         }
 
@@ -444 +444 @@
         if ( 'administrator' != $role ) {
             // If we're not an admin, we should get a wp_die(-1).
-            $this->setExpectedException( 'WPAjaxDieStopException' );
+            $this->setExpectedException( 'WPAjaxDieStopException', '-1' );
         }