Add tests for ICalendarParser

Author: rfc2822

gradle/libs.versions.toml

@@ -26,6 +26,7 @@ guava = { module = "com.google.guava:guava", version.ref = "guava" }
 ical4j = { module = "org.mnode.ical4j:ical4j", version.ref = "ical4j" }
 junit = { module = "junit:junit", version.ref = "junit" }
 kotlin-stdlib = { module = "org.jetbrains.kotlin:kotlin-stdlib", version.ref = "kotlin" }
+mockk = { module = "io.mockk:mockk", version.ref = "mockk" }
 mockk-android = { module = "io.mockk:mockk-android", version.ref = "mockk" }
 slf4j-jdk = { module = "org.slf4j:slf4j-jdk14", version.ref = "slf4j" }
 

lib/build.gradle.kts

@@ -135,4 +135,5 @@ dependencies {
 
     // unit tests
     testImplementation(libs.junit)
+    testImplementation(libs.mockk)
 }

lib/src/main/kotlin/at/bitfire/ical4android/ICalendar.kt

@@ -94,7 +94,7 @@ open class ICalendar {
         fun fromReader(reader: Reader, properties: MutableMap<String, String>? = null): Calendar {
             logger.fine("Parsing iCalendar stream")
 
-            val calendar = ICalendarParser(reader).parse()
+            val calendar = ICalendarParser().parse(reader)
 
             // fill calendar properties
             properties?.let {

lib/src/main/kotlin/at/bitfire/synctools/exception/InvalidRemoteResourceException.kt

@@ -9,7 +9,7 @@ package at.bitfire.synctools.exception
 /**
  * Represents an invalid remote resource (for instance, a calendar object resource).
  */
-class InvalidRemoteResourceException: Exception {
+class InvalidRemoteResourceException: InvalidResourceException {
 
     constructor(message: String): super(message)
     constructor(message: String, ex: Throwable): super(message, ex)

lib/src/main/kotlin/at/bitfire/synctools/icalendar/ICalendarParser.kt

@@ -21,9 +21,7 @@ import java.util.logging.Logger
 /**
  * Custom iCalendar parser that applies error correction using [ICalPreprocessor].
  */
-class ICalendarParser(
-    private val reader: Reader
-) {
+class ICalendarParser {
 
     private val logger
         get() = Logger.getLogger(javaClass.name)
@@ -34,9 +32,9 @@ class ICalendarParser(
      * 1. The input stream from is preprocessed with [ICalPreprocessor.preprocessStream].
      * 2. The parsed calendar is preprocessed with [ICalPreprocessor.preprocessCalendar].
      *
-     * @throws InvalidRemoteResourceException   when the resource is invalid
+     * @throws InvalidRemoteResourceException   when the resource is can't be parsed
      */
-    fun parse(): Calendar {
+    fun parse(reader: Reader): Calendar {
         // preprocess stream to work around problems that prevent parsing and thus can't be fixed later
         val preprocessed = ICalPreprocessor.preprocessStream(reader)
 

lib/src/test/kotlin/at/bitfire/synctools/icalendar/ICalendarParserTest.kt

@@ -6,5 +6,57 @@
 
 package at.bitfire.synctools.icalendar
 
+import at.bitfire.ical4android.validation.ICalPreprocessor
+import at.bitfire.synctools.exception.InvalidRemoteResourceException
+import io.mockk.junit4.MockKRule
+import io.mockk.mockkObject
+import io.mockk.verify
+import org.junit.Rule
+import org.junit.Test
+import java.io.StringReader
+
 class ICalendarParserTest {
+
+    @get:Rule
+    val mockkRule = MockKRule(this)
+
+    @Test
+    fun `parse() applies pre-processing`() {
+        mockkObject(ICalPreprocessor)
+
+        val reader = StringReader(
+            "BEGIN:VCALENDAR\r\n" +
+            "BEGIN:VEVENT\r\n" +
+            "END:VEVENT\r\n" +
+            "END:VCALENDAR\r\n"
+        )
+        val cal = ICalendarParser().parse(reader)
+
+        verify(exactly = 1) {
+            // verify preprocessing was applied to stream
+            ICalPreprocessor.preprocessStream(any())
+
+            // verify preprocessing was applied to resulting calendar
+            ICalPreprocessor.preprocessCalendar(cal)
+        }
+    }
+
+    @Test
+    fun `parse() suppresses invalid properties`() {
+        val reader = StringReader(
+            "BEGIN:VCALENDAR\r\n" +
+                    "BEGIN:VEVENT\r\n" +
+                    "DTSTAMP:invalid\r\n" +
+                    "END:VEVENT\r\n" +
+                    "END:VCALENDAR\r\n"
+        )
+        ICalendarParser().parse(reader)
+    }
+
+    @Test(expected = InvalidRemoteResourceException::class)
+    fun `parse() throws exception on invalid input`() {
+        val reader = StringReader("invalid")
+        ICalendarParser().parse(reader)
+    }
+
 }