Error_Handler_Test - Code Metrics - Inspection of "add tests to error_handler class" - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — add/handling-connection-errors ( b95e3b...06a037 )

unknown

created 2020-06-22 21:45 UTC

Error_Handler_Test A

↳ Parent: Project

Complexity

Total Complexity

Size/Duplication

Total Lines	261
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

Metric	Value
dl	0
loc	261
rs	10
c	0
b	0
f	0
wmc	11
lcom	1
cbo	2

11 Methods

Rating	Name	Size	Complexity
A	setUp()	4	1
A	get_sample_error()	19	1
A	test_store_error()	27	1
A	test_store_multiple_error_codes()	30	1
A	test_store_multiple_error_codes_multiple_users()	32	1
A	test_gate()	11	1
A	test_max_five_errors_per_code()	26	1
A	get_user_id_from_token_data()	28	1
A	test_get_user_id_from_token()	3	1
A	test_get_error_by_nonce()	15	1
A	test_verify_error()	12	1

<?php // phpcs:ignore WordPress.Files.FileName.NotHyphenatedLowercase
/**
 * Connection Manager functionality testing.
 *
 * @package automattic/jetpack-connection
 */

namespace Automattic\Jetpack\Connection;

use WorDBless\BaseTestCase;

/**
 * Connection Manager functionality testing.
 */
class Error_Handler_Test extends BaseTestCase {

	/**
	 * Initialize tests
	 */
	public function setUp() {
		parent::setUp();
		$this->error_handler = Error_Handler::get_instance();
	}

	/**
	 * Generates a sample WP_Error object in the same format Manager class does for broken signatures
	 *
	 * @param string $error_code The error code you want the error to have.
	 * @param string $user_id The user id you want the token to have.
	 * @return \WP_Error
	 */
	public function get_sample_error( $error_code, $user_id ) {

		$signature_details = array(
			'token'     => 'dhj938djh938d:1:' . $user_id,
			'timestamp' => time(),
			'nonce'     => 'asd3d32d',
			'body_hash' => 'dsf34frf',
			'method'    => 'POST',
			'url'       => 'https://example.org',
			'signature' => 'sdf234fe',
		);

		return new \WP_Error(
			$error_code,

			'An error was triggered',
			compact( 'signature_details' )
		);

	}

	/**
	 * Test storing an error
	 */
	public function test_store_error() {

		add_filter( 'jetpack_connection_bypass_error_reporting_gate', '__return_true' );

		$error = $this->get_sample_error( 'invalid_token', 1 );

		$this->error_handler->report_error( $error );

		$stored_errors = $this->error_handler->get_stored_errors();

		$this->assertEquals( 1, count( $stored_errors ) );

		$this->arrayHasKey( 'invalid_token', $stored_errors );

		$this->assertEquals( 1, count( $stored_errors['invalid_token'] ) );

		$this->arrayHasKey( '1', $stored_errors['invalid_token'] );

		$this->arrayHasKey( 'nonce', $stored_errors['invalid_token']['1'] );
		$this->arrayHasKey( 'error_code', $stored_errors['invalid_token']['1'] );
		$this->arrayHasKey( 'user_id', $stored_errors['invalid_token']['1'] );
		$this->arrayHasKey( 'error_message', $stored_errors['invalid_token']['1'] );
		$this->arrayHasKey( 'error_data', $stored_errors['invalid_token']['1'] );
		$this->arrayHasKey( 'timestamp', $stored_errors['invalid_token']['1'] );
		$this->arrayHasKey( 'nonce', $stored_errors['invalid_token']['1'] );

	}

	/**
	 * Test storing errors
	 */
	public function test_store_multiple_error_codes() {

		add_filter( 'jetpack_connection_bypass_error_reporting_gate', '__return_true' );

		$error  = $this->get_sample_error( 'invalid_token', 1 );
		$error2 = $this->get_sample_error( 'unknown_user', 1 );

		$this->error_handler->report_error( $error );
		$this->error_handler->report_error( $error2 );

		$stored_errors = $this->error_handler->get_stored_errors();

		$this->assertEquals( 2, count( $stored_errors ) );

		$this->arrayHasKey( 'invalid_token', $stored_errors );

		$this->assertEquals( 1, count( $stored_errors['invalid_token'] ) );
		$this->assertEquals( 1, count( $stored_errors['unknown_user'] ) );

		$this->arrayHasKey( '1', $stored_errors['unknown_user'] );

		$this->arrayHasKey( 'nonce', $stored_errors['unknown_user']['1'] );
		$this->arrayHasKey( 'error_code', $stored_errors['unknown_user']['1'] );
		$this->arrayHasKey( 'user_id', $stored_errors['unknown_user']['1'] );
		$this->arrayHasKey( 'error_message', $stored_errors['unknown_user']['1'] );
		$this->arrayHasKey( 'error_data', $stored_errors['unknown_user']['1'] );
		$this->arrayHasKey( 'timestamp', $stored_errors['unknown_user']['1'] );
		$this->arrayHasKey( 'nonce', $stored_errors['unknown_user']['1'] );

	}

	/**
	 * Test storing errors
	 */
	public function test_store_multiple_error_codes_multiple_users() {

		add_filter( 'jetpack_connection_bypass_error_reporting_gate', '__return_true' );

		$error  = $this->get_sample_error( 'invalid_token', 1 );
		$error2 = $this->get_sample_error( 'unknown_user', 1 );
		$error3 = $this->get_sample_error( 'unknown_user', 2 );

		$this->error_handler->report_error( $error );
		$this->error_handler->report_error( $error2 );
		$this->error_handler->report_error( $error3 );

		$stored_errors = $this->error_handler->get_stored_errors();

		$this->assertEquals( 2, count( $stored_errors ) );

		$this->arrayHasKey( 'invalid_token', $stored_errors );

		$this->assertEquals( 1, count( $stored_errors['invalid_token'] ) );
		$this->assertEquals( 2, count( $stored_errors['unknown_user'] ) );

		$this->arrayHasKey( '2', $stored_errors['unknown_user'] );

		$this->arrayHasKey( 'nonce', $stored_errors['unknown_user']['2'] );
		$this->arrayHasKey( 'error_code', $stored_errors['unknown_user']['2'] );
		$this->arrayHasKey( 'user_id', $stored_errors['unknown_user']['2'] );
		$this->arrayHasKey( 'error_message', $stored_errors['unknown_user']['2'] );
		$this->arrayHasKey( 'error_data', $stored_errors['unknown_user']['2'] );
		$this->arrayHasKey( 'timestamp', $stored_errors['unknown_user']['2'] );
		$this->arrayHasKey( 'nonce', $stored_errors['unknown_user']['2'] );

	}

	/**
	 * Test gate
	 */
	public function test_gate() {

		$error  = $this->get_sample_error( 'invalid_token', 1 );
		$error2 = $this->get_sample_error( 'invalid_token', 1 );
		$error3 = $this->get_sample_error( 'unknown_user', 1 );

		$this->assertTrue( $this->error_handler->should_report_error( $error ) );
		$this->assertFalse( $this->error_handler->should_report_error( $error2 ), 'second attempt to report the same error code should be stopped by the gate' );
		$this->assertTrue( $this->error_handler->should_report_error( $error3 ) );

	}

	/**
	 * Test 5 errors per code
	 */
	public function test_max_five_errors_per_code() {

		add_filter( 'jetpack_connection_bypass_error_reporting_gate', '__return_true' );

		$error  = $this->get_sample_error( 'unknown_user', 3 );
		$error2 = $this->get_sample_error( 'unknown_user', 4 );
		$error3 = $this->get_sample_error( 'unknown_user', 5 );
		$error4 = $this->get_sample_error( 'unknown_user', 6 );
		$error5 = $this->get_sample_error( 'unknown_user', 7 );
		$error6 = $this->get_sample_error( 'unknown_user', 8 );

		$this->error_handler->report_error( $error );
		$this->error_handler->report_error( $error2 );
		$this->error_handler->report_error( $error3 );
		$this->error_handler->report_error( $error4 );
		$this->error_handler->report_error( $error5 );
		$this->error_handler->report_error( $error6 );

		$stored_errors = $this->error_handler->get_stored_errors();

		$this->assertEquals( 5, count( $stored_errors['unknown_user'] ) );

		$this->assertArrayNotHasKey( '3', $stored_errors['unknown_user'], 'first inserted error must have been excluded' );
		$this->assertArrayHasKey( '8', $stored_errors['unknown_user'], 'sixth inserted error must be present' );

	}

	function get_user_id_from_token_data() {
		return array(
			array(
				'token'    => 'asdsaddasa:1:3',
				'expected' => 3,
			),
			array(
				'token'    => 'asdsaddasa:1:2',
				'expected' => 2,
			),
			array(
				'token'    => 'asdsaddasa:1',
				'expected' => 'invalid',
			),
			array(
				'token'    => 'asdsaddasa:1:',
				'expected' => 'invalid',
			),
			array(
				'token'    => 'asdsaddasa:1:asd',
				'expected' => 'invalid',
			),
			array(
				'token'    => 'asdsaddasa:1:333',
				'expected' => 333,
			),
		);
	}

	/**
	 * Test get_user_id_from_token
	 *
	 * @param string         $token token.
	 * @param string|integer $expected expected user_id.
	 *
	 * @dataProvider get_user_id_from_token_data
	 */
	public function test_get_user_id_from_token( $token, $expected ) {
		$this->assertEquals( $expected, $this->error_handler->get_user_id_from_token( $token ) );
	}


	/**
	 * Test get_error_by_nonce
	 */
	public function test_get_error_by_nonce() {
		$error  = $this->get_sample_error( 'unknown_user', 3 );
		$error2 = $this->get_sample_error( 'invalid_token', 4 );
		$error3 = $this->get_sample_error( 'no_user_tokens', 5 );

		$this->error_handler->report_error( $error );
		$this->error_handler->report_error( $error2 );
		$this->error_handler->report_error( $error3 );

		$stored_errors = $this->error_handler->get_stored_errors();

		$error = $this->error_handler->get_error_by_nonce( $stored_errors['no_user_tokens']['5']['nonce'] );

		$this->assertEquals( $error, $stored_errors['no_user_tokens']['5'] );
	}

	/**
	 * Test verify error
	 */
	public function test_verify_error() {
		$error = $this->get_sample_error( 'unknown_user', 3 );
		$this->error_handler->report_error( $error );

		$stored_errors = $this->error_handler->get_stored_errors();

		$this->error_handler->verify_error( $stored_errors['unknown_user']['3'] );

		$verified_errors = $this->error_handler->get_verified_errors();

		$this->assertEquals( $verified_errors['unknown_user']['3'], $stored_errors['unknown_user']['3'] );
	}

}


1			<?php // phpcs:ignore WordPress.Files.FileName.NotHyphenatedLowercase
2			/**
3			* Connection Manager functionality testing.
4			*
5			* @package automattic/jetpack-connection
6			*/
7
8			namespace Automattic\Jetpack\Connection;
9
10			use WorDBless\BaseTestCase;
11
12			/**
13			* Connection Manager functionality testing.
14			*/
15			class Error_Handler_Test extends BaseTestCase {
16
17			/**
18			* Initialize tests
19			*/
20			public function setUp() {
21			parent::setUp();
22			$this->error_handler = Error_Handler::get_instance();
23			}
24
25			/**
26			* Generates a sample WP_Error object in the same format Manager class does for broken signatures
27			*
28			* @param string $error_code The error code you want the error to have.
29			* @param string $user_id The user id you want the token to have.
30			* @return \WP_Error
31			*/
32			public function get_sample_error( $error_code, $user_id ) {
33
34			$signature_details = array(
35			'token' => 'dhj938djh938d:1:' . $user_id,
36			'timestamp' => time(),
37			'nonce' => 'asd3d32d',
38			'body_hash' => 'dsf34frf',
39			'method' => 'POST',
40			'url' => 'https://example.org',
41			'signature' => 'sdf234fe',
42			);
43
44			return new \WP_Error(
45			$error_code,
			0 ignored issues – show Unused Code introduced 2020-06-22 22:57 UTC by Report Bug Copy Issue Report The call to `WP_Error::__construct()` has too many arguments starting with `$error_code`. This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue. If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress. In this case you can add the `@ignore` PhpDoc annotation to the duplicate definition and it will be ignored. Loading history...
46			'An error was triggered',
47			compact( 'signature_details' )
48			);
49
50			}
51
52			/**
53			* Test storing an error
54			*/
55			public function test_store_error() {
56
57			add_filter( 'jetpack_connection_bypass_error_reporting_gate', '__return_true' );
58
59			$error = $this->get_sample_error( 'invalid_token', 1 );
60
61			$this->error_handler->report_error( $error );
62
63			$stored_errors = $this->error_handler->get_stored_errors();
64
65			$this->assertEquals( 1, count( $stored_errors ) );
66
67			$this->arrayHasKey( 'invalid_token', $stored_errors );
68
69			$this->assertEquals( 1, count( $stored_errors['invalid_token'] ) );
70
71			$this->arrayHasKey( '1', $stored_errors['invalid_token'] );
72
73			$this->arrayHasKey( 'nonce', $stored_errors['invalid_token']['1'] );
74			$this->arrayHasKey( 'error_code', $stored_errors['invalid_token']['1'] );
75			$this->arrayHasKey( 'user_id', $stored_errors['invalid_token']['1'] );
76			$this->arrayHasKey( 'error_message', $stored_errors['invalid_token']['1'] );
77			$this->arrayHasKey( 'error_data', $stored_errors['invalid_token']['1'] );
78			$this->arrayHasKey( 'timestamp', $stored_errors['invalid_token']['1'] );
79			$this->arrayHasKey( 'nonce', $stored_errors['invalid_token']['1'] );
80
81			}
82
83			/**
84			* Test storing errors
85			*/
86			public function test_store_multiple_error_codes() {
87
88			add_filter( 'jetpack_connection_bypass_error_reporting_gate', '__return_true' );
89
90			$error = $this->get_sample_error( 'invalid_token', 1 );
91			$error2 = $this->get_sample_error( 'unknown_user', 1 );
92
93			$this->error_handler->report_error( $error );
94			$this->error_handler->report_error( $error2 );
95
96			$stored_errors = $this->error_handler->get_stored_errors();
97
98			$this->assertEquals( 2, count( $stored_errors ) );
99
100			$this->arrayHasKey( 'invalid_token', $stored_errors );
101
102			$this->assertEquals( 1, count( $stored_errors['invalid_token'] ) );
103			$this->assertEquals( 1, count( $stored_errors['unknown_user'] ) );
104
105			$this->arrayHasKey( '1', $stored_errors['unknown_user'] );
106
107			$this->arrayHasKey( 'nonce', $stored_errors['unknown_user']['1'] );
108			$this->arrayHasKey( 'error_code', $stored_errors['unknown_user']['1'] );
109			$this->arrayHasKey( 'user_id', $stored_errors['unknown_user']['1'] );
110			$this->arrayHasKey( 'error_message', $stored_errors['unknown_user']['1'] );
111			$this->arrayHasKey( 'error_data', $stored_errors['unknown_user']['1'] );
112			$this->arrayHasKey( 'timestamp', $stored_errors['unknown_user']['1'] );
113			$this->arrayHasKey( 'nonce', $stored_errors['unknown_user']['1'] );
114
115			}
116
117			/**
118			* Test storing errors
119			*/
120			public function test_store_multiple_error_codes_multiple_users() {
121
122			add_filter( 'jetpack_connection_bypass_error_reporting_gate', '__return_true' );
123
124			$error = $this->get_sample_error( 'invalid_token', 1 );
125			$error2 = $this->get_sample_error( 'unknown_user', 1 );
126			$error3 = $this->get_sample_error( 'unknown_user', 2 );
127
128			$this->error_handler->report_error( $error );
129			$this->error_handler->report_error( $error2 );
130			$this->error_handler->report_error( $error3 );
131
132			$stored_errors = $this->error_handler->get_stored_errors();
133
134			$this->assertEquals( 2, count( $stored_errors ) );
135
136			$this->arrayHasKey( 'invalid_token', $stored_errors );
137
138			$this->assertEquals( 1, count( $stored_errors['invalid_token'] ) );
139			$this->assertEquals( 2, count( $stored_errors['unknown_user'] ) );
140
141			$this->arrayHasKey( '2', $stored_errors['unknown_user'] );
142
143			$this->arrayHasKey( 'nonce', $stored_errors['unknown_user']['2'] );
144			$this->arrayHasKey( 'error_code', $stored_errors['unknown_user']['2'] );
145			$this->arrayHasKey( 'user_id', $stored_errors['unknown_user']['2'] );
146			$this->arrayHasKey( 'error_message', $stored_errors['unknown_user']['2'] );
147			$this->arrayHasKey( 'error_data', $stored_errors['unknown_user']['2'] );
148			$this->arrayHasKey( 'timestamp', $stored_errors['unknown_user']['2'] );
149			$this->arrayHasKey( 'nonce', $stored_errors['unknown_user']['2'] );
150
151			}
152
153			/**
154			* Test gate
155			*/
156			public function test_gate() {
157
158			$error = $this->get_sample_error( 'invalid_token', 1 );
159			$error2 = $this->get_sample_error( 'invalid_token', 1 );
160			$error3 = $this->get_sample_error( 'unknown_user', 1 );
161
162			$this->assertTrue( $this->error_handler->should_report_error( $error ) );
163			$this->assertFalse( $this->error_handler->should_report_error( $error2 ), 'second attempt to report the same error code should be stopped by the gate' );
164			$this->assertTrue( $this->error_handler->should_report_error( $error3 ) );
165
166			}
167
168			/**
169			* Test 5 errors per code
170			*/
171			public function test_max_five_errors_per_code() {
172
173			add_filter( 'jetpack_connection_bypass_error_reporting_gate', '__return_true' );
174
175			$error = $this->get_sample_error( 'unknown_user', 3 );
176			$error2 = $this->get_sample_error( 'unknown_user', 4 );
177			$error3 = $this->get_sample_error( 'unknown_user', 5 );
178			$error4 = $this->get_sample_error( 'unknown_user', 6 );
179			$error5 = $this->get_sample_error( 'unknown_user', 7 );
180			$error6 = $this->get_sample_error( 'unknown_user', 8 );
181
182			$this->error_handler->report_error( $error );
183			$this->error_handler->report_error( $error2 );
184			$this->error_handler->report_error( $error3 );
185			$this->error_handler->report_error( $error4 );
186			$this->error_handler->report_error( $error5 );
187			$this->error_handler->report_error( $error6 );
188
189			$stored_errors = $this->error_handler->get_stored_errors();
190
191			$this->assertEquals( 5, count( $stored_errors['unknown_user'] ) );
192
193			$this->assertArrayNotHasKey( '3', $stored_errors['unknown_user'], 'first inserted error must have been excluded' );
194			$this->assertArrayHasKey( '8', $stored_errors['unknown_user'], 'sixth inserted error must be present' );
195
196			}
197
198			function get_user_id_from_token_data() {
199			return array(
200			array(
201			'token' => 'asdsaddasa:1:3',
202			'expected' => 3,
203			),
204			array(
205			'token' => 'asdsaddasa:1:2',
206			'expected' => 2,
207			),
208			array(
209			'token' => 'asdsaddasa:1',
210			'expected' => 'invalid',
211			),
212			array(
213			'token' => 'asdsaddasa:1:',
214			'expected' => 'invalid',
215			),
216			array(
217			'token' => 'asdsaddasa:1:asd',
218			'expected' => 'invalid',
219			),
220			array(
221			'token' => 'asdsaddasa:1:333',
222			'expected' => 333,
223			),
224			);
225			}
226
227			/**
228			* Test get_user_id_from_token
229			*
230			* @param string $token token.
231			* @param string\|integer $expected expected user_id.
232			*
233			* @dataProvider get_user_id_from_token_data
234			*/
235			public function test_get_user_id_from_token( $token, $expected ) {
236			$this->assertEquals( $expected, $this->error_handler->get_user_id_from_token( $token ) );
237			}
238
239
240			/**
241			* Test get_error_by_nonce
242			*/
243			public function test_get_error_by_nonce() {
244			$error = $this->get_sample_error( 'unknown_user', 3 );
245			$error2 = $this->get_sample_error( 'invalid_token', 4 );
246			$error3 = $this->get_sample_error( 'no_user_tokens', 5 );
247
248			$this->error_handler->report_error( $error );
249			$this->error_handler->report_error( $error2 );
250			$this->error_handler->report_error( $error3 );
251
252			$stored_errors = $this->error_handler->get_stored_errors();
253
254			$error = $this->error_handler->get_error_by_nonce( $stored_errors['no_user_tokens']['5']['nonce'] );
255
256			$this->assertEquals( $error, $stored_errors['no_user_tokens']['5'] );
257			}
258
259			/**
260			* Test verify error
261			*/
262			public function test_verify_error() {
263			$error = $this->get_sample_error( 'unknown_user', 3 );
264			$this->error_handler->report_error( $error );
265
266			$stored_errors = $this->error_handler->get_stored_errors();
267
268			$this->error_handler->verify_error( $stored_errors['unknown_user']['3'] );
269
270			$verified_errors = $this->error_handler->get_verified_errors();
271
272			$this->assertEquals( $verified_errors['unknown_user']['3'], $stored_errors['unknown_user']['3'] );
273			}
274
275			}
276

Automattic / jetpack

Push — add/handling-connection-errors ( b95e3b...06a037 )

Error_Handler_Test A

Complexity

Size/Duplication

Coupling/Cohesion

Importance

11 Methods

Duplication Side-by-Side

Filter issues like