wordpress-develop/tests/phpunit/tests/ajax/CustomizeMenus.php
Helen Hou-Sandi 3fd1376418 Menu customizer: More clearly separate search results from available items.
Available items now fade from view while you're searching, and there is an explicit way to clear search results. No results gives a better message, though still brief this time around.

props valendesigns, designsimply, DH-Shredder, helen.
fixes #32710.


git-svn-id: https://develop.svn.wordpress.org/trunk@33511 602fd350-edb4-49c9-b593-d223f7449a82
2015-07-29 23:39:54 +00:00

539 lines
13 KiB
PHP

<?php
/**
* Testing ajax customize menus functionality
*
* @package WordPress
* @subpackage UnitTests
* @since 4.3.0
* @group ajax
* @runTestsInSeparateProcesses
*/
class Tests_Ajax_CustomizeMenus extends WP_Ajax_UnitTestCase {
/**
* Instance of WP_Customize_Manager which is reset for each test.
*
* @var WP_Customize_Manager
*/
public $wp_customize;
/**
* Set up the test fixture.
*/
public function setUp() {
parent::setUp();
require_once ABSPATH . WPINC . '/class-wp-customize-manager.php';
wp_set_current_user( $this->factory->user->create( array( 'role' => 'administrator' ) ) );
global $wp_customize;
$this->wp_customize = new WP_Customize_Manager();
$wp_customize = $this->wp_customize;
}
/**
* Tear down the test fixture.
*/
public function tearDown() {
wp_set_current_user( 0 );
parent::tearDown();
}
/**
* Helper to keep it DRY
*
* @param string $action Action.
*/
protected function make_ajax_call( $action ) {
// Make the request.
try {
$this->_handleAjax( $action );
} catch ( WPAjaxDieContinueException $e ) {
unset( $e );
}
}
/**
* Testing capabilities check for ajax_load_available_items method
*
* @dataProvider data_ajax_load_available_items_cap_check
*
* @param string $role The role we're checking caps against.
* @param array $expected_results Expected results.
*/
function test_ajax_load_available_items_cap_check( $role, $expected_results ) {
if ( 'administrator' != $role ) {
// If we're not an admin, we should get a wp_die(-1).
$this->setExpectedException( 'WPAjaxDieStopException' );
}
wp_set_current_user( $this->factory->user->create( array( 'role' => $role ) ) );
$_POST = array(
'action' => 'load-available-menu-items-customizer',
'customize-menus-nonce' => wp_create_nonce( 'customize-menus' ),
);
$this->make_ajax_call( 'load-available-menu-items-customizer' );
// If we are an admin, we should get a proper response.
if ( 'administrator' === $role ) {
// Get the results.
$response = json_decode( $this->_last_response, true );
$this->assertSame( $expected_results, $response );
}
}
/**
* Data provider for test_ajax_load_available_items_cap_check().
*
* Provides various post_args to induce error messages in the that can be
* compared to the expected_results.
*
* @since 4.3.0
*
* @return array {
* @type array {
* @string string $role The role that will test caps for.
* @array array $expected_results The expected results from the ajax call.
* }
* }
*/
function data_ajax_load_available_items_cap_check() {
return array(
array(
'subscriber',
array(),
),
array(
'contributor',
array(),
),
array(
'author',
array(),
),
array(
'editor',
array(),
),
array(
'administrator',
array(
'success' => false,
'data' => 'nav_menus_missing_type_or_object_parameter',
),
),
);
}
/**
* Testing the error messaging for ajax_load_available_items
*
* @dataProvider data_ajax_load_available_items_error_messages
*
* @param array $post_args POST args.
* @param mixed $expected_results Expected results.
*/
function test_ajax_load_available_items_error_messages( $post_args, $expected_results ) {
$_POST = array_merge( array(
'action' => 'load-available-menu-items-customizer',
'customize-menus-nonce' => wp_create_nonce( 'customize-menus' ),
), $post_args );
// Make the request.
$this->make_ajax_call( 'load-available-menu-items-customizer' );
// Get the results.
$response = json_decode( $this->_last_response, true );
$this->assertSame( $expected_results, $response );
}
/**
* Data provider for test_ajax_load_available_items_error_message().
*
* Provides various post_args to induce error messages in the that can be
* compared to the expected_results.
*
* @since 4.3.0
*
* @return array {
* @type array {
* @array array $post_args The arguments that will merged with the $_POST array.
* @array array $expected_results The expected results from the ajax call.
* }
* }
*/
function data_ajax_load_available_items_error_messages() {
return array(
// Testing empty obj_type and type.
array(
array(
'type' => '',
'object' => '',
),
array(
'success' => false,
'data' => 'nav_menus_missing_type_or_object_parameter',
),
),
// Testing empty obj_type.
array(
array(
'type' => '',
'object' => 'post',
),
array(
'success' => false,
'data' => 'nav_menus_missing_type_or_object_parameter',
),
),
// Testing empty type.
array(
array(
'type' => '',
'object' => 'post',
),
array(
'success' => false,
'data' => 'nav_menus_missing_type_or_object_parameter',
),
),
// Testing incorrect type option.
array(
array(
'type' => 'post_type',
'object' => 'invalid',
),
array(
'success' => false,
'data' => 'nav_menus_invalid_post_type',
),
),
);
}
/**
* Testing the success status.
*
* @dataProvider data_ajax_load_available_items_success_status
*
* @param array $post_args POST args.
* @param array $success_status Success status.
*/
function test_ajax_load_available_items_success_status( $post_args, $success_status ) {
$_POST = array_merge( array(
'action' => 'load-available-menu-items-customizer',
'customize-menus-nonce' => wp_create_nonce( 'customize-menus' ),
), $post_args );
// Make the request.
$this->make_ajax_call( 'load-available-menu-items-customizer' );
// Get the results.
$response = json_decode( $this->_last_response, true );
$this->assertSame( $success_status, $response['success'] );
}
/**
* Data provider for test_ajax_load_available_items_success_status().
*
* Provides various post_args to retrieve results and compare against
* the success status.
*
* @since 4.3.0
*
* @return array {
* @type array {
* @type array $post_args The arguments that will merged with the $_POST array.
* @type bool $success_status The expected success status.
* }
* }
*/
function data_ajax_load_available_items_success_status() {
return array(
array(
array(
'type' => 'post_type',
'object' => 'post',
),
true,
),
array(
array(
'type' => 'post_type',
'object' => 'page',
),
true,
),
array(
array(
'type' => 'post_type',
'object' => 'custom',
),
false,
),
array(
array(
'type' => 'taxonomy',
'object' => 'post_tag',
),
true,
),
);
}
/**
* Testing the array structure for a single item
*
* @dataProvider data_ajax_load_available_items_structure
*
* @param array $post_args POST args.
*/
function test2_ajax_load_available_items_structure( $post_args ) {
$expected_keys = array(
'id',
'title',
'type',
'type_label',
'object',
'object_id',
'url',
);
// Create some terms and pages.
$this->factory->term->create_many( 5 );
$this->factory->post->create_many( 5, array( 'post_type' => 'page' ) );
$_POST = array_merge( array(
'action' => 'load-available-menu-items-customizer',
'customize-menus-nonce' => wp_create_nonce( 'customize-menus' ),
), $post_args );
// Make the request.
$this->make_ajax_call( 'load-available-menu-items-customizer' );
// Get the results.
$response = json_decode( $this->_last_response, true );
$this->assertNotEmpty( $response['data']['items'] );
// Get the second index to avoid the home page edge case.
$test_item = $response['data']['items'][1];
foreach ( $expected_keys as $key ) {
$this->assertArrayHasKey( $key, $test_item );
$this->assertNotEmpty( $test_item[ $key ] );
}
// Special test for the home page.
if ( 'page' === $test_item['object'] ) {
$home = $response['data']['items'][0];
foreach ( $expected_keys as $key ) {
if ( 'object_id' !== $key ) {
$this->assertArrayHasKey( $key, $home );
if ( 'object' !== $key ) {
$this->assertNotEmpty( $home[ $key ] );
}
}
}
}
}
/**
* Data provider for test_ajax_load_available_items_structure().
*
* Provides various post_args to return a list of items to test the array structure of.
*
* @since 4.3.0
*
* @return array {
* @type array {
* @type array $post_args The arguments that will merged with the $_POST array.
* }
* }
*/
function data_ajax_load_available_items_structure() {
return array(
array(
array(
'type' => 'post_type',
'object' => 'post',
),
),
array(
array(
'type' => 'post_type',
'object' => 'page',
),
),
array(
array(
'type' => 'taxonomy',
'object' => 'post_tag',
),
),
);
}
/**
* Testing the error messages for ajax_search_available_items
*
* @dataProvider data_ajax_search_available_items_caps_check
*
* @param string $role Role.
* @param array $expected_results Expected results.
*/
function test_ajax_search_available_items_caps_check( $role, $expected_results ) {
if ( 'administrator' != $role ) {
// If we're not an admin, we should get a wp_die(-1).
$this->setExpectedException( 'WPAjaxDieStopException' );
}
wp_set_current_user( $this->factory->user->create( array( 'role' => $role ) ) );
$_POST = array(
'action' => 'search-available-menu-items-customizer',
'customize-menus-nonce' => wp_create_nonce( 'customize-menus' ),
);
$this->make_ajax_call( 'search-available-menu-items-customizer' );
// If we are an admin, we should get a proper response.
if ( 'administrator' === $role ) {
// Get the results.
$response = json_decode( $this->_last_response, true );
$this->assertSame( $expected_results, $response );
}
}
/**
* Data provider for test_ajax_search_available_items_caps_check().
*
* Provides various post_args to induce error messages in the that can be
* compared to the expected_results.
*
* @since 4.3.0
*
* @todo Make this more DRY
*
* @return array {
* @type array {
* @string string $role The role that will test caps for.
* @array array $expected_results The expected results from the ajax call.
* }
* }
*/
function data_ajax_search_available_items_caps_check() {
return array(
array(
'subscriber',
array(),
),
array(
'contributor',
array(),
),
array(
'author',
array(),
),
array(
'editor',
array(),
),
array(
'administrator',
array(
'success' => false,
'data' => 'nav_menus_missing_search_parameter',
),
),
);
}
/**
* Testing the results of various searches
*
* @dataProvider data_ajax_search_available_items_results
*
* @param array $post_args POST args.
* @param array $expected_results Expected results.
*/
function test_ajax_search_available_items_results( $post_args, $expected_results ) {
$this->factory->post->create_many( 5, array( 'post_title' => 'Test Post' ) );
$_POST = array_merge( array(
'action' => 'search-available-menu-items-customizer',
'customize-menus-nonce' => wp_create_nonce( 'customize-menus' ),
), $post_args );
$this->make_ajax_call( 'search-available-menu-items-customizer' );
$response = json_decode( $this->_last_response, true );
if ( isset( $post_args['search'] ) && 'test' === $post_args['search'] ) {
$this->assertsame( true, $response['success'] );
$this->assertSame( 5, count( $response['data']['items'] ) );
} else {
$this->assertSame( $expected_results, $response );
}
}
/**
* Data provider for test_ajax_search_available_items_results().
*
* Provides various post_args to test the results.
*
* @since 4.3.0
*
* @return array {
* @type array {
* @string string $post_args The args that will be passed to ajax.
* @array array $expected_results The expected results from the ajax call.
* }
* }
*/
function data_ajax_search_available_items_results() {
return array(
array(
array(),
array(
'success' => false,
'data' => 'nav_menus_missing_search_parameter',
),
),
array(
array(
'search' => 'all_the_things',
),
array(
'success' => false,
'data' => array(
'message' => 'No results found.',
),
),
),
array(
array(
'search' => 'test',
),
array(
'success' => true,
array(),
),
),
);
}
}