[FIXED] How to make a maven build fail if source code contains a keyword / regex

Issue

Question

How to make a maven build fail if source code contains a keyword / regex?

Bonus

• Be able to specify which path to check
• Be able to specify which "kind" of path to check :
  • "I want to be sure that KEYWORD is not contained in 'main' resources. I don't care about 'test'"
  • "I want to be sure that KEYWORD is not contained in 'test' resources. I don't care about 'main'"
  • ...
• Be able to specify on which phase to execute the test (Eg. before compilation)

Solution

(Based on current answers 2013-09-26)

Best solution yet seems to be @BaptisteMathus answer that fully integrates with maven and is platform independant.

In my use case, @GregWhitaker answer is the good one because it's cheaper to implement as I don't care about platform independency (<= the required command is availiable on all my hosts). The code sample below is a solution based on this answer, it forbids usage of "FIXME" or "Auto-generated method stub" but is assuming that egrep is availiable.

Please see also @MarkOConnor answer that is cleaner in "SONAR enabled" project

<build>
    <plugins>
        <plugin>
            <groupId>org.codehaus.mojo</groupId>
            <artifactId>exec-maven-plugin</artifactId>
            <version>1.2.1</version>
            <executions>
                <execution>
                    <phase>process-sources</phase>
                    <configuration>
                        <executable>egrep</executable>
                        <successCodes>
                            <successCode>1</successCode>
                        </successCodes>
                        <arguments>
                            <argument>-rqm</argument>
                            <argument>1</argument>
                            <!-- Forbidden Keywords -->
                            <argument>FIXME|Auto-generated method stub</argument>
                            <!-- search path -->
                            <argument>src/main</argument>
                        </arguments>
                    </configuration>
                    <goals>
                        <goal>exec</goal>
                    </goals>
                </execution>
            </executions>
        </plugin>
    </plugins>
</build>

Solution

Going to SonarQube to do that is not a bad idea.

Anyway, if someone wants to use a maven-only solution, then the right way would then be by using a plugin dedicated to "enforce" things with maven builds. Using exec-maven-plugin is not that standard and certainly too much platform-dependent.

This plugin is logically named maven-enforcer-plugin and writing a custom enforcer rule is actually very simple.

Answered By - Baptiste Mathus
Answer Checked By - Robin (JavaFixing Admin)