Reject malformed parsed file entries

Author: adamziel

lib/class-command.php

@@ -68,6 +68,35 @@ public function import( $args, $assoc_args ) {
 		}
 		preserve_json_object_shapes( $phpdoc );
 
+		// The importer dereferences these fields before it can report malformed
+		// input. Validate the file envelope here so bad JSON data produces one
+		// actionable CLI error instead of array-offset warnings or a type error.
+		foreach ( $phpdoc as $index => $parsed_file ) {
+			if (
+				! is_array( $parsed_file ) ||
+				! isset( $parsed_file['path'] ) ||
+				! is_string( $parsed_file['path'] ) ||
+				'' === $parsed_file['path'] ||
+				! isset( $parsed_file['file'] ) ||
+				! is_array( $parsed_file['file'] ) ||
+				! isset( $parsed_file['file']['description'] ) ||
+				! is_string( $parsed_file['file']['description'] ) ||
+				! isset( $parsed_file['file']['long_description'] ) ||
+				! is_string( $parsed_file['file']['long_description'] ) ||
+				! isset( $parsed_file['file']['tags'] ) ||
+				! is_array( $parsed_file['file']['tags'] )
+			) {
+				WP_CLI::error(
+					sprintf(
+						'JSON in %1$s entry %2$d must contain a parsed file object with a path and file metadata.',
+						$file,
+						$index + 1
+					)
+				);
+				exit;
+			}
+		}
+
 		// Import data
 		$this->_do_import( $phpdoc, isset( $assoc_args['quick'] ), isset( $assoc_args['import-internal'] ) );
 	}

tests/phpunit/tests/import/command.php

@@ -52,6 +52,39 @@ public function test_import_rejects_malformed_json() {
 		$command->import( array( $file ), array() );
 	}
 
+	/**
+	 * @dataProvider invalid_file_entries
+	 */
+	public function test_import_rejects_invalid_file_entries( $json ) {
+		$file = $this->write_json_file( $json );
+
+		$this->expectException( RuntimeException::class );
+		$this->expectExceptionMessage( 'entry 1 must contain a parsed file object with a path and file metadata' );
+
+		$command = new Command_Import_Test_Command;
+		$command->import( array( $file ), array() );
+	}
+
+	public function invalid_file_entries() {
+		return array(
+			'null' => array( '[null]' ),
+			'number' => array( '[42]' ),
+			'string' => array( '["parsed file"]' ),
+			'list' => array( '[[]]' ),
+			'empty object' => array( '[{}]' ),
+			'missing file metadata' => array( '[{"path":"example.php"}]' ),
+			'non-string path' => array( '[{"path":42,"file":{"description":"","long_description":"","tags":[]}}]' ),
+			'empty path' => array( '[{"path":"","file":{"description":"","long_description":"","tags":[]}}]' ),
+			'non-object file metadata' => array( '[{"path":"example.php","file":[]}]' ),
+			'missing description' => array( '[{"path":"example.php","file":{"long_description":"","tags":[]}}]' ),
+			'non-string description' => array( '[{"path":"example.php","file":{"description":42,"long_description":"","tags":[]}}]' ),
+			'missing long description' => array( '[{"path":"example.php","file":{"description":"","tags":[]}}]' ),
+			'non-string long description' => array( '[{"path":"example.php","file":{"description":"","long_description":42,"tags":[]}}]' ),
+			'missing tags' => array( '[{"path":"example.php","file":{"description":"","long_description":""}}]' ),
+			'non-list tags' => array( '[{"path":"example.php","file":{"description":"","long_description":"","tags":42}}]' ),
+		);
+	}
+
 	public function test_import_accepts_a_top_level_file_list() {
 		$file    = $this->write_json_file( '[]' );
 		$command = new Command_Import_Test_Command;
@@ -61,6 +94,28 @@ public function test_import_accepts_a_top_level_file_list() {
 		$this->assertSame( array(), $command->imported_data );
 	}
 
+	public function test_import_accepts_a_parsed_file_entry() {
+		$file    = $this->write_json_file( '[{"file":{"description":"","long_description":"","tags":[]},"path":"example.php","root":"/tmp"}]' );
+		$command = new Command_Import_Test_Command;
+
+		$command->import( array( $file ), array() );
+
+		$this->assertSame(
+			array(
+				array(
+					'file' => array(
+						'description' => '',
+						'long_description' => '',
+						'tags' => array(),
+					),
+					'path' => 'example.php',
+					'root' => '/tmp',
+				),
+			),
+			$command->imported_data
+		);
+	}
+
 	private function write_json_file( $json ) {
 		$file = tempnam( sys_get_temp_dir(), 'phpdoc-parser-' );
 		file_put_contents( $file, $json );