Feature/3307/detect-invalid-file-input

CHANGELOG.md

@@ -7,6 +7,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/)
 
 ## [unreleased] (Added 🚀 | Changed | Removed 🗑 | Fixed 🐞 | Chore 👨‍💻 👩‍💻)
 
+### Added 🚀
+
+-   Add message outputting which parser is being configured during parser suggestions [#3335](https://github.com/MaibornWolff/codecharta/pull/3335)
+-   Add basic validity checking for all input resources (files/folders, url for SonarImporter) [#3325](https://github.com/MaibornWolff/codecharta/pull/3325)
+
 ## [1.118.0] - 2023-06-15
 
 ### Added 🚀
@@ -16,7 +21,6 @@ and this project adheres to [Semantic Versioning](http://semver.org/)
 -   Expand and restructure documentation regarding Docker usage [#3312](https://github.com/MaibornWolff/codecharta/pull/3312)
 -   Add current working directories as hint or default value to interactive parser and parser suggestions when asking for input [#3319](https://github.com/MaibornWolff/codecharta/pull/3319)
 -   Add helpful status messages when calculating parser suggestions [#3329](https://github.com/MaibornWolff/codecharta/pull/3329)
--   Add message outputting which parser is being configured during parser suggestions [#3335](https://github.com/MaibornWolff/codecharta/pull/3335)
 
 ### Fixed 🐞
 

analysis/export/CSVExporter/src/main/kotlin/de/maibornwolff/codecharta/exporter/csv/CSVExporter.kt

@@ -9,6 +9,7 @@ import de.maibornwolff.codecharta.serialization.ProjectDeserializer
 import de.maibornwolff.codecharta.tools.interactiveparser.InteractiveParser
 import de.maibornwolff.codecharta.tools.interactiveparser.ParserDialogInterface
 import de.maibornwolff.codecharta.tools.interactiveparser.util.InteractiveParserHelper
+import de.maibornwolff.codecharta.util.InputHelper
 import picocli.CommandLine
 import java.io.BufferedWriter
 import java.io.File
@@ -51,6 +52,10 @@ class CSVExporter : Callable<Void>, InteractiveParser {
             throw IllegalArgumentException("depth-of-hierarchy must not be negative")
         }
 
+        if (!InputHelper.isInputValid(sources, canInputContainFolders = false)) {
+            throw IllegalArgumentException("Input invalid file for CSVExporter, stopping execution...")
+        }
+
         val projects = sources.map { ProjectDeserializer.deserializeProject(it.inputStream()) }
 
         projects.forEach { writeUsingWriter(it, writer()) }

analysis/export/CSVExporter/src/test/kotlin/de/maibornwolff/codecharta/exporter/csvexporter/CSVExporterTest.kt

@@ -0,0 +1,39 @@
+package de.maibornwolff.codecharta.exporter.csvexporter
+
+import de.maibornwolff.codecharta.exporter.csv.CSVExporter
+import de.maibornwolff.codecharta.util.InputHelper
+import io.mockk.every
+import io.mockk.mockkObject
+import io.mockk.unmockkAll
+import org.assertj.core.api.Assertions
+import org.junit.jupiter.api.AfterAll
+import org.junit.jupiter.api.Test
+import org.junit.jupiter.api.TestInstance
+import picocli.CommandLine
+import java.io.ByteArrayOutputStream
+import java.io.PrintStream
+
+@TestInstance(TestInstance.Lifecycle.PER_CLASS)
+class CSVExporterTest {
+    val errContent = ByteArrayOutputStream()
+    val originalErr = System.err
+
+    @AfterAll
+    fun afterTest() {
+        unmockkAll()
+    }
+
+    @Test
+    fun `should stop execution if input files are invalid`() {
+        mockkObject(InputHelper)
+        every {
+            InputHelper.isInputValid(any(), any())
+        } returns false
+
+        System.setErr(PrintStream(errContent))
+        CommandLine(CSVExporter()).execute("thisDoesNotExist.cc.json").toString()
+        System.setErr(originalErr)
+
+        Assertions.assertThat(errContent.toString()).contains("Input invalid file for CSVExporter, stopping execution")
+    }
+}

analysis/filter/EdgeFilter/src/main/kotlin/de/maibornwolff/codecharta/filter/edgefilter/EdgeFilter.kt

@@ -5,6 +5,7 @@ import de.maibornwolff.codecharta.serialization.ProjectSerializer
 import de.maibornwolff.codecharta.tools.interactiveparser.InteractiveParser
 import de.maibornwolff.codecharta.tools.interactiveparser.ParserDialogInterface
 import de.maibornwolff.codecharta.tools.interactiveparser.util.InteractiveParserHelper
+import de.maibornwolff.codecharta.util.InputHelper
 import picocli.CommandLine
 import java.io.File
 import java.io.PrintStream
@@ -22,8 +23,8 @@ class EdgeFilter(
     @CommandLine.Option(names = ["-h", "--help"], usageHelp = true, description = ["displays this help and exits"])
     var help: Boolean = false
 
-    @CommandLine.Parameters(arity = "1..*", paramLabel = "FILE", description = ["files to filter"])
-    private var source: String = ""
+    @CommandLine.Parameters(arity = "1", paramLabel = "FILE", description = ["files to filter"])
+    private var source: File? = null
 
     @CommandLine.Option(names = ["--path-separator"], description = ["path separator (default = '/')"])
     private var pathSeparator = '/'
@@ -32,7 +33,11 @@ class EdgeFilter(
     private var outputFile: String? = null
 
     override fun call(): Void? {
-        val srcProject = ProjectDeserializer.deserializeProject(File(source).inputStream())
+        if (!InputHelper.isInputValidAndNotNull(arrayOf(source), canInputContainFolders = false)) {
+            throw IllegalArgumentException("Input invalid file for EdgeFilter, stopping execution...")
+        }
+
+        val srcProject = ProjectDeserializer.deserializeProject(source!!.inputStream())
 
         val newProject = EdgeProjectBuilder(srcProject, pathSeparator).merge()
 

analysis/filter/EdgeFilter/src/test/kotlin/de/maibornwolff/codecharta/filter/edgefilter/EdgeFilterTest.kt

@@ -1,11 +1,30 @@
 package de.maibornwolff.codecharta.filter.edgefilter
 
 import de.maibornwolff.codecharta.filter.edgefilter.EdgeFilter.Companion.main
+import de.maibornwolff.codecharta.util.InputHelper
+import io.mockk.every
+import io.mockk.mockkObject
+import io.mockk.unmockkAll
+import org.assertj.core.api.Assertions
+import org.junit.jupiter.api.AfterEach
 import org.junit.jupiter.api.Assertions.assertTrue
 import org.junit.jupiter.api.Test
+import org.junit.jupiter.api.TestInstance
+import picocli.CommandLine
+import java.io.ByteArrayOutputStream
 import java.io.File
+import java.io.PrintStream
 
+@TestInstance(TestInstance.Lifecycle.PER_CLASS)
 class EdgeFilterTest {
+    val errContent = ByteArrayOutputStream()
+    val originalErr = System.err
+
+    @AfterEach
+    fun afterTest() {
+        unmockkAll()
+    }
+
     @Test
     fun `should create json uncompressed file`() {
         main(
@@ -18,4 +37,18 @@ class EdgeFilterTest {
 
         assertTrue(file.exists())
     }
+
+    @Test
+    fun `should stop execution if input file is invalid`() {
+        mockkObject(InputHelper)
+        every {
+            InputHelper.isInputValid(any(), any())
+        } returns false
+
+        System.setErr(PrintStream(errContent))
+        CommandLine(EdgeFilter()).execute("thisDoesNotExist.cc.json").toString()
+        System.setErr(originalErr)
+
+        Assertions.assertThat(errContent.toString()).contains("Input invalid file for EdgeFilter, stopping execution")
+    }
 }

analysis/filter/EdgeFilter/src/test/kotlin/de/maibornwolff/codecharta/filter/edgefilter/ParserDialogTest.kt

@@ -10,6 +10,7 @@ import org.junit.jupiter.api.AfterAll
 import org.junit.jupiter.api.Test
 import org.junit.jupiter.api.TestInstance
 import picocli.CommandLine
+import java.io.File
 
 @TestInstance(TestInstance.Lifecycle.PER_CLASS)
 class ParserDialogTest {
@@ -44,6 +45,6 @@ class ParserDialogTest {
         val parseResult = cmdLine.parseArgs(*parserArguments.toTypedArray())
         assertThat(parseResult.matchedOption("output-file").getValue<String>()).isEqualTo("sampleOutputFile")
         assertThat(parseResult.matchedOption("path-separator").getValue<Char>()).isEqualTo('/')
-        assertThat(parseResult.matchedPositional(0).getValue<String>()).isEqualTo("sampleFile.cc.json")
+        assertThat(parseResult.matchedPositional(0).getValue<File>()).isEqualTo(File("sampleFile.cc.json"))
     }
 }

analysis/filter/MergeFilter/src/main/kotlin/de/maibornwolff/codecharta/filter/mergefilter/MergeFilter.kt

@@ -58,11 +58,10 @@ class MergeFilter(
                 )
             }
 
-        val sourceFiles = InputHelper.getAndCheckAllSpecifiedInputFiles(sources)
-        if (sourceFiles.isEmpty()) {
-            logger.error("Aborting execution because one or more input files have not been found or no input was specified at all!")
-            return null
+        if (!InputHelper.isInputValid(sources, canInputContainFolders = true)) {
+            throw IllegalArgumentException("Input invalid files/folders for MergeFilter, stopping execution...")
         }
+        val sourceFiles = InputHelper.getFileListFromValidatedResourceArray(sources)
 
         val srcProjects = sourceFiles
             .mapNotNull {

analysis/filter/MergeFilter/src/test/kotlin/de/maibornwolff/codecharta/filter/mergefilter/MergeFilterTest.kt

@@ -1,20 +1,16 @@
 package de.maibornwolff.codecharta.filter.mergefilter
 
 import de.maibornwolff.codecharta.filter.mergefilter.MergeFilter.Companion.main
-import de.maibornwolff.codecharta.model.Project
-import de.maibornwolff.codecharta.serialization.ProjectDeserializer
 import de.maibornwolff.codecharta.util.InputHelper
 import io.mockk.every
 import io.mockk.mockkObject
 import io.mockk.unmockkAll
-import io.mockk.verify
 import org.assertj.core.api.Assertions.assertThat
 import org.junit.jupiter.api.AfterEach
 import org.junit.jupiter.api.Test
 import picocli.CommandLine
 import java.io.ByteArrayOutputStream
 import java.io.File
-import java.io.FileInputStream
 import java.io.PrintStream
 
 class MergeFilterTest {
@@ -98,26 +94,18 @@ class MergeFilterTest {
     }
 
     @Test
-    fun `should abort if at least one input file does not exist`() {
+    fun `should not execute merge if input is invalid`() {
         mockkObject(InputHelper)
         every {
-            InputHelper.getAndCheckAllSpecifiedInputFiles(any())
-        } returns mutableListOf()
-
-        mockkObject(ProjectDeserializer)
-        every {
-            ProjectDeserializer.deserializeProject(any<FileInputStream>())
-        } returns Project("")
+            InputHelper.isInputValid(any(), any())
+        } returns false
 
         System.setErr(PrintStream(errContent))
         CommandLine(MergeFilter()).execute(
                 "src/test/resources/mergeFolderTest/file1.cc.json",
-                "src/test/resources/mergeFolderTest/file2.cc.json",
                 "src/test/resources/thisDoesNotExist.cc.json").toString()
         System.setErr(originalErr)
 
-        assertThat(errContent.toString()).contains("Aborting execution because one or more input files have not been found or no input was specified at all!")
-
-        verify(exactly = 0) { ProjectDeserializer.deserializeProject(any<FileInputStream>()) }
+        assertThat(errContent.toString()).contains("Input invalid files/folders for MergeFilter, stopping execution")
     }
 }

analysis/filter/StructureModifier/src/main/kotlin/de/maibornwolff/codecharta/filter/structuremodifier/StructureModifier.kt

@@ -6,6 +6,7 @@ import de.maibornwolff.codecharta.serialization.ProjectSerializer
 import de.maibornwolff.codecharta.tools.interactiveparser.InteractiveParser
 import de.maibornwolff.codecharta.tools.interactiveparser.ParserDialogInterface
 import de.maibornwolff.codecharta.tools.interactiveparser.util.InteractiveParserHelper
+import de.maibornwolff.codecharta.util.InputHelper
 import mu.KotlinLogging
 import picocli.CommandLine
 import java.io.File
@@ -78,9 +79,10 @@ class StructureModifier(
     private fun readProject(): Project? {
         if (source == null) {
             return ProjectDeserializer.deserializeProject(input)
-        } else if (!source!!.isFile) {
-            logger.error("${source!!.name} has not been found.")
-            return null
+        }
+
+        if (!InputHelper.isInputValid(arrayOf(source!!), canInputContainFolders = false)) {
+            throw IllegalArgumentException("Input invalid file for StructureModifier, stopping execution...")
         }
 
         val input = source!!.inputStream()

analysis/filter/StructureModifier/src/test/kotlin/de/maibornwolff/codecharta/filter/structuremodifier/StructureModifierTest.kt

@@ -1,14 +1,29 @@
 package de.maibornwolff.codecharta.filter.structuremodifier
 
 import de.maibornwolff.codecharta.serialization.ProjectDeserializer
+import de.maibornwolff.codecharta.util.InputHelper
+import io.mockk.every
+import io.mockk.mockkObject
+import io.mockk.unmockkAll
 import org.assertj.core.api.Assertions.assertThat
-import org.junit.jupiter.api.Disabled
+import org.junit.jupiter.api.AfterEach
 import org.junit.jupiter.api.Test
+import org.junit.jupiter.api.TestInstance
+import picocli.CommandLine
 import java.io.ByteArrayOutputStream
 import java.io.File
 import java.io.PrintStream
 
+@TestInstance(TestInstance.Lifecycle.PER_CLASS)
 class StructureModifierTest {
+    val errContent = ByteArrayOutputStream()
+    val originalErr = System.err
+
+    @AfterEach
+    fun afterTest() {
+        unmockkAll()
+    }
+
     @Test
     fun `reads project from file`() {
         val cliResult = executeForOutput("", arrayOf("src/test/resources/sample_project.cc.json", "-r=/does/not/exist"))
@@ -38,16 +53,6 @@ class StructureModifierTest {
         assertThat(errorStream.toString()).contains("invalid_project.cc.json is not a valid project")
     }
 
-    @Disabled
-    @Test
-    fun `reads project piped input multiline`() {
-        val input = File("src/test/resources/sample_project.cc.json").bufferedReader().readLines()
-            .joinToString(separator = "\n") { it }
-        val cliResult = executeForOutput(input, arrayOf("-r=/does/not/exist"))
-
-        assertThat(cliResult).contains(listOf("otherFile.java"))
-    }
-
     @Test
     fun `returns error for malformed piped input`() {
         val originalError = System.err
@@ -112,4 +117,18 @@ class StructureModifierTest {
         assertThat(resultProject.attributeDescriptors.size).isEqualTo(3)
         assertThat(resultProject.attributeDescriptors["yrloc"]).isNull()
     }
+
+    @Test
+    fun `should stop execution if input file is invalid`() {
+        mockkObject(InputHelper)
+        every {
+            InputHelper.isInputValid(any(), any())
+        } returns false
+
+        System.setErr(PrintStream(errContent))
+        CommandLine(StructureModifier()).execute("thisDoesNotExist.cc.json").toString()
+        System.setErr(originalErr)
+
+        assertThat(errContent.toString()).contains("Input invalid file for StructureModifier, stopping execution")
+    }
 }

analysis/import/CSVImporter/src/main/kotlin/de/maibornwolff/codecharta/importer/csv/CSVImporter.kt

@@ -4,6 +4,7 @@ import de.maibornwolff.codecharta.serialization.ProjectSerializer
 import de.maibornwolff.codecharta.tools.interactiveparser.InteractiveParser
 import de.maibornwolff.codecharta.tools.interactiveparser.ParserDialogInterface
 import de.maibornwolff.codecharta.tools.interactiveparser.util.InteractiveParserHelper
+import de.maibornwolff.codecharta.util.InputHelper
 import picocli.CommandLine
 import java.io.File
 import java.io.IOException
@@ -43,6 +44,9 @@ class CSVImporter(
 
     @Throws(IOException::class)
     override fun call(): Void? {
+        if (!InputHelper.isInputValid(files.toTypedArray(), canInputContainFolders = false)) {
+            throw IllegalArgumentException("Input invalid file for CSVImporter, stopping execution...")
+        }
 
         val csvProjectBuilder = CSVProjectBuilder(pathSeparator, csvDelimiter, pathColumnName)
         files.map { it.inputStream() }.forEach<InputStream> { csvProjectBuilder.parseCSVStream(it) }
@@ -54,6 +58,7 @@ class CSVImporter(
     }
 
     companion object {
+
         @JvmStatic
         fun main(args: Array<String>) {
             CommandLine(CSVImporter()).execute(*args)

analysis/import/CSVImporter/src/main/kotlin/de/maibornwolff/codecharta/importer/sourcemonitor/SourceMonitorImporter.kt

@@ -6,6 +6,7 @@ import de.maibornwolff.codecharta.tools.interactiveparser.InteractiveParser
 import de.maibornwolff.codecharta.tools.interactiveparser.ParserDialogInterface
 import de.maibornwolff.codecharta.tools.interactiveparser.util.InteractiveParserHelper
 import de.maibornwolff.codecharta.translator.MetricNameTranslator
+import de.maibornwolff.codecharta.util.InputHelper
 import picocli.CommandLine
 import java.io.File
 import java.io.IOException
@@ -40,6 +41,10 @@ class SourceMonitorImporter(
 
     @Throws(IOException::class)
     override fun call(): Void? {
+        if (!InputHelper.isInputValid(files.toTypedArray(), canInputContainFolders = false)) {
+            throw IllegalArgumentException("Input invalid file for SourceMonitorImporter, stopping execution...")
+        }
+
         val csvProjectBuilder =
             CSVProjectBuilder(pathSeparator, csvDelimiter, "File Name", sourceMonitorReplacement, getAttributeDescriptors())
         files.map { it.inputStream() }.forEach<InputStream> { csvProjectBuilder.parseCSVStream(it) }