Test_Jetpack_JITM::mock_add_get_current_screen() - Code Metrics - Inspection of "Merge remote-tracking branch 'origin/master' into..." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — update/search-js-build ( 7b88d1...a19a37 )

unknown

created 2019-11-21 16:50 UTC

Test_Jetpack_JITM::mock_add_get_current_screen() A

↳ Parent: Test_Jetpack_JITM

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	9
Ratio	100 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	0
dl	9
loc	9
rs	9.9666
c	0
b	0
f	0

<?php

namespace Automattic\Jetpack;

use Automattic\Jetpack\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 ),
		) );

		$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 ),
		) );

		$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_filters( $filters ) {
		$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( __NAMESPACE__ )
			->setName( 'get_current_screen' )
			->setFunction( function() {
				return new \stdClass;
			} );
		$builder->build()->enable();
	}

	protected function mock_add_action() {
		$builder = new MockBuilder();
		$builder->setNamespace( __NAMESPACE__ )
			->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( __NAMESPACE__ )
			->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( __NAMESPACE__ )
			->setName( $name )
			->setFunction( function() use ( $name ) {
				// echo "Called $name with " . print_r( func_get_args(),1 ) . "\n";
			} );
		$builder->build()->enable();
	}
}


1		<?php
2
3		namespace Automattic\Jetpack;
4
5		use Automattic\Jetpack\JITM;
6		use phpmock\functions\FunctionProvider;
7		use phpmock\Mock;
8		use phpmock\MockBuilder;
9		use PHPUnit\Framework\TestCase;
10
11		class Test_Jetpack_JITM extends TestCase {
12		public function setUp() {
13		$this->mock_add_get_current_screen();
14		$this->mock_add_action();
15		$this->mock_do_action();
16		$this->mock_wp_enqueue_script();
17
18		// input/output of these functions doesn't matter right now, they just need to exist
19		$this->mock_empty_function( 'wp_register_style' );
20		$this->mock_empty_function( 'plugins_url' );
21		$this->mock_empty_function( 'wp_style_add_data' );
22		$this->mock_empty_function( 'wp_enqueue_style' );
23		$this->mock_empty_function( 'wp_localize_script' );
24		$this->mock_empty_function( 'esc_url_raw' );
25		$this->mock_empty_function( 'rest_url' );
26		$this->mock_empty_function( 'esc_html__' );
27		}
28
29		public function tearDown() {
30		Mock::disableAll();
31		\Mockery::close();
32		$this->clear_added_actions();
33		$this->clear_enqueued_scripts();
34		}
35
36	View Code Duplication	public function test_jitm_disabled_by_filter() {
37		$this->mock_filters( array(
38		array( 'jetpack_just_in_time_msgs', false, false ),
39		) );
40
41		$jitm = new JITM();
42		$this->assertFalse( $jitm->register() );
43
44		$this->clear_mock_filters();
45		}
46
47	View Code Duplication	public function test_jitm_enabled_by_default() {
48		$this->mock_filters( array(
49		array( 'jetpack_just_in_time_msgs', false, true ),
50		) );
51
52		$jitm = new JITM();
53		$this->assertTrue( $jitm->register() );
54
55		$this->clear_mock_filters();
56		}
57
58		/**
59		* This is an example of a test which uses Mockery to tests a class static method.
60		*
61		* It requires the runInSeparateProcess tag so that the class isn't already autoloaded.
62		*
63		* @runInSeparateProcess
64		*/
65		public function test_prepare_jitms_enqueues_assets() {
66		$mockAssets = \Mockery::mock('alias:Automattic\Jetpack\Assets');
67
68		// mock the static method and return a dummy value
69		$mockAssets
70		->shouldReceive('get_file_url_for_environment')
71		->andReturn('the_file_url');
72
73		$jitm = new JITM();
74		$screen = (object) array( 'id' => 'jetpack_foo' ); // fake screen object
75		$jitm->prepare_jitms( $screen );
76
77		// this should enqueue a jetpack-jitm-new script
78		do_action( 'admin_enqueue_scripts' );
79
80		// assert our script was enqueued with the right value
81		$script = $this->get_enqueued_script( 'jetpack-jitm-new' );
82
83		$this->assertEquals( 'the_file_url', $script['src'] );
84		}
85
86		/*
87		public function test_prepare_jitms_does_not_show_on_some_screens() {
88		$jitm = new JITM();
89		$screen = new \stdClass();
90		$screen->id = 'jetpack_page_stats';
91		$jitm->prepare_jitms( $screen );
92		}
93		*/
94
95		protected function mock_filters( $filters ) {
96		$this->mocked_filters = $filters;
97		$builder = new MockBuilder();
98		$builder->setNamespace( __NAMESPACE__ )
99		->setName( 'apply_filters' )
100		->setFunction(
101		function( ...$current_args ) {
102		foreach ( $this->mocked_filters as $filter ) {
103		if ( array_slice( $filter, 0, -1 ) === $current_args ) {
104		return array_pop( $filter );
105		}
106		}
107		}
108		);
109		$this->apply_filters_mock = $builder->build();
110		$this->apply_filters_mock->enable();
111		}
112
113		protected function clear_mock_filters() {
114		$this->apply_filters_mock->disable();
115		unset( $this->mocked_filters );
116		}
117
118	View Code Duplication	protected function mock_add_get_current_screen() {
119		$builder = new MockBuilder();
120		$builder->setNamespace( __NAMESPACE__ )
121		->setName( 'get_current_screen' )
122		->setFunction( function() {
123		return new \stdClass;
124		} );
125		$builder->build()->enable();
126		}
127
128		protected function mock_add_action() {
129		$builder = new MockBuilder();
130		$builder->setNamespace( __NAMESPACE__ )
131		->setName( 'add_action' )
132		->setFunction( function( $name, $callable ) {
133		global $actions;
134
135		if ( is_null( $actions ) ) {
136		$actions = array();
137		}
138
139		// don't worry about precedence for now
140		if ( ! isset( $actions[$name] ) ) {
141		$actions[$name] = array();
142		}
143
144		$actions[$name][] = $callable;
145		} );
146		$builder->build()->enable();
147		}
148
149		protected function mock_do_action() {
150		$builder = new MockBuilder();
151		$builder->setNamespace( __NAMESPACE__ )
152		->setName( 'do_action' )
153		->setFunction( function( ...$args ) {
154		global $actions;
155		$name = array_shift( $args );
156
157		if ( is_null( $actions ) ) {
158		$actions = array();
159		}
160
161		// don't worry about precedence for now
162		if ( ! isset( $actions[$name] ) ) {
163		$actions[$name] = array();
164		}
165
166		foreach( $actions[$name] as $callable ) {
167		call_user_func_array( $callable, $args );
168		}
169		} );
170		$builder->build()->enable();
171		}
172
173		protected function mock_wp_enqueue_script() {
174		$builder = new MockBuilder();
175		$builder->setNamespace( __NAMESPACE__ )
176		->setName( 'wp_enqueue_script' )
177		->setFunction( function( $handle, $src = '', $deps = array(), $ver = false, $in_footer = false ) {
178		global $wp_scripts;
179
180		if ( is_null( $wp_scripts ) ) {
181		$wp_scripts = array();
182		}
183
184		$wp_scripts[$handle] = compact( 'src', 'deps', 'ver', 'in_footer' );
185		} );
186		$builder->build()->enable();
187		}
188
189		protected function get_enqueued_script( $handle ) {
190		global $wp_scripts;
191		return isset( $wp_scripts[$handle] ) ? $wp_scripts[$handle] : null;
192		}
193
194		protected function clear_added_actions() {
195		global $actions;
196		$actions = array();
197		}
198
199		protected function clear_enqueued_scripts() {
200		global $wp_scripts;
201		$wp_scripts = array();
202		}
203
204		protected function mock_empty_function( $name ) {
205		$builder = new MockBuilder();
206		$builder->setNamespace( __NAMESPACE__ )
207		->setName( $name )
208		->setFunction( function() use ( $name ) {
209		// echo "Called $name with " . print_r( func_get_args(),1 ) . "\n";
210		} );
211		$builder->build()->enable();
212		}
213		}
214

Automattic / jetpack

Push — update/search-js-build ( 7b88d1...a19a37 )

Test_Jetpack_JITM::mock_add_get_current_screen() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like