Build/Test Tools: Add assertions that test the tests.

Several tests perform assertions conditionally or iterate dynamic arrays without ensuring they're populated. If the test is faulty and the condition never evaluates to true, or the array being iterated is unexpectedly empty, this will now correctly cause the test to fail.

Props johnbillion, jrf.

See #63167

git-svn-id: https://develop.svn.wordpress.org/trunk@60251 602fd350-edb4-49c9-b593-d223f7449a82

Author: johnbillion

tests/phpunit/tests/comment.php

@@ -1566,6 +1566,8 @@ public function test_wp_get_comment_fields_max_lengths() {
 
 		$lengths = wp_get_comment_fields_max_lengths();
 
+		$this->assertNotEmpty( $lengths );
+
 		foreach ( $lengths as $field => $length ) {
 			$this->assertSame( $expected[ $field ], $length );
 		}

tests/phpunit/tests/comment/commentsTemplate.php

@@ -566,6 +566,9 @@ public function test_comment_permalinks_should_be_correct_when_using_default_dis
 		// Find the comment permalinks.
 		preg_match_all( '|href="(.*?#comment-([0-9]+))|', $found_p1, $matches );
 
+		$this->assertNotEmpty( $matches );
+		$this->assertNotEmpty( $matches[1] );
+
 		// This is the main post page, so we don't expect any cpage param.
 		foreach ( $matches[1] as $m ) {
 			$this->assertStringNotContainsString( 'cpage', $m );
@@ -586,6 +589,9 @@ public function test_comment_permalinks_should_be_correct_when_using_default_dis
 		// Find the comment permalinks.
 		preg_match_all( '|href="(.*?#comment-([0-9]+))|', $found_p2, $matches );
 
+		$this->assertNotEmpty( $matches );
+		$this->assertNotEmpty( $matches[1] );
+
 		// They should all be on page 2.
 		foreach ( $matches[1] as $m ) {
 			$this->assertStringContainsString( 'cpage=2', $m );
@@ -659,6 +665,9 @@ public function test_comment_permalinks_should_be_correct_when_using_default_dis
 		// Find the comment permalinks.
 		preg_match_all( '|href="(.*?#comment-([0-9]+))|', $found_p0, $matches );
 
+		$this->assertNotEmpty( $matches );
+		$this->assertNotEmpty( $matches[1] );
+
 		foreach ( $matches[1] as $m ) {
 			$this->assertStringContainsString( 'cpage=3', $m );
 		}
@@ -678,6 +687,9 @@ public function test_comment_permalinks_should_be_correct_when_using_default_dis
 		// Find the comment permalinks.
 		preg_match_all( '|href="(.*?#comment-([0-9]+))|', $found_p2, $matches );
 
+		$this->assertNotEmpty( $matches );
+		$this->assertNotEmpty( $matches[1] );
+
 		// They should all be on page 2.
 		foreach ( $matches[1] as $m ) {
 			$this->assertStringContainsString( 'cpage=2', $m );
@@ -699,6 +711,9 @@ public function test_comment_permalinks_should_be_correct_when_using_default_dis
 		// Find the comment permalinks.
 		preg_match_all( '|href="(.*?#comment-([0-9]+))|', $found_p1, $matches );
 
+		$this->assertNotEmpty( $matches );
+		$this->assertNotEmpty( $matches[1] );
+
 		// They should all be on page 2.
 		foreach ( $matches[1] as $m ) {
 			$this->assertStringContainsString( 'cpage=1', $m );

tests/phpunit/tests/comment/metaCache.php

@@ -195,23 +195,23 @@ public function test_comment_meta_should_be_lazy_loaded_for_all_comments_in_comm
 
 		$this->go_to( get_permalink( $p ) );
 
-		if ( have_posts() ) {
-			while ( have_posts() ) {
-				the_post();
-
-				// Load comments with `comments_template()`.
-				$cform = get_echo( 'comments_template' );
-
-				// First request will hit the database.
-				$num_queries = get_num_queries();
-				get_comment_meta( $comment_ids[0], 'sauce' );
-				$this->assertSame( 1, get_num_queries() - $num_queries );
-
-				// Second and third requests should be in cache.
-				get_comment_meta( $comment_ids[1], 'sauce' );
-				get_comment_meta( $comment_ids[2], 'sauce' );
-				$this->assertSame( 1, get_num_queries() - $num_queries );
-			}
+		$this->assertTrue( have_posts() );
+
+		while ( have_posts() ) {
+			the_post();
+
+			// Load comments with `comments_template()`.
+			$cform = get_echo( 'comments_template' );
+
+			// First request will hit the database.
+			$num_queries = get_num_queries();
+			get_comment_meta( $comment_ids[0], 'sauce' );
+			$this->assertSame( 1, get_num_queries() - $num_queries );
+
+			// Second and third requests should be in cache.
+			get_comment_meta( $comment_ids[1], 'sauce' );
+			get_comment_meta( $comment_ids[2], 'sauce' );
+			$this->assertSame( 1, get_num_queries() - $num_queries );
 		}
 	}
 

tests/phpunit/tests/customize/nav-menus.php

@@ -766,25 +766,27 @@ public function test_available_items_template() {
 		$this->assertStringContainsString( $expected, $template );
 
 		$post_types = get_post_types( array( 'show_in_nav_menus' => true ), 'object' );
-		if ( $post_types ) {
-			foreach ( $post_types as $type ) {
-				$this->assertStringContainsString( 'available-menu-items-post_type-' . esc_attr( $type->name ), $template );
-				$this->assertMatchesRegularExpression( '#<h4 class="accordion-section-title".*>\s*<button type="button" class="accordion-trigger" aria-expanded="false" aria-controls=".*">\s*' . esc_html( $type->labels->name ) . '#', $template );
-				$this->assertStringContainsString( 'data-type="post_type"', $template );
-				$this->assertStringContainsString( 'data-object="' . esc_attr( $type->name ) . '"', $template );
-				$this->assertStringContainsString( 'data-type_label="' . esc_attr( $type->labels->singular_name ) . '"', $template );
-			}
+
+		$this->assertNotEmpty( $post_types );
+
+		foreach ( $post_types as $type ) {
+			$this->assertStringContainsString( 'available-menu-items-post_type-' . esc_attr( $type->name ), $template );
+			$this->assertMatchesRegularExpression( '#<h4 class="accordion-section-title".*>\s*<button type="button" class="accordion-trigger" aria-expanded="false" aria-controls=".*">\s*' . esc_html( $type->labels->name ) . '#', $template );
+			$this->assertStringContainsString( 'data-type="post_type"', $template );
+			$this->assertStringContainsString( 'data-object="' . esc_attr( $type->name ) . '"', $template );
+			$this->assertStringContainsString( 'data-type_label="' . esc_attr( $type->labels->singular_name ) . '"', $template );
 		}
 
 		$taxonomies = get_taxonomies( array( 'show_in_nav_menus' => true ), 'object' );
-		if ( $taxonomies ) {
-			foreach ( $taxonomies as $tax ) {
-				$this->assertStringContainsString( 'available-menu-items-taxonomy-' . esc_attr( $tax->name ), $template );
-				$this->assertMatchesRegularExpression( '#<h4 class="accordion-section-title".*>\s*<button type="button" class="accordion-trigger" aria-expanded="false" aria-controls=".*">\s*' . esc_html( $tax->labels->name ) . '#', $template );
-				$this->assertStringContainsString( 'data-type="taxonomy"', $template );
-				$this->assertStringContainsString( 'data-object="' . esc_attr( $tax->name ) . '"', $template );
-				$this->assertStringContainsString( 'data-type_label="' . esc_attr( $tax->labels->singular_name ) . '"', $template );
-			}
+
+		$this->assertNotEmpty( $taxonomies );
+
+		foreach ( $taxonomies as $tax ) {
+			$this->assertStringContainsString( 'available-menu-items-taxonomy-' . esc_attr( $tax->name ), $template );
+			$this->assertMatchesRegularExpression( '#<h4 class="accordion-section-title".*>\s*<button type="button" class="accordion-trigger" aria-expanded="false" aria-controls=".*">\s*' . esc_html( $tax->labels->name ) . '#', $template );
+			$this->assertStringContainsString( 'data-type="taxonomy"', $template );
+			$this->assertStringContainsString( 'data-object="' . esc_attr( $tax->name ) . '"', $template );
+			$this->assertStringContainsString( 'data-type_label="' . esc_attr( $tax->labels->singular_name ) . '"', $template );
 		}
 
 		$this->assertStringContainsString( 'available-menu-items-custom_type', $template );

tests/phpunit/tests/db/charset.php

@@ -829,6 +829,8 @@ public function test_get_column_charset( $drop, $create, $table, $expected_chars
 		self::$_wpdb->query( $drop );
 		self::$_wpdb->query( $create );
 
+		$this->assertNotEmpty( $expected_charset );
+
 		foreach ( $expected_charset as $column => $charset ) {
 			if ( self::$utf8_is_utf8mb3 && 'utf8' === $charset ) {
 				$charset = 'utf8mb3';
@@ -854,6 +856,8 @@ public function test_get_column_charset_non_mysql( $drop, $create, $table, $colu
 
 		self::$_wpdb->query( $create );
 
+		$this->assertNotEmpty( $columns );
+
 		$columns = array_keys( $columns );
 		foreach ( $columns as $column => $charset ) {
 			$this->assertFalse( self::$_wpdb->get_col_charset( $table, $column ) );
@@ -877,6 +881,8 @@ public function test_get_column_charset_is_mysql_undefined( $drop, $create, $tab
 
 		self::$_wpdb->query( $create );
 
+		$this->assertNotEmpty( $columns );
+
 		$columns = array_keys( $columns );
 		foreach ( $columns as $column => $charset ) {
 			$this->assertFalse( self::$_wpdb->get_col_charset( $table, $column ) );
@@ -1070,6 +1076,8 @@ public function test_table_collation_check( $create, $expected, $query, $drop, $
 			)
 		);
 
+		$this->assertNotEmpty( $always_true );
+
 		foreach ( $always_true as $true_query ) {
 			$return = self::$_wpdb->check_safe_collation( $true_query );
 			$this->assertTrue(

tests/phpunit/tests/feed/atom.php

@@ -279,6 +279,8 @@ public function test_atom_enclosure_with_extended_url_length_type_parsing() {
 		$entries = xml_find( $xml, 'feed', 'entry' );
 		$entries = array_slice( $entries, 0, 1 );
 
+		$this->assertNotEmpty( $entries );
+
 		foreach ( $entries as $key => $entry ) {
 			$links = xml_find( $entries[ $key ]['child'], 'link' );
 			$i     = 0;

tests/phpunit/tests/feed/rss2.php

@@ -289,6 +289,8 @@ public function test_items_comments_closed() {
 		// Get all the rss -> channel -> item elements.
 		$items = xml_find( $xml, 'rss', 'channel', 'item' );
 
+		$this->assertNotEmpty( $items );
+
 		// Check each of the items against the known post data.
 		foreach ( $items as $key => $item ) {
 			// Get post for comparison.

tests/phpunit/tests/file.php

@@ -40,6 +40,8 @@ public function test_get_file_data() {
 			'AuthorURI'   => 'http://binarybonsai.com/',
 		);
 
+		$this->assertNotEmpty( $actual );
+
 		foreach ( $actual as $header => $value ) {
 			$this->assertSame( $expected[ $header ], $value, $header );
 		}
@@ -64,6 +66,8 @@ public function test_get_file_data_with_cr_line_endings() {
 			'Author'      => 'A Very Old Mac',
 		);
 
+		$this->assertNotEmpty( $actual );
+
 		foreach ( $actual as $header => $value ) {
 			$this->assertSame( $expected[ $header ], $value, $header );
 		}
@@ -84,6 +88,8 @@ public function test_get_file_data_with_php_open_tag_prefix() {
 			'TemplateName' => 'Something',
 		);
 
+		$this->assertNotEmpty( $actual );
+
 		foreach ( $actual as $header => $value ) {
 			$this->assertSame( $expected[ $header ], $value, $header );
 		}

tests/phpunit/tests/formatting/escUrl.php

@@ -124,7 +124,11 @@ public function test_protocol() {
 			)
 		);
 
-		foreach ( wp_allowed_protocols() as $scheme ) {
+		$protocols = wp_allowed_protocols();
+
+		$this->assertNotEmpty( $protocols );
+
+		foreach ( $protocols as $scheme ) {
 			$this->assertSame( "{$scheme}://example.com", esc_url( "{$scheme}://example.com" ), $scheme );
 			$this->assertSame(
 				"{$scheme}://example.com",

tests/phpunit/tests/formatting/sanitizePost.php

@@ -29,6 +29,9 @@ public function test_int_fields() {
 				case 'string':
 					$this->assertIsString( $post->$field, "field $field" );
 					break;
+				default:
+					$this->fail( "Type $type is not handled by this test." );
+					break;
 			}
 		}
 	}