Add CLI IgnoreViolationsOnExit option flag

README.rst

@@ -94,6 +94,9 @@ Command line options
 
   - ``--strict`` - Also report those nodes with a @SuppressWarnings annotation.
 
+  - ``--ignore-violations-on-exit`` - will exit with a zero code, even if any
+    violations are found.
+
   An example command line: ::
 
     phpmd PHP/Depend/DbusUI xml codesize --reportfile phpmd.xml --suffixes php,phtml
@@ -144,7 +147,9 @@ PHPMD's command line tool currently defines three different exit codes.
   interrupted PHPMD during execution.
 - *2*, This exit code means that PHPMD has processed the code under test
   without the occurence of an error/exception, but it has detected rule
-  violations in the analyzed source code.
+  violations in the analyzed source code. You can also prevent this behaviour
+  with the ``--ignore-violations-on-exit`` flag, which will result to a *0*
+  even if any violations are found.
 
 Renderers
 ---------

src/main/php/PHPMD/TextUI/Command.php

@@ -70,6 +70,9 @@ class Command
      * found in the analyzed code. Otherwise this method will return a value
      * equal to <b>EXIT_VIOLATION</b>.
      *
+     * The use of flag <b>--ignore-violations-on-exit</b> will result to a
+     * <b>EXIT_SUCCESS</b> even if any violation is found.
+     *
      * @param \PHPMD\TextUI\CommandLineOptions $opts
      * @param \PHPMD\RuleSetFactory $ruleSetFactory
      * @return integer
@@ -129,7 +132,7 @@ public function run(CommandLineOptions $opts, RuleSetFactory $ruleSetFactory)
             $ruleSetFactory
         );
 
-        if ($phpmd->hasViolations() && !$opts->hasIgnoreExitViolations()) {
+        if ($phpmd->hasViolations() && !$opts->ignoreExitViolations()) {
             return self::EXIT_VIOLATION;
         }
         return self::EXIT_SUCCESS;

src/main/php/PHPMD/TextUI/CommandLineOptions.php

@@ -200,7 +200,7 @@ public function __construct(array $args, array $availableRuleSets = array())
                 case '--strict':
                     $this->strict = true;
                     break;
-                case '--ignore-exit-violations':
+                case '--ignore-violations-on-exit':
                     $this->ignoreExitViolations = true;
                     break;
                 case (preg_match('(^\-\-reportfile\-(xml|html|text)$)', $arg, $match) > 0):
@@ -338,11 +338,11 @@ public function hasStrict()
     }
 
     /**
-     * Was the <b>--ignore-exit-violations</b> passed to PHPMD's command line interface?
+     * Was the <b>--ignore-violations-on-exit</b> passed to PHPMD's command line interface?
      *
      * @return boolean
      */
-    public function hasIgnoreExitViolations()
+    public function ignoreExitViolations()
     {
         return $this->ignoreExitViolations;
     }
@@ -459,8 +459,8 @@ public function usage()
                'ignore directories' . \PHP_EOL .
                 '--strict: also report those nodes with a @SuppressWarnings ' .
                'annotation' . \PHP_EOL .
-                '--ignore-exit-violations: will exit with 0 even if a ' .
-                'violation is found ' . \PHP_EOL;
+                '--ignore-violations-on-exit: will exit with a zero code, ' .
+                'even if any violations are found' . \PHP_EOL;
     }
 
     /**

src/site/rst/documentation/index.rst

@@ -54,6 +54,9 @@ Command line options
 
   - ``--strict`` - Also report those nodes with a @SuppressWarnings annotation.
 
+  - ``--ignore-violations-on-exit`` - will exit with a zero code, even if any
+    violations are found.
+
   An example command line: ::
 
     phpmd PHP/Depend/DbusUI xml codesize --reportfile phpmd.xml --suffixes php,phtml
@@ -96,7 +99,9 @@ PHPMD's command line tool currently defines three different exit codes.
   interrupted PHPMD during execution.
 - *2*, This exit code means that PHPMD has processed the code under test
   without the occurrence of an error/exception, but it has detected rule
-  violations in the analyzed source code.
+  violations in the analyzed source code. You can also prevent this behaviour
+  with the ``--ignore-violations-on-exit`` flag, which will result to a *0*
+  even if any violations are found.
 
 Renderers
 =========

src/test/php/PHPMD/TextUI/CommandLineOptionsTest.php

@@ -174,7 +174,7 @@ public function testThrowsExpectedExceptionWhenInputFileNotExists()
     }
 
     /**
-     * testCliOptionsAcceptsVersionArgument
+     * testHasVersionReturnsFalseByDefault
      *
      * @return void
      */
@@ -199,6 +199,45 @@ public function testCliOptionsAcceptsVersionArgument()
         self::assertTrue($opts->hasVersion());
     }
 
+    /**
+     * testIgnoreExitViolationsReturnsFalseByDefault
+     *
+     * @return void
+     */
+    public function testIgnoreExitViolationsReturnsFalseByDefault()
+    {
+        $args = array(__FILE__, __FILE__, 'text', 'unusedcode');
+        $opts = new CommandLineOptions($args);
+
+        self::assertFalse($opts->ignoreExitViolations());
+    }
+
+    /**
+     * testCliOptionsAcceptsIgnoreViolationsOnExitArgument
+     *
+     * @return void
+     */
+    public function testCliOptionsAcceptsIgnoreViolationsOnExitArgument()
+    {
+        $args = array(__FILE__, __FILE__, 'text', 'unusedcode', '--ignore-violations-on-exit');
+        $opts = new CommandLineOptions($args);
+
+        self::assertTrue($opts->ignoreExitViolations());
+    }
+
+    /**
+     * testCliUsageContainsStrictOption
+     *
+     * @return void
+     */
+    public function testCliUsageContainsIgnoreViolationsOnExitOption()
+    {
+        $args = array(__FILE__, __FILE__, 'text', 'codesize');
+        $opts = new CommandLineOptions($args);
+
+        $this->assertContains('--ignore-violations-on-exit:', $opts->usage());
+    }
+
     /**
      * testCliUsageContainsStrictOption
      * 

src/test/php/PHPMD/TextUI/CommandTest.php

@@ -99,4 +99,29 @@ public function testMainReturnsViolationExitCodeForSourceWithNPathViolation()
         );
         $this->assertEquals(Command::EXIT_VIOLATION, $exitCode);
     }
+
+    /**
+     * testMainReturnsViolationExitCodeForSourceWithNPathViolation
+     *
+     * @return void
+     * @covers \PHPMD\TextUI\Command
+     * @group phpmd
+     * @group phpmd::textui
+     * @group unittest
+     */
+    public function testMainReturnsSuccessExitCodeForSourceWithNPathViolationAndIgnoreViolationsOnExitFlag()
+    {
+        $exitCode = Command::main(
+            array(
+                __FILE__,
+                self::createFileUri('source/source_with_npath_violation.php'),
+                'text',
+                'codesize',
+                '--reportfile',
+                self::createTempFileUri(),
+                '--ignore-violations-on-exit',
+            )
+        );
+        $this->assertEquals(Command::EXIT_SUCCESS, $exitCode);
+    }
 }