Create tests for internal entities & revise existing noResolve tests

core/base/src/commonMain/kotlin/nl/adaptivity/xmlutil/IXmlStreaming.kt

@@ -67,15 +67,25 @@ public interface IXmlStreaming {
     /**
      * Create a new XML reader with the given input. This reader is generic.
      * @param input The text to be parsed
-     * @param expandEntities If true, entities are directly expanded (throwing errors if not found)
+     * @param expandEntities Whether entity references should be emitted as distinct events, or
+     * treated as simple text. In both cases, entities are resolved and their value available via
+     * [XmlReader.text]. Accessing `text` for an unknown entity will throw an exception. If
+     * [expandEntities] is false, the name of the entity is available via [XmlReader.localName].
+     * Note that entities in attributes are always emitted as distinct events, regardless of
+     * [expandEntities].
      * @return A platform independent [XmlReader], generally [nl.adaptivity.xmlutil.core.KtXmlReader]
      */
     public fun newGenericReader(input: CharSequence, expandEntities: Boolean = false): XmlReader
 
     /**
      * Create a new XML reader with the given input. This reader is generic.
      * @param reader The reader/stream to use as input
-     * @param expandEntities If true, entities are directly expanded (throwing errors if not found)
+     * @param expandEntities Whether entity references should be emitted as distinct events, or
+     * treated as simple text. In both cases, entities are resolved and their value available via
+     * [XmlReader.text]. Accessing `text` for an unknown entity will throw an exception. If
+     * [expandEntities] is false, the name of the entity is available via [XmlReader.localName].
+     * Note that entities in attributes are always emitted as distinct events, regardless of
+     * [expandEntities].
      * @return A platform independent [XmlReader], generally [nl.adaptivity.xmlutil.core.KtXmlReader]
      */
     public fun newGenericReader(reader: Reader, expandEntities: Boolean = false): XmlReader

core/base/src/commonTest/kotlin/nl/adaptivity/xmlutil/test/TestKtXmlReaderExpandEntities.kt

@@ -88,4 +88,32 @@ class TestKtXmlReaderExpandEntities : TestCommonReader() {
 
         assertEquals(EventType.END_ELEMENT, r.next())
     }
+
+    @Test
+    override fun testInternalEntities() {
+        val text = """
+            <!DOCTYPE Test [
+            <!ENTITY helloWorld "Hello, world!">
+            <!ENTITY foo "Foo">
+            <!ENTITY bar "Bar">
+            <!ENTITY baz "Baz">
+            ]>
+            <Test>&helloWorld;</Test>
+        """.trimIndent()
+        val reader = createReader(text)
+
+        var event = reader.next()
+        if (event == EventType.START_DOCUMENT) event = reader.next()
+        assertEquals(EventType.DOCDECL, event)
+        // There should probably be internal entity decl events here, but we only get whitespace...
+        do {
+            event = reader.next()
+        } while (event == EventType.IGNORABLE_WHITESPACE)
+        // Start element event for <Test>
+        reader.next()
+        // Should be the text within the element
+        event = reader.next()
+        assertEquals(EventType.TEXT, event)
+        assertEquals("Hello, world!", reader.text)
+    }
 }

serialization/src/commonTest/kotlin/nl/adaptivity/xml/serialization/regressions/EntityValue311.kt

@@ -70,6 +70,32 @@ class EntityValue311 {
         assertContains(e.message ?: "", "unknown")
     }
 
+    @Test
+    fun testParseKnownEntityNoResolve() {
+        val xmlReader = xmlStreaming.newGenericReader(
+            """
+                <!DOCTYPE Test [ <!ENTITY internalEntity "Hello, world!"> ] >
+                <Test>&internalEntity;</Test>
+            """.trimIndent(),
+            false
+        )
+        val test = XML.v1.decodeFromReader<ValueTest>(xmlReader)
+        assertEquals("Hello, world!", test.value)
+    }
+
+    @Test
+    fun testParseKnownEntityResolve() {
+        val xmlReader = xmlStreaming.newGenericReader(
+            """
+                <!DOCTYPE Test [ <!ENTITY internalEntity "Hello, world!"> ] >
+                <Test>&internalEntity;</Test>
+            """.trimIndent(),
+            true
+        )
+        val test = XML.v1.decodeFromReader<ValueTest>(xmlReader)
+        assertEquals("Hello, world!", test.value)
+    }
+
     @Serializable
     data class ValueTest(@XmlValue val value: String)
 }

testutil/src/commonMain/kotlin/nl/adaptivity/xmlutil/test/TestCommonReader.kt

@@ -275,6 +275,34 @@ abstract class TestCommonReader {
         }
     }
 
+    protected fun testInternalEntities(createReader: (String) -> XmlReader) {
+        val text = """
+            <!DOCTYPE Test [
+            <!ENTITY helloWorld "Hello, world!">
+            <!ENTITY foo "Foo">
+            <!ENTITY bar "Bar">
+            <!ENTITY baz "Baz">
+            ]>
+            <Test>&helloWorld;</Test>
+        """.trimIndent()
+        val reader = createReader(text)
+
+        var event = reader.next()
+        if (event == EventType.START_DOCUMENT) event = reader.next()
+        assertEquals(EventType.DOCDECL, event)
+        // There should probably be internal entity decl events here, but we only get whitespace...
+        do {
+            event = reader.next()
+        } while (event == EventType.IGNORABLE_WHITESPACE)
+        // Start element event for <Test>
+        reader.next()
+        // Should be the text within the element
+        event = reader.next()
+        assertEquals(EventType.ENTITY_REF, event)
+        assertEquals("Hello, world!", reader.text)
+        assertEquals("helloWorld", reader.localName)
+    }
+
     protected abstract fun createReader(xml: String): XmlReader
 
     @Test
@@ -339,6 +367,11 @@ abstract class TestCommonReader {
         }
     }
 
+    @Test
+    open fun testInternalEntities() {
+        testInternalEntities(::createReader)
+    }
+
     /**
      * Test that triggers invalid handling of `]]>` inside attribute values. #266
      */