Adds a flag to allow showing the source of the message (#70)

* Adds a flag to allow showing the source of the message

* Tests --prepend-source flag

* Update composer.json

Co-authored-by: Markus Staab <maggus.staab@googlemail.com>

Author: donatj

cs2pr

@@ -22,6 +22,7 @@ $version = '1.5.1-dev';
 $colorize = false;
 $gracefulWarnings = false;
 $noticeAsWarning = false;
+$prependSource = false;
 
 // parameters
 $params = array();
@@ -35,6 +36,9 @@ foreach ($argv as $arg) {
         case 'colorize':
             $colorize = true;
             break;
+        case 'prepend-source':
+            $prependSource = true;
+            break;
         case 'notices-as-warnings':
             $noticeAsWarning = true;
             break;
@@ -60,6 +64,7 @@ if (count($params) === 1) {
     echo "  --graceful-warnings   Don't exit with error codes if there are only warnings.\n";
     echo "  --colorize            Colorize the output (still compatible with Github Annotations)\n";
     echo "  --notices-as-warnings Convert notices to warnings (Github does not annotate notices otherwise).\n";
+    echo "  --prepend-source      Prepend error 'source' attribute to the message.\n";
     exit(9);
 }
 
@@ -91,6 +96,11 @@ foreach ($root as $file) {
         $type = (string) $error['severity'];
         $line = (string) $error['line'];
         $message = (string) $error['message'];
+        $source = isset($error['source']) ? (string) $error['source'] : null;
+
+        if ($prependSource && $source) {
+            $message = $source.': '.$message;
+        }
 
         $annotateType = annotateType($type, $noticeAsWarning);
         annotateCheck($annotateType, relativePath($filename), $line, $message, $colorize);

tests/errors/mixed-source-attributes.expect

@@ -0,0 +1,7 @@
+::error file=test/phpunit/Traits/BuildingPermissionIdAwareTraitTest.php,line=13::PhanUndeclaredMethod: Call to undeclared method \PHPUnit\Framework\MockObject\MockObject::getPermissionIds
+::warning file=test/phpunit/Utils/Cidr/MultiCidrMatchTest.php,line=12::PhanUndeclaredClassReference: Reference to undeclared class \CIDRmatch\CIDRmatch
+::warning file=test/phpunit/Utils/Cidr/MultiCidrMatchTest.php,line=21::PhanTypeMismatchArgument: Argument 2 ($CIDRmatch) is $cidr of type \PHPUnit\Framework\MockObject\MockObject|\PHPUnit_Framework_MockObject_MockObject but \Utils\Cidr\MultiCidrMatch::__construct() takes \CIDRmatch\CIDRmatch defined at application/classes/Utils/Cidr/MultiCidrMatch.php:20
+::warning file=test/phpunit/Utils/Cidr/MultiCidrMatchTest.php,line=28::PhanUndeclaredClassReference: Reference to undeclared class \CIDRmatch\CIDRmatch
+::warning file=test/phpunit/Utils/Cidr/MultiCidrMatchTest.php,line=38::PhanTypeMismatchArgument: Argument 2 ($CIDRmatch) is $cidr of type \PHPUnit\Framework\MockObject\MockObject|\PHPUnit_Framework_MockObject_MockObject but \Utils\Cidr\MultiCidrMatch::__construct() takes \CIDRmatch\CIDRmatch defined at application/classes/Utils/Cidr/MultiCidrMatch.php:20
+::error file=test/phpunit/Utils/Cidr/MultiCidrMatchTest.php,line=54::Call to undeclared method \PHPUnit\Framework\MockObject\MockObject::matchAny
+::error file=test/phpunit/Utils/Cidr/MultiCidrMatchTest.php,line=69::Call to undeclared method \PHPUnit\Framework\MockObject\MockObject::matchAny

tests/errors/mixed-source-attributes.xml

@@ -0,0 +1,14 @@
+<?xml version="1.0" encoding="ISO-8859-15"?>
+<checkstyle version="6.5">
+  <file name="test/phpunit/Traits/BuildingPermissionIdAwareTraitTest.php">
+    <error line="13" severity="error" message="Call to undeclared method \PHPUnit\Framework\MockObject\MockObject::getPermissionIds" source="PhanUndeclaredMethod"/>
+  </file>
+  <file name="test/phpunit/Utils/Cidr/MultiCidrMatchTest.php">
+    <error line="12" severity="warning" message="Reference to undeclared class \CIDRmatch\CIDRmatch" source="PhanUndeclaredClassReference"/>
+    <error line="21" severity="warning" message="Argument 2 ($CIDRmatch) is $cidr of type \PHPUnit\Framework\MockObject\MockObject|\PHPUnit_Framework_MockObject_MockObject but \Utils\Cidr\MultiCidrMatch::__construct() takes \CIDRmatch\CIDRmatch defined at application/classes/Utils/Cidr/MultiCidrMatch.php:20" source="PhanTypeMismatchArgument"/>
+    <error line="28" severity="warning" message="Reference to undeclared class \CIDRmatch\CIDRmatch" source="PhanUndeclaredClassReference"/>
+    <error line="38" severity="warning" message="Argument 2 ($CIDRmatch) is $cidr of type \PHPUnit\Framework\MockObject\MockObject|\PHPUnit_Framework_MockObject_MockObject but \Utils\Cidr\MultiCidrMatch::__construct() takes \CIDRmatch\CIDRmatch defined at application/classes/Utils/Cidr/MultiCidrMatch.php:20" source="PhanTypeMismatchArgument"/>
+    <error line="54" severity="error" message="Call to undeclared method \PHPUnit\Framework\MockObject\MockObject::matchAny"/>
+    <error line="69" severity="error" message="Call to undeclared method \PHPUnit\Framework\MockObject\MockObject::matchAny"/>
+  </file>
+</checkstyle>

tests/tests.php

@@ -52,6 +52,8 @@ function testXml($xmlPath, $expectedExit, $expectedOutput = null, $options = '')
 testXml(__DIR__.'/errors/notices.xml', 1, file_get_contents(__DIR__.'/errors/notices.expect'));
 testXml(__DIR__.'/errors/notices.xml', 1, file_get_contents(__DIR__.'/errors/notices-as-warnings.expect'), '--notices-as-warnings');
 
+testXml(__DIR__.'/errors/mixed-source-attributes.xml', 1, file_get_contents(__DIR__.'/errors/mixed-source-attributes.expect'), '--prepend-source');
+
 testXml(__DIR__.'/errors/mixed.xml', 1, file_get_contents(__DIR__.'/errors/mixed-colors.expect'), '--colorize');
 
 testXml(__DIR__.'/noerrors/only-header.xml', 0, file_get_contents(__DIR__.'/noerrors/only-header.expect'));