danger 2.0.1 → 2.1.0

data/lib/danger/ci_source/semaphore.rb

@@ -1,26 +1,32 @@
 # https://semaphoreci.com/docs/available-environment-variables.html
 
 module Danger
-  module CISource
-    # https://semaphoreci.com
-    class Semaphore < CI
-      def self.validates?(env)
-        return false unless env["SEMAPHORE"]
-        return false unless env["SEMAPHORE_REPO_SLUG"]
-        return false unless env["PULL_REQUEST_NUMBER"].to_i > 0
+  ### CI Setup
+  #
+  # For Semaphor you will want to go to the settings page of the project. Inside "Build Settings"
+  # you should add `bundle exec danger` to the Setup thread.
+  #
+  # ### Token Setup
+  #
+  # You can add your `DANGER_GITHUB_API_TOKEN` inside the "Environment Variables" section in the settings.
+  #
+  class Semaphore < CI
+    def self.validates_as_ci?(env)
+      env.key? "SEMAPHORE"
+    end
 
-        return true
-      end
+    def self.validates_as_pr?(env)
+      ["SEMAPHORE_REPO_SLUG", "PULL_REQUEST_NUMBER"].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_slug = env["SEMAPHORE_REPO_SLUG"]
-        self.pull_request_id = env["PULL_REQUEST_NUMBER"]
-        self.repo_url = GitRepo.new.origins # Semaphore doesn't provide a repo url env variable :/
-      end
+    def initialize(env)
+      self.repo_slug = env["SEMAPHORE_REPO_SLUG"]
+      self.pull_request_id = env["PULL_REQUEST_NUMBER"]
+      self.repo_url = GitRepo.new.origins # Semaphore doesn't provide a repo url env variable :/
     end
   end
 end

data/lib/danger/ci_source/surf.rb

@@ -1,25 +1,36 @@
 # http://github.com/surf-build/surf
 
 module Danger
-  module CISource
-    # http://github.com/surf-build/surf
-    class Surf < CI
-      def self.validates?(env)
-        return ["SURF_REPO", "SURF_NWO"].all? { |x| env[x] }
-      end
+  # ### 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] }
+    end
 
-      def supported_request_sources
-        @supported_request_sources ||= [Danger::RequestSources::GitHub]
-      end
+    def self.validates_as_pr?(_)
+      true
+    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
+    def supported_request_sources
+      @supported_request_sources ||= [Danger::RequestSources::GitHub]
+    end
 
-        self.repo_url = env["SURF_REPO"]
+    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

@@ -1,23 +1,42 @@
 module Danger
-  module CISource
-    # https://www.jetbrains.com/teamcity/
-    class TeamCity < CI
-      def self.validates?(env)
-        env.key? "TEAMCITY_VERSION"
-      end
+  # https://www.jetbrains.com/teamcity/
 
-      def supported_request_sources
-        @supported_request_sources ||= [Danger::RequestSources::GitHub]
-      end
+  ### 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
+  #
+  # 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 could do this via the GitHub API potentially.
+  #
+  # We would love some advice on improving this setup.
+  #
+  class TeamCity < CI
+    def self.validates_as_ci?(env)
+      env.key? "TEAMCITY_VERSION"
+    end
+
+    def self.validates_as_pr?(env)
+      ["GITHUB_PULL_REQUEST_ID", "GITHUB_REPO_URL", "GITHUB_REPO_SLUG"].all? { |x| env[x] }
+    end
+
+    def supported_request_sources
+      @supported_request_sources ||= [Danger::RequestSources::GitHub]
+    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
-        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 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
+      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
   end
 end

data/lib/danger/ci_source/travis.rb

@@ -2,28 +2,49 @@
 # http://docs.travis-ci.com/user/environment-variables/
 
 module Danger
-  module CISource
-    # https://travis-ci.com
-    class Travis < CI
-      def self.validates?(env)
-        return false unless env["HAS_JOSH_K_SEAL_OF_APPROVAL"]
-        return false unless env["TRAVIS_REPO_SLUG"]
-        return false unless env["TRAVIS_PULL_REQUEST"]
+  ### 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
 
-        return true
-      end
+    def self.validates_as_pr?(env)
+      exists = ["TRAVIS_PULL_REQUEST", "TRAVIS_REPO_SLUG"].all? { |x| env[x] }
+      exists && env["TRAVIS_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["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 :/
+    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/xcode_server.rb

@@ -1,29 +1,42 @@
 # Following the advice from @czechboy0 https://github.com/danger/danger/issues/171
 
 module Danger
-  module CISource
-    # https://github.com/czechboy0/Buildasaur
-    class XcodeServer < CI
-      def self.validates?(env)
-        return false unless env["XCS_BOT_NAME"]
+  # https://github.com/czechboy0/Buildasaur
+  class XcodeServer < CI
+    ### 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-actoin 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`.`.
+    #
+    def self.validates_as_ci?(env)
+      env.key? "XCS_BOT_NAME"
+    end
 
-        return true
-      end
+    def self.validates_as_pr?(env)
+      env["XCS_BOT_NAME"].include? "BuildaBot"
+    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)
-        bot_name = env["XCS_BOT_NAME"]
-        return if bot_name.nil?
+    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
+      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/commands/runner.rb

@@ -2,6 +2,7 @@ module Danger
   class Runner < CLAide::Command
     require "danger/commands/init"
     require "danger/commands/local"
+    require "danger/commands/systems"
 
     # manually set claide plugins as a subcommand
     require "claide_plugin"

data/lib/danger/commands/systems.rb

@@ -0,0 +1,41 @@
+module Danger
+  class Systems < Runner
+    self.abstract_command = true
+    self.description = "For commands related to passing information from Danger to Danger.Systems."
+    self.summary = "Create data for Danger.Systems."
+  end
+
+  class CIDocs < Systems
+    self.command = "ci_docs"
+    self.summary = "Outputs the up-to-date CI documentation for Danger."
+
+    def run
+      here = File.dirname(__FILE__)
+      ci_source_paths = Dir.glob(here + "/../ci_source/*.rb")
+
+      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 }
+
+      # Fail if anything is added and not documented
+      cis_without_docs = ci_sources.select { |source| source.base_docstring.empty? }
+      unless cis_without_docs.empty?
+        cork.puts "Please add docs to: #{cis_without_docs.map(&:name).join(', ')}"
+        abort("Failed.".red)
+      end
+
+      # Output a JSON array of name and details
+      require "json"
+      cork.puts ci_sources.map { |ci|
+        {
+          name: ci.name,
+          docs: ci.docstring
+        }
+      }.to_json
+    end
+  end
+end

data/lib/danger/danger_core/environment_manager.rb

@@ -5,31 +5,29 @@ module Danger
   class EnvironmentManager
     attr_accessor :ci_source, :request_source, :scm
 
-    def initialize(env)
-      CISource::CI.available_ci_sources.each do |klass|
-        next unless klass.validates?(env)
-
-        self.ci_source = klass.new(env)
-        if self.ci_source.repo_slug and self.ci_source.pull_request_id
-          break
-        else
-          self.ci_source = nil
-          return nil
-        end
-      end
+    # Finds a Danger::CI class based on the ENV
+    def self.local_ci_source(env)
+      CI.available_ci_sources.find { |ci| ci.validates_as_ci? env }
+    end
 
-      raise "Could not find a valid pull request within the known CI sources".red unless self.ci_source
+    # Uses the current Danger::CI subclass, and sees if it is a PR
+    def self.pr?(env)
+      local_ci_source(env).validates_as_pr?(env)
+    end
+
+    def initialize(env)
+      ci_klass = self.class.local_ci_source(env)
+      self.ci_source = ci_klass.new(env)
 
       RequestSources::RequestSource.available_request_sources.each do |klass|
         next unless self.ci_source.supports?(klass)
 
         request_source = klass.new(self.ci_source, ENV)
-        next unless request_source.validates?
+        next unless request_source.validates_as_ci?
         self.request_source = request_source
       end
 
-      raise "Could not find a Request Source".red unless self.request_source
-
+      raise "Could not find a Request Source for #{ci_klass}".red unless self.request_source
       self.scm = self.request_source.scm
     end
 

data/lib/danger/danger_core/executor.rb

@@ -10,37 +10,46 @@ module Danger
 
       cork ||= Cork::Board.new(silent: false,
                               verbose: false)
+
+      # Could we find a CI source at all?
+      unless EnvironmentManager.local_ci_source(ENV)
+        abort("Could not find the type of CI for Danger to run on.".red) unless ci_klass
+      end
+
+      # Could we determine that the CI source is inside a PR?
+      unless EnvironmentManager.pr?(ENV)
+        cork.puts "Not a Pull Request - skipping `danger` run".yellow
+        return
+      end
+
+      # OK, then we can have some
       env ||= EnvironmentManager.new(ENV)
       dm ||= Dangerfile.new(env, cork)
 
-      if dm.env.pr?
-        dm.init_plugins
-
-        dm.env.fill_environment_vars
+      dm.init_plugins
 
-        begin
-          dm.env.ensure_danger_branches_are_setup
+      dm.env.fill_environment_vars
 
-          # Offer the chance for a user to specify a branch through the command line
-          ci_base = base || EnvironmentManager.danger_base_branch
-          ci_head = head || EnvironmentManager.danger_head_branch
-          dm.env.scm.diff_for_folder(".", from: ci_base, to: ci_head)
+      begin
+        dm.env.ensure_danger_branches_are_setup
 
-          dm.parse(Pathname.new(dangerfile_path))
+        # Offer the chance for a user to specify a branch through the command line
+        ci_base = base || EnvironmentManager.danger_base_branch
+        ci_head = head || EnvironmentManager.danger_head_branch
+        dm.env.scm.diff_for_folder(".", from: ci_base, to: ci_head)
 
-          if dm.env.request_source.organisation && !dm.env.request_source.danger_repo? && (danger_repo = dm.env.request_source.fetch_danger_repo)
-            url = dm.env.request_source.file_url(repository: danger_repo.name, path: "Dangerfile")
-            path = dm.plugin.download(url)
-            dm.parse(Pathname.new(path))
-          end
+        dm.parse(Pathname.new(dangerfile_path))
 
-          post_results(dm, danger_id)
-          dm.print_results
-        ensure
-          dm.env.clean_up
+        if dm.env.request_source.organisation && !dm.env.request_source.danger_repo? && (danger_repo = dm.env.request_source.fetch_danger_repo)
+          url = dm.env.request_source.file_url(repository: danger_repo.name, path: "Dangerfile")
+          path = dm.plugin.download(url)
+          dm.parse(Pathname.new(path))
         end
-      else
-        cork.puts "Not a Pull Request - skipping `danger` run"
+
+        post_results(dm, danger_id)
+        dm.print_results
+      ensure
+        dm.env.clean_up
       end
     end