BigW Consortium Gitlab

jira_service.rb 8.83 KB
Newer Older
1
class JiraService < IssueTrackerService
2
  include Gitlab::Routing.url_helpers
3

4
  validates :url, url: true, presence: true, if: :activated?
5
  validates :api_url, url: true, allow_blank: true
6
  validates :project_key, presence: true, if: :activated?
Drew Blessing committed
7

8
  prop_accessor :username, :password, :url, :api_url, :project_key,
9
                :jira_issue_transition_id, :title, :description
10

Drew Blessing committed
11 12
  before_update :reset_password

13 14 15
  # This is confusing, but JiraService does not really support these events.
  # The values here are required to display correct options in the service
  # configuration screen.
16
  def self.supported_events
17 18 19
    %w(commit merge_request)
  end

20 21 22 23 24
  # {PROJECT-KEY}-{NUMBER} Examples: JIRA-1, PROJECT-1
  def reference_pattern
    @reference_pattern ||= %r{(?<issue>\b([A-Z][A-Z0-9_]+-)\d+)}
  end

25 26 27 28
  def initialize_properties
    super do
      self.properties = {
        title: issues_tracker['title'],
29 30
        url: issues_tracker['url'],
        api_url: issues_tracker['api_url']
31 32 33 34
      }
    end
  end

Drew Blessing committed
35
  def reset_password
36
    self.password = nil if reset_password?
Drew Blessing committed
37
  end
38

39
  def options
40
    url = URI.parse(client_url)
41

42
    {
43 44 45 46 47 48 49
      username: self.username,
      password: self.password,
      site: URI.join(url, '/').to_s,
      context_path: url.path,
      auth_type: :basic,
      read_timeout: 120,
      use_ssl: url.scheme == 'https'
50 51 52 53
    }
  end

  def client
54
    @client ||= JIRA::Client.new(options)
55 56 57
  end

  def jira_project
58
    @jira_project ||= jira_request { client.Project.find(project_key) }
59 60
  end

61
  def help
62
    "You need to configure JIRA before enabling this service. For more details
63
    read the
64
    [JIRA service documentation](#{help_page_url('user/project/integrations/jira')})."
65 66
  end

67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82
  def title
    if self.properties && self.properties['title'].present?
      self.properties['title']
    else
      'JIRA'
    end
  end

  def description
    if self.properties && self.properties['description'].present?
      self.properties['description']
    else
      'Jira issue tracker'
    end
  end

83
  def self.to_param
84 85
    'jira'
  end
Drew Blessing committed
86 87

  def fields
88
    [
89
      { type: 'text', name: 'url', title: 'Web URL', placeholder: 'https://jira.example.com', required: true },
90
      { type: 'text', name: 'api_url', title: 'JIRA API URL', placeholder: 'If different from Web URL' },
91 92 93
      { type: 'text', name: 'project_key', placeholder: 'Project Key', required: true },
      { type: 'text', name: 'username', placeholder: '', required: true },
      { type: 'password', name: 'password', placeholder: '', required: true },
Jarka Kadlecova committed
94
      { type: 'text', name: 'jira_issue_transition_id', placeholder: '' }
95 96 97
    ]
  end

98
  # URLs to redirect from Gitlab issues pages to jira issue tracker
99 100 101 102 103 104 105 106 107 108
  def project_url
    "#{url}/issues/?jql=project=#{project_key}"
  end

  def issues_url
    "#{url}/browse/:id"
  end

  def new_issue_url
    "#{url}/secure/CreateIssue.jspa"
Drew Blessing committed
109 110
  end

111 112 113 114
  def execute(push)
    # This method is a no-op, because currently JiraService does not
    # support any events.
  end
115

116 117
  def close_issue(entity, external_issue)
    issue = jira_request { client.Issue.find(external_issue.iid) }
118

119 120 121 122 123 124 125 126 127 128 129 130 131 132 133
    return if issue.nil? || issue.resolution.present? || !jira_issue_transition_id.present?

    commit_id = if entity.is_a?(Commit)
                  entity.id
                elsif entity.is_a?(MergeRequest)
                  entity.diff_head_sha
                end

    commit_url = build_entity_url(:commit, commit_id)

    # Depending on the JIRA project's workflow, a comment during transition
    # may or may not be allowed. Refresh the issue after transition and check
    # if it is closed, so we don't have one comment for every commit.
    issue = jira_request { client.Issue.find(issue.key) } if transition_issue(issue)
    add_issue_solved_comment(issue, commit_id, commit_url) if issue.resolution
Drew Blessing committed
134 135 136
  end

  def create_cross_reference_note(mentioned, noteable, author)
137 138 139 140
    unless can_cross_reference?(noteable)
      return "Events for #{noteable.model_name.plural.humanize(capitalize: false)} are disabled."
    end

141 142
    jira_issue = jira_request { client.Issue.find(mentioned.id) }

143
    return unless jira_issue.present?
144

145 146 147
    noteable_id   = noteable.respond_to?(:iid) ? noteable.iid : noteable.id
    noteable_type = noteable_name(noteable)
    entity_url    = build_entity_url(noteable_type, noteable_id)
Drew Blessing committed
148 149 150 151

    data = {
      user: {
        name: author.name,
152
        url: resource_url(user_path(author))
Drew Blessing committed
153 154
      },
      project: {
155 156
        name: self.project.path_with_namespace,
        url: resource_url(namespace_project_path(project.namespace, self.project))
Drew Blessing committed
157 158
      },
      entity: {
159
        name: noteable_type.humanize.downcase,
160 161
        url: entity_url,
        title: noteable.title
Drew Blessing committed
162 163 164
      }
    }

165
    add_comment(data, jira_issue)
Drew Blessing committed
166 167
  end

168 169 170 171 172
  # reason why service cannot be tested
  def disabled_title
    "Please fill in Password and Username."
  end

173 174 175 176 177
  def test(_)
    result = test_settings
    { success: result.present?, result: result }
  end

178 179 180 181 182 183
  # JIRA does not need test data.
  # We are requesting the project that belongs to the project key.
  def test_data(user = nil, project = nil)
    nil
  end

Drew Blessing committed
184
  def test_settings
185
    return unless client_url.present?
186
    # Test settings by getting the project
187
    jira_request { jira_project.present? }
Drew Blessing committed
188 189 190 191
  end

  private

192 193 194 195 196 197 198 199
  def can_cross_reference?(noteable)
    case noteable
    when Commit then commit_events
    when MergeRequest then merge_requests_events
    else true
    end
  end

Drew Blessing committed
200
  def transition_issue(issue)
201
    issue.transitions.build.save(transition: { id: jira_issue_transition_id })
Drew Blessing committed
202 203 204
  end

  def add_issue_solved_comment(issue, commit_id, commit_url)
205 206 207 208
    link_title   = "GitLab: Solved by commit #{commit_id}."
    comment      = "Issue solved with [#{commit_id}|#{commit_url}]."
    link_props   = build_remote_link_props(url: commit_url, title: link_title, resolved: true)
    send_message(issue, comment, link_props)
Drew Blessing committed
209 210
  end

211 212 213 214 215
  def add_comment(data, issue)
    user_name    = data[:user][:name]
    user_url     = data[:user][:url]
    entity_name  = data[:entity][:name]
    entity_url   = data[:entity][:url]
216
    entity_title = data[:entity][:title]
Drew Blessing committed
217 218
    project_name = data[:project][:name]

219
    message      = "[#{user_name}|#{user_url}] mentioned this issue in [a #{entity_name} of #{project_name}|#{entity_url}]:\n'#{entity_title.chomp}'"
220 221
    link_title   = "GitLab: Mentioned on #{entity_name} - #{entity_title}"
    link_props   = build_remote_link_props(url: entity_url, title: link_title)
Drew Blessing committed
222

223 224
    unless comment_exists?(issue, message)
      send_message(issue, message, link_props)
225
    end
Drew Blessing committed
226 227
  end

228 229 230 231
  def comment_exists?(issue, message)
    comments = jira_request { issue.comments }

    comments.present? && comments.any? { |comment| comment.body.include?(message) }
Drew Blessing committed
232 233
  end

234
  def send_message(issue, message, remote_link_props)
235
    return unless client_url.present?
Drew Blessing committed
236

237
    jira_request do
238 239
      remote_link = find_remote_link(issue, remote_link_props[:object][:url])
      if remote_link
240
        remote_link.save!(remote_link_props)
241 242 243
      elsif issue.comments.build.save!(body: message)
        new_remote_link = issue.remotelink.build
        new_remote_link.save!(remote_link_props)
244
      end
Drew Blessing committed
245

246
      result_message = "#{self.class.name} SUCCESS: Successfully posted to #{client_url}."
247 248
      Rails.logger.info(result_message)
      result_message
Drew Blessing committed
249
    end
250
  end
Drew Blessing committed
251

252 253 254 255 256 257
  def find_remote_link(issue, url)
    links = jira_request { issue.remotelink.all }

    links.find { |link| link.object["url"] == url }
  end

258 259 260 261 262 263 264 265 266 267 268 269 270 271
  def build_remote_link_props(url:, title:, resolved: false)
    status = {
      resolved: resolved
    }

    {
      GlobalID: 'GitLab',
      object: {
        url: url,
        title: title,
        status: status,
        icon: { title: 'GitLab', url16x16: 'https://gitlab.com/favicon.ico' }
      }
    }
Drew Blessing committed
272 273 274
  end

  def resource_url(resource)
275
    "#{Settings.gitlab.base_url.chomp("/")}#{resource}"
Drew Blessing committed
276 277
  end

278
  def build_entity_url(noteable_type, entity_id)
279 280 281 282
    polymorphic_url(
      [
        self.project.namespace.becomes(Namespace),
        self.project,
283
        noteable_type.to_sym
284 285 286
      ],
      id:   entity_id,
      host: Settings.gitlab.base_url
Drew Blessing committed
287 288
    )
  end
289

290 291 292 293 294 295 296 297
  def noteable_name(noteable)
    name = noteable.model_name.singular

    # ProjectSnippet inherits from Snippet class so it causes
    # routing error building the URL.
    name == "project_snippet" ? "snippet" : name
  end

298 299 300 301
  # Handle errors when doing JIRA API calls
  def jira_request
    yield

302
  rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, Errno::ECONNREFUSED, URI::InvalidURIError, JIRA::HTTPError, OpenSSL::SSL::SSLError => e
303
    Rails.logger.info "#{self.class.name} Send message ERROR: #{client_url} - #{e.message}"
304 305
    nil
  end
306 307 308 309 310 311 312 313 314 315 316 317 318

  def client_url
    api_url.present? ? api_url : url
  end

  def reset_password?
    # don't reset the password if a new one is provided
    return false if password_touched?
    return true if api_url_changed?
    return false if api_url.present?

    url_changed?
  end
319
end