Updating the tests to assert better error messages

Author: mamazu

src/Validator/Php/PhpClassExistsValidator.php

@@ -14,7 +14,6 @@
 use PhpParser\Node\Stmt\UseUse;
 use PhpParser\Parser;
 use PhpParser\ParserFactory;
-use Webmozart\Assert\Assert;
 
 final class PhpClassExistsValidator implements ValidatorInterface
 {
@@ -47,7 +46,9 @@ public function validate(Block $block): array
 		$phpCode = $this->codeEnsurer->getPHPCode($block->getContent());
 		try {
 			$statements = $this->parser->parse($phpCode);
-			Assert::notNull($statements, 'The parsing of the php file failed.');
+			if ($statements === null) {
+				throw new \InvalidArgumentException('The parsing of the php file failed.');
+			}
 		} catch (\Throwable $exception) {
 			return $this->processSyntaxErrors($block, $exception->getMessage());
 		}

tests/Mamazu/DocumentationParser/FileListTest.php

@@ -35,9 +35,6 @@ public function testGetsAllValidFiles(): void
 		$this->fileList->addFile('vfs://workDir/test.php');
 		$this->fileList->addFile('vfs://workDir/bananas.php');
 
-		$this->expectWarning();
-		$this->expectWarningMessage('Could not find file: vfs://workDir/bananas.php');
-
 		$this->fileList->getAllValidFiles();
 	}
 

tests/Mamazu/DocumentationParser/Validator/Bash/BashValidatorTest.php

@@ -44,7 +44,6 @@ public function testValidatesABlockWithErrors(): void
 		$this->assertEquals(
 			[
 				new Error('test.sh', 11, 'unexpected EOF while looking for matching `"\'', 'bash'),
-				new Error('test.sh', 12, 'syntax error: unexpected end of file', 'bash'),
 			],
 			$this->bashValidator->validate($block)
 		);

tests/Mamazu/DocumentationParser/Validator/XML/XMLValidValidatorTest.php

@@ -50,8 +50,12 @@ public function testReturnsErrorsIfTheXmlIsInvalid(): void
 		$block->expects($this->atLeastOnce())->method('getFileName')->willReturn('abc.xml');
 		$block->expects($this->atLeastOnce())->method('getRelativeLineNumber')->willReturn(10);
 		$result = $this->xMLValidValidator->validate($block);
-		$this->assertIsIterable($result);
-		$this->assertCount(4, $result);
+
+		$expectedOutput = [
+			'[xml] error parsing attribute name',
+			"[xml] Couldn't find end of Start Tag Hello line 2",
+		];
+		$this->assertErrorMessages($expectedOutput, $result);
 	}
 
 	public function testValidatesConsecutiveBlocksCorrectly(): void
@@ -69,13 +73,25 @@ public function testValidatesConsecutiveBlocksCorrectly(): void
 		$block->expects($this->atLeastOnce())->method('getFileName')->willReturn('abc.xml');
 		$block->expects($this->atLeastOnce())->method('getRelativeLineNumber')->willReturn(10);
 		$result = $this->xMLValidValidator->validate($block);
-		$this->assertIsIterable($result);
-		$this->assertCount(4, $result);
+
+		$expectedOutput = [
+			'[xml] error parsing attribute name',
+			"[xml] Couldn't find end of Start Tag Hello line 2",
+		];
+		$this->assertErrorMessages($expectedOutput, $result);
 		$block2->expects($this->atLeastOnce())->method('getContent')->willReturn('
 <Hello>
     This is text
 </Hello>
 ');
 		$this->assertCount(0, $this->xMLValidValidator->validate($block2));
 	}
+
+	private function assertErrorMessages(array $errorMessages, iterable $result): void
+	{
+		foreach ($result as $index => $error) {
+			$this->assertSame($errorMessages[$index] ?? null, $error->getMessage());
+		}
+		$this->assertCount(count($errorMessages), $result);
+	}
 }