gitlab-qa 6.13.0 → 6.15.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0692b909c3bf06d12d5f0846dc3296b93755d0c58c5969a71773e9664b298a8c'
-  data.tar.gz: 3aac312bb7b6dd2244d92b9bbf9ce1ecf561c65caae723abca625b155c00cfa4
+  metadata.gz: c3d066c13bb7ff790bdfc0e7ed6f6cbe70f65c9ecfe2400c3c804c8fc91e6db1
+  data.tar.gz: 85e35e3017cac986d7ccec3927e1f3543164443e2806803e4020830dfe0eebb1
 SHA512:
-  metadata.gz: 05c3a6b9ad1eec8d6adf2892ae3b90568bbfebc7f7def626126ae2b14da9be902b71edd8d45a7c98a3cb89b596fa6cee6b352da159f7e3ae1ca2daf8b37dc176
-  data.tar.gz: 4554af9b7849516651be2e5f32f4fd5d57690b4af2787292d4b18e6a8838fad92201a9d101edcbc9c2391327322fdaca96a37393fe6ea1a3111f734be7934d2f
+  metadata.gz: 2c4e9dffbbaff6dd23ee878b3601e6d3cfa13cb2928f5f360abeba0b75ec1841d45050fbd220c41960690c620da742c48862110857667c3c99566ed62aa80249
+  data.tar.gz: 8658c0b57a0693c335e515b07770b5bff1938fc307be9ad971724713a90b101cd9c1ec7b7c7b5527c9b5cc2c9d594a88ba88fcf6f5b4502801a243e7f754142c

data/.gitlab-ci.yml

@@ -1,8 +1,8 @@
 stages:
   - check
-  - release
   - test
   - report
+  - deploy
   - notify
 
 default:
@@ -35,13 +35,6 @@ workflow:
     # For triggers from GitLab MR pipelines (and pipelines from other projects), create a pipeline
     - if: '$CI_PIPELINE_SOURCE == "pipeline"'
 
-.default-rules:
-  rules:
-    - if: '$CI_COMMIT_TAG || $RELEASE'
-      when: never
-    - if: '$RELEASE == null && $CI_JOB_NAME =~ /staging/'
-      when: manual
-
 variables:
   DOCKER_DRIVER: overlay2
   DOCKER_HOST: tcp://docker:2375
@@ -65,21 +58,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:
@@ -107,6 +85,10 @@ release:
   variables:
     DEFAULT_RELEASE: "CE"
   rules:
+    # Don't run E2E jobs on release pipelines
+    - if: '$CI_SERVER_HOST == "gitlab.com" && $CI_PROJECT_PATH == "gitlab-org/gitlab-qa" && $RELEASE == null'
+      changes: ["lib/**/version.rb"]
+      when: never
     - if: '$CI_COMMIT_TAG || $RELEASE =~ /gitlab-ee/'
       when: never
     - if: '$RELEASE == null && $CI_JOB_NAME =~ /quarantine|custom/'
@@ -121,6 +103,10 @@ release:
   variables:
     DEFAULT_RELEASE: "EE"
   rules:
+    # Don't run E2E jobs on release pipelines
+    - if: '$CI_SERVER_HOST == "gitlab.com" && $CI_PROJECT_PATH == "gitlab-org/gitlab-qa" && $RELEASE == null'
+      changes: ["lib/**/version.rb"]
+      when: never
     - if: '$CI_COMMIT_TAG || $RELEASE =~ /gitlab-ce/'
       when: never
     - if: '$RELEASE == null && $CI_JOB_NAME =~ /quarantine|custom/'
@@ -132,7 +118,15 @@ release:
     - if: '$RELEASE == null || $RELEASE =~ /gitlab-ee/ || $CI_MERGE_REQUEST_ID || $CI_COMMIT_REF_NAME == "master"'
 
 .only-qa:
-  extends: .default-rules
+  rules:
+    # Don't run E2E jobs on release pipelines
+    - if: '$CI_SERVER_HOST == "gitlab.com" && $CI_PROJECT_PATH == "gitlab-org/gitlab-qa" && $RELEASE == null'
+      changes: ["lib/**/version.rb"]
+      when: never
+    - if: '$CI_COMMIT_TAG || $RELEASE'
+      when: never
+    - if: '$RELEASE == null && $CI_JOB_NAME =~ /staging/'
+      when: manual
 
 .high-capacity:
   tags:
@@ -474,7 +468,6 @@ ee:mattermost-quarantine:
 ee:geo:
   extends:
     - .test
-    - .high-capacity
     - .ee-qa
     - .rspec-report-opts
   variables:
@@ -483,7 +476,6 @@ ee:geo:
 ee:geo-quarantine:
   extends:
     - .test
-    - .high-capacity
     - .ee-qa
     - .quarantine
     - .rspec-report-opts
@@ -1012,3 +1004,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/lib/gitlab/qa/report/generate_test_session.rb

@@ -17,9 +17,9 @@ 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', deploy_environment_label]
+            labels: ['Quality', 'QA', 'triage report', pipeline_name_label]
           )
 
           File.write('REPORT_ISSUE_URL', issue.web_url)
@@ -27,20 +27,19 @@ module Gitlab
         # rubocop:enable Metrics/AbcSize
 
         def generate_description(tests)
-          <<~MARKDOWN
+          <<~MARKDOWN.rstrip
           ## 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
-
-          * #{Runtime::Env.qa_issue_url}
+          #{generate_qa_issue_relation}
           MARKDOWN
         end
 
@@ -60,24 +59,30 @@ module Gitlab
         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 = Gitlab.pipeline_jobs(
+            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
+          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")
+            "* [#{job.name}](#{job.web_url})#{allowed_to_fail}"
+          end.join("\n")
 
-            <<~MARKDOWN.chomp if failed_jobs.any?
-            ## Failed jobs
+          <<~MARKDOWN.chomp if failed_jobs.any?
+          ## Failed jobs
 
-            #{listings}
-            MARKDOWN
-          end
+          #{listings}
+          MARKDOWN
         end
 
         def generate_stages_listing(tests)
@@ -222,6 +227,18 @@ module Gitlab
             '-'
           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
       end
     end
   end

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

@@ -34,7 +34,10 @@ module Gitlab
               #  /qa/specs/features/ee/api/<stage>
               #  /qa/specs/features/ee/browser_ui/<stage>
               # For now we assume the Stage is whatever follows api/ or browser_ui/
-              stage = strip_number_prefix(test['file'].match(%r{(api|browser_ui)/([a-z0-9_]+)}i)[2])
+              test_path_match = test['file'].match(%r{(api|browser_ui)/([a-z0-9_]+)}i)
+              next unless test_path_match
+
+              stage = strip_number_prefix(test_path_match[2])
               testcases[stage] = [] unless testcases.key?(stage)
               testcases[stage] << test
             end

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

@@ -142,7 +142,7 @@ module Gitlab
         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)

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

@@ -104,20 +104,18 @@ module Gitlab
           labels
         end
 
-        def deploy_environment_label
-          environment = Runtime::Env.deploy_environment
-
-          case environment
+        def pipeline_name_label
+          case pipeline
           when 'production'
             'found:gitlab.com'
           when 'canary', 'staging'
-            "found:#{environment}.gitlab.com"
+            "found:#{pipeline}.gitlab.com"
           when 'preprod'
             'found:pre.gitlab.com'
           when 'staging-orchestrated', 'nightly', 'master'
-            "found:#{environment}"
+            "found:#{pipeline}"
           else
-            raise "No `found:*` label for the `#{environment}` environment!"
+            raise "No `found:*` label for the `#{pipeline}` pipeline!"
           end
         end
 

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

@@ -116,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

data/lib/gitlab/qa/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   module QA
-    VERSION = '6.13.0'.freeze
+    VERSION = '6.15.3'.freeze
   end
 end

metadata

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