diff options
| author | Ignat Beresnev <ignat.beresnev@jetbrains.com> | 2023-11-10 11:46:54 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-11-10 11:46:54 +0100 |
| commit | 8e5c63d035ef44a269b8c43430f43f5c8eebfb63 (patch) | |
| tree | 1b915207b2b9f61951ddbf0ff2e687efd053d555 /plugins/base/base-test-utils/src/main/kotlin/testRunner | |
| parent | a44efd4ba0c2e4ab921ff75e0f53fc9335aa79db (diff) | |
| download | dokka-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 'plugins/base/base-test-utils/src/main/kotlin/testRunner')
| -rw-r--r-- | plugins/base/base-test-utils/src/main/kotlin/testRunner/baseTestApi.kt | 124 |
1 files changed, 0 insertions, 124 deletions
diff --git a/plugins/base/base-test-utils/src/main/kotlin/testRunner/baseTestApi.kt b/plugins/base/base-test-utils/src/main/kotlin/testRunner/baseTestApi.kt deleted file mode 100644 index 3dc0e54b..00000000 --- a/plugins/base/base-test-utils/src/main/kotlin/testRunner/baseTestApi.kt +++ /dev/null @@ -1,124 +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.base.testApi.testRunner - -import org.jetbrains.dokka.CoreExtensions -import org.jetbrains.dokka.DokkaConfiguration -import org.jetbrains.dokka.DokkaGenerator -import org.jetbrains.dokka.base.generation.SingleModuleGeneration -import org.jetbrains.dokka.model.DModule -import org.jetbrains.dokka.pages.RootPageNode -import org.jetbrains.dokka.plugability.DokkaContext -import org.jetbrains.dokka.plugability.DokkaPlugin -import org.jetbrains.dokka.testApi.logger.TestLogger -import org.jetbrains.dokka.testApi.testRunner.AbstractTest -import org.jetbrains.dokka.testApi.testRunner.CoreTestMethods -import org.jetbrains.dokka.testApi.testRunner.DokkaTestGenerator -import org.jetbrains.dokka.testApi.testRunner.TestBuilder -import org.jetbrains.dokka.utilities.DokkaConsoleLogger -import org.jetbrains.dokka.utilities.DokkaLogger -import org.jetbrains.dokka.utilities.LoggingLevel - -public class BaseDokkaTestGenerator( - configuration: DokkaConfiguration, - logger: DokkaLogger, - testMethods: BaseTestMethods, - additionalPlugins: List<DokkaPlugin> = emptyList() -) : DokkaTestGenerator<BaseTestMethods>(configuration, logger, testMethods, additionalPlugins) { - - override fun generate() { - with(testMethods) { - val dokkaGenerator = DokkaGenerator(configuration, logger) - - val context = - dokkaGenerator.initializePlugins(configuration, logger, additionalPlugins) - pluginsSetupStage(context) - - val singleModuleGeneration = context.single(CoreExtensions.generation) as SingleModuleGeneration - - val modulesFromPlatforms = singleModuleGeneration.createDocumentationModels() - documentablesCreationStage(modulesFromPlatforms) - - verificationStage { singleModuleGeneration.validityCheck(context) } - - val filteredModules = singleModuleGeneration.transformDocumentationModelBeforeMerge(modulesFromPlatforms) - documentablesFirstTransformationStep(filteredModules) - - val documentationModel = singleModuleGeneration.mergeDocumentationModels(filteredModules) - documentablesMergingStage(documentationModel!!) - - val transformedDocumentation = singleModuleGeneration.transformDocumentationModelAfterMerge(documentationModel) - documentablesTransformationStage(transformedDocumentation) - - val pages = singleModuleGeneration.createPages(transformedDocumentation) - pagesGenerationStage(pages) - - val transformedPages = singleModuleGeneration.transformPages(pages) - pagesTransformationStage(transformedPages) - - singleModuleGeneration.render(transformedPages) - renderingStage(transformedPages, context) - - singleModuleGeneration.runPostActions() - - singleModuleGeneration.reportAfterRendering() - } - } -} - -public data class BaseTestMethods( - override val pluginsSetupStage: (DokkaContext) -> Unit, - override val verificationStage: (() -> Unit) -> Unit, - override val documentablesCreationStage: (List<DModule>) -> Unit, - val documentablesFirstTransformationStep: (List<DModule>) -> Unit, - override val documentablesMergingStage: (DModule) -> Unit, - override val documentablesTransformationStage: (DModule) -> Unit, - override val pagesGenerationStage: (RootPageNode) -> Unit, - override val pagesTransformationStage: (RootPageNode) -> Unit, - override val renderingStage: (RootPageNode, DokkaContext) -> Unit -) : CoreTestMethods( - pluginsSetupStage, - verificationStage, - documentablesCreationStage, - documentablesMergingStage, - documentablesTransformationStage, - pagesGenerationStage, - pagesTransformationStage, - renderingStage, -) - -public class BaseTestBuilder : TestBuilder<BaseTestMethods>() { - public var pluginsSetupStage: (DokkaContext) -> Unit = {} - public var verificationStage: (() -> Unit) -> Unit = {} - public var documentablesCreationStage: (List<DModule>) -> Unit = {} - public var preMergeDocumentablesTransformationStage: (List<DModule>) -> Unit = {} - public var documentablesMergingStage: (DModule) -> Unit = {} - public var documentablesTransformationStage: (DModule) -> Unit = {} - public var pagesGenerationStage: (RootPageNode) -> Unit = {} - public var pagesTransformationStage: (RootPageNode) -> Unit = {} - public var renderingStage: (RootPageNode, DokkaContext) -> Unit = { _, _ -> } - - override fun build(): BaseTestMethods { - return BaseTestMethods( - pluginsSetupStage, - verificationStage, - documentablesCreationStage, - preMergeDocumentablesTransformationStage, - documentablesMergingStage, - documentablesTransformationStage, - pagesGenerationStage, - pagesTransformationStage, - renderingStage - ) - } -} - -public abstract class BaseAbstractTest( - logger: TestLogger = TestLogger(DokkaConsoleLogger(LoggingLevel.DEBUG)) -) : AbstractTest<BaseTestMethods, BaseTestBuilder, BaseDokkaTestGenerator>( - ::BaseTestBuilder, - ::BaseDokkaTestGenerator, - logger, -) |
