Skip to content

Commit

Permalink
Add tests for WP_Classic_To_Block_Menu_Converter class (#51410)
Browse files Browse the repository at this point in the history 
* Initial happy path

* Add test and code for invalid arguments

* Add more edge cases

* Add correct docblocks

* Ensure all asserts have message arg

* Please the PHPCS
  • Loading branch information
@getdave
getdave authored Jun 12, 2023
1 parent 6c0d523 commit 625b2de
Show file tree
Hide file tree
Showing 2 changed files with 227 additions and 0 deletions.
12 changes: 12 additions & 0 deletions lib/experimental/class-wp-classic-to-block-menu-converter.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,20 @@ class WP_Classic_To_Block_Menu_Converter {
* @return string the serialized and normalized parsed blocks.
*/
public static function convert( $menu ) {

if ( ! is_nav_menu( $menu ) ) {
return new WP_Error(
'invalid_menu',
__( 'The menu provided is not a valid menu.', 'gutenberg' )
);
}

$menu_items = wp_get_nav_menu_items( $menu->term_id, array( 'update_post_term_cache' => false ) );

if ( empty( $menu_items ) ) {
return array();
}

// Set up the $menu_item variables.
// Adds the class property classes for the current context, if applicable.
_wp_menu_item_classes_by_context( $menu_items );
Expand Down
215 changes: 215 additions & 0 deletions phpunit/class-wp-classic-to-block-menu-converter-test.php
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,215 @@
<?php
/**
* Tests WP_Classic_To_Block_Menu_Converter_Test
*
* @package WordPress
*/

/**
* Tests for the WP_Classic_To_Block_Menu_Converter_Test class.
*/
class WP_Classic_To_Block_Menu_Converter_Test extends WP_UnitTestCase {

/**
* @covers WP_Classic_To_Block_Menu_Converter::get_fallback
*/
public function test_class_exists() {
$this->assertTrue( class_exists( 'WP_Classic_To_Block_Menu_Converter' ) );
}

/**
* @covers WP_Classic_To_Block_Menu_Converter::convert
* @dataProvider provider_test_passing_non_menu_object_to_converter_returns_wp_error
*/
public function test_passing_non_menu_object_to_converter_returns_wp_error( $data ) {

$result = WP_Classic_To_Block_Menu_Converter::convert( $data );

$this->assertTrue( is_wp_error( $result ), 'Should be a WP_Error instance' );

$this->assertEquals( 'invalid_menu', $result->get_error_code(), 'Error code should indicate invalidity of menu argument.' );

$this->assertEquals( 'The menu provided is not a valid menu.', $result->get_error_message(), 'Error message should communicate invalidity of menu argument.' );
}

/**
* @covers WP_Classic_To_Block_Menu_Converter::convert
*/
public function provider_test_passing_non_menu_object_to_converter_returns_wp_error() {
return array(
array( 1 ),
array( -1 ),
array( '1' ),
array( 'not a menu object' ),
array( true ),
array( false ),
array( array() ),
array( new stdClass() ),
);
}

/**
* @covers WP_Classic_To_Block_Menu_Converter::convert
*/
public function test_can_convert_classic_menu_to_blocks() {

$menu_id = wp_create_nav_menu( 'Classic Menu' );

wp_update_nav_menu_item(
$menu_id,
0,
array(
'menu-item-title' => 'Classic Menu Item 1',
'menu-item-url' => '/classic-menu-item-1',
'menu-item-status' => 'publish',
)
);

$second_menu_item_id = wp_update_nav_menu_item(
$menu_id,
0,
array(
'menu-item-title' => 'Classic Menu Item 2',
'menu-item-url' => '/classic-menu-item-2',
'menu-item-status' => 'publish',
)
);

wp_update_nav_menu_item(
$menu_id,
0,
array(
'menu-item-title' => 'Nested Menu Item 1',
'menu-item-url' => '/nested-menu-item-1',
'menu-item-status' => 'publish',
'menu-item-parent-id' => $second_menu_item_id,
)
);

$classic_nav_menu = wp_get_nav_menu_object( $menu_id );

$blocks = WP_Classic_To_Block_Menu_Converter::convert( $classic_nav_menu );

$this->assertNotEmpty( $blocks );

$parsed_blocks = parse_blocks( $blocks );

$first_block = $parsed_blocks[0];
$second_block = $parsed_blocks[1];
$nested_block = $parsed_blocks[1]['innerBlocks'][0];

$this->assertEquals( 'core/navigation-link', $first_block['blockName'], 'First block name should be "core/navigation-link"' );

$this->assertEquals( 'Classic Menu Item 1', $first_block['attrs']['label'], 'First block label should match.' );

$this->assertEquals( '/classic-menu-item-1', $first_block['attrs']['url'], 'First block URL should match.' );

// Assert parent of nested menu item is a submenu block.
$this->assertEquals( 'core/navigation-submenu', $second_block['blockName'], 'Second block name should be "core/navigation-submenu"' );

$this->assertEquals( 'Classic Menu Item 2', $second_block['attrs']['label'], 'Second block label should match.' );

$this->assertEquals( '/classic-menu-item-2', $second_block['attrs']['url'], 'Second block URL should match.' );

$this->assertEquals( 'core/navigation-link', $nested_block['blockName'], 'Nested block name should be "core/navigation-link"' );

$this->assertEquals( 'Nested Menu Item 1', $nested_block['attrs']['label'], 'Nested block label should match.' );

$this->assertEquals( '/nested-menu-item-1', $nested_block['attrs']['url'], 'Nested block URL should match.' );

wp_delete_nav_menu( $menu_id );
}

/**
* @covers WP_Classic_To_Block_Menu_Converter::convert
*/
public function test_does_not_convert_menu_items_with_non_publish_status() {

$menu_id = wp_create_nav_menu( 'Classic Menu' );

wp_update_nav_menu_item(
$menu_id,
0,
array(
'menu-item-title' => 'Classic Menu Item 1',
'menu-item-url' => '/classic-menu-item-1',
'menu-item-status' => 'publish',
)
);

wp_update_nav_menu_item(
$menu_id,
0,
array(
'menu-item-status' => 'draft',
'menu-item-title' => 'Draft Menu Item',
'menu-item-url' => '/draft-menu-item',
)
);

wp_update_nav_menu_item(
$menu_id,
0,
array(
'menu-item-status' => 'private',
'menu-item-title' => 'Private Item',
'menu-item-url' => '/private-menu-item',
)
);

wp_update_nav_menu_item(
$menu_id,
0,
array(
'menu-item-status' => 'pending',
'menu-item-title' => 'Pending Menu Item',
'menu-item-url' => '/pending-menu-item',
)
);

wp_update_nav_menu_item(
$menu_id,
0,
array(
'menu-item-status' => 'future',
'menu-item-title' => 'Future Menu Item',
'menu-item-url' => '/future-menu-item',
)
);

$classic_nav_menu = wp_get_nav_menu_object( $menu_id );

$blocks = WP_Classic_To_Block_Menu_Converter::convert( $classic_nav_menu );

$this->assertNotEmpty( $blocks );

$parsed_blocks = parse_blocks( $blocks );

$this->assertCount( 1, $parsed_blocks, 'Should only be one block in the array.' );

$this->assertEquals( 'core/navigation-link', $parsed_blocks[0]['blockName'], 'First block name should be "core/navigation-link"' );

$this->assertEquals( 'Classic Menu Item 1', $parsed_blocks[0]['attrs']['label'], 'First block label should match.' );

$this->assertEquals( '/classic-menu-item-1', $parsed_blocks[0]['attrs']['url'], 'First block URL should match.' );

wp_delete_nav_menu( $menu_id );
}

/**
* @covers WP_Classic_To_Block_Menu_Converter::convert
*/
public function test_returns_empty_array_for_menus_with_no_items() {
$menu_id = wp_create_nav_menu( 'Empty Menu' );

$classic_nav_menu = wp_get_nav_menu_object( $menu_id );

$blocks = WP_Classic_To_Block_Menu_Converter::convert( $classic_nav_menu );

$this->assertEmpty( $blocks, 'Result should be empty.' );

$this->assertIsArray( $blocks, 'Result should be empty array.' );

wp_delete_nav_menu( $menu_id );
}
}

1 comment on commit 625b2de

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Flaky tests detected in 625b2de.
Some tests passed with failed attempts. The failures may not be related to this commit but are still reported for visibility. See the documentation for more information.

🔍 Workflow run URL: https://github.com/WordPress/gutenberg/actions/runs/5245415223
📝 Reported issues:

Please sign in to comment.