Class: Danger::RequestSources::GitHub

Inherits:
RequestSource show all
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 inherited from RequestSource

available_request_sources, inherited, #validates?

Constructor Details

#initialize(ci_source, environment) ⇒ GitHub

Returns a new instance of GitHub.



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

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 @environment['DANGER_GITHUB_API_HOST']
    Octokit.api_endpoint = @environment['DANGER_GITHUB_API_HOST']
  end
end

Instance Attribute Details

#issue_json ⇒ Object

Returns the value of attribute issue_json.



8
9
10
 
# File 'lib/danger/request_source/github.rb', line 8

def issue_json
  @issue_json
end

#pr_json ⇒ Object

Returns the value of attribute pr_json.



8
9
10
 
# File 'lib/danger/request_source/github.rb', line 8

def pr_json
  @pr_json
end

#support_tokenless_auth ⇒ Object

Returns the value of attribute support_tokenless_auth.



8
9
10
 
# File 'lib/danger/request_source/github.rb', line 8

def support_tokenless_auth
  @support_tokenless_auth
end

Instance Method Details

#client ⇒ Object 



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

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

#danger_repo?(organisation: nil, repository: nil) ⇒ Bool

Returns is this repo the danger repo of the org?.

Returns:

  • (Bool) —

    is this repo the danger repo of the org?



273
274
275
276
277
278
 
# File 'lib/danger/request_source/github.rb', line 273

def danger_repo?(organisation: nil, repository: nil)
  repo = fetch_repository(organisation: organisation, repository: repository)
  repo[:name].casecmp(DANGER_REPO_NAME).zero?
rescue
  false
end

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

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



148
149
150
151
152
153
154
155
 
# File 'lib/danger/request_source/github.rb', line 148

def delete_old_comments!(except: nil, danger_id: 'danger')
  issues = client.issue_comments(ci_source.repo_slug, ci_source.pull_request_id)
  issues.each do |issue|
    next unless issue[:body].include?("generated_by_#{danger_id}")
    next if issue[:id] == except
    client.delete_comment(ci_source.repo_slug, issue[:id])
  end
end

#fetch_danger_repo(organisation: nil) ⇒ Hash

With the information about the repo. This will automatically detect if the repo is capitalised returns nil if there is no danger repo

Returns:

  • (Hash) —

    with the information about the repo. This will automatically detect if the repo is capitalised returns nil if there is no danger repo



265
266
267
268
269
270
 
# File 'lib/danger/request_source/github.rb', line 265

def fetch_danger_repo(organisation: nil)
  data = nil
  data ||= fetch_repository(organisation: organisation, repository: DANGER_REPO_NAME.downcase)
  data ||= fetch_repository(organisation: organisation, repository: DANGER_REPO_NAME.capitalize)
  data
end

#fetch_details ⇒ Object 



56
57
58
59
60
 
# File 'lib/danger/request_source/github.rb', line 56

def fetch_details
  self.pr_json = client.pull_request(ci_source.repo_slug, ci_source.pull_request_id)
  fetch_issue_details(self.pr_json)
  self.ignored_violations = ignored_violations_from_pr(self.pr_json)
end

#fetch_issue_details(pr_json) ⇒ Object 



68
69
70
71
 
# File 'lib/danger/request_source/github.rb', line 68

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

#fetch_repository(organisation: nil, repository: nil) ⇒ Hash

With the information about the repo returns nil if the repo is not available

Returns:

  • (Hash) —

    with the information about the repo returns nil if the repo is not available



254
255
256
257
258
259
260
 
# File 'lib/danger/request_source/github.rb', line 254

def fetch_repository(organisation: nil, repository: nil)
  organisation ||= self.organisation
  repository ||= self.ci_source.repo_slug.split("/").last
  self.client.repo("#{organisation}/#{repository}")
rescue Octokit::NotFound
  nil # repo doesn't exist
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



281
282
283
284
 
# File 'lib/danger/request_source/github.rb', line 281

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

#generate_comment(warnings: [], errors: [], messages: [], markdowns: [], previous_violations: {}, danger_id: 'danger') ⇒ Object 



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/danger/request_source/github.rb', line 175

def generate_comment(warnings: [], errors: [], messages: [], markdowns: [], previous_violations: {}, danger_id: 'danger')
  require 'erb'

  md_template = File.join(Danger.gem_path, 'lib/danger/comment_generators/github.md.erb')

  # erb: http://www.rrn.dk/rubys-erb-templating-system
  # for the extra args: http://stackoverflow.com/questions/4632879/erb-template-removing-the-trailing-line
  @tables = [
    table('Error', 'no_entry_sign', errors, previous_violations),
    table('Warning', 'warning', warnings, previous_violations),
    table('Message', 'book', messages, previous_violations)
  ]
  @markdowns = markdowns
  @danger_id = danger_id

  return ERB.new(File.read(md_template), 0, '-').result(binding)
end

#generate_github_description(warnings: nil, errors: nil) ⇒ Object 



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

def generate_github_description(warnings: nil, errors: nil)
  if errors.empty? && warnings.empty?
    return "All green. #{random_compliment}"
  else
    message = "⚠ "
    message += "#{'Error'.danger_pluralize(errors.count)}. " unless errors.empty?
    message += "#{'Warning'.danger_pluralize(warnings.count)}. " unless warnings.empty?
    message += "Don't worry, everything is fixable."
    return message
  end
end

#host ⇒ Object 



26
27
28
 
# File 'lib/danger/request_source/github.rb', line 26

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

#ignored_violations_from_pr(pr_json) ⇒ Object 



62
63
64
65
66
 
# File 'lib/danger/request_source/github.rb', line 62

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

#markdown_parser ⇒ Object 



35
36
37
 
# File 'lib/danger/request_source/github.rb', line 35

def markdown_parser
  @markdown_parser ||= Redcarpet::Markdown.new(Redcarpet::Render::HTML, no_intra_emphasis: true)
end

#organisation ⇒ String

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



245
246
247
248
249
250
 
# File 'lib/danger/request_source/github.rb', line 245

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

#parse_comment(comment) ⇒ Object 



203
204
205
206
207
208
209
210
211
212
213
214
215
216
 
# File 'lib/danger/request_source/github.rb', line 203

def parse_comment(comment)
  tables = parse_tables_from_comment(comment)
  violations = {}
  tables.each do |table|
    next unless table =~ %r{<th width="100%"(.*?)</th>}im
    title = Regexp.last_match(1)
    kind = table_kind_from_title(title)
    next unless kind

    violations[kind] = violations_from_table(table)
  end

  violations.reject { |_, v| v.empty? }
end

#parse_tables_from_comment(comment) ⇒ Object 



233
234
235
 
# File 'lib/danger/request_source/github.rb', line 233

def parse_tables_from_comment(comment)
  comment.split("</table>")
end

#pr_diff ⇒ Object 



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

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

#process_markdown(violation) ⇒ Object 



237
238
239
240
241
242
 
# File 'lib/danger/request_source/github.rb', line 237

def process_markdown(violation)
  html = markdown_parser.render(violation.message)
  # Remove the outer `<p>`, the -5 represents a newline + `</p>`
  html = html[3...-5] if html.start_with? "<p>"
  Violation.new(html, violation.sticky)
end

#random_compliment ⇒ Object 



157
158
159
160
161
 
# File 'lib/danger/request_source/github.rb', line 157

def random_compliment
  compliment = ['Well done.', 'Congrats.', 'Woo!',
                'Yay.', 'Jolly good show.', "Good on 'ya.", 'Nice work.']
  compliment.sample
end

#scm ⇒ Object 



22
23
24
 
# File 'lib/danger/request_source/github.rb', line 22

def scm
  @scm ||= GitRepo.new
end

#setup_danger_branches ⇒ Object 



43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/danger/request_source/github.rb', line 43

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 



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/danger/request_source/github.rb', line 113

def submit_pull_request_status!(warnings: [], errors: [], details_url: [])
  status = (errors.count.zero? ? 'success' : 'failure')
  message = generate_github_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 set a PR status.")
      else
        abort("\nDanger has failed this build. \nFound #{'error'.danger_pluralize(errors.count)}.")
      end
    else
      puts message
    end
  end
end

#table(name, emoji, violations, all_previous_violations) ⇒ Object 



193
194
195
196
197
198
199
200
201
 
# File 'lib/danger/request_source/github.rb', line 193

def table(name, emoji, violations, all_previous_violations)
  content = violations.map { |v| process_markdown(v) }.uniq
  kind = table_kind_from_title(name)
  previous_violations = all_previous_violations[kind] || []
  messages = content.map(&:message)
  resolved_violations = previous_violations.uniq - messages
  count = content.count
  { name: name, emoji: emoji, content: content, resolved: resolved_violations, count: count }
end

#table_kind_from_title(title) ⇒ Object 



223
224
225
226
227
228
229
230
231
 
# File 'lib/danger/request_source/github.rb', line 223

def table_kind_from_title(title)
  if title =~ /error/i
    :error
  elsif title =~ /warning/i
    :warning
  elsif title =~ /message/i
    :message
  end
end

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

Sending data to GitHub



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/danger/request_source/github.rb', line 74

def update_pull_request!(warnings: [], errors: [], messages: [], markdowns: [], danger_id: 'danger')
  comment_result = {}

  issues = client.issue_comments(ci_source.repo_slug, ci_source.pull_request_id)
  editable_issues = issues.reject { |issue| issue[:body].include?("generated_by_#{danger_id}") == false }

  if editable_issues.empty?
    previous_violations = {}
  else
    comment = editable_issues.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)

    if editable_issues.empty?
      comment_result = client.add_comment(ci_source.repo_slug, ci_source.pull_request_id, body)
    else
      original_id = editable_issues.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

#violations_from_table(table) ⇒ Object 



218
219
220
221
 
# File 'lib/danger/request_source/github.rb', line 218

def violations_from_table(table)
  regex = %r{<td data-sticky="true">(?:<del>)?(.*?)(?:</del>)?\s*</td>}im
  table.scan(regex).flatten.map(&:strip)
end