From 8e5c63d035ef44a269b8c43430f43f5c8eebfb63 Mon Sep 17 00:00:00 2001 From: Ignat Beresnev Date: Fri, 10 Nov 2023 11:46:54 +0100 Subject: 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 --- .../api/plugin-base-test-utils.api | 199 +++++++++++++++++++++ .../plugin-base-test-utils/build.gradle.kts | 32 ++++ .../testApi/renderers/RenderingOnlyTestBase.kt | 12 ++ .../dokka/base/testApi/renderers/TestPage.kt | 59 ++++++ .../base/testApi/signatures/SignatureUtils.kt | 23 +++ .../dokka/base/testApi/testRunner/baseTestApi.kt | 124 +++++++++++++ .../dokka/base/testApi/utils/JsoupUtils.kt | 79 ++++++++ .../dokka/base/testApi/utils/TestOutputWriter.kt | 47 +++++ .../utils/assertHtmlEqualsIgnoringWhitespace.kt | 24 +++ 9 files changed, 599 insertions(+) create mode 100644 dokka-subprojects/plugin-base-test-utils/api/plugin-base-test-utils.api create mode 100644 dokka-subprojects/plugin-base-test-utils/build.gradle.kts create mode 100644 dokka-subprojects/plugin-base-test-utils/src/main/kotlin/org/jetbrains/dokka/base/testApi/renderers/RenderingOnlyTestBase.kt create mode 100644 dokka-subprojects/plugin-base-test-utils/src/main/kotlin/org/jetbrains/dokka/base/testApi/renderers/TestPage.kt create mode 100644 dokka-subprojects/plugin-base-test-utils/src/main/kotlin/org/jetbrains/dokka/base/testApi/signatures/SignatureUtils.kt create mode 100644 dokka-subprojects/plugin-base-test-utils/src/main/kotlin/org/jetbrains/dokka/base/testApi/testRunner/baseTestApi.kt create mode 100644 dokka-subprojects/plugin-base-test-utils/src/main/kotlin/org/jetbrains/dokka/base/testApi/utils/JsoupUtils.kt create mode 100644 dokka-subprojects/plugin-base-test-utils/src/main/kotlin/org/jetbrains/dokka/base/testApi/utils/TestOutputWriter.kt create mode 100644 dokka-subprojects/plugin-base-test-utils/src/main/kotlin/org/jetbrains/dokka/base/testApi/utils/assertHtmlEqualsIgnoringWhitespace.kt (limited to 'dokka-subprojects/plugin-base-test-utils') diff --git a/dokka-subprojects/plugin-base-test-utils/api/plugin-base-test-utils.api b/dokka-subprojects/plugin-base-test-utils/api/plugin-base-test-utils.api new file mode 100644 index 00000000..a6bdc192 --- /dev/null +++ b/dokka-subprojects/plugin-base-test-utils/api/plugin-base-test-utils.api @@ -0,0 +1,199 @@ +public abstract class org/jetbrains/dokka/base/testApi/testRunner/BaseAbstractTest : org/jetbrains/dokka/testApi/testRunner/AbstractTest { + public fun ()V + public fun (Lorg/jetbrains/dokka/testApi/logger/TestLogger;)V + public synthetic fun (Lorg/jetbrains/dokka/testApi/logger/TestLogger;ILkotlin/jvm/internal/DefaultConstructorMarker;)V +} + +public final class org/jetbrains/dokka/base/testApi/testRunner/BaseDokkaTestGenerator : org/jetbrains/dokka/testApi/testRunner/DokkaTestGenerator { + public fun (Lorg/jetbrains/dokka/DokkaConfiguration;Lorg/jetbrains/dokka/utilities/DokkaLogger;Lorg/jetbrains/dokka/base/testApi/testRunner/BaseTestMethods;Ljava/util/List;)V + public synthetic fun (Lorg/jetbrains/dokka/DokkaConfiguration;Lorg/jetbrains/dokka/utilities/DokkaLogger;Lorg/jetbrains/dokka/base/testApi/testRunner/BaseTestMethods;Ljava/util/List;ILkotlin/jvm/internal/DefaultConstructorMarker;)V + public fun generate ()V +} + +public final class org/jetbrains/dokka/base/testApi/testRunner/BaseTestBuilder : org/jetbrains/dokka/testApi/testRunner/TestBuilder { + public fun ()V + public fun build ()Lorg/jetbrains/dokka/base/testApi/testRunner/BaseTestMethods; + public synthetic fun build ()Lorg/jetbrains/dokka/testApi/testRunner/TestMethods; + public final fun getDocumentablesCreationStage ()Lkotlin/jvm/functions/Function1; + public final fun getDocumentablesMergingStage ()Lkotlin/jvm/functions/Function1; + public final fun getDocumentablesTransformationStage ()Lkotlin/jvm/functions/Function1; + public final fun getPagesGenerationStage ()Lkotlin/jvm/functions/Function1; + public final fun getPagesTransformationStage ()Lkotlin/jvm/functions/Function1; + public final fun getPluginsSetupStage ()Lkotlin/jvm/functions/Function1; + public final fun getPreMergeDocumentablesTransformationStage ()Lkotlin/jvm/functions/Function1; + public final fun getRenderingStage ()Lkotlin/jvm/functions/Function2; + public final fun getVerificationStage ()Lkotlin/jvm/functions/Function1; + public final fun setDocumentablesCreationStage (Lkotlin/jvm/functions/Function1;)V + public final fun setDocumentablesMergingStage (Lkotlin/jvm/functions/Function1;)V + public final fun setDocumentablesTransformationStage (Lkotlin/jvm/functions/Function1;)V + public final fun setPagesGenerationStage (Lkotlin/jvm/functions/Function1;)V + public final fun setPagesTransformationStage (Lkotlin/jvm/functions/Function1;)V + public final fun setPluginsSetupStage (Lkotlin/jvm/functions/Function1;)V + public final fun setPreMergeDocumentablesTransformationStage (Lkotlin/jvm/functions/Function1;)V + public final fun setRenderingStage (Lkotlin/jvm/functions/Function2;)V + public final fun setVerificationStage (Lkotlin/jvm/functions/Function1;)V +} + +public final class org/jetbrains/dokka/base/testApi/testRunner/BaseTestMethods : org/jetbrains/dokka/testApi/testRunner/CoreTestMethods { + public fun (Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function2;)V + public final fun component1 ()Lkotlin/jvm/functions/Function1; + public final fun component2 ()Lkotlin/jvm/functions/Function1; + public final fun component3 ()Lkotlin/jvm/functions/Function1; + public final fun component4 ()Lkotlin/jvm/functions/Function1; + public final fun component5 ()Lkotlin/jvm/functions/Function1; + public final fun component6 ()Lkotlin/jvm/functions/Function1; + public final fun component7 ()Lkotlin/jvm/functions/Function1; + public final fun component8 ()Lkotlin/jvm/functions/Function1; + public final fun component9 ()Lkotlin/jvm/functions/Function2; + public final fun copy (Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function2;)Lorg/jetbrains/dokka/base/testApi/testRunner/BaseTestMethods; + public static synthetic fun copy$default (Lorg/jetbrains/dokka/base/testApi/testRunner/BaseTestMethods;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function1;Lkotlin/jvm/functions/Function2;ILjava/lang/Object;)Lorg/jetbrains/dokka/base/testApi/testRunner/BaseTestMethods; + public fun equals (Ljava/lang/Object;)Z + public fun getDocumentablesCreationStage ()Lkotlin/jvm/functions/Function1; + public final fun getDocumentablesFirstTransformationStep ()Lkotlin/jvm/functions/Function1; + public fun getDocumentablesMergingStage ()Lkotlin/jvm/functions/Function1; + public fun getDocumentablesTransformationStage ()Lkotlin/jvm/functions/Function1; + public fun getPagesGenerationStage ()Lkotlin/jvm/functions/Function1; + public fun getPagesTransformationStage ()Lkotlin/jvm/functions/Function1; + public fun getPluginsSetupStage ()Lkotlin/jvm/functions/Function1; + public fun getRenderingStage ()Lkotlin/jvm/functions/Function2; + public fun getVerificationStage ()Lkotlin/jvm/functions/Function1; + public fun hashCode ()I + public fun toString ()Ljava/lang/String; +} + +public final class renderers/RawTestPage : org/jetbrains/dokka/pages/RootPageNode, org/jetbrains/dokka/pages/ContentPage { + public fun (Lorg/jetbrains/dokka/pages/ContentNode;Ljava/lang/String;Ljava/util/Set;Ljava/util/List;Ljava/util/List;)V + public synthetic fun (Lorg/jetbrains/dokka/pages/ContentNode;Ljava/lang/String;Ljava/util/Set;Ljava/util/List;Ljava/util/List;ILkotlin/jvm/internal/DefaultConstructorMarker;)V + public fun getChildren ()Ljava/util/List; + public fun getContent ()Lorg/jetbrains/dokka/pages/ContentNode; + public fun getDocumentable ()Lorg/jetbrains/dokka/model/Documentable; + public fun getDri ()Ljava/util/Set; + public fun getEmbeddedResources ()Ljava/util/List; + public fun getName ()Ljava/lang/String; + public synthetic fun modified (Ljava/lang/String;Ljava/util/List;)Lorg/jetbrains/dokka/pages/PageNode; + public fun modified (Ljava/lang/String;Ljava/util/List;)Lorg/jetbrains/dokka/pages/RootPageNode; + public fun modified (Ljava/lang/String;Lorg/jetbrains/dokka/pages/ContentNode;Ljava/util/Set;Ljava/util/List;Ljava/util/List;)Lorg/jetbrains/dokka/pages/ContentPage; +} + +public abstract class renderers/RenderingOnlyTestBase { + public fun ()V + public abstract fun getContext ()Lorg/jetbrains/dokka/testApi/context/MockContext; + public abstract fun getRenderedContent ()Ljava/lang/Object; +} + +public final class renderers/TestPageKt { + public static final fun testPage (Lkotlin/jvm/functions/Function1;)Lrenderers/RawTestPage; +} + +public final class signatures/Parameter : utils/Tag { + public fun ([Ljava/lang/Object;)V +} + +public final class signatures/Parameters : utils/Tag { + public fun ([Ljava/lang/Object;)V +} + +public final class signatures/SignatureUtilsKt { + public static final fun firstSignature (Lorg/jsoup/nodes/Element;)Lorg/jsoup/nodes/Element; + public static final fun lastSignature (Lorg/jsoup/nodes/Element;)Lorg/jsoup/nodes/Element; + public static final fun renderedContent (Lutils/TestOutputWriter;Ljava/lang/String;)Lorg/jsoup/nodes/Element; + public static synthetic fun renderedContent$default (Lutils/TestOutputWriter;Ljava/lang/String;ILjava/lang/Object;)Lorg/jsoup/nodes/Element; + public static final fun signature (Lorg/jsoup/nodes/Element;)Lorg/jsoup/select/Elements; + public static final fun tab (Lorg/jsoup/nodes/Element;Ljava/lang/String;)Lorg/jsoup/select/Elements; +} + +public final class utils/A : utils/Tag { + public fun ([Ljava/lang/Object;)V +} + +public final class utils/AssertHtmlEqualsIgnoringWhitespaceKt { + public static final fun assertHtmlEqualsIgnoringWhitespace (Ljava/lang/String;Ljava/lang/String;)V +} + +public final class utils/B : utils/Tag { + public fun ([Ljava/lang/Object;)V +} + +public final class utils/BlockQuote : utils/Tag { + public fun ([Ljava/lang/Object;)V +} + +public final class utils/Br : utils/Tag { + public static final field INSTANCE Lutils/Br; +} + +public final class utils/Dd : utils/Tag { + public fun ([Ljava/lang/Object;)V +} + +public final class utils/Div : utils/Tag { + public fun ([Ljava/lang/Object;)V +} + +public final class utils/Dl : utils/Tag { + public fun ([Ljava/lang/Object;)V +} + +public final class utils/Dt : utils/Tag { + public fun ([Ljava/lang/Object;)V +} + +public final class utils/I : utils/Tag { + public fun ([Ljava/lang/Object;)V +} + +public final class utils/JsoupUtilsKt { + public static final fun match (Lorg/jsoup/nodes/Element;[Ljava/lang/Object;Z)V + public static synthetic fun match$default (Lorg/jsoup/nodes/Element;[Ljava/lang/Object;ZILjava/lang/Object;)V + public static final fun withClasses (Lutils/Tag;[Ljava/lang/String;)Lutils/Tag; +} + +public final class utils/P : utils/Tag { + public fun ([Ljava/lang/Object;)V +} + +public final class utils/STRIKE : utils/Tag { + public fun ([Ljava/lang/Object;)V +} + +public final class utils/Span : utils/Tag { + public fun ([Ljava/lang/Object;)V +} + +public class utils/Tag { + public fun (Ljava/lang/String;[Ljava/lang/Object;Ljava/util/List;)V + public synthetic fun (Ljava/lang/String;[Ljava/lang/Object;Ljava/util/List;ILkotlin/jvm/internal/DefaultConstructorMarker;)V + public final fun getExpectedClasses ()Ljava/util/List; + public final fun getMatchers ()[Ljava/lang/Object; + public final fun getName ()Ljava/lang/String; +} + +public final class utils/TestOutputWriter : org/jetbrains/dokka/base/renderers/OutputWriter { + public fun ()V + public fun (Z)V + public synthetic fun (ZILkotlin/jvm/internal/DefaultConstructorMarker;)V + public final fun getContents ()Ljava/util/Map; + public fun write (Ljava/lang/String;Ljava/lang/String;Ljava/lang/String;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; + public fun writeResources (Ljava/lang/String;Ljava/lang/String;Lkotlin/coroutines/Continuation;)Ljava/lang/Object; +} + +public final class utils/TestOutputWriterPlugin : org/jetbrains/dokka/plugability/DokkaPlugin { + public fun ()V + public fun (Z)V + public synthetic fun (ZILkotlin/jvm/internal/DefaultConstructorMarker;)V + public final fun getTestWriter ()Lorg/jetbrains/dokka/plugability/Extension; + public final fun getWriter ()Lutils/TestOutputWriter; +} + +public final class utils/U : utils/Tag { + public fun ([Ljava/lang/Object;)V +} + +public final class utils/Var : utils/Tag { + public fun ([Ljava/lang/Object;)V +} + +public final class utils/Wbr : utils/Tag { + public static final field INSTANCE Lutils/Wbr; +} + diff --git a/dokka-subprojects/plugin-base-test-utils/build.gradle.kts b/dokka-subprojects/plugin-base-test-utils/build.gradle.kts new file mode 100644 index 00000000..d137b728 --- /dev/null +++ b/dokka-subprojects/plugin-base-test-utils/build.gradle.kts @@ -0,0 +1,32 @@ +/* + * Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license. + */ + +import dokkabuild.overridePublicationArtifactId + +plugins { + id("dokkabuild.kotlin-jvm") + id("dokkabuild.publish-jvm") +} + +overridePublicationArtifactId("dokka-base-test-utils") + +dependencies { + compileOnly(projects.dokkaSubprojects.dokkaCore) + compileOnly(projects.dokkaSubprojects.pluginBase) + + api(projects.dokkaSubprojects.analysisKotlinApi) + + // TODO [beresnev] analysis switcher + //runtimeOnly(project(path = ":subprojects:analysis-kotlin-symbols", configuration = "shadow")) + runtimeOnly(project(path = ":dokka-subprojects:analysis-kotlin-descriptors", configuration = "shadow")) + + implementation(kotlin("reflect")) + implementation(libs.jsoup) + + implementation(kotlin("test")) + implementation(projects.dokkaSubprojects.coreTestApi) + + testImplementation(kotlin("test")) + testImplementation(projects.dokkaSubprojects.coreTestApi) +} diff --git a/dokka-subprojects/plugin-base-test-utils/src/main/kotlin/org/jetbrains/dokka/base/testApi/renderers/RenderingOnlyTestBase.kt b/dokka-subprojects/plugin-base-test-utils/src/main/kotlin/org/jetbrains/dokka/base/testApi/renderers/RenderingOnlyTestBase.kt new file mode 100644 index 00000000..d2ff3ad4 --- /dev/null +++ b/dokka-subprojects/plugin-base-test-utils/src/main/kotlin/org/jetbrains/dokka/base/testApi/renderers/RenderingOnlyTestBase.kt @@ -0,0 +1,12 @@ +/* + * Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license. + */ + +package renderers + +import org.jetbrains.dokka.testApi.context.MockContext + +public abstract class RenderingOnlyTestBase { + public abstract val context: MockContext + public abstract val renderedContent: T +} diff --git a/dokka-subprojects/plugin-base-test-utils/src/main/kotlin/org/jetbrains/dokka/base/testApi/renderers/TestPage.kt b/dokka-subprojects/plugin-base-test-utils/src/main/kotlin/org/jetbrains/dokka/base/testApi/renderers/TestPage.kt new file mode 100644 index 00000000..6fb484bf --- /dev/null +++ b/dokka-subprojects/plugin-base-test-utils/src/main/kotlin/org/jetbrains/dokka/base/testApi/renderers/TestPage.kt @@ -0,0 +1,59 @@ +/* + * Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license. + */ + +package renderers + +import org.jetbrains.dokka.DokkaConfiguration +import org.jetbrains.dokka.base.signatures.KotlinSignatureProvider +import org.jetbrains.dokka.base.transformers.pages.comments.CommentsToContentConverter +import org.jetbrains.dokka.base.translators.documentables.PageContentBuilder +import org.jetbrains.dokka.links.DRI +import org.jetbrains.dokka.model.doc.DocTag +import org.jetbrains.dokka.model.properties.PropertyContainer +import org.jetbrains.dokka.pages.* +import org.jetbrains.dokka.utilities.DokkaConsoleLogger +import org.jetbrains.dokka.utilities.LoggingLevel + +public fun testPage(callback: PageContentBuilder.DocumentableContentBuilder.() -> Unit): RawTestPage { + val content = PageContentBuilder( + EmptyCommentConverter, + KotlinSignatureProvider(EmptyCommentConverter, DokkaConsoleLogger(LoggingLevel.DEBUG)), + DokkaConsoleLogger(LoggingLevel.DEBUG) + ).contentFor( + DRI.topLevel, + emptySet(), + block = callback + ) + + return RawTestPage(content) +} + +public class RawTestPage( + override val content: ContentNode, + override val name: String = "testPage", + override val dri: Set = setOf(DRI.topLevel), + override val embeddedResources: List = emptyList(), + override val children: List = emptyList(), +): RootPageNode(), ContentPage { + override fun modified( + name: String, + content: ContentNode, + dri: Set, + embeddedResources: List, + children: List + ): ContentPage = this + + override fun modified(name: String, children: List): RootPageNode = this + +} + +internal object EmptyCommentConverter : CommentsToContentConverter { + override fun buildContent( + docTag: DocTag, + dci: DCI, + sourceSets: Set, + styles: Set