add options gracefulWarnings and colorize (#33)

* add options gracefulWarnings and colorize

* Apply suggestions from code review

Co-Authored-By: Markus Staab <[email protected]>

* fix phpdoc, add tests

* check annotateType instead of type

Co-authored-by: Markus Staab <[email protected]>

Author: korelstar

cs2pr

@@ -18,14 +18,43 @@ gc_disable();
 
 $version = '1.0.6-dev';
 
-if ($argc === 1) {
+// options
+$colorize = false;
+$gracefulWarnings = false;
+
+// parameters
+$params = [];
+foreach ($argv as $arg) {
+    if (substr($arg, 0, 2) === '--') {
+        $option = substr($arg, 2);
+        switch ($option) {
+        case 'graceful-warnings':
+            $gracefulWarnings = true;
+            break;
+        case 'colorize':
+            $colorize = true;
+            break;
+        default:
+            echo "Unknown option ".$option."\n";
+            exit(9);
+        }
+    } else {
+        $params[] = $arg;
+    }
+}
+
+if (count($params) === 1) {
     $xml = stream_get_contents(STDIN);
-} elseif ($argc === 2 && file_exists($argv[1])) {
-    $xml = file_get_contents($argv[1]);
+} elseif (count($params) === 2 && file_exists($params[1])) {
+    $xml = file_get_contents($params[1]);
 } else {
     echo "cs2pr $version\n";
     echo "Annotate a Github Pull Request based on a Checkstyle XML-report.\n";
-    echo "Usage: ". $argv[0] ." <filename>\n";
+    echo "Usage: ". $params[0] ." [OPTION]... <filename>\n";
+    echo "\n";
+    echo "Supported options:\n";
+    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";
     exit(9);
 }
 
@@ -58,8 +87,12 @@ foreach ($root as $file) {
         $line = (string) $error['line'];
         $message = (string) $error['message'];
 
-        annotateCheck(annotateType($type), relativePath($filename), $line, $message);
-        $exit = 1;
+        $annotateType = annotateType($type);
+        annotateCheck($annotateType, relativePath($filename), $line, $message, $colorize);
+
+        if (!$gracefulWarnings || $annotateType === 'error') {
+            $exit = 1;
+        }
     }
 }
 
@@ -70,10 +103,17 @@ exit($exit);
  * @param string $filename
  * @param int $line
  * @param string $message
+ * @param boolean $colorize
  */
-function annotateCheck($type, $filename, $line, $message)
+function annotateCheck($type, $filename, $line, $message, $colorize)
 {
+    if ($colorize) {
+        echo "\033[".($type==='error' ? '91' : '93')."m\n";
+    }
     echo "::{$type} file={$filename},line={$line}::{$message}\n";
+    if ($colorize) {
+        echo "\033[0m";
+    }
 }
 
 function relativePath($path)

tests/errors/mixed-colors.expect

@@ -0,0 +1,7 @@
+
+::error file=redaxo\src\addons\2factor_auth\boot.php,line=6::Call to static method getInstance() on an unknown class rex_one_time_password.
+
+::warning file=redaxo\src\addons\2factor_auth\boot.php,line=9::Call to static method getInstance() on an unknown class rex_minibar.
+
+::error file=redaxo\src\addons\2factor_auth\lib\one_time_password.php,line=0::Class rex_one_time_password was not found while trying to analyse it - autoloading is probably not configured properly.
+

tests/errors/mixed.expect

@@ -0,0 +1,3 @@
+::error file=redaxo\src\addons\2factor_auth\boot.php,line=6::Call to static method getInstance() on an unknown class rex_one_time_password.
+::warning file=redaxo\src\addons\2factor_auth\boot.php,line=9::Call to static method getInstance() on an unknown class rex_minibar.
+::error file=redaxo\src\addons\2factor_auth\lib\one_time_password.php,line=0::Class rex_one_time_password was not found while trying to analyse it - autoloading is probably not configured properly.

tests/errors/mixed.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<checkstyle>
+    <file name="redaxo\src\addons\2factor_auth\boot.php">
+        <error line="6" column="1" severity="failure" message="Call to static method getInstance() on an unknown class rex_one_time_password." />
+        <error line="9" column="1" severity="warning" message="Call to static method getInstance() on an unknown class rex_minibar." />
+    </file>
+    <file name="redaxo\src\addons\2factor_auth\lib\one_time_password.php">
+        <error line="0" column="1" severity="failure" message="Class rex_one_time_password was not found while trying to analyse it - autoloading is probably not configured properly." />
+    </file>
+</checkstyle>

tests/errors/warning-only.expect

@@ -0,0 +1,3 @@
+::warning file=redaxo/src/addons/2factor_auth/boot.php,line=6::Call to static method getInstance() on an unknown class rex_one_time_password.
+::warning file=redaxo/src/addons/2factor_auth/boot.php,line=9::Call to static method getInstance() on an unknown class rex_minibar.
+::warning file=redaxo/src/addons/2factor_auth/lib/one_time_password.php,line=0::Class rex_one_time_password was not found while trying to analyse it - autoloading is probably not configured properly.

tests/errors/warning-only.xml

@@ -0,0 +1,10 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<checkstyle>
+    <file name="redaxo/src/addons/2factor_auth/boot.php">
+        <error line="6" column="1" severity="warning" message="Call to static method getInstance() on an unknown class rex_one_time_password." />
+        <error line="9" column="1" severity="warning" message="Call to static method getInstance() on an unknown class rex_minibar." />
+    </file>
+    <file name="redaxo/src/addons/2factor_auth/lib/one_time_password.php">
+        <error line="0" column="1" severity="warning" message="Class rex_one_time_password was not found while trying to analyse it - autoloading is probably not configured properly." />
+    </file>
+</checkstyle>

tests/tests.php

@@ -11,9 +11,9 @@
  * https://github.com/staabm/annotate-pull-request-from-checkstyle
  */
 
-function testXml($xmlPath, $expectedExit, $expectedOutput = null)
+function testXml($xmlPath, $expectedExit, $expectedOutput = null, $options = '')
 {
-    exec('cat '.$xmlPath .' | php '. __DIR__ .'/../cs2pr 2>&1', $output, $exit);
+    exec('cat '.$xmlPath .' | php '. __DIR__ .'/../cs2pr '.$options.' 2>&1', $output, $exit);
     $output = implode("\n", $output);
 
     if ($exit != $expectedExit) {
@@ -42,6 +42,14 @@ function testXml($xmlPath, $expectedExit, $expectedOutput = null)
 testXml(__DIR__.'/fail/multiple-suites.xml', 2, "Error: Extra content at the end of the document on line 8, column 1\n\n" .file_get_contents(__DIR__.'/fail/multiple-suites.xml'));
 
 testXml(__DIR__.'/errors/minimal.xml', 1, file_get_contents(__DIR__.'/errors/minimal.expect'));
+testXml(__DIR__.'/errors/mixed.xml', 1, file_get_contents(__DIR__.'/errors/mixed.expect'));
+testXml(__DIR__.'/errors/warning-only.xml', 1, file_get_contents(__DIR__.'/errors/warning-only.expect'));
+
+testXml(__DIR__.'/errors/minimal.xml', 1, file_get_contents(__DIR__.'/errors/minimal.expect'), '--graceful-warnings');
+testXml(__DIR__.'/errors/mixed.xml', 1, file_get_contents(__DIR__.'/errors/mixed.expect'), '--graceful-warnings');
+testXml(__DIR__.'/errors/warning-only.xml', 0, file_get_contents(__DIR__.'/errors/warning-only.expect'), '--graceful-warnings');
+
+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'));
 testXml(__DIR__.'/noerrors/only-header-php-cs-fixer.xml', 0, file_get_contents(__DIR__.'/noerrors/only-header-php-cs-fixer.expect'));