Feature/2619/import from metric gardener

CHANGELOG.md

@@ -7,11 +7,15 @@ and this project adheres to [Semantic Versioning](http://semver.org/)
 
 ## [unreleased] (Added 🚀 | Changed | Removed 🗑 | Fixed 🐞 | Chore 👨‍💻 👩‍💻)
 
-## Changed
+### Added 🚀
+
+-   Transform a metric gardener json file into a code charta json file, that can be correctly visualized [#2675](https://github.com/MaibornWolff/codecharta/pull/2875)
+
+### Changed
 
 -   Restore previous selected files when switching back from delta to standard mode [#2891](https://github.com/MaibornWolff/codecharta/pull/2891)
 
-## Fixed 🐞
+### Fixed 🐞
 
 -   Let file selection always show what is actual rendered within the map [#2891](https://github.com/MaibornWolff/codecharta/pull/2891)
 

analysis/build.gradle

@@ -150,11 +150,15 @@ task integrationTest(type: Exec) {
     if (System.properties['os.name'].toLowerCase().contains('windows')) {
         println "In order to run the integration tests a bash script is executed."
         println "Make sure to use a shell with bash capability (e.g. GitBash) to run this task."
+        executable 'bash'
+        workingDir('test')
+        args '-c', "./golden_test.sh $version"
+    }
+    else {
+        executable 'sh'
+        workingDir('test')
+        args '-c', "./golden_test.sh $version"
     }
-
-    executable 'sh'
-    workingDir('test')
-    args '-c', "./golden_test.sh $version"
 }
 
 task jacocoTestReport(type: JacocoReport) {

analysis/import/MetricGardenerImporter/README.md

@@ -0,0 +1,5 @@
+### Metric-Gardener Importer
+
+This importer receives a json-File generated by the Metric Gardener Importer as input
+[metric-gardener ](https://github.com/MaibornWolff/metric-gardener/)and returns a cc.json file.
+It is optional to generate a compressed cc.json file.

analysis/import/MetricGardenerImporter/build.gradle

@@ -0,0 +1,38 @@
+plugins {
+    id "com.github.node-gradle.node" version "3.4.0"
+}
+
+dependencies {
+
+    implementation project(':tools:InteractiveParser')
+    implementation project(':import:SourceCodeParser')
+    implementation project(':model')
+
+    implementation group: 'io.reactivex.rxjava2', name: 'rxjava', version: '2.2.21'
+    implementation group: 'org.glassfish.jersey.core', name: 'jersey-client', version: jersey_version
+    implementation group: 'com.google.code.gson', name: 'gson', version: gson_version
+    implementation group: 'info.picocli', name: 'picocli', version: picocli_version
+    implementation group: 'io.github.microutils', name: 'kotlin-logging', version: kotlin_logging_version
+    implementation group: 'com.github.kotlin-inquirer', name: 'kotlin-inquirer', version: kotlin_inquirer_version
+    implementation group: 'com.fasterxml.jackson', name: 'jackson-base', version: jackson_version
+    implementation group: 'com.fasterxml.jackson.dataformat', name: 'jackson-dataformat-xml', version: jackson_version
+    implementation group: 'com.fasterxml.jackson.module', name: 'jackson-module-kotlin', version: jackson_version
+
+    implementation group: 'org.slf4j', name: 'slf4j-simple', version: slf4j_version
+    implementation group: 'org.glassfish.jersey.inject', name: 'jersey-hk2', version: jersey_version
+    implementation group: 'com.sun.activation', name: 'javax.activation', version: '1.2.0'
+
+
+    testImplementation group: 'junit', name: 'junit', version: junit4_version
+    testImplementation group: 'org.assertj', name: 'assertj-core', version: assertj_version
+    testImplementation group: 'org.hamcrest', name: 'hamcrest-core', version: hamcrest_version
+    testImplementation group: 'org.hamcrest', name: 'hamcrest-library', version: hamcrest_version
+    testImplementation group: 'io.mockk', name: 'mockk', version: mockk_version
+    testImplementation group: 'com.github.tomakehurst', name: 'wiremock', version: wiremock_version
+
+    testRuntimeOnly group: 'org.junit.vintage', name: 'junit-vintage-engine', version: junit5_version
+}
+
+test {
+    useJUnitPlatform()
+}

analysis/import/MetricGardenerImporter/src/main/kotlin/de/maibornwolff/codecharta/importer/metricgardenerimporter/MetricGardenerImporter.kt

@@ -0,0 +1,84 @@
+package de.maibornwolff.codecharta.importer.metricgardenerimporter
+
+import com.fasterxml.jackson.module.kotlin.jacksonObjectMapper
+import de.maibornwolff.codecharta.importer.metricgardenerimporter.json.MetricGardenerProjectBuilder
+import de.maibornwolff.codecharta.importer.metricgardenerimporter.model.MetricGardenerNodes
+import de.maibornwolff.codecharta.serialization.ProjectSerializer
+import de.maibornwolff.codecharta.tools.interactiveparser.InteractiveParser
+import de.maibornwolff.codecharta.tools.interactiveparser.ParserDialogInterface
+import mu.KotlinLogging
+import picocli.CommandLine
+import java.io.BufferedWriter
+import java.io.File
+import java.io.FileWriter
+import java.io.IOException
+import java.nio.charset.Charset
+import java.nio.file.Paths
+import java.util.concurrent.Callable
+
+@CommandLine.Command(
+    name = "metricgardenerimport",
+    description = ["generates a cc.json file from a project parsed with metric-gardener"],
+    footer = ["Copyright(c) 2022, MaibornWolff GmbH"]
+                    )
+
+class MetricGardenerImporter : Callable<Void>, InteractiveParser {
+
+    private val logger = KotlinLogging.logger {}
+    private val mapper = jacksonObjectMapper()
+
+    @CommandLine.Option(
+        names = ["-h", "--help"], usageHelp = true,
+        description = ["Specify: path/to/input/folder/or/file -o path/to/outputfile.json"]
+                       )
+    private var help = false
+
+    @CommandLine.Parameters(
+        arity = "1", paramLabel = "FOLDER or FILE",
+        description = ["path for project folder or code file"]
+                           )
+    private var inputFile = File("")
+
+    @CommandLine.Option(names = ["-o", "--output-file"], description = ["output File (or empty for stdout)"])
+    private var outputFile = File("")
+
+    @CommandLine.Option(names = ["-nc", "--not-compressed"], description = ["save uncompressed output File"])
+    private var compress = true
+
+    @Throws(IOException::class)
+    override fun call(): Void? {
+        if (!inputFile.exists()) {
+            printErrorLog()
+            return null
+        }
+        val metricGardenerNodes: MetricGardenerNodes =
+            mapper.readValue(inputFile.reader(Charset.defaultCharset()), MetricGardenerNodes::class.java)
+        val metricGardenerProjectBuilder = MetricGardenerProjectBuilder(metricGardenerNodes)
+        val project = metricGardenerProjectBuilder.build()
+        val filePath = outputFile.absolutePath ?: "notSpecified"
+        if (compress && filePath != "notSpecified") {
+            ProjectSerializer.serializeAsCompressedFile(project, filePath)
+        } else {
+            val outputWriter = BufferedWriter(FileWriter(outputFile))
+            ProjectSerializer.serializeProject(project, outputWriter)
+        }
+
+        return null
+    }
+
+    private fun printErrorLog() {
+        val path = Paths.get("").toAbsolutePath().toString()
+        logger.error { "Current working directory = $path" }
+        logger.error { "Could not find $inputFile" }
+    }
+
+    companion object {
+
+        @JvmStatic
+        fun main(args: Array<String>) {
+            CommandLine.call(MetricGardenerImporter(), System.out, *args)
+        }
+    }
+
+    override fun getDialog(): ParserDialogInterface = ParserDialog
+}

analysis/import/MetricGardenerImporter/src/main/kotlin/de/maibornwolff/codecharta/importer/metricgardenerimporter/ParserDialog.kt

@@ -0,0 +1,32 @@
+package de.maibornwolff.codecharta.importer.metricgardenerimporter
+
+import com.github.kinquirer.KInquirer
+import com.github.kinquirer.components.promptConfirm
+import com.github.kinquirer.components.promptInput
+import de.maibornwolff.codecharta.tools.interactiveparser.ParserDialogInterface
+
+class ParserDialog {
+    companion object : ParserDialogInterface {
+
+        override fun collectParserArgs(): List<String> {
+            val inputFile = KInquirer.promptInput(
+                message = "What Project do you want to parse?",
+                hint = "path/to/my/project"
+                                                 )
+
+            val outputFileName: String = KInquirer.promptInput(
+                message = "What is the name of the output file?",
+                hint = "path/to/output/filename.cc.json"
+                                                              )
+
+            val isCompressed: Boolean =
+                KInquirer.promptConfirm(message = "Do you want to compress the output file?", default = true)
+
+            return listOfNotNull(
+                inputFile,
+                "--output-file=$outputFileName",
+                if (isCompressed) null else "--not-compressed"
+                                )
+        }
+    }
+}

analysis/import/MetricGardenerImporter/src/main/kotlin/de/maibornwolff/codecharta/importer/metricgardenerimporter/json/MetricGardenerProjectBuilder.kt

@@ -0,0 +1,36 @@
+package de.maibornwolff.codecharta.importer.metricgardenerimporter.json
+
+import de.maibornwolff.codecharta.importer.metricgardenerimporter.model.MetricGardenerNode
+import de.maibornwolff.codecharta.importer.metricgardenerimporter.model.MetricGardenerNodes
+import de.maibornwolff.codecharta.model.MutableNode
+import de.maibornwolff.codecharta.model.NodeType
+import de.maibornwolff.codecharta.model.Project
+import de.maibornwolff.codecharta.model.ProjectBuilder
+import mu.KotlinLogging
+
+class MetricGardenerProjectBuilder(var metricGardenerNodes: MetricGardenerNodes) : ProjectBuilder() {
+
+    private val logger = KotlinLogging.logger {}
+
+    override fun build(): Project {
+        var i = 0
+        for (inputNode in metricGardenerNodes.metricGardenerNodes) {
+            val node = generateCodeChartaFileNode(inputNode)
+            insertByPath(inputNode.getPathWithoutFileName(), node)
+            i = i.inc()
+            logger.info { "$i. Node  von ${metricGardenerNodes.metricGardenerNodes.size} MetricGardenerNodes wurde eingelesen." }
+        }
+        return super.build()
+    }
+
+    fun generateCodeChartaFileNode(metricGardenerNode: MetricGardenerNode): MutableNode {
+        return MutableNode(extractFileNameFromPath(metricGardenerNode.name), NodeType.File, metricGardenerNode.metrics, "", setOf())
+    }
+
+    private fun extractFileNameFromPath(path: String?): String {
+        if (!path.isNullOrBlank()) {
+            return path.split("\\").reversed().get(0)
+        }
+        return ""
+    }
+}

analysis/import/MetricGardenerImporter/src/main/kotlin/de/maibornwolff/codecharta/importer/metricgardenerimporter/model/MetricGardenerNode.kt

@@ -0,0 +1,40 @@
+package de.maibornwolff.codecharta.importer.metricgardenerimporter.model
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties
+import com.fasterxml.jackson.annotation.JsonProperty
+import de.maibornwolff.codecharta.model.Path
+
+@JsonIgnoreProperties("types")
+class MetricGardenerNode(
+    @JsonProperty("name") var name: String?,
+    @JsonProperty("type") var type: String?,
+    @JsonProperty("metrics") var metrics: Map<String, Any>
+                        ) {
+
+    fun getPathWithoutFileName(): Path {
+        if (!name.isNullOrBlank()) {
+            return Path(name!!.split("\\").dropLast(1))
+        }
+        return Path(emptyList())
+    }
+
+    override fun equals(other: Any?): Boolean {
+        if (this === other) return true
+        if (javaClass != other?.javaClass) return false
+
+        other as MetricGardenerNode
+
+        if (name != other.name) return false
+        if (type != other.type) return false
+        if (metrics != other.metrics) return false
+
+        return true
+    }
+
+    override fun hashCode(): Int {
+        var result = name?.hashCode() ?: 0
+        result = 31 * result + (type?.hashCode() ?: 0)
+        result = 31 * result + metrics.hashCode()
+        return result
+    }
+}

analysis/import/MetricGardenerImporter/src/main/kotlin/de/maibornwolff/codecharta/importer/metricgardenerimporter/model/MetricGardenerNodes.kt

@@ -0,0 +1,25 @@
+package de.maibornwolff.codecharta.importer.metricgardenerimporter.model
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties
+import com.fasterxml.jackson.annotation.JsonProperty
+
+@JsonIgnoreProperties("relationships")
+class MetricGardenerNodes(
+    @JsonProperty("nodes") var metricGardenerNodes: MutableList<MetricGardenerNode>
+                         ) {
+
+    override fun equals(other: Any?): Boolean {
+        if (this === other) return true
+        if (javaClass != other?.javaClass) return false
+
+        other as MetricGardenerNodes
+
+        if (metricGardenerNodes != other.metricGardenerNodes) return false
+
+        return true
+    }
+
+    override fun hashCode(): Int {
+        return metricGardenerNodes.hashCode()
+    }
+}

analysis/import/MetricGardenerImporter/src/test/kotlin/de/maibornwolff/codecharta/importer/metricgardenerimporter/MetricGardenerImporterTest.kt

@@ -0,0 +1,53 @@
+package de.maibornwolff.codecharta.importer.metricgardenerimporter
+
+import de.maibornwolff.codecharta.importer.metricgardenerimporter.MetricGardenerImporter.Companion.main
+import org.junit.jupiter.api.Assertions.assertFalse
+import org.junit.jupiter.api.Assertions.assertTrue
+import org.junit.jupiter.api.Test
+import java.io.File
+
+class MetricGardenerImporterTest {
+
+    private val metricGardenerImporter = MetricGardenerImporter()
+
+    @Test
+    fun `should create json uncompressed file`() {
+        main(
+            arrayOf(
+                "src/test/resources/metricgardener-analysis.json", "-nc",
+                "-o=src/test/resources/metricgardener-analysis.cc.json"
+                   )
+            )
+        val file = File("src/test/resources/metricgardener-analysis.cc.json")
+        file.deleteOnExit()
+
+        assertTrue(file.exists())
+    }
+
+    @Test
+    fun `should create json gzip file`() {
+        main(
+            arrayOf(
+                "src/test/resources/metricgardener-analysis.json",
+                "-o=src/test/resources/metricgardener-analysis.cc.json"
+                   )
+            )
+        val file = File("src/test/resources/metricgardener-analysis.cc.json.gz")
+        file.deleteOnExit()
+
+        assertTrue(file.exists())
+    }
+
+    @Test
+    fun `should create no file when the input file was not specified`() {
+        main(
+            arrayOf(
+                "-o=src/test/resources/metricgardener-analysis.cc.json"
+                   )
+            )
+        val file = File("src/test/resources/metricgardener-analysis.cc.json.gz")
+        file.deleteOnExit()
+        metricGardenerImporter.call()
+        assertFalse(file.exists())
+    }
+}