danger 8.0.3

data/lib/danger/danger_core/messages/violation.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require "danger/danger_core/messages/base"
+
+module Danger
+  class Violation < BaseMessage
+    VALID_TYPES = %I[error warning message].freeze
+    attr_accessor :sticky
+
+    def initialize(message, sticky, file = nil, line = nil, type: :warning)
+      raise ArgumentError unless VALID_TYPES.include?(type)
+
+      super(type: type, message: message, file: file, line: line)
+      self.sticky = sticky
+    end
+
+    def ==(other)
+      return false if other.nil?
+      return false unless other.kind_of? self.class
+
+      other.message == message &&
+        other.sticky == sticky &&
+        other.file == file &&
+        other.line == line
+    end
+
+    def hash
+      h = 1
+      h = h * 31 + message.hash
+      h = h * 13 + sticky.hash
+      h = h * 17 + file.hash
+      h = h * 17 + line.hash
+      h
+    end
+
+    def <=>(other)
+      types = VALID_TYPES + [:markdown]
+      order = types.index(type) <=> types.index(other.type)
+      return order unless order.zero?
+
+      compare_by_file_and_line(other)
+    end
+
+    def to_s
+      extra = []
+      extra << "sticky: #{sticky}"
+      extra << "file: #{file}" if file
+      extra << "line: #{line}" if line
+      extra << "type: #{type}"
+
+      "Violation #{message} { #{extra.join ', '} }"
+    end
+  end
+end

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

@@ -0,0 +1,144 @@
+# coding: utf-8
+
+require "danger/plugin_support/plugin"
+
+module Danger
+  # Handles interacting with Bitbucket Cloud inside a Dangerfile. Provides a few functions which wrap `pr_json` and also
+  # through a few standard functions to simplify your code.
+  #
+  # @example Warn when a PR is classed as work in progress
+  #
+  #          warn "PR is classed as Work in Progress" if bitbucket_cloud.pr_title.include? "[WIP]"
+  #
+  # @example Declare a PR to be simple to avoid specific Danger rules
+  #
+  #          declared_trivial = (bitbucket_cloud.pr_title + bitbucket_cloud.pr_body).include?("#trivial")
+  #
+  # @example Ensure that labels have been used on the PR
+  #
+  #          failure "Please add labels to this PR" if bitbucket_cloud.pr_labels.empty?
+  #
+  # @example Ensure there is a summary for a PR
+  #
+  #          failure "Please provide a summary in the Pull Request description" if bitbucket_cloud.pr_body.length < 5
+  #
+  # @example Only accept PRs to the develop branch
+  #
+  #          failure "Please re-submit this PR to develop, we may have already fixed your issue." if bitbucket_cloud.branch_for_base != "develop"
+  #
+  # @example Highlight when a celebrity makes a pull request
+  #
+  #          message "Welcome, Danger." if bitbucket_cloud.pr_author == "dangermcshane"
+  #
+  # @example Ensure that all PRs have an assignee
+  #
+  #          warn "This PR does not have any assignees yet." if bitbucket_cloud.pr_json[:reviewers].length == 0
+  #
+  # @example Send a message with links to a collection of specific files
+  #
+  #          if git.modified_files.include? "config/*.js"
+  #            config_files = git.modified_files.select { |path| path.include? "config/" }
+  #            message "This PR changes #{ bitbucket_cloud.html_link(config_files) }"
+  #          end
+  #
+  # @example Highlight with a clickable link if a Package.json is changed
+  #
+  #         warn "#{bitbucket_cloud.html_link("Package.json")} was edited." if git.modified_files.include? "Package.json"
+  #
+  # @see  danger/danger
+  # @tags core, bitbucket_cloud
+  #
+  class DangerfileBitbucketCloudPlugin < Plugin
+    # So that this init can fail.
+    def self.new(dangerfile)
+      return nil if dangerfile.env.request_source.class != Danger::RequestSources::BitbucketCloud
+      super
+    end
+
+    # The instance name used in the Dangerfile
+    # @return [String]
+    #
+    def self.instance_name
+      "bitbucket_cloud"
+    end
+
+    def initialize(dangerfile)
+      super(dangerfile)
+      @bs = dangerfile.env.request_source
+    end
+
+    # @!group Bitbucket Cloud Misc
+    # The hash that represents the PR's JSON. For an example of what this looks like
+    # see the [Danger Fixture'd one](https://raw.githubusercontent.com/danger/danger/master/spec/fixtures/bitbucket_cloud_api/pr_response.json).
+    # @return [Hash]
+    def pr_json
+      @bs.pr_json
+    end
+
+    # @!group PR Metadata
+    # The title of the Pull Request.
+    # @return [String]
+    #
+    def pr_title
+      @bs.pr_json[:title].to_s
+    end
+
+    # @!group PR Metadata
+    # The body text of the Pull Request.
+    # @return [String]
+    #
+    def pr_description
+      @bs.pr_json[:description].to_s
+    end
+    alias pr_body pr_description
+
+    # @!group PR Metadata
+    # The username of the author of the Pull Request.
+    # @return [String]
+    #
+    def pr_author
+      @bs.pr_json[:author][:username]
+    end
+
+    # @!group PR Commit Metadata
+    # The branch to which the PR is going to be merged into.
+    # @return [String]
+    #
+    def branch_for_base
+      @bs.pr_json[:destination][:branch][:name]
+    end
+
+    # @!group PR Commit Metadata
+    # A href that represents the current PR
+    # @return [String]
+    #
+    def pr_link
+      @bs.pr_json[:links][:self][:href]
+    end
+
+    # @!group PR Commit Metadata
+    # The branch to which the PR is going to be merged from.
+    # @return [String]
+    #
+    def branch_for_head
+      @bs.pr_json[:source][:branch][:name]
+    end
+
+    # @!group PR Commit Metadata
+    # The base commit to which the PR is going to be merged as a parent.
+    # @return [String]
+    #
+    def base_commit
+      @bs.pr_json[:destination][:commit][:hash]
+    end
+
+    # @!group PR Commit Metadata
+    # The head commit to which the PR is requesting to be merged from.
+    # @return [String]
+    #
+    def head_commit
+      @bs.pr_json[:source][:commit][:hash]
+    end
+
+  end
+end

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

@@ -0,0 +1,211 @@
+# coding: utf-8
+
+require "danger/plugin_support/plugin"
+
+module Danger
+  # Handles interacting with Bitbucket Server inside a Dangerfile. Provides a few functions which wrap `pr_json` and also
+  # through a few standard functions to simplify your code.
+  #
+  # @example Warn when a PR is classed as work in progress
+  #
+  #          warn "PR is classed as Work in Progress" if bitbucket_server.pr_title.include? "[WIP]"
+  #
+  # @example Declare a PR to be simple to avoid specific Danger rules
+  #
+  #          declared_trivial = (bitbucket_server.pr_title + bitbucket_server.pr_body).include?("#trivial")
+  #
+  # @example Ensure that labels have been used on the PR
+  #
+  #          failure "Please add labels to this PR" if bitbucket_server.pr_labels.empty?
+  #
+  # @example Ensure there is a summary for a PR
+  #
+  #          failure "Please provide a summary in the Pull Request description" if bitbucket_server.pr_body.length < 5
+  #
+  # @example Only accept PRs to the develop branch
+  #
+  #          failure "Please re-submit this PR to develop, we may have already fixed your issue." if bitbucket_server.branch_for_base != "develop"
+  #
+  # @example Highlight when a celebrity makes a pull request
+  #
+  #          message "Welcome, Danger." if bitbucket_server.pr_author == "dangermcshane"
+  #
+  # @example Ensure that all PRs have an assignee
+  #
+  #          warn "This PR does not have any assignees yet." if bitbucket_server.pr_json[:reviewers].length == 0
+  #
+  # @example Send a message with links to a collection of specific files
+  #
+  #          if git.modified_files.include? "config/*.js"
+  #            config_files = git.modified_files.select { |path| path.include? "config/" }
+  #            message "This PR changes #{ bitbucket_server.html_link(config_files) }"
+  #          end
+  #
+  # @example Highlight with a clickable link if a Package.json is changed
+  #
+  #         warn "#{bitbucket_server.html_link("Package.json")} was edited." if git.modified_files.include? "Package.json"
+  #
+  # @see  danger/danger
+  # @tags core, bitbucket_server
+  #
+  class DangerfileBitbucketServerPlugin < Plugin
+    # So that this init can fail.
+    def self.new(dangerfile)
+      return nil if dangerfile.env.request_source.class != Danger::RequestSources::BitbucketServer
+      super
+    end
+
+    # The instance name used in the Dangerfile
+    # @return [String]
+    #
+    def self.instance_name
+      "bitbucket_server"
+    end
+
+    def initialize(dangerfile)
+      super(dangerfile)
+      @bs = dangerfile.env.request_source
+    end
+
+    # @!group Bitbucket Server Misc
+    # The hash that represents the PR's JSON. For an example of what this looks like
+    # see the [Danger Fixture'd one](https://raw.githubusercontent.com/danger/danger/master/spec/fixtures/bitbucket_server_api/pr_response.json).
+    # @return [Hash]
+    def pr_json
+      @bs.pr_json
+    end
+
+    # @!group PR Metadata
+    # The title of the Pull Request.
+    # @return [String]
+    #
+    def pr_title
+      @bs.pr_json[:title].to_s
+    end
+
+    # @!group PR Metadata
+    # The body text of the Pull Request.
+    # @return [String]
+    #
+    def pr_description
+      @bs.pr_json[:description].to_s
+    end
+    alias pr_body pr_description
+
+    # @!group PR Metadata
+    # The username of the author of the Pull Request.
+    # @return [String]
+    #
+    def pr_author
+      @bs.pr_json[:author][:user][:slug].to_s
+    end
+
+    # @!group PR Commit Metadata
+    # The branch to which the PR is going to be merged into.
+    # @return [String]
+    #
+    def branch_for_base
+      @bs.pr_json[:toRef][:displayId].to_s
+    end
+
+    # @!group PR Commit Metadata
+    # A href that represents the current PR
+    # @return [String]
+    #
+    def pr_link
+      @bs.pr_json[:links][:self].flat_map { |l| l[:href] }.first.to_s
+    end
+
+    # @!group PR Commit Metadata
+    # The branch to which the PR is going to be merged from.
+    # @return [String]
+    #
+    def branch_for_head
+      @bs.pr_json[:fromRef][:displayId].to_s
+    end
+
+    # @!group PR Commit Metadata
+    # The base commit to which the PR is going to be merged as a parent.
+    # @return [String]
+    #
+    def base_commit
+      @bs.pr_json[:toRef][:latestCommit].to_s
+    end
+
+    # @!group PR Commit Metadata
+    # The head commit to which the PR is requesting to be merged from.
+    # @return [String]
+    #
+    def head_commit
+      @bs.pr_json[:fromRef][:latestCommit].to_s
+    end
+
+    # @!group Bitbucket Server Misc
+    # Returns a list of Markdown links for a file, or files in the head repository.
+    # It returns a string of multiple anchors if passed an array.
+    # @note     Atlassian [disabled inline HTML support](https://jira.atlassian.com/browse/BSERV-7147).
+    #           This method method left for backward compatibility.
+    # @param    [String or Array<String>] paths
+    #           A list of strings to convert to github anchors
+    # @param    [Bool] full_path
+    #           Shows the full path as the link's text, defaults to `true`.
+    #
+    # @return [String]
+    #
+    def html_link(paths, full_path: true)
+      markdown_link(paths, full_path: full_path)
+    end
+
+    # @!group Bitbucket Server Misc
+    # Returns a list of Markdown links for a file, or files in the head repository.
+    # It returns a string of multiple links if passed an array.
+    # @param    [String or Array<String>] paths
+    #           A list of strings to convert to Markdown links
+    # @param    [Bool] full_path
+    #           Shows the full path as the link's text, defaults to `true`.
+    #
+    # @return [String]
+    #
+    def markdown_link(paths, full_path: true)
+      create_link(paths, full_path) { |href, text| create_markdown_link(href, text) }
+    end
+    
+    # @!group Bitbucket Server Misc
+    # Updates the PR with build status and build server job link.
+    # @param    [String] status
+    #           SUCCESSFUL, FAILED and INPROGRESS
+    # @param    [String] build_job_link
+    #           Build server job link
+    # @param    [String] description
+    #           Build status description
+    # @return   [String]
+    #
+    def update_pr_build_status(status, build_job_link, description)
+        @bs.update_pr_build_status(status, build_job_link, description)
+    end
+
+    private
+
+    def create_link(paths, full_path)
+      paths = [paths] unless paths.kind_of?(Array)
+      commit = head_commit
+      repo = pr_json[:fromRef][:repository][:links][:self].flat_map { |l| l[:href] }.first
+
+      paths = paths.map do |path|
+        path, line = path.split("#")
+        url_path = path.start_with?("/") ? path : "/#{path}"
+        text = full_path ? path : File.basename(path)
+        url_path.gsub!(" ", "%20")
+        line_ref = line ? "##{line}" : ""
+        yield("#{repo}#{url_path}?at=#{commit}#{line_ref}", text)
+      end
+
+      return paths.first if paths.count < 2
+      paths.first(paths.count - 1).join(", ") + " & " + paths.last
+    end
+
+    def create_markdown_link(href, text)
+      "[#{text}](#{href})"
+    end
+  end
+end

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

@@ -0,0 +1,248 @@
+require "danger/plugin_support/plugin"
+
+module Danger
+  # A way to interact with Danger herself. Offering APIs to import plugins,
+  # and Dangerfiles from multiple sources.
+  #
+  # @example Import a plugin available over HTTP
+  #
+  #          device_grid = "https://raw.githubusercontent.com/fastlane/fastlane/master/danger-device_grid/lib/device_grid/plugin.rb"
+  #          danger.import_plugin(device_grid)
+  #
+  # @example Import from a local file reference
+  #
+  #          danger.import_plugin("danger/plugins/watch_plugin.rb")
+  #
+  # @example Import all files inside a folder
+  #
+  #          danger.import_plugin("danger/plugins/*.rb")
+  #
+  # @example Run a Dangerfile from inside a sub-folder
+  #
+  #          danger.import_dangerfile(path: "path/to/Dangerfile")
+  #
+  # @example Run a Dangerfile from inside a gem
+  #
+  #          danger.import_dangerfile(gem: "ruby-grape-danger")
+  #
+  # @example Run a Dangerfile from inside a repo
+  #
+  #          danger.import_dangerfile(gitlab_project_id: 1345)
+  #
+  # @example Run a Dangerfile from inside a repo branch and path
+  #
+  #          danger.import_dangerfile(github: "ruby-grape/danger", branch: "custom", path: "path/to/Dangerfile")
+  #
+  # @see  danger/danger
+  # @tags core, plugins
+
+  class DangerfileDangerPlugin < Plugin
+    # The instance name used in the Dangerfile
+    # @return [String]
+    #
+    def self.instance_name
+      "danger"
+    end
+
+    # @!group Danger
+    # Download a local or remote plugin and make it usable inside the Dangerfile.
+    #
+    # @param    [String] path_or_url
+    #           a local path or a https URL to the Ruby file to import
+    #           a danger plugin from.
+    # @return   [void]
+    #
+    def import_plugin(path_or_url)
+      raise "`import_plugin` requires a string" unless path_or_url.kind_of?(String)
+
+      if path_or_url.start_with?("http")
+        import_url(path_or_url)
+      else
+        import_local(path_or_url)
+      end
+    end
+
+    # @!group Danger
+    # Import a Dangerfile.
+    #
+    # @param    [Hash] opts
+    # @option opts [String] :github GitHub repo
+    # @option opts [String] :gitlab GitLab repo
+    # @option opts [String] :gem Gem name
+    # @option opts [String] :path Path to Dangerfile
+    # @return   [void]
+    def import_dangerfile(opts)
+      if opts.kind_of?(String)
+        warn "Use `import_dangerfile(github: '#{opts}')` instead of `import_dangerfile '#{opts}'`."
+        import_dangerfile_from_github(opts)
+      elsif opts.kind_of?(Hash)
+        if opts.key?(:github)
+          import_dangerfile_from_github(opts[:github], opts[:branch], opts[:path])
+        elsif opts.key?(:gitlab)
+          import_dangerfile_from_gitlab(opts[:gitlab], opts[:branch], opts[:path])
+        elsif opts.key?(:path)
+          import_dangerfile_from_path(opts[:path])
+        elsif opts.key?(:gem)
+          import_dangerfile_from_gem(opts[:gem])
+        else
+          raise "`import` requires a Hash with either :github, :gitlab, :gem, or :path"
+        end
+      else
+        raise "`import` requires a Hash"
+      end
+    end
+
+    # @!group Danger
+    # Returns the name of the current SCM Provider being used.
+    # @return [Symbol] The name of the SCM Provider used for the active repository.
+    def scm_provider
+      return :unknown unless env.request_source
+
+      case env.request_source
+      when Danger::RequestSources::GitHub
+        :github
+      when Danger::RequestSources::GitLab
+        :gitlab
+      when Danger::RequestSources::BitbucketServer
+        :bitbucket_server
+      when Danger::RequestSources::BitbucketCloud
+        :bitbucket_cloud
+      when Danger::RequestSources::VSTS
+        :vsts
+      else
+        :unknown
+      end
+    end
+
+    private
+
+    # @!group Danger
+    # Read and execute a local Dangerfile.
+    #
+    # @param    [String] path
+    #           A path to a Dangerfile.
+    # @return   [void]
+    #
+    def import_dangerfile_from_path(path)
+      raise "`import_dangerfile_from_path` requires a string" unless path.kind_of?(String)
+      local_path = File.join(path, "Dangerfile")
+      @dangerfile.parse(Pathname.new(local_path))
+    end
+
+    # @!group Danger
+    # Read and execute a Dangerfile from a gem.
+    #
+    # @param    [String] name
+    #           The name of the gem that contains a Dangerfile.
+    # @return   [void]
+    #
+    def import_dangerfile_from_gem(name)
+      raise "`import_dangerfile_from_gem` requires a string" unless name.kind_of?(String)
+      spec = Gem::Specification.find_by_name(name)
+      import_dangerfile_from_path(spec.gem_dir)
+    rescue Gem::MissingSpecError
+      raise "`import_dangerfile_from_gem` tried to load `#{name}` and failed, did you forget to include it in your Gemfile?"
+    end
+
+    # @!group Danger
+    # Download and execute a remote Dangerfile.
+    #
+    # @param    [String] slug
+    #           A slug that represents the repo where the Dangerfile is.
+    # @param    [String] branch
+    #           A branch from repo where the Dangerfile is.
+    # @param    [String] path
+    #           The path at the repo where Dangerfile is.
+    # @return   [void]
+    #
+    def import_dangerfile_from_github(slug, branch = nil, path = nil)
+      raise "`import_dangerfile_from_github` requires a string" unless slug.kind_of?(String)
+      org, repo = slug.split("/")
+      download_url = env.request_source.file_url(organisation: org, repository: repo, branch: branch, path: path || "Dangerfile")
+      local_path = download(download_url)
+      @dangerfile.parse(Pathname.new(local_path))
+    end
+
+    # @!group Danger
+    # Download and execute a remote Dangerfile.
+    #
+    # @param    [Int] slug_or_project_id
+    #           The slug or id of the repo where the Dangerfile is.
+    # @param    [String] branch
+    #           A branch from repo where the Dangerfile is.
+    # @param    [String] path
+    #           The path at the repo where Dangerfile is.
+    # @return   [void]
+    #
+    def import_dangerfile_from_gitlab(slug_or_project_id, branch = nil, path = nil)
+      download_url = env.request_source.file_url(repository: slug_or_project_id, branch: branch, path: path || "Dangerfile")
+      local_path = download(download_url)
+      @dangerfile.parse(Pathname.new(local_path))
+    end
+
+    # @!group Plugins
+    # Download a local or remote plugin or Dangerfile.
+    # This method will not import the file for you, use plugin.import instead
+    #
+    # @param    [String] path_or_url
+    #           a local path or a https URL to the Ruby file to import
+    #           a danger plugin from.
+    # @return [String] The path to the downloaded Ruby file
+    #
+    def download(path_or_url)
+      raise "`download` requires a string" unless path_or_url.kind_of?(String)
+      raise "URL is not https, for security reasons `danger` only supports encrypted requests" if URI.parse(path_or_url).scheme != "https"
+
+      require "tmpdir"
+      require "faraday"
+
+      @http_client ||= Faraday.new do |b|
+        b.adapter :net_http
+      end
+      content = @http_client.get(path_or_url)
+
+      path = File.join(Dir.mktmpdir, "temporary_danger.rb")
+      File.write(path, content.body)
+      return path
+    end
+
+    # @!group Plugins
+    # Download a remote plugin and use it locally.
+    #
+    # @param    [String] url
+    #           https URL to the Ruby file to use
+    # @return [void]
+    def import_url(url)
+      path = download(url)
+      import_local(path)
+    end
+
+    # @!group Plugins
+    # Import one or more local plugins.
+    #
+    # @param    [String] path
+    #           The path to the file to import
+    #           Can also be a pattern (./**/*plugin.rb)
+    # @return [void]
+    def import_local(path)
+      Dir[path].each do |file|
+        validate_file_contains_plugin!(file) do
+          # Without the expand_path it would fail if the path doesn't start with ./
+          require File.expand_path(file)
+        end
+
+        refresh_plugins
+      end
+    end
+
+    # Raises an error when the given block does not register a plugin.
+    def validate_file_contains_plugin!(file)
+      plugin_count_was = Danger::Plugin.all_plugins.length
+      yield
+
+      if Danger::Plugin.all_plugins.length == plugin_count_was
+        raise("#{file} doesn't contain any valid danger plugins.")
+      end
+    end
+  end
+end