danger-warnings_next_generation 0.1.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d88f812549e81bc81f9da5038e5e821e9accd66317241b6d064cf60751b99048
-  data.tar.gz: 9c44904b68e5094ead295cd7ad8184a553bd898c01680f7c8716a084afe57fa3
+  metadata.gz: 5d83fdf1131f573ea07ccd0c01d37e2a7c95f8519b4c890425251c821d0e5536
+  data.tar.gz: f4ecd4575df5bd28ba7fc11d85e36463ed57a05dbed5c030d90011de72dc1ec7
 SHA512:
-  metadata.gz: 8a3bfc08322aa9a3507b70db3f88333bbbbcdc54fd60e8b2ad7278adfd063bbe5f7f162da736a7085ae23545cb11c6cb08b588282d4dd472a9cb0a464038cdef
-  data.tar.gz: 28a702a71425ed522d63dedd01dffb9f48e340b730d3b5ccb11f80e18e27e3925271386bbec78a5f79ef9ee2d01f22e8fc34941c5b5f13eec1576d801c203cac
+  metadata.gz: 5c02b8bbd0b54a1881e3a71e53756217f3eeff02407136c5e75f716d9ccb10011fb7f9ebd678537425c5726c248ff7fd390f0298ff808b0b09cb32a4f52b4d70
+  data.tar.gz: 9dd75d23bfd076882e38fab6d8e816f6acc2a018a243894f18bf944d7594b934e672e1c9412c092f1ca5000ab23f28e3c561e74f5caaafaa78d562cf1a974357

data/CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.0.0] - 2019-6-28
+### Added
+- Option `inline_threshold`
+- Option `table_threshold`
+
 ## [0.1.5] - 2019-6-02
 ### Changed
 - Add tool name to inline comment

data/README.md

@@ -185,3 +185,34 @@ warnings_next_generation.overview_report(
 )
 </pre>
 </blockquote>   
+
+## Comments threshold
+
+You can switch from inline comments to table comment if all issues >= threshold or to warnings if >= table threshold
+
+<blockquote>Switch to table comment if combined issues size >= 15
+<pre>
+warnings_next_generation.report(
+    inline: true
+    inline_threshold: 15
+)
+</pre>
+</blockquote>   
+
+<blockquote>Switch to table comment if combined issues size >= 200
+<pre>
+warnings_next_generation.report(
+    table_threshold: 200
+)
+</pre>
+</blockquote>   
+
+<blockquote>Switch from inline comment to table, and automatically to warning. 
+<pre>
+warnings_next_generation.report(
+    inline: true
+    inline_threshold: 20
+    table_threshold: 200
+)
+</pre>
+</blockquote>   

data/danger-warnings_next_generation.gemspec

@@ -8,7 +8,7 @@ require "warnings_next_generation/gem_version.rb"
 Gem::Specification.new do |spec|
   spec.name = "danger-warnings_next_generation"
   spec.version = WarningsNextGeneration::VERSION
-  spec.authors = ["Martin Schwamberger"]
+  spec.authors = ["Kyaak"]
   spec.email = ["kyaak.dev@gmail.com"]
   spec.description = "Danger plugin to for Jenkins-Warnings-Next-Generation plugin."
   spec.summary = "Read Jenkins warnings-ng reports and comment pull request with found issues."

data/lib/warnings_next_generation/gem_version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WarningsNextGeneration
-  VERSION = "0.1.5"
+  VERSION = "1.0.0"
 end

data/lib/warnings_next_generation/plugin.rb

@@ -89,9 +89,66 @@ module Danger
     def tools_report(*args)
       options = args.first
       check_auth(options)
+
+      collected_details = collect_details(options)
+      force_table = should_force_table(options, collected_details, baseline(options))
+      force_warning = should_force_warning(options, collected_details)
+
+      collected_details.each do |details|
+        name = details[:name]
+        detail_item = details[:details]
+
+        if inline?(options) && check_baseline(options) && !force_table
+          inline_report(name, detail_item, baseline(options))
+        else
+          tool_table(name, detail_item, force_warning)
+        end
+      end
+    end
+
+    private
+
+    def should_force_table(options, collected_details, baseline)
+      result = false
+      threshold = options[:inline_threshold] if options
+      if threshold
+        sum = 0
+        collected_details.each do |details|
+          issues = details[:details]["issues"]
+          issues ||= details[:details][:issues]
+          issues.each do |issue|
+            file = issue["fileName"].gsub(baseline, "")
+            sum += 1 if file_in_changeset?(file)
+          end
+        end
+        result = true if sum >= threshold
+      end
+      result
+    end
+
+    def should_force_warning(options, collected_details)
+      result = false
+      threshold = options[:table_threshold] if options
+      if threshold
+        sum = 0
+        collected_details.each do |details|
+          issues = details[:details]["issues"]
+          issues ||= details[:details][:issues]
+          issues.each do |issue|
+            file = File.basename(issue["fileName"])
+            sum += 1 if basename_in_changeset?(file)
+          end
+        end
+        result = true if sum >= threshold
+      end
+      result
+    end
+
+    def collect_details(options)
       tool_ids = include(options)
 
       tools = tool_entries
+      result = []
       tools.each do |tool|
         name = tool["name"]
         url = tool["latestUrl"]
@@ -99,16 +156,15 @@ module Danger
 
         next if use_include_option?(options) && !tool_ids.include?(id)
 
-        if inline?(options) && check_baseline(options)
-          inline_report(name, url, baseline(options))
-        else
-          tool_table(name, url)
-        end
+        details = details_result(url)
+        result << {
+          name: name,
+          details: details,
+        }
       end
+      result
     end
 
-    private
-
     def include(options)
       options && !options[:include].nil? ? options[:include] : []
     end
@@ -155,9 +211,9 @@ module Danger
       !options.nil? && !options[:include].nil?
     end
 
-    def tool_table(name, url)
-      details = details_result(url)
+    def tool_table(name, details, force_warnings)
       issues = details["issues"]
+      issues ||= details[:issues]
 
       table = WarningsNextGeneration::MarkdownTable.new
       table.detail_header(TABLE_HEADER_SEVERITY, TABLE_HEADER_FILE, TABLE_HEADER_DESCRIPTION)
@@ -172,15 +228,18 @@ module Danger
         table.line(severity, "#{file}:#{line}", "#{category_type(issue)} #{message}")
       end
 
-      unless table.size.zero?
-        content = +"### #{name}\n\n"
-        content << table.to_markdown
-        markdown(content)
+      if force_warnings
+        warn("This changeset has #{table.size} **#{name}** issues.")
+      else
+        unless table.size.zero?
+          content = +"### #{name}\n\n"
+          content << table.to_markdown
+          markdown(content)
+        end
       end
     end
 
-    def inline_report(name, url, baseline)
-      details = details_result(url)
+    def inline_report(name, details, baseline)
       issues = details["issues"]
 
       issues.each do |issue|

data/spec/assets/aggregation_two.json

@@ -0,0 +1,17 @@
+{
+  "_class": "io.jenkins.plugins.analysis.core.restapi.AggregationApi",
+  "tools": [
+    {
+      "id": "java",
+      "latestUrl": "http://localhost:8080/view/White%20Mountains/job/New%20-%20Pipeline%20-%20Simple%20Model/26/java",
+      "name": "Java Warnings",
+      "threshold": 1
+    },
+    {
+      "id": "pmd",
+      "latestUrl": "http://localhost:8080/view/White%20Mountains/job/New%20-%20Pipeline%20-%20Simple%20Model/26/pmd",
+      "name": "Pmd Warnings",
+      "threshold": 1
+    }
+  ]
+}

data/spec/warnings_next_generation_spec.rb

@@ -378,6 +378,226 @@ module Danger
           markdowns = @dangerfile.status_report[:markdowns]
           expect(markdowns.length).to be(0)
         end
+
+        it "creates inline comments if issues lower than threshold" do
+          aggregation_return("/assets/aggregation_single.json")
+          issues = android_lint_issues(14)
+          expect(issues["issues"].size).to be(14)
+          details_return_issue(issues)
+          mock_file_in_changeset(true)
+          @my_plugin.tools_report(inline: true, baseline: "mylibrary/src/main", inline_threshold: 15)
+
+          markdowns = @dangerfile.status_report[:markdowns]
+          messages = @dangerfile.status_report[:messages]
+          expect(markdowns.length).to be(0)
+          expect(messages.length).to be(14)
+        end
+
+        it "creates inline comments if issues not in changedfiles and lower than threshold" do
+          aggregation_return("/assets/aggregation_two.json")
+          java_issues = android_lint_issues(8)
+          pmd_issues = android_lint_issues(8, "OtherFile.java")
+          details_return_issue(java_issues, "java")
+          details_return_issue(pmd_issues, "pmd")
+          target_files_return(["src/main/AndroidManifest.xml"])
+          @my_plugin.tools_report(inline: true, baseline: "project", inline_threshold: 15)
+
+          markdowns = @dangerfile.status_report[:markdowns]
+          messages = @dangerfile.status_report[:messages]
+          expect(markdowns.length).to be(0)
+          expect(messages.length).to be(8)
+        end
+
+        it "creates table comments if issues not in changedfiles and lower than table threshold" do
+          aggregation_return("/assets/aggregation_two.json")
+          java_issues = android_lint_issues(8)
+          pmd_issues_1 = android_lint_issues(8, "OtherFile.java")
+          pmd_issues_2 = android_lint_issues(8, "OtherFileB.java")
+          pmd_issues = { "issues": pmd_issues_1["issues"] += pmd_issues_2["issues"] }
+          details_return_issue(java_issues, "java")
+          details_return_issue(pmd_issues, "pmd")
+          target_files_return(["src/main/AndroidManifest.xml", "src/main/OtherFile.java"])
+          @my_plugin.tools_report(inline: true, baseline: "project", inline_threshold: 15, table_threshold: 30)
+
+          markdowns = @dangerfile.status_report[:markdowns]
+          messages = @dangerfile.status_report[:messages]
+          expect(markdowns.length).to be(2)
+          expect(messages.length).to be(0)
+        end
+
+        it "creates table comment if issues equal than threshold" do
+          aggregation_return("/assets/aggregation_single.json")
+          issues = android_lint_issues(15)
+          expect(issues["issues"].size).to be(15)
+          details_return_issue(issues)
+          mock_file_in_changeset(true)
+          mock_basename_in_changeset(true)
+          @my_plugin.tools_report(inline: true, baseline: "mylibrary/src/main", inline_threshold: 15)
+
+          markdowns = @dangerfile.status_report[:markdowns]
+          messages = @dangerfile.status_report[:messages]
+          expect(markdowns.length).to be(1)
+          expect(messages.length).to be(0)
+        end
+
+        it "creates table comment if issues greater than threshold" do
+          aggregation_return("/assets/aggregation_single.json")
+          issues = android_lint_issues(16)
+          expect(issues["issues"].size).to be(16)
+          details_return_issue(issues)
+          mock_file_in_changeset(true)
+          mock_basename_in_changeset(true)
+          @my_plugin.tools_report(inline: true, baseline: "mylibrary/src/main", inline_threshold: 15)
+
+          markdowns = @dangerfile.status_report[:markdowns]
+          messages = @dangerfile.status_report[:messages]
+          expect(markdowns.length).to be(1)
+          expect(messages.length).to be(0)
+        end
+
+        it "creates table comment if issues of multiple reports greater than threshold" do
+          aggregation_return("/assets/aggregation.json")
+          issues = android_lint_issues(9)
+          expect(issues["issues"].size).to be(9)
+          details_return_issue(issues, "java")
+          details_return_issue(issues, "checkstyle")
+          details_return_issue(issues, "pmd")
+          details_return_issue(issues, "maven")
+          details_return_issue(issues, "javadoc")
+          details_return_issue(issues, "spotbugs")
+          details_return_issue(issues, "cpd")
+          details_return_issue(issues, "open-tasks")
+          mock_file_in_changeset(true)
+          mock_basename_in_changeset(true)
+          @my_plugin.tools_report(inline: true, baseline: "mylibrary/src/main", inline_threshold: 15)
+
+          markdowns = @dangerfile.status_report[:markdowns]
+          messages = @dangerfile.status_report[:messages]
+          expect(markdowns.length).to be(8)
+          expect(messages.length).to be(0)
+        end
+
+        it "creates inline comment if issues of multiple reports lower threshold" do
+          aggregation_return("/assets/aggregation.json")
+          issues = android_lint_issues(10)
+          expect(issues["issues"].size).to be(10)
+          details_return_issue(issues, "java")
+          details_return_issue(issues, "checkstyle")
+          details_return_issue(issues, "pmd")
+          details_return_issue(issues, "maven")
+          details_return_issue(issues, "javadoc")
+          details_return_issue(issues, "spotbugs")
+          details_return_issue(issues, "cpd")
+          details_return_issue(issues, "open-tasks")
+          mock_file_in_changeset(true)
+          mock_basename_in_changeset(true)
+          @my_plugin.tools_report(inline: true, baseline: "mylibrary/src/main", inline_threshold: 100)
+
+          markdowns = @dangerfile.status_report[:markdowns]
+          messages = @dangerfile.status_report[:messages]
+          expect(markdowns.length).to be(0)
+          expect(messages.length).to be(80)
+        end
+
+        it "creates inline comments if issues lower than inline_threshold and table_threshold" do
+          aggregation_return("/assets/aggregation_single.json")
+          issues = android_lint_issues(14)
+          expect(issues["issues"].size).to be(14)
+          details_return_issue(issues)
+          mock_file_in_changeset(true)
+          @my_plugin.tools_report(inline: true, baseline: "mylibrary/src/main", inline_threshold: 15, table_threshold: 15)
+
+          markdowns = @dangerfile.status_report[:markdowns]
+          messages = @dangerfile.status_report[:messages]
+          expect(markdowns.length).to be(0)
+          expect(messages.length).to be(14)
+        end
+
+        it "creates table comments if issues higher than inline_threshold and lower table_threshold" do
+          aggregation_return("/assets/aggregation_single.json")
+          issues = android_lint_issues(14)
+          expect(issues["issues"].size).to be(14)
+          details_return_issue(issues)
+          mock_file_in_changeset(true)
+          mock_basename_in_changeset(true)
+          @my_plugin.tools_report(inline: true, baseline: "mylibrary/src/main", inline_threshold: 10, table_threshold: 15)
+
+          markdowns = @dangerfile.status_report[:markdowns]
+          messages = @dangerfile.status_report[:messages]
+          expect(markdowns.length).to be(1)
+          expect(messages.length).to be(0)
+        end
+
+        it "creates warning comment if issues greater than table_threshold" do
+          aggregation_return("/assets/aggregation_single.json")
+          issues = android_lint_issues(16)
+          expect(issues["issues"].size).to be(16)
+          details_return_issue(issues)
+          mock_file_in_changeset(true)
+          mock_basename_in_changeset(true)
+          @my_plugin.tools_report(table_threshold: 15)
+
+          markdowns = @dangerfile.status_report[:markdowns]
+          messages = @dangerfile.status_report[:messages]
+          warnings = @dangerfile.status_report[:warnings]
+          expect(markdowns.length).to be(0)
+          expect(messages.length).to be(0)
+          expect(warnings.length).to be(1)
+          expect(warnings[0]).to include("16 **Java Warnings** issues")
+        end
+
+        it "creates table comment if issues greater than table_threshold but not in changelog" do
+          aggregation_return("/assets/aggregation_two.json")
+          java_issues = android_lint_issues(8)
+          pmd_issues = android_lint_issues(8, "OtherFile.java")
+          details_return_issue(java_issues, "java")
+          details_return_issue(pmd_issues, "pmd")
+          target_files_return(["src/main/AndroidManifest.xml"])
+          @my_plugin.tools_report(table_threshold: 15)
+
+          markdowns = @dangerfile.status_report[:markdowns]
+          messages = @dangerfile.status_report[:messages]
+          expect(markdowns.length).to be(1)
+          expect(messages.length).to be(0)
+        end
+
+        it "creates warn comments if issues in changedfiles and higher than table threshold" do
+          aggregation_return("/assets/aggregation_two.json")
+          java_issues = android_lint_issues(8)
+          pmd_issues_1 = android_lint_issues(8, "OtherFile.java")
+          pmd_issues_2 = android_lint_issues(8, "OtherFileB.java")
+          pmd_issues = { "issues": pmd_issues_1["issues"] += pmd_issues_2["issues"] }
+          details_return_issue(java_issues, "java")
+          details_return_issue(pmd_issues, "pmd")
+          target_files_return(["src/main/AndroidManifest.xml", "src/main/OtherFile.java"])
+          @my_plugin.tools_report(table_threshold: 15)
+
+          markdowns = @dangerfile.status_report[:markdowns]
+          messages = @dangerfile.status_report[:messages]
+          warnings = @dangerfile.status_report[:warnings]
+          expect(markdowns.length).to be(0)
+          expect(messages.length).to be(0)
+          expect(warnings.length).to be(2)
+          expect(warnings[1]).to include("8 **Pmd Warnings** issues")
+        end
+
+        it "creates warning comment if issues greater than inline and table threshold" do
+          aggregation_return("/assets/aggregation_single.json")
+          issues = android_lint_issues(16)
+          expect(issues["issues"].size).to be(16)
+          details_return_issue(issues)
+          mock_file_in_changeset(true)
+          mock_basename_in_changeset(true)
+          @my_plugin.tools_report(inline: true, baseline: "mylibrary/src/main", inline_threshold: 10, table_threshold: 15)
+
+          markdowns = @dangerfile.status_report[:markdowns]
+          messages = @dangerfile.status_report[:messages]
+          warnings = @dangerfile.status_report[:warnings]
+          expect(markdowns.length).to be(0)
+          expect(messages.length).to be(0)
+          expect(warnings.length).to be(1)
+          expect(warnings[0]).to include("16 **Java Warnings** issues")
+        end
       end
     end
   end
@@ -401,33 +621,37 @@ def details_return(file)
   @my_plugin.stubs(:details_result).returns(json)
 end
 
-def details_return_issue(issue)
-  @my_plugin.stubs(:details_result).returns(issue)
+def details_return_issue(issue, toold_id = "java")
+  @my_plugin.stubs(:details_result).with("http://localhost:8080/view/White%20Mountains/job/New%20-%20Pipeline%20-%20Simple%20Model/26/#{toold_id}").returns(issue)
 end
 
-def android_lint_issues
+def android_lint_issues(count = 1, filename = "AndroidManifest.xml")
   json = {
-    "issues": [
-      {
-        "baseName": "AndroidManifest.xml",
-        "category": "Internationalization:Bidirectional Text",
-        "columnEnd": 0,
-        "columnStart": 0,
-        "description": "",
-        "fileName": "/var/lib/jenkins/workspace/Jenkins/Examples/android/MR6--danger/repository/mylibrary/src/main/AndroidManifest.xml",
-        "fingerprint": "4F7305CA47CE9CFC2A8E9BE4287E79F8",
-        "lineEnd": 0,
-        "lineStart": 0,
-        "message": "Using RTL attributes without enabling RTL support\nThe project references RTL attributes, but does not explicitly enable or disable RTL support with `android:supportsRtl` in the manifest\nTo enable right-to-left support, when running on API 17 and higher, you must set the `android:supportsRtl` attribute in the manifest `<application>` element.&#xA;&#xA;If you have started adding RTL attributes, but have not yet finished the migration, you can set the attribute to false to satisfy this lint check.",
-        "moduleName": "",
-        "origin": "android-lint",
-        "packageName": "-",
-        "reference": "3",
-        "severity": "NORMAL",
-        "type": "RtlEnabled",
-      },
-    ],
+    "issues": [],
   }
+
+  items = 0
+  while items < count
+    json[:issues] << {
+      "baseName": filename,
+      "category": "Internationalization:Bidirectional Text",
+      "columnEnd": 0,
+      "columnStart": 0,
+      "description": "",
+      "fileName": "project/src/main/#{filename}",
+      "fingerprint": "4F7305CA47CE9CFC2A8E9BE4287E79F8",
+      "lineEnd": 0,
+      "lineStart": 0,
+      "message": "Using RTL attributes without enabling RTL support\nThe project references RTL attributes, but does not explicitly enable or disable RTL support with `android:supportsRtl` in the manifest\nTo enable right-to-left support, when running on API 17 and higher, you must set the `android:supportsRtl` attribute in the manifest `<application>` element.&#xA;&#xA;If you have started adding RTL attributes, but have not yet finished the migration, you can set the attribute to false to satisfy this lint check.",
+      "moduleName": "",
+      "origin": "android-lint",
+      "packageName": "-",
+      "reference": "3",
+      "severity": "NORMAL",
+      "type": "RtlEnabled",
+    }
+    items += 1
+  end
   serialized = JSON.generate(json)
   JSON.parse(serialized)
 end
@@ -446,3 +670,11 @@ end
 def target_files_return(list)
   @my_plugin.stubs(:target_files).returns(list)
 end
+
+def mock_file_in_changeset(value)
+  @my_plugin.stubs(:file_in_changeset?).returns(value)
+end
+
+def mock_basename_in_changeset(value)
+  @my_plugin.stubs(:basename_in_changeset?).returns(value)
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-warnings_next_generation
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 1.0.0
 platform: ruby
 authors:
-- Martin Schwamberger
+- Kyaak
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-02 00:00:00.000000000 Z
+date: 2019-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -174,6 +174,7 @@ files:
 - sonar-project.properties
 - spec/assets/aggregation.json
 - spec/assets/aggregation_single.json
+- spec/assets/aggregation_two.json
 - spec/assets/example/aggregation.json
 - spec/assets/example/detail_android_lint.json
 - spec/assets/example/detail_detekt.json
@@ -207,13 +208,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.4
 signing_key: 
 specification_version: 4
 summary: Read Jenkins warnings-ng reports and comment pull request with found issues.
 test_files:
 - spec/assets/aggregation.json
 - spec/assets/aggregation_single.json
+- spec/assets/aggregation_two.json
 - spec/assets/example/aggregation.json
 - spec/assets/example/detail_android_lint.json
 - spec/assets/example/detail_detekt.json