woocommerce/tests/framework/class-wc-unit-test-case.php

134 lines
3.5 KiB
PHP

<?php
/**
* Base test case for all WooCommerce tests.
*
* @package WooCommerce\Tests
*/
/**
* WC Unit Test Case.
*
* Provides WooCommerce-specific setup/tear down/assert methods, custom factories,
* and helper functions.
*
* @since 2.2
*/
class WC_Unit_Test_Case extends WP_UnitTestCase {
/**
* Holds the WC_Unit_Test_Factory instance.
*
* @var WC_Unit_Test_Factory
*/
protected $factory;
/**
* Setup test case.
*
* @since 2.2
*/
public function setUp() {
parent::setUp();
// Add custom factories.
$this->factory = new WC_Unit_Test_Factory();
// Setup mock WC session handler.
add_filter( 'woocommerce_session_handler', array( $this, 'set_mock_session_handler' ) );
$this->setOutputCallback( array( $this, 'filter_output' ) );
// Register post types before each test.
WC_Post_types::register_post_types();
WC_Post_types::register_taxonomies();
}
/**
* Mock the WC session using the abstract class as cookies are not available.
* during tests.
*
* @since 2.2
* @return string The $output string, sans newlines and tabs.
*/
public function set_mock_session_handler() {
return 'WC_Mock_Session_Handler';
}
/**
* Strip newlines and tabs when using expectedOutputString() as otherwise.
* the most template-related tests will fail due to indentation/alignment in.
* the template not matching the sample strings set in the tests.
*
* @since 2.2
*
* @param string $output The captured output.
* @return string The $output string, sans newlines and tabs.
*/
public function filter_output( $output ) {
$output = preg_replace( '/[\n]+/S', '', $output );
$output = preg_replace( '/[\t]+/S', '', $output );
return $output;
}
/**
* Asserts thing is not WP_Error.
*
* @since 2.2
* @param mixed $actual The object to assert is not an instance of WP_Error.
* @param string $message A message to display if the assertion fails.
*/
public function assertNotWPError( $actual, $message = '' ) {
if ( ! $message && is_wp_error( $actual ) ) {
$message = $actual->get_error_message();
}
$this->assertNotInstanceOf( 'WP_Error', $actual, $message );
}
/**
* Asserts thing is WP_Error.
*
* @param mixed $actual The object to assert is an instance of WP_Error.
* @param string $message A message to display if the assertion fails.
*/
public function assertIsWPError( $actual, $message = '' ) {
$this->assertInstanceOf( 'WP_Error', $actual, $message );
}
/**
* Throws an exception with an optional message and code.
*
* Note: can't use `throwException` as that's reserved.
*
* @since 3.3-dev
* @param string $message Optional. The exception message. Default is empty.
* @param int $code Optional. The exception code. Default is empty.
* @throws Exception Containing the given message and code.
*/
public function throwAnException( $message = null, $code = null ) {
$message = $message ? $message : "We're all doomed!";
throw new Exception( $message, $code );
}
/**
* Backport assertNotFalse to PHPUnit 3.6.12 which only runs in PHP 5.2.
*
* @since 2.2
* @param mixed $condition The statement to evaluate as not false.
* @param string $message A message to display if the assertion fails.
*/
public static function assertNotFalse( $condition, $message = '' ) {
if ( version_compare( phpversion(), '5.3', '<' ) ) {
self::assertThat( $condition, self::logicalNot( self::isFalse() ), $message );
} else {
parent::assertNotFalse( $condition, $message );
}
}
}