Skip to content

Commit

Permalink
test: updated navigation tests
Browse files Browse the repository at this point in the history
  • Loading branch information
@berezinant
berezinant committed Nov 21, 2024
1 parent 569fb20 commit 6bd7182
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 40 deletions.
2 changes: 1 addition & 1 deletion dokka-subprojects/plugin-base/src/test/kotlin/enums/KotlinEnumsTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -230,7 +230,7 @@ class KotlinEnumsTest : BaseAbstractTest() {
pluginOverrides = listOf(writerPlugin)
) {
renderingStage = { _, _ ->
val sideMenu = writerPlugin.writer.navigationHtml().select("div.sideMenuPart")
val sideMenu = writerPlugin.writer.navigationHtml().select(".toc--part")

assertEquals("ZERO", sideMenu.select("#root-nav-submenu-0-0-0").text())
assertEquals("ONE", sideMenu.select("#root-nav-submenu-0-0-1").text())
Expand Down
62 changes: 35 additions & 27 deletions dokka-subprojects/plugin-base/src/test/kotlin/renderers/html/NavigationIconTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ package renderers.html
import org.jetbrains.dokka.base.testApi.testRunner.BaseAbstractTest
import utils.TestOutputWriterPlugin
import utils.navigationHtml
import utils.selectNavigationGrid
import utils.selectTocLinkGrid
import kotlin.test.Test
import kotlin.test.assertEquals

Expand All @@ -22,7 +22,7 @@ class NavigationIconTest : BaseAbstractTest() {
}

@Test
fun `should include all navigation icons`() {
fun `should include all icons`() {
val source = """
|/src/main/kotlin/com/example/Empty.kt
|package com.example
Expand All @@ -38,26 +38,35 @@ class NavigationIconTest : BaseAbstractTest() {
) {
renderingStage = { _, _ ->
val navIconAssets = writerPlugin.writer.contents
.filterKeys { it.startsWith("images/nav-icons") }
.filterKeys { it.startsWith("ui-kit/assets") }
.keys.sorted()

assertEquals(16, navIconAssets.size)
assertEquals("images/nav-icons/abstract-class-kotlin.svg", navIconAssets[0])
assertEquals("images/nav-icons/abstract-class.svg", navIconAssets[1])
assertEquals("images/nav-icons/annotation-kotlin.svg", navIconAssets[2])
assertEquals("images/nav-icons/annotation.svg", navIconAssets[3])
assertEquals("images/nav-icons/class-kotlin.svg", navIconAssets[4])
assertEquals("images/nav-icons/class.svg", navIconAssets[5])
assertEquals("images/nav-icons/enum-kotlin.svg", navIconAssets[6])
assertEquals("images/nav-icons/enum.svg", navIconAssets[7])
assertEquals("images/nav-icons/exception-class.svg", navIconAssets[8])
assertEquals("images/nav-icons/field-value.svg", navIconAssets[9])
assertEquals("images/nav-icons/field-variable.svg", navIconAssets[10])
assertEquals("images/nav-icons/function.svg", navIconAssets[11])
assertEquals("images/nav-icons/interface-kotlin.svg", navIconAssets[12])
assertEquals("images/nav-icons/interface.svg", navIconAssets[13])
assertEquals("images/nav-icons/object.svg", navIconAssets[14])
assertEquals("images/nav-icons/typealias-kotlin.svg", navIconAssets[15])
assertEquals(25, navIconAssets.size)
assertEquals("ui-kit/assets/abstract-class-kotlin.svg", navIconAssets[0])
assertEquals("ui-kit/assets/abstract-class.svg", navIconAssets[1])
assertEquals("ui-kit/assets/annotation-kotlin.svg", navIconAssets[2])
assertEquals("ui-kit/assets/annotation.svg", navIconAssets[3])
assertEquals("ui-kit/assets/arrow-down.svg", navIconAssets[4])
assertEquals("ui-kit/assets/burger.svg", navIconAssets[5])
assertEquals("ui-kit/assets/checkbox-off.svg", navIconAssets[6])
assertEquals("ui-kit/assets/checkbox-on.svg", navIconAssets[7])
assertEquals("ui-kit/assets/class-kotlin.svg", navIconAssets[8])
assertEquals("ui-kit/assets/class.svg", navIconAssets[9])
assertEquals("ui-kit/assets/cross.svg", navIconAssets[10])
assertEquals("ui-kit/assets/enum-kotlin.svg", navIconAssets[11])
assertEquals("ui-kit/assets/enum.svg", navIconAssets[12])
assertEquals("ui-kit/assets/exception-class.svg", navIconAssets[13])
assertEquals("ui-kit/assets/field-value.svg", navIconAssets[14])
assertEquals("ui-kit/assets/field-variable.svg", navIconAssets[15])
assertEquals("ui-kit/assets/filter.svg", navIconAssets[16])
assertEquals("ui-kit/assets/function.svg", navIconAssets[17])
assertEquals("ui-kit/assets/homepage.svg", navIconAssets[18])
assertEquals("ui-kit/assets/interface-kotlin.svg", navIconAssets[19])
assertEquals("ui-kit/assets/interface.svg", navIconAssets[20])
assertEquals("ui-kit/assets/object.svg", navIconAssets[21])
assertEquals("ui-kit/assets/placeholder.svg", navIconAssets[22])
assertEquals("ui-kit/assets/theme-toggle.svg", navIconAssets[23])
assertEquals("ui-kit/assets/typealias-kotlin.svg", navIconAssets[24])
}
}
}
Expand Down Expand Up @@ -248,13 +257,12 @@ class NavigationIconTest : BaseAbstractTest() {
pluginOverrides = listOf(writerPlugin)
) {
renderingStage = { _, _ ->
val content = writerPlugin.writer.navigationHtml().select("div.sideMenuPart")
val navigationGrid = content.selectNavigationGrid()
val content = writerPlugin.writer.navigationHtml().select(".toc--part")
val navigationGrid = content.selectTocLinkGrid()

val classNames = navigationGrid.child(0).classNames().toList()
assertEquals("nav-link-child", classNames[0])
assertEquals("nav-icon", classNames[1])
assertEquals(expectedIconClass, classNames[2])
assertEquals("toc--icon", classNames[0])
assertEquals(expectedIconClass, classNames[1])

val navLinkText = navigationGrid.child(1).text()
assertEquals(expectedNavLinkText, navLinkText)
Expand All @@ -276,15 +284,15 @@ class NavigationIconTest : BaseAbstractTest() {
pluginOverrides = listOf(writerPlugin)
) {
renderingStage = { _, _ ->
val content = writerPlugin.writer.navigationHtml().select("div.sideMenuPart")
val content = writerPlugin.writer.navigationHtml().select(".toc--part")

assertEquals(3, content.size)
assertEquals("root-nav-submenu", content[0].id())
assertEquals("root-nav-submenu-0", content[1].id())
assertEquals("root-nav-submenu-0-0", content[2].id())

// there's 3 nav items, but only one icon
val navLinkGrids = content.select("span.nav-icon")
val navLinkGrids = content.select(".toc--icon")
assertEquals(1, navLinkGrids.size)
}
}
Expand Down
19 changes: 9 additions & 10 deletions dokka-subprojects/plugin-base/src/test/kotlin/renderers/html/NavigationTest.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ class NavigationTest : BaseAbstractTest() {
pluginOverrides = listOf(writerPlugin)
) {
renderingStage = { _, _ ->
val content = writerPlugin.writer.navigationHtml().select("div.sideMenuPart")
val content = writerPlugin.writer.navigationHtml().select(".toc--part")
assertEquals(6, content.size)

// Navigation menu should be the following:
Expand Down Expand Up @@ -112,7 +112,7 @@ class NavigationTest : BaseAbstractTest() {
pluginOverrides = listOf(writerPlugin)
) {
renderingStage = { _, _ ->
val content = writerPlugin.writer.navigationHtml().select("div.sideMenuPart")
val content = writerPlugin.writer.navigationHtml().select(".toc--part")
assertEquals(4, content.size)

content[0].assertNavigationLink(
Expand Down Expand Up @@ -158,7 +158,7 @@ class NavigationTest : BaseAbstractTest() {
pluginOverrides = listOf(writerPlugin)
) {
renderingStage = { _, _ ->
val content = writerPlugin.writer.navigationHtml().select("div.sideMenuPart")
val content = writerPlugin.writer.navigationHtml().select(".toc--part")
assertEquals(3, content.size)

// Navigation menu should be the following:
Expand Down Expand Up @@ -212,7 +212,7 @@ class NavigationTest : BaseAbstractTest() {
pluginOverrides = listOf(writerPlugin)
) {
renderingStage = { _, _ ->
val content = writerPlugin.writer.navigationHtml().select("div.sideMenuPart")
val content = writerPlugin.writer.navigationHtml().select(".toc--part")
assertEquals(3, content.size)

// Navigation menu should be the following:
Expand Down Expand Up @@ -269,7 +269,7 @@ class NavigationTest : BaseAbstractTest() {
pluginOverrides = listOf(writerPlugin)
) {
renderingStage = { _, _ ->
val content = writerPlugin.writer.navigationHtml().select("div.sideMenuPart")
val content = writerPlugin.writer.navigationHtml().select(".toc--part")
assertEquals(9, content.size)

// Navigation menu should be the following, sorted by name:
Expand Down Expand Up @@ -369,7 +369,7 @@ class NavigationTest : BaseAbstractTest() {
pluginOverrides = listOf(writerPlugin)
) {
renderingStage = { _, _ ->
val content = writerPlugin.writer.navigationHtml().select("div.sideMenuPart")
val content = writerPlugin.writer.navigationHtml().select(".toc--part")
assertEquals(7, content.size)

// Navigation menu should be the following
Expand Down Expand Up @@ -444,10 +444,9 @@ class NavigationTest : BaseAbstractTest() {
assertEquals(address, link.attr("href"))
if (icon != null) {
val iconStyles =
this.selectFirst("div.overview span.nav-link-grid")?.child(0)?.classNames()?.toList() ?: emptyList()
assertEquals(3, iconStyles.size)
assertEquals("nav-link-child", iconStyles[0])
assertEquals(icon.style(), "${iconStyles[1]} ${iconStyles[2]}")
this.selectFirst(".toc--part .toc--link-grid")?.child(0)?.classNames()?.toList() ?: emptyList()
assertEquals(2, iconStyles.size)
assertEquals(icon.style(), "${iconStyles[0]} ${iconStyles[1]}")
}
if (isStrikethrough) {
val textInsideStrikethrough = link.selectFirst("strike")?.text()
Expand Down
4 changes: 2 additions & 2 deletions dokka-subprojects/plugin-base/src/test/kotlin/utils/HtmlUtils.kt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,6 @@ internal fun TestOutputWriter.navigationHtml(): Element = contents.getValue("nav

internal fun TestOutputWriter.pagesJson(): List<SearchRecord> = jacksonObjectMapper().readValue(contents.getValue("scripts/pages.json"))

internal fun Elements.selectNavigationGrid(): Element {
return this.select("div.overview").select("span.nav-link-grid").single()
internal fun Elements.selectTocLinkGrid(): Element {
return this.select(".toc--row").select(".toc--link-grid").single()
}

0 comments on commit 6bd7182

Please sign in to comment.