561 lines
16 KiB
PHP
561 lines
16 KiB
PHP
<?php
|
|
/**
|
|
* Tests for the WC_Query class.
|
|
*
|
|
* @package WooCommerce\Tests\Util
|
|
* @since 3.3.0
|
|
*/
|
|
|
|
/**
|
|
* WC_Query tests.
|
|
*/
|
|
class WC_Tests_WC_Query extends WC_Unit_Test_Case {
|
|
|
|
/**
|
|
* Test WC_Query gets initialized properly.
|
|
*/
|
|
public function test_instance() {
|
|
$this->assertInstanceOf( 'WC_Query', WC()->query );
|
|
}
|
|
|
|
/**
|
|
* Test the get_errors method.
|
|
*/
|
|
public function test_get_errors() {
|
|
$_GET['wc_error'] = 'test';
|
|
|
|
WC()->query->get_errors();
|
|
$this->assertTrue( wc_has_notice( 'test', 'error' ) );
|
|
|
|
// Clean up.
|
|
// phpcs:disable WordPress.Security.NonceVerification.Recommended
|
|
unset( $_GET['wc_error'] );
|
|
wc_clear_notices();
|
|
|
|
WC()->query->get_errors();
|
|
$this->assertFalse( wc_has_notice( 'test', 'error' ) );
|
|
|
|
}
|
|
|
|
/**
|
|
* Test the init_query_vars and get_query_vars methods.
|
|
*/
|
|
public function test_init_query_vars_get_query_vars() {
|
|
// Test the default options are present.
|
|
WC()->query->init_query_vars();
|
|
$default_vars = WC()->query->get_query_vars();
|
|
$expected = array(
|
|
'order-pay' => 'order-pay',
|
|
'order-received' => 'order-received',
|
|
'orders' => 'orders',
|
|
'view-order' => 'view-order',
|
|
'downloads' => 'downloads',
|
|
'edit-account' => 'edit-account',
|
|
'edit-address' => 'edit-address',
|
|
'payment-methods' => 'payment-methods',
|
|
'lost-password' => 'lost-password',
|
|
'customer-logout' => 'customer-logout',
|
|
'add-payment-method' => 'add-payment-method',
|
|
'delete-payment-method' => 'delete-payment-method',
|
|
'set-default-payment-method' => 'set-default-payment-method',
|
|
);
|
|
$this->assertEquals( $expected, $default_vars );
|
|
|
|
// Test updating a setting works.
|
|
update_option( 'woocommerce_checkout_pay_endpoint', 'order-pay-new' );
|
|
WC()->query->init_query_vars();
|
|
$updated_vars = WC()->query->get_query_vars();
|
|
$this->assertEquals( 'order-pay-new', $updated_vars['order-pay'] );
|
|
}
|
|
|
|
/**
|
|
* Test the get_endpoint_title method.
|
|
*/
|
|
public function test_get_endpoint_title() {
|
|
$endpoints = array(
|
|
'order-pay',
|
|
'order-received',
|
|
'orders',
|
|
'downloads',
|
|
'edit-account',
|
|
'edit-address',
|
|
'payment-methods',
|
|
'add-payment-method',
|
|
'lost-password',
|
|
);
|
|
|
|
foreach ( $endpoints as $endpoint ) {
|
|
$this->assertNotEquals( '', WC()->query->get_endpoint_title( $endpoint ) );
|
|
}
|
|
|
|
$this->assertEquals( '', WC()->query->get_endpoint_title( 'not-real-endpoint' ) );
|
|
}
|
|
|
|
/**
|
|
* Test the get_endpoint_mask method.
|
|
*/
|
|
public function test_get_endpoint_mask() {
|
|
$this->assertEquals( EP_PAGES, WC()->query->get_endpoints_mask() );
|
|
|
|
update_option( 'show_on_front', 'page' );
|
|
update_option( 'page_on_front', 999 );
|
|
update_option( 'woocommerce_checkout_page_id', 999 );
|
|
$this->assertEquals( EP_ROOT | EP_PAGES, WC()->query->get_endpoints_mask() );
|
|
}
|
|
|
|
/**
|
|
* Test the add_query_vars method.
|
|
*/
|
|
public function test_add_query_vars() {
|
|
WC()->query->init_query_vars();
|
|
|
|
$vars = array(
|
|
'test1',
|
|
'test2',
|
|
);
|
|
$added = WC()->query->add_query_vars( $vars );
|
|
|
|
$this->assertContains( 'test1', $added );
|
|
$this->assertContains( 'test2', $added );
|
|
$this->assertContains( 'order-pay', $added );
|
|
$this->assertContains( 'customer-logout', $added );
|
|
}
|
|
|
|
/**
|
|
* Test the get_current_endpoint method.
|
|
*/
|
|
public function test_get_current_endpoint() {
|
|
global $wp;
|
|
|
|
$this->assertEquals( '', WC()->query->get_current_endpoint() );
|
|
$wp->query_vars['order-pay'] = 'order-pay';
|
|
$this->assertEquals( 'order-pay', WC()->query->get_current_endpoint() );
|
|
}
|
|
|
|
/**
|
|
* Test the parse_request method.
|
|
*/
|
|
public function test_parse_request() {
|
|
global $wp;
|
|
|
|
// Test with $_GET.
|
|
WC()->query->init_query_vars();
|
|
$_GET['order-pay'] = 'order-pay';
|
|
WC()->query->parse_request();
|
|
$this->assertEquals( 'order-pay', $wp->query_vars['order-pay'] );
|
|
unset( $_GET['order-pay'] );
|
|
|
|
// Test with query var.
|
|
update_option( 'woocommerce_checkout_pay_endpoint', 'order-pay-new' );
|
|
WC()->query->init_query_vars();
|
|
$wp->query_vars['order-pay-new'] = 'order-pay-new';
|
|
WC()->query->parse_request();
|
|
$this->assertEquals( 'order-pay-new', $wp->query_vars['order-pay'] );
|
|
}
|
|
|
|
/**
|
|
* Test the remove_product_query method.
|
|
*/
|
|
public function test_remove_product_query() {
|
|
$this->assertTrue( (bool) has_filter( 'pre_get_posts', array( WC()->query, 'pre_get_posts' ) ) );
|
|
|
|
WC()->query->remove_product_query();
|
|
|
|
$this->assertFalse( (bool) has_filter( 'pre_get_posts', array( WC()->query, 'pre_get_posts' ) ) );
|
|
}
|
|
|
|
/**
|
|
* Test the remove_ordering_args method.
|
|
*
|
|
* @group core-only
|
|
*/
|
|
public function test_remove_ordering_args() {
|
|
WC()->query->get_catalog_ordering_args( 'price', 'DESC' );
|
|
$this->assertTrue( (bool) has_filter( 'posts_clauses', array( WC()->query, 'order_by_price_desc_post_clauses' ) ) );
|
|
|
|
WC()->query->remove_ordering_args();
|
|
$this->assertFalse( (bool) has_filter( 'posts_clauses', array( WC()->query, 'order_by_price_desc_post_clauses' ) ) );
|
|
}
|
|
|
|
/**
|
|
* Test the get_catalog_ordering_args method.
|
|
*
|
|
* @group core-only
|
|
*/
|
|
public function test_get_catalog_ordering_args() {
|
|
// phpcs:disable WordPress.DB.SlowDBQuery
|
|
$data = array(
|
|
array(
|
|
'orderby' => 'menu_order',
|
|
'order' => 'ASC',
|
|
'expected' => array(
|
|
'orderby' => 'menu_order title',
|
|
'order' => 'ASC',
|
|
'meta_key' => '',
|
|
),
|
|
),
|
|
array(
|
|
'orderby' => 'title',
|
|
'order' => 'DESC',
|
|
'expected' => array(
|
|
'orderby' => 'title',
|
|
'order' => 'DESC',
|
|
'meta_key' => '',
|
|
),
|
|
),
|
|
array(
|
|
'orderby' => 'relevance',
|
|
'order' => 'ASC',
|
|
'expected' => array(
|
|
'orderby' => 'relevance',
|
|
'order' => 'DESC', // Relevance is always DESC order.
|
|
'meta_key' => '',
|
|
),
|
|
),
|
|
array(
|
|
'orderby' => 'rand',
|
|
'order' => '',
|
|
'expected' => array(
|
|
'orderby' => 'rand',
|
|
'order' => 'ASC',
|
|
'meta_key' => '',
|
|
),
|
|
),
|
|
array(
|
|
'orderby' => 'date',
|
|
'order' => 'DESC',
|
|
'expected' => array(
|
|
'orderby' => 'date ID',
|
|
'order' => 'DESC',
|
|
'meta_key' => '',
|
|
),
|
|
),
|
|
array(
|
|
'orderby' => 'price',
|
|
'order' => 'ASC',
|
|
'expected' => array(
|
|
'orderby' => 'price',
|
|
'order' => 'ASC',
|
|
'meta_key' => '',
|
|
),
|
|
),
|
|
array(
|
|
'orderby' => 'price',
|
|
'order' => 'DESC',
|
|
'expected' => array(
|
|
'orderby' => 'price',
|
|
'order' => 'DESC',
|
|
'meta_key' => '',
|
|
),
|
|
),
|
|
array(
|
|
'orderby' => 'popularity',
|
|
'order' => 'DESC',
|
|
'expected' => array(
|
|
'orderby' => 'popularity',
|
|
'order' => 'DESC',
|
|
'meta_key' => '',
|
|
),
|
|
),
|
|
array(
|
|
'orderby' => 'rating',
|
|
'order' => 'ASC',
|
|
'expected' => array(
|
|
'orderby' => 'rating',
|
|
'order' => 'ASC',
|
|
'meta_key' => '',
|
|
),
|
|
),
|
|
array(
|
|
'orderby' => 'unknownkey',
|
|
'order' => 'ASC',
|
|
'expected' => array(
|
|
'orderby' => 'unknownkey',
|
|
'order' => 'ASC',
|
|
'meta_key' => '',
|
|
),
|
|
),
|
|
array(
|
|
'orderby' => 'date',
|
|
'order' => 'INVALIDORDER',
|
|
'expected' => array(
|
|
'orderby' => 'date ID',
|
|
'order' => 'DESC',
|
|
'meta_key' => '',
|
|
),
|
|
),
|
|
array(
|
|
'orderby' => array(
|
|
'price',
|
|
'date',
|
|
),
|
|
'order' => array(
|
|
'DESC',
|
|
),
|
|
'expected' => array(
|
|
'orderby' => 'price',
|
|
'order' => 'DESC',
|
|
'meta_key' => '',
|
|
),
|
|
),
|
|
);
|
|
// phpcs:enable WordPress.DB.SlowDBQuery
|
|
|
|
foreach ( $data as $test ) {
|
|
$result = WC()->query->get_catalog_ordering_args( $test['orderby'], $test['order'] );
|
|
$this->assertEquals( $test['expected'], $result );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Test the get_catalog_ordering_args method with $_GET param.
|
|
*/
|
|
public function test_get_catalog_ordering_args_GET() {
|
|
$_GET['orderby'] = 'price-desc';
|
|
|
|
// phpcs:disable WordPress.DB.SlowDBQuery
|
|
$expected = array(
|
|
'orderby' => 'price',
|
|
'order' => 'DESC',
|
|
'meta_key' => '',
|
|
);
|
|
// phpcs:enable WordPress.DB.SlowDBQuery
|
|
|
|
$this->assertEquals( $expected, WC()->query->get_catalog_ordering_args() );
|
|
|
|
unset( $_GET['orderby'] );
|
|
}
|
|
|
|
/**
|
|
* Test the get_main_query method.
|
|
*/
|
|
public function test_get_main_query() {
|
|
WC()->query->product_query( new WP_Query() );
|
|
$this->assertInstanceOf( 'WP_Query', WC_Query::get_main_query() );
|
|
}
|
|
|
|
/**
|
|
* Test the get_main_tax_query method.
|
|
*/
|
|
public function test_get_main_tax_query() {
|
|
$tax_query = array(
|
|
'taxonomy' => 'product_tag',
|
|
'field' => 'slug',
|
|
'terms' => array( 'test' ),
|
|
'operator' => 'IN',
|
|
'include_children' => true,
|
|
);
|
|
|
|
// phpcs:disable WordPress.DB.SlowDBQuery
|
|
$query_args = array(
|
|
'tax_query' => array( $tax_query ),
|
|
);
|
|
// phpcs:enable WordPress.DB.SlowDBQuery
|
|
|
|
WC()->query->product_query( new WP_Query( $query_args ) );
|
|
$tax_queries = WC_Query::get_main_tax_query();
|
|
$this->assertContains( $tax_query, $tax_queries );
|
|
}
|
|
|
|
/**
|
|
* Test the get_main_meta_query method.
|
|
*/
|
|
public function test_get_main_meta_query() {
|
|
$meta_query = array(
|
|
'key' => '_stock',
|
|
'value' => 10,
|
|
'compare' => '=',
|
|
);
|
|
|
|
// phpcs:disable WordPress.DB.SlowDBQuery
|
|
$query_args = array(
|
|
'meta_query' => array( $meta_query ),
|
|
);
|
|
// phpcs:enable WordPress.DB.SlowDBQuery
|
|
|
|
WC()->query->product_query( new WP_Query( $query_args ) );
|
|
$meta_queries = WC_Query::get_main_meta_query();
|
|
$this->assertContains( $meta_query, $meta_queries );
|
|
}
|
|
|
|
/**
|
|
* Test the remove_add_to_cart_pagination method.
|
|
*/
|
|
public function test_remove_add_to_cart_pagination() {
|
|
$url = 'http://example.com/shop/page/2/?add-to-cart=1';
|
|
$this->assertEquals( 'http://example.com/shop/page/2/', WC()->query->remove_add_to_cart_pagination( $url ) );
|
|
}
|
|
|
|
/**
|
|
* Tests that the rating order by clause works correctly with different rating counts.
|
|
*/
|
|
public function test_catalog_order_by_rating() {
|
|
$worst_product = WC_Helper_Product::create_simple_product();
|
|
$worst_product->set_average_rating( 1 );
|
|
$worst_product->set_rating_counts( array( 1 => 5 ) );
|
|
$worst_product->save();
|
|
$no_reviews = WC_Helper_Product::create_simple_product();
|
|
$no_reviews->set_average_rating( 0 );
|
|
$no_reviews->set_rating_counts( array() );
|
|
$no_reviews->save();
|
|
$two_positive = WC_Helper_Product::create_simple_product();
|
|
$two_positive->set_average_rating( 5 );
|
|
$two_positive->set_rating_counts( array( 5 => 2 ) );
|
|
$two_positive->save();
|
|
$one_positive = WC_Helper_Product::create_simple_product();
|
|
$one_positive->set_average_rating( 5 );
|
|
$one_positive->set_rating_counts( array( 5 => 1 ) );
|
|
$one_positive->save();
|
|
$top_product = WC_Helper_Product::create_simple_product();
|
|
$top_product->set_average_rating( 5 );
|
|
$top_product->set_rating_counts( array( 5 => 3 ) );
|
|
$top_product->save();
|
|
|
|
$query = new WP_Query(
|
|
array_merge(
|
|
array(
|
|
'fields' => 'ids',
|
|
'post_type' => 'product',
|
|
'post_status' => 'publish',
|
|
'orderby' => 'rating',
|
|
'order' => 'DESC',
|
|
),
|
|
WC()->query->get_catalog_ordering_args( 'rating' )
|
|
)
|
|
);
|
|
|
|
$this->assertEquals(
|
|
array(
|
|
$top_product->get_id(),
|
|
$two_positive->get_id(),
|
|
$one_positive->get_id(),
|
|
$worst_product->get_id(),
|
|
$no_reviews->get_id(),
|
|
),
|
|
wp_parse_id_list( $query->posts )
|
|
);
|
|
|
|
WC()->query->remove_ordering_args();
|
|
}
|
|
|
|
/**
|
|
* Setup for a test for adjust_posts.
|
|
*
|
|
* @param bool $with_nav_filtering_data Should WC_Query::get_layered_nav_chosen_attributes return filtering data?.
|
|
* @param bool $use_objects If true, get_current_posts will return objects with an ID property; if false, it will returns the ids.
|
|
* @param string $post_type The value of the 'post_type' property for the objects generated when $use_objects is true.
|
|
*
|
|
* @return array An array where the first element is the instance of WC_Query, and the second is an array of sample products created.
|
|
*/
|
|
private function setup_adjust_posts_test( $with_nav_filtering_data, $use_objects, $post_type = 'product' ) {
|
|
update_option( 'woocommerce_hide_out_of_stock_items', 'yes' );
|
|
|
|
if ( $with_nav_filtering_data ) {
|
|
$nav_filtering_data = array( 'pa_something' => array( 'terms' => array( 'foo', 'bar' ) ) );
|
|
} else {
|
|
$nav_filtering_data = array();
|
|
}
|
|
|
|
$products = array();
|
|
$posts = array();
|
|
for ( $i = 0; $i < 5; $i++ ) {
|
|
$product = WC_Helper_Product::create_simple_product();
|
|
array_push( $products, $product );
|
|
$post = $use_objects ? (object) array(
|
|
'ID' => $product->get_id(),
|
|
'post_type' => $post_type,
|
|
) : $product->get_id();
|
|
array_push( $posts, $post );
|
|
}
|
|
|
|
$products[0]->set_stock_status( 'outofstock' );
|
|
|
|
$sut = $this
|
|
->getMockBuilder( WC_Query::class )
|
|
->setMethods( array( 'get_current_posts', 'get_layered_nav_chosen_attributes_inst' ) )
|
|
->getMock();
|
|
|
|
$sut->method( 'get_current_posts' )->willReturn( $posts );
|
|
$sut->method( 'get_layered_nav_chosen_attributes_inst' )->willReturn( $nav_filtering_data );
|
|
|
|
return array( $sut, $products );
|
|
}
|
|
|
|
/**
|
|
* @param bool $with_nav_filtering_data Should WC_Query::get_layered_nav_chosen_attributes return filtering data?.
|
|
* @param bool $use_objects If true, get_current_posts will return objects with an ID property; if false, it will returns the ids.
|
|
*
|
|
* @testdox adjust_posts should return the number of visible products and create product visibility loop variables
|
|
* @testWith [true, true]
|
|
* [false, false]
|
|
* [true, false]
|
|
* [false, true]
|
|
*/
|
|
public function test_adjust_posts_count_with_nav_filtering_attributes( $with_nav_filtering_data, $use_objects ) {
|
|
global $wp_query;
|
|
|
|
list($sut, $products) = $this->setup_adjust_posts_test( $with_nav_filtering_data, $use_objects );
|
|
|
|
$products[0]->set_stock_status( 'outofstock' );
|
|
$products[0]->save();
|
|
$products[1]->set_stock_status( 'outofstock' );
|
|
$products[1]->save();
|
|
|
|
$wp_query->set( 'wc_query', 'product_query' );
|
|
$this->assertEquals( 32, $sut->adjust_posts_count( 34, $wp_query ) );
|
|
$this->assertEquals( 32, wc_get_loop_prop( 'total' ) );
|
|
$this->assertEquals( false, wc_get_loop_product_visibility( $products[0]->get_id() ) );
|
|
$this->assertEquals( false, wc_get_loop_product_visibility( $products[1]->get_id() ) );
|
|
foreach ( array_slice( $products, 2 ) as $product ) {
|
|
$this->assertEquals( true, wc_get_loop_product_visibility( $product->get_id() ) );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @testdox adjust_posts should return the input unmodified if get_current_posts returns null.
|
|
*/
|
|
public function test_adjust_posts_count_when_there_are_no_posts() {
|
|
global $wp_query;
|
|
|
|
$sut = $this
|
|
->getMockBuilder( WC_Query::class )
|
|
->setMethods( array( 'get_current_posts', 'get_layered_nav_chosen_attributes_inst' ) )
|
|
->getMock();
|
|
|
|
$sut->method( 'get_current_posts' )->willReturn( null );
|
|
|
|
$wp_query->set( 'wc_query', 'product_query' );
|
|
$this->assertEquals( 34, $sut->adjust_posts_count( 34, $wp_query ) );
|
|
}
|
|
|
|
/**
|
|
* @testdox adjust_posts should return the input unmodified if the posts do not represent products.
|
|
*/
|
|
public function test_adjust_posts_count_when_the_posts_are_not_products() {
|
|
global $wp_query;
|
|
|
|
list( $sut, $products ) = $this->setup_adjust_posts_test( true, true, 'page' );
|
|
|
|
$products[0]->set_stock_status( 'outofstock' );
|
|
$products[0]->save();
|
|
|
|
$wp_query->set( 'wc_query', 'product_query' );
|
|
$this->assertEquals( 34, $sut->adjust_posts_count( 34, $wp_query ) );
|
|
}
|
|
|
|
/**
|
|
* @testdox adjust_posts should return the input unmodified if not in the main product query.
|
|
*/
|
|
public function test_adjust_posts_count_when_not_in_the_main_product_query() {
|
|
global $wp_query;
|
|
|
|
list( $sut, $products ) = $this->setup_adjust_posts_test( true, true );
|
|
|
|
$products[0]->set_stock_status( 'outofstock' );
|
|
$products[0]->save();
|
|
|
|
$wp_query->set( 'wc_query', null );
|
|
$this->assertEquals( 34, $sut->adjust_posts_count( 34, $wp_query ) );
|
|
}
|
|
}
|