Password_Checker_Test::rule_provider() - Code Metrics - Inspection of "Adding more tests to the data provider." - Automattic/jetpack - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — add/password-package ( 73a4ea...0577b4 )

unknown

created 2021-03-10 22:06 UTC

Password_Checker_Test::rule_provider() B

↳ Parent: Password_Checker_Test

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
nc	1
nop	0
dl	0
loc	70
rs	8.6545
c	0
b	0
f	0

How to fix Long Method

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

/**
 * Tests the Password_Checker package.
 *
 * @package automattic/jetpack-password-checker
 */

namespace Automattic\Jetpack;

use WorDBless\BaseTestCase;

/**
 * Test Password_Checker class
 */
class Password_Checker_Test extends BaseTestCase {
	/**
	 * User ID.
	 *
	 * @var int|\WP_Error
	 */
	private $user_id;

	/**
	 * User object.
	 *
	 * @var \WP_User
	 */
	private $user;

	/**
	 * Password_Checker object.
	 *
	 * @var Password_Checker
	 */
	private $password_checker;

	/**
	 * Initialize tests.
	 *
	 * @before
	 */
	public function set_up() {
		$this->user_id = wp_insert_user(
			array(
				'user_login' => 'test-user',
				'user_pass'  => '123',
				'first_name' => 'Test',
				'last_name'  => 'User',
				'nickname'   => 'test',
				'role'       => 'subscriber',
			)
		);

		$this->user = new \WP_User( $this->user_id );

		$this->password_checker = new Password_Checker( $this->user );
	}

	/**
	 * Test the password checker.
	 *
	 * @dataProvider rule_provider
	 *
	 * @param string $section         Section name.
	 * @param string $rule            Rule name.
	 * @param string $password        The password.
	 * @param bool   $expected_result The expected result.
	 * @param string $output_message  The output message.
	 */
	public function test_password( $section, $rule, $password, $expected_result, $output_message ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
		$this->password_checker->common_passwords = array( 'password' );

		$tests = $this->password_checker->get_tests( $section );
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);

		$results = $this->password_checker->run_tests( $password, array( $section => array( $rule => $tests[ $section ][ $rule ] ) ) );

		$this->assertSame( $expected_result, ! empty( $results['passed'] ), $output_message );
	}

	/**
	 * Data provider for password tests.
	 *
	 * @return array
	 */
	public function rule_provider() {
		/**
		 * Data format.
		 *
		 * Param 1 -> section
		 * Param 2 -> rule
		 * Param 3 -> password
		 * Param 4 -> expected_result
		 * Param 5 -> output_message
		 */

		return array(
			'no_backslashes'    => array(
				'preg_match',
				'no_backslashes',
				'abc123',
				true,
				'Passwords may not contain the character "\".',
			),
			'minimum_length'    => array(
				'preg_match',
				'minimum_length',
				'abc123',
				true,
				'Password must be at least 6 characters.',
			),
			'has_mixed_case'    => array(
				'preg_match',
				'has_mixed_case',
				'Abc123',
				true,
				'Password must have mixed case characters.',
			),
			'has_digit'         => array(
				'preg_match',
				'has_digit',
				'abc123',
				true,
				'Password must have digits.',
			),
			'has_special_char'  => array(
				'preg_match',
				'has_special_char',
				'abc!def',
				true,
				'Password must have special characters.',
			),
			'compare_to_list_1' => array(
				'compare_to_list',
				'not_a_common_password',
				'password',
				false,
				'Common passwords that should not be used.',
			),
			'compare_to_list_2' => array(
				'compare_to_list',
				'not_a_common_password',
				'hunter2',
				true,
				'Common passwords that should not be used.',
			),
			'compare_to_list_3' => array(
				'compare_to_list',
				'not_same_as_other_user_data',
				'test-user',
				false,
				'Password contains user data.',
			),
		);
	}
}


1			<?php //phpcs:ignore WordPress.Files.FileName.InvalidClassFileName
2
3			/**
4			* Tests the Password_Checker package.
5			*
6			* @package automattic/jetpack-password-checker
7			*/
8
9			namespace Automattic\Jetpack;
10
11			use WorDBless\BaseTestCase;
12
13			/**
14			* Test Password_Checker class
15			*/
16			class Password_Checker_Test extends BaseTestCase {
17			/**
18			* User ID.
19			*
20			* @var int\|\WP_Error
21			*/
22			private $user_id;
23
24			/**
25			* User object.
26			*
27			* @var \WP_User
28			*/
29			private $user;
30
31			/**
32			* Password_Checker object.
33			*
34			* @var Password_Checker
35			*/
36			private $password_checker;
37
38			/**
39			* Initialize tests.
40			*
41			* @before
42			*/
43			public function set_up() {
44			$this->user_id = wp_insert_user(
45			array(
46			'user_login' => 'test-user',
47			'user_pass' => '123',
48			'first_name' => 'Test',
49			'last_name' => 'User',
50			'nickname' => 'test',
51			'role' => 'subscriber',
52			)
53			);
54
55			$this->user = new \WP_User( $this->user_id );
56
57			$this->password_checker = new Password_Checker( $this->user );
58			}
59
60			/**
61			* Test the password checker.
62			*
63			* @dataProvider rule_provider
64			*
65			* @param string $section Section name.
66			* @param string $rule Rule name.
67			* @param string $password The password.
68			* @param bool $expected_result The expected result.
69			* @param string $output_message The output message.
70			*/
71			public function test_password( $section, $rule, $password, $expected_result, $output_message ) { // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
72			$this->password_checker->common_passwords = array( 'password' );
73
74			$tests = $this->password_checker->get_tests( $section );
			0 ignored issues – show Documentation introduced 2021-03-05 05:03 UTC by Report Bug Copy Issue Report `$section` is of type `string`, but the function expects a `false\|array`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
75
76			$results = $this->password_checker->run_tests( $password, array( $section => array( $rule => $tests[ $section ][ $rule ] ) ) );
77
78			$this->assertSame( $expected_result, ! empty( $results['passed'] ), $output_message );
79			}
80
81			/**
82			* Data provider for password tests.
83			*
84			* @return array
85			*/
86			public function rule_provider() {
87			/**
88			* Data format.
89			*
90			* Param 1 -> section
91			* Param 2 -> rule
92			* Param 3 -> password
93			* Param 4 -> expected_result
94			* Param 5 -> output_message
95			*/
96
97			return array(
98			'no_backslashes' => array(
99			'preg_match',
100			'no_backslashes',
101			'abc123',
102			true,
103			'Passwords may not contain the character "\".',
104			),
105			'minimum_length' => array(
106			'preg_match',
107			'minimum_length',
108			'abc123',
109			true,
110			'Password must be at least 6 characters.',
111			),
112			'has_mixed_case' => array(
113			'preg_match',
114			'has_mixed_case',
115			'Abc123',
116			true,
117			'Password must have mixed case characters.',
118			),
119			'has_digit' => array(
120			'preg_match',
121			'has_digit',
122			'abc123',
123			true,
124			'Password must have digits.',
125			),
126			'has_special_char' => array(
127			'preg_match',
128			'has_special_char',
129			'abc!def',
130			true,
131			'Password must have special characters.',
132			),
133			'compare_to_list_1' => array(
134			'compare_to_list',
135			'not_a_common_password',
136			'password',
137			false,
138			'Common passwords that should not be used.',
139			),
140			'compare_to_list_2' => array(
141			'compare_to_list',
142			'not_a_common_password',
143			'hunter2',
144			true,
145			'Common passwords that should not be used.',
146			),
147			'compare_to_list_3' => array(
148			'compare_to_list',
149			'not_same_as_other_user_data',
150			'test-user',
151			false,
152			'Password contains user data.',
153			),
154			);
155			}
156			}
157

Automattic / jetpack

Push — add/password-package ( 73a4ea...0577b4 )

Password_Checker_Test::rule_provider() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like