Merge pull request #106 from MisteliEvooq/main

Add output parameter to export

Author: jakzal

.gitignore

@@ -3,3 +3,6 @@
 
 # Ignore Gradle build output directory
 build
+
+# Ignore settings for IntelliJ IDEA
+.idea

src/functionalTest/kotlin/pl/zalas/gradle/structurizrcli/ExportFunctionalTest.kt

@@ -42,6 +42,27 @@ class ExportFunctionalTest : FunctionalTest {
         assertTrue(File("${projectDir.absolutePath}/structurizr-SystemContext.puml").exists())
     }
 
+    @Test
+    fun `it exports the workspace to a specified output dir`(@TempDir projectDir: File) {
+        givenWorkspace(projectDir, "workspace.dsl")
+        givenConfiguration(projectDir, """
+            plugins {
+                id 'pl.zalas.structurizr-cli'
+            }
+            structurizrCli {
+                export {
+                    format = "plantuml"
+                    workspace = "${projectDir.absolutePath}/workspace.dsl"
+                    output = "${projectDir.absolutePath}/output"
+                }
+            }
+        """)
+
+        execute(projectDir, "structurizrCliExport")
+
+        assertTrue(File("${projectDir.absolutePath}/output/structurizr-SystemContext.puml").exists())
+    }
+
     @Test
     fun `it exports multiple workspaces`(@TempDir projectDir: File, @TempDir workspaceDir1: File, @TempDir workspaceDir2: File) {
         givenWorkspace(workspaceDir1, "workspace1.dsl")

src/main/kotlin/pl/zalas/gradle/structurizrcli/StructurizrCliPlugin.kt

@@ -69,6 +69,7 @@ class StructurizrCliPlugin : Plugin<Project> {
                     task.dependsOn("structurizrCliExtract")
                     task.workspace.set(layout.projectDirectory.file(export.workspace))
                     task.format.set(export.format)
+                    task.output.set(outputDirectory(export))
                     task.structurizrCliJar.set(extract.flatMap { it.structurizrCliJar })
                     task.structurizrCliDirectory.set(structurizrDirectory(extension))
                     extension.exports.getOrNull(index-1)?.also { precedingExport ->
@@ -96,6 +97,11 @@ class StructurizrCliPlugin : Plugin<Project> {
             layout.projectDirectory.dir(it)
         } ?: layout.buildDirectory.dir("downloads").get()
 
+    private fun Project.outputDirectory(export: StructurizrCliPluginExtension.Export): Directory? =
+        export.output?.let {
+            layout.projectDirectory.dir(it)
+        }
+
     private fun Project.structurizrDirectory(extension: StructurizrCliPluginExtension): Directory =
         extension.extract.directory?.let {
             layout.projectDirectory.dir(it)

src/main/kotlin/pl/zalas/gradle/structurizrcli/StructurizrCliPluginExtension.kt

@@ -48,6 +48,7 @@ open class StructurizrCliPluginExtension {
     data class Export(
         var format: String = "plantuml",
         var workspace: String = "workspace.dsl",
+        var output: String? = null,
         var name: String = ""
     )
 

src/main/kotlin/pl/zalas/gradle/structurizrcli/tasks/Export.kt

@@ -21,6 +21,7 @@ import org.gradle.api.file.RegularFileProperty
 import org.gradle.api.provider.Property
 import org.gradle.api.tasks.Input
 import org.gradle.api.tasks.InputFile
+import org.gradle.api.tasks.Optional
 import org.gradle.api.tasks.OutputDirectory
 import org.gradle.api.tasks.TaskAction
 
@@ -32,6 +33,10 @@ open class Export : DefaultTask() {
     @Input
     val format: Property<String> = project.objects.property(String::class.java)
 
+    @OutputDirectory
+    @Optional
+    val output: DirectoryProperty = project.objects.directoryProperty()
+
     @InputFile
     val structurizrCliJar: RegularFileProperty = project.objects.fileProperty()
 
@@ -49,7 +54,11 @@ open class Export : DefaultTask() {
             spec.workingDir(project.layout.projectDirectory)
             spec.classpath(structurizrCliDirectory.dir("lib/*"))
             spec.mainClass.set("com.structurizr.cli.StructurizrCliApplication")
-            spec.args("export", "-workspace", workspace.get(), "-format", format.get())
+            spec.args(args())
         }
     }
+
+
+    private fun args() = listOf("export", "-workspace",  workspace.get(), "-format", format.get()) +
+            if (output.isPresent) listOf("-output", output.get()) else emptyList()
 }