maven-enforcer-plugin

How to catch exception in a beanshell?

浪尽此生 — Wed, 06 Jan 2021 17:34:30 +0000

How to catch exception in a beanshell? 浪尽此生 2021-01-07 01:34:30

问题

I can use the evaluateBeanshell rule to enforce some convention: no colon's in directories below src.

<plugin>
  <artifactId>maven-enforcer-plugin</artifactId>
  <version>1.4.1</version>
  <executions>
    <execution>
      <id>enforce-beanshell</id>
      <goals>
        <goal>enforce</goal>
      </goals>
      <configuration>
        <rules>
          <evaluateBeanshell>
            <condition>org.codehaus.plexus.util.FileUtils.getDirectoryNames(new File("src"), "**/*:*", null, false).isEmpty()</condition>
          </evaluateBeanshell>
        </rules>
      </configuration>
    </execution>
  </executions>
</plugin>

But some projects don't have an src directory, and the rule will fail hard. I tried setting

<condition>org.codehaus.plexus.util.FileUtils.getDirectoryNames(new File("."), "src/**/[^A-Z]*", null, false).isEmpty()</condition>

How do I safely catch the non-existence of the src directory?

回答1:

If you want to use Beanshell, you just need something that returns a boolean.

<evaluateBeanshell>
   <condition>new java.io.File("src").exists()</condition>
</evaluateBeanshell>

This will be true if the path exists as a file/folder/symlink, and false otherwise which will break the build.

If you want to check multiple aspects, such as if it exists AND if it's a directory, add multiple conditions:

<evaluateBeanshell>
   <condition>new java.io.File("path").exists()</condition>
   <condition>new java.io.File("path").isDirectory()</condition>
</evaluateBeanshell>

(Arguably there's little point in checking if it exists then if it's a directory, but helps to illustrate the point)

There's plenty more that can be done with Beanshell, if you have to use it. Ultimately though, the 'requireFilesExist' rule is probably a better configuration for the enforcer.

回答2:

This does what I need

<evaluateBeanshell>
  <condition>
    String projectSource = "${project.basedir}" + "/src";
    if (org.codehaus.plexus.util.FileUtils.fileExists(projectSource)){
      List filenames = org.codehaus.plexus.util.FileUtils.getFileNames(
        new File(projectSource),"**/*.*",null,false);

      for (Iterator it = filenames.iterator(); it.hasNext();) {
        String file = it.next();
        String extension = org.codehaus.plexus.util.FileUtils.getExtension(file);

        if (extension.equals(extension.toLowerCase())) {
          it.remove();
        } else {
          print("Invalid filename extension (no capitals): " + projectSource + "/" + file);
        };
      };
      return filenames.isEmpty();
    } else return true;
  </condition>
</evaluateBeanshell>

来源：https://stackoverflow.com/questions/65307107/how-to-catch-exception-in-a-beanshell

标签

beanshell

maven-enforcer-plugin

enforce custom rule in external projects

主宰稳场 — Mon, 13 Jan 2020 21:51:07 +0000

enforce custom rule in external projects 主宰稳场 2020-01-14 05:51:07

问题

I have one Parent maven project and 4 modules in that project:

Now I want to put some custom rule that says there can be no project versions or dependency versions that begin with the string "master-". This rule will be applicable to all the external projects that depends on eBill Software.

So I created a new module with name customRule whose parent is again eBill Software. I followed writing-a-custom-rule and my rule class is in new module.

Relevant part of CustomRule.java in module customRule:

 MavenProject project = (MavenProject) helper.evaluate( "${project}" );
 Set<Artifact> artifacts = project.getArtifacts();

            boolean containsInvalid = artifacts.stream()
                    .filter(item -> item.getVersion()
                    .startsWith("master-"))
                    .anyMatch(item -> true);

            if(containsInvalid) {
                this.shouldIfail = true;
            }

Relevant part of customRule module pom.xml:

<build>
        <plugins>
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-enforcer-plugin</artifactId>
                <version>1.4</version>
                <executions>
                    <execution>
                        <id>enforce-no-master-versions</id>
                        <goals>
                            <goal>enforce</goal>
                        </goals>
                        <configuration>
                            <rules>
                                <myCustomRule implementation="org.apache.customRule.CustomRule">
                                    <shouldIfail>false</shouldIfail>
                                </myCustomRule>
                            </rules>
                        </configuration>

                    </execution>
                </executions>
            </plugin>
        </plugins>
    </build>

Now I want to access this custom rule in parent module eBill Software:

So what should I enter in its pom.xml and external project's pom.xml to be able to get the custom rule applicable to all the external projects that depends on eBill Software.

来源：https://stackoverflow.com/questions/48315914/enforce-custom-rule-in-external-projects

标签

maven-enforcer-plugin

Run Maven Enforcer Plugin rule on command line

不打扰是莪最后的温柔 — Sun, 22 Dec 2019 23:27:27 +0000

Run Maven Enforcer Plugin rule on command line 不打扰是莪最后的温柔 2019-12-23 07:27:27

问题

I would like to enforce the requireReleaseDeps rule of the Maven Enforcer Plugin on a Maven project without any POM configuration simply as a command line call.

According to the docs I should be able to just pass in the rules parameter like so

mvn enforcer:enforce -Drules=requireReleaseDeps

or maybe this should work

mvn enforcer:enforce -Drules=org.apache.maven.plugins.enforcer.RequireReleaseDeps

However both of these calls result in

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-enforcer-plugin:1.3.1:enforce (default-cli) on project hel
lo-world: The parameters 'rules' for goal org.apache.maven.plugins:maven-enforcer-plugin:1.3.1:enforce are missing or in
valid -> [Help 1]

Anybody know if this usage scenario actually works somehow or do I have to dive into debugging the plugin at this stage to figure this out?

回答1:

Unfortunately there is currently no such functionality but there is already a JIRA Issue for that.

回答2:

It is available from 3.0.0. The Jira issue from accepted answer got resolved: https://issues.apache.org/jira/browse/MENFORCER-142

mvn enforcer:enforce -Drules=alwaysPass,alwaysFail

回答3:

Worked for me using Atlassian's fork of the plugin: mvn org.apache.maven.plugins:maven-enforcer-plugin:3.0.0-atlassian-m01:enforce -Drules=...

I had to declare their plugin repository:

<pluginRepositories>
    ....
    <pluginRepository>
        <id>atlassian-3rdparty</id>
        <url>https://maven.atlassian.com/3rdparty</url>
    </pluginRepository>
</pluginRepositories>

Hope this helps.

回答4:

It works with the 3.0.0-M3 version:

mvn org.apache.maven.plugins:maven-enforcer-plugin:3.0.0-M3:enforce -Drules=requireReleaseDeps

来源：https://stackoverflow.com/questions/22157668/run-maven-enforcer-plugin-rule-on-command-line

标签

maven

maven-enforcer-plugin

Run Maven Enforcer Plugin rule on command line

烂漫一生 — Sun, 22 Dec 2019 23:27:09 +0000

Run Maven Enforcer Plugin rule on command line 烂漫一生 2019-12-23 07:27:09

问题

I would like to enforce the requireReleaseDeps rule of the Maven Enforcer Plugin on a Maven project without any POM configuration simply as a command line call.

According to the docs I should be able to just pass in the rules parameter like so

mvn enforcer:enforce -Drules=requireReleaseDeps

or maybe this should work

mvn enforcer:enforce -Drules=org.apache.maven.plugins.enforcer.RequireReleaseDeps

However both of these calls result in

[ERROR] Failed to execute goal org.apache.maven.plugins:maven-enforcer-plugin:1.3.1:enforce (default-cli) on project hel
lo-world: The parameters 'rules' for goal org.apache.maven.plugins:maven-enforcer-plugin:1.3.1:enforce are missing or in
valid -> [Help 1]

Anybody know if this usage scenario actually works somehow or do I have to dive into debugging the plugin at this stage to figure this out?

回答1:

Unfortunately there is currently no such functionality but there is already a JIRA Issue for that.

回答2:

It is available from 3.0.0. The Jira issue from accepted answer got resolved: https://issues.apache.org/jira/browse/MENFORCER-142

mvn enforcer:enforce -Drules=alwaysPass,alwaysFail

回答3:

Worked for me using Atlassian's fork of the plugin: mvn org.apache.maven.plugins:maven-enforcer-plugin:3.0.0-atlassian-m01:enforce -Drules=...

I had to declare their plugin repository:

<pluginRepositories>
    ....
    <pluginRepository>
        <id>atlassian-3rdparty</id>
        <url>https://maven.atlassian.com/3rdparty</url>
    </pluginRepository>
</pluginRepositories>

Hope this helps.

回答4:

It works with the 3.0.0-M3 version:

mvn org.apache.maven.plugins:maven-enforcer-plugin:3.0.0-M3:enforce -Drules=requireReleaseDeps

来源：https://stackoverflow.com/questions/22157668/run-maven-enforcer-plugin-rule-on-command-line

标签

maven

maven-enforcer-plugin

maven custom rule failing or passing without considering custom rule

我与影子孤独终老i — Thu, 12 Dec 2019 20:20:06 +0000

maven custom rule failing or passing without considering custom rule 我与影子孤独终老i 2019-12-13 04:20:06

问题

I am following writing-a-custom-rule document to create custom rule and applying it.

My enforcer plugin execution has the following entry in pom.xml file-

<execution>
            <id>enforce-no-masters</id>
            <configuration>
              <skip>${masterDependenciesAllowed}</skip>
                <rules>
                   <myCustomRule implementation="or.apache.customRule.CustomRule">
                      <excludes>
                       <exclude>*:*:master-*:*:*</exclude>
                      </excludes>
                       <shouldIfail>false</shouldIfail>
                   </myCustomRule>
                </rules>
            </configuration>
            <goals>
                <goal>enforce</goal>
            </goals>
         </execution>

The issue is if I keep <shouldIfail>true</shouldIfail> then I always get failure and if I keep <shouldIfail>false</shouldIfail> then I always get success.

so I don't know that how to put value of java class variable shouldIfail in the tag so that it will be dynamically pass or fail based on logic.

来源：https://stackoverflow.com/questions/48338179/maven-custom-rule-failing-or-passing-without-considering-custom-rule

标签

java

maven

pom.xml

maven-enforcer-plugin

How to resolve maven EnforcedBytecodeVersion failure?

老子叫甜甜 — Wed, 11 Dec 2019 09:54:41 +0000

How to resolve maven EnforcedBytecodeVersion failure? 老子叫甜甜 2019-12-11 17:54:41

问题

When trying to run maven enforcer getting a failure due to some classes conforming to 1.9 where as the entire project is confine dto 1.8. Following is the stack trace of the log. That specific dependency is being pulled by a different jar which can't be excluded as it has compile time dependency.

[INFO] Checking unresolved references to org.codehaus.mojo.signature:java18:1.0
[INFO] Restricted to JDK 1.8 yet javax.json.bind:javax.json.bind-api:jar:1.0:compile contains module-info.class targeted to JDK 1.9
[WARNING] Rule 14: org.apache.maven.plugins.enforcer.EnforceBytecodeVersion failed with message:
Found Banned Dependency: javax.json.bind:javax.json.bind-api:jar:1.0

回答1:

It seemed to be that you misunderstand the intention of enforceBytecodeversion...It will check all dependencies if they use byte code for a more recent version as stated which means higher than JDK 8 just lifting the maxJdkVersion is not solving the problem. The problem is related to the dependencies you are using ....

The dependency: javax.json.bin:javax.json.bind-api 
contains a `module-info.class` file which is related to JDK 9 ...

If you are sure all code in that dependency does not use JDK 9 specific things you have to exclude module-info.class from checking in enforcer rules...

Update: This can be achieved by using the following:

<project>
  [...]
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-enforcer-plugin</artifactId>
        <version>3.0.0-M1</version>
        <executions>
          <execution>
            <id>enforce-bytecode-version</id>
            <goals>
              <goal>enforce</goal>
            </goals>
            <configuration>
              <rules>
                <enforceBytecodeVersion>
                  <maxJdkVersion>1.8</maxJdkVersion>
                  <ignoreClasses>
                    <ignoreClass>module-info</ignoreClass>
                  </ignoreClasses>
                </enforceBytecodeVersion>
              </rules>
            </configuration>
          </execution>
        </executions>
        <dependencies>
          <dependency>
            <groupId>org.codehaus.mojo</groupId>
            <artifactId>extra-enforcer-rules</artifactId>
            <version>1.0-beta-9</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>
  [...]
</project>

回答2:

By overriding the target bytecode to 1.9 in the child pom was able to resolve the enforcer issue as follows.

<plugin>
    <artifactId>maven-enforcer-plugin</artifactId>
    <executions>
      <execution>
        <goals>
          <goal>enforce</goal>
        </goals>
        <configuration>
          <rules>
            <enforceBytecodeVersion>
              <maxJdkVersion>1.9</maxJdkVersion>
            </enforceBytecodeVersion>
          </rules>
          <fail>true</fail>
        </configuration>
      </execution>
    </executions>
  </plugin>

来源：https://stackoverflow.com/questions/51850449/how-to-resolve-maven-enforcedbytecodeversion-failure

标签

java

maven

maven-3

maven-enforcer-plugin

Maven enforcer plugin missing or invalid rules

混江龙づ霸主 — Tue, 03 Dec 2019 07:16:22 +0000

Maven enforcer plugin missing or invalid rules 混江龙づ霸主 2019-12-03 15:16:22

问题

I am trying to setup the enforcer plugin for maven to enforce a minimum Java version. However, whenever I try to run mvn enforcer:enforce, I get:

The parameters 'rules' for goal org.apache.maven.plugins:maven-enforcer-plugin:1.3.1:enforce are missing or invalid

Here is the relevant portion of my pom file:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-enforcer-plugin</artifactId>
    <version>1.3.1</version>
    <executions>
        <execution>
            <id>enforce-java</id>
            <phase>validate</phase>
            <goals>
                <goal>enforce</goal>
            </goals>
            <configuration>
                <rules>
                    <requireJavaVersion>
                        <version>(1.7.0-20,)</version>
                    </requireJavaVersion>
                </rules>
            </configuration>
        </execution>
    </executions>
</plugin>

I also tried replacing the <requireJavaVersion> block with <alwaysPass/>, in case something was invalid, but it still failed with the same error.

回答1:

It may be that you are using invalid rule names. Check out the rules page. The rule names are case sensitive. Though this is not the case here.

---- Edit ----

Note that the POM configuration has an execution ID of enforce-java and that execution is bound to the validate phase of the lifecycle. The command mvn enforcer:enforce is running a goal, not a phase in the lifecycle. The configuration you provided in the POM doesn't apply to the enforcer:enforce goal.

There are two ways to make this work. Which one you choose depends on what you need.

If you are just trying to test the enforcer plugin configuration without running the whole build, run mvn validate.
If the requirement is that mvn enforcer:enforce works, then change the execution ID to default-cli.

来源：https://stackoverflow.com/questions/24827194/maven-enforcer-plugin-missing-or-invalid-rules

标签

maven-enforcer-plugin

Maven enforcer plugin missing or invalid rules

你。 — Mon, 02 Dec 2019 21:50:29 +0000

Maven enforcer plugin missing or invalid rules 你。 2019-12-03 05:50:29

I am trying to setup the enforcer plugin for maven to enforce a minimum Java version. However, whenever I try to run mvn enforcer:enforce, I get:

The parameters 'rules' for goal org.apache.maven.plugins:maven-enforcer-plugin:1.3.1:enforce are missing or invalid

Here is the relevant portion of my pom file:

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-enforcer-plugin</artifactId>
    <version>1.3.1</version>
    <executions>
        <execution>
            <id>enforce-java</id>
            <phase>validate</phase>
            <goals>
                <goal>enforce</goal>
            </goals>
            <configuration>
                <rules>
                    <requireJavaVersion>
                        <version>(1.7.0-20,)</version>
                    </requireJavaVersion>
                </rules>
            </configuration>
        </execution>
    </executions>
</plugin>

I also tried replacing the <requireJavaVersion> block with <alwaysPass/>, in case something was invalid, but it still failed with the same error.

user944849

It may be that you are using invalid rule names. Check out the rules page. The rule names are case sensitive. Though this is not the case here.

---- Edit ----

There are two ways to make this work. Which one you choose depends on what you need.

If you are just trying to test the enforcer plugin configuration without running the whole build, run mvn validate.
If the requirement is that mvn enforcer:enforce works, then change the execution ID to default-cli.

来源：https://stackoverflow.com/questions/24827194/maven-enforcer-plugin-missing-or-invalid-rules

标签

maven-enforcer-plugin

usage of maven enforcer plugin

人走茶凉 — Wed, 27 Nov 2019 13:13:40 +0000

usage of maven enforcer plugin 人走茶凉 2019-11-27 21:13:40

问题

I'd like to use the maven enforcer plugin to check to see if I have duplicate classes on my path. I've tried the example from here.

But when I run it like so:

mvn enforcer:enforce

I get this:

Failed to execute goal org.apache.maven.plugins:maven-enforcer-plugin:1.0.1:enforce (default-cli) on project datapopulator: The parameters 'rules' for goal org.apache.maven.plugins:maven-enforcer-plugin:1.0.1:enforce are missing or invalid

Is there a way to use this correctly?

EDIT #1

If changing my config to this:

        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-enforcer-plugin</artifactId>
            <version>1.0.1</version>
            <executions>
                <execution>
                    <id>enforce-versions</id>
                    <goals>
                        <goal>enforce</goal>
                    </goals>
                    <configuration>
                        <rules>
                            <AlwaysPass />
                        </rules>
                        <fail>true</fail>
                    </configuration>
                </execution>
            </executions>
        </plugin>

Produces the same error.

回答1:

The reason why your first version did not work is because there is a difference between a plug-in configuration inside the execution tag and a plug-in configuration outside the execution tag. The execution is only used when your plug-in is triggered by a special phase of the complete Maven build.

The Maven guide to configuration explains it better:

Configurations inside the tag differ from those that are outside in that they cannot be used from a direct command line invocation. Instead they are only applied when the lifecycle phase they are bound to are invoked. Alternatively, if you move a configuration section outside of the executions section, it will apply globally to all invocations of the plugin.

回答2:

Try this, moving the configuration outside executions, so it isn't bound to the life cycle phase.

<plugin>
    <groupId>org.apache.maven.plugins</groupId>
    <artifactId>maven-enforcer-plugin</artifactId>
    <version>1.0.1</version>
    <executions>
        <execution>
            <id>enforce-versions</id>
            <goals>
                <goal>enforce</goal>
            </goals>
        </execution>
    </executions>
    <configuration>
        <rules>
            <AlwaysPass />
        </rules>
        <fail>true</fail>
    </configuration>
</plugin>

Now when you do mvn enforcer:enforce, it picks the rules from your pom.xml.

回答3:

See these answers

You can use the special default command line execution id, default-cli to invoke it (see Maven Docs), see my example below. This works at least with 3.1.1 and the article cited says it should work with 2.2.0+

mvn enforcer:enforce

However if you are using above Maven 3.1.1 (I can confirm it works in 3.3.3 with enforcer v 1.4.1) you can specify the execution id you wish using the new @ syntax (see Maven JIRA and the answers above);

e.g. for the example below use

mvn enforcer:enforce@dependency-convergence

Here's a snippet from my pom;

<build>
    <plugins>
        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-enforcer-plugin</artifactId>
            <version>1.4.1</version>
            <executions>
                <execution>
                    <id>dependency-convergence</id>
                    <phase>install</phase>
                    <goals>
                        <goal>enforce</goal>
                    </goals>
                    <configuration>
                        <rules>
                            <DependencyConvergence />
                        </rules>
                        <fail>true</fail>
                    </configuration>
                </execution>
                <execution>
                    <id>default-cli</id>
                    <goals>
                        <goal>enforce</goal>
                    </goals>
                    <configuration>
                        <rules>
                            <DependencyConvergence/>
                        </rules>
                        <fail>true</fail>
                    </configuration>
                </execution>
            </executions>
        </plugin>
      ...

回答4:

I don't know why it won't work with the config being in an execution, but this worked for me:

        <plugin>
            <groupId>org.apache.maven.plugins</groupId>
            <artifactId>maven-enforcer-plugin</artifactId>
            <version>1.0</version>
            <configuration>
                <rules>
                    <banDuplicateClasses>
                        <findAllDuplicates>true</findAllDuplicates>
                    </banDuplicateClasses>
                </rules>
                <fail>false</fail>
            </configuration>
            <dependencies>
                <dependency>
                    <groupId>org.codehaus.mojo</groupId>
                    <artifactId>extra-enforcer-rules</artifactId>
                    <version>1.0-alpha-1</version>
                </dependency>
            </dependencies>
        </plugin>

来源：https://stackoverflow.com/questions/6754974/usage-of-maven-enforcer-plugin

标签

java

maven

maven-plugin

maven-enforcer-plugin