aboutsummaryrefslogtreecommitdiff
path: root/src/functionalTest/java/ch/fhnw/thga/gradleplugins/FregePluginFunctionalTest.java
blob: aa3a7f4c8e65d018e17ae706ae13d8d8a0c2d154 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
package ch.fhnw.thga.gradleplugins;

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.*;
import static org.gradle.testkit.runner.TaskOutcome.SUCCESS;
import static org.gradle.testkit.runner.TaskOutcome.FAILED;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertTrue;

import java.io.BufferedWriter;
import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.stream.Stream;

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 static final String NEW_LINE = System.lineSeparator();
    private static final String SIMPLE_FREGE_CODE = String.join(NEW_LINE,
          "module ch.fhnw.thga.Completion where", NEW_LINE,
          NEW_LINE,
          "  complete :: Int -> (Int, String)", NEW_LINE,
          "  complete i = (i, \"Frege rocks\")", NEW_LINE);

    private static FregeDTOBuilder fregeBuilder;

    @TempDir
    File testProjectDir;
    private File buildFile;
    private File settingsFile;
    private Project project;

    private void writeFile(File destination, String content, boolean append) throws IOException {
        try (BufferedWriter output = new BufferedWriter(new FileWriter(destination, append))) {
            output.write(content);
        }
    }

    private void writeToFile(File destination, String content) throws IOException {
        writeFile(destination, content, false);
    }

    private void appendToFile(File destination, String content) throws IOException {
        writeFile(destination, "\n" + content, true);
    }

    private static String createFregeSection(FregeDTO fregeDTO) {
        return String.format("%s {\n  %s\n}", FREGE_EXTENSION_NAME, fregeDTO.toBuildFile());
    }

    private BuildResult runGradleTask(String... taskName) {
        return GradleRunner.create().withProjectDir(testProjectDir).withPluginClasspath().withArguments(taskName)
                .build();
    }

    private BuildResult runAndFailGradleTask(String taskName, String... args) {
        return GradleRunner.create().withProjectDir(testProjectDir).withPluginClasspath().withArguments(taskName)
                .buildAndFail();
    }

    private void setupDefaultFregeProjectStructure(String fregeCode, String fregeFileName, String buildFileConfig) throws Exception {
        Files.createDirectories(testProjectDir.toPath().resolve(Paths.get("src", "main", "frege")));
        File fregeFile = testProjectDir.toPath().resolve(Paths.get("src", "main", "frege", fregeFileName))
                .toFile();
        writeToFile(fregeFile, fregeCode);
        appendToFile(buildFile, buildFileConfig);
    }

    @BeforeAll
    void beforeAll() throws Exception {
        settingsFile = new File(testProjectDir, "settings.gradle");
        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)));
        fregeBuilder = FregeDTOBuilder.getInstance();
    }

    @AfterEach
    void cleanup() {
        testProjectDir.delete();
    }

    @Nested
    @TestInstance(Lifecycle.PER_CLASS)
    @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());
        }
    }

    @Nested
    @TestInstance(Lifecycle.PER_CLASS)
    @IndicativeSentencesGeneration(separator = " -> ", generator = DisplayNameGenerator.ReplaceUnderscores.class)
    class Compile_frege_task_works {

        @Test
        void given_frege_code_in_default_source_dir_and_minimal_build_file_config() throws Exception {
            String completionFr = "Completion.fr";
            String minimalBuildFileConfig = createFregeSection(
                    fregeBuilder.version("'3.25.84'").release("'3.25alpha'").build());
            setupDefaultFregeProjectStructure(SIMPLE_FREGE_CODE, completionFr, 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());
        }

        @Test
        void given_frege_code_in_custom_source_dir_and_custom_output_dir_and_minimal_build_file_config()
                throws Exception {
            Path customMainSourceDir = testProjectDir.toPath().resolve(Paths.get("src", "frege"));
            Files.createDirectories(customMainSourceDir);
            File completionFr = customMainSourceDir.resolve("Completion.fr").toFile();
            writeToFile(completionFr, SIMPLE_FREGE_CODE);
            String minimalBuildFileConfig = createFregeSection(fregeBuilder.version("'3.25.84'").release("'3.25alpha'")
                    .mainSourceDir("layout.projectDirectory.dir('src/frege')")
                    .outputDir("layout.buildDirectory.dir('frege')").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/frege/ch/fhnw/thga/Completion.java").exists());
            assertTrue(
                    new File(testProjectDir.getAbsolutePath() + "/build/frege/ch/fhnw/thga/Completion.class").exists());
        }
    }

    @Nested
    @TestInstance(Lifecycle.PER_CLASS)
    @IndicativeSentencesGeneration(separator = " -> ", generator = DisplayNameGenerator.ReplaceUnderscores.class)
    class Run_frege_task_works {
        @Test
        void given_frege_file_with_main_function_and_main_module_config() throws Exception {
            String fregeCode = String.join(NEW_LINE, "module ch.fhnw.thga.Main where", NEW_LINE, NEW_LINE,
                    "  main = do", NEW_LINE, "    println \"Frege rocks\"", NEW_LINE);
            String mainFr = "Main.fr";
            String buildFileConfig = createFregeSection(
                    fregeBuilder.version("'3.25.84'").release("'3.25alpha'")
                    .mainModule("'ch.fhnw.thga.Main'").build());
            setupDefaultFregeProjectStructure(fregeCode, mainFr, buildFileConfig);

            BuildResult result = runGradleTask(RUN_FREGE_TASK_NAME);
            assertTrue(project.getTasks().getByName(RUN_FREGE_TASK_NAME) instanceof RunFregeTask);
            assertEquals(SUCCESS, result.task(":" + RUN_FREGE_TASK_NAME).getOutcome());
            assertTrue(result.getOutput().contains("Frege rocks"));
        }

        @Test
        void given_frege_file_without_main_function() throws Exception {
            String completionFr = "Completion.fr";
            String buildFileConfig = createFregeSection(
                    fregeBuilder.version("'3.25.84'").release("'3.25alpha'")
                            .mainModule("'ch.fhnw.thga.Completion'").build());
            setupDefaultFregeProjectStructure(SIMPLE_FREGE_CODE, completionFr, buildFileConfig);

            BuildResult result = runAndFailGradleTask(RUN_FREGE_TASK_NAME);
            assertTrue(project.getTasks().getByName(RUN_FREGE_TASK_NAME) instanceof RunFregeTask);
            assertEquals(FAILED, result.task(":" + RUN_FREGE_TASK_NAME).getOutcome());
            assertTrue(result.getOutput().contains("Main method not found"));
        }

        @Test
        void given_frege_file_with_main_function_and_main_module_command_line_option() throws Exception {
            String fregeCode = String.join(NEW_LINE, "module ch.fhnw.thga.Main where", NEW_LINE, NEW_LINE,
                    "  main = do", NEW_LINE, "    println \"Frege rocks\"", NEW_LINE);
            String mainFr = "Main.fr";
            String buildFileConfig = createFregeSection(
                    fregeBuilder.version("'3.25.84'").release("'3.25alpha'").build());
            setupDefaultFregeProjectStructure(fregeCode, mainFr, buildFileConfig);

            BuildResult result = runGradleTask(RUN_FREGE_TASK_NAME, "--mainModule=ch.fhnw.thga.Main");
            assertTrue(project.getTasks().getByName(RUN_FREGE_TASK_NAME) instanceof RunFregeTask);
            assertEquals(SUCCESS, result.task(":" + RUN_FREGE_TASK_NAME).getOutcome());
            assertTrue(result.getOutput().contains("Frege rocks"));
        }
    }
}