Test_Plugins_Handler

Complexity

Total Complexity

9

Size/Duplication

Total Lines	218
Duplicated Lines	10.09 %

Coupling/Cohesion

Components	1
Dependencies	1

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	test_gets_active_plugins()	0	26	1
A	test_gets_active_plugins_when_multisite()	0	35	1
A	test_gets_active_plugins_records_unknown_plugins()	0	24	1
A	test_gets_active_plugins_ignores_unknown_plugins_when_including_latest()	0	22	1
A	test_gets_cached_plugins()	12	12	1
A	test_updates_cache_writes_plugins()	10	10	1
A	test_detects_when_plugins_change()	0	13	1
A	set_up()	0	9	1
A	tear_down()	0	3	1

<?php // phpcs:ignore WordPress.Files.FileName

/**
 * Plugins handler test suite.
 *
 * @package automattic/jetpack-autoloader
 */

use PHPUnit\Framework\TestCase;

/**
 * Test suite class for the autoloader's plugin handler.
 *
 * @runTestsInSeparateProcesses Ensure that each test has no previously autoloaded files.
 * @preserveGlobalState disabled
 */
class Test_Plugins_Handler extends TestCase {

	/**
	 * A dependency mock for the handler.
	 *
	 * @var Plugin_Locator|\PHPUnit\Framework\MockObject\MockObject
	 */
	private $plugin_locator;

	/**
	 * A dependency mock for the handler.
	 *
	 * @var Path_Processor|\PHPUnit\Framework\MockObject\MockObject
	 */
	private $path_processor;

	/**
	 * The class under test.
	 *
	 * @var Plugins_Handler
	 */
	private $plugins_handler;

	/**
	 * Setup runs before each test.
	 *
	 * @before
	 */
	public function set_up() {
		$this->plugin_locator  = $this->getMockBuilder( Plugin_Locator::class )
			->disableOriginalConstructor()
			->getMock();
		$this->path_processor  = $this->getMockBuilder( Path_Processor::class )
			->disableOriginalConstructor()
			->getMock();
		$this->plugins_handler = new Plugins_Handler( $this->plugin_locator, $this->path_processor );
	}

	/**
	 * Teardown runs after each test.
	 *
	 * @after
	 */
	public function tear_down() {
		cleanup_test_wordpress_data();
	}

	/**
	 * Tests that all active plugins are found.
	 */
	public function test_gets_active_plugins() {
		global $jetpack_autoloader_activating_plugins_paths;
		$jetpack_autoloader_activating_plugins_paths = array( TEST_DATA_PATH . '/plugins/plugin_activating' );
		$this->plugin_locator->expects( $this->once() )

The method expects() does not seem to exist on object<Plugin_Locator>.

			->method( 'find_using_option' )
			->with( 'active_plugins', false )
			->willReturn( array( TEST_DATA_PATH . '/plugins/dummy_current' ) );
		$this->plugin_locator->expects( $this->once() )

The method expects() does not seem to exist on object<Plugin_Locator>.

			->method( 'find_activating_this_request' )
			->willReturn( array( TEST_DATA_PATH . '/plugins/dummy_dev' ) );
		$this->plugin_locator->expects( $this->once() )

The method expects() does not seem to exist on object<Plugin_Locator>.

			->method( 'find_current_plugin' )
			->willReturn( TEST_DATA_PATH . '/plugins/dummy_newer' );

		$plugin_paths = $this->plugins_handler->get_active_plugins();

		$this->assertEquals(
			array(
				TEST_DATA_PATH . '/plugins/plugin_activating',
				TEST_DATA_PATH . '/plugins/dummy_current',
				TEST_DATA_PATH . '/plugins/dummy_dev',
				TEST_DATA_PATH . '/plugins/dummy_newer',
			),
			$plugin_paths
		);
	}

	/**
	 * Tests that all active plugins are found when the site is multisite.
	 */
	public function test_gets_active_plugins_when_multisite() {
		set_test_is_multisite( true );

		global $jetpack_autoloader_activating_plugins_paths;
		$jetpack_autoloader_activating_plugins_paths = array( TEST_DATA_PATH . '/plugins/plugin_activating' );
		$this->plugin_locator->expects( $this->exactly( 2 ) )

The method expects() does not seem to exist on object<Plugin_Locator>.

			->method( 'find_using_option' )
			->withConsecutive(
				array( 'active_plugins', false ),
				array( 'active_sitewide_plugins', true )
			)
			->willReturnOnConsecutiveCalls(
				array( TEST_DATA_PATH . '/plugins/dummy_current' ),
				array( TEST_DATA_PATH . '/plugins/dummy_newer' )
			);
		$this->plugin_locator->expects( $this->once() )

The method expects() does not seem to exist on object<Plugin_Locator>.

			->method( 'find_activating_this_request' )
			->willReturn( array( TEST_DATA_PATH . '/plugins/dummy_dev' ) );
		$this->plugin_locator->expects( $this->once() )

The method expects() does not seem to exist on object<Plugin_Locator>.

			->method( 'find_current_plugin' )
			->willReturn( TEST_DATA_PATH . '/plugins' );

		$plugin_paths = $this->plugins_handler->get_active_plugins();

		$this->assertEquals(
			array(
				TEST_DATA_PATH . '/plugins/plugin_activating',
				TEST_DATA_PATH . '/plugins/dummy_current',
				TEST_DATA_PATH . '/plugins/dummy_newer',
				TEST_DATA_PATH . '/plugins/dummy_dev',
				TEST_DATA_PATH . '/plugins',
			),
			$plugin_paths
		);
	}

	/**
	 * Tests that the current plugin is recorded as unknown when it isn't found as an active plugin.
	 */
	public function test_gets_active_plugins_records_unknown_plugins() {
		$this->plugin_locator->expects( $this->once() )

The method expects() does not seem to exist on object<Plugin_Locator>.

			->method( 'find_using_option' )
			->with( 'active_plugins', false )
			->willReturn( array() );
		$this->plugin_locator->expects( $this->once() )

The method expects() does not seem to exist on object<Plugin_Locator>.

			->method( 'find_activating_this_request' )
			->willReturn( array() );
		$this->plugin_locator->expects( $this->once() )

The method expects() does not seem to exist on object<Plugin_Locator>.

			->method( 'find_current_plugin' )
			->willReturn( TEST_DATA_PATH . '/plugins/dummy_newer' );

		$plugin_paths = $this->plugins_handler->get_active_plugins();

		$this->assertEquals(
			array(
				TEST_DATA_PATH . '/plugins/dummy_newer',
			),
			$plugin_paths
		);

		global $jetpack_autoloader_activating_plugins_paths;
		$this->assertContains( TEST_DATA_PATH . '/plugins/dummy_newer', $jetpack_autoloader_activating_plugins_paths );
	}

	/**
	 * Tests that the current plugin is ignored when it isn't an active plugin but the
	 * autoloader isn't being included from a plugin file.
	 */
	public function test_gets_active_plugins_ignores_unknown_plugins_when_including_latest() {
		global $jetpack_autoloader_including_latest;
		$jetpack_autoloader_including_latest = true;

		$this->plugin_locator->expects( $this->once() )

The method expects() does not seem to exist on object<Plugin_Locator>.

			->method( 'find_using_option' )
			->with( 'active_plugins', false )
			->willReturn( array() );
		$this->plugin_locator->expects( $this->once() )

The method expects() does not seem to exist on object<Plugin_Locator>.

			->method( 'find_activating_this_request' )
			->willReturn( array() );
		$this->plugin_locator->expects( $this->once() )

The method expects() does not seem to exist on object<Plugin_Locator>.

			->method( 'find_current_plugin' )
			->willReturn( TEST_DATA_PATH . '/plugins/dummy_newer' );

		$plugin_paths = $this->plugins_handler->get_active_plugins();

		$this->assertEmpty( $plugin_paths );

		global $jetpack_autoloader_activating_plugins_paths;
		$this->assertEmpty( $jetpack_autoloader_activating_plugins_paths );
	}

	/**
	 * Tests that the plugins in the cache are loaded.
	 */
	public function test_gets_cached_plugins() {
		set_transient( Plugins_Handler::TRANSIENT_KEY, array( '{{WP_PLUGIN_PATH}}/plugins/dummy_newer' ) );

		$this->path_processor->expects( $this->once() )

The method expects() does not seem to exist on object<Path_Processor>.

			->method( 'untokenize_path_constants' )
			->with( '{{WP_PLUGIN_PATH}}/plugins/dummy_newer' )
			->willReturn( TEST_DATA_PATH . '/plugins/dummy_newer' );

		$plugin_paths = $this->plugins_handler->get_cached_plugins();

		$this->assertEquals( array( TEST_DATA_PATH . '/plugins/dummy_newer' ), $plugin_paths );
	}

	/**
	 * Tests that the plugins are updated when they have changed.
	 */
	public function test_updates_cache_writes_plugins() {
		$this->path_processor->expects( $this->once() )

The method expects() does not seem to exist on object<Path_Processor>.

			->method( 'tokenize_path_constants' )
			->with( TEST_DATA_PATH . '/plugins/dummy_newer' )
			->willReturn( '{{WP_PLUGIN_PATH}}/plugins/dummy_newer' );

		$this->plugins_handler->cache_plugins( array( TEST_DATA_PATH . '/plugins/dummy_newer' ) );

		$this->assertEquals( array( '{{WP_PLUGIN_PATH}}/plugins/dummy_newer' ), get_transient( Plugins_Handler::TRANSIENT_KEY ) );
	}

	/**
	 * Tests that the handler indicate whether or not the plugins have changed from the global cached list.
	 */
	public function test_detects_when_plugins_change() {
		global $jetpack_autoloader_cached_plugin_paths;

		$plugins = array();
		$this->assertFalse( $this->plugins_handler->have_plugins_changed( $plugins ) );
		$this->assertSame( $plugins, $jetpack_autoloader_cached_plugin_paths );
		$this->assertFalse( $this->plugins_handler->have_plugins_changed( $plugins ) );

		$plugins = array( TEST_DATA_PATH . '/plugins/dummy_newer' );
		$this->assertTrue( $this->plugins_handler->have_plugins_changed( $plugins ) );
		$this->assertSame( $plugins, $jetpack_autoloader_cached_plugin_paths );
		$this->assertFalse( $this->plugins_handler->have_plugins_changed( $plugins ) );
	}
}