gitlab-qa 7.17.0 → 7.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b5445d22b9e7e579cf2e2a9f545a956169f65e8b23fc5ef9e8d7e3e264af01c
-  data.tar.gz: 07b26a574d5b1ce71821a9ce2ec518ce7c350f9a7eb31802cb55cd24fce36010
+  metadata.gz: 7314a9036c9aeacae478aaf82d13baee97c53c94bf5aabe800ec0e9f98b5234d
+  data.tar.gz: 83fe883428323a6edc87c1993564de31dcd5afc79aada90798ea07d93a1b09fb
 SHA512:
-  metadata.gz: b0f09f5a5bad616dec344a44599b3b50bbfc3efe03ca197e0ad67daed0d365f7681b6a62c1697b4ab34bbd66992bd6b9149c875fddada2ee678a1c38da936580
-  data.tar.gz: 0eb8adba19d135389ea8c888472d55726339c76f430f667e9f6236e77f7239de283288c2284870365ca2b68a7aa2cf58957164cf17e8976344988f55fa2860b9
+  metadata.gz: 7e3d05561762175dae31c8298ef4411595287f516f3fc809457e842c368a7ea712c6c2f697a1c1849c1ff26b060b68220327e5d3cb5e5792426bb886881a233a
+  data.tar.gz: 062b24dfdf48a7da1d309b0282f4972d1f6e72dbb2ad4a44f2ad8c2c352f3684ff0b423390070dcc83c9228b19597bc0ddfee94aef017810f5283c673511e472

data/.gitlab-ci.yml

@@ -77,7 +77,7 @@ rspec:
     when: always
     expire_in: 10d
     paths:
-      - ./gitlab-qa-run-*
+      - gitlab-qa-run-*
     reports:
       junit: gitlab-qa-run-*/**/rspec-*.xml
   script:
@@ -125,12 +125,6 @@ rspec:
     - 7gb
     - triggered-packages
 
-.knapsack-variables:
-  variables:
-    KNAPSACK_REPORT_PATH: "knapsack/master_report.json"
-    KNAPSACK_TEST_FILE_PATTERN: "qa/specs/features/**/*_spec.rb"
-    KNAPSACK_GENERATE_REPORT: "true"
-
 .rspec-report-opts:
   variables:
     FILE_SAFE_JOB_NAME: $(echo $CI_JOB_NAME | sed 's/[ /]/_/g')
@@ -174,7 +168,6 @@ ce:custom-parallel:
     - .rspec-report-opts
     - .no-issue-report-script
     - .ce-variables
-
   allow_failure: true
   parallel: 10
 
@@ -195,7 +188,6 @@ ce:instance-parallel:
     - .test
     - .high-capacity
     - .ce-variables
-    - .knapsack-variables
     - .rspec-report-opts
   parallel: 5
 
@@ -224,7 +216,6 @@ ee:instance-parallel:
     - .test
     - .high-capacity
     - .ee-variables
-    - .knapsack-variables
     - .rspec-report-opts
   parallel: 5
 
@@ -253,7 +244,6 @@ ce:relative_url-parallel:
     - .test
     - .high-capacity
     - .ce-variables
-    - .knapsack-variables
     - .rspec-report-opts
   parallel: 5
   variables:
@@ -287,7 +277,6 @@ ee:relative_url-parallel:
     - .test
     - .high-capacity
     - .ee-variables
-    - .knapsack-variables
     - .rspec-report-opts
   parallel: 5
   variables:
@@ -381,7 +370,6 @@ ce:update-parallel:
     - .high-capacity
     - .ce-variables
     - .rspec-report-opts
-    - .knapsack-variables
     - .update-scenario-script
   parallel: 5
 
@@ -413,7 +401,6 @@ ee:update-parallel:
     - .high-capacity
     - .ee-variables
     - .rspec-report-opts
-    - .knapsack-variables
     - .update-scenario-script
   parallel: 10
 
@@ -446,7 +433,6 @@ ce:upgrade-parallel:
     - .test
     - .high-capacity
     - .rspec-report-opts
-    - .knapsack-variables
   parallel: 5
 
 ce:upgrade:
@@ -549,7 +535,7 @@ ee:service_ping_disabled:
   variables:
     QA_SCENARIO: "Test::Integration::ServicePingDisabled"
 
-# Disabling geo jobs temporarily due to https://gitlab.com/gitlab-org/gitlab/-/issues/273063
+# Disabling geo jobs temporarily due to https://gitlab.com/gitlab-org/quality/team-tasks/-/issues/774
 # ee:geo:
 #   extends:
 #     - .test
@@ -1011,7 +997,6 @@ ce:praefect-parallel:
     - .test
     - .high-capacity
     - .ce-variables
-    - .knapsack-variables
     - .rspec-report-opts
   parallel: 5
   variables:
@@ -1048,7 +1033,6 @@ ee:praefect-parallel:
     - .test
     - .high-capacity
     - .ee-variables
-    - .knapsack-variables
     - .rspec-report-opts
   parallel: 10
   variables:
@@ -1225,6 +1209,33 @@ ee:large-setup:
   variables:
     QA_RSPEC_TAGS: "--tag can_use_large_setup"
 
+ee:cloud-activation:
+  before_script:
+    - unset EE_LICENSE
+    - !reference [default, before_script]
+  extends:
+    - .rules:ee-never-when-triggered-by-feature-flag-definition-change
+    - .test
+    - .high-capacity
+    - .ee-variables
+    - .rspec-report-opts
+  variables:
+    QA_RSPEC_TAGS: "--tag cloud_activation"
+
+ee:cloud-activation-quarantine:
+  before_script:
+    - unset EE_LICENSE
+    - !reference [default, before_script]
+  extends:
+    - .rules:ee-never-when-triggered-by-feature-flag-definition-change
+    - .test
+    - .high-capacity
+    - .ee-variables
+    - .quarantine
+    - .rspec-report-opts
+  variables:
+    QA_RSPEC_TAGS: "--tag cloud_activation"
+
 # This job requires the `GITLAB_QA_ACCESS_TOKEN` and `GITLAB_QA_DEV_ACCESS_TOKEN`
 # variable to be passed when triggered.
 staging:
@@ -1348,9 +1359,17 @@ generate-allure-report:
     - if: '$TOP_UPSTREAM_SOURCE_PROJECT && $TOP_UPSTREAM_SOURCE_SHA'
       when: always
 
+generate-knapsack-report:
+  extends: .generate-knapsack-report-base
+  image:
+    name: ${QA_IMAGE}
+  stage: report
+
 include:
   - local: .gitlab/ci/*.gitlab-ci.yml
   - project: 'gitlab-org/quality/pipeline-common'
     file: '/ci/gem-release.yml'
   - project: 'gitlab-org/quality/pipeline-common'
     file: '/ci/allure-report.yml'
+  - project: 'gitlab-org/quality/pipeline-common'
+    file: '/ci/knapsack-report.yml'

data/docs/what_tests_can_be_run.md

@@ -59,6 +59,7 @@ All environment variables used by GitLab QA should be defined in [`lib/gitlab/qa
 | `GITLAB_QA_ADMIN_ACCESS_TOKEN` |-  | A valid personal access token with the `api` scope from a user with admin access. Used for API access as an admin during tests. | No|
 | `GITLAB_QA_CONTAINER_REGISTRY_ACCESS_TOKEN` | - | A valid personal access token with the `read_registry` scope. Used to [access the container registry on `registry.gitlab.com` when tests run in a CI job that _is not_ triggered via another pipeline](https://gitlab.com/gitlab-org/gitlab-qa/-/blob/364addb83e7b136ff0f9d8719ca9553d290aa9ab/lib/gitlab/qa/release.rb#L152). For example, if you manually run a [new Staging pipeline](https://ops.gitlab.net/gitlab-org/quality/staging/-/pipelines/new), this token will be used. | No |
 | `EE_LICENSE` |-  | Enterprise Edition license. | No|
+| `QA_EE_ACTIVATION_CODE` |-  | Cloud activation code to enable Enterprise Edition features. | No|
 | `QA_ARTIFACTS_DIR` |`/tmp/gitlab-qa`| Path to a directory where artifacts (logs and screenshots) for failing tests will be saved. | No|
 | `DOCKER_HOST` |`http://localhost`| Docker host to run tests against. | No|
 | `WEBDRIVER_HEADLESS` |-  | When running locally, set to `false` to allow Chrome tests to be visible - watch your tests being run. | No|
@@ -703,6 +704,9 @@ in the GitLab project).
 
 **Required environment variables:**
 
+- `GITLAB_QA_USER_AGENT`: The browser user-agent to use instead of the default Chrome user-agent.
+  This is needed for the automated tests to bypass the WAF
+
 - `GITLAB_QA_ACCESS_TOKEN`: A valid personal access token with the `api` scope.
   This is used to retrieve the version that staging is currently running.
   This can be found in the shared 1Password vault.
@@ -718,6 +722,7 @@ in the GitLab project).
 Example:
 
 ```
+$ export GITLAB_QA_USER_AGENT="$GITLAB_QA_USER_AGENT"
 $ export GITLAB_QA_ACCESS_TOKEN=your_api_access_token
 $ export GITLAB_QA_DEV_ACCESS_TOKEN=your_dev_registry_access_token
 $ export GITLAB_USERNAME="gitlab-qa"

data/gitlab-qa.gemspec

@@ -28,8 +28,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'solargraph', '~> 0.41'
   spec.add_development_dependency 'webmock', '3.7.0'
   spec.add_runtime_dependency 'activesupport', '~> 6.1'
-  spec.add_runtime_dependency 'gitlab', '~> 4.16.1'
+  spec.add_runtime_dependency 'gitlab', '~> 4.18.0'
   spec.add_runtime_dependency 'http', '~> 5.0'
   spec.add_runtime_dependency 'nokogiri', '~> 1.10'
+  spec.add_runtime_dependency 'rainbow', '~> 3.0.0'
   spec.add_runtime_dependency 'table_print', '1.5.7'
 end

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

@@ -108,7 +108,7 @@ module Gitlab
 
         def teardown
           unless teardown?
-            puts "The orchestrated docker containers have not been removed."
+            Runtime::Logger.info("The orchestrated docker containers have not been removed.")
             docker.ps
 
             return

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

@@ -12,7 +12,7 @@ module Gitlab
       class Gitlab < Base
         extend Forwardable
 
-        attr_reader :release, :omnibus_configuration
+        attr_reader :release, :omnibus_configuration, :omnibus_gitlab_rails_env
         attr_accessor :tls, :skip_availability_check, :runner_network
         attr_writer :name, :relative_path
 
@@ -29,6 +29,7 @@ module Gitlab
           super
 
           @skip_availability_check = false
+          @omnibus_gitlab_rails_env = {}
 
           @volumes[GITLAB_CERTIFICATES_PATH] = SSL_PATH
           @volumes[AUTHORITY_CERTIFICATES_PATH] = TRUSTED_PATH
@@ -41,7 +42,14 @@ module Gitlab
         def set_formless_login_token
           return if Runtime::Env.gitlab_qa_formless_login_token.to_s.strip.empty?
 
-          @omnibus_configuration << "gitlab_rails['env'] = { 'GITLAB_QA_FORMLESS_LOGIN_TOKEN' => '#{Runtime::Env.gitlab_qa_formless_login_token}' }"
+          @omnibus_gitlab_rails_env['GITLAB_QA_FORMLESS_LOGIN_TOKEN'] = Runtime::Env.gitlab_qa_formless_login_token
+        end
+
+        def set_license_mode
+          return unless Runtime::Env.test_license_mode?
+
+          @omnibus_gitlab_rails_env['GITLAB_LICENSE_MODE'] = 'test'
+          @omnibus_gitlab_rails_env['CUSTOMER_PORTAL_URL'] = 'https://customers.staging.gitlab.com'
         end
 
         def elastic_url=(url)
@@ -95,6 +103,9 @@ module Gitlab
 
         def prepare_gitlab_omnibus_config
           set_formless_login_token
+          set_license_mode
+
+          @omnibus_configuration << "gitlab_rails['env'] = #{@omnibus_gitlab_rails_env}" unless omnibus_gitlab_rails_env.empty?
         end
 
         def start # rubocop:disable Metrics/AbcSize

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

@@ -62,7 +62,7 @@ module Gitlab
           FileUtils.mkdir_p(host_data_dir)
 
           @buckets.each do |bucket|
-            puts "Creating Minio bucket: #{bucket}"
+            Runtime::Logger.info("Creating Minio bucket: #{bucket}")
             FileUtils.mkdir_p(File.join(host_data_dir, bucket))
           end
         end

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

@@ -8,7 +8,7 @@ module Gitlab
       # the `qa/` directory located in GitLab CE / EE repositories.
       #
       class Specs < Scenario::Template
-        attr_accessor :suite, :release, :network, :args, :volumes, :env, :runner_network
+        attr_accessor :suite, :release, :network, :args, :volumes, :env, :runner_network, :hostname
 
         def initialize
           @docker = Docker::Engine.new
@@ -17,7 +17,7 @@ module Gitlab
         end
 
         def perform
-          return puts "Skipping tests." if skip_tests?
+          return Runtime::Logger.info("Skipping tests.") if skip_tests?
 
           raise ArgumentError unless [suite, release].all?
 
@@ -25,7 +25,7 @@ module Gitlab
 
           @docker.pull(image: qa_image) unless Runtime::Env.skip_pull?
 
-          puts "Running test suite `#{suite}` for #{release.project_name}"
+          Runtime::Logger.info("Running test suite `#{suite}` for #{release.project_name}")
 
           name = "#{release.project_name}-qa-#{SecureRandom.hex(4)}"
 
@@ -45,6 +45,11 @@ module Gitlab
             @docker.run(image: qa_image, args: [suite, *args_with_flags(args, feature_flag_set)]) do |command|
               command << "-t --rm --net=#{network || 'bridge'}"
 
+              unless hostname.nil?
+                command << "--hostname #{hostname}"
+                command.env('QA_HOSTNAME', hostname)
+              end
+
               env.merge(Runtime::Env.variables).each do |key, value|
                 command.env(key, value)
               end
@@ -66,7 +71,7 @@ module Gitlab
         def args_with_flags(args, feature_flag_set)
           return args if feature_flag_set.empty?
 
-          puts "Running with feature flag: #{feature_flag_set.join(' ')}"
+          Runtime::Logger.info("Running with feature flag: #{feature_flag_set.join(' ')}")
 
           args_with_f = args.dup
           args_with_f.insert(1, *feature_flag_set)

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

@@ -1,16 +1,19 @@
 require 'open3'
+require 'rainbow/refinement'
 
 module Gitlab
   module QA
     module Docker
       class Shellout
+        using Rainbow
         StatusError = Class.new(StandardError)
 
         def initialize(command)
           @command = command
           @output = []
 
-          puts "Docker shell command: `#{@command.mask_secrets}`"
+          Rainbow.enabled = Runtime::Env.colorized_logs?
+          Runtime::Logger.info("Docker shell command: `#{@command.mask_secrets}`".cyan)
         end
 
         def execute! # rubocop:disable Metrics/AbcSize
@@ -28,7 +31,7 @@ module Gitlab
             end
 
             if wait.value.exited? && wait.value.exitstatus.nonzero? # rubocop:disable Style/IfUnlessModifier
-              raise StatusError, "Docker command `#{@command.mask_secrets}` failed!"
+              raise StatusError, "Docker command `#{@command.mask_secrets}` failed! ✘"
             end
           end
 

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

@@ -1,10 +1,13 @@
+require 'active_support/core_ext/object/blank'
 require 'securerandom'
+require 'rainbow/refinement'
 
 module Gitlab
   module QA
     module Runtime
       module Env
         extend self
+        using Rainbow
 
         # Variables that are used in tests and are passed through to the docker container that executes the tests.
         # These variables should be listed in /docs/what_tests_can_be_run.md#supported-gitlab-environment-variables
@@ -33,6 +36,7 @@ module Gitlab
           'QA_SLOW_CONNECTION_LATENCY_MS' => :qa_slow_connection_latency_ms,
           'QA_SLOW_CONNECTION_THROUGHPUT_KBPS' => :qa_slow_connection_throughput_kbps,
           'QA_GENERATE_ALLURE_REPORT' => :generate_allure_report,
+          'QA_EE_ACTIVATION_CODE' => :ee_activation_code,
           'QA_EXPORT_TEST_METRICS' => :qa_export_test_metrics,
           'QA_INFLUXDB_URL' => :qa_influxdb_url,
           'QA_INFLUXDB_TOKEN' => :qa_influxdb_token,
@@ -76,6 +80,7 @@ module Gitlab
           'KNAPSACK_REPORT_PATH' => :knapsack_report_path,
           'KNAPSACK_TEST_FILE_PATTERN' => :knapsack_test_file_pattern,
           'KNAPSACK_TEST_DIR' => :knapsack_test_dir,
+          'QA_KNAPSACK_REPORT_GCS_CREDENTIALS' => :qa_knapsack_report_gcs_credentials,
           'CI' => :ci,
           'CI_COMMIT_REF_NAME' => :ci_commit_ref_name,
           'CI_JOB_NAME' => :ci_job_name,
@@ -124,14 +129,15 @@ module Gitlab
           'GCS_BUCKET_NAME' => :gcs_bucket_name,
           'SMOKE_ONLY' => :smoke_only,
           'NO_ADMIN' => :no_admin,
-          'CHROME_DISABLE_DEV_SHM' => :chrome_disable_dev_shm
+          'CHROME_DISABLE_DEV_SHM' => :chrome_disable_dev_shm,
+          'COLORIZED_LOGS' => :colorized_logs
         }.freeze
 
         ENV_VARIABLES.each do |env_name, method_name|
           attr_writer(method_name)
 
           define_method(method_name) do
-            ENV[env_name] || (instance_variable_get("@#{method_name}") if instance_variable_defined?("@#{method_name}"))
+            env_var_value_if_defined(env_name) || (instance_variable_get("@#{method_name}") if instance_variable_defined?("@#{method_name}"))
           end
         end
 
@@ -141,36 +147,40 @@ module Gitlab
           ENV_VARIABLES.each do |name, attribute|
             # Variables that are overridden in the environment take precedence
             # over the defaults specified by the QA runtime.
-            value = env_value_if_defined(name) || send(attribute) # rubocop:disable GitlabSecurity/PublicSend
+            value = env_var_name_if_defined(name) || send(attribute) # rubocop:disable GitlabSecurity/PublicSend
             vars[name] = value if value
           end
 
           vars
         end
 
+        def debug?
+          enabled?(ENV['QA_DEBUG'], default: true)
+        end
+
         def default_branch
-          ENV['QA_DEFAULT_BRANCH'] || 'main'
+          env_var_value_if_defined('QA_DEFAULT_BRANCH') || 'main'
         end
 
         def gitlab_availability_timeout
-          ENV.fetch('GITLAB_QA_AVAILABILITY_TIMEOUT', 360).to_i
+          (env_var_value_if_defined('GITLAB_QA_AVAILABILITY_TIMEOUT') || 360).to_i
         end
 
         def gitlab_username
-          ENV['GITLAB_USERNAME'] || 'gitlab-qa'
+          env_var_value_if_defined('GITLAB_USERNAME') || 'gitlab-qa'
         end
 
         def gitlab_dev_username
-          ENV['GITLAB_DEV_USERNAME'] || 'gitlab-qa-bot'
+          env_var_value_if_defined('GITLAB_DEV_USERNAME') || 'gitlab-qa-bot'
         end
 
         def gitlab_api_base
-          ENV['GITLAB_API_BASE'] || 'https://gitlab.com/api/v4'
+          env_var_value_if_defined('GITLAB_API_BASE') || 'https://gitlab.com/api/v4'
         end
 
         def pipeline_from_project_name
           if ci_project_name.to_s.start_with?('gitlab-qa')
-            if ENV['TOP_UPSTREAM_SOURCE_JOB'].to_s.start_with?('https://ops.gitlab.net')
+            if env_var_value_if_defined('TOP_UPSTREAM_SOURCE_JOB').to_s.start_with?('https://ops.gitlab.net')
               'staging-orchestrated'
             else
               QA::Runtime::Env.default_branch
@@ -184,24 +194,28 @@ module Gitlab
           @run_id ||= "gitlab-qa-run-#{Time.now.strftime('%Y-%m-%d-%H-%M-%S')}-#{SecureRandom.hex(4)}"
         end
 
+        def colorized_logs?
+          enabled?(ENV['COLORIZED_LOGS'], default: false)
+        end
+
         def dev_access_token_variable
-          env_value_if_defined('GITLAB_QA_DEV_ACCESS_TOKEN')
+          env_var_name_if_defined('GITLAB_QA_DEV_ACCESS_TOKEN')
         end
 
         def initial_root_password
-          ENV['GITLAB_INITIAL_ROOT_PASSWORD'] || '5iveL!fe'
+          env_var_value_if_defined('GITLAB_INITIAL_ROOT_PASSWORD') || '5iveL!fe'
         end
 
         def deploy_environment
-          ENV['DEPLOY_ENVIRONMENT'] || pipeline_from_project_name
+          env_var_value_if_defined('DEPLOY_ENVIRONMENT') || pipeline_from_project_name
         end
 
         def host_artifacts_dir
-          @host_artifacts_dir ||= File.join(ENV['QA_ARTIFACTS_DIR'] || '/tmp/gitlab-qa', Runtime::Env.run_id)
+          @host_artifacts_dir ||= File.join(env_var_value_if_defined('QA_ARTIFACTS_DIR') || '/tmp/gitlab-qa', Runtime::Env.run_id)
         end
 
         def elastic_version
-          ENV['ELASTIC_VERSION'] || '6.4.2'.freeze
+          env_var_value_if_defined('ELASTIC_VERSION') || '6.4.2'.freeze
         end
 
         def require_license!
@@ -217,25 +231,25 @@ module Gitlab
         end
 
         def require_qa_access_token!
-          return unless ENV['GITLAB_QA_ACCESS_TOKEN'].to_s.strip.empty?
+          return unless env_var_value_if_defined('GITLAB_QA_ACCESS_TOKEN').to_s.strip.empty?
 
           raise ArgumentError, "Please provide GITLAB_QA_ACCESS_TOKEN"
         end
 
         def require_qa_dev_access_token!
-          return unless ENV['GITLAB_QA_DEV_ACCESS_TOKEN'].to_s.strip.empty?
+          return unless env_var_value_if_defined('GITLAB_QA_DEV_ACCESS_TOKEN').to_s.strip.empty?
 
           raise ArgumentError, "Please provide GITLAB_QA_DEV_ACCESS_TOKEN"
         end
 
         def require_slack_qa_channel!
-          return unless ENV['SLACK_QA_CHANNEL'].to_s.strip.empty?
+          return unless env_var_value_if_defined('SLACK_QA_CHANNEL').to_s.strip.empty?
 
           raise ArgumentError, "Please provide SLACK_QA_CHANNEL"
         end
 
         def require_ci_slack_webhook_url!
-          return unless ENV['CI_SLACK_WEBHOOK_URL'].to_s.strip.empty?
+          return unless env_var_value_if_defined('CI_SLACK_WEBHOOK_URL').to_s.strip.empty?
 
           raise ArgumentError, "Please provide CI_SLACK_WEBHOOK_URL"
         end
@@ -265,7 +279,7 @@ module Gitlab
         end
 
         def require_initial_password!
-          return unless ENV['GITLAB_INITIAL_ROOT_PASSWORD'].to_s.strip.empty?
+          return unless env_var_value_if_defined('GITLAB_INITIAL_ROOT_PASSWORD').to_s.strip.empty?
 
           raise(
             ArgumentError,
@@ -289,11 +303,15 @@ module Gitlab
         end
 
         def skip_pull?
-          enabled?(ENV['QA_SKIP_PULL'], default: false)
+          enabled?(env_var_value_if_defined('QA_SKIP_PULL'), default: false)
         end
 
         def geo_failover?
-          enabled?(ENV['GEO_FAILOVER'], default: false)
+          enabled?(env_var_value_if_defined('GEO_FAILOVER'), default: false)
+        end
+
+        def test_license_mode?
+          enabled?(env_var_value_if_defined('TEST_LICENSE_MODE'), default: false)
         end
 
         private
@@ -304,9 +322,17 @@ module Gitlab
           (value =~ /^(false|no|0)$/i) != 0
         end
 
-        def env_value_if_defined(variable)
-          # Pass through the variables if they are defined in the environment
-          return "$#{variable}" if ENV[variable]
+        def env_var_value_valid?(variable)
+          !ENV[variable].blank?
+        end
+
+        def env_var_value_if_defined(variable)
+          return ENV[variable] if env_var_value_valid?(variable)
+        end
+
+        def env_var_name_if_defined(variable)
+          # Pass through the variables if they are defined and not empty in the environment
+          return "$#{variable}" if env_var_value_valid?(variable)
         end
       end
     end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'logger'
+require 'forwardable'
+require'rainbow/refinement'
+
+module Gitlab
+  module QA
+    module Runtime
+      module Logger
+        extend SingleForwardable
+        using Rainbow
+
+        def_delegators :logger, :debug, :info, :warn, :error, :fatal, :unknown
+
+        singleton_class.module_eval do
+          attr_writer :logger
+
+          def logger
+            Rainbow.enabled = Runtime::Env.colorized_logs?
+
+            @logger ||= ::Logger.new($stdout).tap do |logger|
+              logger.level = Runtime::Env.debug? ? ::Logger::DEBUG : ::Logger::INFO
+
+              logger.formatter = proc do |severity, datetime, progname, msg|
+                date_format = datetime.strftime("%Y-%m-%d %H:%M:%S")
+
+                "[date=#{date_format} from=GitLab QA] #{severity.ljust(5)}-- ".yellow + "#{msg}\n"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/qa/scenario/test/instance/image.rb

@@ -19,6 +19,7 @@ module Gitlab
                 gitlab.instance do
                   Component::Specs.perform do |specs|
                     specs.suite = 'Test::Instance::All'
+                    specs.hostname = "qa-e2e-specs.#{gitlab.network}"
                     specs.release = gitlab.release
                     specs.network = gitlab.network
                     specs.args = [gitlab.address, *rspec_args]

data/lib/gitlab/qa/scenario/test/integration/actioncable.rb

@@ -12,7 +12,7 @@ module Gitlab
                 gitlab.omnibus_configuration << "actioncable['enable'] = true"
 
                 gitlab.instance do
-                  puts "Running actioncable specs!"
+                  Runtime::Logger.info('Running actioncable specs!')
 
                   rspec_args << "--" unless rspec_args.include?('--')
                   rspec_args << %w[--tag actioncable]

data/lib/gitlab/qa/scenario/test/integration/client_ssl.rb

@@ -24,7 +24,7 @@ module Gitlab
                 gitlab.tls = true
 
                 gitlab.instance do
-                  puts 'Running Client SSL specs!'
+                  Runtime::Logger.info('Running Client SSL specs!')
 
                   if @tag
                     rspec_args << "--" unless rspec_args.include?('--')

data/lib/gitlab/qa/scenario/test/integration/elasticsearch.rb

@@ -27,7 +27,7 @@ module Gitlab
                   elastic.network = 'test'
                   elastic.instance do
                     gitlab.instance do
-                      puts "Running #{spec_suite} specs!"
+                      Runtime::Logger.info("Running #{spec_suite} specs!")
 
                       Component::Specs.perform do |specs|
                         specs.suite = spec_suite

data/lib/gitlab/qa/scenario/test/integration/geo.rb

@@ -64,7 +64,7 @@ module Gitlab
                       prepare; start; reconfigure; process_exec_commands
 
                       # shellout to instance specs
-                      puts 'Running Geo primary / secondary specs!'
+                      Runtime::Logger.info('Running Geo primary / secondary specs!')
 
                       Component::Specs.perform do |specs|
                         specs.suite = 'QA::EE::Scenario::Test::Geo'

data/lib/gitlab/qa/scenario/test/integration/gitaly_cluster.rb

@@ -50,7 +50,7 @@ module Gitlab
 
                 gitlab.omnibus_configuration << gitlab_omnibus_configuration
                 gitlab.instance do
-                  puts "Running Gitaly Cluster specs!"
+                  Runtime::Logger.info('Running Gitaly Cluster specs!')
 
                   if @tag
                     rspec_args << "--" unless rspec_args.include?('--')

data/lib/gitlab/qa/scenario/test/integration/jira.rb

@@ -16,7 +16,7 @@ module Gitlab
 
                   jira.instance do
                     gitlab.instance do
-                      puts 'Running Jira specs!'
+                      Runtime::Logger.info('Running Jira specs!')
 
                       rspec_args << "--" unless rspec_args.include?('--')
                       rspec_args << %w[--tag jira]

data/lib/gitlab/qa/scenario/test/integration/ldap.rb

@@ -52,7 +52,7 @@ module Gitlab
 
             def run_specs(gitlab, volumes = {}, *rspec_args)
               gitlab.instance do
-                puts "Running #{spec_suite} specs!"
+                Runtime::Logger.info("Running #{spec_suite} specs!")
 
                 Component::Specs.perform do |specs|
                   specs.suite = spec_suite

data/lib/gitlab/qa/scenario/test/integration/mtls.rb

@@ -33,7 +33,7 @@ module Gitlab
                     gitlab.tls = true
 
                     gitlab.instance do
-                      puts "Running mTLS specs!"
+                      Runtime::Logger.info("Running mTLS specs!")
 
                       if @tag
                         rspec_args << "--" unless rspec_args.include?('--')

data/lib/gitlab/qa/scenario/test/integration/saml.rb

@@ -44,7 +44,7 @@ module Gitlab
 
             def run_specs(gitlab, release, *rspec_args)
               gitlab.instance do
-                puts "Running #{spec_suite} specs!"
+                Runtime::Logger.info("Running #{spec_suite} specs!")
 
                 Component::Specs.perform do |specs|
                   specs.suite = spec_suite

data/lib/gitlab/qa/scenario/test/integration/smtp.rb

@@ -37,7 +37,7 @@ module Gitlab
 
                   mail_hog.instance do
                     gitlab.instance do
-                      puts "Running #{spec_suite} specs!"
+                      Runtime::Logger.info("Running #{spec_suite} specs!")
 
                       Component::Specs.perform do |specs|
                         specs.suite = spec_suite

data/lib/gitlab/qa/support/get_request.rb

@@ -47,7 +47,7 @@ module Gitlab
 
             retry_count += 1
             wait_seconds = response["retry-after"].to_i
-            puts "Received 429 - Too many requests. Waiting for #{wait_seconds} seconds."
+            Runtime::Logger.debug("Received 429 - Too many requests. Waiting for #{wait_seconds} seconds.")
             sleep wait_seconds
           end
 

data/lib/gitlab/qa/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module Gitlab
   module QA
-    VERSION = '7.17.0'.freeze
+    VERSION = '7.19.0'
   end
 end

data/lib/gitlab/qa.rb

@@ -9,6 +9,7 @@ module Gitlab
       autoload :Scenario, 'gitlab/qa/runtime/scenario'
       autoload :TokenFinder, 'gitlab/qa/runtime/token_finder'
       autoload :OmnibusConfiguration, 'gitlab/qa/runtime/omnibus_configuration'
+      autoload :Logger, 'gitlab/qa/runtime/logger'
 
       module OmnibusConfigurations
         autoload :Default, 'gitlab/qa/runtime/omnibus_configurations/default'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-qa
 version: !ruby/object:Gem::Version
-  version: 7.17.0
+  version: 7.19.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-16 00:00:00.000000000 Z
+date: 2022-01-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.16.1
+        version: 4.18.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 4.16.1
+        version: 4.18.0
 - !ruby/object:Gem::Dependency
   name: http
   requirement: !ruby/object:Gem::Requirement
@@ -164,6 +164,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: table_print
   requirement: !ruby/object:Gem::Requirement
@@ -266,6 +280,7 @@ files:
 - lib/gitlab/qa/reporter.rb
 - lib/gitlab/qa/runner.rb
 - lib/gitlab/qa/runtime/env.rb
+- lib/gitlab/qa/runtime/logger.rb
 - lib/gitlab/qa/runtime/omnibus_configuration.rb
 - lib/gitlab/qa/runtime/omnibus_configurations/default.rb
 - lib/gitlab/qa/runtime/omnibus_configurations/license_mode.rb