gitlab-qa 10.4.1 → 11.1.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-qa
 version: !ruby/object:Gem::Version
-  version: 10.4.1
+  version: 11.1.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-18 00:00:00.000000000 Z
+date: 2023-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -198,14 +198,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.18.0
+        version: '4.19'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.18.0
+        version: '4.19'
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
@@ -313,13 +313,13 @@ email:
 - gitlab-qa@gmail.com
 executables:
 - gitlab-qa
-- gitlab-qa-report
 extensions: []
 extra_rdoc_files: []
 files:
 - ".dockerignore"
 - ".gitignore"
 - ".gitlab-ci.yml"
+- ".gitlab/changelog_config.yml"
 - ".gitlab/issue_templates/Default.md"
 - ".gitlab/merge_request_templates/Default.md"
 - ".gitlab/merge_request_templates/Release.md"
@@ -339,7 +339,6 @@ files:
 - bin/gen-cert.sh
 - bin/merge_html_reports
 - bin/setup
-- bin/slack
 - docs/README.md
 - docs/architecture.md
 - docs/configuring_omnibus.md
@@ -355,7 +354,6 @@ files:
 - docs/waits.md
 - docs/what_tests_can_be_run.md
 - exe/gitlab-qa
-- exe/gitlab-qa-report
 - fixtures/ldap/1_add_nodes.ldif
 - fixtures/ldap/2_add_users.ldif
 - fixtures/ldap/3_add_groups.ldif
@@ -393,24 +391,6 @@ files:
 - lib/gitlab/qa/docker/engine.rb
 - lib/gitlab/qa/docker/volumes.rb
 - lib/gitlab/qa/release.rb
-- lib/gitlab/qa/report/base_test_results.rb
-- lib/gitlab/qa/report/find_set_dri.rb
-- lib/gitlab/qa/report/generate_test_session.rb
-- lib/gitlab/qa/report/gitlab_issue_client.rb
-- lib/gitlab/qa/report/gitlab_issue_dry_client.rb
-- lib/gitlab/qa/report/j_unit_test_results.rb
-- lib/gitlab/qa/report/json_test_results.rb
-- lib/gitlab/qa/report/prepare_stage_reports.rb
-- lib/gitlab/qa/report/relate_failure_issue.rb
-- lib/gitlab/qa/report/report_as_issue.rb
-- lib/gitlab/qa/report/report_results.rb
-- lib/gitlab/qa/report/results_in_issues.rb
-- lib/gitlab/qa/report/results_in_testcases.rb
-- lib/gitlab/qa/report/results_reporter_shared.rb
-- lib/gitlab/qa/report/summary_table.rb
-- lib/gitlab/qa/report/test_result.rb
-- lib/gitlab/qa/report/update_screenshot_path.rb
-- lib/gitlab/qa/reporter.rb
 - lib/gitlab/qa/runner.rb
 - lib/gitlab/qa/runtime/env.rb
 - lib/gitlab/qa/runtime/logger.rb
@@ -424,7 +404,6 @@ files:
 - lib/gitlab/qa/runtime/omnibus_configurations/packages.rb
 - lib/gitlab/qa/runtime/omnibus_configurations/registry_object_storage.rb
 - lib/gitlab/qa/runtime/scenario.rb
-- lib/gitlab/qa/runtime/token_finder.rb
 - lib/gitlab/qa/scenario/actable.rb
 - lib/gitlab/qa/scenario/cli_commands.rb
 - lib/gitlab/qa/scenario/template.rb
@@ -478,7 +457,6 @@ files:
 - lib/gitlab/qa/service/cluster_provider/base.rb
 - lib/gitlab/qa/service/cluster_provider/k3d.rb
 - lib/gitlab/qa/service/kubernetes_cluster.rb
-- lib/gitlab/qa/slack/post_to_slack.rb
 - lib/gitlab/qa/support/config_scripts.rb
 - lib/gitlab/qa/support/get_request.rb
 - lib/gitlab/qa/support/gitlab_upgrade_path.rb
@@ -487,18 +465,6 @@ files:
 - lib/gitlab/qa/support/invalid_response_error.rb
 - lib/gitlab/qa/support/shell_command.rb
 - lib/gitlab/qa/support/shellout.rb
-- lib/gitlab/qa/system_logs/finders/json_log_finder.rb
-- lib/gitlab/qa/system_logs/finders/rails/api_log_finder.rb
-- lib/gitlab/qa/system_logs/finders/rails/application_log_finder.rb
-- lib/gitlab/qa/system_logs/finders/rails/exception_log_finder.rb
-- lib/gitlab/qa/system_logs/finders/rails/graphql_log_finder.rb
-- lib/gitlab/qa/system_logs/log_types/log.rb
-- lib/gitlab/qa/system_logs/log_types/rails/api_log.rb
-- lib/gitlab/qa/system_logs/log_types/rails/application_log.rb
-- lib/gitlab/qa/system_logs/log_types/rails/exception_log.rb
-- lib/gitlab/qa/system_logs/log_types/rails/graphql_log.rb
-- lib/gitlab/qa/system_logs/shared_fields.rb
-- lib/gitlab/qa/system_logs/system_logs_formatter.rb
 - lib/gitlab/qa/test_logger.rb
 - lib/gitlab/qa/version.rb
 - scripts/build-package-and-test-env

data/bin/slack

@@ -1,14 +0,0 @@
-#!/bin/bash
-# Sends Slack notification MSG to CI_SLACK_WEBHOOK_URL (which needs to be set).
-# ICON_EMOJI needs to be set to an icon emoji name (without the `:` around it).
-
-CHANNEL=$1
-MSG=$2
-ICON_EMOJI=$3
-
-if [ -z "$CHANNEL" ] || [ -z "$CI_SLACK_WEBHOOK_URL" ] || [ -z "$MSG" ] || [ -z "$ICON_EMOJI" ]; then
-    echo "Missing argument(s) - Use: $0 channel message icon_emoji"
-    echo "and set CI_SLACK_WEBHOOK_URL environment variable."
-else
-    curl -X POST --data-urlencode 'payload={"channel": "#'"$CHANNEL"'", "username": "GitLab QA Bot", "text": "'"$MSG"'", "icon_emoji": "'":$ICON_EMOJI:"'"}' "$CI_SLACK_WEBHOOK_URL"
-fi

data/exe/gitlab-qa-report

@@ -1,10 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-lib = File.expand_path('../lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-
-require 'bundler/setup'
-require 'gitlab/qa'
-
-Gitlab::QA::Reporter.invoke(ARGV)

data/lib/gitlab/qa/report/base_test_results.rb

@@ -1,39 +0,0 @@
-# frozen_string_literal: true
-
-module Gitlab
-  module QA
-    module Report
-      class BaseTestResults
-        include Enumerable
-
-        attr_reader :path
-
-        def initialize(path)
-          @path = path
-          @results = parse
-          @testcases = process
-        end
-
-        def each(&block)
-          testcases.each(&block)
-        end
-
-        def write
-          raise NotImplementedError
-        end
-
-        private
-
-        attr_reader :results, :testcases
-
-        def parse
-          raise NotImplementedError
-        end
-
-        def process
-          raise NotImplementedError
-        end
-      end
-    end
-  end
-end

data/lib/gitlab/qa/report/find_set_dri.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-require 'json'
-
-module Gitlab
-  module QA
-    module Report
-      module FindSetDri
-        def set_dri_via_group(product_group, test)
-          parse_json_with_sets
-          fetch_stage_sets(test)
-
-          return @sets.sample['username'] if @stage_sets.empty?
-
-          fetch_group_sets(product_group)
-
-          if @group_sets.empty?
-            @stage_sets.sample['username']
-          else
-            @group_sets.sample['username']
-          end
-        end
-
-        private
-
-        def parse_json_with_sets
-          response = Support::HttpRequest.make_http_request(
-            url: 'https://gitlab-org.gitlab.io/gitlab-roulette/roulette.json'
-          )
-          @sets = JSON.parse(response.body).select { |user| user['role'].include?('software-engineer-in-test') }
-        end
-
-        def fetch_stage_sets(test)
-          @stage_sets = @sets.select { |user| user['role'].include?(test.stage.split("_").map(&:capitalize).join(" ")) }
-        end
-
-        def fetch_group_sets(product_group)
-          @group_sets = @stage_sets.select { |user| user['role'].include?(product_group.split("_").map { |word| word == 'and' ? word : word.capitalize }.join(" ")) }
-        end
-      end
-    end
-  end
-end

data/lib/gitlab/qa/report/generate_test_session.rb

@@ -1,275 +0,0 @@
-# frozen_string_literal: true
-
-require 'erb'
-require 'date'
-
-module Gitlab
-  module QA
-    module Report
-      class GenerateTestSession < ReportAsIssue
-        def initialize(**kwargs)
-          super
-          @issue_type = 'issue'
-        end
-
-        private
-
-        # rubocop:disable Metrics/AbcSize
-        def run!
-          puts "Generating test results in `#{files.join(',')}` as issues in project `#{project}` via the API at `#{Runtime::Env.gitlab_api_base}`."
-
-          tests = Dir.glob(files).flat_map do |path|
-            puts "Loading tests in #{path}"
-
-            Report::JsonTestResults.new(path).to_a
-          end
-
-          issue = gitlab.create_issue(
-            title: "#{Time.now.strftime('%Y-%m-%d')} Test session report | #{Runtime::Env.qa_run_type}",
-            description: generate_description(tests),
-            labels: ['Quality', 'QA', 'triage report', pipeline_name_label]
-          )
-
-          # Workaround for https://gitlab.com/gitlab-org/gitlab/-/issues/295493
-          unless Runtime::Env.qa_issue_url.to_s.empty?
-            gitlab.create_issue_note(
-              iid: issue.iid,
-              note: "/relate #{Runtime::Env.qa_issue_url}")
-          end
-
-          File.write('REPORT_ISSUE_URL', issue.web_url)
-        end
-        # rubocop:enable Metrics/AbcSize
-
-        def generate_description(tests)
-          <<~MARKDOWN.rstrip
-          ## Session summary
-
-          * Deploy version: #{Runtime::Env.deploy_version}
-          * Deploy environment: #{Runtime::Env.deploy_environment}
-          * Pipeline: #{Runtime::Env.pipeline_from_project_name} [#{Runtime::Env.ci_pipeline_id}](#{Runtime::Env.ci_pipeline_url})
-          #{generate_summary(tests: tests)}
-
-          #{generate_failed_jobs_listing}
-
-          #{generate_stages_listing(tests)}
-
-          #{generate_qa_issue_relation}
-
-          #{generate_link_to_dashboard}
-          MARKDOWN
-        end
-
-        def generate_summary(tests:, tests_by_status: nil)
-          tests_by_status ||= tests.group_by(&:status)
-          total = tests.size
-          passed = tests_by_status['passed']&.size || 0
-          failed = tests_by_status['failed']&.size || 0
-          others = total - passed - failed
-
-          <<~MARKDOWN.chomp
-          * Total #{total} tests
-          * Passed #{passed} tests
-          * Failed #{failed} tests
-          * #{others} other tests (usually skipped)
-          MARKDOWN
-        end
-
-        def generate_failed_jobs_listing
-          failed_jobs = []
-
-          client = Gitlab.client(
-            endpoint: Runtime::Env.ci_api_v4_url,
-            private_token: Runtime::Env.gitlab_ci_api_token)
-
-          gitlab.handle_gitlab_client_exceptions do
-            failed_jobs = client.pipeline_jobs(
-              Runtime::Env.ci_project_id,
-              Runtime::Env.ci_pipeline_id,
-              scope: 'failed')
-          end
-
-          listings = failed_jobs.map do |job|
-            allowed_to_fail = ' (allowed to fail)' if job.allow_failure
-
-            "* [#{job.name}](#{job.web_url})#{allowed_to_fail}"
-          end.join("\n")
-
-          <<~MARKDOWN.chomp if failed_jobs.any?
-          ## Failed jobs
-
-          #{listings}
-          MARKDOWN
-        end
-
-        def generate_stages_listing(tests)
-          generate_tests_by_stage(tests).map do |stage, tests_for_stage|
-            tests_by_status = tests_for_stage.group_by(&:status)
-
-            <<~MARKDOWN.chomp
-            ### #{stage&.capitalize || 'Unknown'}
-
-            #{generate_summary(
-              tests: tests_for_stage, tests_by_status: tests_by_status)}
-
-            #{generate_testcase_listing_by_status(
-              tests: tests_for_stage, tests_by_status: tests_by_status)}
-            MARKDOWN
-          end.join("\n\n")
-        end
-
-        def generate_tests_by_stage(tests)
-          # https://about.gitlab.com/handbook/product/product-categories/#devops-stages
-          ordering = %w[
-            manage
-            plan
-            create
-            verify
-            package
-            release
-            configure
-            monitor
-            secure
-            defend
-            growth
-            fulfillment
-            enablement
-          ]
-
-          tests.sort_by do |test|
-            ordering.index(test.stage) || ordering.size
-          end.group_by(&:stage)
-        end
-
-        def generate_testcase_listing_by_status(tests:, tests_by_status:)
-          failed_tests = tests_by_status['failed']
-          passed_tests = tests_by_status['passed']
-          other_tests = tests.reject do |test|
-            test.status == 'failed' || test.status == 'passed'
-          end
-
-          [
-            (failed_listings(failed_tests) if failed_tests),
-            (passed_listings(passed_tests) if passed_tests),
-            (other_listings(other_tests) if other_tests.any?)
-          ].compact.join("\n\n")
-        end
-
-        def failed_listings(failed_tests)
-          generate_testcase_listing(failed_tests)
-        end
-
-        def passed_listings(passed_tests)
-          <<~MARKDOWN.chomp
-            <details><summary>Passed tests:</summary>
-
-            #{generate_testcase_listing(passed_tests, passed: true)}
-
-            </details>
-          MARKDOWN
-        end
-
-        def other_listings(other_tests)
-          <<~MARKDOWN.chomp
-            <details><summary>Other tests:</summary>
-
-            #{generate_testcase_listing(other_tests)}
-
-            </details>
-          MARKDOWN
-        end
-
-        def generate_testcase_listing(tests, passed: false)
-          body = tests.group_by(&:testcase).map do |testcase, tests_with_same_testcase|
-            tests_with_same_testcase.sort_by!(&:name)
-            [
-              generate_test_text(testcase, tests_with_same_testcase, passed),
-              generate_test_job(tests_with_same_testcase),
-              generate_test_status(tests_with_same_testcase),
-              generate_test_actions(tests_with_same_testcase)
-            ].join(' | ')
-          end.join("\n")
-
-          <<~MARKDOWN.chomp
-          | Test | Job | Status | Action |
-          | - | - | - | - |
-          #{body}
-          MARKDOWN
-        end
-
-        def generate_test_text(testcase, tests_with_same_testcase, passed)
-          text = tests_with_same_testcase.map(&:name).uniq.join(', ')
-          encoded_text = ERB::Util.url_encode(text)
-
-          if testcase && !passed
-            # Workaround for reducing system notes on testcase issues
-            # The first regex extracts the link to the issues list page from a link to a single issue show page by removing the issue id.
-            "[#{text}](#{testcase.match(%r{[\s\S]+\/[^\/\d]+})}?state=opened&search=#{encoded_text})"
-          else
-            text
-          end
-        end
-
-        def generate_test_job(tests_with_same_testcase)
-          tests_with_same_testcase.map do |test|
-            ci_job_id = test.ci_job_url[/\d+\z/]
-
-            "[#{ci_job_id}](#{test.ci_job_url})#{' ~"quarantine"' if test.quarantine?}"
-          end.uniq.join(', ')
-        end
-
-        def generate_test_status(tests_with_same_testcase)
-          tests_with_same_testcase.map(&:status).uniq.map do |status|
-            %(~"#{status}")
-          end.join(', ')
-        end
-
-        def generate_test_actions(tests_with_same_testcase)
-          # All failed tests would be grouped together, meaning that
-          # if one failed, all the tests here would be failed too.
-          # So this check is safe. Same applies to 'passed'.
-          # But all other status might be mixing together,
-          # we cannot assume other statuses.
-          if tests_with_same_testcase.first.status == 'failed'
-            tests_having_failure_issue =
-              tests_with_same_testcase.select(&:failure_issue)
-
-            if tests_having_failure_issue.any?
-              items = tests_having_failure_issue.uniq(&:failure_issue).map do |test|
-                "<li>[ ] [failure issue](#{test.failure_issue})</li>"
-              end.join(' ')
-
-              "<ul>#{items}</ul>"
-            else
-              '<ul><li>[ ] failure issue exists or was created</li></ul>'
-            end
-          else
-            '-'
-          end
-        end
-
-        def generate_qa_issue_relation
-          return unless Runtime::Env.qa_issue_url
-
-          <<~MARKDOWN.chomp
-          ## Release QA issue
-
-          * #{Runtime::Env.qa_issue_url}
-
-          /relate #{Runtime::Env.qa_issue_url}
-          MARKDOWN
-        end
-
-        def generate_link_to_dashboard
-          return unless Runtime::Env.qa_run_type
-
-          <<~MARKDOWN.chomp
-          ## Link to Grafana dashboard for run-type of #{Runtime::Env.qa_run_type}
-
-          * https://dashboards.quality.gitlab.net/d/kuNYMgDnz/test-run-metrics?orgId=1&refresh=1m&var-run_type=#{Runtime::Env.qa_run_type}
-          MARKDOWN
-        end
-      end
-    end
-  end
-end

data/lib/gitlab/qa/report/gitlab_issue_client.rb

@@ -1,190 +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
-
-  module QA
-    module Report
-      # The GitLab client is used for API access: https://github.com/NARKOZ/gitlab
-      class GitlabIssueClient
-        MAINTAINER_ACCESS_LEVEL = 40
-        RETRY_BACK_OFF_DELAY = 60
-        MAX_RETRY_ATTEMPTS = 3
-
-        def initialize(token:, project:)
-          @token = token
-          @project = project
-          @retry_backoff = 0
-
-          configure_gitlab_client
-        end
-
-        def assert_user_permission!
-          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
-
-        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, options)
-              .auto_paginate
-              .select(&select)
-          end
-        end
-
-        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
-
-        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
-
-        def edit_issue(iid:, options: {})
-          handle_gitlab_client_exceptions do
-            Gitlab.edit_issue(project, iid, options)
-          end
-        end
-
-        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
-
-        def create_issue_note(iid:, note:)
-          handle_gitlab_client_exceptions do
-            Gitlab.create_issue_note(project, iid, note)
-          end
-        end
-
-        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
-
-        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
-
-        def find_user_id(username:)
-          handle_gitlab_client_exceptions do
-            user = Gitlab.users(username: username)&.first
-            user['id'] unless user.nil?
-          end
-        end
-
-        def upload_file(file_fullpath:)
-          ignore_gitlab_client_exceptions do
-            Gitlab.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
-          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
-
-          slack_options = {
-            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(**slack_options).invoke!
-        end
-
-        private
-
-        attr_reader :token, :project
-
-        def configure_gitlab_client
-          Gitlab.configure do |config|
-            config.endpoint = Runtime::Env.gitlab_api_base
-            config.private_token = token
-          end
-        end
-
-        def abort_not_permitted
-          abort "You must have at least Maintainer access to the project to use this feature."
-        end
-
-        def warn_exception(error)
-          error_msg = "#{error.class.name} #{error.message}"
-          warn(error_msg)
-          error_msg
-        end
-      end
-    end
-  end
-end