Skip to content

README.md

Latest commit

 

History

History
50 lines (33 loc) · 1.42 KB

README.md

File metadata and controls

50 lines (33 loc) · 1.42 KB

Tests

This plugin has integration tests only — no separate unit suite. Tests run inside a wp-env container so they have access to a real WordPress install.

Prerequisites

  • Docker (required by wp-env).
  • Node.js (any LTS version) for wp-env.
  • Composer for PHP dependencies.

One-time setup

composer install
npx wp-env start

wp-env start builds the WordPress containers and mounts this plugin into them. The first run takes a minute or two.

Running the tests

composer test:integration       # Single-site integration tests
composer test:integration-ms    # Same tests in multisite mode

Both commands run PHPUnit inside the tests-cli container, so you don't need PHP locally to use them.

Coverage

composer coverage               # Generates HTML coverage in build/coverage-html/
composer coverage-ci            # Runs PHPUnit without writing the report

Stopping the environment

npx wp-env stop

Where tests live

  • tests/bootstrap.php — PHPUnit bootstrap (uses yoast/wp-test-utils).
  • tests/Integration/TestCase.php — base class. Extend this for new tests.
  • tests/Integration/*Test.php — the test files themselves.

Continuous integration

The matrix in .github/workflows/integration.yml runs the lowest supported combination (WP 6.4 / PHP 7.4) and the latest (master / latest PHP). Both single-site and multisite paths run on every push.