danger-additional-logging 0.0.1

data/lib/danger/ci_source/drone.rb

@@ -0,0 +1,71 @@
+# http://readme.drone.io/usage/variables/
+require "danger/request_sources/github/github"
+require "danger/request_sources/gitlab"
+
+module Danger
+  # ### 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 expose the `DANGER_GITHUB_API_TOKEN` as a secret to your
+  # builds:
+  #
+  # Drone secrets: http://readme.drone.io/usage/secret-guide/
+  # NOTE: This is a new syntax in DroneCI 0.6+
+  #
+  # ```yml
+  #   build:
+  #     image: golang
+  #     secrets:
+  #       - DANGER_GITHUB_API_TOKEN
+  #     commands:
+  #       - ...
+  #       - bundle exec danger
+  # ```
+  class Drone < CI
+    def self.validates_as_ci?(env)
+      validates_as_ci_post_06?(env) or validates_as_ci_pre_06?(env)
+    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, Danger::RequestSources::GitLab]
+    end
+
+    def initialize(env)
+      if self.class.validates_as_ci_post_06?(env)
+        self.repo_slug = "#{env['DRONE_REPO_OWNER']}/#{env['DRONE_REPO_NAME']}"
+        self.repo_url = env["DRONE_REPO_LINK"] if self.class.validates_as_ci_post_06?(env)
+      elsif self.class.validates_as_ci_pre_06?(env)
+        self.repo_slug = env["DRONE_REPO"]
+        self.repo_url = GitRepo.new.origins
+      end
+
+      self.pull_request_id = env["DRONE_PULL_REQUEST"]
+    end
+
+    # Check if this build is valid for CI with drone 0.6 or later
+    def self.validates_as_ci_post_06?(env)
+      env.key? "DRONE_REPO_OWNER" and env.key? "DRONE_REPO_NAME"
+    end
+
+    # Checks if this build is valid for CI with drone 0.5 or earlier
+    def self.validates_as_ci_pre_06?(env)
+      env.key? "DRONE_REPO"
+    end
+  end
+end

data/lib/danger/ci_source/github_actions.rb

@@ -0,0 +1,44 @@
+require "danger/request_sources/github/github"
+
+module Danger
+  # ### CI Setup
+  #
+  # You can use `danger/danger` Action in your `.github/workflows/xxx.yml`.
+  # And so, you can use GITHUB_TOKEN secret as `DANGER_GITHUB_API_TOKEN` environment variable.
+  #
+  #  ```yml
+  #  ...
+  #    steps:
+  #      - uses: actions/checkout@v3
+  #      - uses: danger/danger@master
+  #        env:
+  #          DANGER_GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+  #  ```
+  #
+  class GitHubActions < CI
+    def self.validates_as_ci?(env)
+      env.key? "GITHUB_ACTION"
+    end
+
+    def self.validates_as_pr?(env)
+      value = env["GITHUB_EVENT_NAME"]
+      ["pull_request", "pull_request_target"].include?(value)
+    end
+
+    def supported_request_sources
+      @supported_request_sources ||= [Danger::RequestSources::GitHub]
+    end
+
+    def initialize(env)
+      self.repo_slug = env["GITHUB_REPOSITORY"]
+      pull_request_event = JSON.parse(File.read(env["GITHUB_EVENT_PATH"]))
+      self.pull_request_id = pull_request_event["number"]
+      self.repo_url = pull_request_event["repository"]["clone_url"]
+
+      # if environment variable DANGER_GITHUB_API_TOKEN is not set, use env GITHUB_TOKEN
+      if (env.key? "GITHUB_ACTION") && (!env.key? "DANGER_GITHUB_API_TOKEN")
+        env["DANGER_GITHUB_API_TOKEN"] = env["GITHUB_TOKEN"]
+      end
+    end
+  end
+end

data/lib/danger/ci_source/gitlab_ci.rb

@@ -0,0 +1,89 @@
+# http://docs.gitlab.com/ce/ci/variables/README.html
+require "uri"
+require "danger/request_sources/github/github"
+require "danger/request_sources/gitlab"
+
+module Danger
+  # ### CI Setup
+  #
+  # Install dependencies and add a danger step to your .gitlab-ci.yml:
+  #
+  # ```yml
+  # before_script:
+  #  - bundle install
+  # danger:
+  #   script:
+  #    - bundle exec danger
+  # ```
+  #
+  # ### Token Setup
+  #
+  # Add the `DANGER_GITLAB_API_TOKEN` to your pipeline env variables if you
+  # are hosting your code on GitLab. If you are using GitLab as a mirror
+  # for the purpose of CI/CD, while hosting your repo on GitHub, set the
+  # `DANGER_GITHUB_API_TOKEN` as well as the project repo URL to
+  # `DANGER_PROJECT_REPO_URL`.
+
+  class GitLabCI < CI
+    def self.validates_as_ci?(env)
+      env.key? "GITLAB_CI"
+    end
+
+    def self.validates_as_pr?(env)
+      exists = [
+        "GITLAB_CI", "CI_PROJECT_PATH"
+      ].all? { |x| env[x] }
+
+      exists && determine_pull_or_merge_request_id(env).to_i > 0
+    end
+
+    def self.determine_pull_or_merge_request_id(env)
+      return env["CI_MERGE_REQUEST_IID"] if env["CI_MERGE_REQUEST_IID"]
+      return env["CI_EXTERNAL_PULL_REQUEST_IID"] if env["CI_EXTERNAL_PULL_REQUEST_IID"]
+      return 0 unless env["CI_COMMIT_SHA"]
+
+      project_path = env["CI_MERGE_REQUEST_PROJECT_PATH"] || env["CI_PROJECT_PATH"]
+      base_commit = env["CI_COMMIT_SHA"]
+      client = RequestSources::GitLab.new(nil, env).client
+
+      client_version = Gem::Version.new(client.version.version)
+      if client_version >= Gem::Version.new("10.7")
+        # Use the 'list merge requests associated with a commit' API, for speed
+        # (GET /projects/:id/repository/commits/:sha/merge_requests) available for GitLab >= 10.7
+        merge_request = client.commit_merge_requests(project_path, base_commit, state: :opened).first
+        if client_version >= Gem::Version.new("13.8")
+          # Gitlab 13.8.0 started returning merge requests for merge commits and squashed commits
+          # By checking for merge_request.state, we can ensure danger only comments on MRs which are open
+          return 0 if merge_request.nil?
+          return 0 unless merge_request.state == "opened"
+        end
+      else
+        merge_requests = client.merge_requests(project_path, state: :opened)
+        merge_request = merge_requests.auto_paginate.find do |mr|
+          mr.sha == base_commit
+        end
+      end
+      merge_request.nil? ? 0 : merge_request.iid
+    end
+
+    def self.slug_from(env)
+      if env["DANGER_PROJECT_REPO_URL"]
+        env["DANGER_PROJECT_REPO_URL"].split("/").last(2).join("/")
+      else
+        env["CI_MERGE_REQUEST_PROJECT_PATH"] || env["CI_PROJECT_PATH"]
+      end
+    end
+
+    def initialize(env)
+      self.repo_slug = self.class.slug_from(env)
+      self.pull_request_id = self.class.determine_pull_or_merge_request_id(env)
+    end
+
+    def supported_request_sources
+      @supported_request_sources ||= [
+        Danger::RequestSources::GitHub,
+        Danger::RequestSources::GitLab
+      ]
+    end
+  end
+end

data/lib/danger/ci_source/jenkins.rb

@@ -0,0 +1,148 @@
+# https://wiki.jenkins-ci.org/display/JENKINS/Building+a+software+project#Buildingasoftwareproject-JenkinsSetEnvironmentVariables
+# https://wiki.jenkins-ci.org/display/JENKINS/GitHub+pull+request+builder+plugin
+require "danger/request_sources/github/github"
+require "danger/request_sources/gitlab"
+require "danger/request_sources/bitbucket_server"
+require "danger/request_sources/bitbucket_cloud"
+
+module Danger
+  # https://jenkins-ci.org
+
+  # ### CI Setup
+  # Ah Jenkins, so many memories. So, if you're using Jenkins, you're hosting your own environment.
+  #
+  # #### GitHub
+  # 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.
+  #
+  # ##### Pipeline
+  # If your're using [pipelines](https://jenkins.io/solutions/pipeline/) you should be using the [GitHub branch source plugin](https://wiki.jenkins-ci.org/display/JENKINS/GitHub+Branch+Source+Plugin)
+  # for easy setup and handling of PRs.
+  #
+  # After you've set up the plugin, add a `sh 'bundle exec danger'` line in your pipeline script and make sure that build PRs is enabled.
+  #
+  # #### GitLab
+  # You will want to be using the [GitLab Plugin](https://github.com/jenkinsci/gitlab-plugin)
+  # in order to ensure that you have the build environment set up for MR integration.
+  #
+  # With that set up, you can edit your job to add `bundle exec danger` at the build action.
+  #
+  # #### General
+  #
+  # People occasionally see issues with Danger not classing your CI runs as a PR, to give you visibility
+  # the Jenkins side of Danger expects to see one of these env vars:
+  # - ghprbPullId
+  # - CHANGE_ID
+  # - gitlabMergeRequestIid
+  # - gitlabMergeRequestId
+  #
+  # ### Token Setup
+  #
+  # #### GitHub
+  # As you own the machine, it's up to you to add the environment variable for the `DANGER_GITHUB_API_TOKEN`.
+  #
+  # #### GitLab
+  # As you own the machine, it's up to you to add the environment variable for the `DANGER_GITLAB_API_TOKEN`.
+  #
+  class Jenkins < CI
+    attr_accessor :project_url
+
+    class EnvNotFound < StandardError
+      def initialize
+        super("ENV not found, please check your Jenkins. Related: https://stackoverflow.com/search?q=jenkins+env+null")
+      end
+    end
+
+    def self.validates_as_ci?(env)
+      env.key? "JENKINS_URL"
+    end
+
+    def self.validates_as_pr?(env)
+      id = pull_request_id(env)
+      !id.nil? && !id.empty? && !!id.match(/^\d+$/)
+    end
+
+    def supported_request_sources
+      @supported_request_sources ||= [
+        Danger::RequestSources::GitHub,
+        Danger::RequestSources::GitLab,
+        Danger::RequestSources::BitbucketServer,
+        Danger::RequestSources::BitbucketCloud
+      ]
+    end
+
+    def initialize(env)
+      raise EnvNotFound.new if env.nil? || env.empty?
+
+      self.repo_url = self.class.repo_url(env)
+      self.pull_request_id = self.class.pull_request_id(env)
+      self.repo_slug = self.class.repo_slug(self.repo_url)
+      self.project_url = env["CI_MERGE_REQUEST_PROJECT_URL"] || env["CI_PROJECT_URL"]
+    end
+
+    def self.repo_slug(repo_url)
+      slug = self.slug_ssh(repo_url)
+      slug ||= self.slug_http(repo_url)
+      slug ||= self.slug_bitbucket(repo_url)
+      slug ||= self.slug_fallback(repo_url)
+      return slug.gsub(/\.git$/, "") unless slug.nil?
+    end
+
+    def self.slug_bitbucket(repo_url)
+      repo_matches = repo_url.match(%r{(?:[/:])projects/([^/.]+)/repos/([^/.]+)})
+      return "#{repo_matches[1]}/#{repo_matches[2]}" if repo_matches
+    end
+
+    def self.slug_ssh(repo_url)
+      repo_matches = repo_url.match(/^git@.+:(.+)/)
+      return repo_matches[1] if repo_matches
+    end
+
+    def self.slug_http(repo_url)
+      repo_matches = repo_url.match(%r{^https?.+(?>\.\w*\d*/)(.+.git$)})
+      return repo_matches[1] if repo_matches
+    end
+
+    def self.slug_fallback(repo_url)
+      repo_matches = repo_url.match(%r{([/:])([^/]+/[^/]+)$})
+      return repo_matches[2]
+    end
+
+    def self.pull_request_id(env)
+      if env["ghprbPullId"]
+        env["ghprbPullId"]
+      elsif env["CHANGE_ID"]
+        env["CHANGE_ID"]
+      elsif env["gitlabMergeRequestIid"]
+        env["gitlabMergeRequestIid"]
+      else
+        env["gitlabMergeRequestId"]
+      end
+    end
+
+    def self.repo_url(env)
+      if env["GIT_URL_1"]
+        env["GIT_URL_1"]
+      elsif env["CHANGE_URL"]
+        change_url = env["CHANGE_URL"]
+        case change_url
+        when %r{/pull/} # GitHub
+          matches = change_url.match(%r{(.+)/pull/[0-9]+})
+          matches[1] unless matches.nil?
+        when %r{/merge_requests/} # GitLab
+          matches = change_url.match(%r{(.+?)(/-)?/merge_requests/[0-9]+})
+          matches[1] unless matches.nil?
+        when %r{/pull-requests/} # Bitbucket
+          matches = change_url.match(%r{(.+)/pull-requests/[0-9]+})
+          matches[1] unless matches.nil?
+        else
+          change_url
+        end
+      else
+        env["GIT_URL"]
+      end
+    end
+  end
+end

data/lib/danger/ci_source/local_git_repo.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+# For more info see: https://github.com/schacon/ruby-git
+
+require "git"
+require "uri"
+
+require "danger/request_sources/github/github"
+
+require "danger/ci_source/support/find_repo_info_from_url"
+require "danger/ci_source/support/find_repo_info_from_logs"
+require "danger/ci_source/support/no_repo_info"
+require "danger/ci_source/support/pull_request_finder"
+require "danger/ci_source/support/commits"
+
+module Danger
+  # ignore
+  class LocalGitRepo < CI
+    attr_accessor :base_commit, :head_commit
+
+    def self.validates_as_ci?(env)
+      env.key? "DANGER_USE_LOCAL_GIT"
+    end
+
+    def self.validates_as_pr?(_env)
+      false
+    end
+
+    def git
+      @git ||= GitRepo.new
+    end
+
+    def run_git(command)
+      git.exec(command).encode("UTF-8", "binary", invalid: :replace, undef: :replace, replace: "")
+    end
+
+    def supported_request_sources
+      @supported_request_sources ||= [
+        Danger::RequestSources::GitHub,
+        Danger::RequestSources::BitbucketServer,
+        Danger::RequestSources::BitbucketCloud,
+        Danger::RequestSources::VSTS
+      ]
+    end
+
+    def initialize(env = {})
+      @remote_info = find_remote_info(env)
+      @found_pull_request = find_pull_request(env)
+      self.repo_slug = remote_info.slug
+      raise_error_for_missing_remote if remote_info.kind_of?(NoRepoInfo)
+
+      self.pull_request_id = found_pull_request.pull_request_id
+
+      if sha
+        self.base_commit = commits.base
+        self.head_commit = commits.head
+      else
+        self.base_commit = found_pull_request.base
+        self.head_commit = found_pull_request.head
+      end
+    end
+
+    private
+
+    attr_reader :remote_info, :found_pull_request
+
+    def raise_error_for_missing_remote
+      raise missing_remote_error_message
+    end
+
+    def missing_remote_error_message
+      "danger cannot find your git remote, please set a remote. " \
+      "And the repository must host on GitHub.com or GitHub Enterprise."
+    end
+
+    def find_remote_info(env)
+      if given_pull_request_url?(env)
+        FindRepoInfoFromURL.new(env["LOCAL_GIT_PR_URL"]).call
+      else
+        FindRepoInfoFromLogs.new(
+          env["DANGER_GITHUB_HOST"] || "github.com",
+          run_git("remote show origin -n")
+        ).call
+      end || NoRepoInfo.new
+    end
+
+    def find_pull_request(env)
+      if given_pull_request_url?(env)
+        PullRequestFinder.new(
+          remote_info.id,
+          remote_info.slug,
+          remote: true,
+          remote_url: env["LOCAL_GIT_PR_URL"]
+        ).call(env: env)
+      else
+        PullRequestFinder.new(
+          env.fetch("LOCAL_GIT_PR_ID") { "" },
+          remote_info.slug,
+          remote: false,
+          git_logs: run_git("log --oneline -1000000")
+        ).call(env: env)
+      end
+    end
+
+    def given_pull_request_url?(env)
+      env["LOCAL_GIT_PR_URL"] && !env["LOCAL_GIT_PR_URL"].empty?
+    end
+
+    def sha
+      @_sha ||= found_pull_request.sha
+    end
+
+    def commits
+      @_commits ||= Commits.new(run_git("rev-list --parents -n 1 #{sha}"))
+    end
+  end
+end

data/lib/danger/ci_source/local_only_git_repo.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require "git"
+require "danger/request_sources/local_only"
+
+module Danger
+  # ### CI Setup
+  #
+  # For setting up LocalOnlyGitRepo there is not much needed. Either `--base` and `--head` need to be specified or
+  # origin/master is expected for base and HEAD for head
+  #
+  class LocalOnlyGitRepo < CI
+    attr_accessor :base_commit, :head_commit
+
+    HEAD_VAR = "DANGER_LOCAL_HEAD"
+    BASE_VAR = "DANGER_LOCAL_BASE"
+
+    def self.validates_as_ci?(env)
+      env.key? "DANGER_USE_LOCAL_ONLY_GIT"
+    end
+
+    def self.validates_as_pr?(_env)
+      false
+    end
+
+    def git
+      @git ||= GitRepo.new
+    end
+
+    def run_git(command)
+      git.exec(command).encode("UTF-8", "binary", invalid: :replace, undef: :replace, replace: "")
+    end
+
+    def supported_request_sources
+      @supported_request_sources ||= [Danger::RequestSources::LocalOnly]
+    end
+
+    def initialize(env = {})
+      # expects --base/--head specified OR origin/master to be base and HEAD head
+      self.base_commit = env[BASE_VAR] || run_git("rev-parse --abbrev-ref origin/master")
+      self.head_commit = env[HEAD_VAR] || run_git("rev-parse --abbrev-ref HEAD")
+    end
+  end
+end

data/lib/danger/ci_source/screwdriver.rb

@@ -0,0 +1,48 @@
+# http://screwdriver.cd
+# https://docs.screwdriver.cd/user-guide/environment-variables
+require "danger/request_sources/github/github"
+
+module Danger
+  # ### CI Setup
+  #
+  # Install dependencies and add a danger step to your screwdriver.yaml:
+  #
+  # ```yml
+  # jobs:
+  #   danger:
+  #     requires: [~pr, ~commit]
+  #     steps:
+  #       - setup: bundle install --path vendor
+  #       - danger: bundle exec danger
+  #     secrets:
+  #       - DANGER_GITHUB_API_TOKEN
+  # ```
+  #
+  # ### Token Setup
+  #
+  # Add the `DANGER_GITHUB_API_TOKEN` to your pipeline env as a
+  # [build secret](https://docs.screwdriver.cd/user-guide/configuration/secrets)
+  #
+  class Screwdriver < CI
+    def self.validates_as_ci?(env)
+      env.key? "SCREWDRIVER"
+    end
+
+    def self.validates_as_pr?(env)
+      exists = ["SD_PULL_REQUEST", "SCM_URL"].all? { |x| env[x] && !env[x].empty? }
+      exists && env["SD_PULL_REQUEST"].to_i > 0
+    end
+
+    def supported_request_sources
+      @supported_request_sources ||= [Danger::RequestSources::GitHub]
+    end
+
+    def initialize(env)
+      self.repo_slug = env["SCM_URL"].split(":").last.gsub(".git", "").split("#", 2).first
+      self.repo_url = env["SCM_URL"].split("#", 2).first
+      if env["SD_PULL_REQUEST"].to_i > 0
+        self.pull_request_id = env["SD_PULL_REQUEST"]
+      end
+    end
+  end
+end

data/lib/danger/ci_source/semaphore.rb

@@ -0,0 +1,37 @@
+# https://docs.semaphoreci.com/article/12-environment-variables
+require "danger/request_sources/github/github"
+
+module Danger
+  # ### CI Setup
+  #
+  # For Semaphore 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. Note that Semaphore only provides
+  # the build environment variables necessary for Danger on PRs across forks.
+  #
+  # ### 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
+
+    def self.validates_as_pr?(env)
+      one = ["SEMAPHORE_REPO_SLUG", "PULL_REQUEST_NUMBER"].all? { |x| env[x] && !env[x].empty? }
+      two = ["SEMAPHORE_GIT_REPO_SLUG", "SEMAPHORE_GIT_PR_NUMBER"].all? { |x| env[x] && !env[x].empty? }
+
+      one || two
+    end
+
+    def supported_request_sources
+      @supported_request_sources ||= [Danger::RequestSources::GitHub]
+    end
+
+    def initialize(env)
+      self.repo_slug = env["SEMAPHORE_GIT_REPO_SLUG"] || env["SEMAPHORE_REPO_SLUG"]
+      self.pull_request_id = env["SEMAPHORE_GIT_PR_NUMBER"] || env["PULL_REQUEST_NUMBER"]
+      self.repo_url = env["SEMAPHORE_GIT_URL"] || GitRepo.new.origins
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Danger
+  class Commits
+    def initialize(base_head)
+      @base_head = base_head.strip.split(" ".freeze)
+    end
+
+    def base
+      base_head.first
+    end
+
+    def head
+      base_head.last
+    end
+
+    private
+
+    attr_reader :base_head
+  end
+end

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

@@ -0,0 +1,35 @@
+require "danger/ci_source/support/repo_info"
+
+module Danger
+  class FindRepoInfoFromLogs
+    def initialize(github_host, remote_logs)
+      @github_host = github_host
+      @remote_logs = remote_logs
+    end
+
+    def call
+      matched = remote.match(regexp)
+
+      if matched
+        RepoInfo.new(matched["repo_slug"], nil)
+      end
+    end
+
+    private
+
+    attr_reader :remote_logs, :github_host
+
+    def remote
+      remote_logs.lines.grep(/Fetch URL/)[0].split(": ".freeze, 2)[1]
+    end
+
+    def regexp
+      %r{
+        #{Regexp.escape(github_host)}
+        (:|/|(:/))
+        (?<repo_slug>[^/]+/.+?)
+        (?:\.git)?$
+      }x
+    end
+  end
+end