Added docs, tests, fix existing tests

docs/logging.md

@@ -0,0 +1,7 @@
+# Logs in Flank
+
+1. Log level depends on the output style.
+1. ```Simple, multi``` and ```verbose``` output style prints logs from ```SIMPLE``` and ```DETAILED``` levels.
+1. ```Compact``` style prints log only from ```SIMPLE``` level.
+1. If you want a print message for all output styles uses ```log``` or ```logLn``` with only ```message``` parameter.
+1. If you want print message more detailed message use ```log``` or ```logLn``` and set ```level``` to ```OutputLogLevel.DETAILED```

test_runner/src/main/kotlin/ftl/args/IArgs.kt

@@ -85,7 +85,7 @@ interface IArgs {
 }
 
 val IArgs.logLevel
-    get() = if (outputStyle == OutputStyle.Compact) OutputLogLevel.LOW else OutputLogLevel.All
+    get() = if (outputStyle == OutputStyle.Compact) OutputLogLevel.SIMPLE else OutputLogLevel.DETAILED
 
 fun IArgs.setLogLevel() = also {
     ftl.log.setLogLevel(logLevel)

test_runner/src/main/kotlin/ftl/log/OutputLogger.kt

@@ -4,17 +4,17 @@ fun setLogLevel(logLevel: OutputLogLevel) {
     minimumLogLevel = logLevel
 }
 
-fun log(message: Any, level: OutputLogLevel = OutputLogLevel.LOW) =
+fun log(message: Any, level: OutputLogLevel = OutputLogLevel.SIMPLE) =
     if (minimumLogLevel >= level) print(message)
     else Unit
 
-fun logLn(message: Any = "", level: OutputLogLevel = OutputLogLevel.LOW) =
+fun logLn(message: Any = "", level: OutputLogLevel = OutputLogLevel.SIMPLE) =
     if (minimumLogLevel >= level) println(message)
     else Unit
 
-private var minimumLogLevel: OutputLogLevel = OutputLogLevel.LOW
+private var minimumLogLevel: OutputLogLevel = OutputLogLevel.DETAILED
 
 enum class OutputLogLevel {
-    LOW,
-    All
+    SIMPLE,
+    DETAILED
 }

test_runner/src/main/kotlin/ftl/run/DumpShards.kt

@@ -52,7 +52,7 @@ fun saveShardChunks(
         Paths.get(shardFilePath),
         getGson(obfuscatedOutput).toJson(shards).toByteArray()
     )
-    logLn("Saved $size shards to $shardFilePath", OutputLogLevel.All)
+    logLn("Saved $size shards to $shardFilePath", OutputLogLevel.DETAILED)
 }
 
 private fun getGson(obfuscatedOutput: Boolean) = if (obfuscatedOutput) obfuscatePrettyPrinter else prettyPrint

test_runner/src/main/kotlin/ftl/run/common/FetchArtifacts.kt

@@ -20,7 +20,7 @@ import java.nio.file.Paths
 
 // TODO needs refactor
 internal suspend fun fetchArtifacts(matrixMap: MatrixMap, args: IArgs) = coroutineScope {
-    logLn("FetchArtifacts", OutputLogLevel.All)
+    logLn("FetchArtifacts", OutputLogLevel.DETAILED)
     val fields = Storage.BlobListOption.fields(Storage.BlobField.NAME)
 
     var dirty = false
@@ -43,7 +43,7 @@ internal suspend fun fetchArtifacts(matrixMap: MatrixMap, args: IArgs) = corouti
             if (matched) {
                 val downloadFile = getDownloadPath(args, blobPath)
 
-                log(".", OutputLogLevel.All)
+                log(".", OutputLogLevel.DETAILED)
                 if (!downloadFile.toFile().exists()) {
                     val parentFile = downloadFile.parent.toFile()
                     parentFile.mkdirs()
@@ -56,12 +56,12 @@ internal suspend fun fetchArtifacts(matrixMap: MatrixMap, args: IArgs) = corouti
         filtered[index] = matrix.copy(downloaded = true)
         jobs
     }.joinAll()
-    logLn(level = OutputLogLevel.All)
+    logLn(level = OutputLogLevel.DETAILED)
 
     if (dirty) {
-        logLn(FtlConstants.indent + "Updating matrix file", level = OutputLogLevel.All)
+        logLn(FtlConstants.indent + "Updating matrix file", level = OutputLogLevel.DETAILED)
         args.updateMatrixFile(matrixMap)
-        logLn(level = OutputLogLevel.All)
+        logLn(level = OutputLogLevel.DETAILED)
     }
 }
 

test_runner/src/main/kotlin/ftl/run/status/ExecutionStatusPrinter.kt

@@ -66,7 +66,7 @@ internal class MultiLinePrinter(
 @VisibleForTesting
 internal object VerbosePrinter : (List<ExecutionStatus.Change>) -> Unit {
     override fun invoke(changes: List<ExecutionStatus.Change>) {
-        changes.map(ExecutionStatus.Change::views).flatten().forEach { logLn(it, OutputLogLevel.All) }
+        changes.map(ExecutionStatus.Change::views).flatten().forEach { logLn(it, OutputLogLevel.DETAILED) }
     }
 }
 

test_runner/src/main/kotlin/ftl/util/ProgressBar.kt

@@ -11,20 +11,20 @@ class ProgressBar {
     private val timer = Timer(true)
 
     fun start(msg: String) {
-        log("  $msg ", OutputLogLevel.All)
+        log("  $msg ", OutputLogLevel.DETAILED)
         timer.scheduleAtFixedRate(task, 0, 10_000)
     }
 
     fun stop() {
-        logLn(level = OutputLogLevel.All)
+        logLn(level = OutputLogLevel.DETAILED)
         timer.cancel()
         task.cancel()
     }
 }
 
 private class ProgressBarTask : TimerTask() {
     override fun run() {
-        log(".", OutputLogLevel.All)
+        log(".", OutputLogLevel.DETAILED)
     }
 }
 

test_runner/src/test/kotlin/ftl/log/OutputLoggerTest.kt

@@ -0,0 +1,45 @@
+package ftl.log
+
+import com.google.common.truth.Truth
+import ftl.test.util.TestHelper.normalizeLineEnding
+import org.junit.After
+import org.junit.Rule
+import org.junit.Test
+import org.junit.contrib.java.lang.system.SystemOutRule
+
+class OutputLoggerTest {
+
+    @Rule
+    @JvmField
+    val systemOutRule: SystemOutRule = SystemOutRule().enableLog().muteForSuccessfulTests()
+
+    private val simpleMessage = "print for simple"
+    private val detailedMessage = "print for detailed"
+
+    @After
+    fun afterTest() {
+        setLogLevel(OutputLogLevel.DETAILED)
+    }
+
+    @Test
+    fun `should print messages from all output levels if log level set to detailed`() {
+        setLogLevel(OutputLogLevel.DETAILED)
+
+        logLn(simpleMessage)
+        logLn(detailedMessage, OutputLogLevel.DETAILED)
+
+        Truth.assertThat(systemOutRule.log.normalizeLineEnding()).contains(simpleMessage)
+        Truth.assertThat(systemOutRule.log.normalizeLineEnding()).contains(detailedMessage)
+    }
+
+    @Test
+    fun `should print messages only simple output level if log level not set`() {
+        setLogLevel(OutputLogLevel.SIMPLE)
+
+        logLn(simpleMessage)
+        logLn(detailedMessage, OutputLogLevel.DETAILED)
+
+        Truth.assertThat(systemOutRule.log.normalizeLineEnding()).contains(simpleMessage)
+        Truth.assertThat(systemOutRule.log.normalizeLineEnding()).doesNotContain(detailedMessage)
+    }
+}

test_runner/src/test/kotlin/ftl/util/ProgressBarTest.kt

@@ -20,7 +20,7 @@ class ProgressBarTest {
 
     @Before
     fun beforeTest() {
-        setLogLevel(OutputLogLevel.All)
+        setLogLevel(OutputLogLevel.DETAILED)
     }
 
     @Test