wp-codeception.php

<?php
/**
 * Plugin Name: WP Codeception
 * Plugin URI: https://github.com/10up/wp-codeception
 * Description: Registers WP-CLI commands which allow you to execute Codeception tests.
 * Author: 10up Inc
 * Author URI: https://10up.com/
 * Version: 1.0.3
 * License: GPL version 2 or later - http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
 */

// +----------------------------------------------------------------------+
// | Copyright 2015 10up Inc                                              |
// +----------------------------------------------------------------------+
// | This program is free software; you can redistribute it and/or modify |
// | it under the terms of the GNU General Public License, version 2, as  |
// | published by the Free Software Foundation.                           |
// |                                                                      |
// | This program is distributed in the hope that it will be useful,      |
// | but WITHOUT ANY WARRANTY; without even the implied warranty of       |
// | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the        |
// | GNU General Public License for more details.                         |
// |                                                                      |
// | You should have received a copy of the GNU General Public License    |
// | along with this program; if not, write to the Free Software          |
// | Foundation, Inc., 51 Franklin St, Fifth Floor, Boston,               |
// | MA 02110-1301 USA                                                    |
// +----------------------------------------------------------------------+

// do nothing if PHP version is less than 5.5
if ( version_compare( PHP_VERSION, '5.5', '<' ) ) {
	return;
}

// Do nothing if WP_CLI is not defined
if ( ! defined( 'WP_CLI' ) || ! WP_CLI ) {
	return;
}

// Only ever load wp-codeception once
if ( ! defined( 'WP_CODECEPTION_LOADED' ) ) {

	// Define constants
	define( 'WPCC_VERSION', '1.0.3' );
	define( 'WPCC_ABSPATH', __DIR__ );
	define( 'WP_CODECEPTION_LOADED', true );

	// See if the codeception library is available, if not, try to load it
	if ( ! class_exists( 'Codeception\Codecept' ) ) {
		try {
			if ( ! file_exists( __DIR__ . '/vendor/autoload.php' ) ) {
				throw new Exception( 'You must run composer first if running this as a standalone plugin' );
			}
			require_once __DIR__ . '/vendor/autoload.php';
		} catch ( Exception $e ) {
			WP_CLI::error( $e->getMessage() );
		}
	}

	// Register WP-CLI commands
	WP_CLI::add_command( 'codeception', '\WPCC\CLI\Codeception' );
	WP_CLI::add_command( 'selenium', '\WPCC\CLI\Selenium' );

}

/**
 * Following functions were copied from the Codeception's autoload file, because
 * we are not going to load it anymore, but these functions are still required
 * and used in the depths of the framework, so we have to load it here.
 */

if ( ! function_exists( 'codecept_debug' ) ) :

	/**
	 * Registers debug message which will be printed if --debug argument is passed to the command.
	 *
	 * @since 1.0.1
	 *
	 * @param mixed $data The debug data, it will be serialized if we need to display it.
	 */
	function codecept_debug( $data ) {
		\Codeception\Util\Debug::debug( $data );
	}

endif;

if ( ! function_exists( 'codecept_root_dir' ) ) :

	/**
	 * Returns absolute path to the requested object which is expected to be in
	 * the root directory of a testing project.
	 *
	 * @since 1.0.1
	 *
	 * @param string $appendPath A relative path to the requested object.
	 * @return string The absolute path to the object.
	 */
	function codecept_root_dir( $appendPath = '' ) {
		return \Codeception\Configuration::projectDir() . $appendPath;
	}

endif;

if ( ! function_exists( 'codecept_output_dir' ) ) :

	/**
	 * Returns absolute path to the requested object which is expected to be in
	 * the output directory of a testing project.
	 *
	 * @since 1.0.1
	 *
	 * @param string $appendPath A relative path to the requested object.
	 * @return string The absolute path to the object.
	 */
	function codecept_output_dir( $appendPath = '' ) {
		return \Codeception\Configuration::outputDir() . $appendPath;
	}

endif;

if ( ! function_exists( 'codecept_log_dir' ) ) :

	/**
	 * Returns absolute path to the requested object which is expected to be in
	 * the log directory of a testing project.
	 *
	 * @since 1.0.1
	 *
	 * @param string $appendPath A relative path to the requested object.
	 * @return string The absolute path to the object.
	 */
	function codecept_log_dir( $appendPath = '' ) {
		return \Codeception\Configuration::outputDir() . $appendPath;
	}

endif;

if ( ! function_exists( 'codecept_data_dir' ) ) :

	/**
	 * Returns absolute path to the requested object which is expected to be in
	 * the data directory of a testing project.
	 *
	 * @since 1.0.1
	 *
	 * @param string $appendPath A relative path to the requested object.
	 * @return string The absolute path to the object.
	 */
	function codecept_data_dir( $appendPath = '' ) {
		return \Codeception\Configuration::dataDir() . $appendPath;
	}

endif;