Automattic\Jetpack\Test_Jetpack_JITM

Complexity

Total Complexity

25

Size/Duplication

Total Lines	225
Duplicated Lines	22.22 %

Coupling/Cohesion

Components	2
Dependencies	1

Importance

Changes

0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	setUp()	0	16	1
A	tearDown()	0	6	1
A	test_jitm_disabled_by_filter()	16	16	1
A	test_jitm_enabled_by_default()	16	16	1
A	test_prepare_jitms_enqueues_assets()	0	20	1
A	mock_site_url()	9	9	1
A	mock_filters()	0	17	3
A	clear_mock_filters()	0	4	1
A	mock_add_get_current_screen()	9	9	1
A	mock_add_action()	0	20	3
A	mock_do_action()	0	23	4
A	mock_wp_enqueue_script()	0	15	2
A	get_enqueued_script()	0	4	2
A	clear_added_actions()	0	4	1
A	clear_enqueued_scripts()	0	4	1
A	mock_empty_function()	0	9	1

<?php  // phpcs:disable

namespace Automattic\Jetpack;

use Automattic\Jetpack\JITMS\JITM;
use phpmock\functions\FunctionProvider;
use phpmock\Mock;
use phpmock\MockBuilder;
use PHPUnit\Framework\TestCase;

class Test_Jetpack_JITM extends TestCase {
	public function setUp() {
		$this->mock_add_get_current_screen();
		$this->mock_add_action();
		$this->mock_do_action();
		$this->mock_wp_enqueue_script();

		// input/output of these functions doesn't matter right now, they just need to exist
		$this->mock_empty_function( 'wp_register_style' );
		$this->mock_empty_function( 'plugins_url' );
		$this->mock_empty_function( 'wp_style_add_data' );
		$this->mock_empty_function( 'wp_enqueue_style' );
		$this->mock_empty_function( 'wp_localize_script' );
		$this->mock_empty_function( 'esc_url_raw' );
		$this->mock_empty_function( 'rest_url' );
		$this->mock_empty_function( 'esc_html__' );
	}

	public function tearDown() {
		Mock::disableAll();
		\Mockery::close();
		$this->clear_added_actions();
		$this->clear_enqueued_scripts();
	}

	public function test_jitm_disabled_by_filter() {
		$this->mock_filters( array(
			array( 'jetpack_just_in_time_msgs', false, false ),
		), "Automattic\Jetpack\JITMS" );

		// Used for Status->is_development_mode().
		$this->mock_filters( array(
			array( 'jetpack_just_in_time_msgs', false, false ),
		), "Automattic\Jetpack" );
		$this->mock_site_url();

		$jitm = new JITM();
		$this->assertFalse( $jitm->register() );

		$this->clear_mock_filters();
	}

	public function test_jitm_enabled_by_default() {
		$this->mock_filters( array(
			array( 'jetpack_just_in_time_msgs', false, true ),
		), "Automattic\Jetpack\JITMS" );

		// Used for Status->is_development_mode().
		$this->mock_filters( array(
			array( 'jetpack_just_in_time_msgs', false, true ),
		), "Automattic\Jetpack" );
		$this->mock_site_url();

		$jitm = new JITM();
		$this->assertTrue( $jitm->register() );

		$this->clear_mock_filters();
	}

	/**
	 * This is an example of a test which uses Mockery to tests a class static method.
	 *
	 * It requires the runInSeparateProcess tag so that the class isn't already autoloaded.
	 *
	 * @runInSeparateProcess
	 */
	public function test_prepare_jitms_enqueues_assets() {
		$mockAssets = \Mockery::mock('alias:Automattic\Jetpack\Assets');

		// mock the static method and return a dummy value
		$mockAssets
			->shouldReceive('get_file_url_for_environment')
			->andReturn('the_file_url');

		$jitm = new JITM();
		$screen = (object) array( 'id' => 'jetpack_foo' ); // fake screen object
		$jitm->prepare_jitms( $screen );

		// this should enqueue a jetpack-jitm-new script
		do_action( 'admin_enqueue_scripts' );

		// assert our script was enqueued with the right value
		$script = $this->get_enqueued_script( 'jetpack-jitm-new' );

		$this->assertEquals( 'the_file_url', $script['src'] );
	}

	/*
	public function test_prepare_jitms_does_not_show_on_some_screens() {
		$jitm = new JITM();
		$screen = new \stdClass();
		$screen->id = 'jetpack_page_stats';
		$jitm->prepare_jitms( $screen );
	}
	*/

	protected function mock_site_url() {
		$builder = new MockBuilder();
		$builder->setNamespace( "Automattic\Jetpack" )
			->setName( 'site_url' )
			->setFunction( function() {
				return "unit-test";
			} );
		$builder->build()->enable();
	}

	protected function mock_filters( $filters, $namespace ) {
		$this->mocked_filters = $filters;
		$builder = new MockBuilder();
		$builder->setNamespace( $namespace )
			->setName( 'apply_filters' )
			->setFunction(
				function( ...$current_args ) {
					foreach ( $this->mocked_filters as $filter ) {
						if ( array_slice( $filter, 0, -1 ) === $current_args ) {
							return array_pop( $filter );
						}
					}
				}
			);
		$this->apply_filters_mock = $builder->build();
		$this->apply_filters_mock->enable();
	}

	protected function clear_mock_filters() {
		$this->apply_filters_mock->disable();
		unset( $this->mocked_filters );
	}

	protected function mock_add_get_current_screen() {
		$builder = new MockBuilder();
		$builder->setNamespace( "Automattic\Jetpack\JITMS" )
			->setName( 'get_current_screen' )
			->setFunction( function() {
				return new \stdClass;
			} );
		$builder->build()->enable();
	}

	protected function mock_add_action() {
		$builder = new MockBuilder();
		$builder->setNamespace( "Automattic\Jetpack\JITMS" )
			->setName( 'add_action' )
			->setFunction( function( $name, $callable ) {
				global $actions;

				if ( is_null( $actions ) ) {
					$actions = array();
				}

				// don't worry about precedence for now
				if ( ! isset( $actions[$name] ) ) {
					$actions[$name] = array();
				}

				$actions[$name][] = $callable;
			} );
		$builder->build()->enable();
	}

	protected function mock_do_action() {
		$builder = new MockBuilder();
		$builder->setNamespace( __NAMESPACE__ )
			->setName( 'do_action' )
			->setFunction( function( ...$args ) {
				global $actions;
				$name = array_shift( $args );

				if ( is_null( $actions ) ) {
					$actions = array();
				}

				// don't worry about precedence for now
				if ( ! isset( $actions[$name] ) ) {
					$actions[$name] = array();
				}

				foreach( $actions[$name] as $callable ) {
					call_user_func_array( $callable, $args );
				}
			} );
		$builder->build()->enable();
	}

	protected function mock_wp_enqueue_script() {
		$builder = new MockBuilder();
		$builder->setNamespace( "Automattic\Jetpack\JITMS" )
			->setName( 'wp_enqueue_script' )
			->setFunction( function( $handle, $src = '', $deps = array(), $ver = false, $in_footer = false ) {
				global $wp_scripts;

				if ( is_null( $wp_scripts ) ) {
					$wp_scripts = array();
				}

				$wp_scripts[$handle] = compact( 'src', 'deps', 'ver', 'in_footer' );
			} );
		$builder->build()->enable();
	}

	protected function get_enqueued_script( $handle ) {
		global $wp_scripts;
		return isset( $wp_scripts[$handle] ) ? $wp_scripts[$handle] : null;
	}

	protected function clear_added_actions() {
		global $actions;
		$actions = array();
	}

	protected function clear_enqueued_scripts() {
		global $wp_scripts;
		$wp_scripts = array();
	}

	protected function mock_empty_function( $name ) {
		$builder = new MockBuilder();
		$builder->setNamespace( "Automattic\Jetpack\JITMS" )
			->setName( $name )
			->setFunction( function() use ( $name ) {
				// echo "Called $name with " . print_r( func_get_args(),1 ) . "\n";
			} );
		$builder->build()->enable();
	}
}