pantheon-systems/pantheon-wordpress-develop

Name: pantheon-wordpress-develop

Owner: Pantheon

Description: A set of scripts to do nightly testing on Pantheon of the latest WordPress commits

Created: 2016-06-16 19:32:54.0

Updated: 2017-02-02 04:14:23.0

Pushed: 2017-08-22 13:39:48.0

Homepage:

Size: 28

Language: PHP

GitHub Committers

User	Most Recent Commit	# Commits

Other Committers

User	Email	Most Recent Commit	# Commits

README

pantheon-wordpress-develop

Runs the WordPress PHPUnit test suite on Pantheon infrastructure to ensure Pantheon is fully compatible with WordPress.

This repo is deprecated in favor of pantheon-systems/wordpress-unit-tests

How It Works

The purpose of this repository is to verify that Pantheon's infrastructure is fully compatible with WordPress. Compatibility is verified by running the WordPress PHPUnit test suite on Pantheon on a regular, automated basis. The test running is handled end to end with CircleCI, and can easily be driven from your local environment too.

On a high level, here's how it works:

1. A new CircleCI job is initiated through a cron job, or manually.
2. The job environment defines three important environment variables:
3. TERMINUS_TOKEN - A machine token used for creating and deleting site environments on Pantheon. Because this token is meant to be kept secret, the value is set in the CircleCI admin, and not tracked in circle.yml.
4. TERMINUS_SITE - An existing Pantheon site to be used for running the test suite. This site must support multidev, and the TERMINUS_TOKEN must be able to create and delete environments for this site.
5. TERMINUS_ENV - A unique name for the multidev branch to be created, to prevent collisions between jobs.
6. CircleCI installs Terminus, an interface for programmatically interacting with Pantheon.
7. The test suite runs in three steps:
8. prepare.sh - Prepares the Pantheon site environment to have the test suite run against it. Preparation includes:
   • Creating the site environment using Terminus.
   • Force pushing git://develop.git.wordpress.org/ to the branch correlating with the site environment.
   • Committing the configuration files in templates/.
   • Committing a copy of PHPUnit
   • Now that the git operations have completed, changing the environment to SFTP mode.
9. test.sh - Runs the PHPUnit test suite through a WP-CLI command proxy, and reports the results to Slack.
10. cleanup.sh - Cleans up after the test suite has completed. Cleanup includes:
    • Deleting the site environment using Terminus.

And that's it!

Making Improvements

Need to improve this test runner in some way? You can clone the repository locally and run it against any Pantheon site.

WARNING! WARNING!

PLEASE READ THE FOLLOWING VERY CAREFULLY.

BY FORCE PUSHING AGAINST TERMINUS_ENV AND ERASING THE DATABASE, THIS TEST RUNNER IRREVOCABLY DAMAGES YOUR PANTHEON SITE. USE ONLY WITH A SINGLE-USE, “THROWAWAY” SITE. DO NOT USE WITH ANY PANTHEON SITE THAT CANNOT BE DELETED.

With the warning out of the way, here's how you can use the test runner locally.

First, make sure Terminus is installed and authenticated:

composer global require pantheon-systems/terminus
terminus auth login --machine-token=<secret-token>

Then, you can clone and use the test runner:

git clone git@github.com:pantheon-systems/pantheon-wordpress-develop.git
cd pantheon-wordpress-develop
export TERMINUS_SITE=<disposable-site>
export TERMINUS_ENV=<disposable-env>
./prepare.sh
./test.sh
./cleanup.sh

Feel free to open an issue with any questions you may have.