All Downloads are FREE. Search and download functionalities are using the official Maven repository.
Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
org.jetbrains.kotlin.gradle.targets.js.testing.karma.KotlinKarma.kt Maven / Gradle / Ivy
/*
* Copyright 2010-2019 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license
* that can be found in the license/LICENSE.txt file.
*/
package org.jetbrains.kotlin.gradle.targets.js.testing.karma
import com.google.gson.GsonBuilder
import jetbrains.buildServer.messages.serviceMessages.BaseTestSuiteMessage
import org.gradle.api.Project
import org.gradle.api.internal.tasks.testing.TestResultProcessor
import org.gradle.internal.logging.progress.ProgressLogger
import org.gradle.process.ProcessForkOptions
import org.jetbrains.kotlin.gradle.internal.operation
import org.jetbrains.kotlin.gradle.internal.testing.TCServiceMessagesClientSettings
import org.jetbrains.kotlin.gradle.internal.testing.TCServiceMessagesTestExecutionSpec
import org.jetbrains.kotlin.gradle.plugin.mpp.KotlinJsCompilation
import org.jetbrains.kotlin.gradle.targets.js.NpmPackageVersion
import org.jetbrains.kotlin.gradle.targets.js.RequiredKotlinJsDependency
import org.jetbrains.kotlin.gradle.targets.js.appendConfigsFromDir
import org.jetbrains.kotlin.gradle.targets.js.internal.parseNodeJsStackTraceAsJvm
import org.jetbrains.kotlin.gradle.targets.js.jsQuoted
import org.jetbrains.kotlin.gradle.targets.js.nodejs.NodeJsRootPlugin
import org.jetbrains.kotlin.gradle.targets.js.npm.npmProject
import org.jetbrains.kotlin.gradle.targets.js.testing.*
import org.jetbrains.kotlin.gradle.targets.js.webpack.KotlinWebpackConfig
import org.jetbrains.kotlin.gradle.testing.internal.reportsDir
import org.slf4j.Logger
import java.io.File
class KotlinKarma(override val compilation: KotlinJsCompilation) : KotlinJsTestFramework {
private val project: Project = compilation.target.project
private val nodeJs = NodeJsRootPlugin.apply(project.rootProject)
private val versions = nodeJs.versions
private val config: KarmaConfig = KarmaConfig()
private val requiredDependencies = mutableSetOf()
private val configurators = mutableListOf<(KotlinJsTest) -> Unit>()
private val envJsCollector = mutableMapOf()
private val confJsWriters = mutableListOf<(Appendable) -> Unit>()
private var sourceMaps = false
private var configDirectory: File? = project.projectDir.resolve("karma.config.d").takeIf { it.isDirectory }
override val requiredNpmDependencies: Collection
get() = requiredDependencies.toList()
override val settingsState: String
get() = "KotlinKarma($config)"
init {
requiredDependencies.add(versions.kotlinJsTestRunner)
requiredDependencies.add(versions.karma)
useKotlinReporter()
useMocha()
useWebpack()
useSourceMapSupport()
config.singleRun = true
config.autoWatch = false
}
private fun useKotlinReporter() {
config.reporters.add("karma-kotlin-reporter")
confJsWriters.add {
//language=ES6
it.appendln(
"""
config.plugins = config.plugins || [];
config.plugins.push('karma-*'); // default
config.plugins.push('kotlin-test-js-runner/karma-kotlin-reporter.js');
""".trimIndent()
)
}
}
internal fun watch() {
config.singleRun = false
config.autoWatch = true
}
fun useConfigDirectory(dir: String) = useConfigDirectory(File(dir))
fun useConfigDirectory(dir: File) {
configDirectory = dir
}
fun useChrome() {
useBrowser(
id = "Chrome",
dependency = versions.karmaChromeLauncher
)
}
fun useChromeCanary() {
useBrowser(
id = "ChromeCanary",
dependency = versions.karmaChromeLauncher
)
}
fun useChromeHeadless() {
useBrowser(
id = "ChromeHeadless",
dependency = versions.karmaChromeLauncher
)
}
fun usePhantomJS() = useBrowser("PhantomJS", versions.karmaPhantomJsLauncher)
fun useFirefox() = useBrowser("Firefox", versions.karmaFirefoxLauncher)
fun useOpera() = useBrowser("Opera", versions.karmaOperaLauncher)
fun useSafari() = useBrowser("Safari", versions.karmaSafariLauncher)
fun useIe() = useBrowser("IE", versions.karmaIeLauncher)
private fun useBrowser(id: String, dependency: NpmPackageVersion) {
config.browsers.add(id)
requiredDependencies.add(dependency)
}
private fun useMocha() {
requiredDependencies.add(versions.karmaMocha)
requiredDependencies.add(versions.mocha)
config.frameworks.add("mocha")
}
private fun useWebpack() {
createAdapterJs()
requiredDependencies.add(versions.karmaWebpack)
requiredDependencies.add(versions.webpack)
val webpackConfigWriter = KotlinWebpackConfig(
configDirectory = project.projectDir.resolve("webpack.config.d").takeIf { it.isDirectory },
sourceMaps = true,
devtool = null,
export = false,
progressReporter = true,
progressReporterPathFilter = nodeJs.rootPackageDir.absolutePath
)
requiredDependencies.addAll(webpackConfigWriter.getRequiredDependencies(versions))
addPreprocessor("webpack")
confJsWriters.add {
it.appendln()
it.appendln("// webpack config")
it.appendln("function createWebpackConfig() {")
webpackConfigWriter.appendTo(it)
//language=ES6
it.appendln(
"""
// noinspection JSUnnecessarySemicolon
;(function(config) {
const webpack = require('webpack');
config.plugins.push(new webpack.SourceMapDevToolPlugin({
moduleFilenameTemplate: "[absolute-resource-path]"
}))
})(config);
""".trimIndent()
)
it.appendln(" return config;")
it.appendln("}")
it.appendln()
it.appendln("config.set({webpack: createWebpackConfig()});")
it.appendln()
}
requiredDependencies.add(versions.webpack)
requiredDependencies.add(versions.webpackCli)
requiredDependencies.add(versions.kotlinSourceMapLoader)
requiredDependencies.add(versions.sourceMapSupport)
}
fun useCoverage(
html: Boolean = true,
lcov: Boolean = true,
cobertura: Boolean = false,
teamcity: Boolean = true,
text: Boolean = false,
textSummary: Boolean = false,
json: Boolean = false,
jsonSummary: Boolean = false
) {
if (listOf(
html, lcov, cobertura,
teamcity, text, textSummary,
json, jsonSummary
).all { !it }
) return
requiredDependencies.add(versions.karmaCoverage)
config.reporters.add("coverage")
addPreprocessor("coverage") { !it.endsWith("_test.js") }
configurators.add {
val reportDir = project.reportsDir.resolve("coverage/${it.name}")
reportDir.mkdirs()
config.coverageReporter = CoverageReporter(reportDir.canonicalPath).also { coverage ->
if (html) coverage.reporters.add(Reporter("html"))
if (lcov) coverage.reporters.add(Reporter("lcovonly"))
if (cobertura) coverage.reporters.add(Reporter("cobertura"))
if (teamcity) coverage.reporters.add(Reporter("teamcity"))
if (text) coverage.reporters.add(Reporter("text"))
if (textSummary) coverage.reporters.add(Reporter("text-summary"))
if (json) coverage.reporters.add(Reporter("json"))
if (jsonSummary) coverage.reporters.add(Reporter("json-summary"))
}
}
}
fun useSourceMapSupport() {
requiredDependencies.add(versions.karmaSourceMapLoader)
sourceMaps = true
addPreprocessor("sourcemap")
}
private fun addPreprocessor(name: String, predicate: (String) -> Boolean = { true }) {
configurators.add {
config.files.forEach {
if (predicate(it)) {
config.preprocessors.getOrPut(it) { mutableListOf() }.add(name)
}
}
}
}
private fun createAdapterJs() {
configurators.add {
val npmProject = compilation.npmProject
val file = it.nodeModulesToLoad
.map { npmProject.require(it) }
.single()
val adapterJs = npmProject.dir.resolve("adapter-browser.js")
adapterJs.printWriter().use { writer ->
val karmaRunner = npmProject.require("kotlin-test-js-runner/kotlin-test-karma-runner.js")
writer.println("require(${karmaRunner.jsQuoted()})")
writer.println("module.exports = require(${file.jsQuoted()})")
}
config.files.add(adapterJs.canonicalPath)
}
}
override fun createTestExecutionSpec(
task: KotlinJsTest,
forkOptions: ProcessForkOptions,
nodeJsArgs: MutableList
): TCServiceMessagesTestExecutionSpec {
if (config.browsers.isEmpty()) {
error("No browsers configured for $task")
}
val clientSettings = TCServiceMessagesClientSettings(
task.name,
testNameSuffix = task.targetName,
prependSuiteName = true,
stackTraceParser = ::parseNodeJsStackTraceAsJvm,
ignoreOutOfRootNodes = true
)
val npmProject = compilation.npmProject
config.basePath = npmProject.nodeModulesDir.absolutePath
configurators.forEach {
it(task)
}
val cliArgs = KotlinTestRunnerCliArgs(
include = task.includePatterns,
exclude = task.excludePatterns
)
config.client.args.addAll(cliArgs.toList())
val karmaConfJs = npmProject.dir.resolve("karma.conf.js")
karmaConfJs.printWriter().use { confWriter ->
confWriter.println("// environment variables")
envJsCollector.forEach { (envVar, value) ->
//language=JavaScript 1.8
confWriter.println("process.env.$envVar = $value")
}
confWriter.println()
confWriter.println("module.exports = function(config) {")
confWriter.println()
confWriter.print("config.set(")
GsonBuilder().setPrettyPrinting().create().toJson(config, confWriter)
confWriter.println(");")
confJsWriters.forEach { it(confWriter) }
confWriter.appendFromConfigDir()
confWriter.println()
confWriter.println("}")
}
val nodeModules = listOf("karma/bin/karma")
val args = nodeJsArgs +
nodeModules.map { npmProject.require(it) } +
listOf("start", karmaConfJs.absolutePath)
return object : JSServiceMessagesTestExecutionSpec(
forkOptions,
args,
true,
clientSettings
) {
lateinit var progressLogger: ProgressLogger
override fun wrapExecute(body: () -> Unit) {
project.operation("Running and building tests with karma and webpack") {
progressLogger = this
body()
}
}
override fun createClient(testResultProcessor: TestResultProcessor, log: Logger) =
object : JSServiceMessagesClient(
testResultProcessor,
clientSettings,
log,
suppressedOutput
) {
val baseTestNameSuffix get() = settings.testNameSuffix
override var testNameSuffix: String? = baseTestNameSuffix
override fun printNonTestOutput(text: String) {
val value = text.trimEnd()
progressLogger.progress(value)
super.printNonTestOutput(text)
}
override fun processStackTrace(stackTrace: String): String =
processKarmaStackTrace(stackTrace)
override fun getSuiteName(message: BaseTestSuiteMessage): String {
val src = message.suiteName.trim()
// example: "sample.a DeepPackageTest Inner.HeadlessChrome 74.0.3729 (Mac OS X 10.14.4)"
// should be reported as "sample.a.DeepPackageTest.Inner[js,browser,HeadlessChrome74.0.3729,MacOSX10.14.4]"
// lets parse it from the end:
val os = src.substringAfterLast("(") // Mac OS X 10.14.4)
.removeSuffix(")") // Mac OS X 10.14.4
.replace(" ", "") // MacOSX10.14.4
val withoutOs = src.substringBeforeLast(" (") // sample.a DeepPackageTest Inner.HeadlessChrome 74.0.3729
val rawSuiteNameOnly = withoutOs
.substringBeforeLast(" ") // sample.a DeepPackageTest Inner.HeadlessChrome
.substringBeforeLast(".") // sample.a DeepPackageTest Inner
val browser = withoutOs.substring(rawSuiteNameOnly.length + 1) // HeadlessChrome 74.0.3729
.replace(" ", "") // HeadlessChrome74.0.3729
testNameSuffix = listOfNotNull(baseTestNameSuffix, browser, os)
.takeIf { it.isNotEmpty() }
?.joinToString()
return rawSuiteNameOnly.replace(" ", ".") // sample.a.DeepPackageTest.Inner
}
}
}
}
private fun Appendable.appendFromConfigDir() {
val configDirectory = configDirectory ?: return
check(configDirectory.isDirectory) {
"\"$configDirectory\" is not a directory"
}
appendln()
appendConfigsFromDir(configDirectory)
appendln()
}
companion object {
const val CHROME_BIN = "CHROME_BIN"
const val CHROME_CANARY_BIN = "CHROME_CANARY_BIN"
}
}
