danger 8.0.4

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

@@ -0,0 +1,10 @@
+module Danger
+  class RepoInfo
+    attr_reader :slug, :id
+
+    def initialize(slug, id)
+      @slug = slug
+      @id = id
+    end
+  end
+end

data/lib/danger/ci_source/surf.rb

@@ -0,0 +1,37 @@
+# http://github.com/surf-build/surf
+require "danger/request_sources/github/github"
+
+module Danger
+  # ### CI Setup
+  #
+  # You want to add `bundle exec danger` to your `build.sh` file to run  Danger at the
+  # end of your build.
+  #
+  # ### Token Setup
+  #
+  # As this is self-hosted, you will need to add the `DANGER_GITHUB_API_TOKEN` to your build user's ENV. The alternative
+  # is to pass in the token as a prefix to the command `DANGER_GITHUB_API_TOKEN="123" bundle exec danger`.
+  #
+  class Surf < CI
+    def self.validates_as_ci?(env)
+      return ["SURF_REPO", "SURF_NWO"].all? { |x| env[x] && !env[x].empty? }
+    end
+
+    def self.validates_as_pr?(env)
+      validates_as_ci?(env)
+    end
+
+    def supported_request_sources
+      @supported_request_sources ||= [Danger::RequestSources::GitHub]
+    end
+
+    def initialize(env)
+      self.repo_slug = env["SURF_NWO"]
+      if env["SURF_PR_NUM"].to_i > 0
+        self.pull_request_id = env["SURF_PR_NUM"]
+      end
+
+      self.repo_url = env["SURF_REPO"]
+    end
+  end
+end

data/lib/danger/ci_source/teamcity.rb

@@ -0,0 +1,161 @@
+# https://www.jetbrains.com/teamcity/
+require "danger/request_sources/github/github"
+require "danger/request_sources/gitlab"
+
+module Danger
+  # ### CI Setup
+  #
+  # You need to go to your project settings. Then depending on the type of your build settings, you may need
+  # to add a new build step for Danger. You want to be able to run the command `bundle exec danger`, so
+  # the "Simple Command Runner" should be all you need to do that.
+  #
+  # ### Token + Environment Setup
+  #
+  # #### GitHub
+  #
+  # As this is self-hosted, you will need to add the `DANGER_GITHUB_API_TOKEN` to your build user's ENV. The alternative
+  # is to pass in the token as a prefix to the command `DANGER_GITHUB_API_TOKEN="123" bundle exec danger`.
+  #
+  # However, you will need to find a way to add the environment vars: `GITHUB_REPO_SLUG`, `GITHUB_PULL_REQUEST_ID` and
+  # `GITHUB_REPO_URL`. These are not added by default. You can manually add `GITHUB_REPO_SLUG` and `GITHUB_REPO_URL`
+  #  as build parameters or by exporting them inside your Simple Command Runner.
+  #
+  # As for `GITHUB_PULL_REQUEST_ID`, TeamCity provides the `%teamcity.build.branch%` variable which is in the format
+  # `PR_NUMBER/merge`. You can slice the Pull Request ID out by doing the following:
+  #
+  # ```sh
+  # branch="%teamcity.build.branch%"
+  # export GITHUB_PULL_REQUEST_ID=(${branch//\// })
+  # ```
+  # Or if you are using the pull request feature you can set an environment parameter called `GITHUB_PULL_REQUEST_ID`
+  # to the value of: `%teamcity.pullRequest.number`
+  #
+  # #### GitLab
+  #
+  # As this is self-hosted, you will need to add the `DANGER_GITLAB_API_TOKEN` to your build user's ENV. The alternative
+  # is to pass in the token as a prefix to the command `DANGER_GITLAB_API_TOKEN="123" bundle exec danger`.
+  #
+  # However, you will need to find a way to add the environment vars: `GITLAB_REPO_SLUG`, `GITLAB_PULL_REQUEST_ID` and
+  # `GITLAB_REPO_URL`. These are not added by default. You could do this via the GitLab API potentially.
+  #
+  # We would love some advice on improving this setup.
+  #
+  # #### BitBucket Cloud
+  #
+  # You will need to add the following environment variables as build parameters or by exporting them inside your
+  # Simple Command Runner.
+  #
+  #
+  # - `BITBUCKET_REPO_SLUG`
+  # - `BITBUCKET_REPO_URL`
+  #
+  # - `DANGER_BITBUCKETCLOUD_USERNAME`
+  # - `DANGER_BITBUCKETCLOUD_PASSWORD`
+  #
+  # or
+  #
+  # - `DANGER_BITBUCKETCLOUD_OAUTH_KEY`
+  # - `DANGER_BITBUCKETCLOUD_OAUTH_SECRET`
+  #
+  # You will also need to set the `BITBUCKET_BRANCH_NAME` environment variable.
+  # TeamCity provides `%teamcity.build.branch%`, which you can use at the top of your Simple Command Runner:
+  # ```sh
+  # export BITBUCKET_BRANCH_NAME="%teamcity.build.branch%"
+  # ```
+  #
+  # #### BitBucket Server
+  #
+  # You will need to add the following environment variables as build parameters or by exporting them inside your
+  # Simple Command Runner.
+  #
+  # - `DANGER_BITBUCKETSERVER_USERNAME`
+  # - `DANGER_BITBUCKETSERVER_PASSWORD`
+  # - `DANGER_BITBUCKETSERVER_HOST`
+  # - `BITBUCKETSERVER_REPO_SLUG`
+  # - `BITBUCKETSERVER_PULL_REQUEST_ID`
+  # - `BITBUCKETSERVER_REPO_URL`
+  #
+  class TeamCity < CI
+    class << self
+      def validates_as_github_pr?(env)
+        ["GITHUB_PULL_REQUEST_ID", "GITHUB_REPO_URL"].all? { |x| env[x] && !env[x].empty? }
+      end
+
+      def validates_as_gitlab_pr?(env)
+        ["GITLAB_REPO_SLUG", "GITLAB_PULL_REQUEST_ID", "GITLAB_REPO_URL"].all? { |x| env[x] && !env[x].empty? }
+      end
+
+      def validates_as_bitbucket_cloud_pr?(env)
+        ["BITBUCKET_REPO_SLUG", "BITBUCKET_BRANCH_NAME", "BITBUCKET_REPO_URL"].all? { |x| env[x] && !env[x].empty? }
+      end
+
+      def validates_as_bitbucket_server_pr?(env)
+        ["BITBUCKETSERVER_REPO_SLUG", "BITBUCKETSERVER_PULL_REQUEST_ID", "BITBUCKETSERVER_REPO_URL"].all? { |x| env[x] && !env[x].empty? }
+      end
+    end
+
+    def self.validates_as_ci?(env)
+      env.key? "TEAMCITY_VERSION"
+    end
+
+    def self.validates_as_pr?(env)
+      validates_as_github_pr?(env) || validates_as_gitlab_pr?(env) || validates_as_bitbucket_cloud_pr?(env) || validates_as_bitbucket_server_pr?(env)
+    end
+
+    def supported_request_sources
+      @supported_request_sources ||= [Danger::RequestSources::GitHub, Danger::RequestSources::GitLab, Danger::RequestSources::BitbucketCloud, Danger::RequestSources::BitbucketServer]
+    end
+
+    def initialize(env)
+      # NB: Unfortunately TeamCity doesn't provide these variables
+      # automatically so you have to add these variables manually to your
+      # project or build configuration
+      if self.class.validates_as_github_pr?(env)
+        extract_github_variables!(env)
+      elsif self.class.validates_as_gitlab_pr?(env)
+        extract_gitlab_variables!(env)
+      elsif self.class.validates_as_bitbucket_cloud_pr?(env)
+        extract_bitbucket_variables!(env)
+      elsif self.class.validates_as_bitbucket_server_pr?(env)
+        extract_bitbucket_server_variables!(env)
+      end
+    end
+
+    private
+
+    def extract_github_variables!(env)
+      self.repo_slug       = env["GITHUB_REPO_SLUG"]
+      self.pull_request_id = env["GITHUB_PULL_REQUEST_ID"].to_i
+      self.repo_url        = env["GITHUB_REPO_URL"]
+    end
+
+    def extract_gitlab_variables!(env)
+      self.repo_slug       = env["GITLAB_REPO_SLUG"]
+      self.pull_request_id = env["GITLAB_PULL_REQUEST_ID"].to_i
+      self.repo_url        = env["GITLAB_REPO_URL"]
+    end
+
+    def extract_bitbucket_variables!(env)
+      self.repo_slug       = env["BITBUCKET_REPO_SLUG"]
+      self.pull_request_id = bitbucket_pr_from_env(env)
+      self.repo_url        = env["BITBUCKET_REPO_URL"]
+    end
+
+    def extract_bitbucket_server_variables!(env)
+      self.repo_slug       = env["BITBUCKETSERVER_REPO_SLUG"]
+      self.pull_request_id = env["BITBUCKETSERVER_PULL_REQUEST_ID"].to_i
+      self.repo_url        = env["BITBUCKETSERVER_REPO_URL"]
+    end
+
+    # This is a little hacky, because Bitbucket doesn't provide us a PR id
+    def bitbucket_pr_from_env(env)
+      branch_name = env["BITBUCKET_BRANCH_NAME"]
+      repo_slug   = env["BITBUCKET_REPO_SLUG"]
+      begin
+        Danger::RequestSources::BitbucketCloudAPI.new(repo_slug, nil, branch_name, env).pull_request_id
+      rescue
+        raise "Failed to find a pull request for branch \"#{branch_name}\" on Bitbucket."
+      end
+    end
+  end
+end

data/lib/danger/ci_source/travis.rb

@@ -0,0 +1,51 @@
+# http://docs.travis-ci.com/user/osx-ci-environment/
+# http://docs.travis-ci.com/user/environment-variables/
+require "danger/request_sources/github/github"
+
+module Danger
+  # ### CI Setup
+  # You need to edit your `.travis.yml` to include `bundle exec danger`. If you already have
+  # a `script:` section then we recommend adding this command at the end of the script step: `- bundle exec danger`.
+  #
+  #  Otherwise, add a `before_script` step to the root of the `.travis.yml` with `bundle exec danger`
+  #
+  #  ```ruby
+  #    before_script:
+  #      - bundle exec danger
+  #  ```
+  #
+  # Adding this to your `.travis.yml` allows Danger to fail your build, both on the TravisCI website and within your Pull Request.
+  # With that set up, you can edit your job to add `bundle exec danger` at the build action.
+  #
+  # _Note:_ Travis CI defaults to using an older version of Ruby, so you may need to add `rvm: 2.0.0` to the root your `.travis.yml`.
+  #
+  # ### Token Setup
+  #
+  # You need to add the `DANGER_GITHUB_API_TOKEN` environment variable, to do this,
+  # go to your repo's settings, which should look like: `https://travis-ci.org/[user]/[repo]/settings`.
+  #
+  # If you have an open source project, you should ensure "Display value in build log" enabled, so that PRs from forks work.
+  #
+  class Travis < CI
+    def self.validates_as_ci?(env)
+      env.key? "HAS_JOSH_K_SEAL_OF_APPROVAL"
+    end
+
+    def self.validates_as_pr?(env)
+      exists = ["TRAVIS_PULL_REQUEST", "TRAVIS_REPO_SLUG"].all? { |x| env[x] && !env[x].empty? }
+      exists && env["TRAVIS_PULL_REQUEST"].to_i > 0
+    end
+
+    def supported_request_sources
+      @supported_request_sources ||= [Danger::RequestSources::GitHub]
+    end
+
+    def initialize(env)
+      self.repo_slug = env["TRAVIS_REPO_SLUG"]
+      if env["TRAVIS_PULL_REQUEST"].to_i > 0
+        self.pull_request_id = env["TRAVIS_PULL_REQUEST"]
+      end
+      self.repo_url = GitRepo.new.origins # Travis doesn't provide a repo url env variable :/
+    end
+  end
+end

data/lib/danger/ci_source/vsts.rb

@@ -0,0 +1,73 @@
+require "danger/request_sources/github/github"
+require "danger/request_sources/vsts"
+
+module Danger
+  # ### CI Setup
+  #
+  # You need to go to your project's build definition. Then add a "Command Line" Task with the "Tool" field set to  "bundle"
+  # and the "Arguments" field set to "exec danger".
+  #
+  # ### Token Setup
+  #
+  # #### GitHub
+  #
+  # You need to add the `DANGER_GITHUB_API_TOKEN` environment variable, to do this, go to your build definition's variables tab.
+  #
+  # Make sure that `DANGER_GITHUB_API_TOKEN` is not set to secret since vsts does not expose secret variables while building.
+  #
+  # #### VSTS
+  #
+  # You need to add the `DANGER_VSTS_API_TOKEN` and `DANGER_VSTS_HOST` environment variable, to do this,
+  # go to your build definition's variables tab. The `DANGER_VSTS_API_TOKEN` is your vsts personal access token.
+  # Instructions for creating a personal access token can be found [here](https://www.visualstudio.com/en-us/docs/setup-admin/team-services/use-personal-access-tokens-to-authenticate).
+  # For the `DANGER_VSTS_HOST` variable the suggested value is `$(System.TeamFoundationCollectionUri)$(System.TeamProject)`
+  # which will automatically get your vsts domain and your project name needed for the vsts api.
+  #
+  # Make sure that `DANGER_VSTS_API_TOKEN` is not set to secret since vsts does not expose secret variables while building.
+  #
+  class VSTS < CI
+    class << self
+      def github_slug(env)
+        env["BUILD_REPOSITORY_NAME"]
+      end
+
+      def vsts_slug(env)
+        project_name = env["SYSTEM_TEAMPROJECT"]
+        repo_name = env["BUILD_REPOSITORY_NAME"]
+
+        "#{project_name}/#{repo_name}"
+      end
+    end
+
+    def self.validates_as_ci?(env)
+      has_all_variables = ["SYSTEM_TEAMFOUNDATIONCOLLECTIONURI", "BUILD_REPOSITORY_PROVIDER"].all? { |x| env[x] && !env[x].empty? }
+
+      is_support_source_control = ["GitHub", "TfsGit"].include?(env["BUILD_REPOSITORY_PROVIDER"])
+
+      has_all_variables && is_support_source_control
+    end
+
+    def self.validates_as_pr?(env)
+      has_all_variables = ["BUILD_SOURCEBRANCH", "BUILD_REPOSITORY_URI", "BUILD_REASON", "BUILD_REPOSITORY_NAME"].all? { |x| env[x] && !env[x].empty? }
+
+      has_all_variables && env["BUILD_REASON"] == "PullRequest"
+    end
+
+    def supported_request_sources
+      @supported_request_sources ||= [Danger::RequestSources::GitHub, Danger::RequestSources::VSTS]
+    end
+
+    def initialize(env)
+      case env["BUILD_REPOSITORY_PROVIDER"]
+      when "GitHub"
+        self.repo_slug = self.class.github_slug(env)
+      when "TfsGit"
+        self.repo_slug = self.class.vsts_slug(env)
+      end
+
+      repo_matches = env["BUILD_SOURCEBRANCH"].match(%r{refs\/pull\/([0-9]+)\/merge})
+      self.pull_request_id = repo_matches[1] unless repo_matches.nil?
+      self.repo_url = env["BUILD_REPOSITORY_URI"]
+    end
+  end
+end

data/lib/danger/ci_source/xcode_server.rb

@@ -0,0 +1,48 @@
+# Following the advice from @czechboy0 https://github.com/danger/danger/issues/171
+# https://github.com/czechboy0/Buildasaur
+require "danger/request_sources/github/github"
+
+module Danger
+  # ### CI Setup
+  #
+  # If you're bold enough to use Xcode Bots. You will need to use [Buildasaur](https://github.com/czechboy0/Buildasaur)
+  # in order to work with Danger. This will set up your build environment for you, as the name of the bot contains all
+  # of the environment variables that Danger needs to work.
+  #
+  # With Buildasaur set up, you can edit your job to add `bundle exec danger` as a post-action build script.
+  #
+  # ### Token Setup
+  #
+  # As this is self-hosted, you will need to add the `DANGER_GITHUB_API_TOKEN` to your build user's ENV. The alternative
+  # is to pass in the token as a prefix to the command `DANGER_GITHUB_API_TOKEN="123" bundle exec danger`.`.
+  #
+  class XcodeServer < CI
+    def self.validates_as_ci?(env)
+      env.key? "XCS_BOT_NAME"
+    end
+
+    def self.validates_as_pr?(env)
+      value = env["XCS_BOT_NAME"]
+      !value.nil? && value.include?("BuildaBot")
+    end
+
+    def supported_request_sources
+      @supported_request_sources ||= [
+        Danger::RequestSources::GitHub,
+        Danger::RequestSources::BitbucketServer,
+        Danger::RequestSources::BitbucketCloud
+      ]
+    end
+
+    def initialize(env)
+      bot_name = env["XCS_BOT_NAME"]
+      return if bot_name.nil?
+
+      repo_matches = bot_name.match(/\[(.+)\]/)
+      self.repo_slug = repo_matches[1] unless repo_matches.nil?
+      pull_request_id_matches = bot_name.match(/#(\d+)/)
+      self.pull_request_id = pull_request_id_matches[1] unless pull_request_id_matches.nil?
+      self.repo_url = GitRepo.new.origins # Xcode Server doesn't provide a repo url env variable :/
+    end
+  end
+end

data/lib/danger/clients/rubygems_client.rb

@@ -0,0 +1,14 @@
+module Danger
+  class RubyGemsClient
+    API_URL = "https://rubygems.org/api/v1/versions/danger/latest.json".freeze
+    DUMMY_VERSION = "0.0.0".freeze
+
+    def self.latest_danger_version
+      require "json"
+      json = JSON.parse(Faraday.get(API_URL).body)
+      json.fetch("version") { DUMMY_VERSION }
+    rescue StandardError => _e
+      DUMMY_VERSION
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+require "claide_plugin"
+require "danger/commands/dangerfile/init"
+
+module Danger
+  class DangerfileGem < DangerfileCommand
+    self.summary = "Create a gem-based Dangerfile quickly."
+    def self.description
+      <<-DESC
+                Creates a scaffold for the development of a new gem based Dangerfile
+                named `NAME` according to the best practices.
+      DESC
+    end
+    self.command = "gem"
+    self.arguments = [
+      CLAide::Argument.new("NAME", true)
+    ]
+
+    def initialize(argv)
+      @name = argv.shift_argument
+      prefix = "dangerfile" + "-"
+      unless @name.nil? || @name.empty? || @name.start_with?(prefix)
+        @name = prefix + @name.dup
+      end
+      @template_url = argv.shift_argument
+      super
+    end
+
+    def validate!
+      super
+      if @name.nil? || @name.empty?
+        help! "A name for the plugin is required."
+      end
+
+      help! "The plugin name cannot contain spaces." if @name =~ /\s/
+    end
+
+    def run
+      runner = CLAide::TemplateRunner.new(@name, "https://github.com/danger/dangerfile-gem-template")
+      runner.clone_template
+      runner.configure_template
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+require "danger/danger_core/dangerfile_generator"
+
+# Mainly so we can have a nice structure for commands
+
+module Danger
+  class DangerfileCommand < Runner
+    self.summary = "Easily create you Dangerfiles."
+    self.command = "dangerfile"
+
+    self.abstract_command = true
+    def self.options
+      []
+    end
+  end
+end
+
+# Just a less verbose way of doing the Dangerfile from `danger init`.
+
+module Danger
+  class DangerfileInit < DangerfileCommand
+    self.summary = "Create an example Dangerfile."
+    self.command = "init"
+
+    def run
+      content = DangerfileGenerator.create_dangerfile(".", cork)
+      File.write("Dangerfile", content)
+      cork.puts "Created" + "./Dangerfile".green
+    end
+  end
+end