Merge pull request mojohaus#199 from obfischer/gh-issue-193-take-rule…

…s-from-classpath

Fixed mojohaus#193

ReleaseNotes.md

@@ -5,25 +5,25 @@
  * [Fixed Issue 182][issue-182]
 
    Add goal for updating the SCM tag in the POM.
-   
+
  * [Fixed Issue 197][issue-197]
- 
+
    Java 1.7 as prerequisite.
 
  * [Fixed Issue 198][issue-198]
- 
+
    Update version of modules which are not children but part of reactor.
 
  * [Fixed Issue 185][issue-185]
-   
+
    Unable to set dependencyReportFormat as parameter anymore.
    Thanks to Ilja Dubinin.
 
  * [Fixed Issue 187][issue-187]
-   
+
    create target directory when run dependency update report.
    Thanks to Ilja Dubinin.
-   
+
  * [Pull Request #189][pull-189]
 
    Fixed inccorect links. Thanks to Anton Johansson.

src/it/it-rules-via-classpath-001/invoker.properties

@@ -0,0 +1,2 @@
+invoker.goals=${project.groupId}:${project.artifactId}:${project.version}:use-latest-releases
+invoker.buildResult = failure

src/it/it-rules-via-classpath-001/pom.xml

@@ -0,0 +1,32 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+
+  <groupId>localhost</groupId>
+  <artifactId>it-rules-via-classpath-001</artifactId>
+  <version>1.0</version>
+  <packaging>pom</packaging>
+  <name>GH-193: Fail if resource is not found</name>
+
+  <dependencies>
+    <dependency>
+      <groupId>localhost</groupId>
+      <artifactId>version-rules</artifactId>
+      <version>3.0.1</version>
+    </dependency>
+  </dependencies>
+
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>@project.groupId@</groupId>
+        <artifactId>@project.artifactId@</artifactId>
+        <version>@project.version@</version>
+        <configuration>
+          <rulesUri>classpath:///package/foo/bar/rule-set.xml</rulesUri>
+        </configuration>
+      </plugin>
+    </plugins>
+  </build>
+
+</project>

src/it/it-rules-via-classpath-001/verify.bsh

@@ -0,0 +1,22 @@
+import java.io.*;
+import org.codehaus.plexus.util.FileUtils;
+
+try
+{
+    File file = new File( basedir, "build.log" );
+    String buf = FileUtils.fileRead( file, "UTF-8" );
+    String expectedMessage = "Resource \"classpath:///package/foo/bar/rule-set.xml\" not found in classpath.";
+
+    if ( buf.indexOf( expectedMessage ) < 0 )
+    {
+        System.err.println( "Build should have failed as the requested resource is not present." );
+        return false;
+    }
+}
+catch( Throwable t )
+{
+    t.printStackTrace();
+    return false;
+}
+
+return true;

src/it/it-rules-via-classpath-002/invoker.properties

@@ -0,0 +1,2 @@
+invoker.goals=clean install ${project.groupId}:${project.artifactId}:${project.version}:use-latest-releases
+invoker.buildResult = success

src/it/it-rules-via-classpath-002/pom.xml

@@ -0,0 +1,46 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+
+  <groupId>localhost</groupId>
+  <artifactId>it-rules-via-classpath-002</artifactId>
+  <version>1.0</version>
+  <packaging>pom</packaging>
+  <name>GH-193: Succeed if resource is found</name>
+
+  <dependencies>
+    <dependency>
+      <groupId>localhost</groupId>
+      <artifactId>version-rules</artifactId>
+      <version>3.0.1</version>
+    </dependency>
+    <dependency>
+      <groupId>localhost</groupId>
+      <artifactId>setup-provide-rules-in-jar</artifactId>
+      <version>1.0</version>
+    </dependency>
+
+  </dependencies>
+
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>@project.groupId@</groupId>
+        <artifactId>@project.artifactId@</artifactId>
+        <version>@project.version@</version>
+        <configuration>
+          <rulesUri>classpath:///package/foo/bar/rules.xml</rulesUri>
+        </configuration>
+        <dependencies>
+          <dependency>
+            <groupId>localhost</groupId>
+            <artifactId>setup-provide-rules-in-jar</artifactId>
+            <version>1.0</version>
+          </dependency>
+
+        </dependencies>
+      </plugin>
+    </plugins>
+  </build>
+
+</project>

src/it/it-rules-via-classpath-002/verify.bsh

@@ -0,0 +1,22 @@
+import java.io.*;
+import org.codehaus.plexus.util.FileUtils;
+
+try
+{
+    File file = new File( basedir, "build.log" );
+    String buf = FileUtils.fileRead( file, "UTF-8" );
+    String expectedMessage = "Resource \"classpath:///package/foo/bar/rules.xml\" not found in classpath.";
+
+    if ( buf.indexOf( expectedMessage ) >= 0 )
+    {
+        System.err.println( "File resource rules.xml should have been found in the classpath." );
+        return false;
+    }
+}
+catch( Throwable t )
+{
+    t.printStackTrace();
+    return false;
+}
+
+return true;

src/it/it-rules-via-classpath-003/invoker.properties

@@ -0,0 +1,2 @@
+invoker.goals=clean install ${project.groupId}:${project.artifactId}:${project.version}:use-latest-releases
+invoker.buildResult = success

src/it/it-rules-via-classpath-003/pom.xml

@@ -0,0 +1,45 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+
+  <groupId>localhost</groupId>
+  <artifactId>it-rules-via-classpath-003</artifactId>
+  <version>1.0</version>
+  <packaging>pom</packaging>
+  <name>GH-193: Found rules file is used by the plugin</name>
+
+  <dependencies>
+    <dependency>
+      <groupId>localhost</groupId>
+      <artifactId>version-rules</artifactId>
+      <version>3.0.1</version>
+    </dependency>
+    <dependency>
+      <groupId>localhost</groupId>
+      <artifactId>setup-provide-rules-in-jar</artifactId>
+      <version>1.0</version>
+    </dependency>
+
+  </dependencies>
+
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>@project.groupId@</groupId>
+        <artifactId>@project.artifactId@</artifactId>
+        <version>@project.version@</version>
+        <configuration>
+          <rulesUri>classpath:///package/foo/bar/rules.xml</rulesUri>
+        </configuration>
+        <dependencies>
+          <dependency>
+            <groupId>localhost</groupId>
+            <artifactId>setup-provide-rules-in-jar</artifactId>
+            <version>1.0</version>
+          </dependency>
+        </dependencies>
+      </plugin>
+    </plugins>
+  </build>
+
+</project>

src/it/it-rules-via-classpath-003/verify.bsh

@@ -0,0 +1,21 @@
+import java.io.*;
+import org.codehaus.plexus.util.FileUtils;
+
+try
+{
+    File file = new File( basedir, "pom.xml" );
+    String buf = FileUtils.fileRead( file, "UTF-8" );
+
+    if ( buf.indexOf( "<version>3.0.1-1.1</version>" ) < 0 )
+    {
+        System.err.println( "Version of version-rules not bumped to 3.0.1-1.1" );
+        return false;
+    }
+}
+catch( Throwable t )
+{
+    t.printStackTrace();
+    return false;
+}
+
+return true;

src/it/setup-provide-rules-in-jar/invoker.properties

@@ -0,0 +1 @@
+invoker.goals=clean install

src/it/setup-provide-rules-in-jar/pom.xml

@@ -0,0 +1,12 @@
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+
+  <groupId>localhost</groupId>
+  <artifactId>setup-provide-rules-in-jar</artifactId>
+  <version>1.0</version>
+  <packaging>jar</packaging>
+  <name>GH-193: Provide a rules file within a jar</name>
+
+
+</project>

src/it/setup-provide-rules-in-jar/src/main/resources/package/foo/bar/rules.xml

@@ -0,0 +1,5 @@
+<ruleset comparisonMethod="maven">
+  <rules>
+    <rule groupId="localhost" artifactId="version-rules" comparisonMethod="mercury"/>
+  </rules>
+</ruleset>

src/main/java/org/codehaus/mojo/versions/AbstractVersionsReport.java

@@ -160,7 +160,9 @@ public abstract class AbstractVersionsReport
     private String serverId;
 
     /**
-     * The Wagon URI of a ruleSet file containing the rules that control how to compare version numbers.
+     * URI of a ruleSet file containing the rules that control how to compare
+     * version numbers. The URI could be either a Wagon URI or a classpath URI
+     * (e.g. <code>classpath:///package/sub/package/rules.xml</code>).
      *
      * @since 1.0-alpha-3
      */

src/main/java/org/codehaus/mojo/versions/AbstractVersionsUpdaterMojo.java

@@ -148,7 +148,9 @@ public abstract class AbstractVersionsUpdaterMojo
     private String serverId;
 
     /**
-     * The Wagon URI of a ruleSet file containing the rules that control how to compare version numbers.
+     * URI of a ruleSet file containing the rules that control how to compare
+     * version numbers. The URI could be either a Wagon URI or a classpath URI
+     * (e.g. <code>classpath:///package/sub/package/rules.xml</code>).
      *
      * @since 1.0-alpha-3
      */