[Core] Replace parentFile.makeDirs with Files.createDirectories(parentFile)

While `makeDirs` makes an attempt at creating the directories
`createDirectories` will throw an exception when the directories could not be
created or if the file exists but was not a directory.

See: #2108

Author: mpkorstanje

compatibility/src/test/java/io/cucumber/compatibility/CompatibilityTest.java

@@ -13,19 +13,19 @@
 import org.junit.jupiter.params.ParameterizedTest;
 import org.junit.jupiter.params.provider.MethodSource;
 
-import java.io.File;
-import java.io.FileOutputStream;
 import java.io.IOException;
 import java.io.InputStream;
 import java.nio.file.Files;
 import java.nio.file.Path;
+import java.nio.file.Paths;
 import java.util.ArrayList;
 import java.util.Comparator;
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.stream.Collectors;
 
+import static java.nio.file.Files.newOutputStream;
 import static org.hamcrest.CoreMatchers.is;
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.collection.IsIterableContainingInRelativeOrder.containsInRelativeOrder;
@@ -36,11 +36,10 @@ public class CompatibilityTest {
     @ParameterizedTest
     @MethodSource("io.cucumber.compatibility.TestCase#testCases")
     void produces_expected_output_for(TestCase testCase) throws IOException {
-        File parentDir = new File("target/messages/" + testCase.getId());
-        parentDir.mkdirs();
-        File outputNdjson = new File(parentDir, "out.ndjson");
-        File outputHtml = new File(parentDir, "out.html");
-        File outputJson = new File(parentDir, "out.json");
+        Path parentDir = Files.createDirectories(Paths.get("target", "messages", testCase.getId()));
+        Path outputNdjson = parentDir.resolve("out.ndjson");
+        Path outputHtml = parentDir.resolve("out.html");
+        Path outputJson = parentDir.resolve("out.json");
 
         try {
             Runtime.builder()
@@ -49,17 +48,17 @@ void produces_expected_output_for(TestCase testCase) throws IOException {
                             .addFeature(testCase.getFeature())
                             .build())
                     .withAdditionalPlugins(
-                        new MessageFormatter(new FileOutputStream(outputNdjson)),
-                        new HtmlFormatter(new FileOutputStream(outputHtml)),
-                        new JsonFormatter(new FileOutputStream(outputJson)))
+                        new MessageFormatter(newOutputStream(outputNdjson)),
+                        new HtmlFormatter(newOutputStream(outputHtml)),
+                        new JsonFormatter(newOutputStream(outputJson)))
                     .build()
                     .run();
         } catch (Exception ignored) {
 
         }
 
         List<Messages.Envelope> expected = readAllMessages(testCase.getExpectedFile());
-        List<Messages.Envelope> actual = readAllMessages(outputNdjson.toPath());
+        List<Messages.Envelope> actual = readAllMessages(outputNdjson);
 
         Map<String, List<GeneratedMessageV3>> expectedEnvelopes = openEnvelopes(expected);
         Map<String, List<GeneratedMessageV3>> actualEnvelopes = openEnvelopes(actual);

core/src/main/java/io/cucumber/core/plugin/PluginFactory.java

@@ -18,6 +18,7 @@
 import java.net.URI;
 import java.net.URISyntaxException;
 import java.net.URL;
+import java.nio.file.Files;
 import java.util.Arrays;
 import java.util.HashMap;
 import java.util.Map;
@@ -199,11 +200,32 @@ private static OutputStream openStream(String arg) throws IOException {
     }
 
     private static FileOutputStream createFileOutputStream(File file) {
+        File canonicalFile;
         try {
-            File parentFile = file.getParentFile();
+            canonicalFile = file.getCanonicalFile();
+        } catch (IOException e) {
+            throw new IllegalArgumentException(String.format("" +
+                    "Couldn't get the canonical file of %s.\n" +
+                    "The details are in the stack trace below:",
+                file),
+                e);
+        }
+
+        try {
+            File parentFile = canonicalFile.getParentFile();
             if (parentFile != null) {
-                parentFile.mkdirs();
+                Files.createDirectories(parentFile.toPath());
             }
+        } catch (IOException e) {
+            throw new IllegalArgumentException(String.format("" +
+                    "Couldn't create parent directories of %s.\n" +
+                    "Make sure the the directory isn't a file.\n" +
+                    "The details are in the stack trace below:",
+                file),
+                e);
+        }
+
+        try {
             return new FileOutputStream(file);
         } catch (FileNotFoundException e) {
             throw new IllegalArgumentException(String.format("" +

java/src/main/groovy/generate-annotations.groovy

@@ -1,6 +1,7 @@
 import groovy.text.SimpleTemplateEngine
 import io.cucumber.gherkin.GherkinDialectProvider
 
+import java.nio.file.Files
 import java.text.Normalizer
 
 SimpleTemplateEngine engine = new SimpleTemplateEngine()
@@ -26,7 +27,7 @@ dialectProvider.getLanguages().each { language ->
             if (!file.exists()) {
                 // Haitian has two translations that only differ by case - Sipozeke and SipozeKe
                 // Some file systems are unable to distiguish between them and overwrite the other one :-(
-                file.parentFile.mkdirs()
+                Files.createDirectories(file.parentFile.toPath())
                 file.write(template.toString(), "UTF-8")
             }
         }

java8/src/main/groovy/generate-interfaces.groovy

@@ -1,6 +1,8 @@
 import groovy.text.SimpleTemplateEngine
 import io.cucumber.gherkin.GherkinDialectProvider
 
+import java.nio.file.Files
+
 SimpleTemplateEngine engine = new SimpleTemplateEngine()
 
 def unsupported = ["em"] // The generated files for Emoij do not compile.
@@ -16,7 +18,7 @@ dialectProvider.getLanguages().each { language ->
         def binding = ["i18n": dialect, "className": className, "language_name": name]
         def template = engine.createTemplate(templateSource).make(binding)
         def file = new File(project.baseDir, "target/generated-sources/i18n/java/io/cucumber/java8/${className}.java")
-        file.parentFile.mkdirs()
+        Files.createDirectories(file.parentFile.toPath())
         file.write(template.toString(), "UTF-8")
     }
 }