aboutsummaryrefslogtreecommitdiff
path: root/integration-tests/maven/src/integrationTest/kotlin/org/jetbrains/dokka
diff options
context:
space:
mode:
authorIgnat Beresnev <ignat.beresnev@jetbrains.com>2023-11-10 11:46:54 +0100
committerGitHub <noreply@github.com>2023-11-10 11:46:54 +0100
commit8e5c63d035ef44a269b8c43430f43f5c8eebfb63 (patch)
tree1b915207b2b9f61951ddbf0ff2e687efd053d555 /integration-tests/maven/src/integrationTest/kotlin/org/jetbrains/dokka
parenta44efd4ba0c2e4ab921ff75e0f53fc9335aa79db (diff)
downloaddokka-8e5c63d035ef44a269b8c43430f43f5c8eebfb63.tar.gz
dokka-8e5c63d035ef44a269b8c43430f43f5c8eebfb63.tar.bz2
dokka-8e5c63d035ef44a269b8c43430f43f5c8eebfb63.zip
Restructure the project to utilize included builds (#3174)
* Refactor and simplify artifact publishing * Update Gradle to 8.4 * Refactor and simplify convention plugins and build scripts Fixes #3132 --------- Co-authored-by: Adam <897017+aSemy@users.noreply.github.com> Co-authored-by: Oleg Yukhnevich <whyoleg@gmail.com>
Diffstat (limited to 'integration-tests/maven/src/integrationTest/kotlin/org/jetbrains/dokka')
-rw-r--r--integration-tests/maven/src/integrationTest/kotlin/org/jetbrains/dokka/it/maven/BiojavaIntegrationTest.kt63
-rw-r--r--integration-tests/maven/src/integrationTest/kotlin/org/jetbrains/dokka/it/maven/MavenIntegrationTest.kt219
2 files changed, 0 insertions, 282 deletions
diff --git a/integration-tests/maven/src/integrationTest/kotlin/org/jetbrains/dokka/it/maven/BiojavaIntegrationTest.kt b/integration-tests/maven/src/integrationTest/kotlin/org/jetbrains/dokka/it/maven/BiojavaIntegrationTest.kt
deleted file mode 100644
index 7987d45e..00000000
--- a/integration-tests/maven/src/integrationTest/kotlin/org/jetbrains/dokka/it/maven/BiojavaIntegrationTest.kt
+++ /dev/null
@@ -1,63 +0,0 @@
-/*
- * Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
- */
-
-package org.jetbrains.dokka.it.maven
-
-import org.jetbrains.dokka.it.*
-import java.io.File
-import kotlin.test.BeforeTest
-import kotlin.test.Test
-import kotlin.test.assertEquals
-import kotlin.test.assertTrue
-
-class BiojavaIntegrationTest : AbstractIntegrationTest(), TestOutputCopier {
-
- private val currentDokkaVersion: String = checkNotNull(System.getenv("DOKKA_VERSION"))
- private val mavenBinaryFile: File = File(checkNotNull(System.getenv("MVN_BINARY_PATH")))
- override val projectOutputLocation: File by lazy { File(projectDir, "biojava-core/target/dokkaJavadoc") }
-
- @BeforeTest
- fun prepareProjectFiles() {
- val templateProjectDir = File("projects", "biojava/biojava")
- templateProjectDir.copyRecursively(projectDir)
- val customResourcesDir = File(templateProjectDir, "custom Resources")
- if (customResourcesDir.exists() && customResourcesDir.isDirectory) {
- customResourcesDir.copyRecursively(File(projectDir, "customResources"), overwrite = true)
- }
- copyAndApplyGitDiff(File("projects", "biojava/biojava.diff"))
- }
-
- @Test
- fun `dokka javadoc`() {
- val result = ProcessBuilder().directory(projectDir)
- .command(mavenBinaryFile.absolutePath, "dokka:javadoc", "-pl", "biojava-core", "\"-Ddokka_version=$currentDokkaVersion\"", "-U", "-e").start().awaitProcessResult()
-
- diagnosticAsserts(result)
-
- assertTrue(projectOutputLocation.isDirectory, "Missing dokka output directory")
-
- val scriptsDir = File(projectOutputLocation, "jquery")
- assertTrue(scriptsDir.isDirectory, "Missing jquery directory")
-
- val stylesDir = File(projectOutputLocation, "resources")
- assertTrue(stylesDir.isDirectory, "Missing resources directory")
-
- projectDir.allHtmlFiles().forEach { file ->
- assertContainsNoErrorClass(file)
- assertNoUnresolvedLinks(file)
- }
- }
-
- private fun diagnosticAsserts(result: ProcessResult) {
- assertEquals(0, result.exitCode, "Expected exitCode 0 (Success)")
-
- val extensionLoadedRegex = Regex("""Extension: org\.jetbrains\.dokka\.base\.DokkaBase""")
- val amountOfExtensionsLoaded = extensionLoadedRegex.findAll(result.output).count()
-
- assertTrue(
- amountOfExtensionsLoaded > 10,
- "Expected more than 10 extensions being present (found $amountOfExtensionsLoaded)"
- )
- }
-}
diff --git a/integration-tests/maven/src/integrationTest/kotlin/org/jetbrains/dokka/it/maven/MavenIntegrationTest.kt b/integration-tests/maven/src/integrationTest/kotlin/org/jetbrains/dokka/it/maven/MavenIntegrationTest.kt
deleted file mode 100644
index 7606072c..00000000
--- a/integration-tests/maven/src/integrationTest/kotlin/org/jetbrains/dokka/it/maven/MavenIntegrationTest.kt
+++ /dev/null
@@ -1,219 +0,0 @@
-/*
- * Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
- */
-
-package org.jetbrains.dokka.it.maven
-
-import org.intellij.lang.annotations.Language
-import org.jetbrains.dokka.it.AbstractIntegrationTest
-import org.jetbrains.dokka.it.ProcessResult
-import org.jetbrains.dokka.it.awaitProcessResult
-import java.io.File
-import kotlin.test.*
-
-class MavenIntegrationTest : AbstractIntegrationTest() {
-
- private val currentDokkaVersion: String = checkNotNull(System.getenv("DOKKA_VERSION"))
-
- private val mavenBinaryFile: File = File(checkNotNull(System.getenv("MVN_BINARY_PATH")))
-
- @BeforeTest
- fun prepareProjectFiles() {
- val templateProjectDir = File("projects", "it-maven")
- templateProjectDir.copyRecursively(projectDir)
- val pomXml = File(projectDir, "pom.xml")
- assertTrue(pomXml.isFile)
- pomXml.apply {
- writeText(readText().replace("\$dokka_version", currentDokkaVersion))
- }
- val customResourcesDir = File(templateProjectDir, "customResources")
- if (customResourcesDir.exists() && customResourcesDir.isDirectory) {
- customResourcesDir.copyRecursively(File(projectDir, "customResources"), overwrite = true)
- }
- }
-
- @Test
- fun `dokka help`() {
- val result = ProcessBuilder().directory(projectDir)
- .command(mavenBinaryFile.absolutePath, "dokka:help", "-U", "-e")
- .start()
- .awaitProcessResult()
-
- // format the output to remove blank lines and make newlines system-independent
- val output = result.output.lines().filter { it.isNotBlank() }.joinToString("\n")
-
- assertContains(
- output,
- """
- |This plugin has 4 goals:
- |dokka:dokka
- |dokka:help
- |dokka:javadoc
- |dokka:javadocJar
- """.trimMargin()
- )
- }
-
- @Test
- fun `dokka dokka`() {
- val result = ProcessBuilder().directory(projectDir)
- .command(mavenBinaryFile.absolutePath, "dokka:dokka", "-U", "-e").start().awaitProcessResult()
-
- diagnosticAsserts(result)
-
- val dokkaOutputDir = File(projectDir, "output")
- assertTrue(dokkaOutputDir.isDirectory, "Missing dokka output directory")
-
- val imagesDir = File(dokkaOutputDir, "images")
- assertTrue(imagesDir.isDirectory, "Missing images directory")
-
- val scriptsDir = File(dokkaOutputDir, "scripts")
- assertTrue(scriptsDir.isDirectory, "Missing scripts directory")
-
- val stylesDir = File(dokkaOutputDir, "styles")
- assertTrue(stylesDir.isDirectory, "Missing styles directory")
-
- val navigationHtml = File(dokkaOutputDir, "navigation.html")
- assertTrue(navigationHtml.isFile, "Missing navigation.html")
-
- projectDir.allHtmlFiles().forEach { file ->
- assertContainsNoErrorClass(file)
- assertNoUnresolvedLinks(file)
- assertNoEmptyLinks(file)
- assertNoEmptySpans(file)
- }
-
- assertTrue(
- stylesDir.resolve("logo-styles.css").readText().contains(
- "--dokka-logo-image-url: url('https://upload.wikimedia.org/wikipedia/commons/9/9d/Ubuntu_logo.svg');",
- )
- )
- assertTrue(stylesDir.resolve("custom-style-to-add.css").isFile)
- projectDir.allHtmlFiles().forEach { file ->
- if (file.name != "navigation.html") {
- assertTrue(
- "custom-style-to-add.css" in file.readText(),
- "custom styles not added to html file ${file.name}"
- )
- }
- }
- assertTrue(stylesDir.resolve("custom-style-to-add.css").readText().contains("""/* custom stylesheet */"""))
- assertTrue(imagesDir.resolve("custom-resource.svg").isFile)
-
- assertConfiguredVisibility(projectDir)
- }
-
- @Test
- fun `dokka javadoc`() {
- val result = ProcessBuilder().directory(projectDir)
- .command(mavenBinaryFile.absolutePath, "dokka:javadoc", "-U", "-e").start().awaitProcessResult()
-
- diagnosticAsserts(result)
-
- val dokkaOutputDir = File(projectDir, "output")
- assertTrue(dokkaOutputDir.isDirectory, "Missing dokka output directory")
-
- val scriptsDir = File(dokkaOutputDir, "jquery")
- assertTrue(scriptsDir.isDirectory, "Missing jquery directory")
-
- val stylesDir = File(dokkaOutputDir, "resources")
- assertTrue(stylesDir.isDirectory, "Missing resources directory")
-
- projectDir.allHtmlFiles().forEach { file ->
- assertContainsNoErrorClass(file)
- assertNoUnresolvedLinks(file)
- }
- }
-
- @Test
- fun `dokka javadocJar`() {
- val result = ProcessBuilder().directory(projectDir)
- .command(mavenBinaryFile.absolutePath, "dokka:javadocJar", "-U", "-e").start().awaitProcessResult()
-
- diagnosticAsserts(result)
-
- val dokkaOutputDir = File(projectDir, "output")
- assertTrue(dokkaOutputDir.isDirectory, "Missing dokka output directory")
-
- val scriptsDir = File(dokkaOutputDir, "jquery")
- assertTrue(scriptsDir.isDirectory, "Missing jquery directory")
-
- val stylesDir = File(dokkaOutputDir, "resources")
- assertTrue(stylesDir.isDirectory, "Missing resources directory")
-
- val dokkaTargetDir = File(projectDir, "target")
- assertTrue(dokkaOutputDir.isDirectory, "Missing dokka target directory")
-
- val jarFile = File(dokkaTargetDir, "it-maven-1.0-SNAPSHOT-javadoc.jar")
- assertTrue(jarFile.isFile, "Missing dokka jar file")
-
- projectDir.allHtmlFiles().forEach { file ->
- assertContainsNoErrorClass(file)
- assertNoUnresolvedLinks(file)
- }
- }
-
- private fun diagnosticAsserts(result: ProcessResult) {
- assertEquals(0, result.exitCode, "Expected exitCode 0 (Success)")
-
- val extensionLoadedRegex = Regex("""Extension: org\.jetbrains\.dokka\.base\.DokkaBase""")
- val amountOfExtensionsLoaded = extensionLoadedRegex.findAll(result.output).count()
-
- assertTrue(
- amountOfExtensionsLoaded > 10,
- "Expected more than 10 extensions being present (found $amountOfExtensionsLoaded)"
- )
-
- val undocumentedReportRegex = Regex("""Undocumented:""")
- val amountOfUndocumentedReports = undocumentedReportRegex.findAll(result.output).count()
- assertTrue(
- amountOfUndocumentedReports > 0,
- "Expected at least one report of undocumented code (found $amountOfUndocumentedReports)"
- )
-
- val undocumentedJavaReportRegex = Regex("""Undocumented: it\.basic\.java""")
- val amountOfUndocumentedJavaReports = undocumentedJavaReportRegex.findAll(result.output).count()
- assertTrue(
- amountOfUndocumentedJavaReports > 0,
- "Expected at least one report of undocumented java code (found $amountOfUndocumentedJavaReports)"
- )
- }
-
- private fun assertConfiguredVisibility(projectDir: File) {
- val projectHtmlFiles = projectDir.allHtmlFiles().toList()
-
- assertContentVisibility(
- contentFiles = projectHtmlFiles,
- documentPublic = true,
- documentProtected = true, // sourceSet documentedVisibilities
- documentInternal = false,
- documentPrivate = true // for overriddenVisibility package
- )
-
- assertContainsFilePaths(
- outputFiles = projectHtmlFiles,
- expectedFilePaths = listOf(
- // documentedVisibilities is overridden for package `overriddenVisibility` specifically
- // to include private code, so html pages for it are expected to have been created
- Regex("it\\.overriddenVisibility/-visible-private-class/private-method\\.html"),
- Regex("it\\.overriddenVisibility/-visible-private-class/private-val\\.html"),
- )
- )
- }
-
- companion object {
- /*
- * TODO replace with kotlin.test.assertContains after migrating to Kotlin language version 1.5+
- */
- fun assertContains(
- charSequence: CharSequence,
- @Language("TEXT") other: CharSequence,
- ignoreCase: Boolean = false
- ) {
- asserter.assertTrue(
- { "Expected the char sequence to contain the substring.\nCharSequence <$charSequence>, substring <$other>, ignoreCase <$ignoreCase>." },
- charSequence.contains(other, ignoreCase)
- )
- }
- }
-}