MZAWeb/wp-browser

WordPress extension of PhpBrowser for Codeception.

wp-browser

WordPress extension of PhpBrowser for Codeception.

The package includes a class extending Codeception PhpBrowser module that adds WordPress related assertions for cest and cept tests and an extension of Codeception own Db module meant to allow for more comfortable WordPress specific database handling and testing.

Installing

To install simply require the package in the composer.json file like

"require-dev": { "lucatume/wp-browser": "master@dev" }

and then use composer update

Configuration

WPBrowser

In the acceptance.suite.yml add the module among the loaded ones

# Codeception Test Suite Configuration

# suite for acceptance tests.
# perform tests in browser using the WebDriver or PhpBrowser.
# If you need both WebDriver and PHPBrowser tests - create a separate suite.

class_name: AcceptanceTester
modules:
    enabled:
        - AcceptanceHelper
        - WPBrowser
    config:
        WPBrowser:
            url: 'http://example.local'
            adminUsername: 'theAdmin'
            adminPassword: 'iguana'
            adminUrl: '/wp-core/wp-admin'

and configure the required adminUsername, adminPassword and adminUrl fields. The adminUrl is relative to the url specified in PhpBrowser configuration.

Methods

The module adds methods that can be used in .cest and .cept methods using the same $I->doSomething syntax used in PhpBrowser.
Included methods are:

// login as administrator using username and password
public function loginAsAdmin();

// login as user
public function loginAs($username, $password);

// go the plugins page
public function amOnPluginsPage();

// activate a plugin from the plugin page
public function activatePlugin($pluginSlug);

// deactivate a plugin from the plugin page
public function deactivatePlugin($pluginSlug);

// check that a plugin is installed and deactivated from the plugin page
public function seePluginDeactivated($pluginSlug);

// check that a plugin is installed and activated from the plugin page
public function seePluginActivated($pluginSlug);

// check that a plugin is installed from the plugin page
public function seePluginInstalled($pluginSlug);

// check that a plugin is not installed from the plugin page
public function doNotSeePluginInstalled($pluginSlug);

// check for an error admin notice
public function seeErrorMessage($classes = '');

// check for an updated admin notice
public function seeMessage($classes = '');

// check that the current page is a wp_die generated one
public function seeWpDiePage();

all pretty explanatory. Methods like seePlugin... require the use of the amOnPluginsPage method before their invocation to navigate PhpBrowser to the right folder.

WPDb

The module extends Codeception\Module\Db and will hence act as a drop-in replacement for it. It adds an optional tablePrefix configuration parameter, defaulting to wp, and will require the same parameters as the original module.

Methods

The module is meant to be a WordPress specific extension of the Db module and will hence decline the have and see methods for each WordPress table. As an example the methods for the options table are:

public function haveOptionInDatabase($option_name, $option_value);

public function haveSerializedOptionInDatabase($option_name, $option_value);

public function seeOptionInDatabase($option_name, $option_value);

public function dontSeeOptionInDatabase($option_name, $option_value);

public function seeSerializedOptionInDatabase($option_name, $option_value);

public function dontSeeSerializedOptionInDatabase($option_name, $option_value);

public function haveUserInDatabase($user_login, $user_id, $role = 'subscriber', Array $userData = [])

public function seeUserInDatabase(Array $criteria);