-
Notifications
You must be signed in to change notification settings - Fork 413
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add the link to GitHub repo to the header if there are source links d…
…efined (#3235) * Use URL from base plugin configuration * Add integration test for the multi-module project that the homepage link exists everywhere
- Loading branch information
Showing
10 changed files
with
195 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
102 changes: 102 additions & 0 deletions
102
plugins/base/src/test/kotlin/renderers/html/HeaderTest.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| /* | ||
| * Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license. | ||
| */ | ||
|
|
||
| package renderers.html | ||
|
|
||
| import org.jetbrains.dokka.DokkaConfiguration | ||
| import org.jetbrains.dokka.DokkaConfigurationImpl | ||
| import org.jetbrains.dokka.PluginConfigurationImpl | ||
| import org.jetbrains.dokka.base.DokkaBase | ||
| import org.jetbrains.dokka.base.DokkaBaseConfiguration | ||
| import org.jetbrains.dokka.base.templating.toJsonString | ||
| import org.jetbrains.dokka.base.testApi.testRunner.BaseAbstractTest | ||
| import org.jetbrains.dokka.pages.RootPageNode | ||
| import org.jetbrains.dokka.plugability.DokkaContext | ||
| import org.jsoup.Jsoup | ||
| import utils.TestOutputWriter | ||
| import utils.TestOutputWriterPlugin | ||
| import kotlin.test.Test | ||
| import kotlin.test.assertEquals | ||
| import kotlin.test.assertNotNull | ||
| import kotlin.test.assertNull | ||
|
|
||
| class HeaderTest : BaseAbstractTest() { | ||
| private val configuration = dokkaConfiguration { | ||
| sourceSets { | ||
| sourceSet { | ||
| name = "jvm" | ||
| sourceRoots = listOf("src/jvm") | ||
| } | ||
| sourceSet { | ||
| name = "js" | ||
| sourceRoots = listOf("src/js") | ||
| } | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| fun `should include homepage link if homepageLink is provided`() { | ||
| testRendering( | ||
| DokkaBaseConfiguration(homepageLink = "https://github.com/Kotlin/dokka/") | ||
| ) { _, _, writer -> | ||
| val renderedContent = navigationElement(writer) | ||
|
|
||
| val sourceLinkElement = | ||
| assertNotNull(renderedContent.getElementById("homepage-link"), "Source link element not found") | ||
| val aElement = assertNotNull(sourceLinkElement.selectFirst("a")) | ||
| assertEquals("https://github.com/Kotlin/dokka/", aElement.attr("href")) | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| fun `should not include homepage link by default`() { | ||
| testRendering(null) { _, _, writer -> | ||
| val renderedContent = navigationElement(writer) | ||
| assertNull(renderedContent.getElementById("homepage-link"), "Source link element found") | ||
| } | ||
| } | ||
|
|
||
| private fun testRendering( | ||
| baseConfiguration: DokkaBaseConfiguration?, | ||
| block: (RootPageNode, DokkaContext, writer: TestOutputWriter) -> Unit | ||
| ) { | ||
| fun configuration(): DokkaConfigurationImpl { | ||
| baseConfiguration ?: return configuration | ||
| return configuration.copy( | ||
| pluginsConfiguration = listOf( | ||
| PluginConfigurationImpl( | ||
| DokkaBase::class.java.canonicalName, | ||
| DokkaConfiguration.SerializationFormat.JSON, | ||
| toJsonString(baseConfiguration) | ||
| ) | ||
| ) | ||
| ) | ||
| } | ||
|
|
||
| val writerPlugin = TestOutputWriterPlugin() | ||
| testInline( | ||
| """ | ||
| |/src/jvm/Test.kt | ||
| |fun test() {} | ||
| |/src/js/Test.kt | ||
| |fun test() {} | ||
| """, | ||
| configuration(), | ||
| pluginOverrides = listOf(writerPlugin) | ||
| ) { | ||
| renderingStage = { node, context -> | ||
| block(node, context, writerPlugin.writer) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private fun navigationElement(writer: TestOutputWriter) = | ||
| writer | ||
| .contents | ||
| .getValue("index.html") | ||
| .let(Jsoup::parse) | ||
| .select(".navigation") | ||
| .single() | ||
|
|
||
| } |