gitlab-qa 6.22.0 → 7.0.2

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
@@ -500,6 +534,18 @@ $ gitlab-qa Test::Integration::Mattermost EE
 
 ### `Test::Integration::Packages CE|EE|<full image address>`
 
+**Note: This Scenario no longer exists.  See https://gitlab.com/gitlab-org/gitlab-qa/-/merge_requests/662**
+
+To run Packages tests, you may [configure Omnibus](configuring_omnibus.md) to use the [Packages](https://gitlab.com/gitlab-org/gitlab-qa/-/blob/master/lib/gitlab/qa/runtime/omnibus_configurations/packages.rb) configurator.
+
+Example:
+
+```
+$ export EE_LICENSE=$(cat /path/to/Geo.gitlab_license)
+
+$ gitlab-qa Test::Instance::Image EE --omnibus-config packages
+```
+
 This tests the GitLab Package Registry feature by setting
 `gitlab_rails['packages_enabled'] = true` in the Omnibus configuration
 before starting the GitLab container.
@@ -513,14 +559,6 @@ which runs only the tests with `:packages` metadata.
 
 - `EE_LICENSE`: A valid EE license.
 
-Example:
-
-```
-$ export EE_LICENSE=$(cat /path/to/Geo.gitlab_license)
-
-$ gitlab-qa Test::Integration::Packages EE
-```
-
 ### `Test::Integration::Praefect CE|EE|<full image address>`
 
 This tests [Praefect](https://docs.gitlab.com/ee/administration/gitaly/praefect.html),

data/gitlab-qa.gemspec

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'gitlab/qa/version'
@@ -5,11 +7,11 @@ require 'gitlab/qa/version'
 Gem::Specification.new do |spec|
   spec.name          = 'gitlab-qa'
   spec.version       = Gitlab::QA::VERSION
-  spec.authors       = ['Grzegorz Bizon']
-  spec.email         = ['grzesiek.bizon@gmail.com']
+  spec.authors       = ['GitLab Quality']
+  spec.email         = ['gitlab-qa@gmail.com']
 
   spec.summary       = 'Integration tests for GitLab'
-  spec.homepage      = 'http://about.gitlab.com'
+  spec.homepage      = 'http://about.gitlab.com/'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`
@@ -31,5 +33,5 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'gitlab', '~> 4.16.1'
   spec.add_runtime_dependency 'http', '4.3.0'
   spec.add_runtime_dependency 'nokogiri', '~> 1.10'
-  spec.add_runtime_dependency 'table_print', '1.5.6'
+  spec.add_runtime_dependency 'table_print', '1.5.7'
 end

data/lib/gitlab/qa.rb

@@ -8,6 +8,13 @@ module Gitlab
       autoload :Env, 'gitlab/qa/runtime/env'
       autoload :Scenario, 'gitlab/qa/runtime/scenario'
       autoload :TokenFinder, 'gitlab/qa/runtime/token_finder'
+      autoload :OmnibusConfiguration, 'gitlab/qa/runtime/omnibus_configuration'
+
+      module OmnibusConfigurations
+        autoload :Default, 'gitlab/qa/runtime/omnibus_configurations/default'
+        autoload :Packages, 'gitlab/qa/runtime/omnibus_configurations/packages'
+        autoload :ObjectStorage, 'gitlab/qa/runtime/omnibus_configurations/object_storage'
+      end
     end
 
     module Scenario

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

@@ -78,7 +78,7 @@ module Gitlab
         end
 
         def start # rubocop:disable Metrics/AbcSize
-          docker.run(image, tag) do |command|
+          docker.run(image: image, tag: tag) do |command|
             command << "-d"
             command << "--name #{name}"
             command << "--net #{network}"
@@ -129,7 +129,7 @@ module Gitlab
         def pull
           return if Runtime::Env.skip_pull?
 
-          docker.pull(image, tag)
+          docker.pull(image: image, tag: tag)
         end
 
         def process_exec_commands

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

@@ -13,7 +13,7 @@ module Gitlab
         end
 
         def start
-          @docker.run(image, tag) do |command|
+          @docker.run(image: image, tag: tag) do |command|
             command << "-d"
             command << "--name #{name}"
             command << "--net #{network}"

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'securerandom'
 require 'net/http'
 require 'uri'
@@ -10,39 +12,36 @@ module Gitlab
       class Gitlab < Base
         extend Forwardable
 
-        attr_reader :release
-        attr_accessor :tls, :disable_animations, :skip_availability_check, :runner_network
+        attr_reader :release, :omnibus_configuration
+        attr_accessor :tls, :skip_availability_check, :runner_network
         attr_writer :name, :relative_path
 
         def_delegators :release, :tag, :image, :edition
 
-        AUTHORITY_CERTIFICATES_PATH = File.expand_path('../../../../tls_certificates/authority'.freeze, __dir__)
-        GITLAB_CERTIFICATES_PATH = File.expand_path('../../../../tls_certificates/gitlab'.freeze, __dir__)
-        GITALY_CERTIFICATES_PATH = File.expand_path('../../../../tls_certificates/gitaly'.freeze, __dir__)
+        AUTHORITY_CERTIFICATES_PATH = File.expand_path('../../../../tls_certificates/authority', __dir__)
+        GITLAB_CERTIFICATES_PATH = File.expand_path('../../../../tls_certificates/gitlab', __dir__)
+        GITALY_CERTIFICATES_PATH = File.expand_path('../../../../tls_certificates/gitaly', __dir__)
 
-        SSL_PATH = '/etc/gitlab/ssl'.freeze
-        TRUSTED_PATH = '/etc/gitlab/trusted-certs'.freeze
+        SSL_PATH = '/etc/gitlab/ssl'
+        TRUSTED_PATH = '/etc/gitlab/trusted-certs'
 
         def initialize
           super
 
-          @disable_animations = true
           @skip_availability_check = false
 
           @volumes[GITLAB_CERTIFICATES_PATH] = SSL_PATH
           @volumes[AUTHORITY_CERTIFICATES_PATH] = TRUSTED_PATH
 
-          self.release = 'CE'
-        end
+          @omnibus_configuration ||= OmnibusConfiguration.new
 
-        def omnibus_config=(config)
-          @environment['GITLAB_OMNIBUS_CONFIG'] = config.tr("\n", ' ')
+          self.release = 'CE'
         end
 
         def set_formless_login_token
           return if Runtime::Env.gitlab_qa_formless_login_token.to_s.strip.empty?
 
-          @environment['GITLAB_OMNIBUS_CONFIG'] = "gitlab_rails['env'] = { 'GITLAB_QA_FORMLESS_LOGIN_TOKEN' => '#{Runtime::Env.gitlab_qa_formless_login_token}' }; #{@environment['GITLAB_OMNIBUS_CONFIG'] || ''}"
+          @omnibus_configuration << "gitlab_rails['env'] = { 'GITLAB_QA_FORMLESS_LOGIN_TOKEN' => '#{Runtime::Env.gitlab_qa_formless_login_token}' }"
         end
 
         def elastic_url=(url)
@@ -95,23 +94,13 @@ module Gitlab
         end
 
         def prepare_gitlab_omnibus_config
-          setup_disable_animations if disable_animations
           set_formless_login_token
-          setup_application_settings_cache_expiry
-        end
-
-        def setup_disable_animations
-          @environment['GITLAB_OMNIBUS_CONFIG'] = "gitlab_rails['gitlab_disable_animations'] = true; #{@environment['GITLAB_OMNIBUS_CONFIG'] || ''}"
-        end
-
-        def setup_application_settings_cache_expiry
-          @environment['GITLAB_OMNIBUS_CONFIG'] = "gitlab_rails['application_settings_cache_seconds'] = 0; #{@environment['GITLAB_OMNIBUS_CONFIG'] || ''}"
         end
 
         def start # rubocop:disable Metrics/AbcSize
           ensure_configured!
 
-          docker.run(image, tag) do |command|
+          docker.run(image: image, tag: tag) do |command|
             command << "-d -p #{port}"
             command << "--name #{name}"
             command << "--net #{network}"
@@ -135,6 +124,8 @@ module Gitlab
         end
 
         def reconfigure
+          setup_omnibus
+
           @docker.attach(name) do |line, wait|
             puts line
             # TODO, workaround which allows to detach from the container
@@ -170,6 +161,12 @@ module Gitlab
           raise 'Please configure an instance first!' unless [name, release, network].all?
         end
 
+        def setup_omnibus
+          @docker.write_files(name) do |f|
+            f.write('/etc/gitlab/gitlab.rb', @omnibus_configuration.to_s)
+          end
+        end
+
         class Availability
           def initialize(name, relative_path: '', scheme: 'http', protocol_port: 80)
             @docker = Docker::Engine.new
@@ -209,6 +206,20 @@ module Gitlab
             @uri.scheme == 'https' ? { use_ssl: true, verify_mode: OpenSSL::SSL::VERIFY_NONE } : {}
           end
         end
+
+        class OmnibusConfiguration
+          def initialize
+            @config = Runtime::Scenario.attributes[:omnibus_configuration].clone || []
+          end
+
+          def <<(configuration)
+            @config << configuration
+          end
+
+          def to_s
+            @config.to_s
+          end
+        end
       end
     end
   end

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

@@ -49,7 +49,10 @@ module Gitlab
         def start
           raise "Must set gitlab_hostname" unless @gitlab_hostname
 
-          @docker.run(DOCKER_IMAGE, DOCKER_IMAGE_TAG, "-o StrictHostKeyChecking=no -N -R #{subdomain}:#{@gitlab_hostname}:80 #{ENV.fetch('TUNNEL_SSH_USER')}@#{tunnel_server_hostname}") do |command|
+          @docker.run(
+            image: DOCKER_IMAGE,
+            tag: DOCKER_IMAGE_TAG,
+            args: ["-o StrictHostKeyChecking=no -N -R #{subdomain}:#{@gitlab_hostname}:80 #{ENV.fetch('TUNNEL_SSH_USER')}@#{tunnel_server_hostname}"]) do |command|
             command << '-d '
             command << "--name #{name}"
             command << "--net #{network}"

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

@@ -16,7 +16,7 @@ module Gitlab
         end
 
         def start
-          docker.run(image, tag) do |command|
+          docker.run(image: image, tag: tag) do |command|
             command << '-d '
             command << "--name #{name}"
             command << "--net #{network}"

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

@@ -63,7 +63,7 @@ module Gitlab
         def start
           # copy-service needed for bootstraping LDAP user:
           # https://github.com/osixia/docker-openldap#seed-ldap-database-with-ldif
-          docker.run(image, tag, '--copy-service') do |command|
+          docker.run(image: image, tag: tag, args: ['--copy-service']) do |command|
             command << '-d '
             command << "--name #{name}"
             command << "--net #{network}"

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

@@ -19,7 +19,7 @@ module Gitlab
         end
 
         def start
-          docker.run(image, tag) do |command|
+          docker.run(image: image, tag: tag) do |command|
             command << '-d '
             command << "--name #{name}"
             command << "--net #{network}"

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

@@ -1,5 +1,6 @@
 require 'securerandom'
 require 'fileutils'
+require 'yaml'
 
 # This component sets up the Minio (https://hub.docker.com/r/minio/minio)
 # image with the proper configuration for GitLab users to use object storage.
@@ -23,18 +24,12 @@ module Gitlab
           @buckets = []
         end
 
-        def instance
-          raise 'Please provide a block!' unless block_given?
-
-          super
-        end
-
         def add_bucket(name)
           @buckets << name
         end
 
         def to_config
-          config = YAML.safe_load <<~CFG
+          YAML.safe_load <<~CFG
             provider: AWS
             aws_access_key_id: #{AWS_ACCESS_KEY}
             aws_secret_access_key: #{AWS_SECRET_KEY}
@@ -43,9 +38,6 @@ module Gitlab
             endpoint: http://#{hostname}:#{port}
             path_style: true
           CFG
-
-          # Quotes get eaten up when the string is set in the environment
-          config.to_s.gsub('"', '\\"')
         end
 
         private
@@ -78,7 +70,7 @@ module Gitlab
         def start # rubocop:disable Metrics/AbcSize
           # --compat needed until https://gitlab.com/gitlab-org/gitlab-workhorse/issues/210
           # is resolved
-          docker.run(image, tag, "server", "--compat", DATA_DIR) do |command|
+          docker.run(image: image, tag: tag, args: ["server", "--compat", DATA_DIR]) do |command|
             command << '-d '
             command << "--name #{name}"
             command << "--net #{network}"

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

@@ -10,7 +10,7 @@ module Gitlab
         end
 
         def start
-          @docker.run(image, tag) do |command|
+          @docker.run(image: image, tag: tag) do |command|
             command << "-d"
             command << "--name #{name}"
             command << "--net #{network}"

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

@@ -34,7 +34,7 @@ module Gitlab
 
         # rubocop:disable Metrics/AbcSize
         def start
-          docker.run(image, tag) do |command|
+          docker.run(image: image, tag: tag) do |command|
             command << '-d '
             command << "--name #{name}"
             command << "--net #{network}"

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(image: 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(image: qa_image, args: [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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module QA
     module Docker
@@ -13,15 +15,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)
+        def run(image:, tag: nil, 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!
@@ -36,14 +38,37 @@ module Gitlab
           false
         end
 
+        # Write to file(s) in the Docker container specified by @param name
+        # @param name The name of the Docker Container
+        # @example
+        #   engine.write_files('gitlab-abc123') do |files|
+        #     files.append('/etc/hosts', '127.0.0.1 localhost')
+        #     files.write('/opt/other', <<~TEXT
+        #       This is content
+        #       That goes within /opt/other
+        #     TEXT)
+        def write_files(name)
+          exec(name, yield(
+            Class.new do
+              def self.write(file, contents)
+                %(echo "#{contents}" > #{file};)
+              end
+
+              def self.append(file, contents)
+                %(echo "#{contents}" >> #{file};)
+              end
+            end
+          ))
+        end
+
         def exec(name, command)
           cmd = ['exec']
           cmd << '--privileged' if privileged_command?(command)
-          Docker::Command.execute("#{cmd.join(' ')} #{name} bash -c '#{command}'")
+          Docker::Command.execute(%(#{cmd.join(' ')} #{name} bash -c "#{command.gsub('"', '\\"')}"))
         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 +119,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