Merge pull request #1 from Cognifide/base-impl

Base implementation

Author: Krystian Panek

README.md

@@ -68,10 +68,17 @@ When using argument `--config-path` then it is also needed to have at least file
 Use command, to run Lighthouse CI by using:
 
 * default suite and its base URL: `sh gradlew lighthouseRun`,
-* only desired suite by name: `sh gradlew lighthouseRun -Plighthouse.suite=site.demo` (if suite by base URL not found, suite named `default` will be used),
+* only desired suite by name: `sh gradlew lighthouseRun -Plighthouse.suite=site.demo` (if suite by name not found, suite named `default` will be used),
 * only desired suite by base URL: `sh gradlew lighthouseRun -Plighthouse.baseUrl=http://example.com`,
 * any suite with any base URL: `sh gradlew lighthouseRun -Plighthouse.baseUrl=http://any-host.com -Plighthouse.suite=site.live` (base URL defined in suite will be overridden).
 
+Note that after running one of above commands first time, new files might be generated:
+
+* *package.json*
+* *yarn.lock*
+
+This is indented behavior - __remember to save these files in VCS__.
+
 ## Building
 
 1. Clone this project using command `git clone https://github.com/Cognifide/gradle-lighthouse-plugin.git`

build.gradle.kts

@@ -4,13 +4,21 @@ plugins {
     id("org.jetbrains.kotlin.jvm")
 }
 
+defaultTasks("build", "publishToMavenLocal")
+group = "com.cognifide.gradle"
+
 repositories {
     jcenter()
+    gradlePluginPortal()
 }
 
 dependencies {
     implementation(platform("org.jetbrains.kotlin:kotlin-bom:${properties["kotlin.version"]}"))
     implementation("org.jetbrains.kotlin:kotlin-stdlib-jdk8")
+    implementation("com.fasterxml.jackson.module:jackson-module-kotlin:2.8.8")
+    implementation("commons-io:commons-io:2.6")
+    implementation("com.github.node-gradle:gradle-node-plugin:2.1.1")
+
     testImplementation("org.jetbrains.kotlin:kotlin-test")
     testImplementation("org.jetbrains.kotlin:kotlin-test-junit")
 }

gradle.properties

@@ -1 +1,2 @@
+version=1.0.0
 kotlin.version=1.3.50

settings.gradle.kts

@@ -4,4 +4,4 @@ pluginManagement {
     }
 }
 
-rootProject.name = "gradle-lighthouse-plugin"
+rootProject.name = "lighthouse-plugin"

src/main/kotlin/com/cognifide/gradle/lighthouse/LighthouseException.kt

@@ -0,0 +1,6 @@
+package com.cognifide.gradle.lighthouse
+
+class LighthouseException : Exception {
+
+    constructor(message: String): super(message)
+}

src/main/kotlin/com/cognifide/gradle/lighthouse/LighthouseExtension.kt

@@ -0,0 +1,31 @@
+package com.cognifide.gradle.lighthouse
+
+import com.cognifide.gradle.lighthouse.config.Config
+import com.cognifide.gradle.lighthouse.runner.Runner
+import com.cognifide.gradle.lighthouse.runner.RunUnit
+import org.gradle.api.Project
+import java.io.File
+import com.cognifide.gradle.lighthouse.Utils.prop
+
+class LighthouseExtension(val project: Project) {
+
+    var configFile = project.file(project.prop("lighthouse.configFile") ?: "lighthouse/suites.json")
+
+    val config get() = Config.from(configFile)
+
+    var suiteName = project.prop("lighthouse.suite")
+
+    var baseUrl = project.prop("lighthouse.baseUrl")
+
+    var reportFileRule: (RunUnit) -> File = {
+        project.file("build/lighthouse/${it.suite.name}/${it.url.substringAfter("://").replace("/", "_")}")
+    }
+
+    var workingDir = project.file(project.prop("lighthouse.workingDir") ?: "build/lighthouse")
+
+    fun <T> runner(consumer: Runner.() -> T) = Runner(this).run(consumer)
+
+    companion object {
+        fun get(project: Project) = project.extensions.getByType(LighthouseExtension::class.java)
+    }
+}

src/main/kotlin/com/cognifide/gradle/lighthouse/LighthousePlugin.kt

@@ -1,15 +1,44 @@
 package com.cognifide.gradle.lighthouse
 
-import org.gradle.api.Project
+import com.cognifide.gradle.lighthouse.tasks.LighthouseRun
+import com.moowork.gradle.node.NodeExtension
+import com.moowork.gradle.node.yarn.YarnInstallTask
 import org.gradle.api.Plugin
+import org.gradle.api.Project
+import java.io.File
 
 open class LighthousePlugin: Plugin<Project> {
 
     override fun apply(project: Project) {
-        project.tasks.register("lighthouseRun") { task ->
-            task.doLast {
-                println("Hello from plugin 'com.cognifide.lighthouse'")
+        project.plugins.apply("com.github.node-gradle.node")
+
+        val node = NodeExtension.get(project)
+
+        node.apply {
+            version = "10.16.3"
+            yarnVersion = "1.19.0"
+            download = true
+        }
+
+        val yarnInstall = project.tasks.named(YarnInstallTask.NAME, YarnInstallTask::class.java) {
+            File(node.nodeModulesDir, "package.json").apply {
+                if (!exists()) {
+                    writeText("""
+                        {
+                          "license": "UNLICENSED",
+                          "devDependencies": {
+                            "lighthouse-ci": "^1.10.0"
+                          }
+                        }
+                    """.trimIndent())
+                }
             }
         }
+
+        project.extensions.add("lighthouse", LighthouseExtension(project))
+
+        project.tasks.register("lighthouseRun", LighthouseRun::class.java) {
+            it.dependsOn(yarnInstall)
+        }
     }
 }

src/main/kotlin/com/cognifide/gradle/lighthouse/Utils.kt

@@ -0,0 +1,22 @@
+package com.cognifide.gradle.lighthouse
+
+import com.fasterxml.jackson.databind.ObjectMapper
+import org.apache.commons.io.FilenameUtils
+import org.gradle.api.Project
+
+object Utils {
+
+    fun Project.prop(name: String) = findProperty(name) as String?
+
+    fun <T> fromJson(json: String, clazz: Class<T>): T {
+        return ObjectMapper().readValue(json, clazz)
+    }
+
+    fun wildcardMatch(value: String?, matcher: String?): Boolean {
+        if (matcher.isNullOrBlank()) {
+            return false
+        }
+
+        return matcher.split(",").any { FilenameUtils.wildcardMatch(value.orEmpty(), it) }
+    }
+}

src/main/kotlin/com/cognifide/gradle/lighthouse/config/Config.kt

@@ -0,0 +1,22 @@
+package com.cognifide.gradle.lighthouse.config
+
+import com.cognifide.gradle.lighthouse.LighthouseException
+import com.cognifide.gradle.lighthouse.Utils
+import java.io.File
+
+class Config {
+
+    var suites: List<Suite> = listOf()
+
+    companion object {
+
+        fun from(file: File) = file.run {
+            if (!exists()) {
+                throw LighthouseException("Lighthouse configuration file does not exists: $file!")
+            }
+
+            Utils.fromJson(readText(), Config::class.java)
+        }
+    }
+}
+

src/main/kotlin/com/cognifide/gradle/lighthouse/config/Suite.kt

@@ -0,0 +1,12 @@
+package com.cognifide.gradle.lighthouse.config
+
+class Suite {
+
+    lateinit var name: String
+
+    var baseUrl: String? = null
+
+    var paths: List<String> = listOf()
+
+    var args: List<String> = listOf()
+}