[ReplaceRegexpTask] Added failOnError support (#1866)

* [ReplaceRegexpTask] Added fail on error support * Update ReplaceRegexpTask.php * Update ReplaceRegexpTask.php * Update phing-grammar.rng * Update ReplaceRegexpTaskTest.xml * Update ReplaceRegexpTaskTest.php * Update ReplaceRegexpTaskTest.php
phingofficial · Sep 14, 2024 · 593141c · 593141c
1 parent b2af8ce
commit 593141c
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 2 deletions.
diff --git a/etc/phing-grammar.rng b/etc/phing-grammar.rng
@@ -5956,6 +5956,9 @@
                     <attribute name="replace"/>
                     <attribute name="flags"/>
                     <attribute name="byLine"/>
+                    <attribute name="failonerror" a:defaultValue="false">
+                        <data type="boolean"/>
+                    </attribute>
                 </optional>
             </interleave>
         </element>

diff --git a/src/Phing/Task/System/ReplaceRegexpTask.php b/src/Phing/Task/System/ReplaceRegexpTask.php
@@ -65,6 +65,16 @@ class ReplaceRegexpTask extends Task
      */
     private $regexp;
 
+    private $failonerror = false;
+
+    /**
+     * If false, note errors but continue.
+     */
+    public function setFailOnError($failonerror)
+    {
+        $this->failonerror = $failonerror;
+    }
+
     /**
      * File to apply regexp on.
      */
@@ -200,7 +210,10 @@ public function main()
                 if ($in) {
                     $in->close();
                 }
-                $this->log('Error reading file: ' . $e->getMessage(), Project::MSG_WARN);
+                $this->log('Error reading file: ' . $e->getMessage(), Project::MSG_ERR);
+                if ($this->failonerror) {
+                    throw new BuildException("Error reading file: '" . $file->getAbsolutePath() . "'", $e);
+                }
             }
 
             try {
@@ -213,7 +226,10 @@ public function main()
                 if ($out) {
                     $out->close();
                 }
-                $this->log('Error writing file back: ' . $e->getMessage(), Project::MSG_WARN);
+                $this->log('Error writing file back: ' . $e->getMessage(), Project::MSG_ERR);
+                if ($this->failonerror) {
+                    throw new BuildException("Error writing file back: '" . $file->getAbsolutePath() . "'", $e);
+                }
             }
         }
     }

diff --git a/tests/Phing/Test/Task/System/ReplaceRegexpTaskTest.php b/tests/Phing/Test/Task/System/ReplaceRegexpTaskTest.php
@@ -50,4 +50,13 @@ public function testReplaceRegexp(): void
         $this->executeTarget(__FUNCTION__);
         $this->assertStringEqualsFile('test.properties', 'NewProperty=12345');
     }
+
+    public function testFailOnError(): void
+    {
+        $this->expectBuildExceptionContaining(
+            __FUNCTION__,
+            'failonerror has to fail',
+            "Error reading file:"
+        );
+    }
 }
diff --git a/tests/etc/tasks/system/ReplaceRegexpTaskTest.xml b/tests/etc/tasks/system/ReplaceRegexpTaskTest.xml
@@ -11,4 +11,10 @@
              match="OldProperty=(.*)"
              replace="NewProperty=\1"/>
     </target>
+    <target name="testFailOnError">
+        <replaceregexp file="nofile"
+             match="OldProperty=(.*)"
+             replace="NewProperty=\1"
+             failonerror="true"/>
+    </target>
 </project>