gitlab_quality-test_tooling 1.8.1 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4c8eda4a61584293cfb2f20a4ece0c5afd8963be75c56c5c3a1f71cbbf04a2ed
-  data.tar.gz: 72ea08e5a2fac3b5d9f0d5dada3bb71c7b655acbd7c03f4533e0bbe951be954e
+  metadata.gz: 6aa86323a85f779b89a3d26bd9e2b78e2166d4aaf1fdd18c5b3c26e67edbed1f
+  data.tar.gz: 9096461ccb4f8527f0347c4987e405d0ef39ff45aa890468968b773372f854a0
 SHA512:
-  metadata.gz: fe64d9f93ff1343c36d1d478f63e9a4614587897b6414ec3a1f4c28fdd90ee1d245134e9350f546373350acf1f1355dd50d31da162a899d096ceb1114029767e
-  data.tar.gz: d4dd2ba2714e54c766592734481f7ba373692375f4c2011578f1b22da36fae3b8d58e721677e47ba214805d3798737c5ad6dec7711d586a46727029e555fb72e
+  metadata.gz: 3c6e475336007851d1fd92e18d3ec622ef1ea505b5a603b344eef1a36139a6be1cafc67c12758ce37b045eacb12812fe52aad58a80829336502b6edff48f17ca
+  data.tar.gz: 4047f4eb355bb0247366d838367d2cf9628b3fe35b43ffe75760fc7578cc3bbeaa8ccb77ddc7c84184dbcfe2dbf888c5c679e9a600560d229193a3da055203cf

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab_quality-test_tooling (1.8.1)
+    gitlab_quality-test_tooling (1.10.0)
       activesupport (>= 6.1, < 7.2)
       amatch (~> 0.4.1)
       gitlab (~> 4.19)

data/exe/post-to-slack

@@ -8,6 +8,9 @@ require_relative "../lib/gitlab_quality/test_tooling"
 
 params = {}
 
+messages = []
+gitlab_api_token = nil
+
 options = OptionParser.new do |opts|
   opts.banner = "Usage: #{$PROGRAM_NAME} [options]"
 
@@ -15,16 +18,34 @@ options = OptionParser.new do |opts|
     params[:slack_webhook_url] = slack_webhook_url
   end
 
+  opts.on('-a', '--gitlab-api-token TOKEN', String, 'GitLab API token') do |token|
+    gitlab_api_token = token unless token.empty?
+  end
+
   opts.on('-c', '--channel CHANNEL', String, 'Slack channel to post the message to') do |channel|
     params[:channel] = channel
   end
 
   opts.on('-m', '--message MESSAGE', String, 'Post message to Slack') do |message|
-    params[:message] = message
+    messages << message
   end
 
   opts.on('-t', '--include-summary-table FILES', String, 'Add a test summary table based on RSpec report files (JUnit XML)') do |files|
-    params[:message] += "\n\n#{GitlabQuality::TestTooling::SummaryTable.create(input_files: files)}"
+    messages << GitlabQuality::TestTooling::SummaryTable.create(input_files: files)
+  end
+
+  opts.on('-j', '--include-failed-jobs-table', 'Add a list of failed jobs in the pipeline') do
+    next puts("Failed jobs table requires api token to be set via --gitlab-api-token option, skipping failed jobs table") unless gitlab_api_token
+
+    project_id = ENV['CI_PROJECT_ID']&.to_i || (next puts("CI_PROJECT_ID not set, skipping failed jobs table"))
+    pipeline_id = ENV['CI_PIPELINE_ID']&.to_i || (next puts("CI_PIPELINE_ID not set, skipping failed jobs table"))
+
+    jobs = GitlabQuality::TestTooling::GitlabClient::JobsClient.new(token: gitlab_api_token, project: project_id).pipeline_jobs(pipeline_id: pipeline_id, scope: 'failed')
+    next if jobs.empty?
+
+    messages << GitlabQuality::TestTooling::FailedJobsTable.create(jobs: jobs)
+  rescue StandardError => e
+    puts "Failed to fetch failed jobs. #{e.class}: #{e.message}"
   end
 
   opts.on('-u', '--username USERNAME', String, 'Username to use for the Slack message') do |username|
@@ -50,6 +71,8 @@ options = OptionParser.new do |opts|
   opts.parse(ARGV)
 end
 
+params[:message] = messages.join("\n")
+
 if params.any?
   GitlabQuality::TestTooling::Slack::PostToSlack.new(**params).invoke!
 else

data/lib/gitlab_quality/test_tooling/failed_jobs_table.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'table_print'
+
+module GitlabQuality
+  module TestTooling
+    module FailedJobsTable
+      class << self
+        # Create table with formatted list of failed jobs
+        #
+        # @param [Array<Gitlab::ObjectifiedHash>] jobs
+        # @return [String]
+        def create(jobs:)
+          "```\n#{TablePrint::Printer.table_print(collect_results(jobs))}\n```\n"
+        end
+
+        private
+
+        # Format list of failed jobs
+        #
+        # @param [Array<Gitlab::ObjectifiedHash>] jobs
+        # @return [Array]
+        def collect_results(jobs)
+          jobs.sort_by(&:stage).map do |job|
+            {
+              "Job" => job.name,
+              "Stage" => job.stage,
+              "Failure Reason" => job.failure_reason
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab_quality/test_tooling/gitlab_client/gitlab_client.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+require 'gitlab'
+
+module GitlabQuality
+  module TestTooling
+    module GitlabClient
+      class GitlabClient
+        RETRY_BACK_OFF_DELAY = 60
+        MAX_RETRY_ATTEMPTS = 3
+
+        def initialize(token:, project:, **_kwargs)
+          @token = token
+          @project = project
+          @retry_backoff = 0
+        end
+
+        def handle_gitlab_client_exceptions # rubocop:disable Metrics/AbcSize
+          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 = 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 Runtime::Env.ci_commit_ref_name == Runtime::Env.default_branch
+
+          slack_options = {
+            slack_webhook_url: ENV.fetch('CI_SLACK_WEBHOOK_URL', nil),
+            channel: channel,
+            username: "GitLab Quality Test Tooling",
+            icon_emoji: ':ci_failing:',
+            message: <<~MSG
+              An unexpected error occurred while reporting test results in issues.
+              The error occurred in job: #{Runtime::Env.ci_job_url}
+              `#{error_msg}`
+            MSG
+          }
+          puts "Posting Slack message to channel: #{channel}"
+
+          GitlabQuality::TestTooling::Slack::PostToSlack.new(**slack_options).invoke!
+        end
+
+        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
+
+        private
+
+        attr_reader :project, :token
+
+        def client
+          @client ||= Gitlab.client(
+            endpoint: Runtime::Env.gitlab_api_base,
+            private_token: token
+          )
+        end
+
+        def warn_exception(error)
+          error_msg = "#{error.class.name} #{error.message}"
+          warn(error_msg)
+          error_msg
+        end
+      end
+    end
+  end
+end

data/lib/gitlab_quality/test_tooling/gitlab_client/issues_client.rb

@@ -0,0 +1,153 @@
+# frozen_string_literal: true
+
+require 'gitlab'
+
+module Gitlab
+  # Monkey patch the Gitlab client to use the correct API path and add required methods
+  class Client
+    def team_member(project, id)
+      get("/projects/#{url_encode(project)}/members/all/#{id}")
+    end
+
+    def issue_discussions(project, issue_id, options = {})
+      get("/projects/#{url_encode(project)}/issues/#{issue_id}/discussions", query: options)
+    end
+
+    def add_note_to_issue_discussion_as_thread(project, issue_id, discussion_id, options = {})
+      post("/projects/#{url_encode(project)}/issues/#{issue_id}/discussions/#{discussion_id}/notes", query: options)
+    end
+  end
+end
+
+module GitlabQuality
+  module TestTooling
+    module GitlabClient
+      # The GitLab client is used for API access: https://github.com/NARKOZ/gitlab
+      class IssuesClient < GitlabClient
+        REPORTER_ACCESS_LEVEL = 20
+
+        def assert_user_permission!
+          handle_gitlab_client_exceptions do
+            member = client.team_member(project, user.id)
+
+            abort_not_permitted(member.access_level) if member.access_level < REPORTER_ACCESS_LEVEL
+          end
+        rescue Gitlab::Error::NotFound
+          abort_member_not_found(user)
+        end
+
+        def find_issues(iid: nil, options: {}, &select)
+          select ||= :itself
+
+          handle_gitlab_client_exceptions do
+            break [client.issue(project, iid)].select(&select) if iid
+
+            client.issues(project, options)
+                  .auto_paginate
+                  .select(&select)
+          end
+        end
+
+        def find_issues_by_hash(test_hash, &select)
+          select ||= :itself
+
+          handle_gitlab_client_exceptions do
+            client.search_in_project(project, 'issues', test_hash)
+                  .auto_paginate
+                  .select(&select)
+          end
+        end
+
+        def find_issue_discussions(iid:)
+          handle_gitlab_client_exceptions do
+            client.issue_discussions(project, iid, order_by: 'created_at', sort: 'asc').auto_paginate
+          end
+        end
+
+        def create_issue(title:, description:, labels:, issue_type: 'issue', assignee_id: nil, due_date: nil, confidential: false)
+          attrs = {
+            issue_type: issue_type,
+            description: description,
+            labels: labels,
+            assignee_id: assignee_id,
+            due_date: due_date,
+            confidential: confidential
+          }.compact
+
+          handle_gitlab_client_exceptions do
+            client.create_issue(project, title, attrs)
+          end
+        end
+
+        def edit_issue(iid:, options: {})
+          handle_gitlab_client_exceptions do
+            client.edit_issue(project, iid, options)
+          end
+        end
+
+        def find_issue_notes(iid:)
+          handle_gitlab_client_exceptions do
+            client.issue_notes(project, iid, order_by: 'created_at', sort: 'asc')&.auto_paginate
+          end
+        end
+
+        def create_issue_note(iid:, note:)
+          handle_gitlab_client_exceptions do
+            client.create_issue_note(project, iid, note)
+          end
+        end
+
+        def edit_issue_note(issue_iid:, note_id:, note:)
+          handle_gitlab_client_exceptions do
+            client.edit_issue_note(project, issue_iid, note_id, note)
+          end
+        end
+
+        def add_note_to_issue_discussion_as_thread(iid:, discussion_id:, body:)
+          handle_gitlab_client_exceptions do
+            client.add_note_to_issue_discussion_as_thread(project, iid, discussion_id, body: body)
+          end
+        end
+
+        def find_user_id(username:)
+          handle_gitlab_client_exceptions do
+            user = client.users(username: username)&.first
+            user['id'] unless user.nil?
+          end
+        end
+
+        def upload_file(file_fullpath:)
+          ignore_gitlab_client_exceptions do
+            client.upload_file(project, file_fullpath)
+          end
+        end
+
+        private
+
+        attr_reader :token, :project
+
+        def user
+          return @user if defined?(@user)
+
+          @user ||= begin
+            client.user
+          rescue Gitlab::Error::NotFound
+            abort_user_not_found
+          end
+        end
+
+        def abort_not_permitted(access_level)
+          abort "#{user.username} must have at least Reporter access to the project '#{project}' to use this feature. Current access level: #{access_level}"
+        end
+
+        def abort_user_not_found
+          abort "User not found for given token."
+        end
+
+        def abort_member_not_found(user)
+          abort "#{user.username} must be a member of the '#{project}' project."
+        end
+      end
+    end
+  end
+end

data/lib/gitlab_quality/test_tooling/gitlab_client/issues_dry_client.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    module GitlabClient
+      class IssuesDryClient < IssuesClient
+        def create_issue(title:, description:, labels:, issue_type: 'issue', confidential: false)
+          attrs = { description: description, labels: labels, confidential: confidential }
+
+          puts "The following #{issue_type} would have been created:"
+          puts "project: #{project}, title: #{title}, attrs: #{attrs}"
+        end
+
+        def edit_issue(iid:, options: {})
+          puts "The #{project}##{iid} issue would have been updated with: #{options}"
+        end
+
+        def create_issue_note(iid:, note:)
+          puts "The following note would have been posted on #{project}##{iid} issue: #{note}"
+        end
+
+        def edit_issue_note(issue_iid:, note_id:, note:)
+          puts "The following note would have been edited on #{project}##{issue_iid} (note #{note_id}) issue: #{note}"
+        end
+
+        def add_note_to_issue_discussion_as_thread(iid:, discussion_id:, body:)
+          puts "The following discussion note would have been posted on #{project}##{iid} (discussion #{discussion_id}) issue: #{body}"
+        end
+
+        def upload_file(file_fullpath:)
+          puts "The following file would have been uploaded: #{file_fullpath}"
+        end
+      end
+    end
+  end
+end

data/lib/gitlab_quality/test_tooling/gitlab_client/jobs_client.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'gitlab'
+
+module GitlabQuality
+  module TestTooling
+    module GitlabClient
+      class JobsClient < GitlabClient
+        def pipeline_jobs(pipeline_id:, scope:)
+          client.pipeline_jobs(project, pipeline_id, scope: scope)
+        end
+      end
+    end
+  end
+end

data/lib/gitlab_quality/test_tooling/gitlab_client/merge_requests_client.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require 'gitlab'
+
+module GitlabQuality
+  module TestTooling
+    module GitlabClient
+      class MergeRequestsClient < GitlabClient
+        def find_merge_request_changes(merge_request_iid:)
+          client.merge_request_changes(project, merge_request_iid)
+        end
+
+        def create_merge_request(title:, source_branch:, target_branch:, description:, labels:)
+          merge_request = handle_gitlab_client_exceptions do
+            client.create_merge_request(project,
+              title,
+              source_branch: source_branch,
+              target_branch: target_branch,
+              description: description,
+              labels: labels,
+              squash: true,
+              remove_source_branch: true)
+          end
+
+          Runtime::Logger.debug("Created merge request #{merge_request['iid']} (#{merge_request['web_url']})") if merge_request
+        end
+
+        def find(iid: nil, options: {}, &select)
+          select ||= :itself
+
+          if iid
+            find_merge_request(iid, &select)
+          else
+            find_merge_requests(options, &select)
+          end
+        end
+
+        def merge_request_changed_files(merge_request_iid:)
+          find_merge_request_changes(merge_request_iid: merge_request_iid)["changes"].map do |change|
+            change["new_path"]
+          end
+        end
+
+        def find_note(body:, merge_request_iid:)
+          client.merge_request_notes(project, merge_request_iid, per_page: 100).auto_paginate.find do |mr_note|
+            mr_note['body'] =~ /#{body}/
+          end
+        end
+
+        def create_note(note:, merge_request_iid:)
+          client.create_merge_request_note(project, merge_request_iid, note)
+        end
+
+        def update_note(id:, note:, merge_request_iid:)
+          client.edit_merge_request_note(project, merge_request_iid, id, note)
+        end
+
+        private
+
+        attr_reader :project, :token, :merge_request_iid
+
+        def find_merge_request(iid, &select)
+          handle_gitlab_client_exceptions do
+            [client.merge_requests(project, iid)].select(&select)
+          end
+        end
+
+        def find_merge_requests(options, &select)
+          handle_gitlab_client_exceptions do
+            client.merge_requests(project, options)
+                  .auto_paginate
+                  .select(&select)
+          end
+        end
+
+        def client
+          @client ||= Gitlab.client(
+            endpoint: Runtime::Env.gitlab_api_base,
+            private_token: token
+          )
+        end
+      end
+    end
+  end
+end

data/lib/gitlab_quality/test_tooling/gitlab_client/merge_requests_dry_client.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    module GitlabClient
+      class MergeRequestsDryClient < MergeRequestsClient
+        def find_merge_request_changes(merge_request_iid:)
+          puts "Finding changes for merge_request_id #{merge_request_iid}"
+          puts "project: #{project}"
+        end
+
+        def merge_request_changed_files(merge_request_iid:)
+          puts "Changed files for #{merge_request_iid}"
+          []
+        end
+
+        def find_note(body:, merge_request_iid:)
+          puts "Find note for #{merge_request_iid} with body: #{body} for mr_iid: #{merge_request_iid}"
+        end
+
+        def create_note(note:, merge_request_iid:)
+          puts "The following note would have been created with body: #{note} for mr_iid: #{merge_request_iid}"
+        end
+
+        def update_note(id:, note:, merge_request_iid:)
+          puts "The following note would have been updated id: #{id} with body: #{note} for mr_iid: #{merge_request_iid}"
+        end
+
+        def create_merge_request(title:, source_branch:, target_branch:, description:, labels:)
+          puts "A merge request would be created with title: #{title} " \
+               "source_branch: #{source_branch} target_branch: #{target_branch} description: #{description} labels: #{labels}"
+        end
+      end
+    end
+  end
+end

data/lib/gitlab_quality/test_tooling/report/merge_request_slow_tests_report.rb

@@ -10,8 +10,7 @@ module GitlabQuality
 
         def initialize(token:, input_files:, merge_request_iid:, project: nil, dry_run: false, **_kwargs)
           @project = project
-          @gitlab_merge_request = (dry_run ? GitlabClient::MergeRequestDryClient : GitlabClient::MergeRequest).new(token: token, project: project,
-            merge_request_iid: merge_request_iid)
+          @gitlab_merge_request = (dry_run ? GitlabClient::MergeRequestsDryClient : GitlabClient::MergeRequestsClient).new(token: token, project: project)
           @files = Array(input_files)
           @merge_request_iid = merge_request_iid
           @slow_tests = []
@@ -57,7 +56,7 @@ module GitlabQuality
         end
 
         def merge_request_changed_files
-          @merge_request_changed_files ||= gitlab_merge_request.merge_request_changed_files
+          @merge_request_changed_files ||= gitlab_merge_request.merge_request_changed_files(merge_request_iid: merge_request_iid)
         end
 
         def find_slow_tests(test_results)
@@ -119,21 +118,21 @@ module GitlabQuality
           "#{gitlab_note}\n\n</details>"
         end
 
-        def upsert_mr_note(slow_tests)
-          existing_note = gitlab_merge_request.find_note(body: SLOW_TEST_MESSAGE)
+        def upsert_mr_note(slow_tests) # rubocop:disable Metrics/AbcSize
+          existing_note = gitlab_merge_request.find_note(body: SLOW_TEST_MESSAGE, merge_request_iid: merge_request_iid)
 
           if existing_note
             puts "Update note for merge request: #{merge_request_iid}"
 
             up_to_date_note = add_slow_test_rows(existing_note.body, slow_tests)
 
-            gitlab_merge_request.update_note(id: existing_note['id'], note: up_to_date_note) if existing_note.body != up_to_date_note
+            gitlab_merge_request.update_note(id: existing_note['id'], note: up_to_date_note, merge_request_iid: merge_request_iid) if existing_note.body != up_to_date_note
           else
             up_to_date_note = build_note(slow_tests)
 
             puts "Create note for merge request: #{merge_request_iid}"
 
-            gitlab_merge_request.create_note(note: up_to_date_note)
+            gitlab_merge_request.create_note(note: up_to_date_note, merge_request_iid: merge_request_iid)
           end
         end
 

data/lib/gitlab_quality/test_tooling/report/relate_failure_issue.rb

@@ -25,7 +25,7 @@ module GitlabQuality
         SYSTEMIC_EXCEPTIONS_THRESHOLD = 10
         SPAM_THRESHOLD_FOR_FAILURE_ISSUES = 3
         FAILURE_STACKTRACE_REGEX = %r{(?:(?:.*Failure/Error:(?<stacktrace>.+))|(?<stacktrace>.+))}m
-        ISSUE_STACKTRACE_REGEX = /### Stack trace\s*(```)#{FAILURE_STACKTRACE_REGEX}(```)/m
+        ISSUE_STACKTRACE_REGEX = /### Stack trace\s*(```)#{FAILURE_STACKTRACE_REGEX}(```)\n*\n###/m
 
         NEW_ISSUE_LABELS = Set.new(%w[test failure::new priority::2]).freeze
         IGNORED_FAILURES = [

data/lib/gitlab_quality/test_tooling/report/report_as_issue.rb

@@ -10,7 +10,7 @@ module GitlabQuality
 
         def initialize(token:, input_files:, related_issues_file: nil, project: nil, confidential: false, dry_run: false, **_kwargs)
           @project = project
-          @gitlab = (dry_run ? GitlabIssueDryClient : GitlabIssueClient).new(token: token, project: project)
+          @gitlab = (dry_run ? GitlabClient::IssuesDryClient : GitlabClient::IssuesClient).new(token: token, project: project)
           @files = Array(input_files)
           @confidential = confidential
           @issue_logger = IssueLogger.new(file_path: related_issues_file) unless related_issues_file.nil?

data/lib/gitlab_quality/test_tooling/version.rb

@@ -2,6 +2,6 @@
 
 module GitlabQuality
   module TestTooling
-    VERSION = "1.8.1"
+    VERSION = "1.10.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_quality-test_tooling
 version: !ruby/object:Gem::Version
-  version: 1.8.1
+  version: 1.10.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-05 00:00:00.000000000 Z
+date: 2024-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -383,10 +383,13 @@ files:
 - exe/update-screenshot-paths
 - lefthook.yml
 - lib/gitlab_quality/test_tooling.rb
-- lib/gitlab_quality/test_tooling/gitlab_client/merge_request.rb
-- lib/gitlab_quality/test_tooling/gitlab_client/merge_request_dry_client.rb
-- lib/gitlab_quality/test_tooling/gitlab_issue_client.rb
-- lib/gitlab_quality/test_tooling/gitlab_issue_dry_client.rb
+- lib/gitlab_quality/test_tooling/failed_jobs_table.rb
+- lib/gitlab_quality/test_tooling/gitlab_client/gitlab_client.rb
+- lib/gitlab_quality/test_tooling/gitlab_client/issues_client.rb
+- lib/gitlab_quality/test_tooling/gitlab_client/issues_dry_client.rb
+- lib/gitlab_quality/test_tooling/gitlab_client/jobs_client.rb
+- lib/gitlab_quality/test_tooling/gitlab_client/merge_requests_client.rb
+- lib/gitlab_quality/test_tooling/gitlab_client/merge_requests_dry_client.rb
 - lib/gitlab_quality/test_tooling/labels_inference.rb
 - lib/gitlab_quality/test_tooling/report/concerns/find_set_dri.rb
 - lib/gitlab_quality/test_tooling/report/concerns/group_and_category_labels.rb

data/lib/gitlab_quality/test_tooling/gitlab_client/merge_request.rb

@@ -1,52 +0,0 @@
-# frozen_string_literal: true
-
-require 'gitlab'
-
-module GitlabQuality
-  module TestTooling
-    module GitlabClient
-      class MergeRequest
-        def initialize(token:, project:, merge_request_iid:)
-          @token = token
-          @project = project
-          @merge_request_iid = merge_request_iid
-        end
-
-        def find_merge_request
-          client.merge_request_changes(project, merge_request_iid)
-        end
-
-        def merge_request_changed_files
-          find_merge_request["changes"].map do |change|
-            change["new_path"]
-          end
-        end
-
-        def find_note(body:)
-          client.merge_request_notes(project, merge_request_iid, per_page: 100).auto_paginate.find do |mr_note|
-            mr_note['body'] =~ /#{body}/
-          end
-        end
-
-        def create_note(note:)
-          client.create_merge_request_note(project, merge_request_iid, note)
-        end
-
-        def update_note(id:, note:)
-          client.edit_merge_request_note(project, merge_request_iid, id, note)
-        end
-
-        private
-
-        attr_reader :project, :token, :merge_request_iid
-
-        def client
-          @client ||= Gitlab.client(
-            endpoint: Runtime::Env.gitlab_api_base,
-            private_token: token
-          )
-        end
-      end
-    end
-  end
-end

data/lib/gitlab_quality/test_tooling/gitlab_client/merge_request_dry_client.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-module GitlabQuality
-  module TestTooling
-    module GitlabClient
-      class MergeRequestDryClient < MergeRequest
-        def find_merge_request
-          puts "Finding merge_request_id #{merge_request_iid}"
-          puts "project: #{project}"
-        end
-
-        def merge_request_changed_files
-          puts "Changed files for #{merge_request_iid}"
-          []
-        end
-
-        def find_note(body:)
-          puts "Find note for #{merge_request_iid} with body: #{body}"
-        end
-
-        def create_note(note:)
-          puts "The following note would have been created with body: #{note}"
-        end
-
-        def update_note(id:, note:)
-          puts "The following note would have been update id: #{id} with body: #{note}"
-        end
-      end
-    end
-  end
-end

data/lib/gitlab_quality/test_tooling/gitlab_issue_client.rb

@@ -1,226 +0,0 @@
-# frozen_string_literal: true
-
-require 'gitlab'
-
-module Gitlab
-  # Monkey patch the Gitlab client to use the correct API path and add required methods
-  class Client
-    def team_member(project, id)
-      get("/projects/#{url_encode(project)}/members/all/#{id}")
-    end
-
-    def issue_discussions(project, issue_id, options = {})
-      get("/projects/#{url_encode(project)}/issues/#{issue_id}/discussions", query: options)
-    end
-
-    def add_note_to_issue_discussion_as_thread(project, issue_id, discussion_id, options = {})
-      post("/projects/#{url_encode(project)}/issues/#{issue_id}/discussions/#{discussion_id}/notes", query: options)
-    end
-  end
-end
-
-module GitlabQuality
-  module TestTooling
-    # The GitLab client is used for API access: https://github.com/NARKOZ/gitlab
-    class GitlabIssueClient
-      REPORTER_ACCESS_LEVEL = 20
-      RETRY_BACK_OFF_DELAY = 60
-      MAX_RETRY_ATTEMPTS = 3
-
-      def initialize(token:, project:)
-        @token = token
-        @project = project
-        @retry_backoff = 0
-      end
-
-      def assert_user_permission!
-        handle_gitlab_client_exceptions do
-          member = client.team_member(project, user.id)
-
-          abort_not_permitted(member.access_level) if member.access_level < REPORTER_ACCESS_LEVEL
-        end
-      rescue Gitlab::Error::NotFound
-        abort_member_not_found(user)
-      end
-
-      def find_issues(iid: nil, options: {}, &select)
-        select ||= :itself
-
-        handle_gitlab_client_exceptions do
-          break [client.issue(project, iid)].select(&select) if iid
-
-          client.issues(project, options)
-            .auto_paginate
-            .select(&select)
-        end
-      end
-
-      def find_issues_by_hash(test_hash, &select)
-        select ||= :itself
-
-        handle_gitlab_client_exceptions do
-          client.search_in_project(project, 'issues', test_hash)
-            .auto_paginate
-            .select(&select)
-        end
-      end
-
-      def find_issue_discussions(iid:)
-        handle_gitlab_client_exceptions do
-          client.issue_discussions(project, iid, order_by: 'created_at', sort: 'asc').auto_paginate
-        end
-      end
-
-      def create_issue(title:, description:, labels:, issue_type: 'issue', assignee_id: nil, due_date: nil, confidential: false)
-        attrs = {
-          issue_type: issue_type,
-          description: description,
-          labels: labels,
-          assignee_id: assignee_id,
-          due_date: due_date,
-          confidential: confidential
-        }.compact
-
-        handle_gitlab_client_exceptions do
-          client.create_issue(project, title, attrs)
-        end
-      end
-
-      def edit_issue(iid:, options: {})
-        handle_gitlab_client_exceptions do
-          client.edit_issue(project, iid, options)
-        end
-      end
-
-      def find_issue_notes(iid:)
-        handle_gitlab_client_exceptions do
-          client.issue_notes(project, iid, order_by: 'created_at', sort: 'asc')&.auto_paginate
-        end
-      end
-
-      def create_issue_note(iid:, note:)
-        handle_gitlab_client_exceptions do
-          client.create_issue_note(project, iid, note)
-        end
-      end
-
-      def edit_issue_note(issue_iid:, note_id:, note:)
-        handle_gitlab_client_exceptions do
-          client.edit_issue_note(project, issue_iid, note_id, note)
-        end
-      end
-
-      def add_note_to_issue_discussion_as_thread(iid:, discussion_id:, body:)
-        handle_gitlab_client_exceptions do
-          client.add_note_to_issue_discussion_as_thread(project, iid, discussion_id, body: body)
-        end
-      end
-
-      def find_user_id(username:)
-        handle_gitlab_client_exceptions do
-          user = client.users(username: username)&.first
-          user['id'] unless user.nil?
-        end
-      end
-
-      def upload_file(file_fullpath:)
-        ignore_gitlab_client_exceptions do
-          client.upload_file(project, file_fullpath)
-        end
-      end
-
-      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
-
-      def handle_gitlab_client_exceptions # rubocop:disable Metrics/AbcSize
-        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 = 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 Runtime::Env.ci_commit_ref_name == Runtime::Env.default_branch
-
-        slack_options = {
-          slack_webhook_url: ENV.fetch('CI_SLACK_WEBHOOK_URL', nil),
-          channel: channel,
-          username: "GitLab Quality Test Tooling",
-          icon_emoji: ':ci_failing:',
-          message: <<~MSG
-            An unexpected error occurred while reporting test results in issues.
-            The error occurred in job: #{Runtime::Env.ci_job_url}
-            `#{error_msg}`
-          MSG
-        }
-        puts "Posting Slack message to channel: #{channel}"
-
-        GitlabQuality::TestTooling::Slack::PostToSlack.new(**slack_options).invoke!
-      end
-
-      private
-
-      attr_reader :token, :project
-
-      def client
-        @client ||= Gitlab.client(
-          endpoint: Runtime::Env.gitlab_api_base,
-          private_token: token
-        )
-      end
-
-      def user
-        return @user if defined?(@user)
-
-        @user ||= begin
-          client.user
-        rescue Gitlab::Error::NotFound
-          abort_user_not_found
-        end
-      end
-
-      def abort_not_permitted(access_level)
-        abort "#{user.username} must have at least Reporter access to the project '#{project}' to use this feature. Current access level: #{access_level}"
-      end
-
-      def abort_user_not_found
-        abort "User not found for given token."
-      end
-
-      def abort_member_not_found(user)
-        abort "#{user.username} must be a member of the '#{project}' project."
-      end
-
-      def warn_exception(error)
-        error_msg = "#{error.class.name} #{error.message}"
-        warn(error_msg)
-        error_msg
-      end
-    end
-  end
-end

data/lib/gitlab_quality/test_tooling/gitlab_issue_dry_client.rb

@@ -1,34 +0,0 @@
-# frozen_string_literal: true
-
-module GitlabQuality
-  module TestTooling
-    class GitlabIssueDryClient < GitlabIssueClient
-      def create_issue(title:, description:, labels:, issue_type: 'issue', confidential: false)
-        attrs = { description: description, labels: labels, confidential: confidential }
-
-        puts "The following #{issue_type} would have been created:"
-        puts "project: #{project}, title: #{title}, attrs: #{attrs}"
-      end
-
-      def edit_issue(iid:, options: {})
-        puts "The #{project}##{iid} issue would have been updated with: #{options}"
-      end
-
-      def create_issue_note(iid:, note:)
-        puts "The following note would have been posted on #{project}##{iid} issue: #{note}"
-      end
-
-      def edit_issue_note(issue_iid:, note_id:, note:)
-        puts "The following note would have been edited on #{project}##{issue_iid} (note #{note_id}) issue: #{note}"
-      end
-
-      def add_note_to_issue_discussion_as_thread(iid:, discussion_id:, body:)
-        puts "The following discussion note would have been posted on #{project}##{iid} (discussion #{discussion_id}) issue: #{body}"
-      end
-
-      def upload_file(file_fullpath:)
-        puts "The following file would have been uploaded: #{file_fullpath}"
-      end
-    end
-  end
-end