Steve-Dee-Designs
/
woocommerce
mirror of https://github.com/woocommerce/woocommerce.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
woocommerce/tests/unit-tests/util/class-wc-tests-core-functio...

649 lines
17 KiB
PHP
Raw Blame History

<?php
/**
* Unit tests for the core functions.
*
* @package WooCommerce\Tests\Util
* @since 2.2
*/
/**
* Core function unit tests.
*/
class WC_Tests_Core_Functions extends WC_Unit_Test_Case {
/**
* Test get_woocommerce_currency().
*
* @since 2.2
*/
public function test_get_woocommerce_currency() {
$this->assertEquals( 'GBP', get_woocommerce_currency() );
}
/**
* Test get_woocommerce_currencies().
*
* @since 2.2
*/
public function test_get_woocommerce_currencies() {
$expected_currencies = array(
'AED' => 'United Arab Emirates dirham',
'AFN' => 'Afghan afghani',
'ALL' => 'Albanian lek',
'AMD' => 'Armenian dram',
'ANG' => 'Netherlands Antillean guilder',
'AOA' => 'Angolan kwanza',
'ARS' => 'Argentine peso',
'AUD' => 'Australian dollar',
'AWG' => 'Aruban florin',
'AZN' => 'Azerbaijani manat',
'BAM' => 'Bosnia and Herzegovina convertible mark',
'BBD' => 'Barbadian dollar',
'BDT' => 'Bangladeshi taka',
'BGN' => 'Bulgarian lev',
'BHD' => 'Bahraini dinar',
'BIF' => 'Burundian franc',
'BMD' => 'Bermudian dollar',
'BND' => 'Brunei dollar',
'BOB' => 'Bolivian boliviano',
'BRL' => 'Brazilian real',
'BSD' => 'Bahamian dollar',
'BTC' => 'Bitcoin',
'BTN' => 'Bhutanese ngultrum',
'BWP' => 'Botswana pula',
'BYR' => 'Belarusian ruble (old)',
'BYN' => 'Belarusian ruble',
'BZD' => 'Belize dollar',
'CAD' => 'Canadian dollar',
'CDF' => 'Congolese franc',
'CHF' => 'Swiss franc',
'CLP' => 'Chilean peso',
'CNY' => 'Chinese yuan',
'COP' => 'Colombian peso',
'CRC' => 'Costa Rican col&oacute;n',
'CUC' => 'Cuban convertible peso',
'CUP' => 'Cuban peso',
'CVE' => 'Cape Verdean escudo',
'CZK' => 'Czech koruna',
'DJF' => 'Djiboutian franc',
'DKK' => 'Danish krone',
'DOP' => 'Dominican peso',
'DZD' => 'Algerian dinar',
'EGP' => 'Egyptian pound',
'ERN' => 'Eritrean nakfa',
'ETB' => 'Ethiopian birr',
'EUR' => 'Euro',
'FJD' => 'Fijian dollar',
'FKP' => 'Falkland Islands pound',
'GBP' => 'Pound sterling',
'GEL' => 'Georgian lari',
'GGP' => 'Guernsey pound',
'GHS' => 'Ghana cedi',
'GIP' => 'Gibraltar pound',
'GMD' => 'Gambian dalasi',
'GNF' => 'Guinean franc',
'GTQ' => 'Guatemalan quetzal',
'GYD' => 'Guyanese dollar',
'HKD' => 'Hong Kong dollar',
'HNL' => 'Honduran lempira',
'HRK' => 'Croatian kuna',
'HTG' => 'Haitian gourde',
'HUF' => 'Hungarian forint',
'IDR' => 'Indonesian rupiah',
'ILS' => 'Israeli new shekel',
'IMP' => 'Manx pound',
'INR' => 'Indian rupee',
'IQD' => 'Iraqi dinar',
'IRR' => 'Iranian rial',
'IRT' => 'Iranian toman',
'ISK' => 'Icelandic kr&oacute;na',
'JEP' => 'Jersey pound',
'JMD' => 'Jamaican dollar',
'JOD' => 'Jordanian dinar',
'JPY' => 'Japanese yen',
'KES' => 'Kenyan shilling',
'KGS' => 'Kyrgyzstani som',
'KHR' => 'Cambodian riel',
'KMF' => 'Comorian franc',
'KPW' => 'North Korean won',
'KRW' => 'South Korean won',
'KWD' => 'Kuwaiti dinar',
'KYD' => 'Cayman Islands dollar',
'KZT' => 'Kazakhstani tenge',
'LAK' => 'Lao kip',
'LBP' => 'Lebanese pound',
'LKR' => 'Sri Lankan rupee',
'LRD' => 'Liberian dollar',
'LSL' => 'Lesotho loti',
'LYD' => 'Libyan dinar',
'MAD' => 'Moroccan dirham',
'MDL' => 'Moldovan leu',
'MGA' => 'Malagasy ariary',
'MKD' => 'Macedonian denar',
'MMK' => 'Burmese kyat',
'MNT' => 'Mongolian t&ouml;gr&ouml;g',
'MOP' => 'Macanese pataca',
'MRO' => 'Mauritanian ouguiya',
'MUR' => 'Mauritian rupee',
'MVR' => 'Maldivian rufiyaa',
'MWK' => 'Malawian kwacha',
'MXN' => 'Mexican peso',
'MYR' => 'Malaysian ringgit',
'MZN' => 'Mozambican metical',
'NAD' => 'Namibian dollar',
'NGN' => 'Nigerian naira',
'NIO' => 'Nicaraguan c&oacute;rdoba',
'NOK' => 'Norwegian krone',
'NPR' => 'Nepalese rupee',
'NZD' => 'New Zealand dollar',
'OMR' => 'Omani rial',
'PAB' => 'Panamanian balboa',
'PEN' => 'Peruvian nuevo sol',
'PGK' => 'Papua New Guinean kina',
'PHP' => 'Philippine peso',
'PKR' => 'Pakistani rupee',
'PLN' => 'Polish z&#x142;oty',
'PRB' => 'Transnistrian ruble',
'PYG' => 'Paraguayan guaran&iacute;',
'QAR' => 'Qatari riyal',
'RON' => 'Romanian leu',
'RSD' => 'Serbian dinar',
'RUB' => 'Russian ruble',
'RWF' => 'Rwandan franc',
'SAR' => 'Saudi riyal',
'SBD' => 'Solomon Islands dollar',
'SCR' => 'Seychellois rupee',
'SDG' => 'Sudanese pound',
'SEK' => 'Swedish krona',
'SGD' => 'Singapore dollar',
'SHP' => 'Saint Helena pound',
'SLL' => 'Sierra Leonean leone',
'SOS' => 'Somali shilling',
'SRD' => 'Surinamese dollar',
'SSP' => 'South Sudanese pound',
'STD' => 'S&atilde;o Tom&eacute; and Pr&iacute;ncipe dobra',
'SYP' => 'Syrian pound',
'SZL' => 'Swazi lilangeni',
'THB' => 'Thai baht',
'TJS' => 'Tajikistani somoni',
'TMT' => 'Turkmenistan manat',
'TND' => 'Tunisian dinar',
'TOP' => 'Tongan pa&#x2bb;anga',
'TRY' => 'Turkish lira',
'TTD' => 'Trinidad and Tobago dollar',
'TWD' => 'New Taiwan dollar',
'TZS' => 'Tanzanian shilling',
'UAH' => 'Ukrainian hryvnia',
'UGX' => 'Ugandan shilling',
'USD' => 'United States dollar',
'UYU' => 'Uruguayan peso',
'UZS' => 'Uzbekistani som',
'VEF' => 'Venezuelan bol&iacute;var',
'VND' => 'Vietnamese &#x111;&#x1ed3;ng',
'VUV' => 'Vanuatu vatu',
'WST' => 'Samoan t&#x101;l&#x101;',
'XAF' => 'Central African CFA franc',
'XCD' => 'East Caribbean dollar',
'XOF' => 'West African CFA franc',
'XPF' => 'CFP franc',
'YER' => 'Yemeni rial',
'ZAR' => 'South African rand',
'ZMW' => 'Zambian kwacha',
);
$this->assertEquals( $expected_currencies, get_woocommerce_currencies() );
}
/**
* Test get_woocommerce_currency_symbol().
*
* @since 2.2
*/
public function test_get_woocommerce_currency_symbol() {
// Default currency.
$this->assertEquals( '&pound;', get_woocommerce_currency_symbol() );
// Given specific currency.
$this->assertEquals( '&#36;', get_woocommerce_currency_symbol( 'USD' ) );
// Each case.
foreach ( array_keys( get_woocommerce_currencies() ) as $currency_code ) {
$this->assertInternalType( 'string', get_woocommerce_currency_symbol( $currency_code ) );
}
}
/**
* Test get_woocommerce_api_url().
*
* @since 2.2
*/
public function test_get_woocommerce_api_url() {
$base_uri = get_home_url();
// Base URI.
$this->assertEquals( "$base_uri/wc-api/v3/", get_woocommerce_api_url( null ) );
// Path.
$this->assertEquals( "$base_uri/wc-api/v3/orders", get_woocommerce_api_url( 'orders' ) );
}
/**
* Test wc_get_log_file_path().
*
* @since 2.4
*/
public function test_wc_get_log_file_path() {
$log_dir = trailingslashit( WC_LOG_DIR );
$hash_name = sanitize_file_name( wp_hash( 'unit-tests' ) );
$this->assertEquals( $log_dir . 'unit-tests-' . $hash_name . '.log', wc_get_log_file_path( 'unit-tests' ) );
}
/**
* Test wc_get_logger().
*
* @since 3.0.0
*/
public function test_wc_get_logger() {
// This filter should have no effect because the class does not implement WC_Logger_Interface.
add_filter( 'woocommerce_logging_class', array( $this, 'return_bad_logger' ) );
$this->setExpectedIncorrectUsage( 'wc_get_logger' );
$log_a = wc_get_logger();
$log_b = wc_get_logger();
$this->assertInstanceOf( 'WC_Logger', $log_a );
$this->assertInstanceOf( 'WC_Logger', $log_b );
$this->assertSame( $log_a, $log_b, '`wc_get_logger()` should return the same instance' );
}
/**
* Return class which does not implement WC_Logger_Interface
*
* This is a helper function to test woocommerce_logging_class filter and wc_get_logger.
*
* @return string Class name
*/
public function return_bad_logger() {
return __CLASS__;
}
/**
* Test wc_get_base_location().
*
* @since 2.3.0
*/
public function test_wc_get_base_location() {
$default = wc_get_base_location();
$this->assertEquals( 'GB', $default['country'] );
$this->assertEquals( '', $default['state'] );
}
/**
* Test wc_format_country_state_string().
*
* @since 2.6.0
*/
public function test_wc_format_country_state_string() {
// Test with correct values.
$this->assertEquals(
array(
'country' => 'US',
'state' => 'CA',
),
wc_format_country_state_string( 'US:CA' )
);
// Test what happens when we pass an incorrect value.
$this->assertEquals(
array(
'country' => 'US-CA',
'state' => '',
),
wc_format_country_state_string( 'US-CA' )
);
}
/**
* Test wc_get_shipping_method_count()
*
* @since 2.6.0
*/
public function test_wc_get_shipping_method_count() {
// Without legacy methods.
$this->assertEquals( 0, wc_get_shipping_method_count( false ) );
// With legacy methods.
$this->assertEquals( 0, wc_get_shipping_method_count( true ) );
}
/**
* Test wc_print_r()
*
* @since 3.0.0
*/
public function test_wc_print_r() {
$arr = array(
1,
2,
'a',
'b',
'c' => 'd',
);
// This filter will sequentially remove handlers, allowing us to test as though our
// functions were accumulatively blacklisted, adding one on each call.
add_filter( 'woocommerce_print_r_alternatives', array( $this, 'filter_wc_print_r_alternatives' ) );
$this->expectOutputString(
print_r( $arr, true ),
$return_value = wc_print_r( $arr )
);
$this->assertTrue( $return_value );
ob_clean();
$this->expectOutputString(
var_export( $arr, true ),
$return_value = wc_print_r( $arr )
);
$this->assertTrue( $return_value );
ob_clean();
$this->expectOutputString(
json_encode( $arr ),
$return_value = wc_print_r( $arr )
);
$this->assertTrue( $return_value );
ob_clean();
$this->expectOutputString(
serialize( $arr ),
$return_value = wc_print_r( $arr )
);
$this->assertTrue( $return_value );
ob_clean();
$this->expectOutputString(
'',
$return_value = wc_print_r( $arr )
);
$this->assertFalse( $return_value );
ob_clean();
// Reset filter to include all handlers.
$this->filter_wc_print_r_alternatives( array(), true );
$this->assertEquals( print_r( $arr, true ), wc_print_r( $arr, true ) );
$this->assertEquals( var_export( $arr, true ), wc_print_r( $arr, true ) );
$this->assertEquals( json_encode( $arr ), wc_print_r( $arr, true ) );
$this->assertEquals( serialize( $arr ), wc_print_r( $arr, true ) );
$this->assertFalse( wc_print_r( $arr, true ) );
remove_filter( 'woocommerce_print_r_alternatives', array( $this, 'filter_wc_print_r_alternatives' ) );
}
/**
* Filter function to help test wc_print_r alternatives via filter.
*
* On the first run, all alternatives are returned.
* On each successive run, an alternative is excluded from the beginning.
* Eventually, no handlers are returned.
*
* @param array $alternatives Input array of alternatives.
* @param bool $reset Optional. Default false. True to reset excluded alternatives.
* @return array|bool Alternatives. True on reset.
*/
public function filter_wc_print_r_alternatives( $alternatives, $reset = false ) {
static $skip = 0;
if ( $reset ) {
$skip = 0;
return true;
}
return array_slice( $alternatives, $skip++ );
}
/**
* Test wc_get_wildcard_postcodes
*/
public function test_wc_get_wildcard_postcodes() {
$postcode = 'cb23 6as';
$country = 'GB';
$wildcards = array( 'cb23 6as', 'CB23 6AS', 'CB23 6AS*', 'CB23 6A*', 'CB23 6*', 'CB23 *', 'CB23*', 'CB2*', 'CB*', 'C*', '*' );
$this->assertEquals( $wildcards, wc_get_wildcard_postcodes( $postcode, $country ) );
$postcode = 'GIJóN';
$country = '';
$wildcards = array( 'GIJóN', 'GIJÓN', 'GIJÓN*', 'GIJÓ*', 'GIJ*', 'GI*', 'G*', '*' );
$this->assertEquals( $wildcards, wc_get_wildcard_postcodes( $postcode, $country ) );
}
/**
* Tests wc_maybe_define_constant().
*
* @since 3.2.0
*/
public function test_wc_maybe_define_constant() {
$this->assertFalse( defined( 'WC_TESTING_DEFINE_FUNCTION' ) );
// Check if defined.
wc_maybe_define_constant( 'WC_TESTING_DEFINE_FUNCTION', true );
$this->assertTrue( defined( 'WC_TESTING_DEFINE_FUNCTION' ) );
// Check value.
wc_maybe_define_constant( 'WC_TESTING_DEFINE_FUNCTION', false );
$this->assertTrue( WC_TESTING_DEFINE_FUNCTION );
}
/**
* Tests wc_create_order() and wc_update_order() currency handling.
*
* @since 3.2.0
*/
public function test_wc_create_update_order_currency() {
$old_currency = get_woocommerce_currency();
$new_currency = 'BGN';
update_option( 'woocommerce_currency', $new_currency );
// New order should be created using shop currency.
$order = wc_create_order( array(
'status' => 'pending',
'customer_id' => 1,
'created_via' => 'unit tests',
'cart_hash' => '',
) );
$this->assertEquals( $new_currency, $order->get_currency() );
update_option( 'woocommerce_currency', $old_currency );
// Currency should not change when order is updated.
$order = wc_update_order( array(
'customer_id' => 2,
'order_id' => $order->get_id(),
) );
$this->assertEquals( $new_currency, $order->get_currency() );
$order = wc_update_order( array(
'customer_id' => 2,
) );
$this->assertInstanceOf( 'WP_Error', $order );
}
/**
* Test the wc_is_active_theme function.
*
* @return void
*/
public function test_wc_is_active_theme() {
$current_theme = get_template();
$this->assertTrue( wc_is_active_theme( $current_theme ) );
$this->assertFalse( wc_is_active_theme( 'somegiberish' ) );
$this->assertTrue( wc_is_active_theme( array( $current_theme, 'somegiberish' ) ) );
}
/**
* Test the wc_get_template function.
*
* @return void
*/
public function test_wc_get_template_part() {
$this->assertEmpty( wc_get_template_part( 'nothinghere' ) );
}
/**
* Test wc_get_image_size function.
*
* @return void
*/
public function test_wc_get_image_size() {
$this->assertArrayHasKey( 'width', wc_get_image_size( array( 100, 100, 1 ) ) );
$this->assertArrayHasKey( 'height', wc_get_image_size( 'shop_single' ) );
update_option( 'woocommerce_thumbnail_cropping', 'uncropped' );
$this->assertArrayHasKey( 'crop', wc_get_image_size( 'shop_thumbnail' ) );
update_option( 'woocommerce_thumbnail_cropping', 'custom' );
$this->assertArrayHasKey( 'crop', wc_get_image_size( 'shop_thumbnail' ) );
}
/**
* Test wc_enqueue_js and wc_print_js functions.
*
* @return void
*/
public function test_wc_enqueue_js_wc_print_js() {
$js = 'alert( "test" );';
ob_start();
wc_print_js();
$printed_js = ob_get_clean();
$this->assertNotContains( $js, $printed_js );
wc_enqueue_js( $js );
ob_start();
wc_print_js();
$printed_js = ob_get_clean();
$this->assertContains( $js, $printed_js );
}
/**
* Test wc_get_log_file_name function.
*
* @return void
*/
public function test_wc_get_log_file_name() {
$this->assertNotEmpty( wc_get_log_file_name( 'test' ) );
}
/**
* Test wc_get_page_children function.
*
* @return void
*/
public function test_wc_get_page_children() {
$page_id = wp_insert_post( array(
'post_title' => 'Parent Page',
'post_type' => 'page',
'post_name' => 'parent-page',
'post_status' => 'publish',
'post_author' => 1,
'menu_order' => 0,
) );
$child_page_id = wp_insert_post( array(
'post_parent' => $page_id,
'post_title' => 'Parent Page',
'post_type' => 'page',
'post_name' => 'parent-page',
'post_status' => 'publish',
'post_author' => 1,
'menu_order' => 0,
) );
$children = wc_get_page_children( $page_id );
$this->assertEquals( $child_page_id, $children[0] );
wp_delete_post( $page_id, true );
wp_delete_post( $child_page_id, true );
}
/**
* Test hash_equals function.
*
* @return void
*/
public function test_hash_equals() {
$this->assertTrue( hash_equals( 'abc', 'abc' ) ); // @codingStandardsIgnoreLine.
$this->assertFalse( hash_equals( 'abcd', 'abc' ) ); // @codingStandardsIgnoreLine.
}
/**
* Test wc_rand_hash function.
*
* @return void
*/
public function test_wc_rand_hash() {
$this->assertNotEquals( wc_rand_hash(), wc_rand_hash() );
}
/**
* Test wc_transaction_query function.
*/
public function test_wc_transaction_query() {
global $wpdb;
$wpdb->insert(
$wpdb->prefix . 'options',
array(
'option_name' => 'transaction_test',
'option_value' => '1',
),
array(
'%s',
'%s',
)
);
wc_transaction_query( 'start' );
$this->assertTrue( WC_USE_TRANSACTIONS );
$wpdb->update(
$wpdb->prefix . 'options',
array(
'option_value' => '0',
),
array(
'option_name' => 'transaction_test',
)
);
$col = $wpdb->get_col( "SElECT option_value FROM {$wpdb->prefix}options WHERE option_name = 'transaction_test'" );
$this->assertEquals( '0', $col[0] );
wc_transaction_query( 'rollback' );
$col = $wpdb->get_col( "SElECT option_value FROM {$wpdb->prefix}options WHERE option_name = 'transaction_test'" );
$this->assertEquals( '1', $col[0] );
wc_transaction_query( 'start' );
$wpdb->update(
$wpdb->prefix . 'options',
array(
'option_value' => '0',
),
array(
'option_name' => 'transaction_test',
)
);
wc_transaction_query( 'commit' );
$col = $wpdb->get_col( "SElECT option_value FROM {$wpdb->prefix}options WHERE option_name = 'transaction_test'" );
$this->assertEquals( '0', $col[0] );
$wpdb->delete(
$wpdb->prefix . 'options',
array(
'option_name' => 'transaction_test',
)
);
}
}
Reference in New Issue View Git Blame Copy Permalink