gitlab-qa 7.34.0 → 8.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 917c47b2fbead3c77db3cd6c441995a8324ed73735262542dcd94de854022a35
-  data.tar.gz: 7785db11c9eb0f1f7ff2ecf32b16b8fd95ad9bab9391711f2d0af05a7e903153
+  metadata.gz: '0982270bb1256eb950e30c84028a70fca0663c744fff1bf00cb1937f89936f43'
+  data.tar.gz: c2051a27b8027df5d47359a6b27a54338e25bfc37471dae2fe600087e118b392
 SHA512:
-  metadata.gz: c509e252f4bd1e7d405d517920e306e2cdf5233cd73a5fbf25a878cbb863a7c21e5fedb007c8ef461f7e34e1899b27ff989d92182c427575a125f4c99a39de9d
-  data.tar.gz: 9011ddab65c7c0218ed49a5cbd2cdaa26f2b2ce013eb005d9ba63ee067ce18306bf8475861156ca52d7e2272cc9c94588ac86016e90e7901ecdac94d4e2f6cbf
+  metadata.gz: c11dd80b24b285fcd8b93c94c0fabac93be215576eb307804c485ad9a5dbba4a7b6cd9f6b016f13082ba4c146f8189a2e7f6bf9b41ef85172a735696e2e558af
+  data.tar.gz: 0cf57dcfa1f30e37f2acc66015ed03c0d2e3d2bd65284f7be92d71b1028fadbceb9f72feaa7a4dad29905d7554a9f985885b6d95ca096944c1a955ffa0ac244d

data/.gitlab/ci/jobs/registry_with_cdn.gitlab-ci.yml

@@ -1,4 +1,7 @@
 ce:registry_with_cdn:
+  before_script:
+    - unset GITLAB_QA_ADMIN_ACCESS_TOKEN
+    - !reference [default, before_script]
   extends:
     - .rules:ce-never-when-triggered-by-feature-flag-definition-change
     - .test
@@ -10,6 +13,9 @@ ce:registry_with_cdn:
   allow_failure: true
 
 ce:registry_with_cdn-quarantine:
+  before_script:
+    - unset GITLAB_QA_ADMIN_ACCESS_TOKEN
+    - !reference [default, before_script]
   extends:
     - .rules:ce-never-when-triggered-by-feature-flag-definition-change
     - .test
@@ -21,6 +27,9 @@ ce:registry_with_cdn-quarantine:
     QA_SCENARIO: "Test::Integration::RegistryWithCDN"
 
 ee:registry_with_cdn:
+  before_script:
+    - unset GITLAB_QA_ADMIN_ACCESS_TOKEN
+    - !reference [default, before_script]
   extends:
     - .rules:ee-never-when-triggered-by-feature-flag-definition-change
     - .test
@@ -32,6 +41,9 @@ ee:registry_with_cdn:
   allow_failure: true
 
 ee:registry_with_cdn-quarantine:
+  before_script:
+    - unset GITLAB_QA_ADMIN_ACCESS_TOKEN
+    - !reference [default, before_script]
   extends:
     - .rules:ee-never-when-triggered-by-feature-flag-definition-change
     - .test

data/.rubocop_todo.yml

@@ -1,22 +1,21 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2021-09-17 06:55:33 UTC using RuboCop version 0.93.1.
+# on 2022-06-21 18:16:41 UTC using RuboCop version 0.93.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 165
+# Offense count: 199
 # Cop supports --auto-correct.
 CodeReuse/ActiveRecord:
   Enabled: false
 
-# Offense count: 2
+# Offense count: 1
 # Cop supports --auto-correct.
 Cop/LineBreakAroundConditionalBlock:
   Exclude:
     - 'lib/gitlab/qa/release.rb'
-    - 'lib/gitlab/qa/runtime/env.rb'
 
 # Offense count: 1
 # Configuration parameters: Include.
@@ -44,10 +43,10 @@ Lint/RedundantCopDisableDirective:
     - 'lib/gitlab/qa/component/staging.rb'
     - 'lib/gitlab/qa/runtime/scenario.rb'
 
-# Offense count: 10
+# Offense count: 21
 # Configuration parameters: IgnoredMethods.
 Metrics/AbcSize:
-  Max: 26
+  Max: 60
   IgnoredMethods:
     - perform
 
@@ -58,24 +57,11 @@ Naming/RescuedExceptionsVariableName:
   Exclude:
     - 'lib/gitlab/qa/component/staging.rb'
 
-# Offense count: 1
-# Cop supports --auto-correct.
-Performance/RegexpMatch:
-  Exclude:
-    - 'lib/gitlab/qa/component/gitlab.rb'
-
-# Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: AutoCorrect.
-Performance/StringInclude:
-  Exclude:
-    - 'lib/gitlab/qa/component/gitlab.rb'
-
 # Offense count: 3
 # Cop supports --auto-correct.
 RSpec/EmptyLineAfterLetBlock:
   Exclude:
-    - 'spec/gitlab/qa/support/dev_eeqa_image_spec.rb'
+    - 'spec/gitlab/qa/support/dev_ee_qa_image_spec.rb'
 
 # Offense count: 4
 # Cop supports --auto-correct.
@@ -84,6 +70,12 @@ RSpec/ExampleWording:
   Exclude:
     - 'spec/gitlab/qa/component/gitlab_spec.rb'
 
+# Offense count: 1
+# Configuration parameters: CustomTransform, IgnoreMethods, SpecSuffixOnly.
+RSpec/FilePath:
+  Exclude:
+    - 'spec/gitlab/qa/support/dev_ee_qa_image_spec.rb'
+
 # Offense count: 2
 RSpec/LeakyConstantDeclaration:
   Exclude:
@@ -95,13 +87,6 @@ Style/ExplicitBlockArgument:
   Exclude:
     - 'lib/gitlab/qa/scenario/test/integration/ldap.rb'
 
-# Offense count: 86
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: always, always_true, never
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
 # Offense count: 1
 # Cop supports --auto-correct.
 Style/HashTransformKeys:
@@ -114,7 +99,7 @@ Style/HashTransformation:
   Exclude:
     - 'lib/gitlab/qa/docker/volumes.rb'
 
-# Offense count: 3
+# Offense count: 8
 # Cop supports --auto-correct.
 Style/IfUnlessModifier:
   Exclude:
@@ -154,9 +139,9 @@ Style/StringConcatenation:
   Exclude:
     - 'lib/gitlab/qa/reporter.rb'
 
-# Offense count: 126
+# Offense count: 191
 # Cop supports --auto-correct.
 # Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
 # URISchemes: http, https
 Layout/LineLength:
-  Max: 192
+  Max: 189

data/Dangerfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'gitlab-dangerfiles'
 
 Gitlab::Dangerfiles.for_project(self) do |dangerfiles|

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/Gemfile.lock

@@ -1,13 +1,14 @@
 PATH
   remote: .
   specs:
-    gitlab-qa (7.34.0)
+    gitlab-qa (8.0.0)
       activesupport (~> 6.1)
       gitlab (~> 4.18.0)
       http (~> 5.0)
       nokogiri (~> 1.10)
       rainbow (~> 3.0.0)
       table_print (= 1.5.7)
+      zeitwerk (~> 2.4)
 
 GEM
   remote: https://rubygems.org/
@@ -245,4 +246,4 @@ DEPENDENCIES
   webmock (= 3.7.0)
 
 BUNDLED WITH
-   2.2.33
+   2.3.9

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 require 'rubocop/rake_task'

data/docs/run_qa_against_gdk.md

@@ -120,6 +120,11 @@ This is required because chrome-webdriver makes use of `/dev/shm` shared memory.
 ~3GB but unless you allocate 5GB or more some magic numbers may not enable a bigger `/dev/shm` in the
 'host' VM that "native" docker runs on.
 
+By default, Docker runs a container with a /dev/shm shared memory space 64MB.
+This is typically too small for Chrome and will cause Chrome to crash when rendering large pages and fail the tests. 
+To fix, run the container with docker run `--shm-size=1gb` to increase the size of `/dev/shm`.
+Since Chrome 65, this is no longer necessary. Instead, launch the browser with the `CHROME_DISABLE_DEV_SHM=true`.
+
 Please note that while it's possible to run multi-node tests like Geo Primary and Secondary, you can't
 access the machines from your host machine, as they are all exposed as `0.0.0.0:port`, and because
 of that they don't match the configured VHOSTs in your GitLab installation, so the redirect login

data/exe/gitlab-qa

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 lib = File.expand_path('../lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)

data/exe/gitlab-qa-report

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 lib = File.expand_path('../lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)

data/gitlab-qa.gemspec

@@ -34,4 +34,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'nokogiri', '~> 1.10'
   spec.add_runtime_dependency 'rainbow', '~> 3.0.0'
   spec.add_runtime_dependency 'table_print', '1.5.7'
+  spec.add_runtime_dependency 'zeitwerk', '~> 2.4'
 end

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

@@ -155,7 +155,9 @@ module Gitlab
           rescue Docker::Shellout::StatusError => e
             # for scenarios where a service fails during startup, attempt to retry to avoid flaky failures
             if (retries += 1) < 3
-              puts "Retry instance_no_teardown due to Docker::Shellout::StatusError -- attempt #{retries}"
+              Runtime::Logger.warn(
+                "Retry instance_no_teardown due to Docker::Shellout::StatusError -- attempt #{retries}"
+              )
               teardown!
               retry
             end

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

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Gitlab
   module QA
     module Component
       class Elasticsearch < Base
-        DOCKER_IMAGE = 'docker.elastic.co/elasticsearch/elasticsearch'.freeze
+        DOCKER_IMAGE = 'docker.elastic.co/elasticsearch/elasticsearch'
 
         def name
           @name ||= "elastic68"

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

@@ -13,6 +13,7 @@ module Gitlab
     module Component
       class Gitlab < Base
         extend Forwardable
+        using Rainbow
 
         attr_reader :release, :omnibus_configuration, :omnibus_gitlab_rails_env
         attr_accessor :tls, :skip_availability_check, :runner_network, :seed_admin_token, :seed_db
@@ -121,8 +122,9 @@ module Gitlab
         def prepare_gitlab_omnibus_config
           set_formless_login_token
           set_license_mode
+          return if omnibus_gitlab_rails_env.empty?
 
-          @omnibus_configuration << "gitlab_rails['env'] = #{@omnibus_gitlab_rails_env}" unless omnibus_gitlab_rails_env.empty?
+          @omnibus_configuration << "gitlab_rails['env'] = #{@omnibus_gitlab_rails_env}"
         end
 
         def start # rubocop:disable Metrics/AbcSize
@@ -148,7 +150,12 @@ module Gitlab
               command << "--network-alias #{network_alias}"
             end
           end
-          Docker::Command.execute("network connect --alias #{name}.#{network} --alias #{name}.#{runner_network} #{runner_network} #{name}") if runner_network
+
+          return unless runner_network
+
+          Docker::Command.execute(
+            "network connect --alias #{name}.#{network} --alias #{name}.#{runner_network} #{runner_network} #{name}"
+          )
         end
 
         def reconfigure
@@ -163,10 +170,19 @@ module Gitlab
         def wait_until_ready
           return if skip_availability_check
 
-          if Availability.new(name, relative_path: relative_path, scheme: scheme, protocol_port: port.to_i).check(Runtime::Env.gitlab_availability_timeout)
-            puts ' -> GitLab is available.'
+          availability = Availability.new(
+            name,
+            relative_path: relative_path,
+            scheme: scheme,
+            protocol_port: port.to_i
+          )
+
+          Runtime::Logger.info("Waiting for GitLab to become healthy ...")
+
+          if availability.check(Runtime::Env.gitlab_availability_timeout)
+            Runtime::Logger.info("-> GitLab is available at `#{availability.uri}`!".bright)
           else
-            abort ' -> GitLab unavailable!'
+            abort '-> GitLab unavailable!'.red
           end
         end
 
@@ -260,7 +276,10 @@ module Gitlab
           [
             @docker.exec(name, 'mkdir -p /opt/gitlab/embedded/service/gitlab-shell/hooks/pre-receive.d'),
             @docker.write_files(name) do |f|
-              f.write('/opt/gitlab/embedded/service/gitlab-shell/hooks/pre-receive.d/pre-receive.d', global_server_prereceive_hook, false)
+              f.write(
+                '/opt/gitlab/embedded/service/gitlab-shell/hooks/pre-receive.d/pre-receive.d',
+                global_server_prereceive_hook, false
+              )
             end,
             @docker.exec(name, 'chmod +x /opt/gitlab/embedded/service/gitlab-shell/hooks/pre-receive.d/*')
           ]
@@ -270,42 +289,41 @@ module Gitlab
           def initialize(name, relative_path: '', scheme: 'http', protocol_port: 80)
             @docker = Docker::Engine.new
 
-            host = @docker.hostname
-            port = @docker.port(name, protocol_port).split(':').last
-
-            @uri = URI.join("#{scheme}://#{host}:#{port}", "#{relative_path}/", 'help')
+            @name = name
+            @scheme = scheme
+            @relative_path = relative_path
+            @protocol_port = protocol_port
           end
 
           def check(retries)
-            print "Waiting for GitLab at `#{@uri}` to become available "
-
             retries.times do
               return true if service_available?
 
-              print '.'
               sleep 1
             end
 
             false
           end
 
+          def uri
+            @uri ||= begin
+              port = docker.port(name, protocol_port).split(':').last
+
+              URI.join("#{scheme}://#{docker.hostname}:#{port}", relative_path)
+            end
+          end
+
           private
 
+          attr_reader :docker, :name, :relative_path, :scheme, :protocol_port
+
           def service_available?
-            response = Net::HTTP.start(@uri.host, @uri.port, opts) do |http|
-              http.head2(@uri.request_uri)
-            end
+            output = docker.inspect(name) { |command| command << "--format='{{json .State.Health.Status}}'" }
 
-            print response.code
-            response.code.to_i == 200
-          rescue Errno::ECONNREFUSED, Errno::ECONNRESET, EOFError => e
-            print e.message
+            output == '"healthy"'
+          rescue Docker::Shellout::StatusError
             false
           end
-
-          def opts
-            @uri.scheme == 'https' ? { use_ssl: true, verify_mode: OpenSSL::SSL::VERIFY_NONE } : {}
-          end
         end
       end
     end

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

@@ -1,11 +1,13 @@
+# frozen_string_literal: true
+
 require 'tempfile'
 
 module Gitlab
   module QA
     module Component
       class InternetTunnel < Base
-        DOCKER_IMAGE = 'gitlab/ssh-tunnel'.freeze
-        DOCKER_IMAGE_TAG = '1.0.0'.freeze
+        DOCKER_IMAGE = 'gitlab/ssh-tunnel'
+        DOCKER_IMAGE_TAG = '1.0.0'
 
         attr_writer :gitlab_hostname
 

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

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Gitlab
   module QA
     module Component
       class Jira < Base
-        DOCKER_IMAGE = 'registry.gitlab.com/gitlab-org/gitlab-qa/jira-gitlab'.freeze
-        DOCKER_IMAGE_TAG = '8.8-project-and-issue'.freeze
+        DOCKER_IMAGE = 'registry.gitlab.com/gitlab-org/gitlab-qa/jira-gitlab'
+        DOCKER_IMAGE_TAG = '8.8-project-and-issue'
 
         def name
           @name ||= "jira"

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

@@ -1,3 +1,4 @@
+# frozen_string_literal: true
 # This component sets up the MailHog (https://github.com/mailhog/MailHog)
 # image with the proper configuration for SMTP email delivery from Gitlab
 
@@ -5,8 +6,8 @@ module Gitlab
   module QA
     module Component
       class MailHog < Base
-        DOCKER_IMAGE = 'mailhog/mailhog'.freeze
-        DOCKER_IMAGE_TAG = 'v1.0.0'.freeze
+        DOCKER_IMAGE = 'mailhog/mailhog'
+        DOCKER_IMAGE_TAG = 'v1.0.0'
 
         def name
           @name ||= "mailhog"

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'securerandom'
 require 'fileutils'
 require 'yaml'
@@ -8,12 +10,12 @@ module Gitlab
   module QA
     module Component
       class Minio < Base
-        DOCKER_IMAGE = 'minio/minio'.freeze
-        DOCKER_IMAGE_TAG = 'latest'.freeze
+        DOCKER_IMAGE = 'minio/minio'
+        DOCKER_IMAGE_TAG = 'latest'
         # These are secrets used in a local Minio container, they're not used for any online S3 server.
-        AWS_ACCESS_KEY = 'AKIAIOSFODNN7EXAMPLE'.freeze
-        AWS_SECRET_KEY = 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY'.freeze
-        DATA_DIR = '/data'.freeze
+        AWS_ACCESS_KEY = 'AKIAIOSFODNN7EXAMPLE'
+        AWS_SECRET_KEY = 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY'
+        DATA_DIR = '/data'
         DEFAULT_PORT = 9000
 
         def initialize

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

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Gitlab
   module QA
     module Component
       class PostgreSQL < Base
-        DOCKER_IMAGE = 'postgres'.freeze
-        DOCKER_IMAGE_TAG = '11'.freeze
+        DOCKER_IMAGE = 'postgres'
+        DOCKER_IMAGE_TAG = '11'
 
         def name
           @name ||= "postgres"

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

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Gitlab
   module QA
     module Component
       class Preprod < Staging
-        ADDRESS = 'https://pre.gitlab.com'.freeze
+        ADDRESS = 'https://pre.gitlab.com'
       end
     end
   end

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

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Gitlab
   module QA
     module Component
       class Production < Staging
-        ADDRESS = 'https://gitlab.com'.freeze
+        ADDRESS = 'https://gitlab.com'
       end
     end
   end

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

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 module Gitlab
   module QA
     module Component
       class Release < Staging
-        ADDRESS = 'https://release.gitlab.net'.freeze
+        ADDRESS = 'https://release.gitlab.net'
       end
     end
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'securerandom'
 
 # This component sets up the docker-test-saml-idp (https://github.com/kristophjunge/docker-test-saml-idp)
@@ -7,8 +9,8 @@ module Gitlab
   module QA
     module Component
       class SAML < Base
-        DOCKER_IMAGE = 'jamedjo/test-saml-idp'.freeze
-        DOCKER_IMAGE_TAG = 'latest'.freeze
+        DOCKER_IMAGE = 'jamedjo/test-saml-idp'
+        DOCKER_IMAGE_TAG = 'latest'
 
         def set_entity_id(entity_id)
           @environment['SIMPLESAMLPHP_SP_ENTITY_ID'] = entity_id

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'securerandom'
 
 module Gitlab

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'net/http'
 require 'json'
 require 'uri'
@@ -6,8 +8,8 @@ module Gitlab
   module QA
     module Component
       class Staging
-        ADDRESS = 'https://staging.gitlab.com'.freeze
-        GEO_SECONDARY_ADDRESS = 'https://geo.staging.gitlab.com'.freeze
+        ADDRESS = 'https://staging.gitlab.com'
+        GEO_SECONDARY_ADDRESS = 'https://geo.staging.gitlab.com'
 
         def self.release
           QA::Release.new(image)

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

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 module Gitlab
   module QA
     module Component
       class StagingRef < Staging
-        ADDRESS = 'https://staging-ref.gitlab.com'.freeze
-        GEO_SECONDARY_ADDRESS = 'https://geo.staging-ref.gitlab.com'.freeze
+        ADDRESS = 'https://staging-ref.gitlab.com'
+        GEO_SECONDARY_ADDRESS = 'https://geo.staging-ref.gitlab.com'
       end
     end
   end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module QA
     module Docker
@@ -43,7 +45,7 @@ module Gitlab
         #
         # @return [String] The masked command string
         def mask_secrets
-          @mask_secrets.each_with_object(to_s) { |secret, s| s.gsub!(secret, '*****') }
+          @mask_secrets.each_with_object(+to_s) { |secret, s| s.gsub!(secret, '*****') }
         end
 
         def ==(other)
@@ -52,6 +54,10 @@ module Gitlab
 
         def execute!(&block)
           Docker::Shellout.new(self).execute!(&block)
+        rescue Docker::Shellout::StatusError => e
+          e.set_backtrace([])
+
+          raise e
         end
 
         def self.execute(cmd, mask_secrets: nil, &block)

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

@@ -142,6 +142,16 @@ module Gitlab
           Docker::Command.execute(['ps', name].compact.join(' '))
         end
 
+        def inspect(name)
+          Docker::Command.new('inspect').then do |command|
+            yield command if block_given?
+
+            command << name
+
+            command.execute!
+          end
+        end
+
         private
 
         def full_image_name(image, tag)