danger 8.0.6 → 8.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b175fad0150fdcb243c42f37c0b9683a7dc00db8b3be4ef81d01be0103b90bb
-  data.tar.gz: d422bf7eadd533e5591f1ac43cde404f38d124a3c398469a1b9563c5338e8370
+  metadata.gz: 58ac1ecdfec8029d0fee2f4d6e0b63e975c56f1ced271f24fd8cf094f3e7e647
+  data.tar.gz: 65ef72507496b5c6d9d34da8473d5ba6006eba4338d84618a22bd95dd928b115
 SHA512:
-  metadata.gz: d36a05ed7713cf0b50936c04feaa4cb49c8ba035b539ff265c9d7e231c2670efba007f5f4a2bf58936cab24c7aa0e09d5c9a2a9edff9714689fc5b03cc31d870
-  data.tar.gz: 611a647c06bab7c3949ded7ff12b5498b966d54f10056481ae720dfa3801f48ac27085d112f69c186feb5638b2b82b0f7583c0f020af33af8251705429fbf614
+  metadata.gz: 8717fee5c49cc4cb0835a7ce4d68755a3981f2e4e18529da14c49a7433b5a250a16097930b0ad342fbed6b0d020219b79795cb46da22b871f1d69b4aaaf3484e
+  data.tar.gz: 0b128cb7f4b2f6749a6e1f5c58dce9c17bf992f71660e86b3771f5b3797e1165fe4187d58cfb9eb4f343314ef4035c5fbc04936abaf2af32389c9a0522809887

data/lib/danger/request_sources/bitbucket_server.rb

@@ -2,6 +2,8 @@
 
 require "danger/helpers/comments_helper"
 require "danger/request_sources/bitbucket_server_api"
+require "danger/request_sources/code_insights_api"
+require_relative "request_source"
 
 module Danger
   module RequestSources
@@ -17,12 +19,21 @@ module Danger
         ]
       end
 
+      def self.optional_env_vars
+        ["DANGER_BITBUCKETSERVER_CODE_INSIGHTS_REPORT_KEY",
+         "DANGER_BITBUCKETSERVER_CODE_INSIGHTS_REPORT_TITLE",
+         "DANGER_BITBUCKETSERVER_CODE_INSIGHTS_REPORT_DESCRIPTION",
+         "DANGER_BITBUCKETSERVER_CODE_INSIGHTS_REPORT_LOGO_URL"
+        ]
+      end
+
       def initialize(ci_source, environment)
         self.ci_source = ci_source
         self.environment = environment
 
         project, slug = ci_source.repo_slug.split("/")
         @api = BitbucketServerAPI.new(project, slug, ci_source.pull_request_id, environment)
+        @code_insights = CodeInsightsAPI.new(project, slug, environment)
       end
 
       def validates_as_ci?
@@ -73,16 +84,42 @@ module Danger
       def update_pull_request!(warnings: [], errors: [], messages: [], markdowns: [], danger_id: "danger", new_comment: false, remove_previous_comments: false)
         delete_old_comments(danger_id: danger_id) if !new_comment || remove_previous_comments
 
-        comment = generate_description(warnings: warnings, errors: errors)
+        # If configured, send a Code Insights API to provide the PR with a quality report
+        # which includes inline code violations found by Danger as Annotations.
+        # If no inline violations occurred, an empty, successful (green) report will be sent.
+        if @code_insights.ready?
+          inline_violations = inline_violations_group(warnings: warnings, errors: errors, messages: messages)
+          inline_warnings = inline_violations[:warnings] || []
+          inline_errors = inline_violations[:errors] || []
+          inline_messages = inline_violations[:messages] || []
+
+          head_commit = self.pr_json[:fromRef][:latestCommit]
+          @code_insights.send_report(head_commit,
+                                     inline_warnings,
+                                     inline_errors,
+                                     inline_messages)
+        end
+
+        # If we're sending inline comments separately via Code Insights,
+        # the main body comment should contain only generic, non-file specific messages.
+        if @code_insights.ready?
+          main_violations = main_violations_group(warnings: warnings, errors: errors, messages: messages)
+          warnings = main_violations[:warnings] || []
+          errors = main_violations[:errors] || []
+          messages = main_violations[:messages] || []
+          markdowns = main_violations[:markdowns] || []
+        end
+
+        comment = generate_description(warnings: warnings,
+                                       errors: errors)
         comment += "\n\n"
         comment += generate_comment(warnings: warnings,
-                                     errors: errors,
-                                   messages: messages,
-                                  markdowns: markdowns,
-                        previous_violations: {},
-                                  danger_id: danger_id,
-                                   template: "bitbucket_server")
-
+                                    errors: errors,
+                                    messages: messages,
+                                    markdowns: markdowns,
+                                    previous_violations: {},
+                                    danger_id: danger_id,
+                                    template: "bitbucket_server")
         @api.post_comment(comment)
       end
 
@@ -91,7 +128,34 @@ module Danger
           @api.delete_comment(c[:id], c[:version]) if c[:text] =~ /generated_by_#{danger_id}/
         end
       end
-        
+
+      def main_violations_group(warnings: [], errors: [], messages: [], markdowns: [])
+        {
+          warnings: warnings.reject(&:inline?),
+          errors: errors.reject(&:inline?),
+          messages: messages.reject(&:inline?),
+          markdowns: markdowns.reject(&:inline?)
+        }
+      end
+
+      def inline_violations_group(warnings: [], errors: [], messages: [], markdowns: [])
+        cmp = proc do |a, b|
+          next -1 unless a.file && a.line
+          next 1 unless b.file && b.line
+
+          next a.line <=> b.line if a.file == b.file
+          next a.file <=> b.file
+        end
+
+        # Sort to group inline comments by file
+        {
+          warnings: warnings.select(&:inline?).sort(&cmp),
+          errors: errors.select(&:inline?).sort(&cmp),
+          messages: messages.select(&:inline?).sort(&cmp),
+          markdowns: markdowns.select(&:inline?).sort(&cmp)
+        }
+      end
+
       def update_pr_build_status(status, build_job_link, description)
         changeset = self.pr_json[:fromRef][:latestCommit]
         # Support for older versions of Bitbucket Server

data/lib/danger/request_sources/code_insights_api.rb

@@ -0,0 +1,147 @@
+# coding: utf-8
+
+module Danger
+  module RequestSources
+    #
+    # Provides ability for Danger to interact with Atlassian's Code Insights API in order to provide code quality
+    # reports along with inline comments for specific lines in specific files.
+    #  See https://developer.atlassian.com/server/bitbucket/how-tos/code-insights/ for more details.
+    #
+    # Currently this functionality is implemented only for Bitbucket Server request source.
+    class CodeInsightsAPI
+      attr_accessor :username, :password, :host, :report_key, :report_title, :report_description, :logo_url
+
+      def initialize(project, slug, environment)
+        @username = environment["DANGER_BITBUCKETSERVER_USERNAME"] || ""
+        @password = environment["DANGER_BITBUCKETSERVER_PASSWORD"] || ""
+        @host = environment["DANGER_BITBUCKETSERVER_HOST"] || ""
+        @report_key = environment["DANGER_BITBUCKETSERVER_CODE_INSIGHTS_REPORT_KEY"] || ""
+        @report_title = environment["DANGER_BITBUCKETSERVER_CODE_INSIGHTS_REPORT_TITLE"] || ""
+        @report_description = environment["DANGER_BITBUCKETSERVER_CODE_INSIGHTS_REPORT_DESCRIPTION"] || ""
+        @logo_url = environment["DANGER_BITBUCKETSERVER_CODE_INSIGHTS_REPORT_LOGO_URL"] || ""
+        @project = project
+        @slug = slug
+      end
+
+      def inspect
+        inspected = super
+
+        if @password
+          inspected = inspected.sub! @password, "********".freeze
+        end
+
+        inspected
+      end
+
+      def ready?
+        !(@report_key.empty? || @report_title.empty? || @report_description.empty? || @username.empty? || @password.empty? || @host.empty?)
+      end
+
+      def delete_report(commit)
+        uri = URI(report_endpoint_at_commit(commit))
+        request = Net::HTTP::Delete.new(uri.request_uri, {"Content-Type" => "application/json"})
+        request.basic_auth @username, @password
+        response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: use_ssl) do |http|
+          http.request(request)
+        end
+
+        # show failure when server returns an error
+        case response
+        when Net::HTTPClientError, Net::HTTPServerError
+          # HTTP 4xx - 5xx
+          abort "\nError deleting report from Code Insights API: #{response.code} (#{response.message}) - #{response.body}\n\n"
+        end
+
+      end
+
+      def send_report(commit, inline_warnings, inline_errors, inline_messages)
+        delete_report(commit)
+        put_report(commit, inline_errors.count)
+        should_post_annotations = !(inline_warnings + inline_errors + inline_messages).empty?
+        if should_post_annotations
+          post_annotations(commit, inline_warnings, inline_errors, inline_messages)
+        end
+      end
+
+      def put_report(commit, inline_errors_count)
+        uri = URI(report_endpoint_at_commit(commit))
+        request = Net::HTTP::Put.new(uri.request_uri, {"Content-Type" => "application/json"})
+        request.basic_auth @username, @password
+        request.body = {"title": @report_title,
+                        "details": @report_description,
+                        "result": (inline_errors_count > 0) ? "FAIL" : "PASS",
+                        "reporter": @username,
+                        "link": "https://github.com/danger/danger",
+                        "logoURL": @logo_url
+        }.to_json
+
+        response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: use_ssl) do |http|
+          http.request(request)
+        end
+
+        # show failure when server returns an error
+        case response
+        when Net::HTTPClientError, Net::HTTPServerError
+          # HTTP 4xx - 5xx
+          abort "\nError putting report to Code Insights API: #{response.code} (#{response.message}) - #{response.body}\n\n"
+        end
+      end
+
+      def post_annotations(commit, inline_warnings, inline_errors, inline_messages)
+        uri = URI(annotation_endpoint_at_commit(commit))
+
+        annotations = []
+
+        inline_messages.each do |violation|
+          annotations << violation_hash_with_severity(violation, "LOW")
+        end
+
+        inline_warnings.each do |violation|
+          annotations << violation_hash_with_severity(violation, "MEDIUM")
+        end
+
+        inline_errors.each do |violation|
+          annotations << violation_hash_with_severity(violation, "HIGH")
+        end
+
+        body = {annotations: annotations}.to_json
+        request = Net::HTTP::Post.new(uri.request_uri, {"Content-Type" => "application/json"})
+        request.basic_auth @username, @password
+        request.body = body
+
+        response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: use_ssl) do |http|
+          http.request(request)
+        end
+
+        # show failure when server returns an error
+        case response
+        when Net::HTTPClientError, Net::HTTPServerError
+          # HTTP 4xx - 5xx
+          abort "\nError posting comment to Code Insights API: #{response.code} (#{response.message}) - #{response.body}\n\n"
+        end
+      end
+
+      def violation_hash_with_severity(violation, severity)
+        annotation = {}
+        annotation["message"] = violation.message
+        annotation["severity"] = severity
+        annotation["path"] = violation.file
+        annotation["line"] = violation.line.to_i
+        return annotation
+      end
+
+      def report_endpoint_at_commit(commit)
+        "#{@host}/rest/insights/1.0/projects/#{@project}/repos/#{@slug}/commits/#{commit}/reports/#{@report_key}"
+      end
+
+      def annotation_endpoint_at_commit(commit)
+        report_endpoint_at_commit(commit) + "/annotations"
+      end
+
+      def use_ssl
+        @host.include? "https://"
+      end
+
+    end
+  end
+end

data/lib/danger/request_sources/github/github.rb

@@ -171,10 +171,10 @@ module Danger
           markdowns: markdowns
         )
 
-        rest_inline_violations = submit_inline_comments!({
+        rest_inline_violations = submit_inline_comments!(**{
           danger_id: danger_id,
           previous_violations: previous_violations
-        }.merge(**inline_violations))
+        }.merge(inline_violations))
 
         main_violations = merge_violations(
           regular_violations, rest_inline_violations
@@ -189,11 +189,11 @@ module Danger
 
         # If there are still violations to show
         if main_violations_sum.any?
-          body = generate_comment({
+          body = generate_comment(**{
             template: "github",
             danger_id: danger_id,
             previous_violations: previous_violations
-          }.merge(**main_violations))
+          }.merge(main_violations))
 
           comment_result =
             if should_create_new_comment

data/lib/danger/version.rb

@@ -1,4 +1,4 @@
 module Danger
-  VERSION = "8.0.6".freeze
+  VERSION = "8.1.0".freeze
   DESCRIPTION = "Like Unit Tests, but for your Team Culture.".freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: danger
 version: !ruby/object:Gem::Version
-  version: 8.0.6
+  version: 8.1.0
 platform: ruby
 authors:
 - Orta Therox
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-10-05 00:00:00.000000000 Z
+date: 2020-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: claide
@@ -301,6 +301,7 @@ files:
 - lib/danger/request_sources/bitbucket_cloud_api.rb
 - lib/danger/request_sources/bitbucket_server.rb
 - lib/danger/request_sources/bitbucket_server_api.rb
+- lib/danger/request_sources/code_insights_api.rb
 - lib/danger/request_sources/github/github.rb
 - lib/danger/request_sources/github/github_review.rb
 - lib/danger/request_sources/github/github_review_resolver.rb