gitlab-qa 10.2.1 → 10.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a87ce2862d1a1e65107ce6b34b35e9ffdea5dacd3ac8d193d0193ccd70955f2
-  data.tar.gz: 6b5e54d9aff03e63831b2874076ade24540c164e5391e628c0ab7b6a2a0f19b6
+  metadata.gz: 2851a74117f3479437a3e355883c7a407d4f56c41aac2700028cd9686790f0ea
+  data.tar.gz: a284df28173a258c4948ead8be3c677df487c585b60cc73ffe88d5c12b6281b5
 SHA512:
-  metadata.gz: 617455a03eba3c3e7fb55eed317084851160409105c356d76cfb7c449daa383985a62ae7a4ccac64e2804511aed8a7fe826a4bf3effac7210150c5359fa209d7
-  data.tar.gz: 9947e70d1176453db67c99223ed72c9f8be9764ffb80985fd94666d758ef5abca7b3d67b294f24988d5d089a6b1f1afc9e30ca2eed9134c944c8ccec2a1216b6
+  metadata.gz: 44a1c9743ce4fafbaad0e20f2de55598c4686598a2c3ac50d9da69565e72a477e3a0ab90f909fb32ed2b153129912b365db19ee9af91814bf6db707dc4bc70f4
+  data.tar.gz: f2d8e7accf348103ff3f7ab85467186dd11a7c51a5cdb691e3e8999716272ba54a06204257395a7594ea832c60b93d33a11fd198c57b957609599638ab3b2672

data/.gitlab/merge_request_templates/Release.md

@@ -32,4 +32,9 @@ with the latest commit from https://gitlab.com/gitlab-org/gitlab-qa/commits/mast
 - Checklist after merging:
   - [ ] [Update the release notes for the newly created tag](docs/release_process.md#how-to).
 
+- Checklist after gitlab-qa version has been released by the post merge pipeline:
+  - [ ] In the pipeline-common project, [update the GITLAB_QA_VERSION](https://gitlab.com/gitlab-org/quality/pipeline-common/-/blob/master/ci/base.gitlab-ci.yml) and [create a release](https://gitlab.com/gitlab-org/quality/pipeline-common#release-process).
+  - [ ] In the GitLab project, update the ref for pipeline-common for [package-and-test](https://gitlab.com/gitlab-org/gitlab/-/blob/master/.gitlab/ci/package-and-test/main.gitlab-ci.yml) and [review-apps](https://gitlab.com/gitlab-org/gitlab/-/blob/master/.gitlab/ci/review-apps/qa.gitlab-ci.yml).
+  - [ ] Unless already done by [renovate-gitlab-bot](https://gitlab.com/dashboard/merge_requests?scope=all&state=opened&author_username=gitlab-dependency-update-bot&label_name[]=Quality), or if you need it sooner, in the GitLab project, [update the gitlab-qa gem version](https://gitlab.com/gitlab-org/gitlab/-/blob/master/qa/Gemfile) and [`Gemfile.lock`](https://gitlab.com/gitlab-org/gitlab/-/blob/master/qa/Gemfile.lock) (for an example, see: https://gitlab.com/gitlab-org/gitlab/-/merge_requests/117054).
+
 /label ~Quality ~"type::maintenance" ~"maintenance::dependency"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab-qa (10.2.1)
+    gitlab-qa (10.3.0)
       activesupport (~> 6.1)
       gitlab (~> 4.18.0)
       http (~> 5.0)

data/docs/running_against_remote_grid.md

@@ -9,12 +9,17 @@ I.e, if you have a Selenium server set up at http://localhost:4444 or if you hav
 | Variable                  | Description                                                    | Default  | Example(s)                     |
 |---------------------------|----------------------------------------------------------------|----------|--------------------------------|
 | QA_BROWSER                | Browser to run against                                         | "chrome" | "chrome" "firefox" "safari"    |
+| QA_BROWSER_VERSION        | Version of browser to run against                              | "latest" | "latest" "111.0" "mobile-111.0"|
 | QA_REMOTE_GRID_PROTOCOL   | Protocol to use                                                | "http"   | "http" "https"                 |
-| QA_REMOTE_GRID            | Remote grid to run tests against                               |          | "localhost:3000" "provider:80" |
-| QA_REMOTE_GRID_USERNAME   | Username to specify in the remote grid. "USERNAME@provider:80" |          | "gitlab-sl"                    |
-| QA_REMOTE_GRID_ACCESS_KEY | Key/Token paired with `QA_REMOTE_GRID_USERNAME`                |          |                                |
-| QA_REMOTE_TUNNEL_ID       | Name of the remote tunnel to use                               | "gitlab-sl_tunnel_id" |                                |
-| QA_REMOTE_MOBILE_DEVICE_NAME | Name of mobile device to test against. `QA_BROWSER` must be set to `safari` for iOS devices and `chrome` for Android devices.                                                |          | "iPhone 12 Simulator"          |
+| QA_REMOTE_GRID            | Remote grid to run tests against                               |          | "localhost:3000" "provider:80" "selenoid:4444" |
+| QA_LAYOUT                 | Used with Selenoid. Tells test nav to expect collapsed menus. "phone" expects collapsed top and left nav bars, "tablet" expects collapsed left nav bar only. |          | "phone", "tablet"              |
+| SELENOID_DIRECTORY        | Used with Selenoid. Directory to save videos to                | "<host_artifacts_dir>/selenoid" |        |
+| USE_SELENOID              | Used with Selenoid. Sets up selenoid containers.               | false    | false, true                    |
+| QA_RECORD_VIDEO           | Used with Selenoid. Triggers video recording.                  | false    | false, true                    |
+| QA_REMOTE_GRID_USERNAME   | Used with Sauce Labs. Username to specify in the remote grid. "USERNAME@provider:80" |          | "gitlab-sl"                    |
+| QA_REMOTE_GRID_ACCESS_KEY | Used with Sauce Labs. Key/Token paired with `QA_REMOTE_GRID_USERNAME` |          |                                |
+| QA_REMOTE_TUNNEL_ID       | Used with Sauce Labs. Name of the remote tunnel to use         | "gitlab-sl_tunnel_id" |                                |
+| QA_REMOTE_MOBILE_DEVICE_NAME | Used with Sauce Labs. Name of mobile device to test against. `QA_BROWSER` must be set to `safari` for iOS devices and `chrome` for Android devices. |          | "iPhone 12 Simulator"          |
 
 ## Testing with Sauce Labs
 

data/fixtures/selenoid/browsers.json

@@ -0,0 +1,25 @@
+{
+  "chrome": {
+    "default": "111.0",
+    "versions": {
+      "111.0": {
+        "image": "selenoid/chrome:111.0",
+        "port": "4444"
+      },
+      "mobile-111.0": {
+        "image": "registry.gitlab.com/gitlab-org/gitlab-qa/selenoid-chrome-gitlab:mobile-111.0",
+        "path": "/wd/hub",
+        "port": "4444"
+      }
+    }
+  },
+  "MicrosoftEdge": {
+    "default": "111.0",
+    "versions": {
+      "111.0": {
+        "image": "browsers/edge:111.0",
+        "port": "4444"
+      }
+    }
+  }
+}

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

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require 'http'
+
+module Gitlab
+  module QA
+    module Component
+      # Component for the Selenoid Grid
+      # https://aerokube.com/selenoid/latest/
+      class Selenoid < Base
+        DOCKER_IMAGE = 'aerokube/selenoid'
+        DOCKER_IMAGE_TAG = 'latest-release'
+
+        def name
+          @name ||= 'selenoid'
+        end
+
+        def instance
+          Runtime::Env.webdriver_headless = '0'
+          Runtime::Env.chrome_disable_dev_shm = 'true'
+          Runtime::Env.remote_grid = "#{hostname}:4444"
+          Runtime::Env.remote_grid_protocol = 'http'
+          raise 'Please provide a block!' unless block_given?
+
+          super
+        end
+
+        def start
+          pull_images
+          docker.run(image: image, tag: tag, args: ['-container-network', network]) do |command|
+            set_command_args(command)
+            set_volumes(command)
+          end
+
+          wait_until_ready
+        end
+
+        def wait_until_ready(max_attempts: 20, wait: 2)
+          Runtime::Logger.info("Waiting for Selenoid ...")
+
+          max_attempts.times do
+            return Runtime::Logger.info("Selenoid ready!") if grid_healthy?
+
+            sleep wait
+          end
+
+          raise "Retried #{max_attempts} times. Selenoid is not responding. Aborting."
+        end
+
+        private
+
+        def grid_healthy?
+          HTTP.get('http://localhost:4444/ping').status&.success?
+        rescue HTTP::ConnectionError => _e
+          false
+        end
+
+        def pull_images
+          docker.pull(image: "selenoid/chrome", tag: Runtime::Env.browser_version) if Runtime::Env.browser == :chrome && !Runtime::Env.mobile_layout?
+          docker.pull(image: "selenoid/video-recorder", tag: "latest-release")
+        end
+
+        # Set custom run command arguments
+        #
+        # @param [Docker::Command] command
+        # @return [void]
+        def set_command_args(command)
+          command << '-d '
+          command << "--name #{name}"
+          command << "--net #{network}"
+          command << "--hostname #{hostname}"
+          command << "--publish 4444:4444"
+          command << "-e OVERRIDE_VIDEO_OUTPUT_DIR=#{Runtime::Env.selenoid_directory}/video"
+        end
+
+        # Set volumes
+        #
+        # @param [Docker::Command] command
+        # @return [void]
+        def set_volumes(command)
+          command.volume('/var/run/docker.sock', '/var/run/docker.sock')
+          command.volume("#{__dir__}/../../../../fixtures/selenoid", "/etc/selenoid")
+          command.volume("#{Runtime::Env.selenoid_directory}/video", '/opt/selenoid/video')
+        end
+      end
+    end
+  end
+end

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

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 # rubocop:disable Metrics/CyclomaticComplexity
+# rubocop:disable Metrics/AbcSize
 
 require 'securerandom'
 
@@ -27,6 +28,19 @@ module Gitlab
         end
 
         def perform
+          if Runtime::Env.use_selenoid?
+            Component::Selenoid.perform do |selenoid|
+              selenoid.network = network
+              selenoid.instance do
+                internal_perform
+              end
+            end
+          else
+            internal_perform
+          end
+        end
+
+        def internal_perform
           return Runtime::Logger.info("Skipping tests.") if skip_tests?
 
           raise ArgumentError unless [suite, release].all?
@@ -114,3 +128,4 @@ module Gitlab
   end
 end
 # rubocop:enable Metrics/CyclomaticComplexity
+# rubocop:enable Metrics/AbcSize

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

@@ -19,7 +19,7 @@ module Gitlab
         FAILED_JOB_DESCRIPTION_REGEX = %r{First happened in https?:\/\/\S+\.}m.freeze
         FAILED_JOB_NOTE_REGEX = %r{Failed most recently in \D+ pipeline: https?:\/\/\S+}.freeze
         NEW_ISSUE_LABELS = Set.new(%w[QA Quality test failure::new priority::2]).freeze
-        IGNORE_EXCEPTIONS = ['Net::ReadTimeout'].freeze
+        IGNORE_EXCEPTIONS = ['Net::ReadTimeout', '403 Forbidden - Your account has been blocked'].freeze
 
         MultipleIssuesFound = Class.new(StandardError)
 
@@ -53,10 +53,10 @@ module Gitlab
           puts "  => Searching issues for test '#{test.name}'..."
 
           begin
-            issue = test.quarantine? ? find_and_link_issue(test) : find_and_link_issue(test) || create_issue(test)
-            return unless issue
+            issue, issue_already_commented = find_and_link_issue(test)
+            return create_issue(test) unless issue || test.quarantine?
 
-            update_labels(issue, test)
+            update_labels(issue, test) unless issue_already_commented
           rescue MultipleIssuesFound => e
             warn(e.message)
           end
@@ -64,19 +64,18 @@ module Gitlab
 
         def find_and_link_issue(test)
           issue, diff_ratio = find_failure_issue(test)
-          issue_already_commented = issue ? @commented_issue_list.include?(issue.web_url) : nil
+          return [false, true] unless issue
 
-          if issue && !issue_already_commented
+          issue_already_commented = issue_already_commented?(issue)
+          if issue_already_commented
+            puts " => Failure already commented on issue."
+          else
             puts "  => Found issue #{issue.web_url} for test '#{test.name}' with a diff ratio of #{(diff_ratio * 100).round(2)}%."
             post_or_update_failed_job_note(issue, test)
             @commented_issue_list.add(issue.web_url)
-          else
-            puts " => Failure already commented on issue." if issue_already_commented
-
-            return false
           end
 
-          issue
+          [issue, issue_already_commented]
         end
 
         def create_issue(test)
@@ -286,6 +285,8 @@ module Gitlab
           current_note = "Failed most recently in #{pipeline} pipeline: #{test.ci_job_url}"
           existing_note = existing_failure_note(issue)
 
+          return if existing_note && current_note == existing_note.body
+
           if existing_note
             gitlab.edit_issue_note(issue_iid: issue.iid, note_id: existing_note.id, note: current_note)
           else
@@ -355,13 +356,17 @@ module Gitlab
         # @param [Array<Hash>] exceptions the exceptions associated with the failure.
         # @return [String] the reason to ignore the exceptions, or `nil` if any exceptions should not be ignored.
         def ignore_failure_reason(exceptions)
-          exception_classes = exceptions
-            .filter_map { |exception| exception['class'] if IGNORE_EXCEPTIONS.include?(exception['class']) }
+          exception_messages = exceptions
+            .filter_map { |exception| exception['message'] if IGNORE_EXCEPTIONS.any? { |e| exception['message'].include?(e) } }
             .compact
-          return if exception_classes.empty? || exception_classes.size < exceptions.size
+          return if exception_messages.empty? || exception_messages.size < exceptions.size
+
+          msg = exception_messages.many? ? 'the errors were' : 'the error was'
+          "#{msg} #{exception_messages.join(', ')}"
+        end
 
-          msg = exception_classes.many? ? 'the errors were' : 'the error was'
-          "#{msg} #{exception_classes.join(', ')}"
+        def issue_already_commented?(issue)
+          @commented_issue_list.include?(issue.web_url)
         end
       end
     end

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

@@ -41,6 +41,7 @@ module Gitlab
           'QA_INFLUXDB_TOKEN' => :qa_influxdb_token,
           'QA_SKIP_PULL' => :qa_skip_pull,
           'QA_VALIDATE_RESOURCE_REUSE' => :qa_validate_resource_reuse,
+          'WEBDRIVER_HEADLESS' => :webdriver_headless,
           'GITLAB_API_BASE' => :api_base,
           'GITLAB_ADMIN_USERNAME' => :admin_username,
           'GITLAB_ADMIN_PASSWORD' => :admin_password,
@@ -148,7 +149,9 @@ module Gitlab
           'RELEASE' => :release,
           'RELEASE_REGISTRY_URL' => :release_registry_url,
           'RELEASE_REGISTRY_USERNAME' => :release_registry_username,
-          'RELEASE_REGISTRY_PASSWORD' => :release_registry_password
+          'RELEASE_REGISTRY_PASSWORD' => :release_registry_password,
+          'SELENOID_DIRECTORY' => :selenoid_directory,
+          'USE_SELENOID' => :use_selenoid
         }.freeze
 
         ENV_VARIABLES.each do |env_name, method_name|
@@ -349,6 +352,22 @@ module Gitlab
           enabled?(env_var_value_if_defined('QA_EXPORT_TEST_METRICS'), default: true)
         end
 
+        def selenoid_directory
+          env_var_value_if_defined('SELENOID_DIRECTORY') || "#{host_artifacts_dir}/selenoid"
+        end
+
+        def use_selenoid?
+          enabled?(env_var_value_if_defined('USE_SELENOID'), default: false)
+        end
+
+        def mobile_layout?
+          env_var_value_if_defined('QA_LAYOUT')&.match?(/tablet|phone/i)
+        end
+
+        def browser_version
+          env_var_value_if_defined('QA_BROWSER_VERSION')
+        end
+
         def qa_run_type
           return env_var_value_if_defined('QA_RUN_TYPE') if env_var_value_valid?('QA_RUN_TYPE')
 

data/lib/gitlab/qa/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   module QA
-    VERSION = '10.2.1'
+    VERSION = '10.3.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-qa
 version: !ruby/object:Gem::Version
-  version: 10.2.1
+  version: 10.3.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-14 00:00:00.000000000 Z
+date: 2023-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -360,6 +360,7 @@ files:
 - fixtures/ldap/2_add_users.ldif
 - fixtures/ldap/3_add_groups.ldif
 - fixtures/ldap/tanuki.ldif
+- fixtures/selenoid/browsers.json
 - gitlab-qa.gemspec
 - lefthook.yml
 - lib/gitlab/qa.rb
@@ -382,6 +383,7 @@ files:
 - lib/gitlab/qa/component/production.rb
 - lib/gitlab/qa/component/release.rb
 - lib/gitlab/qa/component/saml.rb
+- lib/gitlab/qa/component/selenoid.rb
 - lib/gitlab/qa/component/specs.rb
 - lib/gitlab/qa/component/staging.rb
 - lib/gitlab/qa/component/staging_ref.rb