Added more unit tests

Author: paulorb

.github/workflows/main.yml

@@ -31,6 +31,12 @@ jobs:
       run: |
         ./gradlew test jacocoTestReport
 
+    - name: Generate JaCoCo Badge
+        uses: cicirello/jacoco-badge-generator@v2
+        with:
+          generate-branches-badge: true
+          jacoco-csv-file: build/reports/jacoco/test/jacocoTestReport.csv
+
     - name: Upload Artifacts
       uses: actions/upload-artifact@v2
       with:

build.gradle.kts

@@ -65,6 +65,7 @@ kotlin {
 tasks.jacocoTestReport {
     reports {
         xml.required.set(true)
+        csv.required.set(true)
     }
 }
 

src/main/kotlin/ConfigurationParser.kt

@@ -1,3 +1,4 @@
+import org.slf4j.LoggerFactory
 import java.io.BufferedReader
 import java.io.File
 import java.io.StringReader
@@ -9,8 +10,13 @@ class ConfigurationParser {
 
     companion object {
         var fileName: String = ""
+        var readFromResources: Boolean = false
+        val logger = LoggerFactory.getLogger("ConfigurationParser")
     }
 
+    fun setReadFromResources(value: Boolean) {
+        readFromResources = value
+    }
 
     fun setFileName(file: String) {
         fileName = file
@@ -19,16 +25,23 @@ class ConfigurationParser {
         try {
             val context = JAXBContext.newInstance(Device::class.java, Set::class.java, Random::class.java, Delay::class.java, Linear::class.java, Add::class.java, Sub::class.java, Csv::class.java, IfEqual::class.java, Parameters::class.java, Parameter::class.java)
             val unmarshaller = context.createUnmarshaller()
-            if(fileName.isEmpty()) {
+            if(fileName.isEmpty() ) {
                 val reader = StringReader(this::class.java.classLoader.getResource("configuration.xml")!!.readText())
                 val device = unmarshaller.unmarshal(reader) as Device
                 return device
-            }else{
-                val bufferedReader: BufferedReader = File(fileName).bufferedReader()
-                val device = unmarshaller.unmarshal(bufferedReader) as Device
-                return device
+            }else {
+                if(readFromResources) {
+                    val reader = StringReader(this::class.java.classLoader.getResource(fileName)!!.readText())
+                    val device = unmarshaller.unmarshal(reader) as Device
+                    return device
+                }else {
+                    val bufferedReader: BufferedReader = File(fileName).bufferedReader()
+                    val device = unmarshaller.unmarshal(bufferedReader) as Device
+                    return device
+                }
             }
         } catch (e: JAXBException) {
+            logger.error(e.message)
             e.printStackTrace()
         }
         return null

src/test/kotlin/ConfigurationParserTest.kt

@@ -0,0 +1,15 @@
+import org.junit.jupiter.api.Test
+import org.junit.jupiter.api.assertThrows
+
+class ConfigurationParserTest {
+
+    // When parser fails to load the xml due to missing device root section the following error will be printed followed by the stacktrace
+    // 2024-07-23 21:21:04 ERROR ConfigurationParser - unexpected element (uri:"", local:"simulation"). Expected elements are <{}add>,<{}csv>,<{}delay>,<{}device>,<{}ifEqual>,<{}linear>,<{}random>,<{}set>,<{}sub>
+    @Test
+    fun `Parser must fail if device section is not present`() {
+        val configuration = ConfigurationParser()
+        configuration.setReadFromResources(true)
+        configuration.setFileName("invalid_missing_device.xml")
+        assertThrows<NullPointerException> { configuration.getConfiguredDevice() }
+    }
+}

src/test/kotlin/EnvironmentVariablesTest.kt

@@ -5,6 +5,8 @@ internal class EnvironmentVariablesTest {
     @Test
     fun `Command line parameter must match with parameters definition`() {
         val configuration = ConfigurationParser()
+        configuration.setFileName("configuration.xml")
+        configuration.setReadFromResources(true)
         val listParameters = mutableListOf<EnvParameter>()
         listParameters.add(EnvParameter(
             "PARAM_INT16",

src/test/resources/invalid_missing_device.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="US-ASCII" ?>
+<!-- Invalid xml missing device root definition -->
+<simulation plcScanTime="1000">
+    <delay>500</delay>
+</simulation>