fix: lockfile should not be generated or validated if skip option is …

…true (#909)

Co-authored-by: Martin Monperrus <[email protected]>

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

@@ -39,6 +39,7 @@ public class GenerateLockFileMojo extends AbstractLockfileMojo {
     public void execute() throws MojoExecutionException {
         if (Boolean.parseBoolean(skip)) {
             getLog().info("Skipping maven-lockfile");
+            return;
         }
         try {
             LockFile lockFileFromFile =

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

@@ -31,11 +31,12 @@ public class ValidateChecksumMojo extends AbstractLockfileMojo {
      * @throws MojoExecutionException if the lock file is invalid or could not be read.
      */
     public void execute() throws MojoExecutionException {
-        getLog().info("Validating lock file ...");
         if (Boolean.parseBoolean(skip)) {
             getLog().info("Skipping maven-lockfile");
+            return;
         }
         try {
+            getLog().info("Validating lock file ...");
             Environment environment = generateMetaInformation();
 
             LockFile lockFileFromFile = LockFile.readLockFile(getLockFilePath(project));

maven_plugin/src/test/java/it/IntegrationTestsIT.java

@@ -331,4 +331,17 @@ public void orderedLockfile(MavenExecutionResult result) throws Exception {
         boolean sorted = Ordering.natural().isOrdered(dependencyList);
         assertThat(sorted).isTrue();
     }
+
+    @MavenTest
+    public void skipLockfile(MavenExecutionResult result) throws Exception {
+        // contract: the lockfile should not be generated if skip option is true
+        assertThat(result).isSuccessful();
+        var fileExists = Files.find(
+                        result.getMavenProjectResult().getTargetBaseDirectory(),
+                        Integer.MAX_VALUE,
+                        (path, attr) -> path.getFileName().toString().contains("lockfile.json"))
+                .findAny()
+                .isPresent();
+        assertThat(fileExists).isFalse();
+    }
 }

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

@@ -0,0 +1,52 @@
+<project>
+  <modelVersion>4.0.0</modelVersion>
+
+  <groupId>com.mycompany.app</groupId>
+  <artifactId>my-app</artifactId>
+  <packaging>jar</packaging>
+  <version>1</version>
+  <properties>
+    <maven.compiler.target>11</maven.compiler.target>
+    <maven.compiler.source>11</maven.compiler.source>
+    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+  </properties>
+  <dependencies>
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-api</artifactId>
+      <version>5.9.2</version>
+    </dependency>
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-api</artifactId>
+      <version>5.9.2</version>
+      <classifier>sources</classifier>
+    </dependency>
+    <dependency>
+      <groupId>org.junit.jupiter</groupId>
+      <artifactId>junit-jupiter-api</artifactId>
+      <version>5.9.2</version>
+      <classifier>javadoc</classifier>
+    </dependency>
+  </dependencies>
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>io.github.chains-project</groupId>
+        <artifactId>
+          maven-lockfile</artifactId>
+        <version>@project.version@</version>
+        <executions>
+          <execution>
+            <goals>
+              <goal>generate</goal>
+            </goals>
+          </execution>
+        </executions>
+        <configuration>
+          <skip>true</skip>
+        </configuration>
+      </plugin>
+    </plugins>
+  </build>
+</project>

maven_plugin/src/test/resources-its/it/IntegrationTestsIT/skipLockfile/src/main/java/HelloWorld.java

@@ -0,0 +1,7 @@
+package simpleProject.src.main.java;
+
+public class HelloWorld {
+  public static void main(String[] args) {
+    System.out.println("Hello World!");
+  }
+}