introduce debuggable flag (#24)

tarek360 · Jul 23, 2019 · 8845419 · 8845419
1 parent 8b127ea
commit 8845419
Show file tree

Hide file tree

Showing 11 changed files with 59 additions and 28 deletions.
diff --git a/app/src/main/java/io/github/tarek360/app/App.kt b/app/src/main/java/io/github/tarek360/app/App.kt
@@ -11,6 +11,7 @@ import io.github.tarek360.rules.core.Level.ERROR
 fun main(_args: Array<String>) {
 
     val configuration = koshry {
+        debuggable = true
 
         rules {
             rule = protectedFileRule {

diff --git a/core/src/main/java/io/github/tarek360/core/Logger.kt b/core/src/main/java/io/github/tarek360/core/Logger.kt
@@ -1,6 +1,6 @@
 package io.github.tarek360.core
 
-const val DEBUGGABLE = false
+var debuggableLogger = false
 
 val logger: Logger = Logger()
 
@@ -15,7 +15,7 @@ class Logger {
     }
 
     fun d(msg: () -> String?) {
-        if (DEBUGGABLE) {
+        if (debuggableLogger) {
             println("$ANSI_WHITE${msg()}$ANSI_RESET")
         }
     }

diff --git a/core/src/main/java/io/github/tarek360/core/cl/CommanderImpl.kt b/core/src/main/java/io/github/tarek360/core/cl/CommanderImpl.kt
@@ -5,19 +5,26 @@ import java.io.BufferedReader
 
 class CommanderImpl : Commander {
 
-  override fun executeCL(command: String): List<String> {
-    return execute(command)
-  }
+    override fun executeCL(command: String): List<String> {
+        return execute(command)
+    }
 
-  override fun executeSh(filePath: String) {
+    override fun executeSh(filePath: String) {
 
-  }
+    }
 
-  private fun execute(command: String): List<String> {
-    logger.d { "command executed: {$command}" }
-    val proc = Runtime.getRuntime().exec(command)
-    val lines = proc.inputStream.bufferedReader().use(BufferedReader::readLines)
-    proc.waitFor()
-    return lines
-  }
+    private fun execute(command: String): List<String> {
+        logger.d { "COMMAND EXECUTED: {$command}" }
+        val proc = Runtime.getRuntime().exec(command)
+        val lines = proc.inputStream.bufferedReader().use(BufferedReader::readLines)
+        proc.waitFor()
+        if (lines.isEmpty()) {
+            logger.e { "COMMAND {$command} HAS NO OUTPUT!" }
+        } else {
+            logger.d { "COMMAND OUTPUT LINES:" }
+            lines.forEach { logger.d { "- $it" } }
+            logger.d { "------------- OUTPUT END!\n" }
+        }
+        return lines
+    }
 }
diff --git a/githost/src/main/java/io/github/tarek360/githost/GitHost.kt b/githost/src/main/java/io/github/tarek360/githost/GitHost.kt
@@ -1,19 +1,25 @@
 package io.github.tarek360.githost
 
-interface GitHost {
+import io.github.tarek360.core.logger
+
+abstract class GitHost {
+
+  init {
+    logger.d { "GitHost name: ${this.javaClass.typeName}" }
+  }
 
   /**
    *@return Comment URL
    */
-  fun postComment(comment: Comment): String?
+  abstract fun postComment(comment: Comment): String?
 
-  fun updateComment(comment: Comment, commentId: Int): String?
+  abstract fun updateComment(comment: Comment, commentId: Int): String?
 
-  fun postStatus(status: Status)
+  abstract fun postStatus(status: Status)
 
-  fun pushFile(filePath: String, branchName: String, commitMsg: String)
+  abstract fun pushFile(filePath: String, branchName: String, commitMsg: String)
 
-  fun getPullRequestInfo(): PullRequest?
+  abstract fun getPullRequestInfo(): PullRequest?
 
-  fun getPullRequestComments(): List<GitHostComment>?
+  abstract fun getPullRequestComments(): List<GitHostComment>?
 }
diff --git a/githost/src/main/java/io/github/tarek360/githost/UnknownGitHost.kt b/githost/src/main/java/io/github/tarek360/githost/UnknownGitHost.kt
@@ -2,7 +2,11 @@ package io.github.tarek360.githost
 
 import io.github.tarek360.core.logger
 
-class UnknownGitHost : GitHost {
+class UnknownGitHost : GitHost() {
+
+    init {
+        logger.e { "Unknown GitHostType" }
+    }
 
     override fun postComment(comment: Comment): String? {
         logger.w { "Unknown GitHost: Koshry can't post the report" }

diff --git a/githost/src/main/java/io/github/tarek360/githost/github/GitHub.kt b/githost/src/main/java/io/github/tarek360/githost/github/GitHub.kt
@@ -12,7 +12,7 @@ import java.net.HttpURLConnection.HTTP_CREATED
 
 var baseUrl = ""
 
-class GitHub(private val gitHostInfo: GitHostInfo, isEnterprise: Boolean = false) : GitHost {
+class GitHub(private val gitHostInfo: GitHostInfo, isEnterprise: Boolean = false) : GitHost() {
 
     init {
         // if it's not mocked web server

diff --git a/githost/src/main/java/io/github/tarek360/githost/network/OkHttp.kt b/githost/src/main/java/io/github/tarek360/githost/network/OkHttp.kt
@@ -1,6 +1,6 @@
 package io.github.tarek360.githost.network
 
-import io.github.tarek360.core.DEBUGGABLE
+import io.github.tarek360.core.debuggableLogger
 import io.github.tarek360.core.logger
 import okhttp3.OkHttpClient
 import okhttp3.logging.HttpLoggingInterceptor
@@ -10,7 +10,7 @@ val okhttp: OkHttpClient by lazy {
     val logger = HttpLoggingInterceptor(HttpLoggingInterceptor.Logger { m -> logger.d { m } })
     logger.level = HttpLoggingInterceptor.Level.BASIC
     val okhttpBuilder = OkHttpClient.Builder()
-    if(DEBUGGABLE){
+    if(debuggableLogger){
         okhttpBuilder.addInterceptor(logger)
     }
     okhttpBuilder.build()

diff --git a/koshry/src/main/java/io/github/tarek360/koshry/Dsl.kt b/koshry/src/main/java/io/github/tarek360/koshry/Dsl.kt
@@ -1,5 +1,6 @@
 package io.github.tarek360.koshry
 
+import io.github.tarek360.core.debuggableLogger
 import io.github.tarek360.rules.core.Rule
 import io.github.tarek360.rules.core.RuleDsl
 
@@ -18,6 +19,12 @@ class KoshryBuilder {
     var baseSha = ""
     var headSha = ""
 
+    var debuggable = false
+        set(value) {
+            field = value
+            debuggableLogger = value
+        }
+
     private val rules = ArrayList<Rule>()
 
     fun rules(block: RULES.() -> Unit) {

diff --git a/koshry/src/main/java/io/github/tarek360/koshry/Koshry.kt b/koshry/src/main/java/io/github/tarek360/koshry/Koshry.kt
@@ -13,7 +13,7 @@ class Koshry {
             val runner = KoshryRunner()
             if (ci != null) {
                 logger.i { "${ci.javaClass.simpleName} is detected!" }
-                logger.i { "Koshry started running on ${ci.javaClass.simpleName}.." }
+                logger.i { "Koshry has started to run on ${ci.javaClass.simpleName}.." }
 
                 val gitHostInfo = GitHostInfoProvider(ci, CommanderImpl(), GitRemoteUrlParser()).provide()
 
@@ -23,7 +23,7 @@ class Koshry {
 
                 runner.runOnCi(ci, koshryConfig, gitHostInfo, gitHostController)
             } else {
-                logger.i { "Koshry started running locally.." }
+                logger.i { "Koshry has started to run locally.." }
                 runner.runLocally(koshryConfig)
             }
         }

diff --git a/koshry/src/main/java/io/github/tarek360/koshry/RulesMan.kt b/koshry/src/main/java/io/github/tarek360/koshry/RulesMan.kt
@@ -18,6 +18,10 @@ class RulesMan(
                    rules: List<Rule>)
             : Comment {
 
+        if (baseSha.isBlank() || headSha.isBlank()) {
+            return Comment("No SHA, No diff, No Report", true)
+        }
+
         var shouldFail = false
         val gitDiff = GitDiffProvider.provide(baseSha, headSha)
 

diff --git a/koshry/src/main/java/io/github/tarek360/koshry/git/GitHostInfoProvider.kt b/koshry/src/main/java/io/github/tarek360/koshry/git/GitHostInfoProvider.kt
@@ -29,9 +29,11 @@ open class GitHostInfoProvider(private val ci: Ci,
             logger.e { "Cant't find owner name and/or repo name in environment variables." }
         }
         if (token == null) {
-            logger.e { "Cant't 'KOSHRY_GIT_HOST_TOKEN' in environment variables." }
+            logger.e { "Cant't find 'KOSHRY_GIT_HOST_TOKEN' in environment variables." }
         }
 
+        logger.d { "pullRequestId $pullRequestId, ownerNameRepoName $ownerNameRepoName, token $token" }
+
         return GitHostInfo(
                 domain = gitRemoteOrigin?.domain,
                 ownerNameRepoName = ownerNameRepoName,