gitlab-qa 10.2.2 → 10.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1d4d6777aac07a8fbb1da706af278b89fa4abc6684b37a828ec8f3b8f0cd6c49
-  data.tar.gz: 2852a0396eb280993b58fcfe91f29b89565ba28c27615d12d9c04883aa2cfdac
+  metadata.gz: 2851a74117f3479437a3e355883c7a407d4f56c41aac2700028cd9686790f0ea
+  data.tar.gz: a284df28173a258c4948ead8be3c677df487c585b60cc73ffe88d5c12b6281b5
 SHA512:
-  metadata.gz: 8592539a7d61dbfd902853a53ad48310fdf216fb455be221d3d55fc27f1327919550844dade5496d003c83b54d9dfec9c4eafc7e78451b84e3d5b700c188f30c
-  data.tar.gz: cd50e445144fb5d2f70f91eb2ef3b0355f2b78c3712722746571703d7d1bcfa34f41e5462e5ddfa92bb13ae9b206662399dad78f3be8cfa7efc9cb7d42a44545
+  metadata.gz: 44a1c9743ce4fafbaad0e20f2de55598c4686598a2c3ac50d9da69565e72a477e3a0ab90f909fb32ed2b153129912b365db19ee9af91814bf6db707dc4bc70f4
+  data.tar.gz: f2d8e7accf348103ff3f7ab85467186dd11a7c51a5cdb691e3e8999716272ba54a06204257395a7594ea832c60b93d33a11fd198c57b957609599638ab3b2672

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab-qa (10.2.2)
+    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/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.2'
+    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.2
+  version: 10.3.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-18 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