Spring/spring-modulith
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

GH-644 - Add option to clean the output directory in documentation generation.

Browse Source
This commit is contained in:
Tobias Haindl
2024-06-22 14:11:56 +02:00
committed by Oliver Drotbohm
parent b4dae619c1
commit 08430ad1af
2 changed files with 76 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
spring-modulith-integration-test/src/test/java/org/springframework/modulith/docs/DocumenterTest.java
View File

@@ -27,10 +27,12 @@ import java.util.Optional;
import java.util.stream.Stream;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;
import org.springframework.modulith.core.ApplicationModule;
import org.springframework.modulith.core.ApplicationModules;
import org.springframework.modulith.core.DependencyType;
import org.springframework.modulith.docs.Documenter.DiagramOptions;
import org.springframework.modulith.docs.Documenter.Options;
import org.springframework.util.function.ThrowingConsumer;
import com.acme.myproject.Application;
@@ -139,6 +141,46 @@ class DocumenterTest {
});
}
@Test
void shouldCleanOutputLocation(@TempDir Path outputDirectory) throws IOException {
var filePath = createTestFile(outputDirectory);
var nestedFiledPath = createTestFileInSubdirectory(outputDirectory);
new Documenter(ApplicationModules.of(Application.class), outputDirectory.toString()).writeDocumentation();
assertThat(filePath).doesNotExist();
assertThat(nestedFiledPath).doesNotExist();
assertThat(Files.list(outputDirectory)).isNotEmpty();
}
@Test
void shouldNotCleanOutputLocation(@TempDir Path outputDirectory) throws IOException {
var filePath = createTestFile(outputDirectory);
var nestedFiledPath = createTestFileInSubdirectory(outputDirectory);
new Documenter(ApplicationModules.of(Application.class),
Options.defaults().withOutputFolder(outputDirectory.toString()).withoutClean())
.writeDocumentation();
assertThat(filePath).exists();
assertThat(nestedFiledPath).exists();
assertThat(Files.list(outputDirectory)).isNotEmpty();
}
private static Path createTestFile(Path tempDir) throws IOException {
return createFile(tempDir.resolve("some-old-module.adoc"));
}
private static Path createTestFileInSubdirectory(Path tempDir) throws IOException {
return createFile(tempDir.resolve("some-subdirectory").resolve("old-module.adoc"));
}
private static Path createFile(Path filePath) throws IOException {
return Files.createDirectories(filePath);
}
private static void deleteDirectoryContents(Path path) throws IOException {
if (Files.exists(path) && Files.isDirectory(path)) {