gitlab-qa 6.22.1 → 7.0.3

data/lib/gitlab/qa/runner.rb

@@ -1,4 +1,7 @@
+# frozen_string_literal: true
+
 require 'optparse'
+require 'active_support/inflector'
 
 module Gitlab
   module QA
@@ -7,6 +10,12 @@ 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
+        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]'
@@ -20,12 +29,22 @@ 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}"
             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
@@ -39,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

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,
@@ -64,6 +65,7 @@ module Gitlab
           'KNAPSACK_TEST_FILE_PATTERN' => :knapsack_test_file_pattern,
           'KNAPSACK_TEST_DIR' => :knapsack_test_dir,
           'CI' => :ci,
+          'CI_JOB_NAME' => :ci_job_name,
           'CI_JOB_URL' => :ci_job_url,
           'CI_RUNNER_ID' => :ci_runner_id,
           'CI_SERVER_HOST' => :ci_server_host,

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

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/object/blank'
+
+module Gitlab
+  module QA
+    module Runtime
+      class OmnibusConfiguration
+        def initialize
+          @config = ["# Generated by GitLab QA Omnibus Configurator at #{Time.now.strftime('%Y-%m-%d %H:%M:%S')}"]
+        end
+
+        def to_s
+          sanitize!.join("\n")
+        end
+
+        def configuration
+          raise NotImplementedError
+        end
+
+        # Before hook for any additional configuration
+        # This would usually be a container that needs to be running
+        # @return Any instance of [Gitlab::QA::Component::Base]
+        def prepare; end
+
+        # Commands to execute before GitLab boots
+        def exec_commands
+          []
+        end
+
+        # Ensures no duplicate entries
+        # @raise RuntimeError if competing configurations exist
+        # rubocop:disable Metrics/AbcSize
+        def sanitize!
+          sanitized = @config.map do |config|
+            next config if config.start_with?('#') || config.match(/\w+\(/) # allow for comments and method invocations
+
+            # sometimes "=" is part of a Hash. Only split based on the first "="
+            k, v = config.split("=", 2)
+            # make sure each config is well-formed
+            # e.g., gitlab_rails['packages_enabled'] = true
+            #   NOT gitlab_rails['packages_enabled']=true
+
+            v.nil? ? k.strip : "#{k.strip} = #{v.strip.tr('"', "'")}".strip
+          end.uniq
+
+          errors = []
+
+          # check for duplicates
+          duplicate_keys = []
+          duplicates = sanitized.reject do |n|
+            key = n.split('=').first
+            duplicate_keys << key unless duplicate_keys.include?(key)
+          end
+
+          duplicates.each { |duplicate| errors << "Duplicate entry found: `#{duplicate}`" }
+
+          raise "Errors exist within the Omnibus Configuration!\n#{errors.join(',')}" if errors.any?
+
+          @config = sanitized
+        end
+        # rubocop:enable Metrics/AbcSize
+
+        def <<(config)
+          @config << config.strip unless config.strip.empty?
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/qa/runtime/omnibus_configurations/default.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module QA
+    module Runtime
+      module OmnibusConfigurations
+        # Default Configuration for Omnibus
+        # All runs will include this configuration
+        class Default < Runtime::OmnibusConfiguration
+          def configuration
+            <<~OMNIBUS
+              gitlab_rails['gitlab_default_theme'] = 10 # Light Red Theme
+              gitlab_rails['gitlab_disable_animations'] = true # Disable animations
+              gitlab_rails['application_settings_cache_seconds'] = 0 # Settings cache expiry
+            OMNIBUS
+          end
+
+          def self.configuration
+            new.configuration
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/qa/runtime/omnibus_configurations/object_storage.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module QA
+    module Runtime
+      module OmnibusConfigurations
+        class ObjectStorage < Default
+          TYPES = %w[artifacts external_diffs lfs uploads packages dependency_proxy].freeze
+
+          def configuration
+            TYPES.each_with_object(+'') do |object_type, omnibus|
+              omnibus << <<~OMNIBUS
+                gitlab_rails['#{object_type}_enabled'] = true
+                gitlab_rails['#{object_type}_storage_path'] = '/var/opt/gitlab/gitlab-rails/shared/#{object_type}'
+                gitlab_rails['#{object_type}_object_store_enabled'] = true
+                gitlab_rails['#{object_type}_object_store_remote_directory'] = '#{object_type}-bucket'
+                gitlab_rails['#{object_type}_object_store_background_upload'] = false
+                gitlab_rails['#{object_type}_object_store_direct_upload'] = true
+                gitlab_rails['#{object_type}_object_store_proxy_download'] = true
+                gitlab_rails['#{object_type}_object_store_connection'] = #{minio.to_config}
+              OMNIBUS
+            end
+          end
+
+          def prepare
+            minio.network = 'test'
+
+            TYPES.each do |bucket_name|
+              minio.add_bucket("#{bucket_name}-bucket")
+            end
+
+            minio
+          end
+
+          def exec_commands
+            QA::Scenario::CLICommands.git_lfs_install_commands
+          end
+
+          private
+
+          def minio
+            @minio ||= Component::Minio.new
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/qa/runtime/omnibus_configurations/packages.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module QA
+    module Runtime
+      module OmnibusConfigurations
+        class Packages < Default
+          def configuration
+            <<~OMNIBUS
+              gitlab_rails['packages_enabled'] = true
+            OMNIBUS
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/qa/scenario/cli_commands.rb

@@ -4,11 +4,11 @@ module Gitlab
       module CLICommands
         GIT_LFS_VERSION = '2.8.0'.freeze
 
-        def git_lfs_install_commands
-          @git_lfs_install_commands ||= [
+        def self.git_lfs_install_commands
+          [
             "cd /tmp ; curl -qsL https://github.com/git-lfs/git-lfs/releases/download/v#{GIT_LFS_VERSION}/git-lfs-linux-amd64-v#{GIT_LFS_VERSION}.tar.gz | tar xzvf -",
             'cp /tmp/git-lfs /usr/local/bin'
-          ]
+          ].freeze
         end
       end
     end

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

@@ -10,9 +10,7 @@ module Gitlab
                 gitlab.network = 'test'
                 gitlab.relative_path = '/relative'
 
-                gitlab.omnibus_config = <<~OMNIBUS
-                  external_url '#{gitlab.address}';
-                OMNIBUS
+                gitlab.omnibus_configuration << "external_url '#{gitlab.address}'"
 
                 gitlab.instance do
                   Component::Specs.perform do |specs|

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

@@ -9,7 +9,7 @@ module Gitlab
                 gitlab.release = QA::Release.new(release)
                 gitlab.name = 'gitlab'
                 gitlab.network = 'test'
-                gitlab.omnibus_config = <<~OMNIBUS
+                gitlab.omnibus_configuration << <<~OMNIBUS
                   git_data_dirs({
                     'default' => {
                       'path' => '/var/opt/gitlab/git-data/repositories/default'

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

@@ -9,9 +9,7 @@ module Gitlab
                 gitlab.release = QA::Release.new(release)
                 gitlab.name = 'gitlab-actioncable'
                 gitlab.network = 'test'
-                gitlab.omnibus_config = <<~OMNIBUS
-                  actioncable['enable'] = true;
-                OMNIBUS
+                gitlab.omnibus_configuration << "actioncable['enable'] = true"
 
                 gitlab.instance do
                   puts "Running actioncable specs!"

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

@@ -4,7 +4,6 @@ module Gitlab
       module Test
         module Integration
           class Geo < Scenario::Template
-            include Scenario::CLICommands
             ##
             # rubocop:disable Lint/MissingCopEnableDirective
             # rubocop:disable Metrics/AbcSize
@@ -20,7 +19,7 @@ module Gitlab
                 primary.release = release
                 primary.name = 'gitlab-primary'
                 primary.network = 'geo'
-                primary.omnibus_config = <<~OMNIBUS
+                primary.omnibus_configuration << <<~OMNIBUS
                   gitlab_rails['db_key_base'] = '4dd58204865eb41bca93bd38131d51cc';
                   geo_primary_role['enable'] = true;
                   gitlab_rails['db_password'] = 'mypass';
@@ -36,14 +35,14 @@ module Gitlab
                   sidekiq['concurrency'] = 2;
                   puma['worker_processes'] = 2;
                 OMNIBUS
-                primary.exec_commands = fast_ssh_key_lookup_commands + git_lfs_install_commands
+                primary.exec_commands = fast_ssh_key_lookup_commands + QA::Scenario::CLICommands.git_lfs_install_commands
 
                 primary.instance do
                   Component::Gitlab.perform do |secondary|
                     secondary.release = release
                     secondary.name = 'gitlab-secondary'
                     secondary.network = 'geo'
-                    secondary.omnibus_config = <<~OMNIBUS
+                    secondary.omnibus_configuration << <<~OMNIBUS
                       geo_secondary['db_fdw'] = true;
                       geo_secondary_role['enable'] = true;
                       gitlab_rails['db_key_base'] = '4dd58204865eb41bca93bd38131d51cc';
@@ -58,7 +57,7 @@ module Gitlab
                       sidekiq['concurrency'] = 2;
                       puma['worker_processes'] = 2;
                     OMNIBUS
-                    secondary.exec_commands = fast_ssh_key_lookup_commands + git_lfs_install_commands
+                    secondary.exec_commands = fast_ssh_key_lookup_commands + QA::Scenario::CLICommands.git_lfs_install_commands
 
                     secondary.act do
                       # TODO, we do not wait for secondary to start because of

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

@@ -39,7 +39,7 @@ module Gitlab
                 praefect.network = @network
                 praefect.skip_availability_check = true
 
-                praefect.omnibus_config = praefect_omnibus_configuration
+                praefect.omnibus_configuration << praefect_omnibus_configuration
 
                 praefect.instance(skip_teardown: true)
               end
@@ -49,7 +49,7 @@ module Gitlab
                 gitlab.name = gitlab_name
                 gitlab.network = @network
 
-                gitlab.omnibus_config = gitlab_omnibus_configuration
+                gitlab.omnibus_configuration << gitlab_omnibus_configuration
                 gitlab.instance do
                   puts "Running Gitaly Cluster specs!"
 
@@ -131,8 +131,7 @@ module Gitlab
 
             def gitaly_omnibus_configuration
               <<~OMNIBUS
-                #{disable_other_services}
-                prometheus['enable'] = true;
+                #{disable_other_services.sub(/(prometheus\['enable'\]) = false/, '\1 = true')}
                 prometheus_monitoring['enable'] = false;
                 gitaly['enable'] = true;
                 gitaly['listen_addr'] = '0.0.0.0:8075';
@@ -197,7 +196,7 @@ module Gitlab
                 gitaly.name = name
                 gitaly.network = @network
                 gitaly.skip_availability_check = true
-                gitaly.omnibus_config = gitaly_omnibus_configuration
+                gitaly.omnibus_configuration << gitaly_omnibus_configuration
                 gitaly.instance(skip_teardown: true)
               end
             end

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

@@ -17,7 +17,7 @@ module Gitlab
             end
 
             def configure(gitlab, saml)
-              gitlab.omnibus_config = <<~OMNIBUS
+              gitlab.omnibus_configuration << <<~OMNIBUS
                 gitlab_rails['omniauth_enabled'] = true;
                 gitlab_rails['omniauth_providers'] = [{ name: 'group_saml' }];
               OMNIBUS

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

@@ -17,7 +17,7 @@ module Gitlab
               saml.set_assertion_consumer_service("#{gitlab.address}/users/auth/saml/callback")
               saml.set_simple_saml_hostname
 
-              gitlab.omnibus_config = <<~OMNIBUS
+              gitlab.omnibus_configuration << <<~OMNIBUS
                 gitlab_rails['omniauth_enabled'] = true;
                 gitlab_rails['omniauth_allow_single_sign_on'] = ['saml'];
                 gitlab_rails['omniauth_block_auto_created_users'] = false;

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

@@ -21,7 +21,7 @@ module Gitlab
                     tunnel_registry.gitlab_hostname = gitlab.hostname
                     tunnel_registry.network = 'test'
 
-                    gitlab.omnibus_config = <<~OMNIBUS
+                    gitlab.omnibus_configuration << <<~OMNIBUS
                       external_url '#{tunnel_gitlab.url}';
                       nginx['listen_port'] = 80;
                       nginx['listen_https'] = false;

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

@@ -27,7 +27,7 @@ module Gitlab
             end
 
             def ldap_servers_omnibus_config
-              config = YAML.safe_load <<~CFG
+              YAML.safe_load <<~CFG
                 main:
                   label: LDAP
                   host: #{ldap_hostname}
@@ -44,9 +44,6 @@ module Gitlab
                   external_groups: ''
                   sync_ssh_keys: false
               CFG
-
-              # Quotes get eaten up when the string is set in the environment
-              config.to_s.gsub("\"", "\\\"")
             end
 
             def ldap_hostname