pronto-golang 0.0.16 → 0.0.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78838b2b1bf653434084571dc636c643944b67111bda54cea5fce92301f7c8f4
-  data.tar.gz: df2744fb7b735d9290ecd3db3518b17d483bc4313e571eaf15b03170eb9b46e7
+  metadata.gz: 120d00f5e921b115909bfc11916d9ee23230182ac4a34f95f86c468e9f9328b0
+  data.tar.gz: 1f33e54b1290fc68f0048fc34be88734f9717f998dd7d13705e688a7a52aba24
 SHA512:
-  metadata.gz: efc448f0df3114c77c86f7527b6d27cbd2b31eb9f18ecac2ec73dec53e6a43d471bcaf2a1ba618519ee319dcfc04efdc819ee263093269ffb577348c56161619
-  data.tar.gz: b5d98cb7367a6ac5644183936c08fc876d4af79cde4c025f88e1eaf1ec5898ed78eac98fd23233d3b8740505bcb109d995fc251d4ea506dfffb5201edeb371d5
+  metadata.gz: c62f9f498b04990ebe48b1ada3f9498cc3db39ab785f748c3a18863f80081ad7dec60bd6bf7426eeb26353c7c581ff4c33810af0da9de0bfa30e7acdece57ce3
+  data.tar.gz: 184a6a107c0442ae979f591f894af8e130c292d6f58059528a35e3f77b8dd0ee7860ff50d19a627de068bd3d7b850bcb7e0ddf6b6075db39a156b1a041202ee2

data/README.md

@@ -45,7 +45,7 @@ It is expected that it reponds to the following methods:
 | `command(file_path)` | Executes the command and receives the file_path to allow checking only the current file |
 | `self.base_command` | Returns the name/basic command that will be invoked. Is also used for enabling and disabling it via `.golangtools.yml` |
 | `available?` | Returns true if the tool can be found, e.g. through `which #{base_command}` |
-| `parse_line(line)` | Receives the line returned from the tool for parsing. Returns `absolute_path`, `line_number`, `level`, `message text` |
+| `process_output(output)` | Receives the output returned from the tool for parsing. Returns an array of `Output` with `absolute_path`, `line_number`, `level`, `message text` |
 
 It is possible to inherit from `Pronto::GolangTools::Base`, in which case only `self.base_command` and `parse_line` need to be implemented.
 

data/lib/pronto/golang/output.rb

@@ -0,0 +1,12 @@
+module Pronto
+  module GolangSupport
+    
+    Output = Struct.new(
+               :file_path,
+               :line_number,
+               :level,
+               :message,
+             )
+
+  end
+end

data/lib/pronto/golang/tools/base.rb

@@ -1,3 +1,5 @@
+require_relative '../output'
+
 module Pronto
   module GolangTools
     class Base
@@ -14,13 +16,17 @@ module Pronto
       end
 
       def command(file_path)
-        "cd #{directory} && #{base_command} #{parameters} #{file_path}"
+        "cd #{directory} && #{base_command} #{default_parameters} #{parameters} #{file_path}"
       end
 
       def directory(default = '.')
         @config.fetch('execution_directory', default)
       end
 
+      def default_parameters
+        '' # blank, can be overwritten for tools
+      end
+
       def parameters
         @config.fetch('parameters', '') # Default to '' if the key is not configured
       end
@@ -48,8 +54,8 @@ module Pronto
         'file'
       end
 
-      def parse_line(line)
-        elements = line.split(':')
+      def process_output(output)
+        elements = output.split(':')
         file_path   = elements[0]
         line_number = elements[1]
 
@@ -72,7 +78,9 @@ module Pronto
           file_path = File.join(dir, file_path)
         end
 
-        return file_path, line_number, :warning, message.to_s.strip
+        return [
+          Pronto::GolangSupport::Output.new(file_path, line_number, :warning, message.to_s.strip),
+        ]
       end
     end
   end

data/lib/pronto/golang/tools/golangci_lint.rb

@@ -1,3 +1,7 @@
+require 'json'
+
+require_relative '../output'
+
 module Pronto
   module GolangTools
     class GolangCiLint < Base
@@ -8,6 +12,31 @@ module Pronto
       def execution_mode
         'project'
       end
+
+      def default_parameters
+        'run --out-format=json'
+      end
+
+      def process_output(output)
+        issues = JSON.parse(output).fetch('Issues')
+
+        dir = directory('')
+
+        return issues.map do |issue|
+          file_path = issue.fetch('Pos').fetch('Filename')
+
+          if dir != ''
+            file_path = File.join(dir, file_path)
+          end
+
+          Pronto::GolangSupport::Output.new(
+            file_path,
+            issue.fetch('Pos').fetch('Line'),
+            :warning,
+            "#{issue.fetch('Text')} (#{issue.fetch('FromLinter')})",
+          )
+        end
+      end
     end
   end
 end

data/lib/pronto/golang/tools/golint.rb

@@ -1,3 +1,5 @@
+require_relative '../output'
+
 module Pronto
   module GolangTools
     class Golint < Base
@@ -5,15 +7,17 @@ module Pronto
         'golint'
       end
 
-      def parse_line(line)
-        path, line_number, _, message = line.split(':')
+      def process_output(output)
+        path, line_number, _, message = output.split(':')
 
         absolute_path = Pathname.new(path)
         working_directory = Pathname.new(Dir.pwd)
 
         file_path = absolute_path.relative_path_from(working_directory).to_s
 
-        return file_path, line_number, :warning, message.to_s.strip
+        return [
+          Pronto::GolangSupport::Output.new(file_path, line_number, :warning, message.to_s.strip),
+        ]
       end
     end
   end

data/lib/pronto/golang/tools/gosec.rb

@@ -1,6 +1,7 @@
 require 'pathname'
 
 require_relative '../errors'
+require_relative '../output'
 
 module Pronto
   module GolangTools
@@ -20,7 +21,7 @@ module Pronto
         "#{base_command} #{parameters} #{File.dirname(file_path)}"
       end
 
-      def parse_line(line)
+      def process_output(line)
         line = line.gsub(ANSI_COLOR_CODING_PATTERN, '')
 
         if !GOSEC_LINE_PATTERN.match(line)
@@ -36,7 +37,9 @@ module Pronto
 
         file_path = absolute_path.relative_path_from(working_directory)
 
-        return file_path.to_s, line_number, :warning, message
+        return [
+          Pronto::GolangSupport::Output.new(file_path.to_s, line_number, :warning, message),
+        ]
       end
     end
   end

data/lib/pronto/golang/tools/staticcheck.rb

@@ -1,3 +1,5 @@
+require_relative '../output'
+
 module Pronto
   module GolangTools
     class Staticcheck < Base
@@ -5,10 +7,12 @@ module Pronto
         'staticcheck'
       end
 
-      def parse_line(line)
-        file_path, line_number, _, message = line.split(':')
+      def process_output(output)
+        file_path, line_number, _, message = output.split(':')
 
-        return file_path, line_number, :warning, message.to_s.strip
+        return [
+          Pronto::GolangSupport::Output.new(file_path, line_number, :warning, message.to_s.strip),
+        ]
       end
     end
   end

data/lib/pronto/golang/version.rb

@@ -1,5 +1,5 @@
 module Pronto
   module GolangVersion
-    VERSION = '0.0.16'.freeze
+    VERSION = '0.0.17'.freeze
   end
 end

data/lib/pronto/golang.rb

@@ -83,16 +83,16 @@ module Pronto
             next if output_line.strip == 'exit status 1'
 
             collected_findings << {
-              line: output_line,
-              tool: tool,
+              output: output_line,
+              tool:   tool,
             }
           end
         end
 
         while output_line = stderr.gets
           collected_findings << {
-            line: output_line,
-            tool: tool,
+            output: output_line,
+            tool:   tool,
           }
         end
       end
@@ -104,34 +104,43 @@ module Pronto
       messages = []
 
       findings.each do |finding|
-        messages << process_line(patch, finding[:tool], finding[:line])
+        messages += process_line(patch, finding[:tool], finding[:output])
       end
 
       return messages
     end
 
-    def process_line(patch, tool, output_line)
-      return nil if output_line =~ /^#/
+    def process_line(patch, tool, output)
+      return [] if output =~ /^#/
 
       begin
-        file_path, line_number, level, message = tool.parse_line(output_line)
+        messages = []
 
-        patch.added_lines.each do |line|
-          if line_number.to_s == line.new_lineno.to_s &&
-             patch.new_file_full_path.to_s == File.expand_path(file_path)
+        parsed_outputs = tool.process_output(output)
 
-            prefix_message = "#{tool.base_command}: #{message}"
+        parsed_outputs.each do |parsed_output|
+          patch.added_lines.each do |line|
 
-            return Message.new(
-              file_path, line, level, prefix_message, line.commit_sha, self.class
-            )
+            next if parsed_output.line_number.to_s != line.new_lineno.to_s ||
+                    patch.new_file_full_path.to_s != File.expand_path(parsed_output.file_path)
+
+            prefix_message = "#{tool.base_command}: #{parsed_output.message}"
+
+            messages << Message.new(
+                          parsed_output.file_path,
+                          line,
+                          parsed_output.level,
+                          prefix_message,
+                          line.commit_sha,
+                          self.class,
+                        )
           end
         end
       rescue ::Pronto::GolangSupport::UnprocessableLine
         # Do nothing if the line is not processable
       end
 
-      return nil
+      return messages
     end
 
     def available_tools

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pronto-golang
 version: !ruby/object:Gem::Version
-  version: 0.0.16
+  version: 0.0.17
 platform: ruby
 authors:
 - Tobias Schoknecht
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-11 00:00:00.000000000 Z
+date: 2023-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pronto
@@ -71,6 +71,7 @@ files:
 - lib/pronto/golang.rb
 - lib/pronto/golang/errors.rb
 - lib/pronto/golang/file_finder.rb
+- lib/pronto/golang/output.rb
 - lib/pronto/golang/tools.rb
 - lib/pronto/golang/tools/base.rb
 - lib/pronto/golang/tools/golangci_lint.rb