Implement dPackage and dModule test APIs in favour of default params in DModule and DPackage

5 files changed, 69 insertions, 28 deletions

diff --git a/core/src/main/kotlin/model/Documentable.kt b/core/src/main/kotlin/model/Documentable.kt
index 34ad6c2b..0ffc2f84 100644
--- a/core/src/main/kotlin/model/Documentable.kt
+++ b/core/src/main/kotlin/model/Documentable.kt
@@ -87,10 +87,10 @@ sealed class DClasslike : Documentable(), WithScope, WithVisibility, WithExpectA
 
 data class DModule(
     override val name: String,
-    val packages: List<DPackage> = emptyList(),
-    override val documentation: SourceSetDependent<DocumentationNode> = emptyMap(),
+    val packages: List<DPackage>,
+    override val documentation: SourceSetDependent<DocumentationNode>,
     override val expectPresentInSet: DokkaSourceSet? = null,
-    override val sourceSets: Set<DokkaSourceSet> = emptySet(),
+    override val sourceSets: Set<DokkaSourceSet>,
     override val extra: PropertyContainer<DModule> = PropertyContainer.empty()
 ) : Documentable(), WithExtraProperties<DModule> {
     override val dri: DRI = DRI.topLevel
@@ -102,13 +102,13 @@ data class DModule(
 
 data class DPackage(
     override val dri: DRI,
-    override val functions: List<DFunction> = emptyList(),
-    override val properties: List<DProperty> = emptyList(),
-    override val classlikes: List<DClasslike> = emptyList(),
-    val typealiases: List<DTypeAlias> = emptyList(),
-    override val documentation: SourceSetDependent<DocumentationNode> = emptyMap(),
+    override val functions: List<DFunction>,
+    override val properties: List<DProperty>,
+    override val classlikes: List<DClasslike>,
+    val typealiases: List<DTypeAlias>,
+    override val documentation: SourceSetDependent<DocumentationNode>,
     override val expectPresentInSet: DokkaSourceSet? = null,
-    override val sourceSets: Set<DokkaSourceSet> = emptySet(),
+    override val sourceSets: Set<DokkaSourceSet>,
     override val extra: PropertyContainer<DPackage> = PropertyContainer.empty()
 ) : Documentable(), WithScope, WithExtraProperties<DPackage> {
 
diff --git a/core/test-api/src/main/kotlin/testApi/testRunner/TestDokkaConfigurationBuilder.kt b/core/test-api/src/main/kotlin/testApi/testRunner/TestDokkaConfigurationBuilder.kt
index 2d9f99b2..d7b4f64f 100644
--- a/core/test-api/src/main/kotlin/testApi/testRunner/TestDokkaConfigurationBuilder.kt
+++ b/core/test-api/src/main/kotlin/testApi/testRunner/TestDokkaConfigurationBuilder.kt
@@ -6,6 +6,7 @@ import org.jetbrains.dokka.model.*
 import org.jetbrains.dokka.model.doc.Description
 import org.jetbrains.dokka.model.doc.DocumentationNode
 import org.jetbrains.dokka.model.doc.Text
+import org.jetbrains.dokka.model.properties.PropertyContainer
 import java.io.File
 
 fun dokkaConfiguration(block: TestDokkaConfigurationBuilder.() -> Unit): DokkaConfigurationImpl =
@@ -145,6 +146,44 @@ fun sourceSet(name: String): DokkaConfiguration.DokkaSourceSet {
     )
 }
 
+fun dModule(
+    name: String,
+    packages: List<DPackage> = emptyList(),
+    documentation: SourceSetDependent<DocumentationNode> = emptyMap(),
+    expectPresentInSet: DokkaConfiguration.DokkaSourceSet? = null,
+    sourceSets: Set<DokkaConfiguration.DokkaSourceSet> = emptySet(),
+    extra: PropertyContainer<DModule> = PropertyContainer.empty()
+): DModule = DModule(
+    name = name,
+    packages = packages,
+    documentation = documentation,
+    expectPresentInSet = expectPresentInSet,
+    sourceSets = sourceSets,
+    extra = extra
+)
+
+fun dPackage(
+    dri: DRI,
+    functions: List<DFunction> = emptyList(),
+    properties: List<DProperty> = emptyList(),
+    classlikes: List<DClasslike> = emptyList(),
+    typealiases: List<DTypeAlias> = emptyList(),
+    documentation: SourceSetDependent<DocumentationNode> = emptyMap(),
+    expectPresentInSet: DokkaConfiguration.DokkaSourceSet? = null,
+    sourceSets: Set<DokkaConfiguration.DokkaSourceSet> = emptySet(),
+    extra: PropertyContainer<DPackage> = PropertyContainer.empty()
+): DPackage = DPackage(
+    dri = dri,
+    functions = functions,
+    properties = properties,
+    classlikes = classlikes,
+    typealiases = typealiases,
+    documentation = documentation,
+    expectPresentInSet = expectPresentInSet,
+    sourceSets = sourceSets,
+    extra = extra
+)
+
 fun documentationNode(vararg texts: String): DocumentationNode {
     return DocumentationNode(texts.toList().map { Description(Text(it)) })
 }
diff --git a/plugins/base/src/test/kotlin/transformers/ContextModuleAndPackageDocumentationReaderTest1.kt b/plugins/base/src/test/kotlin/transformers/ContextModuleAndPackageDocumentationReaderTest1.kt
index 51a5e85a..2aba6d67 100644
--- a/plugins/base/src/test/kotlin/transformers/ContextModuleAndPackageDocumentationReaderTest1.kt
+++ b/plugins/base/src/test/kotlin/transformers/ContextModuleAndPackageDocumentationReaderTest1.kt
@@ -3,8 +3,6 @@ package transformers
 import org.jetbrains.dokka.DokkaConfiguration.DokkaSourceSet
 import org.jetbrains.dokka.base.transformers.documentables.ModuleAndPackageDocumentationReader
 import org.jetbrains.dokka.links.DRI
-import org.jetbrains.dokka.model.DModule
-import org.jetbrains.dokka.model.DPackage
 import org.jetbrains.dokka.model.doc.DocumentationNode
 import org.jetbrains.dokka.plugability.DokkaContext
 import org.jetbrains.dokka.testApi.logger.TestLogger
@@ -13,6 +11,8 @@ import org.junit.jupiter.api.Assertions.assertEquals
 import org.junit.jupiter.api.BeforeEach
 import org.junit.jupiter.api.Test
 import testApi.testRunner.TestDokkaConfigurationBuilder
+import testApi.testRunner.dModule
+import testApi.testRunner.dPackage
 
 class ContextModuleAndPackageDocumentationReaderTest1 : AbstractContextModuleAndPackageDocumentationReaderTest() {
 
@@ -83,7 +83,7 @@ class ContextModuleAndPackageDocumentationReaderTest1 : AbstractContextModuleAnd
 
     @Test
     fun `assert moduleA with sourceSetA`() {
-        val documentation = reader[DModule(name = "moduleA", sourceSets = setOf(sourceSetA))]
+        val documentation = reader[dModule(name = "moduleA", sourceSets = setOf(sourceSetA))]
         assertEquals(
             1, documentation.keys.size,
             "Expected moduleA only containing documentation in a single source set"
@@ -101,7 +101,7 @@ class ContextModuleAndPackageDocumentationReaderTest1 : AbstractContextModuleAnd
 
     @Test
     fun `assert moduleA with no source sets`() {
-        val documentation = reader[DModule("moduleA")]
+        val documentation = reader[dModule("moduleA")]
         assertEquals(
             emptyMap<DokkaSourceSet, DocumentationNode>(), documentation,
             "Expected no documentation received for module not declaring a matching sourceSet"
@@ -111,7 +111,7 @@ class ContextModuleAndPackageDocumentationReaderTest1 : AbstractContextModuleAnd
     @Test
     fun `assert moduleA with unknown source set`() {
         val documentation = reader[
-                DModule("moduleA", sourceSets = setOf(configurationBuilder.unattachedSourceSet { name = "unknown" }))
+                dModule("moduleA", sourceSets = setOf(configurationBuilder.unattachedSourceSet { name = "unknown" }))
         ]
         assertEquals(
             emptyMap<DokkaSourceSet, DocumentationNode>(), documentation,
@@ -121,7 +121,7 @@ class ContextModuleAndPackageDocumentationReaderTest1 : AbstractContextModuleAnd
 
     @Test
     fun `assert moduleA with all sourceSets`() {
-        val documentation = reader[DModule("moduleA", sourceSets = setOf(sourceSetA, sourceSetB, sourceSetB2))]
+        val documentation = reader[dModule("moduleA", sourceSets = setOf(sourceSetA, sourceSetB, sourceSetB2))]
         assertEquals(1, documentation.entries.size, "Expected only one entry from sourceSetA")
         assertEquals(sourceSetA, documentation.keys.single(), "Expected only one entry from sourceSetA")
         assertEquals("This is moduleA", documentation.texts.single())
@@ -129,7 +129,7 @@ class ContextModuleAndPackageDocumentationReaderTest1 : AbstractContextModuleAnd
 
     @Test
     fun `assert moduleB with sourceSetB and sourceSetB2`() {
-        val documentation = reader[DModule("moduleB", sourceSets = setOf(sourceSetB, sourceSetB2))]
+        val documentation = reader[dModule("moduleB", sourceSets = setOf(sourceSetB, sourceSetB2))]
         assertEquals(1, documentation.keys.size, "Expected only one entry from sourceSetB")
         assertEquals(sourceSetB, documentation.keys.single(), "Expected only one entry from sourceSetB")
         assertEquals("This is moduleB", documentation.texts.single())
@@ -137,7 +137,7 @@ class ContextModuleAndPackageDocumentationReaderTest1 : AbstractContextModuleAnd
 
     @Test
     fun `assert sample_A in sourceSetA`() {
-        val documentation = reader[DPackage(DRI("sample.a"), sourceSets = setOf(sourceSetA))]
+        val documentation = reader[dPackage(DRI("sample.a"), sourceSets = setOf(sourceSetA))]
         assertEquals(1, documentation.keys.size, "Expected only one entry from sourceSetA")
         assertEquals(sourceSetA, documentation.keys.single(), "Expected only one entry from sourceSetA")
         assertEquals("This is package sample.a", documentation.texts.single())
@@ -145,7 +145,7 @@ class ContextModuleAndPackageDocumentationReaderTest1 : AbstractContextModuleAnd
 
     @Test
     fun `assert sample_a_sub in sourceSetA`() {
-        val documentation = reader[DPackage(DRI("sample.a.sub"), sourceSets = setOf(sourceSetA))]
+        val documentation = reader[dPackage(DRI("sample.a.sub"), sourceSets = setOf(sourceSetA))]
         assertEquals(
             emptyMap<DokkaSourceSet, DocumentationNode>(), documentation,
             "Expected no documentation found for different package"
@@ -154,7 +154,7 @@ class ContextModuleAndPackageDocumentationReaderTest1 : AbstractContextModuleAnd
 
     @Test
     fun `assert sample_a in sourceSetB`() {
-        val documentation = reader[DPackage(DRI("sample.a"), sourceSets = setOf(sourceSetB))]
+        val documentation = reader[dPackage(DRI("sample.a"), sourceSets = setOf(sourceSetB))]
         assertEquals(
             emptyMap<DokkaSourceSet, DocumentationNode>(), documentation,
             "Expected no documentation found for different sourceSet"
@@ -163,7 +163,7 @@ class ContextModuleAndPackageDocumentationReaderTest1 : AbstractContextModuleAnd
 
     @Test
     fun `assert sample_b in sourceSetB`() {
-        val documentation = reader[DPackage(DRI("sample.b"), sourceSets = setOf(sourceSetB))]
+        val documentation = reader[dPackage(DRI("sample.b"), sourceSets = setOf(sourceSetB))]
         assertEquals(1, documentation.keys.size, "Expected only one entry from sourceSetB")
         assertEquals(sourceSetB, documentation.keys.single(), "Expected only one entry from sourceSetB")
         assertEquals("This is package sample.b", documentation.texts.single())
@@ -171,7 +171,7 @@ class ContextModuleAndPackageDocumentationReaderTest1 : AbstractContextModuleAnd
 
     @Test
     fun `assert sample_b in sourceSetB and sourceSetB2`() {
-        val documentation = reader[DPackage(DRI("sample.b"), sourceSets = setOf(sourceSetB, sourceSetB2))]
+        val documentation = reader[dPackage(DRI("sample.b"), sourceSets = setOf(sourceSetB, sourceSetB2))]
         assertEquals(1, documentation.keys.size, "Expected only one entry from sourceSetB")
         assertEquals(sourceSetB, documentation.keys.single(), "Expected only one entry from sourceSetB")
         assertEquals("This is package sample.b", documentation.texts.single())
diff --git a/plugins/base/src/test/kotlin/transformers/ContextModuleAndPackageDocumentationReaderTest3.kt b/plugins/base/src/test/kotlin/transformers/ContextModuleAndPackageDocumentationReaderTest3.kt
index a557379b..9319f5af 100644
--- a/plugins/base/src/test/kotlin/transformers/ContextModuleAndPackageDocumentationReaderTest3.kt
+++ b/plugins/base/src/test/kotlin/transformers/ContextModuleAndPackageDocumentationReaderTest3.kt
@@ -8,6 +8,7 @@ import org.jetbrains.dokka.utilities.DokkaConsoleLogger
 import org.junit.jupiter.api.BeforeEach
 import org.junit.jupiter.api.Test
 import testApi.testRunner.TestDokkaConfigurationBuilder
+import testApi.testRunner.dPackage
 import testApi.testRunner.dokkaConfiguration
 import testApi.testRunner.sourceSet
 import kotlin.test.assertEquals
@@ -48,7 +49,7 @@ class ContextModuleAndPackageDocumentationReaderTest3 : AbstractContextModuleAnd
 
     @Test
     fun `root package is matched by empty string and the root keyword`() {
-        val documentation = reader[DPackage(DRI(""), sourceSets = setOf(sourceSet))]
+        val documentation = reader[dPackage(DRI(""), sourceSets = setOf(sourceSet))]
         assertEquals(
             listOf("This is the root package", "This is also the root package"), documentation.texts
         )
diff --git a/plugins/base/src/test/kotlin/transformers/ModuleAndPackageDocumentationTransformerUnitTest.kt b/plugins/base/src/test/kotlin/transformers/ModuleAndPackageDocumentationTransformerUnitTest.kt
index b75f8e5b..9f934f3f 100644
--- a/plugins/base/src/test/kotlin/transformers/ModuleAndPackageDocumentationTransformerUnitTest.kt
+++ b/plugins/base/src/test/kotlin/transformers/ModuleAndPackageDocumentationTransformerUnitTest.kt
@@ -9,6 +9,7 @@ import org.jetbrains.dokka.model.SourceSetDependent
 import org.jetbrains.dokka.model.doc.DocumentationNode
 import org.junit.jupiter.api.Assertions.assertEquals
 import org.junit.jupiter.api.Test
+import testApi.testRunner.dPackage
 import testApi.testRunner.documentationNode
 import testApi.testRunner.sourceSet
 
@@ -139,21 +140,21 @@ class ModuleAndPackageDocumentationTransformerUnitTest {
                     documentation = emptyMap(),
                     sourceSets = emptySet(),
                     packages = listOf(
-                        DPackage(
+                        dPackage(
                             dri = DRI("com.sample"),
                             documentation = mapOf(
                                 sourceSet("A") to documentationNode("pre-existing:A:com.sample")
                             ),
                             sourceSets = setOf(sourceSet("A"), sourceSet("B"), sourceSet("C")),
                         ),
-                        DPackage(
+                        dPackage(
                             dri = DRI("com.attach"),
                             documentation = mapOf(
                                 sourceSet("A") to documentationNode("pre-existing:A:com.attach")
                             ),
                             sourceSets = setOf(sourceSet("A"), sourceSet("B"), sourceSet("C"))
                         ),
-                        DPackage(
+                        dPackage(
                             dri = DRI("com.attach.sub"),
                             documentation = mapOf(
                                 sourceSet("A") to documentationNode("pre-existing:A:com.attach.sub"),
@@ -197,7 +198,7 @@ class ModuleAndPackageDocumentationTransformerUnitTest {
                 documentation = emptyMap(),
                 sourceSets = emptySet(),
                 packages = listOf(
-                    DPackage(
+                    dPackage(
                         dri = DRI("com.sample"),
                         documentation = mapOf(
                             /* No documentation added, since in wrong package */
@@ -206,7 +207,7 @@ class ModuleAndPackageDocumentationTransformerUnitTest {
                         sourceSets = setOf(sourceSet("A"), sourceSet("B"), sourceSet("C")),
 
                         ),
-                    DPackage(
+                    dPackage(
                         dri = DRI("com.attach"),
                         documentation = mapOf(
                             /* Documentation added */
@@ -215,7 +216,7 @@ class ModuleAndPackageDocumentationTransformerUnitTest {
                         ),
                         sourceSets = setOf(sourceSet("A"), sourceSet("B"), sourceSet("C")),
                     ),
-                    DPackage(
+                    dPackage(
                         dri = DRI("com.attach.sub"),
                         documentation = mapOf(
                             /* Documentation added */