Widget | Log Viewer - preview

.gitignore

@@ -14,9 +14,12 @@ Thumbs.db
 # Project specific
 /mnt/*.json
 /mnt/*.backup
+/mnt/widget*
 /mnt/content/*.json
 /mnt/.version
 /cogboard-compose.yml
+/mnt/mongo/*
+!/mnt/mongo/.gitkeep
 
 # Intellij           #
 ######################

api-mocks/__files/logViewer/logs.json

@@ -0,0 +1,11 @@
+{
+  "logLines": [
+    "02:49:12 127.0.0.1 GET / 200",
+    "02:49:35 127.0.0.1 GET /index.html 200",
+    "03:01:06 127.0.0.1 GET /images/sponsered.gif 304",
+    "03:52:36 127.0.0.1 GET /search.php 200",
+    "04:17:03 127.0.0.1 GET /admin/style.css 200",
+    "05:04:54 127.0.0.1 GET /favicon.ico 404",
+    "05:38:07 127.0.0.1 GET /js/ads.js 200"
+    ]
+}

api-mocks/mappings/endpoints-mapping.json

@@ -1,5 +1,23 @@
 {
   "mappings": [
+    {
+      "request": {
+        "method": "GET",
+        "url": "/log-viewer",
+        "queryParameters": {
+          "lines": {
+            "matches": "^[0-9]+$"
+          }
+        }
+      },
+      "response": {
+        "status": 200,
+        "headers": {
+          "Content-Type": "application/json"
+        },
+        "bodyFileName": "logViewer/logs.json"
+      }
+    },
     {
       "request": {
         "method": "GET",

build.gradle.kts

@@ -55,7 +55,7 @@ allprojects {
 
 tasks {
     named("build") {
-        dependsOn(":cogboard-app:test", ":cogboard-webapp:buildImage")
+        dependsOn(":cogboard-app:test", ":cogboard-webapp:buildImage", ":ssh:buildImage")
     }
     register("cypressInit", Exec::class) {
         setWorkingDir("./functional/cypress-tests")

cogboard-app/build.gradle.kts

@@ -1,45 +1,47 @@
-import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
-
-plugins {
-    kotlin("jvm")
-}
-
-tasks.named<Test>("test") {
-    useJUnitPlatform()
-}
-
-dependencies {
-
-    "io.knotx:knotx".let { v ->
-        implementation(platform("$v-dependencies:${project.property("knotx.version")}"))
-        implementation("$v-server-http-api:${project.property("knotx.version")}")
-    }
-    "io.vertx:vertx".let { v ->
-        implementation("$v-web")
-        implementation("$v-auth-jwt")
-        implementation("$v-web-client")
-        implementation("$v-rx-java2")
-    }
-    implementation("com.fasterxml.jackson.module:jackson-module-kotlin:2.10.0")
-    implementation(kotlin("stdlib-jdk8"))
-
-    testImplementation("org.assertj:assertj-core:3.12.2")
-    testImplementation("org.junit.jupiter:junit-jupiter-api:5.4.2")
-    testImplementation("org.junit.jupiter:junit-jupiter-params:5.3.1")
-    testImplementation("org.mockito:mockito-junit-jupiter:3.1.0")
-    testImplementation(gradleTestKit())
-    testRuntime("org.junit.jupiter:junit-jupiter-engine:5.4.2")
-}
-
-repositories {
-    mavenCentral()
-}
-
-val compileKotlin: KotlinCompile by tasks
-compileKotlin.kotlinOptions {
-    jvmTarget = "1.8"
-}
-val compileTestKotlin: KotlinCompile by tasks
-compileTestKotlin.kotlinOptions {
-    jvmTarget = "1.8"
+import org.jetbrains.kotlin.gradle.tasks.KotlinCompile
+
+plugins {
+    kotlin("jvm")
+}
+
+tasks.named<Test>("test") {
+    useJUnitPlatform()
+}
+
+dependencies {
+
+    "io.knotx:knotx".let { v ->
+        implementation(platform("$v-dependencies:${project.property("knotx.version")}"))
+        implementation("$v-server-http-api:${project.property("knotx.version")}")
+    }
+    "io.vertx:vertx".let { v ->
+        implementation("$v-web")
+        implementation("$v-auth-jwt")
+        implementation("$v-web-client")
+        implementation("$v-rx-java2")
+    }
+    implementation("com.fasterxml.jackson.module:jackson-module-kotlin:2.10.0")
+    implementation(kotlin("stdlib-jdk8"))
+    implementation("com.jcraft:jsch:0.1.55")
+    implementation("org.mongodb:mongo-java-driver:3.12.10")
+
+    testImplementation("org.assertj:assertj-core:3.12.2")
+    testImplementation("org.junit.jupiter:junit-jupiter-api:5.4.2")
+    testImplementation("org.junit.jupiter:junit-jupiter-params:5.3.1")
+    testImplementation("org.mockito:mockito-junit-jupiter:3.1.0")
+    testImplementation(gradleTestKit())
+    testRuntime("org.junit.jupiter:junit-jupiter-engine:5.4.2")
+}
+
+repositories {
+    mavenCentral()
+}
+
+val compileKotlin: KotlinCompile by tasks
+compileKotlin.kotlinOptions {
+    jvmTarget = "1.8"
+}
+val compileTestKotlin: KotlinCompile by tasks
+compileTestKotlin.kotlinOptions {
+    jvmTarget = "1.8"
 }

cogboard-app/src/main/kotlin/com/cognifide/cogboard/CogboardConstants.kt

@@ -38,7 +38,18 @@ class CogboardConstants {
             const val SCHEDULE_PERIOD = "schedulePeriod"
             const val SCHEDULE_PERIOD_DEFAULT = 120L // 120 seconds
             const val SCHEDULE_DELAY_DEFAULT = 10L // 10 seconds
+            const val SSH_TIMEOUT = 5000 // 5000ms -> 5s
+            const val SSH_HOST = "sshAddress"
+            const val SSH_PORT = "sshPort"
+            const val SSH_KEY = "sshKey"
+            const val SSH_KEY_PASSPHRASE = "sshKeyPassphrase"
             const val URL = "url"
+
+            const val LOG_REQUEST_TYPE = "logRequestType"
+            const val LOG_LINES = "logLinesField"
+            const val LOG_FILE_SIZE = "logFileSizeField"
+            const val LOG_EXPIRATION_DAYS = "logRecordExpirationField"
+            const val LOG_PARSER = "logParserField"
             const val REQUEST_ID = "requestId"
             const val PUBLIC_URL = "publicUrl"
             const val USER = "user"
@@ -78,6 +89,13 @@ class CogboardConstants {
         }
     }
 
+    class ConnectionType {
+        companion object {
+            const val SSH = "SSH"
+            const val HTTP = "HTTP"
+        }
+    }
+
     class RequestMethod {
         companion object {
             const val GET = "get"

cogboard-app/src/main/kotlin/com/cognifide/cogboard/config/EndpointLoader.kt

@@ -31,6 +31,8 @@ class EndpointLoader(
                 this.put(Props.USER, credentials.getString(Props.USER) ?: "")
                 this.put(Props.PASSWORD, credentials.getString(Props.PASSWORD) ?: "")
                 this.put(Props.TOKEN, credentials.getString(Props.TOKEN) ?: "")
+                this.put(Props.SSH_KEY, credentials.getString(Props.SSH_KEY) ?: "")
+                this.put(Props.SSH_KEY_PASSPHRASE, credentials.getString(Props.SSH_KEY_PASSPHRASE) ?: "")
             }
         }
         return this

cogboard-app/src/main/kotlin/com/cognifide/cogboard/config/controller/CredentialsController.kt

@@ -37,6 +37,8 @@ class CredentialsController : AbstractVerticle() {
 
     private fun JsonObject.filterSensitiveData(): JsonObject {
         this.remove(Props.PASSWORD)
+        this.remove(Props.SSH_KEY)
+        this.remove(Props.SSH_KEY_PASSPHRASE)
         return this
     }
 

cogboard-app/src/main/kotlin/com/cognifide/cogboard/config/model/Credential.kt

@@ -5,5 +5,7 @@ data class Credential(
     val label: String,
     val user: String,
     val password: String?,
-    val token: String?
+    val token: String?,
+    val sshKey: String?,
+    val sshKeyPassphrase: String?
 )

cogboard-app/src/main/kotlin/com/cognifide/cogboard/logStorage/LogController.kt

@@ -0,0 +1,63 @@
+package com.cognifide.cogboard.logStorage
+
+import com.cognifide.cogboard.CogboardConstants.Props
+import com.cognifide.cogboard.logStorage.model.Log
+import com.cognifide.cogboard.logStorage.model.asLog
+import com.cognifide.cogboard.storage.VolumeStorageFactory.boards
+import com.cognifide.cogboard.widget.type.logviewer.LogViewerWidget
+import com.mongodb.client.model.Sorts
+import io.knotx.server.api.handler.RoutingHandlerFactory
+import io.vertx.core.Handler
+import io.vertx.core.json.JsonArray
+import io.vertx.core.json.JsonObject
+import io.vertx.core.logging.Logger
+import io.vertx.core.logging.LoggerFactory
+import io.vertx.reactivex.core.Vertx
+import io.vertx.reactivex.ext.web.RoutingContext
+import java.time.Instant
+
+class LogController : RoutingHandlerFactory {
+
+    override fun getName(): String = "logs-handler"
+
+    override fun create(vertx: Vertx?, config: JsonObject?): Handler<RoutingContext> = Handler { context ->
+        context?.request()?.params()?.get("id")?.let { id ->
+            val logs = JsonArray(getLogs(id).map { it.toJson() })
+            context.response().end(logs.encode())
+        }
+    }
+
+    private fun getLogs(id: String): List<Log> {
+        val logLines = boards()
+                .loadConfig()
+                .getJsonObject(Props.WIDGETS)
+                .getJsonObject(Props.WIDGETS_BY_ID)
+                .getJsonObject(id)
+                .getInteger(Props.LOG_LINES)
+                ?: LogViewerWidget.DEFAULT_LOG_LINES.toInt()
+
+        return if (LOGGER.isDebugEnabled) {
+            val start = Instant.now()
+            val logs = fetchLogs(id, logLines)
+            val took = Instant.now().minusMillis(start.toEpochMilli()).toEpochMilli()
+            LOGGER.debug("DB query for $id took $took[ms] for getting $logLines (processed logs: ${logs.size})")
+            logs
+        } else {
+            fetchLogs(id, logLines)
+        }
+    }
+
+    private fun fetchLogs(id: String, logLines: Int): List<Log> {
+        return LogStorage.database
+                .getCollection(id)
+                .find()
+                .sort(Sorts.descending(Log.SEQ))
+                .limit(logLines)
+                .map { it.asLog() }
+                .sortedBy { it.seq }
+    }
+
+    companion object {
+        val LOGGER: Logger = LoggerFactory.getLogger(LogController::class.java)
+    }
+}