gitlab-qa 6.23.0 → 7.0.4

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 ||= Runtime::OmnibusConfiguration.new(Runtime::Scenario.omnibus_configuration)
 
-        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

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(qa_image) 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(qa_image, nil, 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|

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Gitlab
   module QA
     module Docker
@@ -13,11 +15,11 @@ module Gitlab
           Docker::Command.execute(%(login --username "#{username}" --password "#{password}" #{registry}), mask_secrets: password)
         end
 
-        def pull(image, tag = nil)
+        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?
 
@@ -36,10 +38,33 @@ 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)

data/lib/gitlab/qa/runner.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require 'optparse'
+require 'active_support/inflector'
 
 module Gitlab
   module QA
@@ -8,6 +11,11 @@ module Gitlab
         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
+        Runtime::Scenario.define(:omnibus_configuration, Runtime::OmnibusConfiguration.new)
+
+        # Omnibus Configurators specified by flags
+        @active_configurators = []
+        @omnibus_configurations = %w[default] # always load default configuration
 
         @options = OptionParser.new do |opts|
           opts.banner = 'Usage: gitlab-qa [options] Scenario URL [[--] path] [rspec_options]'
@@ -31,6 +39,12 @@ module Gitlab
             exit
           end
 
+          opts.on('--omnibus-config config1[,config2,...]', 'Use Omnibus Configuration package') do |configuration|
+            configuration.split(',').map do |config|
+              @omnibus_configurations << config
+            end
+          end
+
           opts.on_tail('-h', '--help', 'Show the usage') do
             puts opts
             exit
@@ -44,21 +58,54 @@ module Gitlab
         end
 
         args.reject! { |arg| gitlab_qa_options.include?(arg) }
-
         if args.size >= 1
-          Scenario
-            .const_get(args.shift)
-            .perform(*args)
+          load_omnibus_configurations
+
+          begin
+            @active_configurators.compact.each do |configurator|
+              configurator.instance(skip_teardown: true)
+            end
+
+            Scenario
+              .const_get(args.shift)
+              .perform(*args)
+          ensure
+            @active_configurators.compact.each(&:teardown)
+          end
         else
           puts @options
           exit 1
         end
       end
-      # rubocop:enable Metrics/AbcSize
 
       def self.gitlab_qa_options
         @gitlab_qa_options ||= @options.top.list.map(&:long).flatten
       end
+
+      def self.load_omnibus_configurations
+        # OmnibusConfiguration::Test       => --test
+        # OmnibusConfiguration::HelloThere => --hello_there
+        @omnibus_configurations.uniq.each do |config|
+          Runtime::OmnibusConfigurations.const_get(config.camelize).new.tap do |configurator|
+            @active_configurators << configurator.prepare
+
+            # */etc/gitlab/gitlab.rb*
+            # -----------------------
+            # # Runtime::OmnibusConfiguration::Packages
+            # gitlab_rails['packages_enabled'] = true
+            Runtime::Scenario.omnibus_configuration << "# #{configurator.class.name}"
+
+            # Load the configuration
+            configurator.configuration.split("\n").each { |c| Runtime::Scenario.omnibus_configuration << c }
+          end
+        rescue NameError
+          raise <<~ERROR
+                Invalid Omnibus Configuration `#{config}`.
+                Possible configurations: #{Runtime::OmnibusConfigurations.constants.map { |c| c.to_s.underscore }.join(',')}"
+          ERROR
+        end
+      end
     end
+    # rubocop:enable Metrics/AbcSize
   end
 end