Changeset 55903

Timestamp:

06/10/2023 05:28:02 AM (20 months ago)

Author:

audrasjb

Message:

Plugins: Display Auto-updates filters when the current view is "Must Use" or "Drop-in".

This changeset fixes a bug where the "Auto-updates Enabled/Disabled" filters were not showing when the current view is "Must Use" or "Drop-in".

Props NekoJonez, pbiron, costdev, audrasjb.
Fixes #54309.

Location:

trunk

Files:

• src/wp-admin/includes/class-wp-plugins-list-table.php (modified) (3 diffs)
• tests/phpunit/tests/admin/wpPluginsListTable.php (modified) (2 diffs)

trunk/src/wp-admin/includes/class-wp-plugins-list-table.php

@@ -62 +62 @@
         $this->show_autoupdates = wp_is_auto_update_enabled_for_type( 'plugin' )
             && current_user_can( 'update_plugins' )
-            && ( ! is_multisite() || $this->screen->in_admin( 'network' ) )
-            && ! in_array( $status, array( 'mustuse', 'dropins' ), true );
+            && ( ! is_multisite() || $this->screen->in_admin( 'network' ) );
     }
 
@@ -464 +463 @@
         );
 
-        if ( $this->show_autoupdates ) {
+        if ( $this->show_autoupdates && ! in_array( $status, array( 'mustuse', 'dropins' ), true ) ) {
             $columns['auto-updates'] = __( 'Automatic Updates' );
         }
@@ -1155 +1154 @@
                     break;
                 case 'auto-updates':
-                    if ( ! $this->show_autoupdates ) {
+                    if ( ! $this->show_autoupdates || in_array( $status, array( 'mustuse', 'dropins' ), true ) ) {
                         break;
                     }

trunk/tests/phpunit/tests/admin/wpPluginsListTable.php

@@ -11 +11 @@
      */
     public $table = false;
+
+    /**
+     * An admin user ID.
+     *
+     * @var int
+     */
+    private static $admin_id;
+
+    /**
+     * Creates an admin user before any tests run.
+     */
+    public static function set_up_before_class() {
+        parent::set_up_before_class();
+
+        self::$admin_id = self::factory()->user->create(
+            array(
+                'role'       => 'administrator',
+                'user_login' => 'test_wp_plugins_list_table',
+                'user_pass'  => 'password',
+                'user_email' => 'testadmin@test.com',
+            )
+        );
+    }
 
     public function set_up() {
@@ -57 +80 @@
         $this->assertSame( $expected, $actual );
     }
+
+    /**
+     * Tests that WP_Plugins_List_Table::__construct() does not set
+     * the 'show_autoupdates' property to false for Must-Use and Drop-in
+     * plugins.
+     *
+     * The 'ms-excluded' group is added as $this->show_autoupdates is already set to false for multisite.
+     *
+     * @ticket 54309
+     * @group ms-excluded
+     *
+     * @covers WP_Plugins_List_Table::__construct()
+     *
+     * @dataProvider data_status_mustuse_and_dropins
+     *
+     * @param string $status The value for $_REQUEST['plugin_status'].
+     */
+    public function test_construct_should_not_set_show_autoupdates_to_false_for_mustuse_and_dropins( $status ) {
+        $original_status           = isset( $_REQUEST['plugin_status'] ) ? $_REQUEST['plugin_status'] : null;
+        $_REQUEST['plugin_status'] = $status;
+
+        // Enable plugin auto-updates.
+        add_filter( 'plugins_auto_update_enabled', '__return_true' );
+
+        // Use a user with the 'manage_plugins' capability.
+        wp_set_current_user( self::$admin_id );
+
+        $list_table       = new WP_Plugins_List_Table();
+        $show_autoupdates = new ReflectionProperty( $list_table, 'show_autoupdates' );
+
+        $show_autoupdates->setAccessible( true );
+        $actual = $show_autoupdates->getValue( $list_table );
+        $show_autoupdates->setAccessible( false );
+
+        $_REQUEST['plugin_status'] = $original_status;
+
+        $this->assertTrue( $actual );
+    }
+
+    /**
+     * Tests that WP_Plugins_List_Table::get_columns() does not add
+     * the auto-update column when not viewing Must-Use or Drop-in plugins.
+     *
+     * @ticket 54309
+     *
+     * @covers WP_Plugins_List_Table::get_columns
+     *
+     * @dataProvider data_status_mustuse_and_dropins
+     *
+     * @param string $test_status The value for the global $status variable.
+     */
+    public function test_get_columns_should_not_add_the_autoupdates_column_when_viewing_mustuse_or_dropins( $test_status ) {
+        global $status;
+
+        $original_status = $status;
+
+        // Enable plugin auto-updates.
+        add_filter( 'plugins_auto_update_enabled', '__return_true' );
+
+        // Use a user with the 'manage_plugins' capability.
+        wp_set_current_user( self::$admin_id );
+
+        $status = $test_status;
+        $actual = $this->table->get_columns();
+        $status = $original_status;
+
+        $this->assertArrayNotHasKey( 'auto-updates', $actual );
+    }
+
+    /**
+     * Tests that WP_Plugins_List_Table::get_columns() does not add
+     * the auto-update column when the 'plugins_auto_update_enabled'
+     * filter returns false.
+     *
+     * @ticket 54309
+     *
+     * @covers WP_Plugins_List_Table::get_columns
+     */
+    public function test_get_columns_should_not_add_the_autoupdates_column_when_plugin_auto_update_is_disabled() {
+        global $status;
+
+        $original_status = $status;
+
+        // Enable plugin auto-updates.
+        add_filter( 'plugins_auto_update_enabled', '__return_false' );
+
+        // Use a user with the 'manage_plugins' capability.
+        wp_set_current_user( self::$admin_id );
+
+        $status = 'all';
+        $actual = $this->table->get_columns();
+        $status = $original_status;
+
+        $this->assertArrayNotHasKey( 'auto-updates', $actual );
+    }
+
+    /**
+     * Tests that WP_Plugins_List_Table::single_row() does not output the
+     * 'Auto-updates' column for Must-Use or Drop-in plugins.
+     *
+     * @ticket 54309
+     *
+     * @covers WP_Plugins_List_Table::single_row
+     *
+     * @dataProvider data_status_mustuse_and_dropins
+     *
+     * @param string $test_status The value for the global $status variable.
+     */
+    public function test_single_row_should_not_add_the_autoupdates_column_for_mustuse_or_dropins( $test_status ) {
+        global $status;
+
+        $original_status = $status;
+
+        // Enable plugin auto-updates.
+        add_filter( 'plugins_auto_update_enabled', '__return_true' );
+
+        // Use a user with the 'manage_plugins' capability.
+        wp_set_current_user( self::$admin_id );
+
+        $column_info = array(
+            array(
+                'name'         => 'Plugin',
+                'description'  => 'Description',
+                'auto-updates' => 'Auto-updates',
+            ),
+            array(),
+            array(),
+            'name',
+        );
+
+        // Mock WP_Plugins_List_Table
+        $list_table_mock = $this->getMockBuilder( 'WP_Plugins_List_Table' )
+            // Note: setMethods() is deprecated in PHPUnit 9, but still supported.
+            ->setMethods( array( 'get_column_info' ) )
+            ->getMock();
+
+        // Force the return value of the get_column_info() method.
+        $list_table_mock->expects( $this->once() )->method( 'get_column_info' )->willReturn( $column_info );
+
+        $single_row_args = array(
+            'advanced-cache.php',
+            array(
+                'Name'        => 'Advanced caching plugin',
+                'slug'        => 'advanced-cache',
+                'Description' => 'An advanced caching plugin.',
+                'Author'      => 'A plugin author',
+                'Version'     => '1.0.0',
+                'Author URI'  => 'http://example.org',
+                'Text Domain' => 'advanced-cache',
+            ),
+        );
+
+        $status = $test_status;
+        ob_start();
+        $list_table_mock->single_row( $single_row_args );
+        $actual = ob_get_clean();
+        $status = $original_status;
+
+        $this->assertIsString( $actual, 'Output was not captured.' );
+        $this->assertNotEmpty( $actual, 'The output string was empty.' );
+        $this->assertStringNotContainsString( 'column-auto-updates', $actual, 'The auto-updates column was output.' );
+    }
+
+    /**
+     * Data provider.
+     *
+     * @return array[]
+     */
+    public function data_status_mustuse_and_dropins() {
+        return array(
+            'Must-Use' => array( 'mustuse' ),
+            'Drop-ins' => array( 'dropins' ),
+        );
+    }
 }