✨ feat: Add exactVersionString to freeze target (#1204)

Author: LogFlames

README.md

@@ -75,6 +75,9 @@ mvn -f pom.lockfile.xml
 - `lockfileName` (`-DlockfileName=my-lockfile.json` default="lockfile.json") will set the name of the lockfile file to be generated/read.
 - `getConfigFromFile` will read the configuration of maven lockfile from the existing lockfile.
 
+For `:freeze` target:
+- `exactVersionStrings` (`-DexactVersionStrings=false`, default=true) provide version string as exact parameter `[1.0.0]`, instead of soft requirement `1.0.0`.
+
 ### Flags example
 
 The flags are passed by the maven [`-D` (`--define`)](https://books.sonatype.com/mvnref-book/reference/running-sect-options.html) property. For example, to set the `lockfileName` to `my-lockfile.json` and include maven plugins in the lockfile, you would run the following command:

maven_plugin/src/main/java/io/github/chains_project/maven_lockfile/FreezeDependencyMojo.java

@@ -48,6 +48,9 @@ public class FreezeDependencyMojo extends AbstractMojo {
     @Parameter(defaultValue = "lockfile.json", property = "lockfileName")
     private String lockfileName;
 
+    @Parameter(defaultValue = "true", property = "exactVersionStrings")
+    private String exactVersionStrings;
+
     /**
      * Freezes the dependencies of the project. Every dependency will be locked to a specific version.
      *
@@ -143,11 +146,26 @@ private Dependency toMavenDependency(DependencyNode dep) {
         Dependency mavenDep = new Dependency();
         mavenDep.setGroupId(dep.getGroupId().getValue());
         mavenDep.setArtifactId(dep.getArtifactId().getValue());
-        mavenDep.setVersion(dep.getVersion().getValue());
+        String version = dep.getVersion().getValue();
+        if (exactVersionStrings.equals("true")) {
+            version = convertSoftToExactVersionString(version);
+        }
+        mavenDep.setVersion(version);
         if (dep.getClassifier() != null) {
             mavenDep.setClassifier(dep.getClassifier().getValue());
         }
         mavenDep.setScope(dep.getScope().getValue());
         return mavenDep;
     }
+
+    /**
+     * Transform a soft version requirement into an exact one by wrapping it in a range which only includes .
+     */
+    private String convertSoftToExactVersionString(String version) {
+        if (version.startsWith("[") || version.startsWith("(")) {
+            getLog().warn("Version is already a range, '" + version + "'. Cannot reliably make exact for freeze pom.");
+            return version;
+        }
+        return "[" + version + "]";
+    }
 }

maven_plugin/src/test/resources-its/it/IntegrationTestsIT/freezeWithDepManagement/pom.lockfile.expected.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <project xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd" xmlns="http://maven.apache.org/POM/4.0.0"
-         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
     <modelVersion>4.0.0</modelVersion>
     <groupId>com.mycompany.app</groupId>
     <artifactId>freeze-with-dep-management</artifactId>
@@ -15,42 +15,42 @@
             <dependency>
                 <groupId>org.eclipse.sisu</groupId>
                 <artifactId>org.eclipse.sisu.inject</artifactId>
-                <version>0.9.0.M1</version>
+                <version>[0.9.0.M1]</version>
             </dependency>
             <dependency>
                 <groupId>javax.enterprise</groupId>
                 <artifactId>cdi-api</artifactId>
-                <version>1.2</version>
+                <version>[1.2]</version>
                 <scope>compile</scope>
             </dependency>
             <dependency>
                 <groupId>org.codehaus.plexus</groupId>
                 <artifactId>plexus-classworlds</artifactId>
-                <version>2.6.0</version>
+                <version>[2.6.0]</version>
                 <scope>compile</scope>
             </dependency>
             <dependency>
                 <groupId>javax.inject</groupId>
                 <artifactId>javax.inject</artifactId>
-                <version>1</version>
+                <version>[1]</version>
                 <scope>compile</scope>
             </dependency>
             <dependency>
                 <groupId>org.codehaus.plexus</groupId>
                 <artifactId>plexus-component-annotations</artifactId>
-                <version>2.1.0</version>
+                <version>[2.1.0]</version>
                 <scope>compile</scope>
             </dependency>
             <dependency>
                 <groupId>org.codehaus.plexus</groupId>
                 <artifactId>plexus-utils</artifactId>
-                <version>3.3.0</version>
+                <version>[3.3.0]</version>
                 <scope>compile</scope>
             </dependency>
             <dependency>
                 <groupId>javax.annotation</groupId>
                 <artifactId>javax.annotation-api</artifactId>
-                <version>1.2</version>
+                <version>[1.2]</version>
                 <scope>compile</scope>
             </dependency>
         </dependencies>
@@ -59,16 +59,15 @@
         <dependency>
             <groupId>org.eclipse.sisu</groupId>
             <artifactId>org.eclipse.sisu.plexus</artifactId>
-            <version>0.9.0.M2</version>
+            <version>[0.9.0.M2]</version>
             <scope>compile</scope>
         </dependency>
     </dependencies>
     <build>
         <plugins>
             <plugin>
                 <groupId>io.github.chains-project</groupId>
-                <artifactId>
-                    maven-lockfile</artifactId>
+                <artifactId>maven-lockfile</artifactId>
                 <version>@project.version@</version>
                 <executions>
                     <execution>

maven_plugin/src/test/resources-its/it/IntegrationTestsIT/freezeWithoutDepManagement/pom.original.xml

@@ -63,6 +63,9 @@
                         </goals>
                     </execution>
                 </executions>
+                <configuration>
+                    <exactVersionStrings>false</exactVersionStrings>
+                </configuration>
             </plugin>
         </plugins>
     </build>

maven_plugin/src/test/resources-its/it/IntegrationTestsIT/freezeWithoutDepManagement/pom.xml

@@ -63,6 +63,9 @@
                         </goals>
                     </execution>
                 </executions>
+                <configuration>
+                    <exactVersionStrings>false</exactVersionStrings>
+                </configuration>
             </plugin>
         </plugins>
     </build>