WP_Canonical_UnitTestCase::assertCanonical() - Code Metrics - Inspection of "unit tests added" - GeoDirectory/geodirectory - Measure and Improve Code Quality continuously with Scrutinizer

Test Setup Failed

Pull Request — master (#216)

by Viruthagiri

created 2016-03-12 19:19 UTC

WP_Canonical_UnitTestCase::assertCanonical() D

↳ Parent: WP_Canonical_UnitTestCase

Complexity

Conditions	13
Paths	144

Size

Total Lines	49
Code Lines	27

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	49
rs	4.814
cc	13
eloc	27
nc	144
nop	4

How to fix Complexity

<?php

class WP_Canonical_UnitTestCase extends WP_UnitTestCase {
	static $old_current_user;
	static $author_id;
	static $post_ids = array();
	static $comment_ids = array();
	static $term_ids = array();
	static $terms = array();
	static $old_options = array();

	/**
	 * This can be defined in a subclass of this class which contains its own data() method.
	 * Those tests will be run against the specified permastruct.
	 */
	public $structure = '/%year%/%monthnum%/%day%/%postname%/';

	public function setUp() {
		parent::setUp();

		update_option( 'page_comments', true );
		update_option( 'comments_per_page', 5 );
		update_option( 'posts_per_page', 5 );

		global $wp_rewrite;
		$wp_rewrite->init();
		$wp_rewrite->set_permalink_structure( $this->structure );

		create_initial_taxonomies();

		$wp_rewrite->flush_rules();
	}

	/**
	 * Generate fixtures to be shared between canonical tests.
	 *
	 * Abstracted here because it's invoked by setUpBeforeClass() in more than one class.
	 *
	 * @since 4.1.0
	 */
	public static function generate_shared_fixtures( $factory ) {
		self::$old_current_user = get_current_user_id();
		self::$author_id = $factory->user->create( array( 'user_login' => 'canonical-author' ) );

		/*
		 * Also set in self::setUp(), but we must configure here to make sure that
		 * post authorship is properly attributed for fixtures.
		 */
		wp_set_current_user( self::$author_id );

		// Already created by install defaults:
		// self::factory()->term->create( array( 'taxonomy' => 'category', 'name' => 'uncategorized' ) );


		self::$post_ids[] = $factory->post->create( array( 'import_id' => 587, 'post_title' => 'post-format-test-audio', 'post_date' => '2008-06-02 00:00:00' ) );
		self::$post_ids[] = $post_id = $factory->post->create( array( 'post_title' => 'post-format-test-gallery', 'post_date' => '2008-06-10 00:00:00' ) );
		self::$post_ids[] = $factory->post->create( array( 'import_id' => 611, 'post_type' => 'attachment', 'post_title' => 'canola2', 'post_parent' => $post_id ) );

		self::$post_ids[] = $factory->post->create( array(
			'post_title' => 'images-test',
			'post_date' => '2008-09-03 00:00:00',
			'post_content' => 'Page 1 <!--nextpage--> Page 2 <!--nextpage--> Page 3'
		) );

		self::$post_ids[] = $post_id = $factory->post->create( array( 'import_id' => 149, 'post_title' => 'comment-test', 'post_date' => '2008-03-03 00:00:00' ) );
		self::$comment_ids = $factory->comment->create_post_comments( $post_id, 15 );

		self::$post_ids[] = $factory->post->create( array( 'post_date' => '2008-09-05 00:00:00' ) );

		self::$post_ids[] = $factory->post->create( array( 'import_id' => 123 ) );
		self::$post_ids[] = $factory->post->create( array( 'import_id' => 1 ) );
		self::$post_ids[] = $factory->post->create( array( 'import_id' => 358 ) );

		self::$post_ids[] = $factory->post->create( array( 'post_type' => 'page', 'post_title' => 'sample-page' ) );
		self::$post_ids[] = $factory->post->create( array( 'post_type' => 'page', 'post_title' => 'about' ) );
		self::$post_ids[] = $post_id = $factory->post->create( array( 'post_type' => 'page', 'post_title' => 'parent-page' ) );
		self::$post_ids[] = $factory->post->create(
			array( 'import_id' => 144, 'post_type' => 'page', 'post_title' => 'child-page-1', 'post_parent' => $post_id,
		) );

		self::$post_ids[] = $parent_id = $factory->post->create( array(
			'post_name' => 'parent',
			'post_type' => 'page',
		) );
		self::$post_ids[] = $child_id_1 = $factory->post->create( array(
			'post_name'   => 'child1',
			'post_type'   => 'page',
			'post_parent' => $parent_id,
		) );
		self::$post_ids[] = $child_id_2 = $factory->post->create( array(
			'post_name'   => 'child2',
			'post_type'   => 'page',
			'post_parent' => $parent_id,
		) );
		self::$post_ids[] = $grandchild_id_1 = $factory->post->create( array(
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
			'post_name'   => 'grandchild',
			'post_type'   => 'page',
			'post_parent' => $child_id_1,
		) );
		self::$post_ids[] = $grandchild_id_2 = $factory->post->create( array(
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
			'post_name'   => 'grandchild',
			'post_type'   => 'page',
			'post_parent' => $child_id_2,
		) );

		$cat1 = $factory->term->create( array( 'taxonomy' => 'category', 'name' => 'parent' ) );
		self::$terms['/category/parent/'] = $cat1;
		self::$term_ids[ $cat1 ] = 'category';

		$cat2 = $factory->term->create( array(
			'taxonomy' => 'category', 'name' => 'child-1', 'parent' => self::$terms['/category/parent/'],
		) );
		self::$terms['/category/parent/child-1/'] = $cat2;
		self::$term_ids[ $cat2 ] = 'category';

		$cat3 = $factory->term->create( array(
			'taxonomy' => 'category', 'name' => 'child-2', 'parent' => self::$terms['/category/parent/child-1/'],
		) );
		self::$terms['/category/parent/child-1/child-2/'] = $cat3;
		self::$term_ids[ $cat3 ] = 'category';

		$cat4 = $factory->term->create( array( 'taxonomy' => 'category', 'name' => 'cat-a' ) );
		self::$term_ids[ $cat4 ] = 'category';

		$cat5 = $factory->term->create( array( 'taxonomy' => 'category', 'name' => 'cat-b' ) );
		self::$term_ids[ $cat5 ] = 'category';

		$tag1 = $factory->term->create( array( 'name' => 'post-formats' ) );
		self::$term_ids[ $tag1 ] = 'post_tag';
	}

	/**
	 * Clean up shared fixtures.
	 *
	 * @since 4.1.0
	 */
	public static function delete_shared_fixtures() {
		self::delete_user( self::$author_id );

		foreach ( self::$post_ids as $pid ) {
			wp_delete_post( $pid, true );
		}

		foreach ( self::$comment_ids as $cid ) {
			wp_delete_comment( $cid, true );
		}

		foreach ( self::$term_ids as $tid => $tax ) {
			wp_delete_term( $tid, $tax );
		}

		self::$author_id = null;
		self::$post_ids = array();
		self::$comment_ids = array();
		self::$term_ids = array();
		self::$terms = array();
	}

	/**
	 * Assert that a given URL is the same a the canonical URL generated by WP.
	 *
	 * @since 4.1.0
	 *
	 * @param string $test_url                Raw URL that will be run through redirect_canonical().
	 * @param string $expected                Expected string.
	 * @param int    $ticket                  Optional. Trac ticket number.
	 * @param array  $expected_doing_it_wrong Array of class/function names expected to throw _doing_it_wrong() notices.
	 */
	public function assertCanonical( $test_url, $expected, $ticket = 0, $expected_doing_it_wrong = array() ) {
		$this->expected_doing_it_wrong = array_merge( $this->expected_doing_it_wrong, (array) $expected_doing_it_wrong );

		if ( $ticket )
			$this->knownWPBug( $ticket );

		$ticket_ref = ($ticket > 0) ? 'Ticket #' . $ticket : null;
global $wpdb;
//print_r( $wpdb->get_results( "SELECT * FROM $wpdb->terms" ) );

		if ( is_string($expected) )
			$expected = array('url' => $expected);
		elseif ( is_array($expected) && !isset($expected['url']) && !isset($expected['qv']) )
			$expected = array( 'qv' => $expected );

		if ( !isset($expected['url']) && !isset($expected['qv']) )
			$this->markTestSkipped('No valid expected output was provided');

		$this->go_to( home_url( $test_url ) );

		// Does the redirect match what's expected?
		$can_url = $this->get_canonical( $test_url );
		$parsed_can_url = parse_url($can_url);

		// Just test the Path and Query if present
		if ( isset($expected['url']) ) {
			$this->assertEquals( $expected['url'], $parsed_can_url['path'] . (!empty($parsed_can_url['query']) ? '?' . $parsed_can_url['query'] : ''), $ticket_ref );
		}

		if ( ! isset($expected['qv']) )
			return;

		// "make" that the request and check the query is correct
		$this->go_to( $can_url );

		// Are all query vars accounted for, And correct?
		global $wp;

		$query_vars = array_diff($wp->query_vars, $wp->extra_query_vars);
		if ( !empty($parsed_can_url['query']) ) {
			parse_str($parsed_can_url['query'], $_qv);

			// $_qv should not contain any elements which are set in $query_vars already (ie. $_GET vars should not be present in the Rewrite)
			$this->assertEquals( array(), array_intersect( $query_vars, $_qv ), 'Query vars are duplicated from the Rewrite into $_GET; ' . $ticket_ref );

			$query_vars = array_merge($query_vars, $_qv);
		}

		$this->assertEquals( $expected['qv'], $query_vars );
	}

	/**
	 * Get the canonical URL given a raw URL.
	 *
	 * @param string $test_url Should be relative to the site "front", ie /category/uncategorized/
	 *                         as opposed to http://example.com/category/uncategorized/
	 * @return $can_url Returns the original $test_url if no canonical can be generated, otherwise returns

	 *                  the fully-qualified URL as generated by redirect_canonical().
	 */
	public function get_canonical( $test_url ) {
		$test_url = home_url( $test_url );

		$can_url = redirect_canonical( $test_url, false );
		if ( ! $can_url )
			return $test_url; // No redirect will take place for this request

		return $can_url;
	}
}


1			<?php
2
3			class WP_Canonical_UnitTestCase extends WP_UnitTestCase {
4			static $old_current_user;
5			static $author_id;
6			static $post_ids = array();
7			static $comment_ids = array();
8			static $term_ids = array();
9			static $terms = array();
10			static $old_options = array();
11
12			/**
13			* This can be defined in a subclass of this class which contains its own data() method.
14			* Those tests will be run against the specified permastruct.
15			*/
16			public $structure = '/%year%/%monthnum%/%day%/%postname%/';
17
18			public function setUp() {
19			parent::setUp();
20
21			update_option( 'page_comments', true );
22			update_option( 'comments_per_page', 5 );
23			update_option( 'posts_per_page', 5 );
24
25			global $wp_rewrite;
26			$wp_rewrite->init();
27			$wp_rewrite->set_permalink_structure( $this->structure );
28
29			create_initial_taxonomies();
30
31			$wp_rewrite->flush_rules();
32			}
33
34			/**
35			* Generate fixtures to be shared between canonical tests.
36			*
37			* Abstracted here because it's invoked by setUpBeforeClass() in more than one class.
38			*
39			* @since 4.1.0
40			*/
41			public static function generate_shared_fixtures( $factory ) {
42			self::$old_current_user = get_current_user_id();
43			self::$author_id = $factory->user->create( array( 'user_login' => 'canonical-author' ) );
44
45			/*
46			* Also set in self::setUp(), but we must configure here to make sure that
47			* post authorship is properly attributed for fixtures.
48			*/
49			wp_set_current_user( self::$author_id );
50
51			// Already created by install defaults:
52			// self::factory()->term->create( array( 'taxonomy' => 'category', 'name' => 'uncategorized' ) );
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-03-12 17:53 UTC by Report Bug Copy Issue Report `60%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
53
54			self::$post_ids[] = $factory->post->create( array( 'import_id' => 587, 'post_title' => 'post-format-test-audio', 'post_date' => '2008-06-02 00:00:00' ) );
55			self::$post_ids[] = $post_id = $factory->post->create( array( 'post_title' => 'post-format-test-gallery', 'post_date' => '2008-06-10 00:00:00' ) );
56			self::$post_ids[] = $factory->post->create( array( 'import_id' => 611, 'post_type' => 'attachment', 'post_title' => 'canola2', 'post_parent' => $post_id ) );
57
58			self::$post_ids[] = $factory->post->create( array(
59			'post_title' => 'images-test',
60			'post_date' => '2008-09-03 00:00:00',
61			'post_content' => 'Page 1 <!--nextpage--> Page 2 <!--nextpage--> Page 3'
62			) );
63
64			self::$post_ids[] = $post_id = $factory->post->create( array( 'import_id' => 149, 'post_title' => 'comment-test', 'post_date' => '2008-03-03 00:00:00' ) );
65			self::$comment_ids = $factory->comment->create_post_comments( $post_id, 15 );
66
67			self::$post_ids[] = $factory->post->create( array( 'post_date' => '2008-09-05 00:00:00' ) );
68
69			self::$post_ids[] = $factory->post->create( array( 'import_id' => 123 ) );
70			self::$post_ids[] = $factory->post->create( array( 'import_id' => 1 ) );
71			self::$post_ids[] = $factory->post->create( array( 'import_id' => 358 ) );
72
73			self::$post_ids[] = $factory->post->create( array( 'post_type' => 'page', 'post_title' => 'sample-page' ) );
74			self::$post_ids[] = $factory->post->create( array( 'post_type' => 'page', 'post_title' => 'about' ) );
75			self::$post_ids[] = $post_id = $factory->post->create( array( 'post_type' => 'page', 'post_title' => 'parent-page' ) );
76			self::$post_ids[] = $factory->post->create(
77			array( 'import_id' => 144, 'post_type' => 'page', 'post_title' => 'child-page-1', 'post_parent' => $post_id,
78			) );
79
80			self::$post_ids[] = $parent_id = $factory->post->create( array(
81			'post_name' => 'parent',
82			'post_type' => 'page',
83			) );
84			self::$post_ids[] = $child_id_1 = $factory->post->create( array(
85			'post_name' => 'child1',
86			'post_type' => 'page',
87			'post_parent' => $parent_id,
88			) );
89			self::$post_ids[] = $child_id_2 = $factory->post->create( array(
90			'post_name' => 'child2',
91			'post_type' => 'page',
92			'post_parent' => $parent_id,
93			) );
94			self::$post_ids[] = $grandchild_id_1 = $factory->post->create( array(
			0 ignored issues – show Unused Code introduced 2016-03-12 17:52 UTC by Report Bug Copy Issue Report `$grandchild_id_1` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
95			'post_name' => 'grandchild',
96			'post_type' => 'page',
97			'post_parent' => $child_id_1,
98			) );
99			self::$post_ids[] = $grandchild_id_2 = $factory->post->create( array(
			0 ignored issues – show Unused Code introduced 2016-03-12 17:52 UTC by Report Bug Copy Issue Report `$grandchild_id_2` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
100			'post_name' => 'grandchild',
101			'post_type' => 'page',
102			'post_parent' => $child_id_2,
103			) );
104
105			$cat1 = $factory->term->create( array( 'taxonomy' => 'category', 'name' => 'parent' ) );
106			self::$terms['/category/parent/'] = $cat1;
107			self::$term_ids[ $cat1 ] = 'category';
108
109			$cat2 = $factory->term->create( array(
110			'taxonomy' => 'category', 'name' => 'child-1', 'parent' => self::$terms['/category/parent/'],
111			) );
112			self::$terms['/category/parent/child-1/'] = $cat2;
113			self::$term_ids[ $cat2 ] = 'category';
114
115			$cat3 = $factory->term->create( array(
116			'taxonomy' => 'category', 'name' => 'child-2', 'parent' => self::$terms['/category/parent/child-1/'],
117			) );
118			self::$terms['/category/parent/child-1/child-2/'] = $cat3;
119			self::$term_ids[ $cat3 ] = 'category';
120
121			$cat4 = $factory->term->create( array( 'taxonomy' => 'category', 'name' => 'cat-a' ) );
122			self::$term_ids[ $cat4 ] = 'category';
123
124			$cat5 = $factory->term->create( array( 'taxonomy' => 'category', 'name' => 'cat-b' ) );
125			self::$term_ids[ $cat5 ] = 'category';
126
127			$tag1 = $factory->term->create( array( 'name' => 'post-formats' ) );
128			self::$term_ids[ $tag1 ] = 'post_tag';
129			}
130
131			/**
132			* Clean up shared fixtures.
133			*
134			* @since 4.1.0
135			*/
136			public static function delete_shared_fixtures() {
137			self::delete_user( self::$author_id );
138
139			foreach ( self::$post_ids as $pid ) {
140			wp_delete_post( $pid, true );
141			}
142
143			foreach ( self::$comment_ids as $cid ) {
144			wp_delete_comment( $cid, true );
145			}
146
147			foreach ( self::$term_ids as $tid => $tax ) {
148			wp_delete_term( $tid, $tax );
149			}
150
151			self::$author_id = null;
152			self::$post_ids = array();
153			self::$comment_ids = array();
154			self::$term_ids = array();
155			self::$terms = array();
156			}
157
158			/**
159			* Assert that a given URL is the same a the canonical URL generated by WP.
160			*
161			* @since 4.1.0
162			*
163			* @param string $test_url Raw URL that will be run through redirect_canonical().
164			* @param string $expected Expected string.
165			* @param int $ticket Optional. Trac ticket number.
166			* @param array $expected_doing_it_wrong Array of class/function names expected to throw _doing_it_wrong() notices.
167			*/
168			public function assertCanonical( $test_url, $expected, $ticket = 0, $expected_doing_it_wrong = array() ) {
169			$this->expected_doing_it_wrong = array_merge( $this->expected_doing_it_wrong, (array) $expected_doing_it_wrong );
170
171			if ( $ticket )
172			$this->knownWPBug( $ticket );
173
174			$ticket_ref = ($ticket > 0) ? 'Ticket #' . $ticket : null;
175			global $wpdb;
176			//print_r( $wpdb->get_results( "SELECT * FROM $wpdb->terms" ) );
			0 ignored issues – show Unused Code Comprehensibility introduced 2016-03-12 17:53 UTC by Report Bug Copy Issue Report `58%` of this comment could be valid code. Did you maybe forget this after debugging? Sometimes obsolete code just ends up commented out instead of removed. In this case it is better to remove the code once you have checked you do not need it. The code might also have been commented out for debugging purposes. In this case it is vital that someone uncomments it again or your project may behave in very unexpected ways in production. This check looks for comments that seem to be mostly valid code and reports them. Loading history...
177			if ( is_string($expected) )
178			$expected = array('url' => $expected);
179			elseif ( is_array($expected) && !isset($expected['url']) && !isset($expected['qv']) )
180			$expected = array( 'qv' => $expected );
181
182			if ( !isset($expected['url']) && !isset($expected['qv']) )
183			$this->markTestSkipped('No valid expected output was provided');
184
185			$this->go_to( home_url( $test_url ) );
186
187			// Does the redirect match what's expected?
188			$can_url = $this->get_canonical( $test_url );
189			$parsed_can_url = parse_url($can_url);
190
191			// Just test the Path and Query if present
192			if ( isset($expected['url']) ) {
193			$this->assertEquals( $expected['url'], $parsed_can_url['path'] . (!empty($parsed_can_url['query']) ? '?' . $parsed_can_url['query'] : ''), $ticket_ref );
194			}
195
196			if ( ! isset($expected['qv']) )
197			return;
198
199			// "make" that the request and check the query is correct
200			$this->go_to( $can_url );
201
202			// Are all query vars accounted for, And correct?
203			global $wp;
204
205			$query_vars = array_diff($wp->query_vars, $wp->extra_query_vars);
206			if ( !empty($parsed_can_url['query']) ) {
207			parse_str($parsed_can_url['query'], $_qv);
208
209			// $_qv should not contain any elements which are set in $query_vars already (ie. $_GET vars should not be present in the Rewrite)
210			$this->assertEquals( array(), array_intersect( $query_vars, $_qv ), 'Query vars are duplicated from the Rewrite into $_GET; ' . $ticket_ref );
211
212			$query_vars = array_merge($query_vars, $_qv);
213			}
214
215			$this->assertEquals( $expected['qv'], $query_vars );
216			}
217
218			/**
219			* Get the canonical URL given a raw URL.
220			*
221			* @param string $test_url Should be relative to the site "front", ie /category/uncategorized/
222			* as opposed to http://example.com/category/uncategorized/
223			* @return $can_url Returns the original $test_url if no canonical can be generated, otherwise returns
			0 ignored issues – show Documentation introduced 2016-03-12 17:52 UTC by Report Bug Copy Issue Report The doc-type `$can_url` could not be parsed: Unknown type name "$can_url" at position 0. (view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
224			* the fully-qualified URL as generated by redirect_canonical().
225			*/
226			public function get_canonical( $test_url ) {
227			$test_url = home_url( $test_url );
228
229			$can_url = redirect_canonical( $test_url, false );
230			if ( ! $can_url )
231			return $test_url; // No redirect will take place for this request
232
233			return $can_url;
234			}
235			}
236

GeoDirectory / geodirectory

Pull Request — master (#216)

WP_Canonical_UnitTestCase::assertCanonical() D

Complexity

Size

Duplication

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like