Scaffold wp-browser based tests for a plugin or theme
Quick links: Using | Installing | Contributing
The package adds two commands to wp-cli to scaffold wp-browser based tests for themes and plugins. The first one to scaffold plugin tests:
wp wpb-scaffold plugin-tests my-pluginAnd the second one to scaffold theme tests:
wp wpb-scaffold theme-tests my-themeBoth commands will scaffold or update a Composer composer.json configuration file, launch the composer update or composer install and then launch wp-browser own interactive mode to complete the test scaffolding process.
Both commands offer a degree of control of customization on the process detailed below.
--dry-run - whether the command should update or create the Composer file or it should just state what shoudl be done.
--no-install - whether the command should run the install operations or not; a step after the --dry-run option this will make the command udpate or create the needed Composer composer.json file and then exit.
--skip-composer-update - whether the composer update operation should run or not before eventually staring wp-browser interactive mode bootstrap operations; users that would not like the plugin or theme dependencies to be update as a side effect of the command should use this flag; the flag will be ignored if there was no previous Composer configuration file in the plugin or theme root folder.
--composer=<composer path> - if this option is not set the commands will rely on the system wide composer command to run Composer operations; if the composer command has not been added to the system path or you would like to use a specific version of Composer use this option like
wp wpb-scaffold plugin-tests some-plugin --composer="/some/custom/path/composer"
--dir=<dir> - allows you to specify the directory root where tests should be scaffolded; by default the commands will use the slug to find the plugin or theme root folder but the option allows you to control the destination even outside of the WordPress installation folder.
An example usage:
wp wpb-scaffold plugin-tests some-plugin --dir="/user/repos/wordpress/plugins/some-plugin"
--slug=<slug> - allows you to specify the slug that should be used in the Composer composer.json file Composer configuration file; if not set the command will use the existing plugin or theme information or set a default one. An example usage:
wp wpb-scaffold plugin-tests some-plugin --slug="acme/my-plugin"
--description=<description> - allows you to specify the description that should be used in the Composer composer.json file Composer configuration file; if not set the command will use the existing plugin or theme information or set a default one. An example usage:
wp wpb-scaffold plugin-tests some-plugin --description="My awesome plugin!"
--name=<name> - allows you to specify the name of the author that should be used in the Composer composer.json file Composer configuration file; if not set the command will use the existing plugin or theme information or set a default one. An example usage:
wp wpb-scaffold plugin-tests some-plugin --name="John Doe"
--email=<email> - allows you to specify the email of the author that should be used in the Composer composer.json file Composer configuration file; if not set the command will use the existing plugin or theme information or set a default one. An example usage:
wp wpb-scaffold plugin-tests some-plugin --email="john@doe.com"
As any wp-cli additional command the command will also support any global option and flat.
Installing this package requires WP-CLI v0.23.0 or greater. Update to the latest stable release with wp cli update.
Once you've done so, you can install this package with wp package install lucatume/wpcli-wpbrowser-tests.
I appreciate you taking the initiative to contribute to this project.
Contributing isn’t limited to just code. I encourage you to contribute in the way that best fits your abilities, by writing tutorials, giving a demo at your local meetup, helping other users with their support questions, or revising our documentation.
Think you’ve found a bug? I’d love for you to help us get it fixed.
Before you create a new issue, you should search existing issues to see if there’s an existing resolution to it, or if it’s already been fixed in a newer version.
Once you’ve done a bit of searching and discovered there isn’t an open or fixed issue for your bug, please create a new issue with the following:
- What you were doing (e.g. "When I run
wp wpb-scaffold plugin-tests"). - What you saw (e.g. "I see a fatal about a class being undefined.").
- What you expected to see (e.g. "I expected to see the list of posts.")
Include as much detail as you can, and clear steps to reproduce if possible.
Want to contribute a new feature? Please first open a new issue to discuss whether the feature is a good fit for the project.
Once you've decided to commit the time to seeing your pull request through, please follow our guidelines for creating a pull request to make sure it's a pleasant experience:
- Create a feature branch for each contribution.
- Submit your pull request early for feedback.
- Include functional tests with your changes. Read the WP-CLI documentation for an introduction.
- Follow the WordPress Coding Standards.
This README.md is generated dynamically from the project's codebase using wp scaffold package-readme (doc). To suggest changes, please submit a pull request against the corresponding part of the codebase.