Create missing target directories, use NIO for file block operations

Fix #461

Author: slawekjaranowski

src/it/projects/resolve-properties-ci-do-not-interpolate-profile-activation-file/pom.xml

@@ -15,6 +15,7 @@
         <version>@project.version@</version>
         <configuration>
           <flattenMode>resolveCiFriendliesOnly</flattenMode>
+          <outputDirectory>${project.build.directory}</outputDirectory>
         </configuration>
       </plugin>
     </plugins>

src/it/projects/resolve-properties-ci-do-not-interpolate-profile-activation-file/verify.groovy

@@ -27,7 +27,7 @@ assert '${basedir}/file.txt' == originalProject.profiles.profile[1].activation.f
 assert '${any.property}' == originalProject.profiles.profile[2].activation.file.exists.text()
 assert '${revision}' == originalProject.profiles.profile[3].activation.file.exists.text()
 
-File flattenedPom = new File( basedir, '.flattened-pom.xml' )
+File flattenedPom = new File( basedir, 'target/.flattened-pom.xml' )
 assert flattenedPom.exists()
 def flattenedProject = new XmlSlurper().parse( flattenedPom )
 

src/main/java/org/codehaus/mojo/flatten/AbstractFlattenMojo.java

@@ -20,6 +20,7 @@
  */
 
 import java.io.File;
+import java.nio.file.Path;
 
 import org.apache.maven.plugin.AbstractMojo;
 import org.apache.maven.plugins.annotations.Parameter;
@@ -76,8 +77,8 @@ public File getOutputDirectory() {
     /**
      * @return a {@link File} instance pointing to the flattened POM.
      */
-    protected File getFlattenedPomFile() {
-        return new File(getOutputDirectory(), getFlattenedPomFilename());
+    protected Path getFlattenedPomFile() {
+        return getOutputDirectory().toPath().resolve(getFlattenedPomFilename());
     }
 
     protected boolean shouldSkip() {

src/main/java/org/codehaus/mojo/flatten/CleanMojo.java

@@ -19,7 +19,9 @@
  * under the License.
  */
 
-import java.io.File;
+import java.io.IOException;
+import java.nio.file.Files;
+import java.nio.file.Path;
 
 import org.apache.maven.plugin.MojoExecutionException;
 import org.apache.maven.plugin.MojoFailureException;
@@ -68,12 +70,13 @@ public void execute() throws MojoExecutionException, MojoFailureException {
             return;
         }
 
-        File flattenedPomFile = getFlattenedPomFile();
-        if (flattenedPomFile.isFile()) {
-            getLog().info("Deleting " + flattenedPomFile.getPath());
-            boolean deleted = flattenedPomFile.delete();
-            if (!deleted) {
-                throw new MojoFailureException("Could not delete " + flattenedPomFile.getAbsolutePath());
+        Path flattenedPomFile = getFlattenedPomFile();
+        if (Files.isRegularFile(flattenedPomFile)) {
+            getLog().info("Deleting " + flattenedPomFile);
+            try {
+                Files.delete(flattenedPomFile);
+            } catch (IOException e) {
+                throw new MojoFailureException("Could not delete " + flattenedPomFile, e);
             }
         }
     }

src/main/java/org/codehaus/mojo/flatten/FlattenMojo.java

@@ -25,10 +25,10 @@
 
 import java.io.File;
 import java.io.IOException;
-import java.io.InputStream;
-import java.io.OutputStream;
 import java.io.StringWriter;
 import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.StandardOpenOption;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
@@ -438,7 +438,7 @@ public void execute() throws MojoExecutionException, MojoFailureException {
         inheritanceAssembler.flattenDependencyMode = this.flattenDependencyMode;
 
         File originalPomFile = this.project.getFile();
-        File flattenedPomFile = getFlattenedPomFile();
+        Path flattenedPomFile = getFlattenedPomFile();
         Model flattenedPom;
         /*
          * Non-destructive CI-friendly version flattening?
@@ -485,7 +485,7 @@ public void execute() throws MojoExecutionException, MojoFailureException {
             writePom(flattenedPom, flattenedPomFile, headerComment, commentsOfOriginalPomFile);
         }
         if (isUpdatePomFile()) {
-            this.project.setPomFile(flattenedPomFile);
+            this.project.setPomFile(flattenedPomFile.toFile());
             this.project.setOriginalModel(flattenedPom);
         }
     }
@@ -520,23 +520,16 @@ protected String extractHeaderComment(File xmlFile) throws MojoExecutionExceptio
      * Writes the given POM {@link Model} to the given {@link File}.
      *
      * @param pom           the {@link Model} of the POM to write.
-     * @param pomFile       the {@link File} where to write the given POM will be written to.
+     * @param pomFile       the {@link Path} where to write the given POM will be written to.
      *                      {@link File#getParentFile()
      *                      Parent directories} are {@link File#mkdirs() created} automatically.
      * @param headerComment is the content of a potential XML comment at the top of the XML (after XML declaration and
      *                      before root tag). May be <code>null</code> if not present and to be omitted in target POM.
      * @throws MojoExecutionException if the operation failed (e.g. due to an {@link IOException}).
      */
-    protected void writePom(Model pom, File pomFile, String headerComment, KeepCommentsInPom anOriginalCommentsPath)
+    protected void writePom(Model pom, Path pomFile, String headerComment, KeepCommentsInPom anOriginalCommentsPath)
             throws MojoExecutionException {
 
-        File parentFile = pomFile.getParentFile();
-        if (!parentFile.exists()) {
-            boolean success = parentFile.mkdirs();
-            if (!success) {
-                throw new MojoExecutionException("Failed to create directory " + pomFile.getParent());
-            }
-        }
         // MavenXpp3Writer could internally add the comment but does not expose such feature to API!
         // Instead we have to write POM XML to String and do post processing on that :(
         MavenXpp3Writer pomWriter = new MavenXpp3Writer();
@@ -568,39 +561,41 @@ protected void writePom(Model pom, File pomFile, String headerComment, KeepComme
      * Writes the given <code>data</code> to the given <code>file</code> using the specified <code>encoding</code>.
      *
      * @param data     is the {@link String} to write.
-     * @param file     is the {@link File} to write to.
+     * @param file     is the {@link Path} to write to.
      * @param encoding is the encoding to use for writing the file.
      * @throws MojoExecutionException if anything goes wrong.
      */
-    protected void writeStringToFile(String data, File file, String encoding) throws MojoExecutionException {
+    protected void writeStringToFile(String data, Path file, String encoding) throws MojoExecutionException {
         data = NEW_LINE_PATTERN.matcher(data).replaceAll(System.lineSeparator());
 
-        byte[] binaryData;
-
         try {
-            binaryData = data.getBytes(encoding);
-            if (file.isFile() && file.canRead() && file.length() == binaryData.length) {
-                try (InputStream inputStream = Files.newInputStream(file.toPath())) {
-                    byte[] buffer = new byte[binaryData.length];
-                    inputStream.read(buffer);
+            byte[] binaryData = data.getBytes(encoding);
+            if (Files.isReadable(file) && Files.size(file) == binaryData.length) {
+                try {
+                    byte[] buffer = Files.readAllBytes(file);
                     if (Arrays.equals(buffer, binaryData)) {
                         getLog().debug("Arrays.equals( buffer, binaryData ) ");
                         return;
                     }
                     getLog().debug("Not Arrays.equals( buffer, binaryData ) ");
                 } catch (IOException e) {
                     // ignore those exceptions, we will overwrite the file
-                    getLog().debug("Issue reading file: " + file.getPath(), e);
+                    getLog().debug("Issue reading file: " + file, e);
                 }
             } else {
-                getLog().debug("file: " + file + ",file.length(): " + file.length() + ", binaryData.length: "
+                getLog().debug("file: " + file + ", not exist or has the same length as binaryData.length: "
                         + binaryData.length);
             }
-        } catch (IOException e) {
-            throw new MojoExecutionException("cannot read String as bytes", e);
-        }
-        try (OutputStream outStream = Files.newOutputStream(file.toPath())) {
-            outStream.write(binaryData);
+            Path parent = file.getParent();
+            if (parent != null) {
+                Files.createDirectories(parent);
+            }
+            Files.write(
+                    file,
+                    binaryData,
+                    StandardOpenOption.CREATE,
+                    StandardOpenOption.TRUNCATE_EXISTING,
+                    StandardOpenOption.WRITE);
         } catch (IOException e) {
             throw new MojoExecutionException("Failed to write to " + file, e);
         }
@@ -688,10 +683,10 @@ private Model createExtendedInterpolatedPom(
         return extendedInterpolatedPom;
     }
 
-    private Model createOriginalPom(File pomFile) throws MojoExecutionException {
+    private Model createOriginalPom(Path pomFile) throws MojoExecutionException {
         MavenXpp3Reader reader = new MavenXpp3Reader();
         try {
-            return reader.read(Files.newInputStream(pomFile.toPath()));
+            return reader.read(Files.newInputStream(pomFile));
         } catch (IOException | XmlPullParserException e) {
             throw new MojoExecutionException("Error reading raw model.", e);
         }
@@ -1345,7 +1340,7 @@ public Model getEffectivePom() throws MojoExecutionException {
 
         public Model getOriginalPom() throws MojoExecutionException {
             if (this.originalPom == null) {
-                this.originalPom = createOriginalPom(this.pomFile);
+                this.originalPom = createOriginalPom(this.pomFile.toPath());
             }
             return this.originalPom;
         }

src/test/java/org/codehaus/mojo/flatten/KeepCommentsInPomTest.java

@@ -90,7 +90,7 @@ public void allNewLineSeparatorShouldBeNormalized() throws Exception {
         FlattenMojo flattenMojo = new FlattenMojo();
 
         File tempFile = temporaryFolder.newFile();
-        flattenMojo.writeStringToFile("line 1\n" + "line 2\r\n" + "line 3\r", tempFile, "UTF-8");
+        flattenMojo.writeStringToFile("line 1\n" + "line 2\r\n" + "line 3\r", tempFile.toPath(), "UTF-8");
 
         String lf = System.lineSeparator();