Automattic /
jetpack
Duplicate code is one of the most pungent code smells. A rule that is often used is to re-structure code once it is duplicated in three or more places.
Common duplication problems, and corresponding solutions are:
| 1 | <?php |
||
| 19 | class Test_Atomic_Admin_Menu extends WP_UnitTestCase { |
||
| 20 | |||
| 21 | /** |
||
| 22 | * Menu data fixture. |
||
| 23 | * |
||
| 24 | * @var array |
||
| 25 | */ |
||
| 26 | public static $menu_data; |
||
| 27 | |||
| 28 | /** |
||
| 29 | * Submenu data fixture. |
||
| 30 | * |
||
| 31 | * @var array |
||
| 32 | */ |
||
| 33 | public static $submenu_data; |
||
| 34 | |||
| 35 | /** |
||
| 36 | * Test domain. |
||
| 37 | * |
||
| 38 | * @var string |
||
| 39 | */ |
||
| 40 | public static $domain; |
||
| 41 | |||
| 42 | /** |
||
| 43 | * Whether this testsuite is run on WP.com. |
||
| 44 | * |
||
| 45 | * @var bool |
||
| 46 | */ |
||
| 47 | public static $is_wpcom; |
||
| 48 | |||
| 49 | /** |
||
| 50 | * Admin menu instance. |
||
| 51 | * |
||
| 52 | * @var Atomic_Admin_Menu |
||
| 53 | */ |
||
| 54 | public static $admin_menu; |
||
| 55 | |||
| 56 | /** |
||
| 57 | * Mock user ID. |
||
| 58 | * |
||
| 59 | * @var int |
||
| 60 | */ |
||
| 61 | private static $user_id = 0; |
||
| 62 | |||
| 63 | /** |
||
| 64 | * Create shared fixtures. |
||
| 65 | * |
||
| 66 | * @param WP_UnitTest_Factory $factory Fixture factory. |
||
| 67 | */ |
||
| 68 | public static function wpSetUpBeforeClass( $factory ) { |
||
| 69 | static::$domain = ( new Status() )->get_site_suffix(); |
||
| 70 | static::$user_id = $factory->user->create( array( 'role' => 'administrator' ) ); |
||
|
|
|||
| 71 | static::$menu_data = get_wpcom_menu_fixture(); |
||
| 72 | static::$submenu_data = get_submenu_fixture(); |
||
| 73 | add_filter( 'jetpack_active_modules', array( get_called_class(), 'mock_sso_module_enabled' ) ); |
||
| 74 | } |
||
| 75 | |||
| 76 | /** |
||
| 77 | * Remove mocked filters. |
||
| 78 | */ |
||
| 79 | public static function tearDownAfterClass() { |
||
| 80 | remove_filter( 'jetpack_active_modules', array( get_called_class(), 'mock_sso_module_enabled' ) ); |
||
| 81 | } |
||
| 82 | |||
| 83 | /** |
||
| 84 | * Set up data. |
||
| 85 | */ |
||
| 86 | public function setUp() { |
||
| 87 | parent::setUp(); |
||
| 88 | global $menu, $submenu; |
||
| 89 | |||
| 90 | // Initialize in setUp so it registers hooks for every test. |
||
| 91 | static::$admin_menu = Atomic_Admin_Menu::get_instance(); |
||
| 92 | |||
| 93 | $menu = static::$menu_data; |
||
| 94 | $submenu = static::$submenu_data; |
||
| 95 | |||
| 96 | wp_set_current_user( static::$user_id ); |
||
| 97 | } |
||
| 98 | |||
| 99 | /** |
||
| 100 | * Test get_instance. |
||
| 101 | * |
||
| 102 | * @covers ::get_instance |
||
| 103 | * @covers ::__construct |
||
| 104 | */ |
||
| 105 | View Code Duplication | public function test_get_instance() { |
|
| 106 | $instance = Atomic_Admin_Menu::get_instance(); |
||
| 107 | |||
| 108 | $this->assertInstanceOf( Atomic_Admin_Menu::class, $instance ); |
||
| 109 | $this->assertSame( $instance, static::$admin_menu ); |
||
| 110 | |||
| 111 | $this->assertSame( 99998, has_action( 'admin_menu', array( $instance, 'reregister_menu_items' ) ) ); |
||
| 112 | $this->assertSame( 11, has_action( 'admin_enqueue_scripts', array( $instance, 'enqueue_scripts' ) ) ); |
||
| 113 | } |
||
| 114 | |||
| 115 | /** |
||
| 116 | * Tests add_browse_sites_link. |
||
| 117 | * |
||
| 118 | * @covers ::add_browse_sites_link |
||
| 119 | */ |
||
| 120 | public function test_add_browse_sites_link() { |
||
| 121 | global $menu; |
||
| 122 | |||
| 123 | // No output when executed in single site mode. |
||
| 124 | static::$admin_menu->add_browse_sites_link(); |
||
| 125 | $this->assertArrayNotHasKey( 0, $menu ); |
||
| 126 | } |
||
| 127 | |||
| 128 | /** |
||
| 129 | * Tests add_browse_sites_link. |
||
| 130 | * |
||
| 131 | * @covers ::add_browse_sites_link |
||
| 132 | */ |
||
| 133 | public function test_add_browse_sites_link_multisite() { |
||
| 134 | if ( ! is_multisite() ) { |
||
| 135 | $this->markTestSkipped( 'Only used on multisite' ); |
||
| 136 | } |
||
| 137 | |||
| 138 | global $menu; |
||
| 139 | |||
| 140 | // No output when user has just one site. |
||
| 141 | static::$admin_menu->add_browse_sites_link(); |
||
| 142 | $this->assertArrayNotHasKey( 0, $menu ); |
||
| 143 | |||
| 144 | // Give user a second site. |
||
| 145 | update_user_option( static::$user_id, 'wpcom_site_count', 2 ); |
||
| 146 | |||
| 147 | static::$admin_menu->add_browse_sites_link(); |
||
| 148 | |||
| 149 | $browse_sites_menu_item = array( |
||
| 150 | 'Browse sites', |
||
| 151 | 'read', |
||
| 152 | 'https://wordpress.com/home', |
||
| 153 | 'site-switcher', |
||
| 154 | 'menu-top toplevel_page_https://wordpress.com/home', |
||
| 155 | 'toplevel_page_https://wordpress.com/home', |
||
| 156 | 'dashicons-arrow-left-alt2', |
||
| 157 | ); |
||
| 158 | $this->assertSame( $menu[0], $browse_sites_menu_item ); |
||
| 159 | |||
| 160 | delete_user_option( static::$user_id, 'wpcom_site_count' ); |
||
| 161 | } |
||
| 162 | |||
| 163 | /** |
||
| 164 | * Tests add_new_site_link. |
||
| 165 | * |
||
| 166 | * @covers ::add_new_site_link |
||
| 167 | */ |
||
| 168 | public function test_add_new_site_link() { |
||
| 169 | global $menu; |
||
| 170 | |||
| 171 | // Set jetpack user data. |
||
| 172 | update_user_option( static::$user_id, 'wpcom_site_count', 1 ); |
||
| 173 | |||
| 174 | static::$admin_menu->add_new_site_link(); |
||
| 175 | |||
| 176 | $new_site_menu_item = array( |
||
| 177 | 'Add New Site', |
||
| 178 | 'read', |
||
| 179 | 'https://wordpress.com/start?ref=calypso-sidebar', |
||
| 180 | 'Add New Site', |
||
| 181 | 'menu-top toplevel_page_https://wordpress.com/start?ref=calypso-sidebar', |
||
| 182 | 'toplevel_page_https://wordpress.com/start?ref=calypso-sidebar', |
||
| 183 | 'dashicons-plus-alt', |
||
| 184 | ); |
||
| 185 | $this->assertSame( array_pop( $menu ), $new_site_menu_item ); |
||
| 186 | |||
| 187 | delete_user_option( static::$user_id, 'wpcom_site_count' ); |
||
| 188 | } |
||
| 189 | |||
| 190 | /** |
||
| 191 | * Tests add_site_card_menu |
||
| 192 | * |
||
| 193 | * @covers ::add_site_card_menu |
||
| 194 | */ |
||
| 195 | public function test_add_site_card_menu() { |
||
| 196 | global $menu; |
||
| 197 | |||
| 198 | if ( ! function_exists( 'site_is_private' ) ) { |
||
| 199 | function site_is_private() { // phpcs:ignore |
||
| 202 | } |
||
| 203 | static::$admin_menu->add_site_card_menu(); |
||
| 204 | |||
| 205 | $home_url = home_url(); |
||
| 206 | $site_card_menu_item = array( |
||
| 222 | |||
| 223 | /** |
||
| 224 | * Tests set_site_card_menu_class |
||
| 225 | * |
||
| 226 | * @covers ::set_site_card_menu_class |
||
| 227 | */ |
||
| 228 | public function test_set_site_card_menu_class() { |
||
| 254 | |||
| 255 | /** |
||
| 256 | * Shim wpcomsh fallback site icon. |
||
| 257 | * |
||
| 258 | * @return string |
||
| 259 | */ |
||
| 260 | public function wpcomsh_site_icon_url() { |
||
| 263 | |||
| 264 | /** |
||
| 265 | * Custom site icon. |
||
| 266 | * |
||
| 267 | * @return string |
||
| 268 | */ |
||
| 269 | public function custom_site_icon_url() { |
||
| 272 | |||
| 273 | /** |
||
| 274 | * Tests add_posts_menu |
||
| 275 | * |
||
| 276 | * @covers ::add_posts_menu |
||
| 277 | */ |
||
| 278 | public function test_add_posts_menu() { |
||
| 286 | |||
| 287 | /** |
||
| 288 | * Tests add_page_menu |
||
| 289 | * |
||
| 290 | * @covers ::add_page_menu |
||
| 291 | */ |
||
| 292 | public function test_add_page_menu() { |
||
| 300 | |||
| 301 | /** |
||
| 302 | * Tests add_upgrades_menu |
||
| 303 | * |
||
| 304 | * @covers ::add_upgrades_menu |
||
| 305 | */ |
||
| 306 | View Code Duplication | public function test_add_upgrades_menu() { |
|
| 322 | |||
| 323 | /** |
||
| 324 | * Tests add_tools_menu |
||
| 325 | * |
||
| 326 | * @covers ::add_tools_menu |
||
| 327 | */ |
||
| 328 | public function test_add_tools_menu() { |
||
| 336 | |||
| 337 | /** |
||
| 338 | * Tests add_options_menu |
||
| 339 | * |
||
| 340 | * @covers ::add_options_menu |
||
| 341 | */ |
||
| 342 | public function test_add_options_menu() { |
||
| 356 | |||
| 357 | /** |
||
| 358 | * Tests add_plugins_menu |
||
| 359 | * |
||
| 360 | * @covers ::add_plugins_menu |
||
| 361 | */ |
||
| 362 | public function test_add_plugins_menu() { |
||
| 370 | |||
| 371 | /** |
||
| 372 | * Tests add_appearance_menu |
||
| 373 | * |
||
| 374 | * @covers ::add_appearance_menu |
||
| 375 | */ |
||
| 376 | public function test_add_appearance_menu() { |
||
| 393 | |||
| 394 | /** |
||
| 395 | * Tests add_users_menu |
||
| 396 | * |
||
| 397 | * @covers ::add_users_menu |
||
| 398 | */ |
||
| 399 | public function test_add_users_menu() { |
||
| 405 | |||
| 406 | /** |
||
| 407 | * Tests add_comments_menu |
||
| 408 | * |
||
| 409 | * @covers ::add_comments_menu |
||
| 410 | */ |
||
| 411 | public function test_add_comments_menu() { |
||
| 418 | |||
| 419 | /** |
||
| 420 | * Tests add_gutenberg_menus |
||
| 421 | * |
||
| 422 | * @covers ::add_gutenberg_menus |
||
| 423 | */ |
||
| 424 | public function test_add_gutenberg_menus() { |
||
| 431 | |||
| 432 | /** |
||
| 433 | * Tests that Calypso links are forced on API requests when SSO is disabled. |
||
| 434 | */ |
||
| 435 | public function test_calypso_menu_when_sso_disabled() { |
||
| 472 | |||
| 473 | /** |
||
| 474 | * Adds the SSO module to the list of active modules. |
||
| 475 | * |
||
| 476 | * @param array $modules List of active modules. |
||
| 477 | * |
||
| 478 | * @return array |
||
| 479 | */ |
||
| 480 | public static function mock_sso_module_enabled( $modules ) { |
||
| 484 | } |
||
| 485 |
Loading history...
Let’s assume you have a class which uses late-static binding:
The code above will run fine in your PHP runtime. However, if you now create a sub-class and call the
getSomeVariable()on that sub-class, you will receive a runtime error:In the case above, it makes sense to update
SomeClassto useselfinstead: