From 6166ddfeb6ee977a302d4cacc80dac23cc7e2baf Mon Sep 17 00:00:00 2001 From: Andrzej Ratajczak Date: Fri, 10 Apr 2020 16:59:25 +0200 Subject: Working tests for includes, sources and samples. Minor bugfixes --- .../kotlin/linkableContent/LinkableContentTest.kt | 161 +++++++++++++++++++++ 1 file changed, 161 insertions(+) create mode 100644 plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt (limited to 'plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt') diff --git a/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt b/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt new file mode 100644 index 00000000..71854035 --- /dev/null +++ b/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt @@ -0,0 +1,161 @@ +package linkableContent + +import org.jetbrains.dokka.SourceLinkDefinitionImpl +import org.jetbrains.dokka.base.transformers.pages.samples.DefaultSamplesTransformer +import org.jetbrains.dokka.base.transformers.pages.sourcelinks.SourceLinksTransformer +import org.jetbrains.dokka.pages.* +import org.jetbrains.dokka.testApi.testRunner.AbstractCoreTest +import org.jetbrains.kotlin.utils.addToStdlib.safeAs +import org.junit.jupiter.api.Assertions +import org.junit.jupiter.api.Test + +class LinkableContentTest : AbstractCoreTest() { + + @Test + fun `Include module and package documentation`() { + + val testDataDir = getTestDataDir("multiplatform/basicMultiplatformTest").toAbsolutePath() + val includesDir = getTestDataDir("linkable/includes").toAbsolutePath() + + val configuration = dokkaConfiguration { + passes { + pass { + moduleName = "example" + analysisPlatform = "js" + targets = listOf("js") + sourceRoots = listOf("jsMain", "commonMain", "jvmAndJsSecondCommonMain").map { + "$testDataDir/$it/kotlin" + } + includes = listOf("$includesDir/include2.md") + } + pass { + moduleName = "example" + analysisPlatform = "jvm" + targets = listOf("jvm") + sourceRoots = listOf("jvmMain", "commonMain", "jvmAndJsSecondCommonMain").map { + "$testDataDir/$it/kotlin" + } + includes = listOf("$includesDir/include1.md") + } + } + } + + testFromData(configuration) { + documentablesMergingStage = { + Assertions.assertEquals(2, it.documentation.size) + Assertions.assertEquals(2, it.packages.size) + Assertions.assertEquals(1, it.packages.first().documentation.size) + Assertions.assertEquals(1, it.packages.last().documentation.size) + } + } + + } + + @Test + fun `Sources multiplatform class documentation`() { + + val testDataDir = getTestDataDir("linkable/sources").toAbsolutePath() + + val configuration = dokkaConfiguration { + passes { + pass { + moduleName = "example" + analysisPlatform = "js" + targets = listOf("js") + sourceRoots = listOf("$testDataDir/jsMain/kotlin") + sourceLinks = listOf( + SourceLinkDefinitionImpl( + path = "jsMain/kotlin", + url = "https://github.com/user/repo/tree/master/src/jsMain/kotlin", + lineSuffix = "#L" + ) + ) + } + pass { + moduleName = "example" + analysisPlatform = "jvm" + targets = listOf("jvm") + sourceRoots = listOf("$testDataDir/jvmMain/kotlin") + sourceLinks = listOf( + SourceLinkDefinitionImpl( + path = "jvmMain/kotlin", + url = "https://github.com/user/repo/tree/master/src/jvmMain/kotlin", + lineSuffix = "#L" + ) + ) + } + } + } + + testFromData(configuration) { + renderingStage = { rootPageNode, dokkaContext -> + val newRoot = SourceLinksTransformer(dokkaContext).invoke(rootPageNode) + + val moduleChildren = newRoot.children + Assertions.assertEquals(1, moduleChildren.size) + val packageChildren = moduleChildren.first().children + Assertions.assertEquals(2, packageChildren.size) + packageChildren.forEach { + val name = it.name.substringBefore("Class") + val crl = it.safeAs()?.content?.safeAs()?.children?.last() + ?.safeAs()?.children?.singleOrNull().safeAs() + Assertions.assertEquals( + "https://github.com/user/repo/tree/master/src/${name.toLowerCase()}Main/kotlin/${name}Class.kt#L3", + crl?.address + ) + } + } + } + } + + @Test + fun `Samples multiplatform documentation`() { + + val testDataDir = getTestDataDir("linkable/samples").toAbsolutePath() + + val configuration = dokkaConfiguration { + passes { + pass { + moduleName = "example" + analysisPlatform = "js" + targets = listOf("js") + sourceRoots = listOf("$testDataDir/jsMain/kotlin") + samples = listOf("$testDataDir/jsMain/resources/Samples.kt") + } + pass { + moduleName = "example" + analysisPlatform = "jvm" + targets = listOf("jvm") + sourceRoots = listOf("$testDataDir/jvmMain/kotlin") + samples = listOf("$testDataDir/jvmMain/resources/Samples.kt") + } + } + } + + testFromData(configuration) { + renderingStage = { rootPageNode, dokkaContext -> + val newRoot = DefaultSamplesTransformer(dokkaContext).invoke(rootPageNode) + + val moduleChildren = newRoot.children + Assertions.assertEquals(1, moduleChildren.size) + val packageChildren = moduleChildren.first().children + Assertions.assertEquals(2, packageChildren.size) + packageChildren.forEach { + val name = it.name.substringBefore("Class") + val classChildren = it.children + Assertions.assertEquals(2, classChildren.size) + val function = classChildren.find { it.name == "printWithExclamation" } + val text = function.safeAs()?.content?.safeAs()?.children?.last() + ?.safeAs()?.children?.singleOrNull() + ?.safeAs()?.children?.singleOrNull()?.safeAs()?.children?.last() + ?.safeAs()?.children?.singleOrNull() + ?.safeAs()?.children?.singleOrNull()?.safeAs()?.text + Assertions.assertEquals( + "${name}Class().printWithExclamation(\"Hi, $name\")", + text + ) + } + } + } + } +} \ No newline at end of file -- cgit From bbfb105c1e697eb792301b9fa9d9823344734aeb Mon Sep 17 00:00:00 2001 From: Filip Zybała Date: Tue, 28 Apr 2020 14:23:23 +0200 Subject: SourceLinksTransformer: Fixed invalid cast exception, platform tags in sources table, splitted invoke function to methods. --- .../test/kotlin/linkableContent/LinkableContentTest.kt | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) (limited to 'plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt') diff --git a/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt b/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt index 71854035..bf1d52d8 100644 --- a/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt +++ b/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt @@ -1,9 +1,12 @@ package linkableContent import org.jetbrains.dokka.SourceLinkDefinitionImpl +import org.jetbrains.dokka.base.DokkaBase import org.jetbrains.dokka.base.transformers.pages.samples.DefaultSamplesTransformer import org.jetbrains.dokka.base.transformers.pages.sourcelinks.SourceLinksTransformer +import org.jetbrains.dokka.base.translators.documentables.PageContentBuilder import org.jetbrains.dokka.pages.* +import org.jetbrains.dokka.plugability.plugin import org.jetbrains.dokka.testApi.testRunner.AbstractCoreTest import org.jetbrains.kotlin.utils.addToStdlib.safeAs import org.junit.jupiter.api.Assertions @@ -89,8 +92,13 @@ class LinkableContentTest : AbstractCoreTest() { testFromData(configuration) { renderingStage = { rootPageNode, dokkaContext -> - val newRoot = SourceLinksTransformer(dokkaContext).invoke(rootPageNode) - + val newRoot = SourceLinksTransformer(dokkaContext, + PageContentBuilder( + dokkaContext.single(dokkaContext.plugin().commentsToContentConverter), + dokkaContext.single(dokkaContext.plugin().signatureProvider), + dokkaContext.logger + ) + ).invoke(rootPageNode) val moduleChildren = newRoot.children Assertions.assertEquals(1, moduleChildren.size) val packageChildren = moduleChildren.first().children @@ -98,7 +106,8 @@ class LinkableContentTest : AbstractCoreTest() { packageChildren.forEach { val name = it.name.substringBefore("Class") val crl = it.safeAs()?.content?.safeAs()?.children?.last() - ?.safeAs()?.children?.singleOrNull().safeAs() + ?.safeAs()?.children?.last()?.safeAs()?.children?.singleOrNull() + ?.safeAs()?.children?.singleOrNull()?.safeAs() Assertions.assertEquals( "https://github.com/user/repo/tree/master/src/${name.toLowerCase()}Main/kotlin/${name}Class.kt#L3", crl?.address -- cgit From 3f2a790190da4f40ea6d8a976aa1929b2a1b002b Mon Sep 17 00:00:00 2001 From: Błażej Kardyś Date: Tue, 5 May 2020 17:45:12 +0200 Subject: Changing approach from platform-driven to source-set-driven --- plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt') diff --git a/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt b/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt index bf1d52d8..1299bf80 100644 --- a/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt +++ b/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt @@ -29,6 +29,7 @@ class LinkableContentTest : AbstractCoreTest() { sourceRoots = listOf("jsMain", "commonMain", "jvmAndJsSecondCommonMain").map { "$testDataDir/$it/kotlin" } + sourceSetName = "js" includes = listOf("$includesDir/include2.md") } pass { @@ -38,6 +39,7 @@ class LinkableContentTest : AbstractCoreTest() { sourceRoots = listOf("jvmMain", "commonMain", "jvmAndJsSecondCommonMain").map { "$testDataDir/$it/kotlin" } + sourceSetName = "jvm" includes = listOf("$includesDir/include1.md") } } @@ -73,6 +75,7 @@ class LinkableContentTest : AbstractCoreTest() { lineSuffix = "#L" ) ) + sourceSetName = "js" } pass { moduleName = "example" @@ -86,6 +89,7 @@ class LinkableContentTest : AbstractCoreTest() { lineSuffix = "#L" ) ) + sourceSetName = "jvm" } } } @@ -129,6 +133,7 @@ class LinkableContentTest : AbstractCoreTest() { analysisPlatform = "js" targets = listOf("js") sourceRoots = listOf("$testDataDir/jsMain/kotlin") + sourceSetName = "js" samples = listOf("$testDataDir/jsMain/resources/Samples.kt") } pass { @@ -136,6 +141,7 @@ class LinkableContentTest : AbstractCoreTest() { analysisPlatform = "jvm" targets = listOf("jvm") sourceRoots = listOf("$testDataDir/jvmMain/kotlin") + sourceSetName = "jvm" samples = listOf("$testDataDir/jvmMain/resources/Samples.kt") } } -- cgit From 430d7d6453a0b63dcabecd54aea915410cd35103 Mon Sep 17 00:00:00 2001 From: Kamil Doległo Date: Tue, 5 May 2020 11:53:16 +0200 Subject: Add a draft version of divergent rendering --- .../test/kotlin/linkableContent/LinkableContentTest.kt | 17 ++++++++++++----- 1 file changed, 12 insertions(+), 5 deletions(-) (limited to 'plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt') diff --git a/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt b/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt index 1299bf80..8f60eecb 100644 --- a/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt +++ b/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt @@ -8,8 +8,10 @@ import org.jetbrains.dokka.base.translators.documentables.PageContentBuilder import org.jetbrains.dokka.pages.* import org.jetbrains.dokka.plugability.plugin import org.jetbrains.dokka.testApi.testRunner.AbstractCoreTest +import org.jetbrains.kotlin.utils.addToStdlib.cast import org.jetbrains.kotlin.utils.addToStdlib.safeAs import org.junit.jupiter.api.Assertions +import org.junit.jupiter.api.Disabled import org.junit.jupiter.api.Test class LinkableContentTest : AbstractCoreTest() { @@ -121,6 +123,8 @@ class LinkableContentTest : AbstractCoreTest() { } } + // TODO: enable after fixing SampleTransformer + @Disabled @Test fun `Samples multiplatform documentation`() { @@ -160,11 +164,14 @@ class LinkableContentTest : AbstractCoreTest() { val classChildren = it.children Assertions.assertEquals(2, classChildren.size) val function = classChildren.find { it.name == "printWithExclamation" } - val text = function.safeAs()?.content?.safeAs()?.children?.last() - ?.safeAs()?.children?.singleOrNull() - ?.safeAs()?.children?.singleOrNull()?.safeAs()?.children?.last() - ?.safeAs()?.children?.singleOrNull() - ?.safeAs()?.children?.singleOrNull()?.safeAs()?.text + val text = function.cast().content.cast().children.last() + .cast().children.single() + .cast().after + .cast().children.last() + .cast().children.single() + .cast().children.single().cast().children.last() + .cast().children.single() + .cast().children.single().cast().text Assertions.assertEquals( "${name}Class().printWithExclamation(\"Hi, $name\")", text -- cgit From 9a77287304af906d3d8f14bf6852bf3bc3b759d6 Mon Sep 17 00:00:00 2001 From: Andrzej Ratajczak Date: Mon, 18 May 2020 13:57:41 +0200 Subject: Samples fix --- plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt | 2 -- 1 file changed, 2 deletions(-) (limited to 'plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt') diff --git a/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt b/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt index 8f60eecb..e7883bc1 100644 --- a/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt +++ b/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt @@ -123,8 +123,6 @@ class LinkableContentTest : AbstractCoreTest() { } } - // TODO: enable after fixing SampleTransformer - @Disabled @Test fun `Samples multiplatform documentation`() { -- cgit From 091294c5a920521df1b4bf61c2492b78f3559321 Mon Sep 17 00:00:00 2001 From: Marcin Aman Date: Wed, 20 May 2020 17:58:31 +0200 Subject: Tabs for sections - update tests --- .../base/src/test/kotlin/linkableContent/LinkableContentTest.kt | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) (limited to 'plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt') diff --git a/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt b/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt index e7883bc1..b18c3a5a 100644 --- a/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt +++ b/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt @@ -112,8 +112,8 @@ class LinkableContentTest : AbstractCoreTest() { packageChildren.forEach { val name = it.name.substringBefore("Class") val crl = it.safeAs()?.content?.safeAs()?.children?.last() - ?.safeAs()?.children?.last()?.safeAs()?.children?.singleOrNull() - ?.safeAs()?.children?.singleOrNull()?.safeAs() + ?.safeAs()?.children?.last()?.safeAs()?.children?.lastOrNull() + ?.safeAs()?.children?.singleOrNull()?.safeAs()?.children?.singleOrNull().safeAs() Assertions.assertEquals( "https://github.com/user/repo/tree/master/src/${name.toLowerCase()}Main/kotlin/${name}Class.kt#L3", crl?.address @@ -166,8 +166,11 @@ class LinkableContentTest : AbstractCoreTest() { .cast().children.single() .cast().after .cast().children.last() + .cast().children.last() .cast().children.single() - .cast().children.single().cast().children.last() + .cast().children.single() + .cast().children.single() + .cast().children.single() .cast().children.single() .cast().children.single().cast().text Assertions.assertEquals( -- cgit From c8dba800d9f3be90e073bf9de9d48ab9da9c85e7 Mon Sep 17 00:00:00 2001 From: Marcin Aman Date: Fri, 22 May 2020 14:08:08 +0200 Subject: Trim windows carrage return sign in importing includes --- .../base/src/test/kotlin/linkableContent/LinkableContentTest.kt | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) (limited to 'plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt') diff --git a/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt b/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt index b18c3a5a..c34fa909 100644 --- a/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt +++ b/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt @@ -13,6 +13,7 @@ import org.jetbrains.kotlin.utils.addToStdlib.safeAs import org.junit.jupiter.api.Assertions import org.junit.jupiter.api.Disabled import org.junit.jupiter.api.Test +import java.nio.file.Paths class LinkableContentTest : AbstractCoreTest() { @@ -29,20 +30,20 @@ class LinkableContentTest : AbstractCoreTest() { analysisPlatform = "js" targets = listOf("js") sourceRoots = listOf("jsMain", "commonMain", "jvmAndJsSecondCommonMain").map { - "$testDataDir/$it/kotlin" + Paths.get("$testDataDir/$it/kotlin").toString() } sourceSetName = "js" - includes = listOf("$includesDir/include2.md") + includes = listOf(Paths.get("$includesDir/include2.md").toString()) } pass { moduleName = "example" analysisPlatform = "jvm" targets = listOf("jvm") sourceRoots = listOf("jvmMain", "commonMain", "jvmAndJsSecondCommonMain").map { - "$testDataDir/$it/kotlin" + Paths.get("$testDataDir/$it/kotlin").toString() } sourceSetName = "jvm" - includes = listOf("$includesDir/include1.md") + includes = listOf(Paths.get("$includesDir/include1.md").toString()) } } } -- cgit From 5f9299b074355e3f636da6eb6e1f9283f06ab8c7 Mon Sep 17 00:00:00 2001 From: Marcin Aman Date: Thu, 21 May 2020 14:51:55 +0200 Subject: Return types links in inner classes with generic parents --- .../kotlin/linkableContent/LinkableContentTest.kt | 43 +++++++++++++++++++++- 1 file changed, 42 insertions(+), 1 deletion(-) (limited to 'plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt') diff --git a/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt b/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt index c34fa909..33d3f64c 100644 --- a/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt +++ b/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt @@ -11,7 +11,6 @@ import org.jetbrains.dokka.testApi.testRunner.AbstractCoreTest import org.jetbrains.kotlin.utils.addToStdlib.cast import org.jetbrains.kotlin.utils.addToStdlib.safeAs import org.junit.jupiter.api.Assertions -import org.junit.jupiter.api.Disabled import org.junit.jupiter.api.Test import java.nio.file.Paths @@ -182,4 +181,46 @@ class LinkableContentTest : AbstractCoreTest() { } } } + + @Test + fun `Documenting return type for a function in inner class with generic parent`(){ + testInline( + """ + |/src/main/kotlin/test/source.kt + |package test + | + |class Sample(first: S){ + | inner class SampleInner { + | fun foo(): S = TODO() + | } + |} + | + """.trimIndent(), + dokkaConfiguration { + passes { + pass { + sourceRoots = listOf("src/") + analysisPlatform = "jvm" + targets = listOf("jvm") + } + } + } + ) { + renderingStage = { module, _ -> + val sample = module.children.single { it.name == "test" } + .children.single { it.name == "Sample" }.cast() + val foo = sample + .children.single { it.name == "SampleInner" }.cast() + .children.single { it.name == "foo" }.cast() + + val returnTypeNode = foo.content.dfs { + val link = it.safeAs()?.children + val child = link?.first().safeAs() + child?.text == "S" + }?.safeAs() + + Assertions.assertEquals(sample.dri.first(), returnTypeNode?.address) + } + } + } } \ No newline at end of file -- cgit From 77c8777b7f66bddd374d68decd507547d356d602 Mon Sep 17 00:00:00 2001 From: Marcin Aman Date: Sun, 31 May 2020 21:02:46 +0200 Subject: Improve CSS, pages navigation tree and create anchors on page --- plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) (limited to 'plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt') diff --git a/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt b/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt index 33d3f64c..7cdb0de3 100644 --- a/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt +++ b/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt @@ -164,13 +164,11 @@ class LinkableContentTest : AbstractCoreTest() { val function = classChildren.find { it.name == "printWithExclamation" } val text = function.cast().content.cast().children.last() .cast().children.single() - .cast().after + .cast().before .cast().children.last() .cast().children.last() .cast().children.single() .cast().children.single() - .cast().children.single() - .cast().children.single() .cast().children.single() .cast().children.single().cast().text Assertions.assertEquals( -- cgit From f3baf10b4c882230d382bfcdd94163d070bd0e25 Mon Sep 17 00:00:00 2001 From: Kamil Doległo Date: Wed, 20 May 2020 12:05:26 +0200 Subject: Rework dokka configuration and Gradle plugin --- .../base/src/test/kotlin/linkableContent/LinkableContentTest.kt | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) (limited to 'plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt') diff --git a/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt b/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt index 7cdb0de3..d49ec8a5 100644 --- a/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt +++ b/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt @@ -27,7 +27,6 @@ class LinkableContentTest : AbstractCoreTest() { pass { moduleName = "example" analysisPlatform = "js" - targets = listOf("js") sourceRoots = listOf("jsMain", "commonMain", "jvmAndJsSecondCommonMain").map { Paths.get("$testDataDir/$it/kotlin").toString() } @@ -37,7 +36,6 @@ class LinkableContentTest : AbstractCoreTest() { pass { moduleName = "example" analysisPlatform = "jvm" - targets = listOf("jvm") sourceRoots = listOf("jvmMain", "commonMain", "jvmAndJsSecondCommonMain").map { Paths.get("$testDataDir/$it/kotlin").toString() } @@ -68,7 +66,6 @@ class LinkableContentTest : AbstractCoreTest() { pass { moduleName = "example" analysisPlatform = "js" - targets = listOf("js") sourceRoots = listOf("$testDataDir/jsMain/kotlin") sourceLinks = listOf( SourceLinkDefinitionImpl( @@ -82,7 +79,6 @@ class LinkableContentTest : AbstractCoreTest() { pass { moduleName = "example" analysisPlatform = "jvm" - targets = listOf("jvm") sourceRoots = listOf("$testDataDir/jvmMain/kotlin") sourceLinks = listOf( SourceLinkDefinitionImpl( @@ -133,7 +129,6 @@ class LinkableContentTest : AbstractCoreTest() { pass { moduleName = "example" analysisPlatform = "js" - targets = listOf("js") sourceRoots = listOf("$testDataDir/jsMain/kotlin") sourceSetName = "js" samples = listOf("$testDataDir/jsMain/resources/Samples.kt") @@ -141,7 +136,6 @@ class LinkableContentTest : AbstractCoreTest() { pass { moduleName = "example" analysisPlatform = "jvm" - targets = listOf("jvm") sourceRoots = listOf("$testDataDir/jvmMain/kotlin") sourceSetName = "jvm" samples = listOf("$testDataDir/jvmMain/resources/Samples.kt") @@ -199,7 +193,7 @@ class LinkableContentTest : AbstractCoreTest() { pass { sourceRoots = listOf("src/") analysisPlatform = "jvm" - targets = listOf("jvm") + sourceSetName = "js" } } } -- cgit From 4c9952dbfa2d9b304b10d6d3e43e2424e69fdfe8 Mon Sep 17 00:00:00 2001 From: Kamil Doległo Date: Fri, 12 Jun 2020 12:44:48 +0200 Subject: Fix tests --- .../src/test/kotlin/linkableContent/LinkableContentTest.kt | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) (limited to 'plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt') diff --git a/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt b/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt index d49ec8a5..c2596ba3 100644 --- a/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt +++ b/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt @@ -30,7 +30,7 @@ class LinkableContentTest : AbstractCoreTest() { sourceRoots = listOf("jsMain", "commonMain", "jvmAndJsSecondCommonMain").map { Paths.get("$testDataDir/$it/kotlin").toString() } - sourceSetName = "js" + sourceSetID = "js" includes = listOf(Paths.get("$includesDir/include2.md").toString()) } pass { @@ -39,7 +39,7 @@ class LinkableContentTest : AbstractCoreTest() { sourceRoots = listOf("jvmMain", "commonMain", "jvmAndJsSecondCommonMain").map { Paths.get("$testDataDir/$it/kotlin").toString() } - sourceSetName = "jvm" + sourceSetID = "jvm" includes = listOf(Paths.get("$includesDir/include1.md").toString()) } } @@ -74,7 +74,7 @@ class LinkableContentTest : AbstractCoreTest() { lineSuffix = "#L" ) ) - sourceSetName = "js" + sourceSetID = "js" } pass { moduleName = "example" @@ -87,7 +87,7 @@ class LinkableContentTest : AbstractCoreTest() { lineSuffix = "#L" ) ) - sourceSetName = "jvm" + sourceSetID = "jvm" } } } @@ -130,14 +130,14 @@ class LinkableContentTest : AbstractCoreTest() { moduleName = "example" analysisPlatform = "js" sourceRoots = listOf("$testDataDir/jsMain/kotlin") - sourceSetName = "js" + sourceSetID = "js" samples = listOf("$testDataDir/jsMain/resources/Samples.kt") } pass { moduleName = "example" analysisPlatform = "jvm" sourceRoots = listOf("$testDataDir/jvmMain/kotlin") - sourceSetName = "jvm" + sourceSetID = "jvm" samples = listOf("$testDataDir/jvmMain/resources/Samples.kt") } } @@ -193,7 +193,7 @@ class LinkableContentTest : AbstractCoreTest() { pass { sourceRoots = listOf("src/") analysisPlatform = "jvm" - sourceSetName = "js" + sourceSetID = "js" } } } -- cgit From 370bf45d2dca5fcd71f53c71386be8667157c446 Mon Sep 17 00:00:00 2001 From: Kamil Doległo Date: Thu, 25 Jun 2020 19:27:21 +0200 Subject: Make samples runnable --- .../test/kotlin/linkableContent/LinkableContentTest.kt | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) (limited to 'plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt') diff --git a/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt b/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt index c2596ba3..191df066 100644 --- a/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt +++ b/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt @@ -94,7 +94,8 @@ class LinkableContentTest : AbstractCoreTest() { testFromData(configuration) { renderingStage = { rootPageNode, dokkaContext -> - val newRoot = SourceLinksTransformer(dokkaContext, + val newRoot = SourceLinksTransformer( + dokkaContext, PageContentBuilder( dokkaContext.single(dokkaContext.plugin().commentsToContentConverter), dokkaContext.single(dokkaContext.plugin().signatureProvider), @@ -109,7 +110,8 @@ class LinkableContentTest : AbstractCoreTest() { val name = it.name.substringBefore("Class") val crl = it.safeAs()?.content?.safeAs()?.children?.last() ?.safeAs()?.children?.last()?.safeAs()?.children?.lastOrNull() - ?.safeAs()?.children?.singleOrNull()?.safeAs()?.children?.singleOrNull().safeAs() + ?.safeAs()?.children?.singleOrNull() + ?.safeAs()?.children?.singleOrNull().safeAs() Assertions.assertEquals( "https://github.com/user/repo/tree/master/src/${name.toLowerCase()}Main/kotlin/${name}Class.kt#L3", crl?.address @@ -166,7 +168,12 @@ class LinkableContentTest : AbstractCoreTest() { .cast().children.single() .cast().children.single().cast().text Assertions.assertEquals( - "${name}Class().printWithExclamation(\"Hi, $name\")", + """|import p2.${name}Class + |fun main() { + | //sampleStart + | ${name}Class().printWithExclamation("Hi, $name") + | //sampleEnd + |}""".trimMargin(), text ) } @@ -175,7 +182,7 @@ class LinkableContentTest : AbstractCoreTest() { } @Test - fun `Documenting return type for a function in inner class with generic parent`(){ + fun `Documenting return type for a function in inner class with generic parent`() { testInline( """ |/src/main/kotlin/test/source.kt -- cgit From b0e8622f374f6499058b0f083367b4a54512b702 Mon Sep 17 00:00:00 2001 From: "sebastian.sellmair" Date: Tue, 30 Jun 2020 23:06:03 +0200 Subject: Enforce workspace unique SourceSetID --- .../kotlin/linkableContent/LinkableContentTest.kt | 38 +++++++++++----------- 1 file changed, 19 insertions(+), 19 deletions(-) (limited to 'plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt') diff --git a/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt b/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt index 191df066..2775fcf4 100644 --- a/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt +++ b/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt @@ -23,23 +23,23 @@ class LinkableContentTest : AbstractCoreTest() { val includesDir = getTestDataDir("linkable/includes").toAbsolutePath() val configuration = dokkaConfiguration { - passes { - pass { + sourceSets { + sourceSet { moduleName = "example" analysisPlatform = "js" sourceRoots = listOf("jsMain", "commonMain", "jvmAndJsSecondCommonMain").map { Paths.get("$testDataDir/$it/kotlin").toString() } - sourceSetID = "js" + name = "js" includes = listOf(Paths.get("$includesDir/include2.md").toString()) } - pass { + sourceSet { moduleName = "example" analysisPlatform = "jvm" sourceRoots = listOf("jvmMain", "commonMain", "jvmAndJsSecondCommonMain").map { Paths.get("$testDataDir/$it/kotlin").toString() } - sourceSetID = "jvm" + name = "jvm" includes = listOf(Paths.get("$includesDir/include1.md").toString()) } } @@ -62,8 +62,8 @@ class LinkableContentTest : AbstractCoreTest() { val testDataDir = getTestDataDir("linkable/sources").toAbsolutePath() val configuration = dokkaConfiguration { - passes { - pass { + sourceSets { + sourceSet { moduleName = "example" analysisPlatform = "js" sourceRoots = listOf("$testDataDir/jsMain/kotlin") @@ -74,9 +74,9 @@ class LinkableContentTest : AbstractCoreTest() { lineSuffix = "#L" ) ) - sourceSetID = "js" + name = "js" } - pass { + sourceSet { moduleName = "example" analysisPlatform = "jvm" sourceRoots = listOf("$testDataDir/jvmMain/kotlin") @@ -87,7 +87,7 @@ class LinkableContentTest : AbstractCoreTest() { lineSuffix = "#L" ) ) - sourceSetID = "jvm" + name = "jvm" } } } @@ -127,19 +127,19 @@ class LinkableContentTest : AbstractCoreTest() { val testDataDir = getTestDataDir("linkable/samples").toAbsolutePath() val configuration = dokkaConfiguration { - passes { - pass { + sourceSets { + sourceSet { moduleName = "example" analysisPlatform = "js" sourceRoots = listOf("$testDataDir/jsMain/kotlin") - sourceSetID = "js" + name = "js" samples = listOf("$testDataDir/jsMain/resources/Samples.kt") } - pass { + sourceSet { moduleName = "example" analysisPlatform = "jvm" sourceRoots = listOf("$testDataDir/jvmMain/kotlin") - sourceSetID = "jvm" + name = "jvm" samples = listOf("$testDataDir/jvmMain/resources/Samples.kt") } } @@ -196,11 +196,11 @@ class LinkableContentTest : AbstractCoreTest() { | """.trimIndent(), dokkaConfiguration { - passes { - pass { + sourceSets { + sourceSet { sourceRoots = listOf("src/") analysisPlatform = "jvm" - sourceSetID = "js" + name = "js" } } } @@ -222,4 +222,4 @@ class LinkableContentTest : AbstractCoreTest() { } } } -} \ No newline at end of file +} -- cgit From dcd4c1c5bc13e7bb058bcd055aa2b02d7d39e9c1 Mon Sep 17 00:00:00 2001 From: Andrzej Ratajczak Date: Tue, 14 Jul 2020 19:22:17 +0200 Subject: Fix presenting inline code in KDoc --- plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt') diff --git a/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt b/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt index 2775fcf4..a8fc9f6d 100644 --- a/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt +++ b/plugins/base/src/test/kotlin/linkableContent/LinkableContentTest.kt @@ -166,7 +166,7 @@ class LinkableContentTest : AbstractCoreTest() { .cast().children.single() .cast().children.single() .cast().children.single() - .cast().children.single().cast().text + .cast().children.single().cast().text Assertions.assertEquals( """|import p2.${name}Class |fun main() { -- cgit