gitlab-qa 6.22.1 → 6.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8bc00da4cf9e49638677be4e367af1f998b99d096ff7fb777175a66fe06f8b8d
-  data.tar.gz: f16010de2eea8d2efa1e8ee96280f9c5bff569696b19d4b93095d3c604c45a27
+  metadata.gz: be38f6268c3a91ecdeee390c040f658e07194eb1e3d5f99694d50c68540a5461
+  data.tar.gz: bb9fd66f54e18792a9d5a8bb445fefe7cc63d824ef445b61b60f2c7ef378422f
 SHA512:
-  metadata.gz: d61d4c983f8be4ad97ca421f3bfcfc7797c75cdf39affea49a0c58ef49ac5d8aebf7eb2c4d23d24c8f04d6b623ffb17b5d35eb56f64c45c7026706f8666f17a1
-  data.tar.gz: f5efe84a3f6750872fc3069a88b1ab7a5afb68c2429f7c4e81e9d4984054ba0400f318b4896664c86a1101ed102b7eb2d45de63ff24bdfdce7cffaecb5516ba5
+  metadata.gz: 54f0d06a51b27c5e4ea0c1352ca01f634d8e7bc00475345c87650beaf783e7f4dcc4cc53828d54e75b01ada167f002c1a51451147afac400a27ae9132008ee30
+  data.tar.gz: a651ecb24eb49d6e3997c5c6abfef1048900f760d81374e35b9104b05b25210f94c0ecf4de65e5e79c710ca7552153da7aab36e765b5e1acd9c829cf6feb36c1

data/.gitlab-ci.yml

@@ -12,13 +12,13 @@ default:
   cache:
     key:
       files:
-        - Gemfile
+        - Gemfile.lock
         - gitlab-qa.gemspec
     paths:
       - vendor/ruby
   before_script:
     - bundle version
-    - bundle install --clean --jobs=$(nproc) --path=vendor --retry=3 --quiet && bundle check
+    - bundle install --jobs=$(nproc) --path=vendor --retry=3 --quiet && bundle check
     - if [ -n "$TRIGGERED_USER" ] && [ -n "$TRIGGER_SOURCE" ]; then
         echo "Pipeline triggered by $TRIGGERED_USER at $TRIGGER_SOURCE";
       fi

data/docs/what_tests_can_be_run.md

@@ -143,6 +143,40 @@ To run EE tests, the `EE_LICENSE` environment variable needs to be set:
 
 `$ export EE_LICENSE=$(cat /path/to/GitLab.gitlab_license)`
 
+## Specifying the GitLab QA image to use
+
+By default, `gitlab-qa` infers the QA image to use based on the GitLab image.
+For instance, if you run the following:
+
+```
+$ gitlab-qa Test::Instance::Image gitlab/gitlab-ee:12.4.0-ee.0
+```
+
+Then, `gitlab-qa` would infer `gitlab/gitlab-ee-qa:12.4.0-ee.0` as the QA image
+based on the GitLab image (note the `-qa` suffix in the image name).
+
+In some cases, you'll want to use a specific QA image instead of letting
+`gitlab-qa` infer the QA image name from the GitLab image. Such cases can be
+when you're doing local debugging/testing and you want to control the QA image
+name, or in the CI where the QA image might be built by a project (e.g.
+`gitlab-org/gitlab`, and the GitLab image might be built by another project
+(e.g. `gitlab-org/omnibus-gitlab-mirror`).
+
+To specify the QA image to use, pass the `--qa-image QA_IMAGE` option,
+as follows:
+
+```
+$ gitlab-qa Test::Instance::Image --qa-image registry.gitlab.com/gitlab-org/gitlab/gitlab-ee-qa:branch-name EE
+```
+
+Additionally, setting the `$QA_IMAGE` environment variable achieve the same result,
+without needing to pass the `--qa-image` option:
+
+```
+$ export QA_IMAGE="registry.gitlab.com/gitlab-org/gitlab/gitlab-ee-qa:branch-name"
+$ gitlab-qa Test::Instance::Image EE
+```
+
 ## Running a specific test (or set of tests)
 
 In most of the scenarios listed below, if you don't want to run all the tests

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

@@ -23,7 +23,7 @@ module Gitlab
 
           @docker.login(**release.login_params) if release.login_params
 
-          @docker.pull(release.qa_image, release.qa_tag) unless Runtime::Env.skip_pull?
+          @docker.pull(qa_image) unless Runtime::Env.skip_pull?
 
           puts "Running test suite `#{suite}` for #{release.project_name}"
 
@@ -43,7 +43,7 @@ module Gitlab
           feature_flag_sets << [] unless feature_flag_sets.any?
 
           feature_flag_sets.each do |feature_flag_set|
-            @docker.run(release.qa_image, release.qa_tag, suite, *args_with_flags(args, feature_flag_set)) do |command|
+            @docker.run(qa_image, nil, suite, *args_with_flags(args, feature_flag_set)) do |command|
               command << "-t --rm --net=#{network || 'bridge'}"
 
               env.merge(Runtime::Env.variables).each do |key, value|
@@ -76,6 +76,14 @@ module Gitlab
         def skip_tests?
           Runtime::Scenario.attributes.include?(:run_tests) && !Runtime::Scenario.run_tests
         end
+
+        def qa_image
+          if Runtime::Scenario.attributes.include?(:qa_image)
+            Runtime::Scenario.qa_image
+          else
+            "#{release.qa_image}:#{release.qa_tag}"
+          end
+        end
       end
     end
   end

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

@@ -13,15 +13,15 @@ module Gitlab
           Docker::Command.execute(%(login --username "#{username}" --password "#{password}" #{registry}), mask_secrets: password)
         end
 
-        def pull(image, tag)
-          Docker::Command.execute("pull #{image}:#{tag}")
+        def pull(image, tag = nil)
+          Docker::Command.execute("pull #{full_image_name(image, tag)}")
         end
 
         def run(image, tag, *args)
           Docker::Command.new('run').tap do |command|
             yield command if block_given?
 
-            command << "#{image}:#{tag}"
+            command << full_image_name(image, tag)
             command << args if args.any?
 
             command.execute!
@@ -43,7 +43,7 @@ module Gitlab
         end
 
         def read_file(image, tag, path, &block)
-          cat_file = "run --rm --entrypoint /bin/cat #{image}:#{tag} #{path}"
+          cat_file = "run --rm --entrypoint /bin/cat #{full_image_name(image, tag)} #{path}"
           Docker::Command.execute(cat_file, &block)
         end
 
@@ -94,6 +94,12 @@ module Gitlab
         def ps(name = nil)
           Docker::Command.execute(['ps', name].compact.join(' '))
         end
+
+        private
+
+        def full_image_name(image, tag)
+          [image, tag].compact.join(':')
+        end
       end
     end
   end

data/lib/gitlab/qa/runner.rb

@@ -7,6 +7,7 @@ module Gitlab
       def self.run(args)
         Runtime::Scenario.define(:teardown, true)
         Runtime::Scenario.define(:run_tests, true)
+        Runtime::Scenario.define(:qa_image, Runtime::Env.qa_image) if Runtime::Env.qa_image
 
         @options = OptionParser.new do |opts|
           opts.banner = 'Usage: gitlab-qa [options] Scenario URL [[--] path] [rspec_options]'
@@ -20,6 +21,10 @@ module Gitlab
             Runtime::Scenario.define(:teardown, false)
           end
 
+          opts.on('--qa-image QA_IMAGE', String, 'Specifies a QA image to be used instead of inferring it from the GitLab image. See Gitlab::QA::Release#qa_image') do |value|
+            Runtime::Scenario.define(:qa_image, value)
+          end
+
           opts.on_tail('-v', '--version', 'Show the version') do
             require 'gitlab/qa/version'
             puts "#{$PROGRAM_NAME} : #{VERSION}"

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

@@ -10,6 +10,7 @@ module Gitlab
         # These variables should be listed in /docs/what_tests_can_be_run.md#supported-gitlab-environment-variables
         # unless they're defined elsewhere (e.g.: https://docs.gitlab.com/ee/ci/variables/predefined_variables.html)
         ENV_VARIABLES = {
+          'QA_IMAGE' => :qa_image,
           'QA_REMOTE_GRID' => :remote_grid,
           'QA_REMOTE_GRID_USERNAME' => :remote_grid_username,
           'QA_REMOTE_GRID_ACCESS_KEY' => :remote_grid_access_key,

data/lib/gitlab/qa/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   module QA
-    VERSION = '6.22.1'.freeze
+    VERSION = '6.23.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-qa
 version: !ruby/object:Gem::Version
-  version: 6.22.1
+  version: 6.23.0
 platform: ruby
 authors:
 - Grzegorz Bizon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-02-24 00:00:00.000000000 Z
+date: 2021-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control