gitlab-qa 6.7.0 → 6.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1615e54144d0b669245a15b6a5874efc1d00157fe859dbc6ff2e723380e9da10
-  data.tar.gz: f3ccd0528987c838c793d1bbc2f742833584756bf7a87c58c29b60fa2f7b6ac3
+  metadata.gz: cb6d9e91936be3f2ffdcee43a8693171f691714e086de83065c3ef44580f095e
+  data.tar.gz: a154de6d77c7ffa54426282f0bee792ed13380a5bdb95534fc6bdbc50791c82c
 SHA512:
-  metadata.gz: 47fce0af7a769ccb9dca14c87f3d1f169495324f753f3db60bb8aa10fc6e05a4612f0bc1704e884dca3d7349bd6d0972d5ca77421bba71f60fd03258e24bc52b
-  data.tar.gz: f1d65176693a0091989392eec19425a34d2cbc1ee92cb428178ee22ca438b19e7246fd1306bfdaaa73f5d531a6c01ad5a6b2ee1324ca72ef0ba9b255ae4782f3
+  metadata.gz: b01ee4edc97797c0db5eeacc19dd427d7da082dcea78f7175921b17b73a128c529244aebf7129f2ff901da16496805cd9e6364fa6587db54676d10fcbc1f009d
+  data.tar.gz: d54a08f9c1e02c2bf16f214c3a468cf619438b4e9620cb052c0106c4a336c586218b41d3e050d5e39980d2e148f4ea77631e08b3cbe6afb25f34a1838e0281d6

data/.gitlab-ci.yml

@@ -2,6 +2,7 @@ stages:
   - check
   - release
   - test
+  - report
   - notify
 
 default:
@@ -48,6 +49,10 @@ variables:
   QA_CAN_TEST_GIT_PROTOCOL_V2: "true"
   QA_CAN_TEST_PRAEFECT: "false"
   QA_TESTCASES_REPORTING_PROJECT: "gitlab-org/quality/testcases"
+  QA_FAILURES_REPORTING_PROJECT: "rymai/gitlab-qa-issues"
+  # The --dry-run or --max-diff-ratio option can be set to modify the behavior of `exe/gitlab-qa-report --relate-failure-issue` without releasing a new gem version.
+  QA_FAILURES_REPORTER_OPTIONS: ""
+  QA_TESTCASE_SESSIONS_PROJECT: "gitlab-org/quality/testcase-sessions"
 
 .check-base:
   stage: check
@@ -95,6 +100,7 @@ release:
     - exe/gitlab-qa-report --update-screenshot-path "gitlab-qa-run-*/**/rspec-*.xml"
     - export GITLAB_QA_ACCESS_TOKEN="$GITLAB_QA_PRODUCTION_ACCESS_TOKEN"
     - if [ "$TOP_UPSTREAM_SOURCE_REF" == "master" ] || [[ "$TOP_UPSTREAM_SOURCE_JOB" == https://ops.gitlab.net* ]]; then exe/gitlab-qa-report --report-in-issues "gitlab-qa-run-*/**/rspec-*.json" --project "$QA_TESTCASES_REPORTING_PROJECT" || true; fi
+    - if [ "$TOP_UPSTREAM_SOURCE_REF" == "master" ] || [[ "$TOP_UPSTREAM_SOURCE_JOB" == https://ops.gitlab.net* ]]; then exe/gitlab-qa-report --relate-failure-issue "gitlab-qa-run-*/**/rspec-*.json" --project "$QA_FAILURES_REPORTING_PROJECT" $QA_FAILURES_REPORTER_OPTIONS || true; fi
     - exit $test_run_exit_code
 
 .ce-qa:
@@ -333,6 +339,7 @@ ce:update:
     - exe/gitlab-qa Test::Omnibus::Update ${RELEASE:=CE} ${RELEASE:=CE} -- $RSPEC_REPORT_OPTS || test_run_exit_code=$?
     - export GITLAB_QA_ACCESS_TOKEN="$GITLAB_QA_PRODUCTION_ACCESS_TOKEN"
     - if [ "$TOP_UPSTREAM_SOURCE_REF" == "master" ] || [[ "$TOP_UPSTREAM_SOURCE_JOB" == https://ops.gitlab.net* ]]; then exe/gitlab-qa-report --report-in-issues "gitlab-qa-run-*/**/rspec-*.json" --project "$QA_TESTCASES_REPORTING_PROJECT" || true; fi
+    - if [ "$TOP_UPSTREAM_SOURCE_REF" == "master" ] || [[ "$TOP_UPSTREAM_SOURCE_JOB" == https://ops.gitlab.net* ]]; then exe/gitlab-qa-report --relate-failure-issue "gitlab-qa-run-*/**/rspec-*.json" --project "$QA_FAILURES_REPORTING_PROJECT" $QA_FAILURES_REPORTER_OPTIONS || true; fi
     - exit $test_run_exit_code
   extends:
     - .test
@@ -347,6 +354,7 @@ ce:update-quarantine:
     - exe/gitlab-qa Test::Omnibus::Update ${RELEASE:=CE} ${RELEASE:=CE} -- --tag quarantine --tag ~orchestrated $RSPEC_REPORT_OPTS || test_run_exit_code=$?
     - export GITLAB_QA_ACCESS_TOKEN="$GITLAB_QA_PRODUCTION_ACCESS_TOKEN"
     - if [ "$TOP_UPSTREAM_SOURCE_REF" == "master" ] || [[ "$TOP_UPSTREAM_SOURCE_JOB" == https://ops.gitlab.net* ]]; then exe/gitlab-qa-report --report-in-issues "gitlab-qa-run-*/**/rspec-*.json" --project "$QA_TESTCASES_REPORTING_PROJECT" || true; fi
+    - if [ "$TOP_UPSTREAM_SOURCE_REF" == "master" ] || [[ "$TOP_UPSTREAM_SOURCE_JOB" == https://ops.gitlab.net* ]]; then exe/gitlab-qa-report --relate-failure-issue "gitlab-qa-run-*/**/rspec-*.json" --project "$QA_FAILURES_REPORTING_PROJECT" $QA_FAILURES_REPORTER_OPTIONS || true; fi
     - exit $test_run_exit_code
   extends:
     - .test
@@ -360,6 +368,7 @@ ee:update:
     - exe/gitlab-qa Test::Omnibus::Update ${RELEASE:=EE} ${RELEASE:=EE} -- $RSPEC_REPORT_OPTS || test_run_exit_code=$?
     - export GITLAB_QA_ACCESS_TOKEN="$GITLAB_QA_PRODUCTION_ACCESS_TOKEN"
     - if [ "$TOP_UPSTREAM_SOURCE_REF" == "master" ] || [[ "$TOP_UPSTREAM_SOURCE_JOB" == https://ops.gitlab.net* ]]; then exe/gitlab-qa-report --report-in-issues "gitlab-qa-run-*/**/rspec-*.json" --project "$QA_TESTCASES_REPORTING_PROJECT" || true; fi
+    - if [ "$TOP_UPSTREAM_SOURCE_REF" == "master" ] || [[ "$TOP_UPSTREAM_SOURCE_JOB" == https://ops.gitlab.net* ]]; then exe/gitlab-qa-report --relate-failure-issue "gitlab-qa-run-*/**/rspec-*.json" --project "$QA_FAILURES_REPORTING_PROJECT" $QA_FAILURES_REPORTER_OPTIONS || true; fi
     - exit $test_run_exit_code
   extends:
     - .test
@@ -374,6 +383,7 @@ ee:update-quarantine:
     - exe/gitlab-qa Test::Omnibus::Update ${RELEASE:=EE} ${RELEASE:=EE} -- --tag quarantine --tag ~orchestrated $RSPEC_REPORT_OPTS || test_run_exit_code=$?
     - export GITLAB_QA_ACCESS_TOKEN="$GITLAB_QA_PRODUCTION_ACCESS_TOKEN"
     - if [ "$TOP_UPSTREAM_SOURCE_REF" == "master" ] || [[ "$TOP_UPSTREAM_SOURCE_JOB" == https://ops.gitlab.net* ]]; then exe/gitlab-qa-report --report-in-issues "gitlab-qa-run-*/**/rspec-*.json" --project "$QA_TESTCASES_REPORTING_PROJECT" || true; fi
+    - if [ "$TOP_UPSTREAM_SOURCE_REF" == "master" ] || [[ "$TOP_UPSTREAM_SOURCE_JOB" == https://ops.gitlab.net* ]]; then exe/gitlab-qa-report --relate-failure-issue "gitlab-qa-run-*/**/rspec-*.json" --project "$QA_FAILURES_REPORTING_PROJECT" $QA_FAILURES_REPORTER_OPTIONS || true; fi
     - exit $test_run_exit_code
   extends:
     - .test
@@ -941,6 +951,22 @@ staging:
     - .only-qa
   allow_failure: true
 
+generate_test_session:
+  stage: report
+  rules:
+    - if: '$TOP_UPSTREAM_SOURCE_JOB && $TOP_UPSTREAM_SOURCE_REF == "master"'
+      when: always
+    - if: '$TOP_UPSTREAM_SOURCE_JOB =~ /\Ahttps:\/\/ops.gitlab.net\//'
+      when: always
+  artifacts:
+    when: always
+    expire_in: 10d
+    paths:
+      - REPORT_ISSUE_URL
+  script:
+    - export GITLAB_QA_ACCESS_TOKEN="$GITLAB_QA_PRODUCTION_ACCESS_TOKEN"
+    - exe/gitlab-qa-report --generate-test-session "gitlab-qa-run-*/**/rspec-*.json" --project "$QA_TESTCASE_SESSIONS_PROJECT"
+
 .notify_upstream_commit:
   stage: notify
   image: ruby:2.6
@@ -966,7 +992,7 @@ notify_upstream_commit:failure:
 .notify_slack:
   image: alpine
   stage: notify
-  dependencies: []
+  dependencies: ['generate_test_session']
   cache: {}
   before_script:
     - apk update && apk add git curl bash
@@ -985,4 +1011,4 @@ notify_slack:
     - echo "RELEASE is ${RELEASE}"
     - echo "CI_PIPELINE_URL is $CI_PIPELINE_URL"
     - echo "TOP_UPSTREAM_SOURCE_JOB is $TOP_UPSTREAM_SOURCE_JOB"
-    - bin/slack $NOTIFY_CHANNEL "☠️ QA against $RELEASE failed! ☠️ See $CI_PIPELINE_URL (triggered from $TOP_UPSTREAM_SOURCE_JOB)" ci_failing
+    - 'bin/slack $NOTIFY_CHANNEL "☠️ QA against $RELEASE failed! ☠️ See the test session report: $(cat REPORT_ISSUE_URL), and pipeline: $CI_PIPELINE_URL (triggered from $TOP_UPSTREAM_SOURCE_JOB)" ci_failing'

data/docs/running_specific_orchestrated_tests.md

@@ -4,7 +4,7 @@
 
 The [maven repository spec](https://gitlab.com/gitlab-org/gitlab/-/blob/master/qa/qa/specs/features/ee/browser_ui/5_package/maven_repository_spec.rb) creates a Maven artifact and links it to a GitLab project. The artifact is created within a [Maven docker image](https://gitlab.com/gitlab-org/gitlab/-/blob/master/qa/qa/service/docker_run/maven.rb#L8).
 
-Using `gitlab-qa` to run these tests reduces the liklihood of network errors between the maven container and GitLab instance.
+Using `gitlab-qa` to run these tests reduces the likelihood of network errors between the maven container and GitLab instance.
 
 To run this with `gitlab-qa` you can use the `Test::Instance::Image` that is needed for your test. For example:
 

data/gitlab-qa.gemspec

@@ -27,8 +27,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rubocop', '~> 0.82.0'
   spec.add_development_dependency 'rubocop-rspec', '~> 1.36'
   spec.add_development_dependency 'webmock', '3.7.0'
-  spec.add_runtime_dependency 'activesupport', '~>  6.0.2'
-  spec.add_runtime_dependency 'gitlab', '~>  4.11.0'
+  spec.add_runtime_dependency 'activesupport', '~> 6.0.2'
+  spec.add_runtime_dependency 'gitlab', '~> 4.16.1'
   spec.add_runtime_dependency 'http', '4.3.0'
   spec.add_runtime_dependency 'nokogiri', '~> 1.10'
   spec.add_runtime_dependency 'table_print', '1.5.6'

data/lib/gitlab/qa.rb

@@ -99,12 +99,15 @@ module Gitlab
 
     module Report
       autoload :GitlabIssueClient, 'gitlab/qa/report/gitlab_issue_client'
+      autoload :GitlabIssueDryClient, 'gitlab/qa/report/gitlab_issue_dry_client'
       autoload :BaseTestResults, 'gitlab/qa/report/base_test_results'
+      autoload :RelateFailureIssue, 'gitlab/qa/report/relate_failure_issue'
       autoload :JsonTestResults, 'gitlab/qa/report/json_test_results'
       autoload :JUnitTestResults, 'gitlab/qa/report/junit_test_results'
       autoload :PrepareStageReports, 'gitlab/qa/report/prepare_stage_reports'
       autoload :ReportAsIssue, 'gitlab/qa/report/report_as_issue'
       autoload :ResultsInIssues, 'gitlab/qa/report/results_in_issues'
+      autoload :GenerateTestSession, 'gitlab/qa/report/generate_test_session'
       autoload :SummaryTable, 'gitlab/qa/report/summary_table'
       autoload :TestResult, 'gitlab/qa/report/test_result'
       autoload :UpdateScreenshotPath, 'gitlab/qa/report/update_screenshot_path'

data/lib/gitlab/qa/component/base.rb

@@ -53,6 +53,7 @@ module Gitlab
 
         def prepare
           prepare_docker_image
+          prepare_docker_container
           prepare_network
         end
 
@@ -70,6 +71,12 @@ module Gitlab
           docker.network_create(network)
         end
 
+        def prepare_docker_container
+          return unless docker.container_exists?(name)
+
+          docker.remove(name)
+        end
+
         def start # rubocop:disable Metrics/AbcSize
           docker.run(image, tag) do |command|
             command << "-d"

data/lib/gitlab/qa/docker/engine.rb

@@ -63,6 +63,14 @@ module Gitlab
           Docker::Command.execute("rm -f #{name}")
         end
 
+        def container_exists?(name)
+          Docker::Command.execute("container inspect #{name}")
+        rescue Docker::Shellout::StatusError
+          false
+        else
+          true
+        end
+
         def network_exists?(name)
           Docker::Command.execute("network inspect #{name}")
         rescue Docker::Shellout::StatusError

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

@@ -6,8 +6,11 @@ module Gitlab
       class BaseTestResults
         include Enumerable
 
+        attr_reader :path
+
         def initialize(path)
-          @results = parse(path)
+          @path = path
+          @results = parse
           @testcases = process
         end
 
@@ -15,7 +18,7 @@ module Gitlab
           testcases.each(&block)
         end
 
-        def write(path)
+        def write
           raise NotImplementedError
         end
 
@@ -23,7 +26,7 @@ module Gitlab
 
         attr_reader :results, :testcases
 
-        def parse(path)
+        def parse
           raise NotImplementedError
         end
 

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

@@ -0,0 +1,203 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module QA
+    module Report
+      class GenerateTestSession < ReportAsIssue
+        private
+
+        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: "Test session report | #{Runtime::Env.deploy_environment}",
+            description: generate_description(tests),
+            labels: ['Quality', 'QA', 'triage report']
+          )
+
+          File.write('REPORT_ISSUE_URL', issue.web_url)
+        end
+
+        def generate_description(tests)
+          <<~MARKDOWN
+          ## Session summary
+
+          * Deploy version: #{Runtime::Env.deploy_version}
+          * Pipeline: [#{Runtime::Env.ci_pipeline_id}](#{Runtime::Env.ci_pipeline_url})
+          #{generate_summary(tests: tests)}
+
+          #{generate_stages_listing(tests)}
+
+          ## Release QA issue
+
+          * #{Runtime::Env.qa_issue_url}
+          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_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)}
+
+            </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)
+          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),
+              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)
+          text = tests_with_same_testcase.map(&:name).uniq.join(', ')
+
+          if testcase
+            "[#{text}](#{testcase})"
+          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.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
+      end
+    end
+  end
+end

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

@@ -45,7 +45,7 @@ module Gitlab
           abort_not_permitted
         end
 
-        def find_issues(iid:, options: {}, &select)
+        def find_issues(iid: nil, options: {}, &select)
           select ||= :itself
 
           handle_gitlab_client_exceptions do
@@ -57,15 +57,17 @@ module Gitlab
           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:)
-          puts "Creating issue..."
+          attrs = { description: description, labels: labels }
 
           handle_gitlab_client_exceptions do
-            Gitlab.create_issue(
-              project,
-              title,
-              { description: description, labels: labels }
-            )
+            Gitlab.create_issue(project, title, attrs)
           end
         end
 
@@ -75,6 +77,18 @@ module Gitlab
           end
         end
 
+        def create_issue_note(iid:, note:)
+          handle_gitlab_client_exceptions do
+            Gitlab.create_issue_note(project, iid, 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 handle_gitlab_client_exceptions
           yield
         rescue Gitlab::Error::NotFound
@@ -95,6 +109,9 @@ module Gitlab
           pipeline = QA::Runtime::Env.pipeline_from_project_name
           channel = pipeline == "canary" ? "qa-production" : "qa-#{pipeline}"
           error_msg = warn_exception(e)
+
+          return unless QA::Runtime::Env.ci_commit_ref_name == 'master'
+
           slack_options = {
             channel: channel,
             icon_emoji: ':ci_failing:',