refactor: #195 verbose and porcelain are a cli feature and not in core

+ add option trace
4sh · Feb 7, 2023 · aadfef6 · aadfef6
1 parent 3a3d7cd
commit aadfef6
Show file tree

Hide file tree

Showing 47 changed files with 497 additions and 426 deletions.
diff --git a/modules/cli/src/main/kotlin/datamaintain/cli/app/DatamaintainCliCommand.kt b/modules/cli/src/main/kotlin/datamaintain/cli/app/DatamaintainCliCommand.kt
@@ -2,8 +2,7 @@ package datamaintain.cli.app
 
 import com.github.ajalt.clikt.core.CliktCommand
 import com.github.ajalt.clikt.core.findObject
-import datamaintain.cli.app.utils.CliSpecificKey
-import datamaintain.cli.app.utils.loadConfig
+import datamaintain.cli.app.utils.*
 import datamaintain.core.config.DatamaintainConfig
 import datamaintain.core.exception.DatamaintainBaseException
 import java.util.*
@@ -17,10 +16,24 @@ abstract class DatamaintainCliCommand(name: String, help: String = "") : CliktCo
             overloadProps(props)
             val config = loadConfig(props)
 
-            if (props.getProperty(CliSpecificKey.__PRINT_CONFIG_ONLY.key, CliSpecificKey.__PRINT_CONFIG_ONLY.default)!!.toBoolean()) {
+            val isPrintConfigOnly = props.getBooleanCliProperty(CliSpecificKey.__PRINT_CONFIG_ONLY)
+            if (isPrintConfigOnly) {
+                // config log nothing in INFO level so apply DEBUG level
+                applyLoggerLevel(CliDatamaintainLoggerLevel.VERBOSE)
                 config.log()
             } else {
-                executeCommand(config)
+                val level = if (props.getBooleanCliProperty(CliSpecificKey.TRACE)) {
+                    CliDatamaintainLoggerLevel.TRACE
+                } else if (props.getBooleanCliProperty(CliSpecificKey.VERBOSE)) {
+                    CliDatamaintainLoggerLevel.VERBOSE
+                } else if (props.getBooleanCliProperty(CliSpecificKey.PORCELAIN)) {
+                    CliDatamaintainLoggerLevel.PORCELAIN
+                } else {
+                    CliDatamaintainLoggerLevel.INFO
+                }
+                applyLoggerLevel(level)
+
+                executeCommand(config, level == CliDatamaintainLoggerLevel.PORCELAIN)
             }
         } catch (e: DatamaintainBaseException) {
             echo(e.message, err = true)
@@ -37,5 +50,5 @@ abstract class DatamaintainCliCommand(name: String, help: String = "") : CliktCo
 
     protected abstract fun overloadProps(props: Properties)
 
-    protected abstract fun executeCommand(config: DatamaintainConfig)
+    protected abstract fun executeCommand(config: DatamaintainConfig, porcelain: Boolean)
 }
diff --git a/modules/cli/src/main/kotlin/datamaintain/cli/app/ListExecutedScripts.kt b/modules/cli/src/main/kotlin/datamaintain/cli/app/ListExecutedScripts.kt
@@ -10,9 +10,9 @@ class ListExecutedScripts : DatamaintainCliCommand(name = "list") {
 
     }
 
-    override fun executeCommand(config: DatamaintainConfig) {
+    override fun executeCommand(config: DatamaintainConfig, porcelain: Boolean) {
         Datamaintain(config).listExecutedScripts().forEach {
-            logger.info { "${it.name} (${it.checksum})" }
+            echo("${it.name} (${it.checksum})")
         }
     }
 }
diff --git a/modules/cli/src/main/kotlin/datamaintain/cli/app/update/db/DatamaintainCliUpdateDbCommand.kt b/modules/cli/src/main/kotlin/datamaintain/cli/app/update/db/DatamaintainCliUpdateDbCommand.kt
@@ -1,29 +1,35 @@
 package datamaintain.cli.app.update.db
 
+import com.github.ajalt.clikt.output.TermUi.echo
 import datamaintain.cli.app.DatamaintainCliCommand
 import datamaintain.core.Datamaintain
 import datamaintain.core.config.DatamaintainConfig
 import datamaintain.core.exception.DatamaintainException
 import kotlin.system.exitProcess
 
-fun defaultUpdateDbRunner(config: DatamaintainConfig) {
-    Datamaintain(config).updateDatabase().print(config.logs.verbose, porcelain = config.logs.porcelain)
+fun defaultUpdateDbRunner(config: DatamaintainConfig, porcelain: Boolean) {
+    val report = Datamaintain(config).updateDatabase()
+
+    if (porcelain) {
+        report.executedScripts.asSequence()
+            .map { it.name }
+            .forEach { echo(it) }  // Use echo because logger level is ERROR
+    } else {
+        report.print()
+    }
 }
 
 abstract class DatamaintainCliUpdateDbCommand(
     name: String,
-    val runner: (DatamaintainConfig) -> Unit,
+    val runner: (DatamaintainConfig, Boolean) -> Unit,
     help: String = ""
 ): DatamaintainCliCommand(name, help) {
-    override fun executeCommand(config: DatamaintainConfig) {
+    override fun executeCommand(config: DatamaintainConfig, porcelain: Boolean) {
         try {
-            runner(config)
+            runner(config, porcelain)
         } catch (e: DatamaintainException) {
-            val verbose: Boolean = config.logs.verbose
-            val porcelain: Boolean = config.logs.porcelain
-
             echo("Error at step ${e.step}", err = true)
-            e.report.print(verbose, porcelain = porcelain)
+            e.report.print()
             echo("")
             echo(e.message, err = true)
 

diff --git a/modules/cli/src/main/kotlin/datamaintain/cli/app/update/db/MarkOneScriptAsExecuted.kt b/modules/cli/src/main/kotlin/datamaintain/cli/app/update/db/MarkOneScriptAsExecuted.kt
@@ -1,14 +1,14 @@
 package datamaintain.cli.app.update.db
 
 import com.github.ajalt.clikt.parameters.options.flag
-import com.github.ajalt.clikt.parameters.options.option
+import datamaintain.cli.app.utils.CliSpecificKey
 import datamaintain.cli.app.utils.detailedOption
 import datamaintain.core.config.CoreConfigKey
 import datamaintain.core.config.DatamaintainConfig
 import datamaintain.core.script.ScriptAction
 import java.util.*
 
-class MarkOneScriptAsExecuted(runner: (DatamaintainConfig) -> Unit = ::defaultUpdateDbRunner) :
+class MarkOneScriptAsExecuted(runner: (DatamaintainConfig, Boolean) -> Unit = ::defaultUpdateDbRunner) :
     DatamaintainCliUpdateDbCommand(
         name = "mark-script-as-executed",
         runner = runner,
@@ -20,16 +20,22 @@ class MarkOneScriptAsExecuted(runner: (DatamaintainConfig) -> Unit = ::defaultUp
         defaultValue = CoreConfigKey.SCAN_PATH.default
     )
 
-    private val verbose: Boolean? by detailedOption(
+    private val verbose: Boolean? by detailedOption("--verbose", "-v",
         help = "verbose",
-        defaultValue = CoreConfigKey.VERBOSE.default
+        defaultValue = CliSpecificKey.VERBOSE.default
+    ).flag()
+
+    private val trace: Boolean? by detailedOption("-vv",
+        help = "trace is more verbose than verbose",
+        defaultValue = CliSpecificKey.VERBOSE.default
     ).flag()
 
     override fun overloadProps(props: Properties) {
         props[CoreConfigKey.DEFAULT_SCRIPT_ACTION.key] = ScriptAction.MARK_AS_EXECUTED.name
 
         // Overload from arguments
         path?.let { props.put(CoreConfigKey.SCAN_PATH.key, it) }
-        verbose?.let { props.put(CoreConfigKey.VERBOSE.key, it.toString()) }
+        verbose?.let { props.put(CliSpecificKey.VERBOSE.key, it.toString()) }
+        trace?.let { props.put(CliSpecificKey.TRACE.key, it.toString()) }
     }
-}
+}
diff --git a/modules/cli/src/main/kotlin/datamaintain/cli/app/update/db/UpdateDb.kt b/modules/cli/src/main/kotlin/datamaintain/cli/app/update/db/UpdateDb.kt
@@ -5,6 +5,7 @@ import com.github.ajalt.clikt.parameters.options.flag
 import com.github.ajalt.clikt.parameters.options.multiple
 import com.github.ajalt.clikt.parameters.options.option
 import com.github.ajalt.clikt.parameters.types.choice
+import datamaintain.cli.app.utils.CliSpecificKey
 import datamaintain.cli.app.utils.detailedOption
 import datamaintain.core.config.CoreConfigKey
 import datamaintain.core.config.DatamaintainConfig
@@ -16,7 +17,7 @@ import datamaintain.db.driver.mongo.MongoConfigKey
 import datamaintain.db.driver.mongo.MongoShell
 import java.util.*
 
-class UpdateDb(runner: (DatamaintainConfig) -> Unit = ::defaultUpdateDbRunner) : DatamaintainCliUpdateDbCommand(
+class UpdateDb(runner: (DatamaintainConfig, Boolean) -> Unit = ::defaultUpdateDbRunner) : DatamaintainCliUpdateDbCommand(
     name = "update-db",
     runner = runner
 ) {
@@ -67,9 +68,14 @@ class UpdateDb(runner: (DatamaintainConfig) -> Unit = ::defaultUpdateDbRunner) :
         defaultValue = CoreConfigKey.PRUNE_OVERRIDE_UPDATED_SCRIPTS.default
     ).flag()
 
-    private val verbose: Boolean? by detailedOption(
+    private val verbose: Boolean? by detailedOption("--verbose", "-v",
         help = "verbose",
-        defaultValue = CoreConfigKey.VERBOSE.default
+        defaultValue = CliSpecificKey.VERBOSE.default
+    ).flag()
+
+    private val trace: Boolean? by detailedOption("-vv",
+        help = "trace is more verbose than verbose",
+        defaultValue = CliSpecificKey.VERBOSE.default
     ).flag()
 
     private val saveDbOutput: Boolean? by detailedOption(
@@ -112,7 +118,7 @@ class UpdateDb(runner: (DatamaintainConfig) -> Unit = ::defaultUpdateDbRunner) :
 
     private val porcelain: Boolean? by detailedOption(
         help = "for each executed script, display relative path to scan path",
-        defaultValue = CoreConfigKey.PRINT_RELATIVE_PATH_OF_SCRIPT.default
+        defaultValue = CliSpecificKey.PORCELAIN.default
     ).flag()
 
     private val flags: List<String>? by option(help = "add a flag on the executed scripts. " +
@@ -126,7 +132,8 @@ class UpdateDb(runner: (DatamaintainConfig) -> Unit = ::defaultUpdateDbRunner) :
         blacklistedTags?.let { props.put(CoreConfigKey.TAGS_BLACKLISTED.key, it) }
         tagsToPlayAgain?.let { props.put(CoreConfigKey.PRUNE_TAGS_TO_RUN_AGAIN.key, it) }
         createTagsFromFolder?.let { props.put(CoreConfigKey.CREATE_TAGS_FROM_FOLDER.key, it.toString()) }
-        verbose?.let { props.put(CoreConfigKey.VERBOSE.key, it.toString()) }
+        verbose?.let { props.put(CliSpecificKey.VERBOSE.key, it.toString()) }
+        trace?.let { props.put(CliSpecificKey.TRACE.key, it.toString()) }
         saveDbOutput?.let { props.put(DriverConfigKey.DB_SAVE_OUTPUT.key, it.toString()) }
         printDbOutput?.let { props.put(DriverConfigKey.DB_PRINT_OUTPUT.key, it.toString()) }
         executionMode?.let { props.put(CoreConfigKey.EXECUTION_MODE.key, it) }
@@ -136,7 +143,7 @@ class UpdateDb(runner: (DatamaintainConfig) -> Unit = ::defaultUpdateDbRunner) :
         }
         checkRules?.let { props.put(CoreConfigKey.CHECK_RULES.key, it.optionListToString()) }
         allowAutoOverride?.let { props.put(CoreConfigKey.PRUNE_OVERRIDE_UPDATED_SCRIPTS.key, it.toString()) }
-        porcelain?.let { props.put(CoreConfigKey.PRINT_RELATIVE_PATH_OF_SCRIPT.key, it.toString()) }
+        porcelain?.let { props.put(CliSpecificKey.PORCELAIN.key, it.toString()) }
         mongoShell?.let { props.put(MongoConfigKey.DB_MONGO_SHELL.key, it.toUpperCase()) }
         flags?.let { props.put(CoreConfigKey.FLAGS.key, it.optionListToString()) }
     }

diff --git a/modules/cli/src/main/kotlin/datamaintain/cli/app/utils/CliLogger.kt b/modules/cli/src/main/kotlin/datamaintain/cli/app/utils/CliLogger.kt
@@ -0,0 +1,36 @@
+package datamaintain.cli.app.utils
+
+import ch.qos.logback.classic.Level
+import ch.qos.logback.classic.LoggerContext
+import org.slf4j.LoggerFactory
+
+/**
+ * Translate cli level to logback level and set that level on datamaintain loggers
+ */
+fun applyLoggerLevel(level: CliDatamaintainLoggerLevel) {
+    val context = LoggerFactory.getILoggerFactory() as LoggerContext
+    val datamaintainLogger = context.getLogger("datamaintain")
+
+    when(level) {
+        CliDatamaintainLoggerLevel.INFO -> datamaintainLogger.level = Level.INFO
+        CliDatamaintainLoggerLevel.VERBOSE -> datamaintainLogger.level = Level.DEBUG
+        CliDatamaintainLoggerLevel.TRACE -> datamaintainLogger.level = Level.TRACE
+        CliDatamaintainLoggerLevel.PORCELAIN -> datamaintainLogger.level = Level.ERROR
+        else -> error("Cannot set log level of $level")
+    }
+}
+
+enum class CliDatamaintainLoggerLevel {
+    // normal log level
+    INFO,
+
+    // debug log level
+    VERBOSE,
+
+    // trace log level
+    TRACE,
+
+    // special mode for cli, the datamaintain logs are disabled (except error) and specific logs are print.
+    // This is use for scripts that may need to parse datamaintain logs (e.g: for take in account execution results)
+    PORCELAIN
+}
diff --git a/modules/cli/src/main/kotlin/datamaintain/cli/app/utils/CliSpecificKey.kt b/modules/cli/src/main/kotlin/datamaintain/cli/app/utils/CliSpecificKey.kt
@@ -1,5 +1,7 @@
 package datamaintain.cli.app.utils
 
+import java.util.Properties
+
 /**
  * An enum used to define specific keys that can be used by commands for internal behaviour
  */
@@ -9,5 +11,13 @@ enum class CliSpecificKey(
 ) {
     // Each commands need to manage that in order to only print the effective configuration (so not execute the action)
     __PRINT_CONFIG_ONLY("__PRINT_CONFIG_ONLY", "false"),
-    VERSION("version", "dev")
+    VERSION("version", "dev"),
+    VERBOSE("verbose", "false"),
+    TRACE("trace", "false"),
+    PORCELAIN("porcelain", "false"),
 }
+
+fun Properties.getCliProperty(cliKey: CliSpecificKey) = this.getProperty(cliKey.key, cliKey.default)!!
+
+fun Properties.getBooleanCliProperty(cliKey: CliSpecificKey) = this.getCliProperty(cliKey).toBoolean()
+
diff --git a/...n/datamaintain/core/util/PorcelainUtil.kt → ...tamaintain/cli/app/utils/PorcelainUtil.kt b/...n/datamaintain/core/util/PorcelainUtil.kt → ...tamaintain/cli/app/utils/PorcelainUtil.kt
@@ -1,4 +1,4 @@
-package datamaintain.core.util
+package datamaintain.cli.app.utils
 
 import java.nio.file.Path
 

diff --git a/modules/cli/src/test/kotlin/datamaintain/cli/app/BaseCliTest.kt b/modules/cli/src/test/kotlin/datamaintain/cli/app/BaseCliTest.kt
@@ -10,7 +10,7 @@ open class BaseCliTest {
 
     protected val configWrapper = ConfigWrapper()
 
-    private fun runner(config: DatamaintainConfig) {
+    private fun runner(config: DatamaintainConfig, porcelain: Boolean) {
         configWrapper.datamaintainConfig = config
     }
 

diff --git a/modules/cli/src/test/kotlin/datamaintain/cli/app/PrintConfigTest.kt b/modules/cli/src/test/kotlin/datamaintain/cli/app/PrintConfigTest.kt
@@ -19,7 +19,7 @@ internal class PrintConfigTest : BaseCliTest() {
     }
 
     @Test
-    fun `should print config when command is mark-script-as-exectued`() {
+    fun `should print config when command is mark-script-as-executed`() {
         // Given
         val path = "/myPath"
 
@@ -52,8 +52,6 @@ internal class PrintConfigTest : BaseCliTest() {
             get { get(index++).message }.isEqualTo("- allow override executed script -> false")
             get { get(index++).message }.isEqualTo("- script action -> MARK_AS_EXECUTED")
             get { get(index++).message }.isEqualTo("- flags -> []")
-            get { get(index++).message }.isEqualTo("- verbose -> false")
-            get { get(index++).message }.isEqualTo("- porcelain -> false")
         }
     }
 
@@ -94,8 +92,6 @@ internal class PrintConfigTest : BaseCliTest() {
             get { get(index++).message }.isEqualTo("- allow override executed script -> false")
             get { get(index++).message }.isEqualTo("- script action -> MARK_AS_EXECUTED")
             get { get(index++).message }.isEqualTo("- flags -> []")
-            get { get(index++).message }.isEqualTo("- verbose -> false")
-            get { get(index++).message }.isEqualTo("- porcelain -> false")
         }
     }
 
@@ -142,8 +138,6 @@ internal class PrintConfigTest : BaseCliTest() {
             get { get(index++).message }.isEqualTo("- allow override executed script -> false")
             get { get(index++).message }.isEqualTo("- script action -> RUN")
             get { get(index++).message }.isEqualTo("- flags -> []")
-            get { get(index++).message }.isEqualTo("- verbose -> true")
-            get { get(index++).message }.isEqualTo("- porcelain -> true")
         }
     }
 
@@ -192,8 +186,6 @@ internal class PrintConfigTest : BaseCliTest() {
             get { get(index++).message }.isEqualTo("- allow override executed script -> false")
             get { get(index++).message }.isEqualTo("- script action -> RUN")
             get { get(index++).message }.isEqualTo("- flags -> []")
-            get { get(index++).message }.isEqualTo("- verbose -> true")
-            get { get(index++).message }.isEqualTo("- porcelain -> true")
         }
     }
 }