Refactor: Uses junit5 nested tests for a better structure

Setups missing java 11 in the github workflow

5 files changed, 167 insertions, 121 deletions

diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
index 4f896e5..4654454 100644
--- a/.github/workflows/main.yml
+++ b/.github/workflows/main.yml
@@ -19,10 +19,17 @@ jobs:
       - name: Checkout Repository
         uses: actions/checkout@v2.3.4
 
-      - name: Run Tests
+      - name: Setup Java 11
+        uses: actions/setup-java@v2
+        with:
+          distribution: 'adopt-openj9'
+          java-version: '11'
+
+      - name: Run Unit & Functional Tests
         run: |
           if [ "$RUNNER_OS" = "Windows" ]; then
-            gradlew.bat clean check
+            ./gradlew.bat clean check
           else
             ./gradlew clean check
-          fi
\ No newline at end of file
+          fi
+        shell: bash
\ No newline at end of file
diff --git a/settings.gradle b/settings.gradle
index 772bbfe..8ee43c9 100644
--- a/settings.gradle
+++ b/settings.gradle
@@ -1 +1 @@
-rootProject.name = 'frege-plugin'
\ No newline at end of file
+rootProject.name='frege-plugin'
\ No newline at end of file
diff --git a/src/functionalTest/java/ch/fhnw/thga/gradleplugins/FregePluginFunctionalTest.java b/src/functionalTest/java/ch/fhnw/thga/gradleplugins/FregePluginFunctionalTest.java
index 6800f96..e93bd19 100644
--- a/src/functionalTest/java/ch/fhnw/thga/gradleplugins/FregePluginFunctionalTest.java
+++ b/src/functionalTest/java/ch/fhnw/thga/gradleplugins/FregePluginFunctionalTest.java
@@ -1,6 +1,6 @@
 package ch.fhnw.thga.gradleplugins;
 
-import static ch.fhnw.thga.gradleplugins.FregeDTOTest.createPluginsSection;
+import static ch.fhnw.thga.gradleplugins.GradleBuildFileConversionTest.createPluginsSection;
 import static ch.fhnw.thga.gradleplugins.FregeExtension.DEFAULT_DOWNLOAD_DIRECTORY;
 import static ch.fhnw.thga.gradleplugins.FregePlugin.COMPILE_FREGE_TASK_NAME;
 import static ch.fhnw.thga.gradleplugins.FregePlugin.FREGE_EXTENSION_NAME;
@@ -22,10 +22,18 @@ import org.gradle.api.Project;
 import org.gradle.testfixtures.ProjectBuilder;
 import org.gradle.testkit.runner.BuildResult;
 import org.gradle.testkit.runner.GradleRunner;
+import org.junit.jupiter.api.AfterEach;
+import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.DisplayNameGenerator;
+import org.junit.jupiter.api.IndicativeSentencesGeneration;
+import org.junit.jupiter.api.Nested;
 import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.TestInstance;
+import org.junit.jupiter.api.TestInstance.Lifecycle;
 import org.junit.jupiter.api.io.TempDir;
 
+@TestInstance(Lifecycle.PER_CLASS)
 public class FregePluginFunctionalTest {
 
     private final FregeDTOBuilder fregeBuilder = new FregeDTOBuilder();
@@ -37,14 +45,8 @@ public class FregePluginFunctionalTest {
     private Project project;
 
     private void writeFile(File destination, String content, boolean append) throws IOException {
-        BufferedWriter output = null;
-        try {
-            output = new BufferedWriter(new FileWriter(destination, append));
+        try (BufferedWriter output = new BufferedWriter(new FileWriter(destination, append))) {
             output.write(content);
-        } finally {
-            if (output != null) {
-                output.close();
-            }
         }
     }
 
@@ -60,59 +62,89 @@ public class FregePluginFunctionalTest {
         return String.format("%s {\n  %s\n}", FREGE_EXTENSION_NAME, fregeDTO.toBuildFile());
     }
 
-    private void assertGradleTaskOutcome(String buildFileTaskConfig, String taskName) throws Exception {
-        appendToFile(buildFile, buildFileTaskConfig);
-        BuildResult result = GradleRunner.create().withProjectDir(testProjectDir).withPluginClasspath()
-                .withArguments(taskName).build();
-        System.out.println(result.getOutput());
-        assertEquals(SUCCESS, result.task(":" + taskName).getOutcome());
+    private BuildResult runGradleTask(String taskName) {
+        return GradleRunner.create().withProjectDir(testProjectDir).withPluginClasspath()
+            .withArguments(taskName).build();
     }
 
-    @BeforeEach
-    void setup() throws Exception {
-        buildFile = new File(testProjectDir, "build.gradle");
+    @BeforeAll
+    void beforeAll() throws Exception {
         settingsFile = new File(testProjectDir, "settings.gradle");
-        writeToFile(buildFile, createPluginsSection(Stream.of(FREGE_PLUGIN_ID)));
         writeToFile(settingsFile, "rootProject.name='frege-plugin'");
         project = ProjectBuilder.builder().withProjectDir(testProjectDir).build();
         project.getPluginManager().apply(FREGE_PLUGIN_ID);
+
+    }
+
+    @BeforeEach
+    void setup() throws Exception {
+        buildFile = new File(testProjectDir, "build.gradle");
+        writeToFile(buildFile, createPluginsSection(Stream.of(FREGE_PLUGIN_ID)));
     }
 
-    @Test
-    void given_setup_frege_compiler_task_when_frege_version_and_frege_release_is_specified_then_frege_compiler_is_successfully_downloaded_to_default_directory()
-            throws Exception {
-        FregeDTO minimalFregeDTO = fregeBuilder.version("'3.25.84'").release("'3.25alpha'").build();
-        assertTrue(project.getTasks().getByName(SETUP_FREGE_TASK_NAME) instanceof SetupFregeTask);
-        assertGradleTaskOutcome(createFregeSection(minimalFregeDTO), SETUP_FREGE_TASK_NAME);
-        assertTrue(testProjectDir.toPath().resolve(Paths.get(DEFAULT_DOWNLOAD_DIRECTORY, "frege3.25.84.jar")).toFile()
-                .exists());
+    @AfterEach
+    void cleanup() {
+        buildFile.delete();
     }
 
-    @Test
-    void given_setup_frege_compiler_task_when_frege_version_and_frege_release_and_download_directory_is_specified_then_frege_compiler_is_successfully_downloaded_to_specified_directory()
-            throws Exception {
-        FregeDTO fregeDTO = fregeBuilder.version("'3.25.84'").release("'3.25alpha'")
-                .compilerDownloadDir("layout.projectDirectory.dir('dist')").build();
-        assertTrue(project.getTasks().getByName(SETUP_FREGE_TASK_NAME) instanceof SetupFregeTask);
-        assertGradleTaskOutcome(createFregeSection(fregeDTO), SETUP_FREGE_TASK_NAME);
-        assertTrue(testProjectDir.toPath().resolve(Paths.get("dist", "frege3.25.84.jar")).toFile().exists());
+    @Nested
+    @IndicativeSentencesGeneration(separator = " -> ", generator = DisplayNameGenerator.ReplaceUnderscores.class)
+    class Setup_frege_task_works {
+
+        @Test
+        void given_minimal_build_file_config()
+                throws Exception {
+            String minimalBuildFileConfig = createFregeSection(fregeBuilder.version("'3.25.84'").release("'3.25alpha'").build());
+            appendToFile(buildFile, minimalBuildFileConfig);
+
+            BuildResult result = runGradleTask(SETUP_FREGE_TASK_NAME);
+            
+            assertTrue(project.getTasks().getByName(SETUP_FREGE_TASK_NAME) instanceof SetupFregeTask);
+            assertEquals(SUCCESS, result.task(":" + SETUP_FREGE_TASK_NAME).getOutcome());
+            assertTrue(testProjectDir.toPath().resolve(Paths.get(DEFAULT_DOWNLOAD_DIRECTORY, "frege3.25.84.jar"))
+                    .toFile().exists());
+        }
+
+        @Test
+        void given_custom_frege_compiler_download_directory_in_build_file_config()
+                throws Exception {
+            String buildFileConfigWithCustomDownloadDir = createFregeSection(fregeBuilder.version("'3.25.84'").release("'3.25alpha'")
+                    .compilerDownloadDir("layout.projectDirectory.dir('dist')").build());
+            appendToFile(buildFile, buildFileConfigWithCustomDownloadDir);
+
+            BuildResult result = runGradleTask(SETUP_FREGE_TASK_NAME);
+
+            assertTrue(project.getTasks().getByName(SETUP_FREGE_TASK_NAME) instanceof SetupFregeTask);
+            assertEquals(SUCCESS, result.task(":" + SETUP_FREGE_TASK_NAME).getOutcome());
+            assertTrue(testProjectDir.toPath().resolve(Paths.get("dist", "frege3.25.84.jar")).toFile().exists());
+        }
     }
 
-    @Test
-    void frege_compile_task_is_correctly_executed() throws Exception {
-        String fregeCode = "module ch.fhnw.thga.Completion where\n\n" + "complete :: Int -> (Int, String)\n"
-                + "complete i = (i, \"Frege rocks\")\n";
-        Files.createDirectories(testProjectDir.toPath().resolve(Paths.get("src", "main", "frege")));
-        File completionFr = testProjectDir.toPath().resolve(Paths.get("src", "main", "frege", "Completion.fr"))
-                .toFile();
-        writeToFile(completionFr, fregeCode);
-        FregeDTO minimalFregeDTO = fregeBuilder.version("'3.25.84'").release("'3.25alpha'").build();
-        assertTrue(project.getTasks().getByName(COMPILE_FREGE_TASK_NAME) instanceof CompileFregeTask);
-        assertGradleTaskOutcome(createFregeSection(minimalFregeDTO), COMPILE_FREGE_TASK_NAME);
-        assertTrue(new File(testProjectDir.getAbsolutePath() + "/build/classes/main/frege/ch/fhnw/thga/Completion.java")
-                .exists());
-        assertTrue(
-                new File(testProjectDir.getAbsolutePath() + "/build/classes/main/frege/ch/fhnw/thga/Completion.class")
-                        .exists());
+    @Nested
+    @IndicativeSentencesGeneration(separator = " -> ", generator = DisplayNameGenerator.ReplaceUnderscores.class)
+    class Compile_frege_task_works {
+
+        @Test
+        void given_frege_code_in_src_main_frege_and_minimal_build_file_config() throws Exception {
+            String fregeCode = "module ch.fhnw.thga.Completion where\n\n" + "complete :: Int -> (Int, String)\n"
+                    + "complete i = (i, \"Frege rocks\")\n";
+            Files.createDirectories(testProjectDir.toPath().resolve(Paths.get("src", "main", "frege")));
+            File completionFr = testProjectDir.toPath().resolve(Paths.get("src", "main", "frege", "Completion.fr"))
+                    .toFile();
+            writeToFile(completionFr, fregeCode);
+            String minimalBuildFileConfig = createFregeSection(fregeBuilder.version("'3.25.84'").release("'3.25alpha'").build());
+            appendToFile(buildFile, minimalBuildFileConfig);
+
+            BuildResult result = runGradleTask(COMPILE_FREGE_TASK_NAME);
+
+            assertTrue(project.getTasks().getByName(COMPILE_FREGE_TASK_NAME) instanceof CompileFregeTask);
+            assertEquals(SUCCESS, result.task(":" + COMPILE_FREGE_TASK_NAME).getOutcome());
+            assertTrue(new File(
+                    testProjectDir.getAbsolutePath() + "/build/classes/main/frege/ch/fhnw/thga/Completion.java")
+                            .exists());
+            assertTrue(new File(
+                    testProjectDir.getAbsolutePath() + "/build/classes/main/frege/ch/fhnw/thga/Completion.class")
+                            .exists());
+        }
     }
 }
\ No newline at end of file
diff --git a/src/test/java/ch/fhnw/thga/gradleplugins/FregeDTOTest.java b/src/test/java/ch/fhnw/thga/gradleplugins/FregeDTOTest.java
deleted file mode 100644
index 8df6eae..0000000
--- a/src/test/java/ch/fhnw/thga/gradleplugins/FregeDTOTest.java
+++ /dev/null
@@ -1,67 +0,0 @@
-package ch.fhnw.thga.gradleplugins;
-
-import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.junit.jupiter.api.Assertions.assertTrue;
-
-import java.util.stream.Stream;
-import java.util.stream.Collectors;
-
-import org.junit.jupiter.api.Test;
-
-public class FregeDTOTest {
-    private final FregeDTOBuilder fregeBuilder = new FregeDTOBuilder();
-
-    private static String buildFilePluginString(String pluginId) {
-        return String.format("id '%s'", pluginId);
-    }
-
-    static String createPluginsSection(Stream<String> pluginIds) {
-        String plugins = pluginIds.map(pluginId -> buildFilePluginString(pluginId)).collect(Collectors.joining("\n  "));
-        return String.format("plugins {\n  %s\n}\n", plugins);
-    }
-
-    // TODO: Is there a better alternative?
-    // needed helper method because reflection does NOT return the fields in order
-    private void assertStringContainsSubStrings(String s, Stream<String> subStrings) {
-        assertTrue(subStrings.allMatch(substring -> s.contains(substring)));
-    }
-
-    @Test
-    void given_version_then_fregeDTO_can_be_converted_to_build_file_string() {
-        FregeDTO fregeDTO = fregeBuilder.version("'3.25'").build();
-        String expected = "version = '3.25'";
-        assertEquals(expected, fregeDTO.toBuildFile());
-    }
-
-    @Test
-    void given_version_and_release_then_fregeDTO_can_be_converted_to_build_file_string() {
-        FregeDTO fregeDTO = fregeBuilder.version("'3.25'").release("'3.25alpha'").build();
-        String expected = "version = '3.25'\n  release = '3.25alpha'";
-        assertStringContainsSubStrings(expected, fregeDTO.toBuildFile().lines());
-    }
-
-    @Test
-    void given_version_release_and_compiler_download_dir_then_fregeDTO_can_be_converted_to_build_file_string() {
-        FregeDTO fregeDTO = fregeBuilder.version("'3.25'").release("'3.25alpha'")
-                .compilerDownloadDir("layout.projectDirectory.dir('dist')").build();
-        String expected = "version = '3.25'\n  release = '3.25alpha'\n  compilerDownloadDir = layout.projectDirectory.dir('dist')";
-        assertStringContainsSubStrings(expected, fregeDTO.toBuildFile().lines());
-    }
-
-    @Test
-    void given_single_plugin_id_then_it_is_correctly_converted_to_build_file_string() {
-        String pluginId = "frege";
-        Stream<String> pluginIds = Stream.of(pluginId);
-        String expected = "plugins {\n" + "  id '" + pluginId + "'\n" + "}\n";
-        assertEquals(expected, createPluginsSection(pluginIds));
-    }
-
-    @Test
-    void given_multiple_plugin_ids_then_they_are_correctly_converted_to_build_file_string() {
-        String fregeId = "frege";
-        String javaId = "java";
-        Stream<String> pluginIds = Stream.of(fregeId, javaId);
-        String expected = "plugins {\n" + "  id '" + fregeId + "'\n" + "  id '" + javaId + "'\n" + "}\n";
-        assertEquals(expected, createPluginsSection(pluginIds));
-    }
-}
diff --git a/src/test/java/ch/fhnw/thga/gradleplugins/GradleBuildFileConversionTest.java b/src/test/java/ch/fhnw/thga/gradleplugins/GradleBuildFileConversionTest.java
new file mode 100644
index 0000000..80c8827
--- /dev/null
+++ b/src/test/java/ch/fhnw/thga/gradleplugins/GradleBuildFileConversionTest.java
@@ -0,0 +1,74 @@
+package ch.fhnw.thga.gradleplugins;
+
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+import java.util.stream.Stream;
+import java.util.stream.Collectors;
+
+import org.junit.jupiter.api.DisplayNameGenerator;
+import org.junit.jupiter.api.IndicativeSentencesGeneration;
+import org.junit.jupiter.api.Nested;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.TestInstance;
+import org.junit.jupiter.api.TestInstance.Lifecycle;
+
+@TestInstance(Lifecycle.PER_CLASS)
+public class GradleBuildFileConversionTest {
+    private final FregeDTOBuilder fregeBuilder = new FregeDTOBuilder();
+
+    private static String buildFilePluginString(String pluginId) {
+        return String.format("id '%s'", pluginId);
+    }
+
+    static String createPluginsSection(Stream<String> pluginIds) {
+        String plugins = pluginIds.map(pluginId -> buildFilePluginString(pluginId)).collect(Collectors.joining("\n  "));
+        return String.format("plugins {\n  %s\n}\n", plugins);
+    }
+
+    private void assertStringContainsSubStrings(String s, Stream<String> subStrings) {
+        assertTrue(subStrings.allMatch(substring -> s.contains(substring)));
+    }
+
+    @Nested
+    @IndicativeSentencesGeneration(separator = " -> ", generator = DisplayNameGenerator.ReplaceUnderscores.class)
+    class Converting_Frege_DTO_to_build_file_key_value_pairs_works {
+
+        @Test
+        void given_single_version_property() {
+            FregeDTO fregeDTO = fregeBuilder.version("'3.25'").build();
+            String expected = "version = '3.25'";
+            assertEquals(expected, fregeDTO.toBuildFile());
+        }
+
+        @Test
+        void given_multiple_properties_in_non_deterministic_order() {
+            FregeDTO fregeDTO = fregeBuilder.version("'3.25'").release("'3.25alpha'")
+                    .compilerDownloadDir("layout.projectDirectory.dir('dist')").build();
+            String expected = "version = '3.25'\n  release = '3.25alpha'\n  compilerDownloadDir = layout.projectDirectory.dir('dist')";
+            assertStringContainsSubStrings(expected, fregeDTO.toBuildFile().lines());
+        }
+    }
+
+    @Nested
+    @IndicativeSentencesGeneration(separator = " -> ", generator = DisplayNameGenerator.ReplaceUnderscores.class)
+    class Creating_plugin_section_works {
+
+        @Test
+        void given_single_plugin_id() {
+            String pluginId = "frege";
+            Stream<String> pluginIds = Stream.of(pluginId);
+            String expected = "plugins {\n" + "  id '" + pluginId + "'\n" + "}\n";
+            assertEquals(expected, createPluginsSection(pluginIds));
+        }
+
+        @Test
+        void given_multiple_plugin_ids() {
+            String fregeId = "frege";
+            String javaId = "java";
+            Stream<String> pluginIds = Stream.of(fregeId, javaId);
+            String expected = "plugins {\n" + "  id '" + fregeId + "'\n" + "  id '" + javaId + "'\n" + "}\n";
+            assertEquals(expected, createPluginsSection(pluginIds));
+        }
+    }
+}