gitlab-qa 5.13.0 → 5.13.5

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

@@ -6,22 +6,9 @@ require 'securerandom'
 module Gitlab
   module QA
     module Component
-      class SAML
-        include Scenario::Actable
-
-        SAML_IMAGE = 'jamedjo/test-saml-idp'.freeze
-        SAML_IMAGE_TAG = 'latest'.freeze
-
-        attr_reader :docker
-        attr_accessor :volumes, :network, :environment
-        attr_writer :name
-
-        def initialize
-          @docker = Docker::Engine.new
-          @environment = {}
-          @volumes = {}
-          @network_aliases = []
-        end
+      class SAML < Base
+        DOCKER_IMAGE = 'jamedjo/test-saml-idp'.freeze
+        DOCKER_IMAGE_TAG = 'latest'.freeze
 
         def set_entity_id(entity_id)
           @environment['SIMPLESAMLPHP_SP_ENTITY_ID'] = entity_id
@@ -31,18 +18,10 @@ module Gitlab
           @environment['SIMPLESAMLPHP_SP_ASSERTION_CONSUMER_SERVICE'] = assertion_con_service
         end
 
-        def add_network_alias(name)
-          @network_aliases.push(name)
-        end
-
         def name
           @name ||= "saml-qa-idp"
         end
 
-        def hostname
-          "#{name}.#{network}"
-        end
-
         def group_name
           @group_name ||= "saml_sso_group-#{SecureRandom.hex(4)}"
         end
@@ -50,25 +29,12 @@ module Gitlab
         def instance
           raise 'Please provide a block!' unless block_given?
 
-          prepare
-          start
-
-          yield self
-        ensure
-          teardown
-        end
-
-        def prepare
-          pull
-
-          return if @docker.network_exists?(network)
-
-          @docker.network_create(network)
+          super
         end
 
         # rubocop:disable Metrics/AbcSize
         def start
-          docker.run(SAML_IMAGE, SAML_IMAGE_TAG) do |command|
+          docker.run(image, tag) do |command|
             command << '-d '
             command << "--name #{name}"
             command << "--net #{network}"
@@ -91,21 +57,6 @@ module Gitlab
         end
         # rubocop:enable Metrics/AbcSize
 
-        def restart
-          @docker.restart(name)
-        end
-
-        def teardown
-          raise 'Invalid instance name!' unless name
-
-          @docker.stop(name)
-          @docker.remove(name)
-        end
-
-        def pull
-          @docker.pull(SAML_IMAGE, SAML_IMAGE_TAG)
-        end
-
         def set_sandbox_name(sandbox_name)
           ::Gitlab::QA::Runtime::Env.gitlab_sandbox_name = sandbox_name
         end

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

@@ -19,16 +19,7 @@ module Gitlab
         def perform # rubocop:disable Metrics/AbcSize
           raise ArgumentError unless [suite, release].all?
 
-          if release.dev_gitlab_org?
-            Docker::Command.execute(
-              [
-                'login',
-                '--username gitlab-qa-bot',
-                %(--password "#{Runtime::Env.dev_access_token_variable}"),
-                QA::Release::DEV_REGISTRY
-              ]
-            )
-          end
+          @docker.login(**release.login_params) if release.login_params
 
           puts "Running test suite `#{suite}` for #{release.project_name}"
 

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

@@ -8,6 +8,10 @@ module Gitlab
           URI(DOCKER_HOST).host
         end
 
+        def login(username:, password:, registry:)
+          Docker::Command.execute("login --username '#{username}' --password '#{password}' #{registry}")
+        end
+
         def pull(image, tag)
           Docker::Command.execute("pull #{image}:#{tag}")
         end
@@ -63,6 +67,10 @@ module Gitlab
         def port(name, port)
           Docker::Command.execute("port #{name} #{port}/tcp")
         end
+
+        def running?(name)
+          Docker::Command.execute("ps -f name=#{name}").include?(name)
+        end
       end
     end
   end

data/lib/gitlab/qa/release.rb

@@ -52,6 +52,7 @@ module Gitlab
       DEFAULT_TAG = 'latest'.freeze
       DEFAULT_CANONICAL_TAG = 'nightly'.freeze
       DEV_REGISTRY = 'dev.gitlab.org:5005'.freeze
+      COM_REGISTRY = 'registry.gitlab.com'.freeze
 
       InvalidImageNameError = Class.new(RuntimeError)
 
@@ -134,10 +135,34 @@ module Gitlab
         end
       end
 
+      def login_params
+        if dev_gitlab_org?
+          Runtime::Env.require_qa_dev_access_token!
+
+          {
+            username: Runtime::Env.gitlab_dev_username,
+            password: Runtime::Env.dev_access_token_variable,
+            registry: DEV_REGISTRY
+          }
+        elsif omnibus_mirror?
+          Runtime::Env.require_gitlab_bot_multi_project_pipeline_polling_token!
+
+          {
+            username: Runtime::Env.gitlab_username,
+            password: Runtime::Env.gitlab_bot_multi_project_pipeline_polling_token,
+            registry: COM_REGISTRY
+          }
+        end
+      end
+
       def dev_gitlab_org?
         image.start_with?(DEV_REGISTRY)
       end
 
+      def omnibus_mirror?
+        image.start_with?("#{COM_REGISTRY}/gitlab-org/build/omnibus-gitlab-mirror/")
+      end
+
       def valid?
         canonical? || release.match?(CUSTOM_GITLAB_IMAGE_REGEX)
       end

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

@@ -84,10 +84,22 @@ module Gitlab
           send(:attr_accessor, accessor) # rubocop:disable GitlabSecurity/PublicSend
         end
 
+        def gitlab_username
+          ENV['GITLAB_USERNAME'] || 'gitlab-qa'
+        end
+
+        def gitlab_dev_username
+          ENV['GITLAB_DEV_USERNAME'] || 'gitlab-qa-bot'
+        end
+
         def gitlab_api_base
           ENV['GITLAB_API_BASE'] || 'https://gitlab.com/api/v4'
         end
 
+        def gitlab_bot_multi_project_pipeline_polling_token
+          ENV['GITLAB_BOT_MULTI_PROJECT_PIPELINE_POLLING_TOKEN']
+        end
+
         def ci_job_name
           ENV['CI_JOB_NAME']
         end
@@ -195,8 +207,14 @@ module Gitlab
           end
         end
 
+        def require_gitlab_bot_multi_project_pipeline_polling_token!
+          return unless ENV['GITLAB_BOT_MULTI_PROJECT_PIPELINE_POLLING_TOKEN'].to_s.strip.empty?
+
+          raise ArgumentError, "Please provide GITLAB_BOT_MULTI_PROJECT_PIPELINE_POLLING_TOKEN"
+        end
+
         def skip_pull?
-          (ENV['QA_SKIP_PULL'] =~ /^(false|no|0)$/i) != 0
+          enabled?(ENV['QA_SKIP_PULL'], default: false)
         end
 
         def gitlab_qa_formless_login_token
@@ -205,6 +223,12 @@ module Gitlab
 
         private
 
+        def enabled?(value, default: true)
+          return default if value.nil?
+
+          (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]

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module QA
+    module Runtime
+      ##
+      # Singleton approach to global test scenario arguments.
+      #
+      module Scenario
+        extend self
+
+        def attributes
+          @attributes ||= {}
+        end
+
+        def define(attribute, value)
+          attributes.store(attribute.to_sym, value)
+
+          define_singleton_method(attribute) do
+            attributes[attribute.to_sym].tap do |value|
+              if value.to_s.empty?
+                raise ArgumentError, "Empty `#{attribute}` attribute!"
+              end
+            end
+          end
+        end
+
+        # rubocop:disable Style/MethodMissing
+        def method_missing(name, *)
+          raise ArgumentError, "Scenario attribute `#{name}` not defined!"
+        end
+        # rubocop:enable Style/MethodMissing
+      end
+    end
+  end
+end

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

@@ -11,7 +11,7 @@ module Gitlab
             def perform(edition_and_tag, address, *rspec_args)
               Component::Specs.perform do |specs|
                 specs.suite = 'Test::Instance::All'
-                specs.release = Release.new(edition_and_tag)
+                specs.release = QA::Release.new(edition_and_tag)
                 specs.args = [address, *rspec_args]
               end
             end

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

@@ -13,7 +13,7 @@ module Gitlab
 
               Component::Specs.perform do |specs|
                 specs.suite = 'QA::EE::Scenario::Test::Geo'
-                specs.release = Release.new(release)
+                specs.release = QA::Release.new(release)
                 specs.args = [
                   '--primary-address', primary_address,
                   '--secondary-address', secondary_address,

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

@@ -6,7 +6,7 @@ module Gitlab
           class RepositoryStorage < Image
             def perform(release, *rspec_args)
               Component::Gitlab.perform do |gitlab|
-                gitlab.release = Release.new(release)
+                gitlab.release = QA::Release.new(release)
                 gitlab.name = 'gitlab'
                 gitlab.network = 'test'
                 gitlab.omnibus_config = <<~OMNIBUS

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

@@ -11,7 +11,7 @@ module Gitlab
             def perform(edition_and_tag, address, *rspec_args)
               Component::Specs.perform do |specs|
                 specs.suite = 'Test::Instance::Smoke'
-                specs.release = Release.new(edition_and_tag)
+                specs.release = QA::Release.new(edition_and_tag)
                 specs.args = [address, *rspec_args]
               end
             end

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

@@ -16,7 +16,7 @@ module Gitlab
             end
 
             def perform(release, *rspec_args)
-              release = Release.new(release)
+              release = QA::Release.new(release)
               before_perform(release)
 
               Component::Gitlab.perform do |gitlab|

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

@@ -10,7 +10,7 @@ module Gitlab
             # rubocop:disable Metrics/AbcSize
             #
             def perform(release, *rspec_args)
-              release = Release.new(release)
+              release = QA::Release.new(release)
 
               raise ArgumentError, 'Geo is EE only!' unless release.ee?
 

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

@@ -28,16 +28,16 @@ module Gitlab
                       sql.run_psql '-d template1 -c "CREATE DATABASE praefect_production OWNER postgres"'
 
                       Component::Gitlab.perform do |praefect|
-                        praefect.release = Release.new(release)
+                        praefect.release = QA::Release.new(release)
                         praefect.name = @praefect_node
                         praefect.network = @network
-                        praefect.skip_check = true
+                        praefect.skip_availability_check = true
 
                         praefect.omnibus_config = praefect_omnibus_configuration
 
                         praefect.instance do
                           Component::Gitlab.perform do |gitlab|
-                            gitlab.release = Release.new(release)
+                            gitlab.release = QA::Release.new(release)
                             gitlab.name = gitlab_name
                             gitlab.network = @network
 
@@ -146,10 +146,10 @@ module Gitlab
 
             def gitaly(name, release)
               Component::Gitlab.perform do |gitaly|
-                gitaly.release = Release.new(release)
+                gitaly.release = QA::Release.new(release)
                 gitaly.name = name
                 gitaly.network = @network
-                gitaly.skip_check = true
+                gitaly.skip_availability_check = true
 
                 gitaly.omnibus_config = gitaly_omnibus_configuration
 

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

@@ -6,7 +6,7 @@ module Gitlab
           class Jira < Scenario::Template
             def perform(release, *rspec_args)
               Component::Gitlab.perform do |gitlab|
-                gitlab.release = Release.new(release)
+                gitlab.release = QA::Release.new(release)
                 gitlab.network = 'test'
                 gitlab.name = 'gitlab-jira'
 

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

@@ -6,7 +6,7 @@ module Gitlab
           class Packages < Scenario::Template
             def perform(release, *rspec_args)
               Component::Gitlab.perform do |gitlab|
-                gitlab.release = Release.new(release)
+                gitlab.release = QA::Release.new(release)
                 gitlab.name = 'gitlab-packages'
                 gitlab.network = 'test'
                 gitlab.omnibus_config = <<~OMNIBUS

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

@@ -9,7 +9,7 @@ module Gitlab
               Docker::Volumes.new.with_temporary_volumes do |volumes|
                 # Create the Praefect database before enabling Praefect
                 Component::Gitlab.perform do |gitlab|
-                  gitlab.release = Release.new(release)
+                  gitlab.release = QA::Release.new(release)
                   gitlab.name = 'gitlab'
                   gitlab.network = 'test'
                   gitlab.volumes = volumes
@@ -27,7 +27,7 @@ module Gitlab
 
                 # Restart GitLab with Praefect enabled and then run the tests
                 Component::Gitlab.perform do |gitlab|
-                  gitlab.release = Release.new(release)
+                  gitlab.release = QA::Release.new(release)
                   gitlab.name = 'gitlab'
                   gitlab.network = 'test'
                   gitlab.volumes = volumes

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

@@ -17,7 +17,7 @@ module Gitlab
             end
 
             def perform(release, *rspec_args)
-              release = Release.new(release)
+              release = QA::Release.new(release)
               before_perform(release)
 
               Component::Gitlab.perform do |gitlab|

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

@@ -22,7 +22,7 @@ module Gitlab
             end
 
             def perform(release, *rspec_args)
-              release = Release.new(release)
+              release = QA::Release.new(release)
 
               Component::Gitlab.perform do |gitlab|
                 gitlab.release = release

data/lib/gitlab/qa/scenario/test/omnibus/update.rb

@@ -8,8 +8,8 @@ module Gitlab
         module Omnibus
           class Update < Scenario::Template
             def perform(from_release, to_release = nil, *rspec_args)
-              previous_release = Release.new(from_release).previous_stable
-              current_release = Release.new(to_release || from_release)
+              previous_release = QA::Release.new(from_release).previous_stable
+              current_release = QA::Release.new(to_release || from_release)
 
               Docker::Volumes.new.with_temporary_volumes do |volumes|
                 Component::Gitlab.perform do |gitlab|

data/lib/gitlab/qa/scenario/test/omnibus/upgrade.rb

@@ -8,7 +8,7 @@ module Gitlab
         module Omnibus
           class Upgrade < Scenario::Template
             def perform(image = 'CE', *rspec_args)
-              ce_release = Release.new(image)
+              ce_release = QA::Release.new(image)
 
               if ce_release.ee?
                 raise ArgumentError, 'Only CE can be upgraded to EE!'

data/lib/gitlab/qa/scenario/test/sanity/version.rb

@@ -24,7 +24,7 @@ module Gitlab
                 end
               end
 
-              project = "gitlab-org/#{Release.new(release).project_name}"
+              project = "gitlab-org/#{QA::Release.new(release).project_name}"
               commit = recent_commits(project).find { |c| c['id'] == version }
 
               if commit