gitlab-qa 14.20.0 → 14.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2d322ac696cbbc43376ab9e0119aa17b5ca27b326a4e98c0bed1e7e62bb0d94
-  data.tar.gz: ac29c33e952e89531a792294fe91ecbc251562b77eefb2aa17c46a969b1916a1
+  metadata.gz: d84483452fba7a39c684e4b5b7f772a63712c6d400027b579dca7769ce231c7e
+  data.tar.gz: 64e52ceaa976d1dc0a3f513a26e71f4e529c5a9d9eea8c39474f683da963d718
 SHA512:
-  metadata.gz: e16ec9338d9c0e45854dd81c15219afd7a4960882debbccf75a5a0db426b682f416ce9b41264ba560c8f384b81f822a3bbf51f66b2a0022a9d16d78d7a406c47
-  data.tar.gz: d4f1c16afbf492572dd0d3830c592e38c0182224b2524ab1992e5ffa1e286bcfec7f6a21da837b8de45cea4109bc703ecc6c828a64ab51c7a72d04b50e342956
+  metadata.gz: 8633d6f704664548214395cf5e3b8560e6776f0052d5dcf1da91d3239e5489236877495b9bc077043f4efeb588e15272c595dfda0dc147386818d2a3c505d476
+  data.tar.gz: ca524f4c69c44fab4241cfd836bf2ed0f10047a3b030f942474ed360c8f7356a3ee678aa56dbb59a38697add270dcc8a881789a84fc3c675eb5b65f6395d0425

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab-qa (14.20.0)
+    gitlab-qa (14.21.0)
       activesupport (>= 6.1, < 7.2)
       ffi (~> 1.17)
       gitlab (~> 4.19)

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

@@ -15,19 +15,41 @@ module Gitlab
           class Import < Scenario::Template
             def initialize
               @network = Runtime::Env.docker_network
-              @source_gitlab = Component::Gitlab.new.tap { |gitlab| gitlab.network = @network }
-              @target_gitlab = Component::Gitlab.new.tap { |gitlab| gitlab.network = @network }
-              @mock_server = Component::MockServer.new.tap do |server|
-                server.network = @network
-                server.tls = true
-              end
+
+              @source_gitlab = new_gitlab_instance
+              @target_gitlab = new_gitlab_instance
+              @mock_server = new_mock_server
+              @mail_hog_server = new_mail_hog_server
+              @spec_suite = 'Test::Integration::Import'
+            end
+
+            attr_reader :source_gitlab, :target_gitlab, :mock_server, :network, :spec_suite, :mail_hog_server
+
+            def configure_omnibus(gitlab, mail_hog)
+              raise NotImplementedError
             end
 
-            attr_reader :source_gitlab, :target_gitlab, :mock_server, :network
+            # Import tests that spins up two gitlab instances
+            #
+            # @example
+            # perform(gitlab-ee, gitlab-ee:17.4.0-ee.0)
+            # => will perform import from gitlab-ee:17.4.0-ee.0 to gitlab-ee
+            #
+            # @param [String] target_release target gitlab instance version release docker image(default)
+            # @param [String] source_release source gitlab instance version, if its not passed takes the target release as default
+            # @param [Array] *rspec_args rspec arguments
+            # @return [void]
+            def perform(target_release, source_release = nil, *rspec_args)
+              # When source_release isn't actually passed but RSpec args arg passed with `-- rspec_args...`,
+              # source_release is wrongly set to `--`, so we fix that here.
+              if source_release == "--"
+                rspec_args.prepend('--')
+                source_release = nil
+              end
 
-            def perform(release, *rspec_args)
+              source_release = target_release if source_release.nil?
               start_mock_server
-              start_gitlab_instances(release)
+              start_gitlab_instances(source_release, target_release)
 
               run_specs(rspec_args)
             ensure
@@ -38,6 +60,45 @@ module Gitlab
 
             private
 
+            # Initialize a mailhog instance
+            #
+            # @note this does not start the instance
+            # @return [Gitlab::QA::Component::MailHog] Mailhog instance
+            def new_mail_hog_server
+              Component::MailHog.new.tap do |mail_hog|
+                mail_hog.network = @network
+                mail_hog.set_mailhog_hostname
+              end
+            end
+
+            # Check if MailHog server is needed
+            #
+            # @param [Hash] gitlab_instance
+            # @return [Boolean]
+            def mail_hog_server_needed?(gitlab_instance)
+              respond_to?(:orchestrate_mail_hog_server) && gitlab_instance[:name] == "import-target"
+            end
+
+            # Start MailHog server
+            #
+            # @param [Hash] gitlab_instance
+            # @return [void]
+            def start_mail_hog_server(gitlab_instance)
+              configure_omnibus(gitlab_instance[:instance], mail_hog_server)
+              mail_hog_server.start_instance
+            end
+
+            # Initialize a mock server instance
+            #
+            # @note this does not start the instance
+            # @return [Gitlab::QA::Component::MockServer] mock server instance
+            def new_mock_server
+              Component::MockServer.new.tap do |server|
+                server.network = @network
+                server.tls = true
+              end
+            end
+
             # Start mock server instance
             #
             # @return [void]
@@ -45,25 +106,60 @@ module Gitlab
               mock_server.start_instance
             end
 
-            # Start gitlab instance
+            # Initialize a gitlab instance
             #
-            # @param [Gitlab::QA::Release] release
+            # @note this does not start the instance
+            # @return [Gitlab::QA::Component::Gitlab] gitlab instance
+            def new_gitlab_instance
+              Component::Gitlab.new.tap { |gitlab| gitlab.network = @network }
+            end
+
+            # Setup GitLab instance
+            #
+            # @param [Hash] gitlab_instance
             # @return [void]
-            def start_gitlab_instances(release)
-              instances = [
-                { instance: source_gitlab, name: "import-source", additional_hosts: [] },
-                { instance: target_gitlab, name: "import-target", additional_hosts: mocked_hosts }
+            def setup_gitlab_instance(gitlab_instance)
+              gitlab_instance[:instance].tap do |gitlab|
+                configure_gitlab_instance(gitlab, gitlab_instance)
+                start_mail_hog_server(gitlab_instance) if mail_hog_server_needed?(gitlab_instance)
+                gitlab.start_instance
+              end
+            end
+
+            # Configure GitLab instance
+            #
+            # @param [Gitlab::QA::Component::Gitlab] gitlab
+            # @param [Hash] gitlab_instance
+            # @return [void]
+            def configure_gitlab_instance(gitlab, gitlab_instance)
+              gitlab.name = gitlab_instance[:name]
+              gitlab.release = gitlab_instance[:release]
+              gitlab.additional_hosts = gitlab_instance[:additional_hosts]
+              gitlab.seed_admin_token = true
+            end
+
+            # Build GitLab instances
+            #
+            # @param [Gitlab::QA::Release] source_release
+            # @param [Gitlab::QA::Release] target_release
+            # @return [Array<Hash>]
+            def build_gitlab_instances(source_release, target_release)
+              [
+                { instance: source_gitlab, name: "import-source", additional_hosts: [], release: source_release },
+                { instance: target_gitlab, name: "import-target", additional_hosts: mocked_hosts, release: target_release }
               ]
+            end
+
+            # Start gitlab instance
+            #
+            # @param [Gitlab::QA::Release] source_release
+            # @param [Gitlab::QA::Release] target_release
+            # @return [void]
+            def start_gitlab_instances(source_release, target_release)
+              instances = build_gitlab_instances(source_release, target_release)
 
               ::Parallel.each(instances, in_threads: 2) do |gitlab_instance|
-                gitlab_instance[:instance].tap do |gitlab|
-                  gitlab.name = gitlab_instance[:name]
-                  gitlab.release = release
-                  gitlab.additional_hosts = gitlab_instance[:additional_hosts]
-                  gitlab.seed_admin_token = true
-
-                  gitlab.start_instance
-                end
+                setup_gitlab_instance(gitlab_instance)
               end
             end
 
@@ -71,9 +167,11 @@ module Gitlab
             #
             # @param [Array] rspec_args
             # @return [void]
-            def run_specs(rspec_args)
+            def run_specs(rspec_args) # rubocop:disable Metrics/AbcSize
+              Runtime::Logger.info("Running #{spec_suite} specs!")
+
               Component::Specs.perform do |specs|
-                specs.suite = "Test::Integration::Import"
+                specs.suite = spec_suite
                 specs.release = target_gitlab.release
                 specs.network = network
                 specs.args = [target_gitlab.address, *rspec_args]

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module QA
+    module Scenario
+      module Test
+        module Integration
+          # Scenario type for testing importers with smtp enabled in target gitlab instance
+          class ImportWithSMTP < Import
+            attr_reader :orchestrate_mail_hog_server
+
+            def initialize
+              @spec_suite = 'Test::Integration::ImportWithSMTP'
+              @orchestrate_mail_hog_server = true
+              super
+            end
+
+            def configure_omnibus(gitlab, mail_hog)
+              gitlab.omnibus_configuration << <<~OMNIBUS
+                gitlab_rails['smtp_enable'] = true;
+                gitlab_rails['smtp_address'] = '#{mail_hog.hostname}';
+                gitlab_rails['smtp_port'] = 1025;
+              OMNIBUS
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/qa/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   module QA
-    VERSION = '14.20.0'
+    VERSION = '14.21.0'
   end
 end

data/lib/gitlab/qa.rb

@@ -48,7 +48,8 @@ module Gitlab
       'registry_tls' => 'RegistryTLS',
       'jetbrains' => 'JetBrains',
       'vscode' => 'VSCode',
-      'cli_commands' => 'CLICommands'
+      'cli_commands' => 'CLICommands',
+      'import_with_smtp' => 'ImportWithSMTP'
     )
 
     loader.setup

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-qa
 version: !ruby/object:Gem::Version
-  version: 14.20.0
+  version: 14.21.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-11-11 00:00:00.000000000 Z
+date: 2024-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -470,6 +470,7 @@ files:
 - lib/gitlab/qa/scenario/test/integration/gitlab_pages.rb
 - lib/gitlab/qa/scenario/test/integration/group_saml.rb
 - lib/gitlab/qa/scenario/test/integration/import.rb
+- lib/gitlab/qa/scenario/test/integration/import_with_smtp.rb
 - lib/gitlab/qa/scenario/test/integration/instance_saml.rb
 - lib/gitlab/qa/scenario/test/integration/integrations.rb
 - lib/gitlab/qa/scenario/test/integration/jira.rb