Class: Danger::RequestSources::BitbucketCloud

Inherits:
RequestSource show all
Includes:
Helpers::CommentsHelper
Defined in:
lib/danger/request_sources/bitbucket_cloud.rb

Constant Summary

Constants inherited from RequestSource

RequestSource::DANGER_REPO_NAME

Instance Attribute Summary collapse

Attributes inherited from RequestSource

#ci_source, #environment, #ignored_violations

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Helpers::CommentsHelper

#apply_template, #generate_comment, #generate_description, #generate_inline_comment_body, #generate_inline_markdown_body, #markdown_link_to_message, #markdown_parser, #messages_are_equivalent, #process_markdown, #random_compliment, #table

Methods included from Helpers::CommentsParsingHelper

#parse_comment, #parse_message_from_row, #parse_tables_from_comment, #table_kind_from_title, #violations_from_table

Methods inherited from RequestSource

available_request_sources, available_source_names_and_envs, #file_url, inherited, source_name, #update_build_status

Constructor Details

#initialize(ci_source, environment) ⇒ BitbucketCloud

Returns a new instance of BitbucketCloud.



23
24
25
26
27
28
 
# File 'lib/danger/request_sources/bitbucket_cloud.rb', line 23

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

  @api = BitbucketCloudAPI.new(ci_source.repo_slug, ci_source.pull_request_id, nil, environment)
end

Instance Attribute Details

#pr_json ⇒ Object

Returns the value of attribute pr_json.



10
11
12
 
# File 'lib/danger/request_sources/bitbucket_cloud.rb', line 10

def pr_json
  @pr_json
end

Class Method Details

.env_vars ⇒ Object 



12
13
14
15
16
17
 
# File 'lib/danger/request_sources/bitbucket_cloud.rb', line 12

def self.env_vars
  [
    "DANGER_BITBUCKETCLOUD_USERNAME",
    "DANGER_BITBUCKETCLOUD_PASSWORD"
  ]
end

.optional_env_vars ⇒ Object 



19
20
21
 
# File 'lib/danger/request_sources/bitbucket_cloud.rb', line 19

def self.optional_env_vars
  ["DANGER_BITBUCKETCLOUD_OAUTH_KEY", "DANGER_BITBUCKETCLOUD_OAUTH_SECRET"]
end

Instance Method Details

#delete_old_comments(danger_id: "danger") ⇒ Object 



117
118
119
120
121
122
 
# File 'lib/danger/request_sources/bitbucket_cloud.rb', line 117

def delete_old_comments(danger_id: "danger")
  @api.fetch_comments.each do |c|
    next if c[:user][:uuid] != @api.my_uuid
    @api.delete_comment(c[:id]) if c[:content][:raw] =~ /generated_by_#{danger_id}/
  end
end

#fetch_details ⇒ Object 



47
48
49
 
# File 'lib/danger/request_sources/bitbucket_cloud.rb', line 47

def fetch_details
  self.pr_json = @api.fetch_pr_json
end

#host ⇒ Object 



43
44
45
 
# File 'lib/danger/request_sources/bitbucket_cloud.rb', line 43

def host
  @host ||= @api.host
end

#organisation ⇒ Object 



67
68
69
 
# File 'lib/danger/request_sources/bitbucket_cloud.rb', line 67

def organisation
  nil
end

#scm ⇒ Object 



39
40
41
 
# File 'lib/danger/request_sources/bitbucket_cloud.rb', line 39

def scm
  @scm ||= GitRepo.new
end

#setup_danger_branches ⇒ Object 



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/danger/request_sources/bitbucket_cloud.rb', line 51

def setup_danger_branches
  base_branch = self.pr_json[:destination][:branch][:name]
  base_commit = self.pr_json[:destination][:commit][:hash]
  head_branch = self.pr_json[:source][:branch][:name]
  head_commit = self.pr_json[:source][:commit][:hash]

  # Next, we want to ensure that we have a version of the current branch at a known location
  scm.ensure_commitish_exists_on_branch! base_branch, base_commit
  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. )
  scm.ensure_commitish_exists_on_branch! head_branch, head_commit
  self.scm.exec "branch #{EnvironmentManager.danger_head_branch} #{head_commit}"
end

#update_inline_comments_for_kind!(kind, messages, danger_id: "danger") ⇒ Object 



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/danger/request_sources/bitbucket_cloud.rb', line 93

def update_inline_comments_for_kind!(kind, messages, danger_id: "danger")
  emoji = { warnings: "warning", errors: "no_entry_sign", messages: "book" }[kind]

  messages.reject do |message|
    next false unless message.file && message.line

    body = ""

    if kind == :markdown
      body = generate_inline_markdown_body(message,
                                          danger_id: danger_id,
                                          template: "bitbucket_server")
    else
      body = generate_inline_comment_body(emoji, message,
                                          danger_id: danger_id,
                                          template: "bitbucket_server")
    end

    @api.post_comment(body, file: message.file, line: message.line)

    true
  end
end

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/danger/request_sources/bitbucket_cloud.rb', line 71

def update_pull_request!(warnings: [], errors: [], messages: [], markdowns: [], danger_id: "danger", new_comment: false, remove_previous_comments: false)
  delete_old_comments(danger_id: danger_id) if !new_comment || remove_previous_comments

  comment = generate_description(warnings: warnings, errors: errors, template: "bitbucket_server")
  comment += "\n\n"

  warnings = update_inline_comments_for_kind!(:warnings, warnings, danger_id: danger_id)
  errors = update_inline_comments_for_kind!(:errors, errors, danger_id: danger_id)
  messages = update_inline_comments_for_kind!(:messages, messages, danger_id: danger_id)
  markdowns = update_inline_comments_for_kind!(:markdowns, markdowns, danger_id: danger_id)

  comment += generate_comment(warnings: warnings,
                              errors: errors,
                              messages: messages,
                              markdowns: markdowns,
                              previous_violations: {},
                              danger_id: danger_id,
                              template: "bitbucket_server")

  @api.post_comment(comment)
end

#validates_as_api_source? ⇒ Boolean

Returns:

  • (Boolean) 


35
36
37
 
# File 'lib/danger/request_sources/bitbucket_cloud.rb', line 35

def validates_as_api_source?
  @api.credentials_given?
end

#validates_as_ci? ⇒ Boolean

Returns:

  • (Boolean) 


30
31
32
33
 
# File 'lib/danger/request_sources/bitbucket_cloud.rb', line 30

def validates_as_ci?
  # TODO: ???
  true
end