Class: Danger::RequestSources::GitHub

Inherits:
RequestSource show all
Includes:
Helpers::CommentsHelper
Defined in:
lib/danger/request_source/github.rb

Constant Summary

Constants inherited from RequestSource

RequestSource::DANGER_REPO_NAME

Instance Attribute Summary collapse

Attributes inherited from RequestSource

#ci_source, #environment, #ignored_violations

Instance Method Summary collapse

Methods included from Helpers::CommentsHelper

#generate_comment, #generate_description, #markdown_parser, #parse_comment, #parse_tables_from_comment, #process_markdown, #random_compliment, #table, #table_kind_from_title, #violations_from_table

Methods inherited from RequestSource

available_request_sources, inherited, #validates_as_ci?

Constructor Details

#initialize(ci_source, environment) ⇒ GitHub

Returns a new instance of GitHub.


12
13
14
15
16
17
18
19
20
21
22
# File 'lib/danger/request_source/github.rb', line 12

def initialize(ci_source, environment)
  self.ci_source = ci_source
  self.environment = environment
  self.support_tokenless_auth = false

  Octokit.auto_paginate = true
  @token = @environment["DANGER_GITHUB_API_TOKEN"]
  if api_url
    Octokit.api_endpoint = api_url
  end
end

Instance Attribute Details

#issue_jsonObject

Returns the value of attribute issue_json


10
11
12
# File 'lib/danger/request_source/github.rb', line 10

def issue_json
  @issue_json
end

#pr_jsonObject

Returns the value of attribute pr_json


10
11
12
# File 'lib/danger/request_source/github.rb', line 10

def pr_json
  @pr_json
end

#support_tokenless_authObject

Returns the value of attribute support_tokenless_auth


10
11
12
# File 'lib/danger/request_source/github.rb', line 10

def support_tokenless_auth
  @support_tokenless_auth
end

Instance Method Details

#api_urlObject


36
37
38
39
40
41
# File 'lib/danger/request_source/github.rb', line 36

def api_url
  # `DANGER_GITHUB_API_HOST` is the old name kept for legacy reasons and
  # backwards compatibility. `DANGER_GITHUB_API_BASE_URL` is the new
  # correctly named variable.
  @environment["DANGER_GITHUB_API_HOST"] || @environment["DANGER_GITHUB_API_BASE_URL"]
end

#clientObject


43
44
45
46
# File 'lib/danger/request_source/github.rb', line 43

def client
  raise "No API token given, please provide one using `DANGER_GITHUB_API_TOKEN`" if !@token && !support_tokenless_auth
  @client ||= Octokit::Client.new(access_token: @token)
end

#delete_old_comments!(except: nil, danger_id: "danger") ⇒ Object

Get rid of the previously posted comment, to only have the latest one


165
166
167
168
169
170
171
# File 'lib/danger/request_source/github.rb', line 165

def delete_old_comments!(except: nil, danger_id: "danger")
  issue_comments.each do |comment|
    next unless comment.generated_by_danger?(danger_id)
    next if comment.id == except
    client.delete_comment(ci_source.repo_slug, comment.id)
  end
end

#fetch_detailsObject


65
66
67
68
69
70
71
72
73
# File 'lib/danger/request_source/github.rb', line 65

def fetch_details
  self.pr_json = client.pull_request(ci_source.repo_slug, ci_source.pull_request_id)
  if self.pr_json[:message] == "Moved Permanently"
    raise "Repo moved or renamed, make sure to update the git remote".red
  end

  fetch_issue_details(self.pr_json)
  self.ignored_violations = ignored_violations_from_pr(self.pr_json)
end

#fetch_issue_details(pr_json) ⇒ Object


81
82
83
84
# File 'lib/danger/request_source/github.rb', line 81

def fetch_issue_details(pr_json)
  href = pr_json[:_links][:issue][:href]
  self.issue_json = client.get(href)
end

#file_url(organisation: nil, repository: nil, branch: "master", path: nil) ⇒ String

Returns A URL to the specific file, ready to be downloaded.

Returns:

  • (String)

    A URL to the specific file, ready to be downloaded


182
183
184
185
# File 'lib/danger/request_source/github.rb', line 182

def file_url(organisation: nil, repository: nil, branch: "master", path: nil)
  organisation ||= self.organisation
  "https://raw.githubusercontent.com/#{organisation}/#{repository}/#{branch}/#{path}"
end

#hostObject


32
33
34
# File 'lib/danger/request_source/github.rb', line 32

def host
  @host = @environment["DANGER_GITHUB_HOST"] || "github.com"
end

#ignored_violations_from_pr(pr_json) ⇒ Object


75
76
77
78
79
# File 'lib/danger/request_source/github.rb', line 75

def ignored_violations_from_pr(pr_json)
  pr_body = pr_json[:body]
  return [] if pr_body.nil?
  pr_body.chomp.scan(/>\s*danger\s*:\s*ignore\s*"(.*)"/i).flatten
end

#issue_commentsObject


86
87
88
89
# File 'lib/danger/request_source/github.rb', line 86

def issue_comments
  @comments ||= client.issue_comments(ci_source.repo_slug, ci_source.pull_request_id)
                      .map { |comment| Comment.from_github(comment) }
end

#organisationString

Returns The organisation name, is nil if it can't be detected.

Returns:

  • (String)

    The organisation name, is nil if it can't be detected


174
175
176
177
178
179
# File 'lib/danger/request_source/github.rb', line 174

def organisation
  matched = self.issue_json[:repository_url].match(%r{repos\/(.*)\/})
  return matched[1] if matched && matched[1]
rescue
  nil
end

#pr_diffObject


48
49
50
# File 'lib/danger/request_source/github.rb', line 48

def pr_diff
  @pr_diff ||= client.pull_request(ci_source.repo_slug, ci_source.pull_request_id, accept: "application/vnd.github.v3.diff")
end

#scmObject


28
29
30
# File 'lib/danger/request_source/github.rb', line 28

def scm
  @scm ||= GitRepo.new
end

#setup_danger_branchesObject


52
53
54
55
56
57
58
59
60
61
62
63
# File 'lib/danger/request_source/github.rb', line 52

def setup_danger_branches
  # we can use a github specific feature here:
  base_commit = self.pr_json[:base][:sha]
  head_commit = self.pr_json[:head][:sha]

  # Next, we want to ensure that we have a version of the current branch at a known location
  self.scm.exec "branch #{EnvironmentManager.danger_base_branch} #{base_commit}"

  # OK, so we want to ensure that we have a known head branch, this will always represent
  # the head of the PR ( e.g. the most recent commit that will be merged. )
  self.scm.exec "branch #{EnvironmentManager.danger_head_branch} #{head_commit}"
end

#submit_pull_request_status!(warnings: [], errors: [], details_url: []) ⇒ Object


130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
# File 'lib/danger/request_source/github.rb', line 130

def submit_pull_request_status!(warnings: [], errors: [], details_url: [])
  status = (errors.count.zero? ? "success" : "failure")
  message = generate_description(warnings: warnings, errors: errors)

  latest_pr_commit_ref = self.pr_json[:head][:sha]

  if latest_pr_commit_ref.empty? || latest_pr_commit_ref.nil?
    raise "Couldn't find a commit to update its status".red
  end

  begin
    client.create_status(ci_source.repo_slug, latest_pr_commit_ref, status, {
      description: message,
      context: "danger/danger",
      target_url: details_url
    })
  rescue
    # This usually means the user has no commit access to this repo
    # That's always the case for open source projects where you can only
    # use a read-only GitHub account
    if errors.count > 0
      # We need to fail the actual build here
      is_private = pr_json[:base][:repo][:private]
      if is_private
        abort("\nDanger has failed this build. \nFound #{'error'.danger_pluralize(errors.count)} and I don't have write access to the PR to set a PR status.")
      else
        abort("\nDanger has failed this build. \nFound #{'error'.danger_pluralize(errors.count)}.")
      end
    else
      puts message
    end
  end
end

#update_pull_request!(warnings: [], errors: [], messages: [], markdowns: [], danger_id: "danger") ⇒ Object

Sending data to GitHub


92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
# File 'lib/danger/request_source/github.rb', line 92

def update_pull_request!(warnings: [], errors: [], messages: [], markdowns: [], danger_id: "danger")
  comment_result = {}
  editable_comments = issue_comments.select { |comment| comment.generated_by_danger?(danger_id) }

  if editable_comments.empty?
    previous_violations = {}
  else
    comment = editable_comments.first.body
    previous_violations = parse_comment(comment)
  end

  if previous_violations.empty? && (warnings + errors + messages + markdowns).empty?
    # Just remove the comment, if there's nothing to say.
    delete_old_comments!(danger_id: danger_id)
  else
    body = generate_comment(warnings: warnings,
                              errors: errors,
                            messages: messages,
                           markdowns: markdowns,
                 previous_violations: previous_violations,
                           danger_id: danger_id,
                            template: "github")

    if editable_comments.empty?
      comment_result = client.add_comment(ci_source.repo_slug, ci_source.pull_request_id, body)
    else
      original_id = editable_comments.first.id
      comment_result = client.update_comment(ci_source.repo_slug, original_id, body)
    end
  end

  # Now, set the pull request status.
  # Note: this can terminate the entire process.
  submit_pull_request_status!(warnings: warnings,
                                errors: errors,
                           details_url: comment_result["html_url"])
end

#validates_as_api_source?Boolean

Returns:

  • (Boolean)

24
25
26
# File 'lib/danger/request_source/github.rb', line 24

def validates_as_api_source?
  (@token && !@token.empty?) || self.environment["DANGER_USE_LOCAL_GIT"]
end