aboutsummaryrefslogtreecommitdiff
path: root/plugins/base/src/test/kotlin/transformers
diff options
context:
space:
mode:
authorIgnat Beresnev <ignat.beresnev@jetbrains.com>2023-08-30 15:58:46 +0200
committerGitHub <noreply@github.com>2023-08-30 15:58:46 +0200
commitc63ea36637ce956029fb15b1482c0683ecb8a587 (patch)
tree2b75a8a976b43530820e73dc60cce4b10d9fc005 /plugins/base/src/test/kotlin/transformers
parent0e00edc6fcd406fcf38673ef6a2f8f59e8374de2 (diff)
downloaddokka-c63ea36637ce956029fb15b1482c0683ecb8a587.tar.gz
dokka-c63ea36637ce956029fb15b1482c0683ecb8a587.tar.bz2
dokka-c63ea36637ce956029fb15b1482c0683ecb8a587.zip
Migrate to JUnit 5 and unify used test API (#3138)
Diffstat (limited to 'plugins/base/src/test/kotlin/transformers')
-rw-r--r--plugins/base/src/test/kotlin/transformers/CommentsToContentConverterTest.kt14
-rw-r--r--plugins/base/src/test/kotlin/transformers/ContextModuleAndPackageDocumentationReaderTest1.kt16
-rw-r--r--plugins/base/src/test/kotlin/transformers/ContextModuleAndPackageDocumentationReaderTest3.kt8
-rw-r--r--plugins/base/src/test/kotlin/transformers/DivisionSwitchTest.kt2
-rw-r--r--plugins/base/src/test/kotlin/transformers/InheritedEntriesDocumentableFilterTransfromerTest.kt7
-rw-r--r--plugins/base/src/test/kotlin/transformers/InvalidContentModuleAndPackageDocumentationReaderTest.kt8
-rw-r--r--plugins/base/src/test/kotlin/transformers/MergeImplicitExpectActualDeclarationsTest.kt4
-rw-r--r--plugins/base/src/test/kotlin/transformers/ModuleAndPackageDocumentationTransformerFunctionalTest.kt2
-rw-r--r--plugins/base/src/test/kotlin/transformers/ModuleAndPackageDocumentationTransformerUnitTest.kt6
-rw-r--r--plugins/base/src/test/kotlin/transformers/ReportUndocumentedTransformerTest.kt8
-rw-r--r--plugins/base/src/test/kotlin/transformers/SourceLinkTransformerTest.kt2
-rw-r--r--plugins/base/src/test/kotlin/transformers/SuppressTagFilterTest.kt4
-rw-r--r--plugins/base/src/test/kotlin/transformers/SuppressedByConfigurationDocumentableFilterTransformerTest.kt7
-rw-r--r--plugins/base/src/test/kotlin/transformers/isExceptionTest.kt5
14 files changed, 47 insertions, 46 deletions
diff --git a/plugins/base/src/test/kotlin/transformers/CommentsToContentConverterTest.kt b/plugins/base/src/test/kotlin/transformers/CommentsToContentConverterTest.kt
index e1029856..a88503b0 100644
--- a/plugins/base/src/test/kotlin/transformers/CommentsToContentConverterTest.kt
+++ b/plugins/base/src/test/kotlin/transformers/CommentsToContentConverterTest.kt
@@ -5,9 +5,9 @@ import org.jetbrains.dokka.base.transformers.pages.comments.DocTagToContentConve
import org.jetbrains.dokka.links.DRI
import org.jetbrains.dokka.model.doc.*
import org.jetbrains.dokka.pages.*
-import org.junit.jupiter.api.Assertions.assertEquals
-import org.junit.jupiter.api.Assertions.assertTrue
-import org.junit.jupiter.api.Test
+import kotlin.test.Test
+import kotlin.test.assertEquals
+import kotlin.test.assertTrue
class CommentsToContentConverterTest {
private val converter = DocTagToContentConverter()
@@ -454,23 +454,23 @@ class CommentsToContentConverterTest {
executeTest(docTag) {
composite<ContentList> {
check {
- assertTrue(style.contains(ListStyle.DescriptionList)) { "Expected DL style" }
+ assertTrue(style.contains(ListStyle.DescriptionList), "Expected DL style")
}
group {
check {
- assertTrue(style.contains(ListStyle.DescriptionTerm)) { "Expected DT style" }
+ assertTrue(style.contains(ListStyle.DescriptionTerm), "Expected DT style")
}
+"description list can have..."
}
group {
check {
- assertTrue(style.contains(ListStyle.DescriptionTerm)) { "Expected DT style" }
+ assertTrue(style.contains(ListStyle.DescriptionTerm), "Expected DT style")
}
+"... two consecutive description terms"
}
group {
check {
- assertTrue(style.contains(ListStyle.DescriptionDetails)) { "Expected DD style" }
+ assertTrue(style.contains(ListStyle.DescriptionDetails), "Expected DD style")
}
+"and usually has some sort of a description, like this one"
}
diff --git a/plugins/base/src/test/kotlin/transformers/ContextModuleAndPackageDocumentationReaderTest1.kt b/plugins/base/src/test/kotlin/transformers/ContextModuleAndPackageDocumentationReaderTest1.kt
index 8d2833e4..34c218aa 100644
--- a/plugins/base/src/test/kotlin/transformers/ContextModuleAndPackageDocumentationReaderTest1.kt
+++ b/plugins/base/src/test/kotlin/transformers/ContextModuleAndPackageDocumentationReaderTest1.kt
@@ -1,6 +1,7 @@
package transformers
import org.jetbrains.dokka.DokkaConfiguration.DokkaSourceSet
+import org.jetbrains.dokka.analysis.kotlin.internal.InternalKotlinAnalysisPlugin
import org.jetbrains.dokka.links.DRI
import org.jetbrains.dokka.model.doc.DocumentationNode
import org.jetbrains.dokka.plugability.DokkaContext
@@ -9,14 +10,13 @@ import org.jetbrains.dokka.plugability.querySingle
import org.jetbrains.dokka.testApi.logger.TestLogger
import org.jetbrains.dokka.utilities.DokkaConsoleLogger
import org.jetbrains.dokka.utilities.LoggingLevel
-import org.jetbrains.dokka.analysis.kotlin.internal.InternalKotlinAnalysisPlugin
-import org.junit.jupiter.api.Assertions.assertEquals
-import org.junit.jupiter.api.BeforeEach
-import org.junit.jupiter.api.Test
-import org.junit.jupiter.api.assertThrows
import testApi.testRunner.TestDokkaConfigurationBuilder
import testApi.testRunner.dModule
import testApi.testRunner.dPackage
+import kotlin.test.BeforeTest
+import kotlin.test.Test
+import kotlin.test.assertEquals
+import kotlin.test.assertFailsWith
class ContextModuleAndPackageDocumentationReaderTest1 : AbstractContextModuleAndPackageDocumentationReaderTest() {
@@ -24,7 +24,7 @@ class ContextModuleAndPackageDocumentationReaderTest1 : AbstractContextModuleAnd
private val includeSourceSetA by lazy { temporaryDirectory.resolve("includeA.md").toFile() }
private val includeSourceSetB by lazy { temporaryDirectory.resolve("includeB.md").toFile() }
- @BeforeEach
+ @BeforeTest
fun materializeIncludes() {
includeSourceSetA.writeText(
"""
@@ -107,14 +107,14 @@ class ContextModuleAndPackageDocumentationReaderTest1 : AbstractContextModuleAnd
fun `assert moduleA with no source sets`() {
val documentation = reader.read(dModule("moduleA"))
assertEquals(
- emptyMap<DokkaSourceSet, DocumentationNode>(), documentation,
+ emptyMap(), documentation,
"Expected no documentation received for module not declaring a matching sourceSet"
)
}
@Test
fun `assert moduleA with unknown source set`() {
- assertThrows<IllegalStateException>(
+ assertFailsWith<IllegalStateException>(
"Expected no documentation received for module with unknown sourceSet"
) {
reader.read(
diff --git a/plugins/base/src/test/kotlin/transformers/ContextModuleAndPackageDocumentationReaderTest3.kt b/plugins/base/src/test/kotlin/transformers/ContextModuleAndPackageDocumentationReaderTest3.kt
index 7195eccd..597c58c2 100644
--- a/plugins/base/src/test/kotlin/transformers/ContextModuleAndPackageDocumentationReaderTest3.kt
+++ b/plugins/base/src/test/kotlin/transformers/ContextModuleAndPackageDocumentationReaderTest3.kt
@@ -1,23 +1,23 @@
package transformers
+import org.jetbrains.dokka.analysis.kotlin.internal.InternalKotlinAnalysisPlugin
import org.jetbrains.dokka.links.DRI
import org.jetbrains.dokka.plugability.DokkaContext
import org.jetbrains.dokka.plugability.plugin
import org.jetbrains.dokka.plugability.querySingle
import org.jetbrains.dokka.utilities.DokkaConsoleLogger
import org.jetbrains.dokka.utilities.LoggingLevel
-import org.jetbrains.dokka.analysis.kotlin.internal.InternalKotlinAnalysisPlugin
-import org.junit.jupiter.api.BeforeEach
-import org.junit.jupiter.api.Test
import testApi.testRunner.TestDokkaConfigurationBuilder
import testApi.testRunner.dPackage
+import kotlin.test.BeforeTest
+import kotlin.test.Test
import kotlin.test.assertEquals
class ContextModuleAndPackageDocumentationReaderTest3 : AbstractContextModuleAndPackageDocumentationReaderTest() {
private val include by lazy { temporaryDirectory.resolve("include.md").toFile() }
- @BeforeEach
+ @BeforeTest
fun materializeInclude() {
include.writeText(
"""
diff --git a/plugins/base/src/test/kotlin/transformers/DivisionSwitchTest.kt b/plugins/base/src/test/kotlin/transformers/DivisionSwitchTest.kt
index 16798508..2e9fbaa1 100644
--- a/plugins/base/src/test/kotlin/transformers/DivisionSwitchTest.kt
+++ b/plugins/base/src/test/kotlin/transformers/DivisionSwitchTest.kt
@@ -9,7 +9,7 @@ import org.jetbrains.dokka.pages.ClasslikePageNode
import org.jetbrains.dokka.pages.ContentHeader
import org.jetbrains.dokka.pages.ContentNode
import org.jetbrains.dokka.pages.ContentText
-import org.junit.jupiter.api.Test
+import kotlin.test.Test
import kotlin.test.assertEquals
import kotlin.test.assertNotNull
diff --git a/plugins/base/src/test/kotlin/transformers/InheritedEntriesDocumentableFilterTransfromerTest.kt b/plugins/base/src/test/kotlin/transformers/InheritedEntriesDocumentableFilterTransfromerTest.kt
index 826df64e..d8811bcd 100644
--- a/plugins/base/src/test/kotlin/transformers/InheritedEntriesDocumentableFilterTransfromerTest.kt
+++ b/plugins/base/src/test/kotlin/transformers/InheritedEntriesDocumentableFilterTransfromerTest.kt
@@ -2,10 +2,10 @@ package transformers
import org.jetbrains.dokka.base.testApi.testRunner.BaseAbstractTest
import org.jetbrains.dokka.model.DEnum
-import org.junit.jupiter.api.Test
-import utils.OnlyDescriptors
+import kotlin.test.Test
import kotlin.test.assertEquals
import kotlin.test.assertTrue
+import utils.OnlyDescriptors
class InheritedEntriesDocumentableFilterTransformerTest : BaseAbstractTest() {
val suppressingInheritedConfiguration = dokkaConfiguration {
@@ -155,4 +155,5 @@ class InheritedEntriesDocumentableFilterTransformerTest : BaseAbstractTest() {
}
}
}
-} \ No newline at end of file
+}
+
diff --git a/plugins/base/src/test/kotlin/transformers/InvalidContentModuleAndPackageDocumentationReaderTest.kt b/plugins/base/src/test/kotlin/transformers/InvalidContentModuleAndPackageDocumentationReaderTest.kt
index 3ec1d273..e3b396a1 100644
--- a/plugins/base/src/test/kotlin/transformers/InvalidContentModuleAndPackageDocumentationReaderTest.kt
+++ b/plugins/base/src/test/kotlin/transformers/InvalidContentModuleAndPackageDocumentationReaderTest.kt
@@ -1,15 +1,15 @@
package transformers
+import org.jetbrains.dokka.analysis.kotlin.internal.InternalKotlinAnalysisPlugin
import org.jetbrains.dokka.plugability.DokkaContext
import org.jetbrains.dokka.plugability.plugin
import org.jetbrains.dokka.plugability.querySingle
import org.jetbrains.dokka.utilities.DokkaConsoleLogger
import org.jetbrains.dokka.utilities.LoggingLevel
-import org.jetbrains.dokka.analysis.kotlin.internal.InternalKotlinAnalysisPlugin
-import org.junit.jupiter.api.BeforeEach
-import org.junit.jupiter.api.Test
import testApi.testRunner.TestDokkaConfigurationBuilder
import testApi.testRunner.dModule
+import kotlin.test.BeforeTest
+import kotlin.test.Test
import kotlin.test.assertEquals
import kotlin.test.assertTrue
@@ -19,7 +19,7 @@ class InvalidContentModuleAndPackageDocumentationReaderTest : AbstractContextMod
private val includeA by lazy { temporaryDirectory.resolve("includeA.md").toFile() }
private val includeB by lazy { temporaryDirectory.resolve("includeB.md").toFile() }
- @BeforeEach
+ @BeforeTest
fun materializeInclude() {
includeA.writeText(
"""
diff --git a/plugins/base/src/test/kotlin/transformers/MergeImplicitExpectActualDeclarationsTest.kt b/plugins/base/src/test/kotlin/transformers/MergeImplicitExpectActualDeclarationsTest.kt
index e6cc393d..cdb19299 100644
--- a/plugins/base/src/test/kotlin/transformers/MergeImplicitExpectActualDeclarationsTest.kt
+++ b/plugins/base/src/test/kotlin/transformers/MergeImplicitExpectActualDeclarationsTest.kt
@@ -8,11 +8,11 @@ import org.jetbrains.dokka.model.childrenOfType
import org.jetbrains.dokka.model.dfs
import org.jetbrains.dokka.model.firstChildOfType
import org.jetbrains.dokka.pages.*
-import org.junit.jupiter.api.Test
-import utils.OnlyDescriptors
import utils.assertNotNull
+import kotlin.test.Test
import kotlin.test.assertEquals
import kotlin.test.assertNotNull
+import utils.OnlyDescriptors
class MergeImplicitExpectActualDeclarationsTest : BaseAbstractTest() {
diff --git a/plugins/base/src/test/kotlin/transformers/ModuleAndPackageDocumentationTransformerFunctionalTest.kt b/plugins/base/src/test/kotlin/transformers/ModuleAndPackageDocumentationTransformerFunctionalTest.kt
index 134e7f59..7bf3c9c1 100644
--- a/plugins/base/src/test/kotlin/transformers/ModuleAndPackageDocumentationTransformerFunctionalTest.kt
+++ b/plugins/base/src/test/kotlin/transformers/ModuleAndPackageDocumentationTransformerFunctionalTest.kt
@@ -2,11 +2,11 @@ package transformers
import org.jetbrains.dokka.DokkaSourceSetID
import org.jetbrains.dokka.base.testApi.testRunner.BaseAbstractTest
-import org.junit.jupiter.api.Test
import org.junit.jupiter.api.io.TempDir
import transformers.AbstractContextModuleAndPackageDocumentationReaderTest.Companion.texts
import utils.OnlyDescriptorsMPP
import java.nio.file.Path
+import kotlin.test.Test
import kotlin.test.assertEquals
class ModuleAndPackageDocumentationTransformerFunctionalTest : BaseAbstractTest() {
diff --git a/plugins/base/src/test/kotlin/transformers/ModuleAndPackageDocumentationTransformerUnitTest.kt b/plugins/base/src/test/kotlin/transformers/ModuleAndPackageDocumentationTransformerUnitTest.kt
index 3cbb90ca..d404c6f1 100644
--- a/plugins/base/src/test/kotlin/transformers/ModuleAndPackageDocumentationTransformerUnitTest.kt
+++ b/plugins/base/src/test/kotlin/transformers/ModuleAndPackageDocumentationTransformerUnitTest.kt
@@ -2,6 +2,7 @@ package transformers
import org.jetbrains.dokka.DokkaConfiguration
+import org.jetbrains.dokka.analysis.kotlin.internal.ModuleAndPackageDocumentationReader
import org.jetbrains.dokka.analysis.markdown.jb.MARKDOWN_ELEMENT_FILE_NAME
import org.jetbrains.dokka.base.transformers.documentables.ModuleAndPackageDocumentationTransformer
import org.jetbrains.dokka.links.DRI
@@ -12,11 +13,10 @@ import org.jetbrains.dokka.model.doc.CustomDocTag
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.analysis.kotlin.internal.ModuleAndPackageDocumentationReader
-import org.junit.jupiter.api.Assertions.assertEquals
-import org.junit.jupiter.api.Test
import testApi.testRunner.dPackage
import testApi.testRunner.sourceSet
+import kotlin.test.Test
+import kotlin.test.assertEquals
class ModuleAndPackageDocumentationTransformerUnitTest {
diff --git a/plugins/base/src/test/kotlin/transformers/ReportUndocumentedTransformerTest.kt b/plugins/base/src/test/kotlin/transformers/ReportUndocumentedTransformerTest.kt
index 431abef5..88fc7a9d 100644
--- a/plugins/base/src/test/kotlin/transformers/ReportUndocumentedTransformerTest.kt
+++ b/plugins/base/src/test/kotlin/transformers/ReportUndocumentedTransformerTest.kt
@@ -5,9 +5,9 @@ import org.jetbrains.dokka.DokkaDefaults
import org.jetbrains.dokka.PackageOptionsImpl
import org.jetbrains.dokka.Platform
import org.jetbrains.dokka.base.testApi.testRunner.BaseAbstractTest
-import org.junit.jupiter.api.Assertions.assertEquals
-import org.junit.jupiter.api.Disabled
-import org.junit.jupiter.api.Test
+import kotlin.test.Ignore
+import kotlin.test.Test
+import kotlin.test.assertEquals
class ReportUndocumentedTransformerTest : BaseAbstractTest() {
@@ -181,7 +181,7 @@ class ReportUndocumentedTransformerTest : BaseAbstractTest() {
}
}
- @Disabled
+ @Ignore
@Test
fun `undocumented secondary constructor gets reported`() {
val configuration = dokkaConfiguration {
diff --git a/plugins/base/src/test/kotlin/transformers/SourceLinkTransformerTest.kt b/plugins/base/src/test/kotlin/transformers/SourceLinkTransformerTest.kt
index 532c9e81..a6ae5d7c 100644
--- a/plugins/base/src/test/kotlin/transformers/SourceLinkTransformerTest.kt
+++ b/plugins/base/src/test/kotlin/transformers/SourceLinkTransformerTest.kt
@@ -4,11 +4,11 @@ import org.jetbrains.dokka.DokkaSourceSetID
import org.jetbrains.dokka.SourceLinkDefinitionImpl
import org.jetbrains.dokka.base.testApi.testRunner.BaseAbstractTest
import org.jsoup.nodes.Element
-import org.junit.jupiter.api.Test
import signatures.renderedContent
import utils.OnlyDescriptorsMPP
import utils.TestOutputWriterPlugin
import java.net.URL
+import kotlin.test.Test
import kotlin.test.assertEquals
class SourceLinkTransformerTest : BaseAbstractTest() {
diff --git a/plugins/base/src/test/kotlin/transformers/SuppressTagFilterTest.kt b/plugins/base/src/test/kotlin/transformers/SuppressTagFilterTest.kt
index de1ee46c..e6059e85 100644
--- a/plugins/base/src/test/kotlin/transformers/SuppressTagFilterTest.kt
+++ b/plugins/base/src/test/kotlin/transformers/SuppressTagFilterTest.kt
@@ -3,7 +3,7 @@ package transformers
import org.jetbrains.dokka.base.testApi.testRunner.BaseAbstractTest
import org.jetbrains.dokka.model.DEnum
import org.jetbrains.dokka.model.WithCompanion
-import org.junit.jupiter.api.Test
+import kotlin.test.Test
import kotlin.test.assertEquals
import kotlin.test.assertNotNull
import kotlin.test.assertNull
@@ -204,4 +204,4 @@ class SuppressTagFilterTest : BaseAbstractTest() {
}
}
}
-} \ No newline at end of file
+}
diff --git a/plugins/base/src/test/kotlin/transformers/SuppressedByConfigurationDocumentableFilterTransformerTest.kt b/plugins/base/src/test/kotlin/transformers/SuppressedByConfigurationDocumentableFilterTransformerTest.kt
index a6060970..377c8bec 100644
--- a/plugins/base/src/test/kotlin/transformers/SuppressedByConfigurationDocumentableFilterTransformerTest.kt
+++ b/plugins/base/src/test/kotlin/transformers/SuppressedByConfigurationDocumentableFilterTransformerTest.kt
@@ -4,9 +4,8 @@ import org.jetbrains.dokka.DokkaDefaults
import org.jetbrains.dokka.PackageOptionsImpl
import org.jetbrains.dokka.base.testApi.testRunner.BaseAbstractTest
import org.jetbrains.dokka.links.DRI
-import org.junit.jupiter.api.Assertions.assertEquals
-import org.junit.jupiter.api.Assertions.assertIterableEquals
-import org.junit.jupiter.api.Test
+import kotlin.test.Test
+import kotlin.test.assertEquals
class SuppressedByConfigurationDocumentableFilterTransformerTest : BaseAbstractTest() {
@@ -90,7 +89,7 @@ class SuppressedByConfigurationDocumentableFilterTransformerTest : BaseAbstractT
) {
documentablesMergingStage = { module ->
assertEquals(2, module.packages.size, "Expected two packages in module")
- assertIterableEquals(
+ assertEquals(
listOf(DRI("parent.some"), DRI("parent.other.default")).sortedBy { it.packageName },
module.packages.map { it.dri }.sortedBy { it.packageName },
"Expected 'parent.some' and 'parent.other.default' packages to be not suppressed"
diff --git a/plugins/base/src/test/kotlin/transformers/isExceptionTest.kt b/plugins/base/src/test/kotlin/transformers/isExceptionTest.kt
index dd888ad6..b1ad7163 100644
--- a/plugins/base/src/test/kotlin/transformers/isExceptionTest.kt
+++ b/plugins/base/src/test/kotlin/transformers/isExceptionTest.kt
@@ -3,8 +3,8 @@ package transformers
import org.jetbrains.dokka.base.transformers.documentables.isException
import org.jetbrains.dokka.model.DClass
import org.jetbrains.dokka.model.DTypeAlias
-import org.junit.jupiter.api.Test
import utils.AbstractModelTest
+import kotlin.test.Test
import utils.JavaCode
import utils.UsingJDK
@@ -147,4 +147,5 @@ class IsExceptionJavaTest: AbstractModelTest("/src/main/kotlin/java/Test.java",
}
}
}
-} \ No newline at end of file
+}
+