Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pantheon-systems/wpunit-helpers
Unified scripts for installing and running automated WP Unit Tests.
https://github.com/pantheon-systems/wpunit-helpers
hacktoberfest phpunit unit-testing wordpress wp-unit
Last synced: 5 days ago
JSON representation
Unified scripts for installing and running automated WP Unit Tests.
- Host: GitHub
- URL: https://github.com/pantheon-systems/wpunit-helpers
- Owner: pantheon-systems
- License: mit
- Created: 2023-10-12T17:24:59.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-08-28T17:02:30.000Z (2 months ago)
- Last Synced: 2024-10-31T09:47:24.942Z (5 days ago)
- Topics: hacktoberfest, phpunit, unit-testing, wordpress, wp-unit
- Language: Shell
- Homepage:
- Size: 18.6 KB
- Stars: 0
- Watchers: 21
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# WPUnit Helpers
[](https://github.com/pantheon-systems/wpunit-helpers/actions/workflows/lint.yml) [](https://github.com/pantheon-systems/wpunit-helpers/actions/workflows/test.yml)   [](https://docs.pantheon.io/oss-support-levels#unofficial-support)
Composer plugin providing unified scripts for installing and running automated WP Unit Tests.
## What is this?
This is a set of scripts that can be used in a WordPress plugin or theme repository to run automated tests using the WP Unit Test Framework built on top of PHPUnit. The Composer plugin will install these scripts into the dependent project's `bin` directory, allowing you to add helper scripts to your `composer.json`.
This package fundamentally differs from the traditional `install-wp-tests.sh` script that's existed in the WordPress community for many years by removing some of the idiosyncracies of that workflow and replacing them with a WP-CLI-based approach.
## Requirements
Before using these scripts, you must have the following installed:
* [Composer](https://getcomposer.org/)
* [WP-CLI](https://wp-cli.org/)
Additionally, if you intend to run the tests in a CI environment, you will need to have some modern MySQL-compatible database server available (MariaDB, MySQL, etc).
## What's included?
* `install-wp-tests.sh` - A standardized script for installing the WP Unit Test Framework.
* `install-local-tests.sh` - A helper script for installing WP Unit Tests locally. See [Local Testing](#local-testing) for more information.
* `phpunit-test.sh` - A helper script for running WP Unit Tests that is intended for use in CI.
* `helpers.sh` - A collection of helper functions used by the other scripts.
## Installation
Use Composer to install this package as a development dependency:
```bash
composer require --dev pantheon-systems/wpunit-helpers
```
On installation, the Composer plugin will copy the scripts into the `bin` directory of the dependent project. You can then add the scripts to your `composer.json`:
```json
{
"scripts": {
"phpunit": "phpunit --do-not-cache-result",
"test": "@phpunit",
"test:install": "bin/install-local-tests.sh --skip-db=true",
"test:install:withdb": "bin/install-local-tests.sh"
}
}
```
## Local Testing
The `install-local-tests.sh` script is highly configurable to allow for a variety of local environment setups. Any parameter that could be passed into `install-wp-tests.sh` is set up as an optional flag in `install-local-tests.sh`. By default, the script with no flags will assume that a new database should be created as `root` with no password.
### Flags
#### `--skip-db`
If set and `true`, this flag will skip the database creation step. This is useful if you are using a local database that is already set up. This replaces the (now deprecated) `--no-db` flag.
#### `--dbname`
This flag will set the name of the database to be created. The default value is `wordpress_test`.
#### `--dbuser`
This flag will set the username of the database user to be created. The default value is `root`.
#### `--dbpass`
This flag will set the password of the database user to be created. The default value is an empty string.
#### `--dbhost`
This flag will set the host of the database to be created. The default value is `127.0.0.1`.
#### `--wpversion`
This flag will set the version of WordPress to be installed. The default value is `latest`. Using `nightly` here will use the latest nightly build of WordPress.
#### `--tmpdir`
This flag will set the temporary directory to be used for the WordPress installation. The default value is `/tmp`.