Add sonar formatter

Author: mmelentiev-mail

.travis.yml

@@ -22,6 +22,7 @@ _lua: &lua
     - luarocks install cluacov
     - luarocks install luautf8
     - luarocks install luasocket
+    - luarocks install dkjson
     - luarocks make
 
   script:

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## Unreleased
 
+* Add SonarQube formatter.
 * Tarantool: Add rules for box.session.
   Fixes warnings for writing to box.session.storage.
 

docsrc/cli.rst

@@ -139,6 +139,7 @@ Option                                  Meaning
                                         * ``JUnit`` - JUnit XML formatter;
                                         * ``visual_studio`` - MSBuild/Visual Studio aware formatter;
                                         * ``plain`` - simple warning-per-line formatter;
+                                        * ``sonar`` - formatter for SonarQube;
                                         * ``default`` - standard formatter.
 ``-q | --quiet``                        Suppress report output for files without warnings.
 

luacheck-scm-1.rockspec

@@ -37,6 +37,7 @@ build = {
       ["luacheck.formatter.default"] = "src/luacheck/formatter/default.lua",
       ["luacheck.formatter.junit"] = "src/luacheck/formatter/junit.lua",
       ["luacheck.formatter.plain"] = "src/luacheck/formatter/plain.lua",
+      ["luacheck.formatter.sonar"] = "src/luacheck/formatter/sonar.lua",
       ["luacheck.formatter.tap"] = "src/luacheck/formatter/tap.lua",
       ["luacheck.formatter.visual_studio"] = "src/luacheck/formatter/visual_studio.lua",
       ["luacheck.fs"] = "src/luacheck/fs.lua",

spec/formatters/sonar_spec.lua

@@ -0,0 +1,72 @@
+local json_ok, json = pcall(require, "dkjson")
+json = json_ok and json or require("json")
+
+local get_output = require("spec.helper").get_output
+
+assert:set_parameter("TableFormatLevel", 6)
+
+local function get_json_output(...)
+   local output = get_output(...)
+   local ok, result = pcall(json.decode, output)
+   if ok then
+      return result
+   else
+      return output
+   end
+end
+
+local function build_issue(path, line, col, code, severity, issue_type, message, secondaryLocations)
+   return {
+      effortMinutes = 2,
+      engineId = "luacheck",
+      primaryLocation = {
+         message = message,
+         filePath = path,
+         textRange = {
+            startLine = tonumber(line),
+            startColumn = col and (tonumber(col) - 1),
+         }
+      },
+      ruleId = code,
+      secondaryLocations = secondaryLocations,
+      severity = severity,
+      type = issue_type,
+   }
+end
+
+-- luacheck: max line length 180
+describe("Sonar formatter", function()
+   it("renders empty array when there is no issues", function()
+      -- don't use get_json_output to ensure that there is array in json
+      assert.equal('{"issues":[]}\n', get_output "spec/samples/good_code.lua --std=lua52 --formatter sonar --no-config")
+   end)
+
+   it("renders issues", function()
+      local expected = {
+         build_issue("spec/samples/bad_code.lua", 3, 16, "211", "MAJOR", "CODE_SMELL", "unused function 'helper'"),
+         build_issue("spec/samples/bad_code.lua", 3, 23, "212", "MAJOR", "CODE_SMELL", "unused variable length argument"),
+         build_issue("spec/samples/bad_code.lua", 7, 10, "111", "MAJOR", "CODE_SMELL", "setting non-standard global variable 'embrace'"),
+         build_issue("spec/samples/bad_code.lua", 8, 10, "412", "MAJOR", "CODE_SMELL", "variable 'opt' was previously defined as an argument on line 7", {{
+            filePath = "spec/samples/bad_code.lua",
+            message = "opt",
+            textRange = {
+               startLine = 7,
+               startColumn = 17,
+               endColumn = 19,
+            },
+         }}),
+         build_issue("spec/samples/bad_code.lua", 9, 11, "113", "MAJOR", "CODE_SMELL", "accessing undefined variable 'hepler'"),
+         build_issue("spec/samples/python_code.lua", 1, 6, "011", "BLOCKER", "BUG", "expected '=' near '__future__'"),
+      }
+      local output = get_json_output "spec/samples/good_code.lua spec/samples/bad_code.lua spec/samples/python_code.lua --std=lua52 --formatter sonar --no-config"
+      for i, val in ipairs(output.issues) do
+         assert.same(expected[i], val)
+      end
+   end)
+
+   it("renders fatal errors", function()
+      assert.same({issues = {
+         build_issue("spec/samples/404.lua", 1, nil, "FATAL", "BLOCKER", "BUG", "I/O error")
+      }}, get_json_output "spec/samples/404.lua --formatter sonar --no-config")
+   end)
+end)

src/luacheck/formatter/sonar.lua

@@ -0,0 +1,103 @@
+local format = require("luacheck.format")
+
+local json_ok, json = pcall(require, "dkjson")
+json = json_ok and json or require("json")
+
+local sonar_error = {
+   severity = "BLOCKER",
+   type = "BUG",
+}
+local sonar_warning = {
+   severity = "MAJOR",
+   type = "CODE_SMELL",
+}
+
+local function is_error(event)
+   return event.code:sub(1, 1) == "0"
+end
+
+local function build_primary_location(file_name, event)
+   local has_end_column = event.endColumn and event.endColumn > event.column
+   local message = format.get_message(event)
+   return {
+      message = message,
+      filePath = file_name,
+      textRange = {
+         startLine = event.line,
+         startColumn = event.column - 1,
+         endColumn = has_end_column and (event.endColumn - 1) or nil,
+      }
+   }
+end
+
+local function build_secondary_locations(file_name, event)
+   local has_secondary_locations = event.prev_line ~= nil
+   if not has_secondary_locations then
+      return nil
+   end
+
+   local has_prev_column = event.prev_column ~= nil
+   local has_prev_end_column = has_prev_column and (event.prev_end_column and event.prev_end_column > event.prev_column)
+
+   return {
+      {
+         message = event.name,
+         filePath = file_name,
+         textRange = {
+            startLine = event.prev_line,
+            startColumn = has_prev_column and (event.prev_column - 1) or nil,
+            endColumn = has_prev_end_column and (event.prev_end_column - 1) or nil,
+         }
+      }
+   }
+end
+
+local function sonar_issue(file_name, event)
+   local category = is_error(event) and sonar_error or sonar_warning
+
+   return {
+      engineId = "luacheck",
+      ruleId = event.code,
+      severity = category.severity,
+      type = category.type,
+      effortMinutes = 2,
+      primaryLocation = build_primary_location(file_name, event),
+      secondaryLocations = build_secondary_locations(file_name, event)
+   }
+end
+
+local function sonar_fatal(file_name, file_report)
+   return {
+      engineId = "luacheck",
+      ruleId = "FATAL",
+      severity = "BLOCKER",
+      type = "BUG",
+      effortMinutes = 2,
+      primaryLocation = {
+         message = format.fatal_type(file_report),
+         filePath = file_name,
+         textRange = {
+            startLine = 1
+         }
+      }
+   }
+end
+
+return function(report, file_names)
+   local issues = setmetatable({}, {__jsontype = "array"})
+
+   for i, file_report in ipairs(report) do
+      local file_name = file_names[i]
+      if file_report.fatal then
+         table.insert(issues, sonar_fatal(file_name, file_report))
+      else
+         for _, event in ipairs(file_report) do
+            table.insert(issues, sonar_issue(file_name, event))
+         end
+      end
+   end
+
+   return json.encode({
+      issues = issues
+   })
+end

src/luacheck/main.lua

@@ -237,6 +237,7 @@ Links:
          "   JUnit - JUnit XML formatter;\n" ..
          "   visual_studio - MSBuild/Visual Studio aware formatter;\n" ..
          "   plain - simple warning-per-line formatter;\n" ..
+         "   sonar - formatter for SonarQube;\n" ..
          "   default - standard formatter."),
       parser:flag("-q --quiet", "Suppress output for files without warnings.\n" ..
          "-qq: Suppress output of warnings.\n" ..