Quick reference

• Reference materials:

  Plugin Unit Tests – WP-CLI — WordPress.org

What is PHPUnit WordPress Plugin?

This is PHPUnit environment for WordPress Plugin.

How to use this image

This image is depend on mysql - Docker Hub and intended to use by Docker Compose.

... via docker-compose

Example docker-compose.yml for mysql:

---
services:
  database:
    environment:
      MYSQL_ROOT_PASSWORD: examplepass
    image: mysql:5.7

  phpunit:
    command:
      - bash
    depends_on:
      - database
    environment:
      DATABASE_PASSWORD: examplepass
    image: futureys/phpunit-wordpress-plugin
    stdin_open: true
    tty: true
    volumes:
      - ${PATH_TO_PLUGIN_DIRECTORY}:/plugin

Example .env:

PATH_TO_PLUGIN_DIRECTORY=../path/to/wordpress-plugin

Run docker-compose run phpunit, wait for it to initialize completely, when prompt is displayed, run phpunit or phpcs (as appropriate).

Environment Variables

DATABASE_NAME

Database name to create for WordPress. (default: wordpress)

DATABASE_USER

Database user to connect from WordPress. (default: root)

DATABASE_PASSWORD

Database password to connect from WordPress.

DATABASE_HOST

Database host name to connect from WordPress. (default: database)

DATABASE_PORT

Database port to connect from WordPress. (default: 3306)

License

View license information for the software contained in this image.

As with all Docker images, these likely also contain other software which may be under other licenses (such as Bash, etc from the base distribution, along with any direct or indirect dependencies of the primary software being contained).

Some additional license information which was able to be manual-checked might be found in the yukihiko-shinoda/dockerfile-phpunit-wordpress-plugin repository's dependencies.yml file.

As for any pre-built image usage, it is the image user's responsibility to ensure that any use of this image complies with any relevant licenses for all software contained within.