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>

4 files changed, 0 insertions, 473 deletions

diff --git a/integration-tests/cli/src/integrationTest/kotlin/org/jetbrains/dokka/it/cli/CliIntegrationTest.kt b/integration-tests/cli/src/integrationTest/kotlin/org/jetbrains/dokka/it/cli/CliIntegrationTest.kt
deleted file mode 100644
index 8bab690b..00000000
--- a/integration-tests/cli/src/integrationTest/kotlin/org/jetbrains/dokka/it/cli/CliIntegrationTest.kt
+++ /dev/null
@@ -1,377 +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.cli
-
-import org.jetbrains.dokka.it.awaitProcessResult
-import java.io.File
-import java.io.PrintWriter
-import java.lang.IllegalStateException
-import kotlin.test.*
-
-class CliIntegrationTest : AbstractCliIntegrationTest() {
-
-    @BeforeTest
-    fun copyProject() {
-        val templateProjectDir = File("projects", "it-cli")
-        templateProjectDir.copyRecursively(projectDir)
-    }
-
-    @Test
-    fun runHelp() {
-        val process = ProcessBuilder("java", "-jar", cliJarFile.path, "-h")
-            .redirectErrorStream(true)
-            .start()
-
-        val result = process.awaitProcessResult()
-        assertEquals(0, result.exitCode, "Expected exitCode 0 (Success)")
-        assertTrue("Usage: " in result.output)
-    }
-
-    @Test
-    fun runCli() {
-        val dokkaOutputDir = File(projectDir, "output")
-        assertTrue(dokkaOutputDir.mkdirs())
-        val process = ProcessBuilder(
-            "java", "-jar", cliJarFile.path,
-            "-outputDir", dokkaOutputDir.path,
-            "-pluginsClasspath", basePluginJarFile.path,
-            "-moduleName", "Basic Project",
-            "-sourceSet",
-            buildString {
-                append(" -sourceSetName cliMain")
-                append(" -src ${File(projectDir, "src").path}")
-                append(" -jdkVersion 8")
-                append(" -analysisPlatform jvm")
-                append(" -reportUndocumented")
-                append(" -skipDeprecated")
-            }
-        )
-            .redirectErrorStream(true)
-            .start()
-
-        val result = process.awaitProcessResult()
-        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)"
-        )
-
-        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)
-        }
-
-        assertContentVisibility(
-            contentFiles = projectDir.allHtmlFiles().toList(),
-            documentPublic = true,
-            documentInternal = false,
-            documentProtected = false,
-            documentPrivate = false
-        )
-
-        assertFalse(
-            projectDir.resolve("output").resolve("index.html").readText().contains("emptypackagetest"),
-            "Expected not to render empty packages"
-        )
-    }
-
-    @Test
-    fun failCli() {
-        val dokkaOutputDir = File(projectDir, "output")
-        assertTrue(dokkaOutputDir.mkdirs())
-        val process = ProcessBuilder(
-            "java", "-jar", cliJarFile.path,
-            "-outputDir", dokkaOutputDir.path,
-            "-pluginsClasspath", basePluginJarFile.path,
-            "-moduleName", "Basic Project",
-            "-failOnWarning",
-            "-sourceSet",
-            buildString {
-                append(" -sourceSetName cliMain")
-                append(" -src ${File(projectDir, "src").path}")
-                append(" -jdkVersion 8")
-                append(" -analysisPlatform jvm")
-                append(" -reportUndocumented")
-            }
-        )
-            .redirectErrorStream(true)
-            .start()
-
-        val result = process.awaitProcessResult()
-        assertEquals(1, result.exitCode, "Expected exitCode 1 (Fail)")
-
-        assertTrue(result.output.contains("Exception in thread \"main\" org.jetbrains.dokka.DokkaException: Failed with warningCount"))
-    }
-
-    @Test
-    fun emptyPackagesTest() {
-        val dokkaOutputDir = File(projectDir, "output")
-        assertTrue(dokkaOutputDir.mkdirs())
-        val process = ProcessBuilder(
-            "java", "-jar", cliJarFile.path,
-            "-outputDir", dokkaOutputDir.path,
-            "-pluginsClasspath", basePluginJarFile.path,
-            "-moduleName", "Basic Project",
-            "-sourceSet",
-            buildString {
-                append(" -sourceSetName cliMain")
-                append(" -src ${File(projectDir, "src").path}")
-                append(" -jdkVersion 8")
-                append(" -analysisPlatform jvm")
-                append(" -noSkipEmptyPackages")
-            }
-        )
-            .redirectErrorStream(true)
-            .start()
-
-        val result = process.awaitProcessResult()
-        assertEquals(0, result.exitCode, "Expected exitCode 0 (Success)")
-
-        assertTrue(
-            projectDir.resolve("output").resolve("index.html").readText().contains("emptypackagetest"),
-            "Expected to render empty packages"
-        )
-    }
-
-    @Test
-    fun `module name should be optional`() {
-        val dokkaOutputDir = File(projectDir, "output")
-        assertTrue(dokkaOutputDir.mkdirs())
-        val process = ProcessBuilder(
-            "java", "-jar", cliJarFile.path,
-            "-outputDir", dokkaOutputDir.path,
-            "-loggingLevel", "DEBUG",
-            "-pluginsClasspath", basePluginJarFile.path,
-            "-sourceSet",
-            buildString {
-                append(" -src ${File(projectDir, "src").path}")
-            }
-        )
-            .redirectErrorStream(true)
-            .start()
-
-        val result = process.awaitProcessResult()
-        assertEquals(0, result.exitCode, "Expected exitCode 0 (Success)")
-        assertTrue(result.output.contains("Loaded plugins: "), "Expected output to not contain info logs")
-
-        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")
-    }
-
-    @Test
-    fun `logging level should be respected`() {
-        val dokkaOutputDir = File(projectDir, "output")
-        assertTrue(dokkaOutputDir.mkdirs())
-        val process = ProcessBuilder(
-            "java", "-jar", cliJarFile.path,
-            "-outputDir", dokkaOutputDir.path,
-            "-loggingLevel", "WARN",
-            "-pluginsClasspath", basePluginJarFile.path,
-            "-sourceSet",
-            buildString {
-                append(" -src ${File(projectDir, "src").path}")
-            }
-        )
-            .redirectErrorStream(true)
-            .start()
-
-        val result = process.awaitProcessResult()
-        assertEquals(0, result.exitCode, "Expected exitCode 0 (Success)")
-        assertFalse(result.output.contains("Loaded plugins: "), "Expected output to not contain info logs")
-    }
-
-    @Test
-    fun `custom documented visibility`() {
-        val dokkaOutputDir = File(projectDir, "output")
-        assertTrue(dokkaOutputDir.mkdirs())
-        val process = ProcessBuilder(
-            "java", "-jar", cliJarFile.path,
-            "-outputDir", dokkaOutputDir.path,
-            "-pluginsClasspath", basePluginJarFile.path,
-            "-moduleName", "Basic Project",
-            "-sourceSet",
-            buildString {
-                append(" -sourceSetName cliMain")
-                append(" -src ${File(projectDir, "src").path}")
-                append(" -jdkVersion 8")
-                append(" -analysisPlatform jvm")
-                append(" -documentedVisibilities PUBLIC;PROTECTED")
-                append(" -perPackageOptions it.overriddenVisibility.*,+visibility:PRIVATE")
-            }
-        )
-            .redirectErrorStream(true)
-            .start()
-
-        val result = process.awaitProcessResult()
-        assertEquals(0, result.exitCode, "Expected exitCode 0 (Success)")
-
-        val allHtmlFiles = projectDir.allHtmlFiles().toList()
-
-        assertContentVisibility(
-            contentFiles = allHtmlFiles,
-            documentPublic = true,
-            documentProtected = true, // sourceSet documentedVisibilities
-            documentInternal = false,
-            documentPrivate = true // for overriddenVisibility package
-        )
-
-        assertContainsFilePaths(
-            outputFiles = allHtmlFiles,
-            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"),
-            )
-        )
-    }
-
-
-    @Test
-    fun `should accept json as input configuration`() {
-        val dokkaOutputDir = File(projectDir, "output")
-        assertTrue(dokkaOutputDir.mkdirs())
-        val resourcePath = javaClass.getResource("/my-file.json")?.toURI() ?: throw IllegalStateException("No JSON found!")
-        val jsonPath = File(resourcePath).absolutePath
-        PrintWriter(jsonPath).run {
-            write(jsonBuilder(dokkaOutputDir.invariantSeparatorsPath, basePluginJarFile.invariantSeparatorsPath, File(projectDir, "src").invariantSeparatorsPath, reportUndocumented = true))
-            close()
-        }
-
-        val process = ProcessBuilder(
-            "java", "-jar", cliJarFile.path, jsonPath
-        ).redirectErrorStream(true).start()
-
-        val result = process.awaitProcessResult()
-        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)"
-        )
-
-        assertTrue(dokkaOutputDir.isDirectory, "Missing dokka output directory")
-    }
-
-    /**
-     * This test disables global `reportUndocumneted` property and set `reportUndocumented` via perPackageOptions to
-     * make sure that global settings apply to dokka context.
-     */
-    @Test
-    fun `global settings should overwrite package options in configuration`() {
-        val dokkaOutputDir = File(projectDir, "output")
-        assertTrue(dokkaOutputDir.mkdirs())
-        val resourcePath = javaClass.getResource("/my-file.json")?.toURI() ?: throw IllegalStateException("No JSON found!")
-        val jsonPath = File(resourcePath).absolutePath
-        PrintWriter(jsonPath).run {
-            write(
-                jsonBuilder(
-                    outputPath = dokkaOutputDir.invariantSeparatorsPath,
-                    pluginsClasspath = basePluginJarFile.invariantSeparatorsPath,
-                    projectPath = File(projectDir, "src").invariantSeparatorsPath,
-                    globalSourceLinks = """
-                        {
-                          "localDirectory": "/home/Vadim.Mishenev/dokka/examples/cli/src/main/kotlin",
-                          "remoteUrl": "https://github.com/Kotlin/dokka/tree/master/examples/gradle/dokka-gradle-example/src/main/kotlin",
-                          "remoteLineSuffix": "#L"
-                        }
-                    """.trimIndent(),
-                    globalExternalDocumentationLinks = """
-                        {
-                          "url": "https://docs.oracle.com/javase/8/docs/api/",
-                          "packageListUrl": "https://docs.oracle.com/javase/8/docs/api/package-list"
-                        },
-                        {
-                          "url": "https://kotlinlang.org/api/latest/jvm/stdlib/",
-                          "packageListUrl": "https://kotlinlang.org/api/latest/jvm/stdlib/package-list"
-                        }
-                        """.trimIndent(),
-                    globalPerPackageOptions = """
-                        {
-                          "matchingRegex": ".*",
-                          "skipDeprecated": "true",
-                          "reportUndocumented": "true", 
-                          "documentedVisibilities": ["PUBLIC", "PRIVATE", "PROTECTED", "INTERNAL", "PACKAGE"]
-                        }
-                    """.trimIndent(),
-                    reportUndocumented = false
-                ),
-            )
-            close()
-        }
-
-        val process = ProcessBuilder(
-            "java", "-jar", cliJarFile.path, jsonPath
-        ).redirectErrorStream(true).start()
-
-        val result = process.awaitProcessResult()
-        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)"
-        )
-
-        assertTrue(dokkaOutputDir.isDirectory, "Missing dokka output directory")
-    }
-}
diff --git a/integration-tests/cli/src/integrationTest/kotlin/org/jetbrains/dokka/it/cli/jsonBuilder.kt b/integration-tests/cli/src/integrationTest/kotlin/org/jetbrains/dokka/it/cli/jsonBuilder.kt
deleted file mode 100644
index 093df961..00000000
--- a/integration-tests/cli/src/integrationTest/kotlin/org/jetbrains/dokka/it/cli/jsonBuilder.kt
+++ /dev/null
@@ -1,56 +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.cli
-
-fun jsonBuilder(
-    outputPath: String,
-    pluginsClasspath: String,
-    projectPath: String,
-    globalSourceLinks: String = "",
-    globalExternalDocumentationLinks: String = "",
-    globalPerPackageOptions: String = "",
-    reportUndocumented: Boolean = false
-
-): String {
-   return """{
-  "moduleName": "Dokka Example",
-  "moduleVersion": null,
-  "outputDir": "$outputPath",
-  "pluginsClasspath": ["$pluginsClasspath"],
-  "cacheRoot": null,
-  "offlineMode": false,
-  "sourceLinks": [$globalSourceLinks],
-  "externalDocumentationLinks": [$globalExternalDocumentationLinks],
-  "perPackageOptions": [$globalPerPackageOptions],
-  "sourceSets": [
-    {
-      "displayName": "jvm",
-      "sourceSetID": {
-        "scopeId": ":dokkaHtml",
-        "sourceSetName": "main"
-      },
-      "sourceRoots": [
-        "$projectPath"
-      ],
-      "dependentSourceSets": [],
-      "samples": [],
-      "includes": [],
-      "includeNonPublic": false,
-      "reportUndocumented": $reportUndocumented,
-      "skipEmptyPackages": true,
-      "skipDeprecated": false,
-      "jdkVersion": 8,
-      "sourceLinks": [],
-      "perPackageOptions": [],
-      "externalDocumentationLinks": [],
-      "noStdlibLink": false,
-      "noJdkLink": false,
-      "suppressedFiles": [],
-      "analysisPlatform": "jvm"
-    }
-  ]
-}
-"""
-}
diff --git a/integration-tests/cli/src/integrationTest/resources/my-file.json b/integration-tests/cli/src/integrationTest/resources/my-file.json
deleted file mode 100644
index e69de29b..00000000
--- a/integration-tests/cli/src/integrationTest/resources/my-file.json
+++ /dev/null
diff --git a/integration-tests/cli/src/main/kotlin/org/jetbrains/dokka/it/cli/AbstractCliIntegrationTest.kt b/integration-tests/cli/src/main/kotlin/org/jetbrains/dokka/it/cli/AbstractCliIntegrationTest.kt
deleted file mode 100644
index c7c77e68..00000000
--- a/integration-tests/cli/src/main/kotlin/org/jetbrains/dokka/it/cli/AbstractCliIntegrationTest.kt
+++ /dev/null
@@ -1,40 +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.cli
-
-import org.jetbrains.dokka.it.AbstractIntegrationTest
-import java.io.File
-import kotlin.test.BeforeTest
-import kotlin.test.assertTrue
-
-public abstract class AbstractCliIntegrationTest : AbstractIntegrationTest() {
-
-    protected val cliJarFile: File by lazy {
-        File(tempFolder, "dokka.jar")
-    }
-
-    protected val basePluginJarFile: File by lazy {
-        File(tempFolder, "base-plugin.jar")
-    }
-
-    @BeforeTest
-    public fun copyJarFiles() {
-        val cliJarPathEnvironmentKey = "CLI_JAR_PATH"
-        val cliJarFile = File(System.getenv(cliJarPathEnvironmentKey))
-        assertTrue(
-            cliJarFile.exists() && cliJarFile.isFile,
-            "Missing path to CLI jar System.getenv($cliJarPathEnvironmentKey)"
-        )
-        cliJarFile.copyTo(this.cliJarFile)
-
-        val basePluginPathEnvironmentKey = "BASE_PLUGIN_JAR_PATH"
-        val basePluginJarFile = File(System.getenv(basePluginPathEnvironmentKey))
-        assertTrue(
-            basePluginJarFile.exists() && basePluginJarFile.isFile,
-            "Missing path to base plugin jar System.getenv($basePluginPathEnvironmentKey)"
-        )
-        basePluginJarFile.copyTo(this.basePluginJarFile)
-    }
-}