danger 8.2.1 → 8.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3930680bc519ec86948df5375ea6ffad444929619c7faf3190e204eee827767b
-  data.tar.gz: 6ca8c826a895e9d0ef6bf66343e70110026a8a77fafddc6e72f26b129c37801d
+  metadata.gz: 691f7a26ea0a29f107e6f848bdf7450d2043dc15f5c385c136c1a9d818120c3f
+  data.tar.gz: d5f84a85ec8419dbbfbdcb742ffb15b5fe075d3bf1f676859152a0bb7b466633
 SHA512:
-  metadata.gz: '0267983777b8a27f5d90f6221655d18657a0c4ed6276e475631e4984eabbe2f5329ec8df774100052dfd1e6368082b9865fd1bd87956b538fa032042f1e1538d'
-  data.tar.gz: 700097f2571dd5cb9cac5b9f74d034a53a00e73f747d3aa489cb9cae83b86b85908281a3c910bec25a2299fd828449c9eb82f796d8865f84a0742a46488d2dd3
+  metadata.gz: b712f8566113397b952ebd93e33d1d42b38d1b1a9d04e678971c35feb46a5bfb057236b0ccffc250560df6b1da001fe31f848024de318850c93ecb6af6eb0994
+  data.tar.gz: c89ab31d3afe5d668046629643d65858d6eeeea3d5f67006170af38e9a8c31673789de472501d37ff923c41fb538193cce767ae9567ef4a9a474aca96cf4aad4

data/README.md

@@ -76,7 +76,7 @@ I'd strongly recommend using `bundle exec guard` to run your tests as you work.
 
 #### Debugging
 
-Ruby is super dynamic. One of the best ways to debug Ruby code is by using [pry](http://pryrepl.org/). We include pry for developers: when you have a problem, copy these two lines just before your problem and follow the instructions from "[I Want To Be A Danger Wizard](https://danger.systems/guides/troubleshooting.html#i-want-to-be-a-danger-wizard)."
+Ruby is super dynamic. One of the best ways to debug Ruby code is by using [pry](https://pry.github.io/). We include pry for developers: when you have a problem, copy these two lines just before your problem and follow the instructions from "[I Want To Be A Danger Wizard](https://danger.systems/guides/troubleshooting.html#i-want-to-be-a-danger-wizard)."
 
 ```ruby
 require 'pry'

data/lib/danger/ci_source/azure_pipelines.rb

@@ -19,7 +19,11 @@ module Danger
   #
   class AzurePipelines < CI
     def self.validates_as_ci?(env)
-      env.key? "AGENT_ID"
+      # AGENT_ID is being used by AppCenter as well, so checking here to make sure AppCenter CI doesn't get a false positive for AzurePipelines
+      # Anyone working with AzurePipelines could provide a better/truly unique env key to avoid checking for AppCenter
+      !Danger::Appcenter::validates_as_ci?(env) &&
+      env.key?("AGENT_ID") &&
+      env["BUILD_REPOSITORY_PROVIDER"] != "TfsGit"
     end
 
     def self.validates_as_pr?(env)

data/lib/danger/ci_source/buildkite.rb

@@ -45,7 +45,7 @@ module Danger
     end
 
     def supported_request_sources
-      @supported_request_sources ||= [Danger::RequestSources::GitHub, Danger::RequestSources::GitLab]
+      @supported_request_sources ||= [Danger::RequestSources::GitHub, Danger::RequestSources::GitLab, Danger::RequestSources::BitbucketServer]
     end
   end
 end

data/lib/danger/ci_source/codefresh.rb

@@ -31,23 +31,17 @@ module Danger
       @supported_request_sources ||= [Danger::RequestSources::GitHub]
     end
 
-    def repo_slug
-      return "" if @env["CF_REPO_OWNER"].to_s.empty?
-      return "" if @env["CF_REPO_NAME"].to_s.empty?
-      "#{@env['CF_REPO_OWNER']}/#{@env['CF_REPO_NAME']}".downcase!
-    end
-
-    def repo_url
-      return "" if @env["CF_COMMIT_URL"].to_s.empty?
-      @env["CF_COMMIT_URL"].gsub(/\/commit.+$/, "")
-    end
+    def self.slug_from(env)
+      return "" if env["CF_REPO_OWNER"].to_s.empty?
+      return "" if env["CF_REPO_NAME"].to_s.empty?
 
-    def pull_request_id
-      @env["CF_PULL_REQUEST_NUMBER"]
+      "#{env['CF_REPO_OWNER']}/#{env['CF_REPO_NAME']}".downcase!
     end
 
     def initialize(env)
-      @env = env
+      self.repo_url = env["CF_COMMIT_URL"].to_s.gsub(/\/commit.+$/, "")
+      self.repo_slug = self.class.slug_from(env)
+      self.pull_request_id = env["CF_PULL_REQUEST_NUMBER"]
     end
   end
 end

data/lib/danger/ci_source/codemagic.rb

@@ -0,0 +1,58 @@
+# https://docs.codemagic.io/building/environment-variables/
+
+module Danger
+  # ### CI Setup
+  #
+  # Add a script step to your workflow:
+  #
+  # ```
+  # - name: Running Danger
+  #   script: |
+  #     bundle install
+  #     bundle exec danger
+  # ```
+  #
+  # ### Token Setup
+  #
+  # Add the following environment variables to your workflow's environment configuration.
+  # https://docs.codemagic.io/getting-started/yaml/
+  #
+  # #### GitHub
+  # Add the `DANGER_GITHUB_API_TOKEN` to your build user's ENV.
+  #
+  # #### GitLab
+  # Add the `DANGER_GITLAB_API_TOKEN` to your build user's ENV.
+  #
+  # #### Bitbucket Cloud
+  # Add the `DANGER_BITBUCKETSERVER_USERNAME`, `DANGER_BITBUCKETSERVER_PASSWORD`
+  # to your build user's ENV.
+  #
+  # #### Bitbucket server
+  # Add the `DANGER_BITBUCKETSERVER_USERNAME`, `DANGER_BITBUCKETSERVER_PASSWORD`
+  # and `DANGER_BITBUCKETSERVER_HOST` to your build user's ENV.
+  #
+  class Codemagic < CI
+    def self.validates_as_ci?(env)
+      env.key? "FCI_PROJECT_ID"
+    end
+
+    def self.validates_as_pr?(env)
+      return !env["FCI_PULL_REQUEST_NUMBER"].to_s.empty?
+    end
+
+    def supported_request_sources
+      @supported_request_sources ||= [
+        Danger::RequestSources::GitHub,
+        Danger::RequestSources::GitLab,
+        Danger::RequestSources::BitbucketServer,
+        Danger::RequestSources::BitbucketCloud
+      ]
+    end
+
+    def initialize(env)
+      self.pull_request_id = env["FCI_PULL_REQUEST_NUMBER"]
+      self.repo_slug = env["FCI_REPO_SLUG"]
+      self.repo_url = GitRepo.new.origins # Codemagic doesn't provide a repo url env variable for n
+    end
+  end
+end

data/lib/danger/ci_source/gitlab_ci.rb

@@ -46,10 +46,17 @@ module Danger
       base_commit = env["CI_COMMIT_SHA"]
       client = RequestSources::GitLab.new(nil, env).client
 
-      if (Gem::Version.new(client.version.version) >= Gem::Version.new("10.7"))
+      client_version = Gem::Version.new(client.version.version)
+      if (client_version >= Gem::Version.new("10.7"))
         #Use the 'list merge requests associated with a commit' API, for speeed
         # (GET /projects/:id/repository/commits/:sha/merge_requests) available for GitLab >= 10.7
         merge_request = client.commit_merge_requests(project_path, base_commit, state: :opened).first
+        if (client_version >= Gem::Version.new("13.8"))
+          # Gitlab 13.8.0 started returning merge requests for merge commits and squashed commits
+          # By checking for merge_request.state, we can ensure danger only comments on MRs which are open
+          return 0 if merge_request.nil?
+          return 0 unless merge_request.state == "opened"
+        end
       else
         merge_requests = client.merge_requests(project_path, state: :opened)
         merge_request = merge_requests.auto_paginate.find do |mr|
@@ -59,9 +66,17 @@ module Danger
       merge_request.nil? ? 0 : merge_request.iid
     end
 
+    def self.slug_from(env)
+      if env["DANGER_PROJECT_REPO_URL"]
+        env["DANGER_PROJECT_REPO_URL"].split('/').last(2).join('/')
+      else
+        env["CI_MERGE_REQUEST_PROJECT_PATH"] || env["CI_PROJECT_PATH"]
+      end
+    end
+
     def initialize(env)
-      @env = env
-      @repo_slug = slug_from(env)
+      self.repo_slug = self.class.slug_from(env)
+      self.pull_request_id = self.class.determine_pull_or_merge_request_id(env)
     end
 
     def supported_request_sources
@@ -70,19 +85,5 @@ module Danger
         Danger::RequestSources::GitLab
       ]
     end
-
-    def pull_request_id
-      @pull_request_id ||= self.class.determine_pull_or_merge_request_id(@env)
-    end
-
-    private
-
-    def slug_from(env)
-      if env["DANGER_PROJECT_REPO_URL"]
-        env["DANGER_PROJECT_REPO_URL"].split('/').last(2).join('/')
-      else
-        env["CI_MERGE_REQUEST_PROJECT_PATH"] || env["CI_PROJECT_PATH"]
-      end
-    end
   end
 end

data/lib/danger/ci_source/jenkins.rb

@@ -133,7 +133,7 @@ module Danger
           matches = change_url.match(%r{(.+)\/pull\/[0-9]+})
           matches[1] unless matches.nil?
         when %r{\/merge_requests\/} # GitLab
-          matches = change_url.match(%r{(.+)\/merge_requests\/[0-9]+})
+          matches = change_url.match(%r{(.+?)(\/-)?\/merge_requests\/[0-9]+})
           matches[1] unless matches.nil?
         when %r{\/pull-requests\/} # Bitbucket
           matches = change_url.match(%r{(.+)\/pull-requests\/[0-9]+})

data/lib/danger/ci_source/local_git_repo.rb

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # For more info see: https://github.com/schacon/ruby-git
 
 require "git"
@@ -37,8 +38,8 @@ module Danger
     end
 
     def initialize(env = {})
-      @env = env
-
+      @remote_info = find_remote_info(env)
+      @found_pull_request = find_pull_request(env)
       self.repo_slug = remote_info.slug
       raise_error_for_missing_remote if remote_info.kind_of?(NoRepoInfo)
 
@@ -55,7 +56,7 @@ module Danger
 
     private
 
-    attr_reader :env
+    attr_reader :remote_info, :found_pull_request
 
     def raise_error_for_missing_remote
       raise missing_remote_error_message
@@ -66,45 +67,36 @@ module Danger
       "And the repository must host on GitHub.com or GitHub Enterprise."
     end
 
-    def remote_info
-      @_remote_info ||= begin
-        remote_info = begin
-          if given_pull_request_url?
-            FindRepoInfoFromURL.new(env["LOCAL_GIT_PR_URL"]).call
-          else
-            FindRepoInfoFromLogs.new(
-              env["DANGER_GITHUB_HOST"] || "github.com".freeze,
-              run_git("remote show origin -n".freeze)
-            ).call
-          end
-        end
-
-        remote_info || NoRepoInfo.new
-      end
+    def find_remote_info(env)
+      if given_pull_request_url?(env)
+        FindRepoInfoFromURL.new(env["LOCAL_GIT_PR_URL"]).call
+      else
+        FindRepoInfoFromLogs.new(
+          env["DANGER_GITHUB_HOST"] || "github.com",
+          run_git("remote show origin -n")
+        ).call
+      end || NoRepoInfo.new
     end
 
-    def found_pull_request
-      @_found_pull_request ||= begin
-        if given_pull_request_url?
-          PullRequestFinder.new(
-            remote_info.id,
-            remote_info.slug,
-            remote: true,
-            remote_url: env["LOCAL_GIT_PR_URL"],
-            env: env
-          ).call
-        else
-          PullRequestFinder.new(
-            env.fetch("LOCAL_GIT_PR_ID") { "".freeze },
-            remote_info.slug,
-            remote: false,
-            git_logs: run_git("log --oneline -1000000".freeze)
-          ).call
-        end
+    def find_pull_request(env)
+      if given_pull_request_url?(env)
+        PullRequestFinder.new(
+          remote_info.id,
+          remote_info.slug,
+          remote: true,
+          remote_url: env["LOCAL_GIT_PR_URL"]
+        ).call(env: env)
+      else
+        PullRequestFinder.new(
+          env.fetch("LOCAL_GIT_PR_ID") { "" },
+          remote_info.slug,
+          remote: false,
+          git_logs: run_git("log --oneline -1000000")
+        ).call(env: env)
       end
     end
 
-    def given_pull_request_url?
+    def given_pull_request_url?(env)
       env["LOCAL_GIT_PR_URL"] && !env["LOCAL_GIT_PR_URL"].empty?
     end
 

data/lib/danger/ci_source/local_only_git_repo.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "git"
 require "danger/request_sources/local_only"
 
@@ -9,8 +11,8 @@ module Danger
   #
   class LocalOnlyGitRepo < CI
     attr_accessor :base_commit, :head_commit
-    HEAD_VAR = "DANGER_LOCAL_HEAD".freeze
-    BASE_VAR = "DANGER_LOCAL_BASE".freeze
+    HEAD_VAR = "DANGER_LOCAL_HEAD"
+    BASE_VAR = "DANGER_LOCAL_BASE"
 
     def self.validates_as_ci?(env)
       env.key? "DANGER_USE_LOCAL_ONLY_GIT"
@@ -33,15 +35,9 @@ module Danger
     end
 
     def initialize(env = {})
-      @env = env
-
       # expects --base/--head specified OR origin/master to be base and HEAD head
       self.base_commit = env[BASE_VAR] || run_git("rev-parse --abbrev-ref origin/master")
       self.head_commit = env[HEAD_VAR] || run_git("rev-parse --abbrev-ref HEAD")
     end
-
-    private
-
-    attr_reader :env
   end
 end

data/lib/danger/ci_source/support/commits.rb

@@ -1,17 +1,19 @@
-class Commits
-  def initialize(base_head)
-    @base_head = base_head.strip.split(" ".freeze)
-  end
+module Danger
+  class Commits
+    def initialize(base_head)
+      @base_head = base_head.strip.split(" ".freeze)
+    end
 
-  def base
-    base_head.first
-  end
+    def base
+      base_head.first
+    end
 
-  def head
-    base_head.last
-  end
+    def head
+      base_head.last
+    end
 
-  private
+    private
 
-  attr_reader :base_head
+    attr_reader :base_head
+  end
 end

data/lib/danger/ci_source/support/pull_request_finder.rb

@@ -1,67 +1,65 @@
+# frozen_string_literal: true
+
 require "danger/ci_source/support/local_pull_request"
 require "danger/ci_source/support/remote_pull_request"
 require "danger/ci_source/support/no_pull_request"
 
 module Danger
   class PullRequestFinder
-    def initialize(specific_pull_request_id, repo_slug = nil, remote: false, git_logs: "", remote_url: "", env: nil)
+    def initialize(specific_pull_request_id, repo_slug = nil, remote: false, git_logs: "", remote_url: "")
       @specific_pull_request_id = specific_pull_request_id
       @git_logs = git_logs
       @repo_slug = repo_slug
       @remote = to_boolean(remote)
       @remote_url = remote_url
-      @env = env
     end
 
-    def call
-      check_if_any_pull_request!
-
-      pull_request
+    def call(env: nil)
+      find_pull_request(env).tap do |pull_request|
+        raise_pull_request_not_found!(pull_request) unless pull_request.valid?
+      end
     end
 
     private
 
-    attr_reader :specific_pull_request_id, :git_logs, :repo_slug, :remote, :remote_url, :env
+    attr_reader :specific_pull_request_id, :git_logs, :repo_slug, :remote, :remote_url
 
     def to_boolean(maybe_string)
       ["true", "1", "yes", "y", true].include?(maybe_string)
     end
 
-    def check_if_any_pull_request!
-      unless pull_request.valid?
-        if !specific_pull_request_id.empty?
-          raise "Could not find the Pull Request (#{specific_pull_request_id}) inside the git history for this repo."
-        else
-          raise "No recent Pull Requests found for this repo, danger requires at least one Pull Request for the local mode.".freeze
-        end
+    def raise_pull_request_not_found!(pull_request)
+      if specific_pull_request_id.empty?
+        raise "No recent Pull Requests found for this repo, danger requires at least one Pull Request for the local mode."
+      else
+        raise "Could not find the Pull Request (#{specific_pull_request_id}) inside the git history for this repo."
       end
     end
 
     # @return [String] Log line of most recent merged Pull Request
-    def pull_request
-      @pull_request ||= begin
-        return if pull_request_ref.empty?
-
-        if both_present?
-          LocalPullRequest.new(pick_the_most_recent_one_from_two_matches)
-        elsif only_merged_pull_request_present?
-          LocalPullRequest.new(most_recent_merged_pull_request)
-        elsif only_squash_and_merged_pull_request_present?
-          LocalPullRequest.new(most_recent_squash_and_merged_pull_request)
-        elsif remote && remote_pull_request
-          generate_remote_pull_request
-        else
-          NoPullRequest.new
-        end
+    def find_pull_request(env)
+      return if pull_request_ref.empty?
+
+      if both_present?
+        LocalPullRequest.new(pick_the_most_recent_one_from_two_matches)
+      elsif only_merged_pull_request_present?
+        LocalPullRequest.new(most_recent_merged_pull_request)
+      elsif only_squash_and_merged_pull_request_present?
+        LocalPullRequest.new(most_recent_squash_and_merged_pull_request)
+      elsif remote
+        remote_pull_request = find_remote_pull_request(env)
+        remote_pull_request ? generate_remote_pull_request(remote_pull_request) : NoPullRequest.new
+      else
+        NoPullRequest.new
       end
     end
 
     # @return [String] "#42"
     def pull_request_ref
-      !specific_pull_request_id.empty? ? "##{specific_pull_request_id}" : "#\\d+".freeze
+      !specific_pull_request_id.empty? ? "##{specific_pull_request_id}" : "#\\d+"
     end
 
-    def generate_remote_pull_request
+    def generate_remote_pull_request(remote_pull_request)
       scm_provider = find_scm_provider(remote_url)
 
       case scm_provider
@@ -88,10 +86,8 @@ module Danger
       end
     end
 
-    def remote_pull_request
-      @_remote_pull_request ||= begin
-        client.pull_request(repo_slug, specific_pull_request_id)
-      end
+    def find_remote_pull_request(env)
+      client(env).pull_request(repo_slug, specific_pull_request_id)
     end
 
     def both_present?
@@ -135,9 +131,9 @@ module Danger
       !most_recent_squash_and_merged_pull_request.nil? && !most_recent_squash_and_merged_pull_request.empty?
     end
 
-    def client
+    def client(env)
       scm_provider = find_scm_provider(remote_url)
-    
+
       case scm_provider
       when :bitbucket_cloud
         require "danger/request_sources/bitbucket_cloud_api"
@@ -151,8 +147,15 @@ module Danger
 
       when :github
         require "octokit"
-        Octokit::Client.new(access_token: ENV["DANGER_GITHUB_API_TOKEN"], api_endpoint: api_url)
-
+        access_token = ENV["DANGER_GITHUB_API_TOKEN"]
+        bearer_token = ENV["DANGER_GITHUB_BEARER_TOKEN"]
+        if bearer_token && !bearer_token.empty?
+          Octokit::Client.new(bearer_token: bearer_token, api_endpoint: api_url)
+        elsif access_token && !access_token.empty?
+          Octokit::Client.new(access_token: access_token, api_endpoint: api_url)
+        else
+          raise "No API token given, please provide one using `DANGER_GITHUB_API_TOKEN` or `DANGER_GITHUB_BEARER_TOKEN`"
+        end
       else
         raise "SCM provider not supported: #{scm_provider}"
       end
@@ -161,7 +164,7 @@ module Danger
     def api_url
       ENV.fetch("DANGER_GITHUB_API_HOST") do
         ENV.fetch("DANGER_GITHUB_API_BASE_URL") do
-          "https://api.github.com/".freeze
+          "https://api.github.com/"
         end
       end
     end

data/lib/danger/ci_source/xcode_cloud.rb

@@ -0,0 +1,38 @@
+module Danger
+  # ### CI Setup
+  #
+  # In order to work with Xcode Cloud and Danger, you will need to add `bundle exec danger` to 
+  # the `ci_scripts/ci_post_xcodebuild.sh` (Xcode Cloud's expected filename for a post-action build script).
+  # More details and documentation on Xcode Cloud configuration can be found [here](https://developer.apple.com/documentation/xcode/writing-custom-build-scripts).
+  # 
+  # ### Token Setup
+  #
+  # You will need to add the `DANGER_GITHUB_API_TOKEN` to your build environment. 
+  # If running on GitHub Enterprise, make sure you also set the expected values for 
+  # both `DANGER_GITHUB_API_HOST` and `DANGER_GITHUB_HOST`.
+  #  
+  class XcodeCloud < CI
+    def self.validates_as_ci?(env)
+      env.key? "CI_XCODEBUILD_ACTION"
+    end
+
+    def self.validates_as_pr?(env)
+      env.key? "CI_PULL_REQUEST_NUMBER"
+    end
+
+    def supported_request_sources
+      @supported_request_sources ||= [
+        Danger::RequestSources::GitHub,
+        Danger::RequestSources::GitLab, 
+        Danger::RequestSources::BitbucketCloud, 
+        Danger::RequestSources::BitbucketServer
+      ]
+    end
+
+    def initialize(env)
+      self.repo_slug = env["CI_PULL_REQUEST_SOURCE_REPO"]
+      self.pull_request_id = env["CI_PULL_REQUEST_NUMBER"]
+      self.repo_url = env["CI_PULL_REQUEST_HTML_URL"]
+    end
+  end
+end

data/lib/danger/commands/dangerfile/init.rb

@@ -4,7 +4,7 @@ require "danger/danger_core/dangerfile_generator"
 
 module Danger
   class DangerfileCommand < Runner
-    self.summary = "Easily create you Dangerfiles."
+    self.summary = "Easily create your Dangerfiles."
     self.command = "dangerfile"
 
     self.abstract_command = true

data/lib/danger/commands/pr.rb

@@ -67,7 +67,8 @@ module Danger
           @dangerfile_path,
           nil,
           nil,
-          nil
+          nil,
+          false
         )
       end
     end

data/lib/danger/comment_generators/gitlab_inline.md.erb

@@ -17,10 +17,5 @@
 <%= current %>
 <%# the previous line has to be aligned far to the left, otherwise markdown can break easily %>
 <%- end -%>
-<%# We need to add the generated_by_ to identify comments from danger. But with inlines %>
-<%# it might be a little annoying, so we set on the table, but if we have markdown we add the footer anyway %>
-<%- if @markdowns.count > 0 -%>
-<p align="right" data-meta="generated_by_<%= @danger_id %>">
-  Generated by :no_entry_sign: <a href="http://danger.systems/">Danger</a>
-</p>
-<%- end -%>
+<%# Add the generated_by_ as a html coment to identify comments from danger. %>
+<!-- "generated_by_<%= @danger_id %>" -->

data/lib/danger/comment_generators/vsts_inline.md.erb

@@ -0,0 +1,17 @@
+<%- @tables.each do |table| -%>
+  <%- if table[:content].any? || table[:resolved].any? -%>
+| | |
+|---|---|
+    <%- table[:content].each do |violation| -%>
+| <%= @emoji_mapper.map(table[:emoji]) %> | <%= "~~" if table[:resolved] %><%= violation.message %><%= "~~" if table[:resolved] %> |
+    <%- end -%>
+
+  <%- end -%>
+<%- end -%>
+
+<%- @markdowns.each do |current| -%>
+<%= current %>
+<%# the previous line has to be aligned far to the left, otherwise markdown can break easily %>
+<%- end -%>
+
+Generated by :no_entry_sign: [Danger](https://danger.systems/ "generated_by_<%= @danger_id %>")