#19: Fix filtering of trace messages (#20)

* #19: Fix filtering of trace messages

Author: kaklakariada

.github/workflows/broken_links_checker.yml

@@ -10,7 +10,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
+      - name: Configure broken links checker
+        run: |
+          mkdir -p ./target
+          echo '{ "aliveStatusCodes": [429, 200] }' > ./target/broken_links_checker.json
       - uses: gaurav-nelson/github-action-markdown-link-check@v1
         with:
           use-quiet-mode: 'yes'
-          use-verbose-mode: 'yes'
+          use-verbose-mode: 'yes'
+          config-file: ./target/broken_links_checker.json

doc/changes/changelog.md

@@ -1,5 +1,6 @@
 # Changes
 
+* [1.1.1](changes_1.1.1.md)
 * [1.1.0](changes_1.1.0.md)
 * [1.0.1](changes_1.0.1.md)
 * [1.0.0](changes_1.0.0.md)

doc/changes/changes_1.1.1.md

@@ -0,0 +1,11 @@
+# remotelog-lua 1.1.1, released 2022-03-??
+
+Code name: Fix filtering of `trace` messages
+
+## Summary
+
+Version 1.1.1 of `remotelog-lua` fixes a bug that caused `trace` messages always being logged, independent of the log level.
+
+### Bugfixes
+
+* #19: Fixed filtering of `trace` messages

remotelog-1.1.0-1.rockspec renamed to remotelog-1.1.1-1.rockspec

@@ -1,11 +1,11 @@
 rockspec_format = "3.0"
 
 package = "remotelog"
-version = "1.1.0-1"
+version = "1.1.1-1"
 
 source = {
     url = 'git://github.com/exasol/remotelog-lua',
-    tag = "1.1.0"
+    tag = "1.1.1"
 }
 
 description = {

src/remotelog.lua

@@ -14,7 +14,7 @@ local fallback_strategies = {CONSOLE = 1, DISCARD = 2, ERROR = 3}
 -- </p>
 --
 local M = {
-    VERSION = "1.1.0",
+    VERSION = "1.1.1",
     level = levels.INFO,
     socket_client = nil,
     connection_timeout = 0.1, -- seconds
@@ -306,7 +306,7 @@ end
 -- @param ... log message or message pattern with placeholders and values
 --
 function M.trace(...)
-    if M.level >= levels.FATAL then
+    if M.level >= levels.TRACE then
         write("TRACE", ...)
     end
 end

test/test_remotelog.lua

@@ -74,12 +74,24 @@ function test_log:test_debug()
     self:assert_message(self.today .. " [DEBUG]  Look what we have here.\n")
 end
 
+function test_log:test_debug_not_logged()
+    self.log.set_level("INFO")
+    self.log.debug("don't send")
+    self:assert_no_message(self.today .. " [DEBUG]  don't send\n")
+end
+
 function test_log:test_trace()
     self.log.set_level("TRACE")
     self.log.trace("foo(bar)")
     self:assert_message(self.today .. " [TRACE]  foo(bar)\n")
 end
 
+function test_log:test_trace_not_logged()
+    self.log.set_level("DEBUG")
+    self.log.trace("don't send")
+    self:assert_no_message(self.today .. " [TRACE]  don't send\n")
+end
+
 function test_log:test_set_log_level()
     self.log.set_level("WARN")
     self.log.info("don't send")

test/test_remotelog_console.lua

@@ -31,45 +31,100 @@ local function assert_message(call, original_message, expected_message)
     luaunit.assertEquals(actual_message, expected_message)
 end
 
-local function assert_no_message(call, original_message)
-    local actual_message = trace.trace_print(call, original_message)
+local function assert_no_message(call)
+    local actual_message = trace.trace_print(call, "This message is not sent.")
     luaunit.assertNil(actual_message)
 end
 
 function test_console_log:test_fatal()
     assert_message(self.log.fatal, "Good by, cruel world!", self.today .. " [FATAL]  Good by, cruel world!")
 end
 
+function test_console_log:test_fatal_exact_level()
+    self.log.set_level("FATAL")
+    assert_message(self.log.fatal, "Good by, cruel world!", self.today .. " [FATAL]  Good by, cruel world!")
+end
+
+function test_console_log:test_fatal_not_logged()
+    self.log.set_level("NONE")
+    assert_no_message(self.log.fatal)
+end
+
 function test_console_log:test_error()
     assert_message(self.log.error, "Oops!", self.today .. " [ERROR]  Oops!")
 end
 
+function test_console_log:test_error_exact_level()
+    self.log.set_level("ERROR")
+    assert_message(self.log.error, "Oops!", self.today .. " [ERROR]  Oops!")
+end
+
+function test_console_log:test_error_not_logged()
+    self.log.set_level("FATAL")
+    assert_no_message(self.log.error)
+end
+
 function test_console_log:test_warn()
     assert_message(self.log.warn, "This looks suspicious...", self.today .. " [WARN]   This looks suspicious...")
 end
 
+function test_console_log:test_warn_exact_level()
+    self.log.set_level("WARN")
+    assert_message(self.log.warn, "This looks suspicious...", self.today .. " [WARN]   This looks suspicious...")
+end
+
+function test_console_log:test_warn_not_logged()
+    self.log.set_level("ERROR")
+    assert_no_message(self.log.warn)
+end
+
 function test_console_log:test_info()
     assert_message(self.log.info, "Good to know.", self.today .. " [INFO]   Good to know.")
 end
 
+function test_console_log:test_info_exact_level()
+    self.log.set_level("INFO")
+    assert_message(self.log.info, "Good to know.", self.today .. " [INFO]   Good to know.")
+end
+
+function test_console_log:test_info_not_logged()
+    self.log.set_level("WARN")
+    assert_no_message(self.log.info)
+end
+
 function test_console_log:test_config()
     self.log.set_level("CONFIG")
     assert_message(self.log.config, "Life support enabled.", self.today .. " [CONFIG] Life support enabled.")
 end
 
+function test_console_log:test_config_not_logged()
+    self.log.set_level("INFO")
+    assert_no_message(self.log.config)
+end
+
 function test_console_log:test_debug()
     self.log.set_level("DEBUG")
     assert_message(self.log.debug, "Look what we have here.", self.today .. " [DEBUG]  Look what we have here.")
 end
 
+function test_console_log:test_debug_not_logged()
+    self.log.set_level("INFO")
+    assert_no_message(self.log.debug)
+end
+
 function test_console_log:test_trace()
     self.log.set_level("TRACE")
     assert_message(self.log.trace, "foo(bar)", self.today .. " [TRACE]  foo(bar)")
 end
 
+function test_console_log:test_trace_not_logged()
+    self.log.set_level("DEBUG")
+    assert_no_message(self.log.trace)
+end
+
 function test_console_log:test_set_log_level()
     self.log.set_level("WARN")
-    assert_no_message(self.log.info, "don't send")
+    assert_no_message(self.log.info)
     assert_message(self.log.warn, "send", self.today .. " [WARN]   send")
 end