danger 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2462871258d80d80ee0a85ef7c159dbf42e2b665
-  data.tar.gz: 36396f398f136931f0e02b56c035ad01f40ccfa1
+  metadata.gz: f22b32cdbaacb907e107d068b7533f4721b0ea9a
+  data.tar.gz: 8d7d99a8229047d542486c2e6a5208cee52d027b
 SHA512:
-  metadata.gz: 8018e4545d0bb82cb32c81d711f893d5dc8f03107e8f4f8cc82b59f8985791211e088e3fce61528ee4838afc133b0a24e96db2af604fed1640cb8c98683cf6b7
-  data.tar.gz: e943625c0c8d6215f0cc282f2a5f7b80900e6dd36c416e9c060ec524fa87a5eae71aaebf84fe2f538f3312e43f203e78a1ee50a934de0ff5d53de3f25087cb66
+  metadata.gz: 917ba759a6a42184ce38f1dc72bb543981830896fb15757bb8a0619a71a411922583a4f8d2610f04d0a37bacd338192a9b8539bec922d873f5e88764ac3d455c
+  data.tar.gz: fd38930629b2e39026f07b9371dc15ba81582223b141a05cc2c985f5085d719265d2e36984f56dad351a54999a98f2783ab5f5426f6827ed854a94d151b09df4

data/lib/assets/DangerfileTemplate

@@ -9,5 +9,5 @@ warn("PR is classed as Work in Progress") if github.pr_title.include? "[WIP]"
 warn("Big PR") if git.lines_of_code > 500
 
 # Don't let testing shortcuts get into master by accident
-fail("fdescribe left in tests") if `grep -r fdescribe specs/`.length > 1
-fail("fit left in tests") if `grep -r "fit specs/ `.length > 1
+fail("fdescribe left in tests") if `grep -r fdescribe specs/ `.length > 1
+fail("fit left in tests") if `grep -r fit specs/ `.length > 1

data/lib/danger/ci_source/buildkite.rb

@@ -2,28 +2,40 @@
 # https://buildkite.com/docs/guides/environment-variables
 
 module Danger
-  module CISource
-    # https://buildkite.com
-    class Buildkite < CI
-      def self.validates?(env)
-        return false unless env["BUILDKITE"]
-        return false unless env["BUILDKITE_PULL_REQUEST_REPO"] && !env["BUILDKITE_PULL_REQUEST_REPO"].empty?
-        return false unless env["BUILDKITE_PULL_REQUEST"]
+  # ### CI Setup
+  #
+  # With BuildKite you run the server yourself, so you will want to run  it as a part of your build process.
+  # It is common to have build steps, so we would recommend adding this to your scrip:
+  #
+  #  ``` shell
+  #   echo "--- Running Danger"
+  #   bundle exec danger
+  #  ```
+  #
+  # ### 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 Buildkite < CI
+    def self.validates_as_ci?(env)
+      env.key? "BUILDKITE"
+    end
 
-        return true
-      end
+    def self.validates_as_pr?(env)
+      ["BUILDKITE_PULL_REQUEST_REPO", "BUILDKITE_PULL_REQUEST"].all? { |x| env[x] }
+    end
 
-      def initialize(env)
-        self.repo_url = env["BUILDKITE_PULL_REQUEST_REPO"]
-        self.pull_request_id = env["BUILDKITE_PULL_REQUEST"]
+    def initialize(env)
+      self.repo_url = env["BUILDKITE_PULL_REQUEST_REPO"]
+      self.pull_request_id = env["BUILDKITE_PULL_REQUEST"]
 
-        repo_matches = self.repo_url.match(%r{([\/:])([^\/]+\/[^\/.]+)(?:.git)?$})
-        self.repo_slug = repo_matches[2] unless repo_matches.nil?
-      end
+      repo_matches = self.repo_url.match(%r{([\/:])([^\/]+\/[^\/.]+)(?:.git)?$})
+      self.repo_slug = repo_matches[2] unless repo_matches.nil?
+    end
 
-      def supported_request_sources
-        @supported_request_sources ||= [Danger::RequestSources::GitHub]
-      end
+    def supported_request_sources
+      @supported_request_sources ||= [Danger::RequestSources::GitHub]
     end
   end
 end

data/lib/danger/ci_source/ci_source.rb

@@ -1,35 +1,37 @@
 require "set"
 
 module Danger
-  module CISource
-    # "abstract" CI class
-    class CI
-      attr_accessor :repo_slug, :pull_request_id, :repo_url, :supported_request_sources
-
-      def self.inherited(child_class)
-        available_ci_sources.add child_class
-        super
-      end
-
-      def self.available_ci_sources
-        @available_ci_sources ||= Set.new
-      end
-
-      def supported_request_sources
-        raise "CISource subclass must specify the supported request sources"
-      end
-
-      def supports?(request_source)
-        supported_request_sources.include? request_source
-      end
-
-      def self.validates?(_env)
-        false
-      end
-
-      def initialize(_env)
-        raise "Subclass and overwrite initialize"
-      end
+  # "abstract" CI class
+  class CI
+    attr_accessor :repo_slug, :pull_request_id, :repo_url, :supported_request_sources
+
+    def self.inherited(child_class)
+      available_ci_sources.add child_class
+      super
+    end
+
+    def self.available_ci_sources
+      @available_ci_sources ||= Set.new
+    end
+
+    def supported_request_sources
+      raise "CISource subclass must specify the supported request sources"
+    end
+
+    def supports?(request_source)
+      supported_request_sources.include? request_source
+    end
+
+    def self.validates_as_ci?(_env)
+      abort "You need to include a function for #{self} for validates_as_ci?"
+    end
+
+    def self.validates_as_pr?(_env)
+      abort "You need to include a function for #{self} for validates_as_pr?"
+    end
+
+    def initialize(_env)
+      raise "Subclass and overwrite initialize"
     end
   end
 end

data/lib/danger/ci_source/circle.rb

@@ -3,53 +3,73 @@ require "uri"
 require "danger/ci_source/circle_api"
 
 module Danger
-  module CISource
-    # https://circleci.com
-    class CircleCI < CI
-      def self.validates?(env)
-        return false unless env["CIRCLE_BUILD_NUM"]
-        return false unless env["CIRCLE_PROJECT_USERNAME"]
-        return false unless env["CIRCLE_PROJECT_REPONAME"]
-
-        return true
-      end
+  # ### CI Setup
+  #
+  # For setting up Circle CI, we recommend turning on "Only Build pull requests." in "Advanced Setting." Without this enabled,
+  # it is _really_ tricky for Danger to know whether you are in a pull request or not, as the environment metadata
+  # isn't reliable.
+  #
+  # With that set up, you can you add `bundle exec danger` to your `circle.yml`. If you override the default
+  # `test:` section, then add it as an extra step. Otherwise add a new `pre` section to the test:
+  #
+  #  ``` ruby
+  #   test:
+  #     override:
+  #        - bundle exec danger
+  #  ```
+  #
+  # ### Token Setup
+  #
+  # There is no difference here for OSS vs Closed, add your `DANGER_GITHUB_API_TOKEN` to the Environment variable settings page.
+  #
+  class CircleCI < CI
+    def self.validates_as_ci?(env)
+      env.key? "CIRCLE_BUILD_NUM"
+    end
 
-      def supported_request_sources
-        @supported_request_sources ||= [Danger::RequestSources::GitHub]
-      end
+    def self.validates_as_pr?(env)
+      return true if env["CI_PULL_REQUEST"]
 
-      def client
-        @client ||= CircleAPI.new(@circle_token)
-      end
+      # Uses the Circle API to determine if it's a PR otherwose
+      @circle_token = env["CIRCLE_CI_API_TOKEN"]
+      !pull_request_url(env).nil?
+    end
 
-      def fetch_pull_request_url(repo_slug, build_number)
-        build_json = client.fetch_build(repo_slug, build_number)
-        build_json[:pull_request_urls].first
-      end
+    def supported_request_sources
+      @supported_request_sources ||= [Danger::RequestSources::GitHub]
+    end
+
+    def client
+      @client ||= CircleAPI.new(@circle_token)
+    end
 
-      def pull_request_url(env)
-        url = env["CI_PULL_REQUEST"]
+    def fetch_pull_request_url(repo_slug, build_number)
+      build_json = client.fetch_build(repo_slug, build_number)
+      build_json[:pull_request_urls].first
+    end
 
-        if url.nil? && !env["CIRCLE_PROJECT_USERNAME"].nil? && !env["CIRCLE_PROJECT_REPONAME"].nil?
-          repo_slug = env["CIRCLE_PROJECT_USERNAME"] + "/" + env["CIRCLE_PROJECT_REPONAME"]
-          url = fetch_pull_request_url(repo_slug, env["CIRCLE_BUILD_NUM"])
-        end
+    def pull_request_url(env)
+      url = env["CI_PULL_REQUEST"]
 
-        url
+      if url.nil? && !env["CIRCLE_PROJECT_USERNAME"].nil? && !env["CIRCLE_PROJECT_REPONAME"].nil?
+        repo_slug = env["CIRCLE_PROJECT_USERNAME"] + "/" + env["CIRCLE_PROJECT_REPONAME"]
+        url = fetch_pull_request_url(repo_slug, env["CIRCLE_BUILD_NUM"])
       end
 
-      def initialize(env)
-        self.repo_url = GitRepo.new.origins # CircleCI doesn't provide a repo url env variable :/
+      url
+    end
+
+    def initialize(env)
+      self.repo_url = GitRepo.new.origins # CircleCI doesn't provide a repo url env variable :/
 
-        @circle_token = env["CIRCLE_CI_API_TOKEN"]
-        url = pull_request_url(env)
+      @circle_token = env["CIRCLE_CI_API_TOKEN"]
+      url = pull_request_url(env)
 
-        if URI.parse(url).path.split("/").count == 5
-          paths = URI.parse(url).path.split("/")
-          # The first one is an extra slash, ignore it
-          self.repo_slug = paths[1] + "/" + paths[2]
-          self.pull_request_id = paths[4]
-        end
+      if URI.parse(url).path.split("/").count == 5
+        paths = URI.parse(url).path.split("/")
+        # The first one is an extra slash, ignore it
+        self.repo_slug = paths[1] + "/" + paths[2]
+        self.pull_request_id = paths[4]
       end
     end
   end

data/lib/danger/ci_source/drone.rb

@@ -1,26 +1,41 @@
 # http://readme.drone.io/usage/variables/
 
 module Danger
-  module CISource
-    # https://drone.io
-    class Drone < CI
-      def self.validates?(env)
-        return false unless env["DRONE"]
-        return false unless env["DRONE_REPO"]
-        return false unless env["DRONE_PULL_REQUEST"].to_i > 0
+  # ### CI Setup
+  #
+  # With Drone you run the docker images yourself, so you will want to add `bundle exec danger` at the end of
+  # your `.drone.yml`.
+  #
+  #  ``` shell
+  #   build:
+  #     image: golang
+  #       commands:
+  #         - ...
+  #         - bundle exec danger
+  #  ```
+  #
+  # ### 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 Drone < CI
+    def self.validates_as_ci?(env)
+      env.key? "DRONE_REPO"
+    end
 
-        return true
-      end
+    def self.validates_as_pr?(env)
+      env["DRONE_PULL_REQUEST"].to_i > 0
+    end
 
-      def supported_request_sources
-        @supported_request_sources ||= [Danger::RequestSources::GitHub]
-      end
+    def supported_request_sources
+      @supported_request_sources ||= [Danger::RequestSources::GitHub]
+    end
 
-      def initialize(env)
-        self.repo_slug = env["DRONE_REPO"]
-        self.pull_request_id = env["DRONE_PULL_REQUEST"]
-        self.repo_url = GitRepo.new.origins # Drone doesn't provide a repo url env variable :/
-      end
+    def initialize(env)
+      self.repo_slug = env["DRONE_REPO"]
+      self.pull_request_id = env["DRONE_PULL_REQUEST"]
+      self.repo_url = GitRepo.new.origins # Drone doesn't provide a repo url env variable :/
     end
   end
 end

data/lib/danger/ci_source/jenkins.rb

@@ -2,27 +2,39 @@
 # https://wiki.jenkins-ci.org/display/JENKINS/GitHub+pull+request+builder+plugin
 
 module Danger
-  module CISource
-    # https://jenkins-ci.org
-    class Jenkins < CI
-      def self.validates?(env)
-        return false unless env["ghprbPullId"].to_i > 0
-        return false unless env["GIT_URL"]
+  # https://jenkins-ci.org
 
-        return true
-      end
+  ### CI Setup
+  #
+  # Ah Jenkins, so many memories. So, if you're using Jenkins, you're hosting your own environment. You
+  # will want to be using the [GitHub pull request builder plugin](https://wiki.jenkins-ci.org/display/JENKINS/GitHub+pull+request+builder+plugin)
+  # in order to ensure that you have the build environment set up for PR integration.
+  #
+  # With that set up, you can edit your job to add `bundle exec danger` at the build action.
+  #
+  # ### Token Setup
+  #
+  # As you own the machine, it's up to you to add the enviroment variable for the `DANGER_GITHUB_API_TOKEN`.
+  #
+  class Jenkins < CI
+    def self.validates_as_ci?(env)
+      env.key? "JENKINS_URL"
+    end
+
+    def self.validates_as_pr?(env)
+      ["ghprbPullId"].all? { |x| env[x] }
+    end
 
-      def supported_request_sources
-        @supported_request_sources ||= [Danger::RequestSources::GitHub]
-      end
+    def supported_request_sources
+      @supported_request_sources ||= [Danger::RequestSources::GitHub]
+    end
 
-      def initialize(env)
-        self.repo_url = env["GIT_URL"]
-        self.pull_request_id = env["ghprbPullId"]
+    def initialize(env)
+      self.repo_url = env["GIT_URL"]
+      self.pull_request_id = env["ghprbPullId"]
 
-        repo_matches = self.repo_url.match(%r{([\/:])([^\/]+\/[^\/.]+)(?:.git)?$})
-        self.repo_slug = repo_matches[2] unless repo_matches.nil?
-      end
+      repo_matches = self.repo_url.match(%r{([\/:])([^\/]+\/[^\/.]+)(?:.git)?$})
+      self.repo_slug = repo_matches[2] unless repo_matches.nil?
     end
   end
 end

data/lib/danger/ci_source/local_git_repo.rb

@@ -4,62 +4,60 @@ require "git"
 require "uri"
 
 module Danger
-  module CISource
-    # ignore
-    class LocalGitRepo < CI
-      attr_accessor :base_commit, :head_commit
+  # ignore
+  class LocalGitRepo < CI
+    attr_accessor :base_commit, :head_commit
 
-      def self.validates?(env)
-        return !env["DANGER_USE_LOCAL_GIT"].nil?
-      end
-
-      def git
-        @git ||= GitRepo.new
-      end
+    def self.validates_as_ci?(env)
+      env.key? "DANGER_USE_LOCAL_GIT"
+    end
 
-      def run_git(command)
-        git.exec command
-      end
+    def git
+      @git ||= GitRepo.new
+    end
 
-      def supported_request_sources
-        @supported_request_sources ||= [Danger::RequestSources::GitHub]
-      end
+    def run_git(command)
+      git.exec command
+    end
 
-      def initialize(env = {})
-        github_host = env["DANGER_GITHUB_HOST"] || "github.com"
+    def supported_request_sources
+      @supported_request_sources ||= [Danger::RequestSources::GitHub]
+    end
 
-        # get the remote URL
-        remote = run_git("remote show origin -n").lines.grep(/Fetch URL/)[0].split(": ", 2)[1]
-        if remote
-          remote_url_matches = remote.match(%r{#{Regexp.escape github_host}(:|/)(?<repo_slug>.+/.+?)(?:\.git)?$})
-          if !remote_url_matches.nil? and remote_url_matches["repo_slug"]
-            self.repo_slug = remote_url_matches["repo_slug"]
-          else
-            puts "Danger local requires a repository hosted on GitHub.com or GitHub Enterprise."
-          end
+    def initialize(env = {})
+      github_host = env["DANGER_GITHUB_HOST"] || "github.com"
+
+      # get the remote URL
+      remote = run_git("remote show origin -n").lines.grep(/Fetch URL/)[0].split(": ", 2)[1]
+      if remote
+        remote_url_matches = remote.match(%r{#{Regexp.escape github_host}(:|/)(?<repo_slug>.+/.+?)(?:\.git)?$})
+        if !remote_url_matches.nil? and remote_url_matches["repo_slug"]
+          self.repo_slug = remote_url_matches["repo_slug"]
+        else
+          puts "Danger local requires a repository hosted on GitHub.com or GitHub Enterprise."
         end
+      end
 
-        specific_pr = env["LOCAL_GIT_PR_ID"]
-        pr_ref = specific_pr ? "##{specific_pr}" : ""
-        pr_command = "log --merges --oneline"
+      specific_pr = env["LOCAL_GIT_PR_ID"]
+      pr_ref = specific_pr ? "##{specific_pr}" : ""
+      pr_command = "log --merges --oneline"
 
-        # get the most recent PR merge
-        pr_merge = run_git(pr_command.strip).lines.grep(Regexp.new("Merge pull request " + pr_ref))[0]
+      # get the most recent PR merge
+      pr_merge = run_git(pr_command.strip).lines.grep(Regexp.new("Merge pull request " + pr_ref))[0]
 
-        if pr_merge.to_s.empty?
-          if specific_pr
-            raise "Could not find the pull request (#{specific_pr}) inside the git history for this repo."
-          else
-            raise "No recent pull requests found for this repo, danger requires at least one PR for the local mode."
-          end
+      if pr_merge.to_s.empty?
+        if specific_pr
+          raise "Could not find the pull request (#{specific_pr}) inside the git history for this repo."
+        else
+          raise "No recent pull requests found for this repo, danger requires at least one PR for the local mode."
         end
-
-        self.pull_request_id = pr_merge.match("#([0-9]+)")[1]
-        sha = pr_merge.split(" ")[0]
-        parents = run_git("rev-list --parents -n 1 #{sha}").strip.split(" ")
-        self.base_commit = parents[0]
-        self.head_commit = parents[1]
       end
+
+      self.pull_request_id = pr_merge.match("#([0-9]+)")[1]
+      sha = pr_merge.split(" ")[0]
+      parents = run_git("rev-list --parents -n 1 #{sha}").strip.split(" ")
+      self.base_commit = parents[0]
+      self.head_commit = parents[1]
     end
   end
 end