gitlab-qa 6.10.1 → 6.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f7798682f401a1349003d47532109adc5523cca0d4dfb43a0036669d0432168f
-  data.tar.gz: eaa7d08e48b241b2d2a521f493543f40beebaef4dcb86e04584eb34cbfbba1c8
+  metadata.gz: a196452581ca78bf81e38487d2563675d1f1afce26754e6ae14f754c9386bac8
+  data.tar.gz: 3e6f876da229512eb72d93a98e5affc28c809c4e01b0fadf2dcd13a1e743ba12
 SHA512:
-  metadata.gz: fd9312eb0cf93c3ec671b1115d96ae3926fe977de8c11134817fa90cdfb431b88015ce0c28dab8009492f7a14cba173ec13ffca8e466115e37e1b547f5cbe56d
-  data.tar.gz: cd2810c3e560b25337835d9f8e324549bff222cd45529ae7bd372351284a7080c33aaa611bfe95605f2cb12b3a7c958f272436d2e587b98fa8a425cdfdccfd90
+  metadata.gz: 6b87108ae34a262954ea9ce8ef0129383c76a9e73812819286aa35e5ff8200a7763fb048144c7ce316a4c45f7d5d11ffb1349864f3d493e588fde1fbfbaa6516
+  data.tar.gz: e37a184f29e23f5b02c58365f5628066cbac40158cbd764dfc118bf62176a1cd7690835ede80e8e9a0a5ab8d230dc1e5b509d35d7bb77626fd3b31bc779ed3b7

data/.gitlab-ci.yml

@@ -1,8 +1,8 @@
 stages:
   - check
-  - release
   - test
   - report
+  - deploy
   - notify
 
 default:
@@ -65,21 +65,6 @@ rubocop:
 rspec:
   extends: .check-base
 
-release:
-  stage: release
-  rules:
-    - if: '$CI_COMMIT_TAG'
-  script:
-    - gem update --system
-    - ruby --version
-    - gem env version
-    - gem build gitlab-qa.gemspec
-    - gem push gitlab-qa*.gem
-  artifacts:
-    paths:
-      - gitlab-qa*.gem
-    expire_in: 30 days
-
 .test:
   stage: test
   services:
@@ -95,8 +80,8 @@ release:
     reports:
       junit: gitlab-qa-run-*/**/rspec-*.xml
   script:
-    - 'echo "Running: exe/gitlab-qa ${QA_SCENARIO:=Test::Instance::Image} ${RELEASE:=$DEFAULT_RELEASE} -- $QA_TESTS $QA_RSPEC_TAGS $RSPEC_REPORT_OPTS"'
-    - exe/gitlab-qa ${QA_SCENARIO:=Test::Instance::Image} ${RELEASE:=$DEFAULT_RELEASE} -- $QA_TESTS $QA_RSPEC_TAGS $RSPEC_REPORT_OPTS || test_run_exit_code=$?
+    - 'echo "Running: exe/gitlab-qa ${QA_SCENARIO:=Test::Instance::Image} ${RELEASE:=$DEFAULT_RELEASE} $GITLAB_QA_OPTS -- $QA_TESTS $QA_RSPEC_TAGS $RSPEC_REPORT_OPTS"'
+    - exe/gitlab-qa ${QA_SCENARIO:=Test::Instance::Image} ${RELEASE:=$DEFAULT_RELEASE} $GITLAB_QA_OPTS -- $QA_TESTS $QA_RSPEC_TAGS $RSPEC_REPORT_OPTS || test_run_exit_code=$?
     - 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
@@ -175,8 +160,8 @@ ee:sanity-framework:
 # The custom jobs are for manually running specific/alternative tests in MRs, so we don't report them in issues
 ce:custom-parallel:
   script:
-    - 'echo "Running: exe/gitlab-qa ${QA_SCENARIO:=Test::Instance::Image} ${RELEASE:=$DEFAULT_RELEASE} -- $QA_TESTS $QA_RSPEC_TAGS $RSPEC_REPORT_OPTS"'
-    - exe/gitlab-qa ${QA_SCENARIO:=Test::Instance::Image} ${RELEASE:=$DEFAULT_RELEASE} -- $QA_TESTS $QA_RSPEC_TAGS $RSPEC_REPORT_OPTS
+    - 'echo "Running: exe/gitlab-qa ${QA_SCENARIO:=Test::Instance::Image} ${RELEASE:=$DEFAULT_RELEASE} $GITLAB_QA_OPTS -- $QA_TESTS $QA_RSPEC_TAGS $RSPEC_REPORT_OPTS"'
+    - exe/gitlab-qa ${QA_SCENARIO:=Test::Instance::Image} ${RELEASE:=$DEFAULT_RELEASE} $GITLAB_QA_OPTS -- $QA_TESTS $QA_RSPEC_TAGS $RSPEC_REPORT_OPTS
   extends:
     - .test
     - .high-capacity
@@ -187,8 +172,8 @@ ce:custom-parallel:
 
 ee:custom-parallel:
   script:
-    - 'echo "Running: exe/gitlab-qa ${QA_SCENARIO:=Test::Instance::Image} ${RELEASE:=$DEFAULT_RELEASE} -- $QA_TESTS $QA_RSPEC_TAGS $RSPEC_REPORT_OPTS"'
-    - exe/gitlab-qa ${QA_SCENARIO:=Test::Instance::Image} ${RELEASE:=$DEFAULT_RELEASE} -- $QA_TESTS $QA_RSPEC_TAGS $RSPEC_REPORT_OPTS
+    - 'echo "Running: exe/gitlab-qa ${QA_SCENARIO:=Test::Instance::Image} ${RELEASE:=$DEFAULT_RELEASE} $GITLAB_QA_OPTS -- $QA_TESTS $QA_RSPEC_TAGS $RSPEC_REPORT_OPTS"'
+    - exe/gitlab-qa ${QA_SCENARIO:=Test::Instance::Image} ${RELEASE:=$DEFAULT_RELEASE} $GITLAB_QA_OPTS -- $QA_TESTS $QA_RSPEC_TAGS $RSPEC_REPORT_OPTS
   extends:
     - .test
     - .high-capacity
@@ -1012,3 +997,7 @@ notify_slack:
     - 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 the test session report: $(cat REPORT_ISSUE_URL), and pipeline: $CI_PIPELINE_URL (triggered from $TOP_UPSTREAM_SOURCE_JOB)" ci_failing'
+
+include:
+  - project: 'gitlab-org/quality/pipeline-common'
+    file: '/ci/gem-release.yml'

data/.gitlab/merge_request_templates/Release.md

@@ -30,6 +30,6 @@ with the latest commit from https://gitlab.com/gitlab-org/gitlab-qa/commits/mast
   - [ ] Release notes are accurate.
 
 - Checklist after merging:
-  - [ ] [Create a tag for the new release version](docs/release_process.md#how-to).
+  - [ ] [Update the release notes for the newly created tag](docs/release_process.md#how-to).
 
 /label ~Quality ~"feature::maintenance"

data/docs/release_process.md

@@ -24,12 +24,13 @@ when we make a change - no matter the size of the change.
   - If not, update [`lib/gitlab/qa/version.rb`] to an appropriate [semantic version](https://semver.org) in a new merge request using the [release template](https://gitlab.com/gitlab-org/gitlab-qa/blob/master/.gitlab/merge_request_templates/Release.md)
     and title the MR like `"Bump version to <version>"`.
 - Merge the merge request.
-- Create a new tag via the UI (https://gitlab.com/gitlab-org/gitlab-qa/-/tags/new).
-  * **Tag name**: The same version found in [`lib/gitlab/qa/version.rb`], prefixed with `v`, e.g. if the version is `4.7.1`, the tag would be `v4.7.1`.
-  * **Message**: Set it to "Version x.y.z", e.g. if the version is `4.7.1`, the message would be "Version 4.7.1".
+- The new version should automatically be tagged and pushed to Rubygems by the `gem-release` job in the merge commit pipeline.
+- Update the release notes for the newly created tag (https://gitlab.com/gitlab-org/gitlab-qa/-/tags):
   * **Release notes**: Copy the release notes from the merge request.
-  * Click *Create Tag*.
-  
-GitLab will then start a pipeline for this new tag, and the `release` job will build and push the new version of `gitlab-qa` to RubyGems.
+
+Note: The `gem-release` job uses:
+
+- the `GITLAB_API_TOKEN` environment variable to authenticate against GitLab.com's API in order to create the tag
+- the `GEM_HOST_API_KEY` environment variable to authenticate against Rubygems.org's API in order to release the gem
 
 [`lib/gitlab/qa/version.rb`]: https://gitlab.com/gitlab-org/gitlab-qa/blob/master/lib/gitlab/qa/version.rb#L3

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/docs/what_tests_can_be_run.md

@@ -84,6 +84,7 @@ All environment variables used by GitLab QA should be defined in [`lib/gitlab/qa
 | `JIRA_ADMIN_PASSWORD` |-  | Password for authenticating with Jira server as admin. | No|
 | `CACHE_NAMESPACE_NAME` | `true` | Cache namespace name for groups. | No|
 | `DEPLOY_VERSION` |- | The version of GitLab being tested against. | No|
+| `GITLAB_QA_USER_AGENT` |- | The browser user-agent to use instead of the default Chrome user-agent. | No|
 
 ## [Supported Remote Grid environment variables](./running_against_remote_grid.md)
 

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

@@ -6,6 +6,7 @@ module Gitlab
       class GenerateTestSession < ReportAsIssue
         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}`."
 
@@ -16,22 +17,26 @@ module Gitlab
           end
 
           issue = gitlab.create_issue(
-            title: "Test session report | #{Runtime::Env.deploy_environment}",
+            title: "Test session report | #{pipeline}",
             description: generate_description(tests),
-            labels: ['Quality', 'QA', 'triage report']
+            labels: ['Quality', 'QA', 'triage report', pipeline_name_label]
           )
 
           File.write('REPORT_ISSUE_URL', issue.web_url)
         end
+        # rubocop:enable Metrics/AbcSize
 
         def generate_description(tests)
           <<~MARKDOWN
           ## Session summary
 
           * Deploy version: #{Runtime::Env.deploy_version}
-          * Pipeline: [#{Runtime::Env.ci_pipeline_id}](#{Runtime::Env.ci_pipeline_url})
+          * 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)}
 
           ## Release QA issue
@@ -55,6 +60,33 @@ module Gitlab
           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)
@@ -185,7 +217,7 @@ module Gitlab
               tests_with_same_testcase.select(&:failure_issue)
 
             if tests_having_failure_issue.any?
-              items = tests_having_failure_issue.map do |test|
+              items = tests_having_failure_issue.uniq(&:failure_issue).map do |test|
                 "<li>[ ] [failure issue](#{test.failure_issue})</li>"
               end.join(' ')
 

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

@@ -82,17 +82,20 @@ module Gitlab
           # Search with the `search` param returns 500 errors, so we filter by ~QA and then filter further in Ruby
           failure_issues(test).each_with_object({}) do |issue, memo|
             relevant_issue_stacktrace = find_issue_stacktrace(issue)
-            unless relevant_issue_stacktrace
-              puts "  => [DEBUG] Found issue #{issue.web_url} but stacktrace doesn't match."
-              next
-            end
+            next unless relevant_issue_stacktrace
 
             distance = ld.call(first_test_failure_stacktrace, relevant_issue_stacktrace)
             diff_ratio = (distance.to_f / first_test_failure_stacktrace.size).round(3)
             if diff_ratio <= max_diff_ratio
-              memo[issue] = diff_ratio
+              puts "  => [DEBUG] Issue #{issue} has an acceptable diff ratio of #{(diff_ratio * 100).round(2)}%."
+              # The `Gitlab::ObjectifiedHash` class overrides `#hash` which is used by `Hash#[]=` to compute the hash key.
+              # This leads to a `TypeError Exception: no implicit conversion of Hash into Integer` error, so we convert the object to a hash before using it as a Hash key.
+              # See:
+              # - https://gitlab.com/gitlab-org/gitlab-qa/-/merge_requests/587#note_453336995
+              # - https://github.com/NARKOZ/gitlab/commit/cbdbd1e32623f018a8fae39932a8e3bc4d929abb?_pjax=%23js-repo-pjax-container#r44484494
+              memo[issue.to_h] = diff_ratio
             else
-              puts "  => [DEBUG] Found issue #{issue.web_url} but stacktrace is too different (#{(diff_ratio * 100).round(2)}%)."
+              puts "  => [DEBUG] Found issue #{issue.web_url} but stacktraces are too different (#{(diff_ratio * 100).round(2)}%)."
             end
           end
         end
@@ -103,7 +106,7 @@ module Gitlab
           if issue_stacktrace_match
             issue_stacktrace_match[2].gsub(/^#.*$/, '').strip
           else
-            puts "\n  => Stacktrace couldn't be found for #{issue.web_url}:\n\n#{issue.description}\n\n----------------------------------\n"
+            puts "  => [DEBUG] Stacktrace couldn't be found for #{issue.web_url}:\n\n#{issue.description}\n\n----------------------------------\n"
           end
         end
 
@@ -118,6 +121,9 @@ module Gitlab
             raise(MultipleIssuesFound, %(Too many issues found for test '#{test.name}' (`#{test.file}`)!))
           end
 
+          # Re-instantiate a `Gitlab::ObjectifiedHash` object after having converted it to a hash in #find_relevant_failure_issues above.
+          best_matching_issue = Gitlab::ObjectifiedHash.new(best_matching_issue)
+
           test.failure_issue ||= best_matching_issue.web_url
 
           [best_matching_issue, smaller_diff_ratio]
@@ -131,36 +137,19 @@ module Gitlab
           ].join("\n\n")
         end
 
-        def deploy_environment_label
-          environment = Runtime::Env.deploy_environment
-
-          case environment
-          when 'production'
-            'found:gitlab.com'
-          when 'canary', 'staging'
-            "found:#{environment}.gitlab.com"
-          when 'preprod'
-            'found:pre.gitlab.com'
-          when 'staging-orchestrated', 'nightly', 'master'
-            "found:#{environment}"
-          else
-            raise "No `found:*` label for the `#{environment}` environment!"
-          end
-        end
-
         def new_issue_labels(test)
           NEW_ISSUE_LABELS + up_to_date_labels(test: test)
         end
 
         def up_to_date_labels(test:, issue: nil)
-          super << deploy_environment_label
+          super << pipeline_name_label
         end
 
         def post_failed_job_note(issue, test)
           gitlab.create_issue_note(iid: issue.iid, note: "/relate #{test.testcase}")
         end
 
-        def title_from_test(test)
+        def new_issue_title(test)
           "Failure in #{super}"
         end
       end

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

@@ -28,6 +28,10 @@ module Gitlab
           raise NotImplementedError
         end
 
+        def new_issue_title(test)
+          "#{partial_file_path(test.file)} | #{search_safe(test.name)}".strip
+        end
+
         def new_issue_description(test)
           "### Full description\n\n#{search_safe(test.name)}\n\n### File path\n\n#{test.file}"
         end
@@ -100,6 +104,21 @@ module Gitlab
           labels
         end
 
+        def pipeline_name_label
+          case pipeline
+          when 'production'
+            'found:gitlab.com'
+          when 'canary', 'staging'
+            "found:#{pipeline}.gitlab.com"
+          when 'preprod'
+            'found:pre.gitlab.com'
+          when 'staging-orchestrated', 'nightly', 'master'
+            "found:#{pipeline}"
+          else
+            raise "No `found:*` label for the `#{pipeline}` pipeline!"
+          end
+        end
+
         def ee_test?(test)
           test.file =~ %r{features/ee/(api|browser_ui)}
         end
@@ -113,7 +132,7 @@ module Gitlab
         end
 
         def title_from_test(test)
-          title = "#{partial_file_path(test.file)} | #{search_safe(test.name)}".strip
+          title = new_issue_title(test)
 
           return title unless title.length > MAX_TITLE_LENGTH
 

data/lib/gitlab/qa/runtime/env.rb

@@ -85,7 +85,8 @@ module Gitlab
           'JIRA_ADMIN_USERNAME' => :jira_admin_username,
           'JIRA_ADMIN_PASSWORD' => :jira_admin_password,
           'CACHE_NAMESPACE_NAME' => :cache_namespace_name,
-          'DEPLOY_VERSION' => :deploy_version
+          'DEPLOY_VERSION' => :deploy_version,
+          'GITLAB_QA_USER_AGENT' => :gitlab_qa_user_agent
         }.freeze
 
         ENV_VARIABLES.each do |env_name, method_name|
@@ -115,6 +116,14 @@ module Gitlab
           ENV['GITLAB_BOT_MULTI_PROJECT_PIPELINE_POLLING_TOKEN']
         end
 
+        def gitlab_ci_api_token
+          ENV['GITLAB_CI_API_TOKEN']
+        end
+
+        def ci_api_v4_url
+          ENV['CI_API_V4_URL']
+        end
+
         def ci_job_name
           ENV['CI_JOB_NAME']
         end
@@ -135,8 +144,8 @@ module Gitlab
           ENV['CI_PIPELINE_ID']
         end
 
-        def ci_project_name
-          ENV['CI_PROJECT_NAME']
+        def ci_project_id
+          ENV['CI_PROJECT_ID']
         end
 
         def ci_commit_ref_name

data/lib/gitlab/qa/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   module QA
-    VERSION = '6.10.1'.freeze
+    VERSION = '6.15.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-qa
 version: !ruby/object:Gem::Version
-  version: 6.10.1
+  version: 6.15.0
 platform: ruby
 authors:
 - Grzegorz Bizon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-19 00:00:00.000000000 Z
+date: 2020-12-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control