Test_WPcom_Admin_Menu

Complexity

Total Complexity

20

Size/Duplication

Total Lines	525
Duplicated Lines	31.43 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	wpSetUpBeforeClass()	7	7	1
A	setUp()	12	12	1
A	test_get_instance()	9	9	1
A	test_add_browse_sites_link()	0	29	2
A	test_add_new_site_link()	0	16	1
A	test_add_site_card_menu()	0	26	2
A	test_set_site_card_menu_class()	0	24	2
A	wpcomsh_site_icon_url()	0	3	1
A	custom_site_icon_url()	0	3	1
A	test_add_wpcom_upgrades_menu()	42	42	1
A	test_jetpack_parent_file()	9	9	1
A	test_add_plugins_menu()	0	30	2
A	mock_update_data()	0	11	1
B	test_add_users_menu()	0	81	1
B	test_add_tools_menu()	76	76	1
A	test_add_options_menu()	10	10	1

<?php
/**
 * Tests for WPcom_Admin_Menu class.
 *
 * @package Jetpack
 */

use Automattic\Jetpack\Dashboard_Customizations\WPcom_Admin_Menu;
use Automattic\Jetpack\Status;

require_jetpack_file( 'modules/masterbar/admin-menu/class-admin-menu.php' );
require_jetpack_file( 'modules/masterbar/admin-menu/class-wpcom-admin-menu.php' );
require_jetpack_file( 'tests/php/modules/masterbar/data/admin-menu.php' );

/**
 * Class Test_WPcom_Admin_Menu.
 *
 * @coversDefaultClass Automattic\Jetpack\Dashboard_Customizations\WPcom_Admin_Menu
 */
class Test_WPcom_Admin_Menu extends WP_UnitTestCase {

	/**
	 * Menu data fixture.
	 *
	 * @var array
	 */
	public static $menu_data;

	/**
	 * Submenu data fixture.
	 *
	 * @var array
	 */
	public static $submenu_data;

	/**
	 * Test domain.
	 *
	 * @var string
	 */
	public static $domain;

	/**
	 * Whether this testsuite is run on WP.com.
	 *
	 * @var bool
	 */
	public static $is_wpcom;

	/**
	 * Admin menu instance.
	 *
	 * @var WPcom_Admin_Menu
	 */
	public static $admin_menu;

	/**
	 * Mock user ID.
	 *
	 * @var int
	 */
	private static $user_id = 0;

	/**
	 * Create shared fixtures.
	 *
	 * @param WP_UnitTest_Factory $factory Fixture factory.
	 */
	public static function wpSetUpBeforeClass( $factory ) {
		static::$domain  = ( new Status() )->get_site_suffix();
		static::$user_id = $factory->user->create( array( 'role' => 'administrator' ) );

Since $user_id is declared private, accessing it with static will lead to errors in possible sub-classes; consider using self, or increasing the visibility of $user_id to at least protected.

		static::$menu_data    = get_menu_fixture();
		static::$submenu_data = get_submenu_fixture();
	}

	/**
	 * Set up data.
	 */
	public function setUp() {
		parent::setUp();
		global $menu, $submenu;

		// Initialize in setUp so it registers hooks for every test.
		static::$admin_menu = WPcom_Admin_Menu::get_instance();

		$menu    = static::$menu_data;
		$submenu = static::$submenu_data;

		wp_set_current_user( static::$user_id );

Since $user_id is declared private, accessing it with static will lead to errors in possible sub-classes; consider using self, or increasing the visibility of $user_id to at least protected.

	}

	/**
	 * Test get_instance.
	 *
	 * @covers ::get_instance
	 * @covers ::__construct
	 */
	public function test_get_instance() {
		$instance = WPcom_Admin_Menu::get_instance();

		$this->assertInstanceOf( WPcom_Admin_Menu::class, $instance );
		$this->assertSame( $instance, static::$admin_menu );

		$this->assertSame( 99999, has_action( 'admin_menu', array( $instance, 'reregister_menu_items' ) ) );
		$this->assertSame( 10, has_action( 'admin_enqueue_scripts', array( $instance, 'enqueue_scripts' ) ) );
	}

	/**
	 * Tests add_browse_sites_link.
	 *
	 * @covers ::add_browse_sites_link
	 */
	public function test_add_browse_sites_link() {
		if ( ! function_exists( 'add_user_to_blog' ) ) {
			$this->markTestSkipped( 'Only used on multisite' );
		}
		global $menu;

		// No output when user has just one site.
		static::$admin_menu->add_browse_sites_link();
		$this->assertArrayNotHasKey( 0, $menu );

		// Give user a second site.
		$blog_id = $this->factory->blog->create();
		add_user_to_blog( $blog_id, get_current_user_id(), 'editor' );

		static::$admin_menu->add_browse_sites_link();

		$browse_sites_menu_item = array(
			'Browse sites',
			'read',
			'https://wordpress.com/home',
			'site-switcher',
			'menu-top toplevel_page_https://wordpress.com/home',
			'toplevel_page_https://wordpress.com/home',
			'dashicons-arrow-left-alt2',
		);
		$this->assertSame( $menu[0], $browse_sites_menu_item );

		remove_user_from_blog( get_current_user_id(), $blog_id );
	}

	/**
	 * Tests add_new_site_link.
	 *
	 * @covers ::add_new_site_link
	 */
	public function test_add_new_site_link() {
		global $menu;

		static::$admin_menu->add_new_site_link();

		$new_site_menu_item = array(
			'Add new site',
			'read',
			'https://wordpress.com/start?ref=calypso-sidebar',
			'Add new site',
			'menu-top toplevel_page_https://wordpress.com/start?ref=calypso-sidebar',
			'toplevel_page_https://wordpress.com/start?ref=calypso-sidebar',
			'dashicons-plus-alt',
		);
		$this->assertSame( $menu[1002], $new_site_menu_item ); // 1001 is the separator position, 1002 is the link position
	}

	/**
	 * Tests add_site_card_menu
	 *
	 * @covers ::add_site_card_menu
	 */
	public function test_add_site_card_menu() {
		global $menu;

		if ( ! static::$is_wpcom ) {
			$this->markTestSkipped( 'Only used on WP.com.' );
		}

		static::$admin_menu->add_site_card_menu();

		$home_url            = home_url();
		$site_card_menu_item = array(
			// phpcs:ignore Squiz.Strings.DoubleQuoteUsage.NotRequired
			'
<div class="site__info">
	<div class="site__title">' . get_option( 'blogname' ) . '</div>
	<div class="site__domain">' . static::$domain . "</div>\n\t</div>",
			'read',
			$home_url,
			'site-card',
			'menu-top toplevel_page_' . $home_url,
			'toplevel_page_' . $home_url,
			'data:image/svg+xml,%3Csvg%20class%3D%22gridicon%22%20xmlns%3D%22http%3A%2F%2Fwww.w3.org%2F2000%2Fsvg%22%20viewBox%3D%220%200%2024%2024%22%3E%3Ctitle%3EGlobe%3C%2Ftitle%3E%3Crect%20fill-opacity%3D%220%22%20x%3D%220%22%20width%3D%2224%22%20height%3D%2224%22%2F%3E%3Cg%3E%3Cpath%20fill%3D%22%23fff%22%20d%3D%22M12%202C6.477%202%202%206.477%202%2012s4.477%2010%2010%2010%2010-4.477%2010-10S17.523%202%2012%202zm0%2018l2-2%201-1v-2h-2v-1l-1-1H9v3l2%202v1.93c-3.94-.494-7-3.858-7-7.93l1%201h2v-2h2l3-3V6h-2L9%205v-.41C9.927%204.21%2010.94%204%2012%204s2.073.212%203%20.59V6l-1%201v2l1%201%203.13-3.13c.752.897%201.304%201.964%201.606%203.13H18l-2%202v2l1%201h2l.286.286C18.03%2018.06%2015.24%2020%2012%2020z%22%2F%3E%3C%2Fg%3E%3C%2Fsvg%3E',
		);

		$this->assertEquals( $menu[1], $site_card_menu_item );
	}

	/**
	 * Tests set_site_card_menu_class
	 *
	 * @covers ::set_site_card_menu_class
	 */
	public function test_set_site_card_menu_class() {
		global $menu;

		if ( ! static::$is_wpcom ) {
			$this->markTestSkipped( 'Only used on WP.com.' );
		}

		static::$admin_menu->add_site_card_menu();

		$menu = static::$admin_menu->set_site_card_menu_class( $menu );
		$this->assertNotContains( 'has-site-icon', $menu[1][4] );

		// Atomic fallback site icon counts as no site icon.
		add_filter( 'get_site_icon_url', array( $this, 'wpcomsh_site_icon_url' ) );
		$menu = static::$admin_menu->set_site_card_menu_class( $menu );
		remove_filter( 'get_site_icon_url', array( $this, 'wpcomsh_site_icon_url' ) );
		$this->assertNotContains( 'has-site-icon', $menu[1][4] );

		// Custom site icon triggers CSS class.
		add_filter( 'get_site_icon_url', array( $this, 'custom_site_icon_url' ) );
		$menu = static::$admin_menu->set_site_card_menu_class( $menu );
		remove_filter( 'get_site_icon_url', array( $this, 'custom_site_icon_url' ) );
		$this->assertContains( 'has-site-icon', $menu[1][4] );
	}

	/**
	 * Shim wpcomsh fallback site icon.
	 *
	 * @return string
	 */
	public function wpcomsh_site_icon_url() {
		return 'https://s0.wp.com/i/webclip.png';
	}

	/**
	 * Custom site icon.
	 *
	 * @return string
	 */
	public function custom_site_icon_url() {
		return 'https://s0.wp.com/i/jetpack.png';
	}

	/**
	 * Tests add_upgrades_menu
	 *
	 * @covers ::add_upgrades_menu
	 */
	public function test_add_wpcom_upgrades_menu() {
		global $menu, $submenu;

		static::$admin_menu->add_upgrades_menu();

		$slug = 'https://wordpress.com/plans/' . static::$domain;

		$upgrades_menu_item = array(
			'Upgrades',
			'manage_options',
			$slug,
			'Upgrades',
			'menu-top toplevel_page_https://wordpress.com/plans/' . static::$domain,
			'toplevel_page_https://wordpress.com/plans/' . static::$domain,
			'dashicons-cart',
		);
		$this->assertSame( $menu['4.80608'], $upgrades_menu_item );

		$plans_submenu_item = array(
			'Plans',
			'manage_options',
			$slug,
			'Plans',
		);
		$this->assertContains( $plans_submenu_item, $submenu[ $slug ] );

		$domains_submenu_item = array(
			'Domains',
			'manage_options',
			'https://wordpress.com/domains/manage/' . static::$domain,
			'Domains',
		);
		$this->assertContains( $domains_submenu_item, $submenu[ $slug ] );

		$purchases_submenu_item = array(
			'Purchases',
			'manage_options',
			'https://wordpress.com/purchases/subscriptions/' . static::$domain,
			'Purchases',
		);
		$this->assertContains( $purchases_submenu_item, $submenu[ $slug ] );
	}

	/**
	 * Tests jetpack_parent_file
	 *
	 * @covers ::jetpack_parent_file
	 */
	public function test_jetpack_parent_file() {
		$parent_file = 'edit.php';
		$this->assertSame( $parent_file, static::$admin_menu->jetpack_parent_file( $parent_file ) );

		$this->assertSame(
			'https://wordpress.com/activity-log/' . static::$domain,
			static::$admin_menu->jetpack_parent_file( 'jetpack' )
		);
	}

	/**
	 * Tests add_plugins_menu
	 *
	 * @covers ::add_plugins_menu
	 */
	public function test_add_plugins_menu() {
		global $menu, $submenu;

		add_filter( 'wp_get_update_data', array( $this, 'mock_update_data' ) );
		static::$admin_menu->add_plugins_menu( static::$domain );

The call to WPcom_Admin_Menu::add_plugins_menu() has too many arguments starting with static::$domain.

		remove_filter( 'wp_get_update_data', array( $this, 'mock_update_data' ) );

		$slug  = 'https://wordpress.com/plugins/' . static::$domain;
		$label = is_multisite() ? 'Plugins ' : 'Plugins <span class="update-plugins count-0"><span class="plugin-count">0</span></span>';

		$plugins_menu_item = array(
			$label,
			'activate_plugins',
			$slug,
			'Plugins',
			'menu-top toplevel_page_' . $slug,
			'toplevel_page_' . $slug,
			'dashicons-admin-plugins',
		);

		$this->assertEquals( $plugins_menu_item, $menu[65] );
		$this->assertArrayNotHasKey( 'plugins.php', $submenu );

		$editor_submenu_item = array(
			'Plugin Editor',
			'edit_plugins',
			'plugin-editor.php',
		);
		$this->assertNotContains( $editor_submenu_item, $submenu[ $slug ] );
	}

	/**
	 * Filters the returned array of update data for plugins, themes, and WordPress core.
	 */
	public function mock_update_data() {
		return array(
			'counts' => array(
				'plugins'      => 0,
				'themes'       => 0,
				'translations' => 0,
				'wordpress'    => 0,
			),
			'title'  => '',
		);
	}

	/**
	 * Tests add_users_menu
	 *
	 * @covers ::add_users_menu
	 */
	public function test_add_users_menu() {
		global $menu, $submenu;

		// Current user can't list users.
		wp_set_current_user( $this->factory->user->create( array( 'role' => 'editor' ) ) );
		$menu = array();

		static::$admin_menu->add_users_menu( true );

		$profile_menu_item = array(
			'My Profile',
			'read',
			'https://wordpress.com/me',
			'My Profile',
			'menu-top toplevel_page_https://wordpress.com/me',
			'toplevel_page_https://wordpress.com/me',
			'dashicons-admin-users',
		);
		$this->assertSame( $menu[70], $profile_menu_item );

		$account_submenu_item = array(
			'Account Settings',
			'read',
			'https://wordpress.com/me/account',
			'Account Settings',
		);
		$this->assertContains( $account_submenu_item, $submenu['https://wordpress.com/me'] );
		$this->assertArrayNotHasKey( 'profile.php', $submenu );

		// Reset.
		wp_set_current_user( static::$user_id );

Since $user_id is declared private, accessing it with static will lead to errors in possible sub-classes; consider using self, or increasing the visibility of $user_id to at least protected.

		$menu = static::$menu_data;

		static::$admin_menu->add_users_menu( static::$domain );

static::$domain is of type string, but the function expects a boolean.

		$slug = 'https://wordpress.com/people/team/' . static::$domain;

		$users_menu_item = array(
			'Users',
			'list_users',
			$slug,
			'Users',
			'menu-top toplevel_page_' . $slug,
			'toplevel_page_' . $slug,
			'dashicons-admin-users',
		);
		$this->assertSame( $menu[70], $users_menu_item );
		$this->assertEmpty( $submenu['users.php'] );

		$all_people_submenu_item = array(
			'All People',
			'list_users',
			$slug,
			'All People',
		);
		$this->assertContains( $all_people_submenu_item, $submenu[ $slug ] );

		$add_new_submenu_item = array(
			'Add New',
			'promote_users',
			'https://wordpress.com/people/new/' . static::$domain,
			'Add New',
		);
		$this->assertContains( $add_new_submenu_item, $submenu[ $slug ] );

		$profile_submenu_item = array(
			'My Profile',
			'read',
			'https://wordpress.com/me',
			'My Profile',
		);
		$this->assertContains( $profile_submenu_item, $submenu[ $slug ] );

		$account_submenu_item = array(
			'Account Settings',
			'read',
			'https://wordpress.com/me/account',
			'Account Settings',
		);
		$this->assertContains( $account_submenu_item, $submenu[ $slug ] );
	}

	/**
	 * Tests add_tools_menu
	 *
	 * @covers ::add_tools_menu
	 */
	public function test_add_tools_menu() {
		global $menu, $submenu;

		$slug = 'https://wordpress.com/marketing/tools/' . static::$domain;
		static::$admin_menu->add_tools_menu( static::$domain );

static::$domain is of type string, but the function expects a boolean.

		$tools_menu_item = array(
			'Tools',
			'manage_options',
			$slug,
			'Tools',
			'menu-top toplevel_page_' . $slug,
			'toplevel_page_' . $slug,
			'dashicons-admin-tools',
		);

		$this->assertSame( $menu[75], $tools_menu_item );
		$this->assertArrayNotHasKey( 'tools.php', $submenu );

		// Contains the following menu items.

		$marketing_submenu_item = array(
			'Marketing',
			'manage_options',
			'https://wordpress.com/marketing/tools/' . static::$domain,
			'Marketing',
		);
		$this->assertContains( $marketing_submenu_item, $submenu[ $slug ] );

		$earn_submenu_item = array(
			'Earn',
			'manage_options',
			'https://wordpress.com/earn/' . static::$domain,
			'Earn',
		);
		$this->assertContains( $earn_submenu_item, $submenu[ $slug ] );

		$import_submenu_item = array(
			'Import',
			'import',
			'https://wordpress.com/import/' . static::$domain,
			'Import',
		);
		$this->assertContains( $import_submenu_item, $submenu[ $slug ] );

		$export_submenu_item = array(
			'Export',
			'export',
			'https://wordpress.com/export/' . static::$domain,
			'Export',
		);
		$this->assertContains( $export_submenu_item, $submenu[ $slug ] );

		// NOT contains the following menu items.

		$tools_submenu_item = array(
			'Available Tools',
			'edit_posts',
			'tools.php',
		);
		$this->assertNotContains( $tools_submenu_item, $submenu[ $slug ] );

		$import_submenu_item = array(
			'Import',
			'import',
			'import.php',
		);
		$this->assertNotContains( $import_submenu_item, $submenu[ $slug ] );

		$export_submenu_item = array(
			'Export',
			'export',
			'export.php',
		);
		$this->assertNotContains( $export_submenu_item, $submenu[ $slug ] );
	}

	/**
	 * Tests add_options_menu
	 *
	 * @covers ::add_options_menu
	 */
	public function test_add_options_menu() {
		global $submenu;

		static::$admin_menu->add_options_menu( static::$domain );

static::$domain is of type string, but the function expects a boolean.

		$this->assertNotContains( 'options-discussion.php', $submenu['options-general.php'] );
		$this->assertNotContains( 'options-writing.php', $submenu['options-general.php'] );

		$this->assertContains( 'Hosting Configuration', $submenu['options-general.php'][6] );
	}
}