danger 3.4.2 → 4.0.0

data/lib/danger/commands/pr.rb

@@ -0,0 +1,119 @@
+require "danger/commands/local_helpers/http_cache"
+require "faraday/http_cache"
+require "fileutils"
+require "octokit"
+require "tmpdir"
+
+module Danger
+  class PR < Runner
+    self.summary = "Run the Dangerfile against Pull Requests (works with forks, too).".freeze
+    self.command = "pr".freeze
+
+    def self.options
+      [
+        ["--clear-http-cache", "Clear the local http cache before running Danger locally."],
+        ["--pry", "Drop into a Pry shell after evaluating the Dangerfile."],
+        ["--dangerfile=<path/to/dangerfile>", "The location of your Dangerfile"]
+      ]
+    end
+
+    def initialize(argv)
+      @pr_url = argv.shift_argument
+      @clear_http_cache = argv.flag?("clear-http-cache", false)
+      dangerfile = argv.option("dangerfile", "Dangerfile")
+
+      super
+
+      @dangerfile_path = dangerfile if File.exist?(dangerfile)
+
+      setup_pry if should_pry?(argv)
+    end
+
+    def should_pry?(argv)
+      argv.flag?("pry", false) && !@dangerfile_path.empty? && validate_pry_available
+    end
+
+    def setup_pry
+      File.delete "_Dangerfile.tmp" if File.exist? "_Dangerfile.tmp"
+      FileUtils.cp @dangerfile_path, "_Dangerfile.tmp"
+      File.open("_Dangerfile.tmp", "a") do |f|
+        f.write("binding.pry; File.delete(\"_Dangerfile.tmp\")")
+      end
+      @dangerfile_path = "_Dangerfile.tmp"
+    end
+
+    def validate_pry_available
+      require "pry"
+    rescue LoadError
+      cork.warn "Pry was not found, and is required for 'danger pr --pry'."
+      cork.print_warnings
+      abort
+    end
+
+    def validate!
+      super
+      unless @dangerfile_path
+        help! "Could not find a Dangerfile."
+      end
+    end
+
+    def run
+      ENV["DANGER_USE_LOCAL_GIT"] = "YES"
+      ENV["LOCAL_GIT_PR_URL"] = @pr_url if @pr_url
+
+      # setup caching for Github calls to hitting the API rate limit too quickly
+      cache_file = File.join(ENV["DANGER_TMPDIR"] || Dir.tmpdir, "danger_local_cache")
+      cache = HTTPCache.new(cache_file, clear_cache: @clear_http_cache)
+      Octokit.middleware = Faraday::RackBuilder.new do |builder|
+        builder.use Faraday::HttpCache, store: cache, serializer: Marshal, shared_cache: false
+        builder.use Octokit::Response::RaiseError
+        builder.adapter Faraday.default_adapter
+      end
+
+      env = EnvironmentManager.new(ENV, cork)
+      dm = Dangerfile.new(env, cork)
+      dm.init_plugins
+
+      source = dm.env.ci_source
+      if source.nil? or source.repo_slug.empty?
+        cork.puts "danger pr failed because it only works with GitHub projects at the moment. Sorry.".red
+        exit 0
+      end
+
+      gh = dm.env.request_source
+
+      cork.puts "Running your Dangerfile against this PR - https://#{gh.host}/#{source.repo_slug}/pull/#{source.pull_request_id}"
+
+      if verbose != true
+        cork.puts "Turning on --verbose"
+        dm.verbose = true
+      end
+
+      cork.puts
+
+      # We can use tokenless here, as it's running on someone's computer
+      # and is IP locked, as opposed to on the CI.
+      gh.support_tokenless_auth = true
+
+      begin
+        gh.fetch_details
+      rescue Octokit::NotFound
+        cork.puts "Local repository was not found on GitHub. If you're trying to test a private repository please provide a valid API token through " + "DANGER_GITHUB_API_TOKEN".yellow + " environment variable."
+        return
+      end
+
+      dm.env.request_source = gh
+
+      begin
+        dm.env.fill_environment_vars
+        dm.env.ensure_danger_branches_are_setup
+        dm.env.scm.diff_for_folder(".", from: Danger::EnvironmentManager.danger_base_branch, to: Danger::EnvironmentManager.danger_head_branch)
+
+        dm.parse(Pathname.new(@dangerfile_path))
+        dm.print_results
+      ensure
+        dm.env.clean_up
+      end
+    end
+  end
+end

data/lib/danger/commands/runner.rb

@@ -3,6 +3,7 @@ module Danger
     require "danger/commands/init"
     require "danger/commands/local"
     require "danger/commands/systems"
+    require "danger/commands/pr"
 
     # manually set claide plugins as a subcommand
     require "claide_plugin"
@@ -19,6 +20,9 @@ module Danger
     require "danger/commands/plugins/plugin_json"
     require "danger/commands/plugins/plugin_readme"
 
+    require "danger/commands/dangerfile/init"
+    require "danger/commands/dangerfile/gem"
+
     attr_accessor :cork
 
     self.summary = "Run the Dangerfile."
@@ -33,6 +37,7 @@ module Danger
       @base = argv.option("base")
       @head = argv.option("head")
       @fail_on_errors = argv.option("fail-on-errors", false)
+      @new_comment = argv.flag?("new-comment")
       @danger_id = argv.option("danger_id", "danger")
       @cork = Cork::Board.new(silent: argv.option("silent", false),
                               verbose: argv.option("verbose", false))
@@ -52,7 +57,8 @@ module Danger
         ["--head=[master|dev|stable]", "A branch/tag/commit to use as the head"],
         ["--fail-on-errors=<true|false>", "Should always fail the build process, defaults to false"],
         ["--dangerfile=<path/to/dangerfile>", "The location of your Dangerfile"],
-        ["--danger_id=<id>", "The identifier of this Danger instance"]
+        ["--danger_id=<id>", "The identifier of this Danger instance"],
+        ["--new-comment", "Makes Danger post a new comment instead of editing it's previous one"]
       ].concat(super)
     end
 
@@ -62,6 +68,7 @@ module Danger
         head: @head,
         dangerfile_path: @dangerfile_path,
         danger_id: @danger_id,
+        new_comment: @new_comment,
         fail_on_errors: @fail_on_errors
       )
     end

data/lib/danger/commands/systems.rb

@@ -16,10 +16,12 @@ module Danger
       require "yard"
       # Pull out all the Danger::CI subclasses docs
       registry = YARD::Registry.load(ci_source_paths, true)
-      ci_sources = registry.all(:class)
-                           .select { |klass| klass.inheritance_tree.map(&:name).include? :CI }
-                           .reject { |source| source.name == :CI }
-                           .reject { |source| source.name == :LocalGitRepo }
+      ci_sources = begin
+        registry.all(:class)
+          .select { |klass| klass.inheritance_tree.map(&:name).include? :CI }
+          .reject { |source| source.name == :CI }
+          .reject { |source| source.name == :LocalGitRepo }
+      end
 
       # Fail if anything is added and not documented
       cis_without_docs = ci_sources.select { |source| source.base_docstring.empty? }

data/lib/danger/danger_core/dangerfile.rb

@@ -122,12 +122,15 @@ module Danger
           when :api
             value = "Octokit::Client"
 
-          when :pr_json
-            value = "[Skipped]"
+          when :pr_json, :mr_json
+            value = "[Skipped JSON]"
+
+          when :pr_diff, :mr_diff
+            value = "[Skipped Diff]"
 
           else
             value = plugin.send(method)
-            value = wrap_text(value) if value.kind_of?(String)
+            value = wrap_text(value.encode("utf-8")) if value.kind_of?(String)
             # So that we either have one value per row
             # or we have [] for an empty array
             value = value.join("\n") if value.kind_of?(Array) && value.count > 0
@@ -238,7 +241,7 @@ module Danger
       violation_report[:errors].count > 0
     end
 
-    def post_results(danger_id)
+    def post_results(danger_id, new_comment)
       violations = violation_report
 
       env.request_source.update_pull_request!(
@@ -246,7 +249,8 @@ module Danger
         errors: violations[:errors],
         messages: violations[:messages],
         markdowns: status_report[:markdowns],
-        danger_id: danger_id
+        danger_id: danger_id,
+        new_comment: new_comment
       )
     end
 
@@ -255,7 +259,7 @@ module Danger
       env.scm.diff_for_folder(".".freeze, from: base_branch, to: head_branch)
     end
 
-    def run(base_branch, head_branch, dangerfile_path, danger_id)
+    def run(base_branch, head_branch, dangerfile_path, danger_id, new_comment)
       # Setup internal state
       init_plugins
       env.fill_environment_vars
@@ -270,7 +274,7 @@ module Danger
         # Push results to the API
         # Pass along the details of the run to the request source
         # to send back to the code review site.
-        post_results(danger_id)
+        post_results(danger_id, new_comment)
 
         # Print results in the terminal
         print_results

data/lib/danger/danger_core/dangerfile_generator.rb

@@ -0,0 +1,11 @@
+module Danger
+  class DangerfileGenerator
+    # returns the string for a Dangerfile based on a folder's contents'
+    def self.create_dangerfile(_path, _ui)
+      # Use this template for now, but this is a really ripe place to
+      # improve now!
+      dir = Danger.gem_path
+      File.read(File.join(dir, "lib", "assets", "DangerfileTemplate"))
+    end
+  end
+end

data/lib/danger/danger_core/environment_manager.rb

@@ -39,7 +39,7 @@ module Danger
         self.request_source = request_source
       end
 
-      raise_error_for_no_request_source(env, ui) unless self.request_source
+      raise_error_for_no_request_source(env, self.ui) unless self.request_source
       self.scm = self.request_source.scm
     end
 

data/lib/danger/danger_core/executor.rb

@@ -11,6 +11,7 @@ module Danger
             head: nil,
             dangerfile_path: nil,
             danger_id: nil,
+            new_comment: nil,
             fail_on_errors: nil)
       # Create a silent Cork instance if cork is nil, as it's likely a test
       cork ||= Cork::Board.new(silent: false, verbose: false)
@@ -27,7 +28,8 @@ module Danger
           base_branch(base),
           head_branch(head),
           dangerfile_path,
-          danger_id
+          danger_id,
+          new_comment
         )
       end
 

data/lib/danger/danger_core/plugins/dangerfile_gitlab_plugin.rb

@@ -28,15 +28,15 @@ module Danger
   #
   #          fail "Please re-submit this MR to develop, we may have already fixed your issue." if gitlab.branch_for_merge != "develop"
   #
-  # @example Note when MRs don't reference a milestone, which goes away when it does.
+  # @example Note when MRs don't reference a milestone, make the warning stick around on subsequent runs
   #
   #          has_milestone = gitlab.mr_json["milestone"] != nil
-  #          warn("This MR does not refer to an existing milestone", sticky: false) unless has_milestone
+  #          warn("This MR does not refer to an existing milestone", sticky: true) unless has_milestone
   #
-  # @example Note when a MR cannot be manually merged, which goes away when you can.
+  # @example Note when a MR cannot be manually merged
   #
   #          can_merge = gitlab.mr_json["mergeable"]
-  #          warn("This MR cannot be merged yet.", sticky: false) unless can_merge
+  #          warn("This MR cannot be merged yet.") unless can_merge
   #
   # @example Highlight when a celebrity makes a merge request.
   #

data/lib/danger/danger_core/plugins/dangerfile_messaging_plugin.rb

@@ -8,14 +8,15 @@ module Danger
   #
   # The message within which Danger communicates back is amended on each run in a session.
   #
-  # Each of `message`, `warn` and `fail` have a `sticky` flag, `true` by default, which
-  # means that the message will be crossed out instead of being removed. If it's not use on
-  # subsequent runs.
+  # Each of `message`, `warn` and `fail` have a `sticky` flag, `false` by default, which
+  # when `true` means that the message will be crossed out instead of being removed.
+  # If it's not called again on subsequent runs.
   #
   # By default, using `fail` would fail the corresponding build. Either via an API call, or
-  # via the return value for the danger command.
+  # via the return value for the danger command. If you have linters with errors for this call
+  # you can use `messaging.fail` instead.
   #
-  # It is possible to have Danger ignore specific warnings or errors by writing `Danger: Ignore "[warning/error text]`.
+  # It is possible to have Danger ignore specific warnings or errors by writing `Danger: Ignore "[warning/error text]"`.
   #
   # Sidenote: Messaging is the only plugin which adds functions to the root of the Dangerfile.
   #
@@ -23,9 +24,9 @@ module Danger
   #
   #          fail "This build didn't pass tests"
   #
-  # @example Failing a build, but not keeping its value around on subsequent runs
+  # @example Failing a build, and note that on subsequent runs
   #
-  #          fail("This build didn't pass tests", sticky: false)
+  #          fail("This build didn't pass tests", sticky: true)
   #
   # @example Passing a warning
   #
@@ -87,14 +88,14 @@ module Danger
     #           The message to present to the user
     # @param    [Boolean] sticky
     #           Whether the message should be kept after it was fixed,
-    #           defaults to `true`.
+    #           defaults to `false`.
     # @param    [String] file
     #           Optional. Path to the file that the message is for.
     # @param    [String] line
     #           Optional. The line in the file to present the message in.
     # @return   [void]
     #
-    def message(message, sticky: true, file: nil, line: nil)
+    def message(message, sticky: false, file: nil, line: nil)
       @messages << Violation.new(message, sticky, file, line)
     end
 
@@ -105,14 +106,14 @@ module Danger
     #           The message to present to the user
     # @param    [Boolean] sticky
     #           Whether the message should be kept after it was fixed,
-    #           defaults to `true`.
+    #           defaults to `false`.
     # @param    [String] file
     #           Optional. Path to the file that the message is for.
     # @param    [String] line
     #           Optional. The line in the file to present the message in.
     # @return   [void]
     #
-    def warn(message, sticky: true, file: nil, line: nil)
+    def warn(message, sticky: false, file: nil, line: nil)
       return if should_ignore_violation(message)
       @warnings << Violation.new(message, sticky, file, line)
     end
@@ -124,14 +125,14 @@ module Danger
     #           The message to present to the user
     # @param    [Boolean] sticky
     #           Whether the message should be kept after it was fixed,
-    #           defaults to `true`.
+    #           defaults to `false`.
     # @param    [String] file
     #           Optional. Path to the file that the message is for.
     # @param    [String] line
     #           Optional. The line in the file to present the message in.
     # @return   [void]
     #
-    def fail(message, sticky: true, file: nil, line: nil)
+    def fail(message, sticky: false, file: nil, line: nil)
       return if should_ignore_violation(message)
       @errors << Violation.new(message, sticky, file, line)
     end

data/lib/danger/request_sources/github.rb

@@ -3,6 +3,8 @@ require "octokit"
 require "danger/helpers/comments_helper"
 require "danger/helpers/comment"
 
+require "danger/request_sources/support/get_ignored_violation"
+
 module Danger
   module RequestSources
     class GitHub < RequestSource
@@ -83,13 +85,11 @@ module Danger
         end
 
         fetch_issue_details(self.pr_json)
-        self.ignored_violations = ignored_violations_from_pr(self.pr_json)
+        self.ignored_violations = ignored_violations_from_pr
       end
 
-      def ignored_violations_from_pr(pr_json)
-        pr_body = pr_json["body"]
-        return [] if pr_body.nil?
-        pr_body.chomp.scan(/>\s*danger\s*:\s*ignore\s*"(.*)"/i).flatten
+      def ignored_violations_from_pr
+        GetIgnoredViolation.new(self.pr_json["body"]).call
       end
 
       def fetch_issue_details(pr_json)
@@ -98,20 +98,23 @@ module Danger
       end
 
       def issue_comments
-        @comments ||= client.issue_comments(ci_source.repo_slug, ci_source.pull_request_id)
-                            .map { |comment| Comment.from_github(comment) }
+        @comments ||= begin
+          client.issue_comments(ci_source.repo_slug, ci_source.pull_request_id)
+            .map { |comment| Comment.from_github(comment) }
+        end
       end
 
       # Sending data to GitHub
-      def update_pull_request!(warnings: [], errors: [], messages: [], markdowns: [], danger_id: "danger")
+      def update_pull_request!(warnings: [], errors: [], messages: [], markdowns: [], danger_id: "danger", new_comment: false)
         comment_result = {}
         editable_comments = issue_comments.select { |comment| comment.generated_by_danger?(danger_id) }
+        last_comment = editable_comments.last
+        should_create_new_comment = new_comment || last_comment.nil?
 
-        if editable_comments.empty?
+        if should_create_new_comment
           previous_violations = {}
         else
-          comment = editable_comments.first.body
-          previous_violations = parse_comment(comment)
+          previous_violations = parse_comment(last_comment.body)
         end
 
         main_violations = (warnings + errors + messages + markdowns).reject(&:inline?)
@@ -152,11 +155,10 @@ module Danger
                                   danger_id: danger_id,
                                   template: "github")
 
-          if editable_comments.empty?
+          if should_create_new_comment
             comment_result = client.add_comment(ci_source.repo_slug, ci_source.pull_request_id, body)
           else
-            original_id = editable_comments.first.id
-            comment_result = client.update_comment(ci_source.repo_slug, original_id, body)
+            comment_result = client.update_comment(ci_source.repo_slug, last_comment.id, body)
           end
         end
 
@@ -197,6 +199,7 @@ module Danger
             end
           else
             puts message
+            puts "\nDanger does not have write access to the PR to set a PR status.".yellow
           end
         end
       end

data/lib/danger/request_sources/gitlab.rb

@@ -1,8 +1,9 @@
 # coding: utf-8
-require "gitlab"
 require "danger/helpers/comments_helper"
 require "danger/helpers/comment"
 
+require "danger/request_sources/support/get_ignored_violation"
+
 module Danger
   module RequestSources
     class GitLab < RequestSource
@@ -27,10 +28,19 @@ module Danger
       def client
         token = @environment["DANGER_GITLAB_API_TOKEN"]
         raise "No API token given, please provide one using `DANGER_GITLAB_API_TOKEN`" unless token
+
+        # The require happens inline so that it won't cause exceptions when just using the `danger` gem.
+        require "gitlab"
+
         params = { private_token: token }
         params[:endpoint] = endpoint
 
         @client ||= Gitlab.client(params)
+
+      rescue LoadError
+        puts "The GitLab gem was not installed, you will need to change your Gem from `danger` to `danger-gitlab`.".red
+        puts "\n - See https://github.com/danger/danger/blob/master/CHANGELOG.md#400"
+        abort
       end
 
       def validates_as_api_source?
@@ -55,13 +65,17 @@ module Danger
       end
 
       def mr_comments
-        @comments ||= client.merge_request_comments(escaped_ci_slug, ci_source.pull_request_id)
-                            .map { |comment| Comment.from_gitlab(comment) }
+        @comments ||= begin
+          client.merge_request_comments(escaped_ci_slug, ci_source.pull_request_id)
+            .map { |comment| Comment.from_gitlab(comment) }
+        end
       end
 
       def mr_diff
-        @mr_diff ||= client.merge_request_changes(escaped_ci_slug, ci_source.pull_request_id)
-                           .changes.map { |change| change["diff"] }.join("\n")
+        @mr_diff ||= begin
+          client.merge_request_changes(escaped_ci_slug, ci_source.pull_request_id)
+            .changes.map { |change| change["diff"] }.join("\n")
+        end
       end
 
       def escaped_ci_slug
@@ -84,19 +98,19 @@ module Danger
       def fetch_details
         self.mr_json = client.merge_request(escaped_ci_slug, self.ci_source.pull_request_id)
         self.commits_json = client.merge_request_commits(escaped_ci_slug, self.ci_source.pull_request_id)
-        self.ignored_violations = ignored_violations_from_pr(self.mr_json)
+        self.ignored_violations = ignored_violations_from_pr
       end
 
-      def ignored_violations_from_pr(mr_json)
-        pr_body = mr_json.description
-        return [] if pr_body.nil?
-        pr_body.chomp.scan(/>\s*danger\s*:\s*ignore\s*"(.*)"/i).flatten
+      def ignored_violations_from_pr
+        GetIgnoredViolation.new(self.mr_json.description).call
       end
 
-      def update_pull_request!(warnings: [], errors: [], messages: [], markdowns: [], danger_id: "danger")
+      def update_pull_request!(warnings: [], errors: [], messages: [], markdowns: [], danger_id: "danger", new_comment: false)
         editable_comments = mr_comments.select { |comment| comment.generated_by_danger?(danger_id) }
 
-        if editable_comments.empty?
+        should_create_new_comment = new_comment || editable_comments.empty?
+
+        if should_create_new_comment
           previous_violations = {}
         else
           comment = editable_comments.first.body

data/lib/danger/request_sources/support/get_ignored_violation.rb

@@ -0,0 +1,17 @@
+class GetIgnoredViolation
+  IGNORE_REGEXP = />*\s*danger\s*:\s*ignore\s*"(?<error>[^"]*)"/i
+
+  def initialize(body)
+    @body = body
+  end
+
+  def call
+    return [] unless body
+
+    body.chomp.scan(IGNORE_REGEXP).flatten
+  end
+
+  private
+
+  attr_reader :body
+end

data/lib/danger/scm_source/git_repo.rb

@@ -12,10 +12,10 @@ module Danger
 
       ensure_commitish_exists!(from)
       ensure_commitish_exists!(to)
-      merge_base = repo.merge_base(from, to)
 
-      ensure_commitish_exists!(merge_base)
-      self.diff = repo.diff(merge_base.to_s, to)
+      merge_base = find_merge_base(repo, from, to)
+
+      self.diff = repo.diff(merge_base, to)
       self.log = repo.log.between(from, to)
     end
 
@@ -29,7 +29,7 @@ module Danger
     end
 
     def head_commit
-      exec "rev-parse HEAD"
+      exec("rev-parse HEAD")
     end
 
     def origins
@@ -37,38 +37,60 @@ module Danger
     end
 
     def ensure_commitish_exists!(commitish)
-      exec("fetch") if exec("rev-parse --quiet --verify \"#{commitish}^{commit}\"").empty?
+      git_shallow_fetch if commit_not_exists?(commitish)
+
+      if commit_not_exists?(commitish)
+        raise_if_we_cannot_find_the_commit(commitish)
+      end
     end
 
     private
 
+    def git_shallow_fetch
+      exec("fetch --unshallow")
+    end
+
     def default_env
       { "LANG" => "en_US.UTF-8" }
     end
-  end
-end
 
-# For full context see:
-# https://github.com/danger/danger/issues/160
-# and https://github.com/danger/danger/issues/316
-#
-# for which the fix comes from an unmerged PR from 2012
-# https://github.com/schacon/ruby-git/pull/43
+    def raise_if_we_cannot_find_the_commit(commitish)
+      raise "Commit #{commitish[0..7]} doesn't exist. Are you running `danger local/pr` against the correct repository? Also this usually happens when you rebase/reset and force-pushed."
+    end
 
-module Git
-  class Base
-    def merge_base(commit1, commit2, *other_commits)
-      Git::Object.new self, self.lib.merge_base(commit1, commit2, *other_commits)
+    def commit_exists?(sha1)
+      !commit_not_exists?(sha1)
+    end
+
+    def commit_not_exists?(sha1)
+      exec("rev-parse --quiet --verify #{sha1}^{commit}").empty?
+    end
+
+    def find_merge_base(repo, from, to)
+      possible_merge_base = possible_merge_base(repo, from, to)
+
+      unless possible_merge_base
+        git_shallow_fetch
+        possible_merge_base = possible_merge_base(repo, from, to)
+      end
+
+      raise "Cannot find a merge base between #{from} and #{to}." unless possible_merge_base
+
+      possible_merge_base
+    end
+
+    def possible_merge_base(repo, from, to)
+      [repo.merge_base(from, to)].find { |base| commit_exists?(base) }
     end
   end
+end
 
-  class Lib
+module Git
+  class Base
+    # Use git-merge-base https://git-scm.com/docs/git-merge-base to
+    # find as good common ancestors as possible for a merge
     def merge_base(commit1, commit2, *other_commits)
-      arr_opts = []
-      arr_opts << commit1
-      arr_opts << commit2
-      arr_opts += other_commits
-      command("merge-base", arr_opts)
+      Open3.popen2("git", "merge-base", "--all", commit1, commit2, *other_commits) { |_stdin, stdout, _wait_thr| stdout.read.rstrip }
     end
   end
 end

data/lib/danger/version.rb

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