Merge pull request #625 from WordPress/623-different-names

Add warning for mismatched plugin name

includes/Checker/Checks/Plugin_Repo/Plugin_Readme_Check.php

@@ -143,6 +143,27 @@ private function check_name( Check_Result $result, string $readme_file, Parser $
 				'https://developer.wordpress.org/plugins/wordpress-org/common-issues/#incomplete-readme',
 				9
 			);
+		} else {
+			$plugin_data = get_plugin_data( $result->plugin()->main_file() );
+
+			if ( $parser->name !== $plugin_data['Name'] ) {
+				$this->add_result_warning_for_file(
+					$result,
+					sprintf(
+						/* translators: 1: Plugin name, 2: Name in plugin header */
+						__( 'Plugin name "%1$s" is different from the name declared in plugin header "%2$s".', 'plugin-check' ),
+						$parser->name,
+						$plugin_data['Name']
+					),
+					'mismatched_plugin_name',
+					$readme_file,
+					0,
+					0,
+					'https://developer.wordpress.org/plugins/wordpress-org/common-issues/#incomplete-readme',
+					7
+				);
+
+			}
 		}
 	}
 

tests/phpunit/testdata/plugins/test-plugin-plugin-readme-multiple-parser-warnings/load.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Plugin Name: Test Plugin Readme Errors (Multiple Parser Warnings)
+ * Plugin Name: Test Plugin Readme Errors Multiple Parser Warnings
  * Plugin URI: https://github.com/WordPress/plugin-check
  * Description: Test plugin for the Readme check.
  * Requires at least: 6.0

tests/phpunit/testdata/plugins/test-plugin-plugin-readme-parser-warnings/load.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Plugin Name: Test Plugin Readme Errors (Parser Warnings)
+ * Plugin Name: Test Plugin Readme Errors Parser Warnings
  * Plugin URI: https://github.com/WordPress/plugin-check
  * Description: Test plugin for the Readme check.
  * Requires at least: 6.0

tests/phpunit/tests/Checker/Checks/Plugin_Readme_Check_Tests.php

@@ -97,13 +97,9 @@ public function test_run_with_errors_default_text() {
 
 		$this->assertNotEmpty( $warnings );
 		$this->assertArrayHasKey( 'readme.txt', $warnings );
-		$this->assertEquals( 1, $check_result->get_warning_count() );
 
 		// Check for default text file warning.
-		$this->assertArrayHasKey( 0, $warnings['readme.txt'] );
-		$this->assertArrayHasKey( 0, $warnings['readme.txt'][0] );
-		$this->assertArrayHasKey( 'code', $warnings['readme.txt'][0][0][0] );
-		$this->assertEquals( 'default_readme_text', $warnings['readme.txt'][0][0][0]['code'] );
+		$this->assertCount( 1, wp_list_filter( $warnings['readme.txt'][0][0], array( 'code' => 'default_readme_text' ) ) );
 	}
 
 	public function test_run_with_errors_stable_tag() {
@@ -224,6 +220,7 @@ public function test_run_md_with_errors() {
 		$this->assertCount( 1, wp_list_filter( $warnings['readme.md'][0][0], array( 'code' => 'default_readme_text' ) ) );
 		$this->assertCount( 1, wp_list_filter( $warnings['readme.md'][0][0], array( 'code' => 'invalid_license' ) ) );
 		$this->assertCount( 1, wp_list_filter( $warnings['readme.md'][0][0], array( 'code' => 'license_mismatch' ) ) );
+		$this->assertCount( 1, wp_list_filter( $warnings['readme.md'][0][0], array( 'code' => 'mismatched_plugin_name' ) ) );
 	}
 
 	public function test_single_file_plugin_without_error_for_trademarks() {
@@ -253,13 +250,9 @@ public function test_run_with_errors_parser_warnings() {
 
 		$this->assertNotEmpty( $warnings );
 		$this->assertArrayHasKey( 'readme.txt', $warnings );
-		$this->assertSame( 1, $check_result->get_warning_count() );
 
 		// Check for parser warning.
-		$this->assertArrayHasKey( 0, $warnings['readme.txt'] );
-		$this->assertArrayHasKey( 0, $warnings['readme.txt'][0] );
-		$this->assertArrayHasKey( 'code', $warnings['readme.txt'][0][0][0] );
-		$this->assertSame( 'readme_parser_warnings_tested_header_ignored', $warnings['readme.txt'][0][0][0]['code'] );
+		$this->assertCount( 1, wp_list_filter( $warnings['readme.txt'][0][0], array( 'code' => 'readme_parser_warnings_tested_header_ignored' ) ) );
 	}
 
 	public function test_run_with_errors_multiple_parser_warnings() {
@@ -302,19 +295,18 @@ public function test_run_with_errors_parser_warnings_with_custom_set_transient_v
 
 		$readme_check->run( $check_result );
 
-		$errors   = $check_result->get_errors();
 		$warnings = $check_result->get_warnings();
 
-		$this->assertEmpty( $errors );
 		$this->assertNotEmpty( $warnings );
-		$this->assertSame( 0, $check_result->get_error_count() );
-		$this->assertSame( 1, $check_result->get_warning_count() );
+		$this->assertArrayHasKey( 'readme.txt', $warnings );
 
-		$this->assertArrayHasKey( 0, $warnings['readme.txt'] );
-		$this->assertArrayHasKey( 0, $warnings['readme.txt'][0] );
-		$this->assertArrayHasKey( 'code', $warnings['readme.txt'][0][0][0] );
-		$this->assertSame( 'readme_parser_warnings_tested_header_ignored', $warnings['readme.txt'][0][0][0]['code'] );
-		$this->assertStringContainsString( 'The "Tested up to" field was ignored. This field should only contain a valid WordPress version such as "' . $version . '"', $warnings['readme.txt'][0][0][0]['message'] );
+		$filtered_items = wp_list_filter( $warnings['readme.txt'][0][0], array( 'code' => 'readme_parser_warnings_tested_header_ignored' ) );
+
+		$this->assertCount( 1, $filtered_items );
+
+		$filtered_items = array_values( $filtered_items );
+
+		$this->assertStringContainsString( 'The "Tested up to" field was ignored. This field should only contain a valid WordPress version such as "' . $version . '"', $filtered_items[0]['message'] );
 
 		delete_transient( 'wp_plugin_check_latest_wp_version' );
 	}
@@ -423,15 +415,9 @@ public function test_run_with_errors_upgrade_notice() {
 
 		$this->assertNotEmpty( $warnings );
 		$this->assertArrayHasKey( 'readme.txt', $warnings );
-		$this->assertEquals( 2, $check_result->get_warning_count() );
 
 		// Check for upgrade notices.
-		$this->assertArrayHasKey( 0, $warnings['readme.txt'] );
-		$this->assertArrayHasKey( 0, $warnings['readme.txt'][0] );
-		$this->assertArrayHasKey( 'code', $warnings['readme.txt'][0][0][0] );
-		$this->assertEquals( 'upgrade_notice_limit', $warnings['readme.txt'][0][0][0]['code'] );
-		$this->assertArrayHasKey( 'code', $warnings['readme.txt'][0][0][1] );
-		$this->assertEquals( 'upgrade_notice_limit', $warnings['readme.txt'][0][0][1]['code'] );
+		$this->assertCount( 2, wp_list_filter( $warnings['readme.txt'][0][0], array( 'code' => 'upgrade_notice_limit' ) ) );
 	}
 
 	public function test_run_with_errors_tested_up_to_latest_plus_two_version() {