Class: Gitlab::QA::Report::GitlabIssueClient
- Inherits:
-
Object
- Object
- Gitlab::QA::Report::GitlabIssueClient
- Defined in:
- lib/gitlab/qa/report/gitlab_issue_client.rb
Overview
The GitLab client is used for API access: github.com/NARKOZ/gitlab
Direct Known Subclasses
Constant Summary collapse
- MAINTAINER_ACCESS_LEVEL =
40
- RETRY_BACK_OFF_DELAY =
60
- MAX_RETRY_ATTEMPTS =
3
Instance Method Summary collapse
- #add_note_to_issue_discussion_as_thread(iid:, discussion_id:, body:) ⇒ Object
- #assert_user_permission! ⇒ Object
- #create_issue(title:, description:, labels:, issue_type: 'issue') ⇒ Object
- #create_issue_note(iid:, note:) ⇒ Object
- #edit_issue(iid:, options: {}) ⇒ Object
- #edit_issue_note(issue_iid:, note_id:, note:) ⇒ Object
- #find_issue_discussions(iid:) ⇒ Object
- #find_issue_notes(iid:) ⇒ Object
- #find_issues(iid: nil, options: {}, &select) ⇒ Object
- #find_user_id(username:) ⇒ Object
- #handle_gitlab_client_exceptions ⇒ Object
- #ignore_gitlab_client_exceptions ⇒ Object
-
#initialize(token:, project:) ⇒ GitlabIssueClient
constructor
A new instance of GitlabIssueClient.
- #upload_file(file_fullpath:) ⇒ Object
Constructor Details
#initialize(token:, project:) ⇒ GitlabIssueClient
Returns a new instance of GitlabIssueClient.
29 30 31 32 33 34 35 |
# File 'lib/gitlab/qa/report/gitlab_issue_client.rb', line 29 def initialize(token:, project:) @token = token @project = project @retry_backoff = 0 configure_gitlab_client end |
Instance Method Details
#add_note_to_issue_discussion_as_thread(iid:, discussion_id:, body:) ⇒ Object
98 99 100 101 102 |
# File 'lib/gitlab/qa/report/gitlab_issue_client.rb', line 98 def add_note_to_issue_discussion_as_thread(iid:, discussion_id:, body:) handle_gitlab_client_exceptions do Gitlab.add_note_to_issue_discussion_as_thread(project, iid, discussion_id, body: body) end end |
#assert_user_permission! ⇒ Object
37 38 39 40 41 42 43 44 45 46 |
# File 'lib/gitlab/qa/report/gitlab_issue_client.rb', line 37 def handle_gitlab_client_exceptions do user = Gitlab.user member = Gitlab.team_member(project, user.id) abort_not_permitted if member.access_level < MAINTAINER_ACCESS_LEVEL end rescue Gitlab::Error::NotFound abort_not_permitted end |
#create_issue(title:, description:, labels:, issue_type: 'issue') ⇒ Object
66 67 68 69 70 71 72 |
# File 'lib/gitlab/qa/report/gitlab_issue_client.rb', line 66 def create_issue(title:, description:, labels:, issue_type: 'issue') attrs = { issue_type: issue_type, description: description, labels: labels } handle_gitlab_client_exceptions do Gitlab.create_issue(project, title, attrs) end end |
#create_issue_note(iid:, note:) ⇒ Object
86 87 88 89 90 |
# File 'lib/gitlab/qa/report/gitlab_issue_client.rb', line 86 def create_issue_note(iid:, note:) handle_gitlab_client_exceptions do Gitlab.create_issue_note(project, iid, note) end end |
#edit_issue(iid:, options: {}) ⇒ Object
74 75 76 77 78 |
# File 'lib/gitlab/qa/report/gitlab_issue_client.rb', line 74 def edit_issue(iid:, options: {}) handle_gitlab_client_exceptions do Gitlab.edit_issue(project, iid, ) end end |
#edit_issue_note(issue_iid:, note_id:, note:) ⇒ Object
92 93 94 95 96 |
# File 'lib/gitlab/qa/report/gitlab_issue_client.rb', line 92 def edit_issue_note(issue_iid:, note_id:, note:) handle_gitlab_client_exceptions do Gitlab.edit_issue_note(project, issue_iid, note_id, note) end end |
#find_issue_discussions(iid:) ⇒ Object
60 61 62 63 64 |
# File 'lib/gitlab/qa/report/gitlab_issue_client.rb', line 60 def find_issue_discussions(iid:) handle_gitlab_client_exceptions do Gitlab.issue_discussions(project, iid, order_by: 'created_at', sort: 'asc').auto_paginate end end |
#find_issue_notes(iid:) ⇒ Object
80 81 82 83 84 |
# File 'lib/gitlab/qa/report/gitlab_issue_client.rb', line 80 def find_issue_notes(iid:) handle_gitlab_client_exceptions do Gitlab.issue_notes(project, iid, order_by: 'created_at', sort: 'asc').auto_paginate end end |
#find_issues(iid: nil, options: {}, &select) ⇒ Object
48 49 50 51 52 53 54 55 56 57 58 |
# File 'lib/gitlab/qa/report/gitlab_issue_client.rb', line 48 def find_issues(iid: nil, options: {}, &select) select ||= :itself handle_gitlab_client_exceptions do return [Gitlab.issue(project, iid)].select(&select) if iid Gitlab.issues(project, ) .auto_paginate .select(&select) end end |
#find_user_id(username:) ⇒ Object
104 105 106 107 108 109 |
# File 'lib/gitlab/qa/report/gitlab_issue_client.rb', line 104 def find_user_id(username:) handle_gitlab_client_exceptions do user = Gitlab.users(username: username)&.first user['id'] unless user.nil? end end |
#handle_gitlab_client_exceptions ⇒ Object
123 124 125 126 127 128 129 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 163 164 165 |
# File 'lib/gitlab/qa/report/gitlab_issue_client.rb', line 123 def handle_gitlab_client_exceptions yield rescue Gitlab::Error::NotFound # This error could be raised in assert_user_permission! # If so, we want it to terminate at that point raise rescue SystemCallError, OpenSSL::SSL::SSLError, Net::OpenTimeout, Net::ReadTimeout, Gitlab::Error::InternalServerError, Gitlab::Error::Parsing => e @retry_backoff += RETRY_BACK_OFF_DELAY raise if @retry_backoff > RETRY_BACK_OFF_DELAY * MAX_RETRY_ATTEMPTS warn_exception(e) warn("Sleeping for #{@retry_backoff} seconds before retrying...") sleep @retry_backoff retry rescue StandardError => e pipeline = QA::Runtime::Env.pipeline_from_project_name channel = case pipeline when "canary" "qa-production" when "staging-canary" "qa-staging" else "qa-#{pipeline}" end error_msg = warn_exception(e) return unless QA::Runtime::Env.ci_commit_ref_name == QA::Runtime::Env.default_branch = { channel: channel, icon_emoji: ':ci_failing:', message: <<~MSG An unexpected error occurred while reporting test results in issues. The error occurred in job: #{QA::Runtime::Env.ci_job_url} `#{error_msg}` MSG } puts "Posting Slack message to channel: #{channel}" Gitlab::QA::Slack::PostToSlack.new(**).invoke! end |
#ignore_gitlab_client_exceptions ⇒ Object
117 118 119 120 121 |
# File 'lib/gitlab/qa/report/gitlab_issue_client.rb', line 117 def ignore_gitlab_client_exceptions yield rescue StandardError, SystemCallError, OpenSSL::SSL::SSLError, Net::OpenTimeout, Net::ReadTimeout, Gitlab::Error::Error => e puts "Ignoring the following error: #{e}" end |
#upload_file(file_fullpath:) ⇒ Object
111 112 113 114 115 |
# File 'lib/gitlab/qa/report/gitlab_issue_client.rb', line 111 def upload_file(file_fullpath:) ignore_gitlab_client_exceptions do Gitlab.upload_file(project, file_fullpath) end end |