-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
html log link tests and tidying (#124)
- add tests for log link task - minor tidying
- Loading branch information
Showing
9 changed files
with
208 additions
and
21 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
139 changes: 139 additions & 0 deletions
139
modules/dokkatoo-plugin/src/testFunctional/kotlin/tasks/LogHtmlPublicationLinkTaskTest.kt
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,139 @@ | ||
| package dev.adamko.dokkatoo.tasks | ||
|
|
||
| import dev.adamko.dokkatoo.internal.DokkatooConstants | ||
| import dev.adamko.dokkatoo.tasks.LogHtmlPublicationLinkTask.Companion.ENABLE_TASK_PROPERTY_NAME | ||
| import dev.adamko.dokkatoo.utils.* | ||
| import io.kotest.core.spec.style.FunSpec | ||
| import io.kotest.matchers.string.shouldContain | ||
| import io.kotest.matchers.string.shouldNotContain | ||
| import io.ktor.server.cio.CIO | ||
| import io.ktor.server.engine.embeddedServer | ||
| import org.gradle.testkit.runner.TaskOutcome.SKIPPED | ||
| import org.gradle.testkit.runner.TaskOutcome.SUCCESS | ||
|
|
||
| class LogHtmlPublicationLinkTaskTest : FunSpec({ | ||
|
|
||
| context("given an active file-host server") { | ||
| val server = embeddedServer(CIO, port = 0) { } | ||
| server.start(wait = false) | ||
| val serverPort = server.resolvedConnectors().first().port | ||
|
|
||
| val validServerUri = "http://localhost:$serverPort" | ||
| val validServerUriParam = `-P`("testServerUri=$validServerUri") | ||
|
|
||
| context("and a Kotlin project") { | ||
| val project = initDokkatooProject() | ||
|
|
||
| context("when generate task is run with correct server URI") { | ||
| project.runner | ||
| .addArguments( | ||
| "clean", | ||
| "dokkatooGeneratePublicationHtml", | ||
| "--stacktrace", | ||
| "--info", | ||
| validServerUriParam, | ||
| ) | ||
| .forwardOutput() | ||
| .build { | ||
| test("expect project builds successfully") { | ||
| output shouldContain "BUILD SUCCESSFUL" | ||
| } | ||
| test("LogHtmlPublicationLinkTask should run") { | ||
| shouldHaveTasksWithAnyOutcome( | ||
| ":logLinkDokkatooGeneratePublicationHtml" to listOf(SUCCESS) | ||
| ) | ||
| } | ||
| test("expect link is logged") { | ||
| output shouldContain "Generated Dokka HTML publication: $validServerUri/log-html-publication-link-task/build/dokka/html/index.html" | ||
| } | ||
| } | ||
| } | ||
|
|
||
| context("and the server is down") { | ||
| // stop the server immediately | ||
| server.stop(gracePeriodMillis = 0, timeoutMillis = 0) | ||
|
|
||
| context("when running the generate task") { | ||
| project.runner | ||
| .addArguments( | ||
| "clean", | ||
| "dokkatooGeneratePublicationHtml", | ||
| "--stacktrace", | ||
| "--info", | ||
| validServerUriParam, | ||
| ) | ||
| .forwardOutput() | ||
| .build { | ||
| test("expect project builds successfully") { | ||
| output shouldContain "BUILD SUCCESSFUL" | ||
| } | ||
| test("LogHtmlPublicationLinkTask should be skipped") { | ||
| shouldHaveTasksWithAnyOutcome( | ||
| ":logLinkDokkatooGeneratePublicationHtml" to listOf(SKIPPED) | ||
| ) | ||
| output shouldContain "Skipping task ':logLinkDokkatooGeneratePublicationHtml' as task onlyIf 'server URL is reachable' is false" | ||
| } | ||
| test("expect link is not logged") { | ||
| output shouldNotContain "Generated Dokka HTML publication" | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| } | ||
| }) { | ||
| companion object { | ||
| @Suppress("SpellCheckingInspection") | ||
| /** | ||
| * prefix [param] with `-P`. | ||
| * | ||
| * (this exists to avoid annoying typo warnings, e.g. `-Pserver=localhost` -> `Typo: In word 'Pserver'`) | ||
| */ | ||
| private fun `-P`(param: String): String = "-P$param" | ||
| } | ||
| } | ||
|
|
||
|
|
||
| private fun initDokkatooProject( | ||
| config: GradleProjectTest.() -> Unit = {}, | ||
| ): GradleProjectTest { | ||
| return gradleKtsProjectTest("log-html-publication-link-task") { | ||
| buildGradleKts = """ | ||
| |plugins { | ||
| | kotlin("jvm") version "1.8.22" | ||
| | id("dev.adamko.dokkatoo") version "${DokkatooConstants.DOKKATOO_VERSION}" | ||
| |} | ||
| | | ||
| |dependencies { | ||
| | dokkatooPluginHtml( | ||
| | dokkatoo.versions.jetbrainsDokka.map { dokkaVersion -> | ||
| | "org.jetbrains.dokka:all-modules-page-plugin:${'$'}dokkaVersion" | ||
| | } | ||
| | ) | ||
| |} | ||
| | | ||
| |tasks.withType<dev.adamko.dokkatoo.tasks.LogHtmlPublicationLinkTask>().configureEach { | ||
| | serverUri.set(providers.gradleProperty("testServerUri")) | ||
| |} | ||
| """.trimMargin() | ||
|
|
||
| createKotlinFile( | ||
| "src/main/kotlin/Hello.kt", | ||
| """ | ||
| |package com.project.hello | ||
| | | ||
| |/** The Hello class */ | ||
| |class Hello { | ||
| | /** prints `Hello` to the console */ | ||
| | fun sayHello() = println("Hello") | ||
| |} | ||
| | | ||
| """.trimMargin() | ||
| ) | ||
|
|
||
| // remove the flag that disables the logging task, since this test wants the logger to run | ||
| defaultRunnerArgs.removeIf { ENABLE_TASK_PROPERTY_NAME in it } | ||
|
|
||
| config() | ||
| } | ||
| } |