gitlab-qa 4.12.0 → 4.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: be29a5a9db9ec0e8bf2978867441705138f451eeff78486fd648f963e152fce7
-  data.tar.gz: 538e0b25c50c493488073e04861d634730ecd4b7da7482adacce44501ccc2fc8
+  metadata.gz: 2752708af7bf59c627137ef9d097e5994bf9f80a619b3fac817f24cde5c92c85
+  data.tar.gz: 839f552e6b8d94633aa45db829c1886f08c3cb62fdeb72a6ea108f2c28f2b494
 SHA512:
-  metadata.gz: 63e172af2327cb4dbd5e8ab5f6edaa8a78621ca65d428a9aa659b2d6ae8f4405a42a1bdb0fd77b8f922c087c5cd38d57bee30bdc526071e0ff108c1ac92ccbf1
-  data.tar.gz: 58d2f017bf496c78cb634bb242d17fa5ba81a2d48b26eaeb928e2d516249f2c93185079c98807962bef10dca1fca62420c8b8a14e2041e3942008dc1aa3e1f12
+  metadata.gz: bcf336cc8dc394e4743fa0295ed290043b08eda968b3bd4c5c371a1eadb284a74e6a0f5d123c03bcca72f3b19cd45253386de82106049020bfb1d0f1bbe54d29
+  data.tar.gz: f2663a7e7c9d588591feae456c29aaac2669dd382864fa900d45347eece9c92b187f250d3dfeb995596a76178da15a6ec326e4dc857dd026cd40e399e31d509d

data/.gitlab-ci.yml

@@ -27,6 +27,7 @@ before_script:
   - if [ -n "$TRIGGERED_USER" ] && [ -n "$TRIGGER_SOURCE" ]; then
       echo "Pipeline triggered by $TRIGGERED_USER at $TRIGGER_SOURCE";
     fi
+  - export LANG=C.UTF-8
 
 check:rubocop:
   stage: check
@@ -395,7 +396,7 @@ ee:elasticsearch:
     - .high-capacity
     - .ee-qa
     - .rspec-report-opts
-    
+
 ce:praefect:
   script:
     - exe/gitlab-qa Test::Integration::Praefect ${RELEASE:=CE} -- $RSPEC_REPORT_OPTS
@@ -420,6 +421,24 @@ ee:praefect:
   parallel: 5
   when: manual
 
+ce:smtp:
+  script:
+    - exe/gitlab-qa Test::Integration::SMTP ${RELEASE:=CE} -- $RSPEC_REPORT_OPTS
+  extends:
+    - .test
+    - .high-capacity
+    - .ce-qa
+    - .rspec-report-opts
+
+ee:smtp:
+  script:
+    - exe/gitlab-qa Test::Integration::SMTP ${RELEASE:=EE} -- $RSPEC_REPORT_OPTS
+  extends:
+    - .test
+    - .high-capacity
+    - .ee-qa
+    - .rspec-report-opts
+
 .report-base:
   image: ruby:2.6-alpine
   variables:

data/docs/what_tests_can_be_run.md

@@ -494,6 +494,25 @@ Example:
 $ gitlab-qa Test::Integration::Praefect EE
 ```
 
+### `Test::Integration::SMTP CE|EE|<full image address>`
+
+This tests SMTP notification email delivery from Gitlab by using
+[MailHog](https://github.com/mailhog/MailHog) as MTA.
+It starts up a Docker container for MailHog and sets the Omnibus configuration
+to use it for SMTP delivery. The MailHog container will expose the configured
+port for SMTP delivery, and also another port for the HTTP MailHog API used for
+querying the delivered messages.
+
+To run tests against the GitLab container, a GitLab QA (`gitlab/gitlab-qa`)
+container is spun up and tests are run from it by running the
+`Test::Integration::SMTP` scenario.
+
+Example:
+
+```
+$ gitlab-qa Test::Integration::SMTP CE
+```
+
 ### `Test::Instance::Any CE|EE|<full image address>:nightly|latest|any_tag http://your.instance.gitlab`
 
 This tests that a live GitLab instance works as expected by running tests

data/lib/gitlab/qa.rb

@@ -46,6 +46,7 @@ module Gitlab
           autoload :Packages, 'gitlab/qa/scenario/test/integration/packages'
           autoload :Praefect, 'gitlab/qa/scenario/test/integration/praefect'
           autoload :Elasticsearch, 'gitlab/qa/scenario/test/integration/elasticsearch'
+          autoload :SMTP, 'gitlab/qa/scenario/test/integration/smtp'
         end
 
         module Sanity
@@ -65,6 +66,7 @@ module Gitlab
       autoload :Minio, 'gitlab/qa/component/minio'
       autoload :Preprod, 'gitlab/qa/component/preprod'
       autoload :Elasticsearch, 'gitlab/qa/component/elasticsearch'
+      autoload :MailHog, 'gitlab/qa/component/mail_hog'
     end
 
     module Support

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

@@ -0,0 +1,77 @@
+# This component sets up the MailHog (https://github.com/mailhog/MailHog)
+# image with the proper configuration for SMTP email delivery from Gitlab
+
+module Gitlab
+  module QA
+    module Component
+      class MailHog
+        include Scenario::Actable
+
+        MAILHOG_IMAGE = 'mailhog/mailhog'.freeze
+        MAILHOG_IMAGE_TAG = 'v1.0.0'.freeze
+
+        attr_reader :docker
+        attr_accessor :environment, :network
+        attr_writer :name
+
+        def initialize
+          @docker = Docker::Engine.new
+          @environment = {}
+        end
+
+        def name
+          @name ||= "mailhog"
+        end
+
+        def hostname
+          "#{name}.#{network}"
+        end
+
+        def instance
+          raise 'Please provide a block!' unless block_given?
+
+          prepare
+          start
+
+          yield self
+        ensure
+          teardown
+        end
+
+        def prepare
+          @docker.pull(MAILHOG_IMAGE, MAILHOG_IMAGE_TAG)
+
+          return if @docker.network_exists?(network)
+
+          @docker.network_create(network)
+        end
+
+        def start
+          docker.run(MAILHOG_IMAGE, MAILHOG_IMAGE_TAG) do |command|
+            command << '-d '
+            command << "--name #{name}"
+            command << "--net #{network}"
+            command << "--hostname #{hostname}"
+            command << "--publish 1025:1025"
+            command << "--publish 8025:8025"
+          end
+        end
+
+        def restart
+          @docker.restart(name)
+        end
+
+        def teardown
+          raise 'Invalid instance name!' unless name
+
+          @docker.stop(name)
+          @docker.remove(name)
+        end
+
+        def set_mailhog_hostname
+          ::Gitlab::QA::Runtime::Env.mailhog_hostname = hostname
+        end
+      end
+    end
+  end
+end

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

@@ -56,6 +56,7 @@ module Gitlab
           'KNAPSACK_TEST_FILE_PATTERN' => :knapsack_test_file_pattern,
           'KNAPSACK_TEST_DIR' => :knapsack_test_dir,
           'CI' => :ci,
+          'CI_RUNNER_ID' => :ci_runner_id,
           'CI_NODE_INDEX' => :ci_node_index,
           'CI_NODE_TOTAL' => :ci_node_total,
           'GITLAB_CI' => :gitlab_ci,
@@ -66,7 +67,8 @@ module Gitlab
           'GITLAB_QA_1P_SECRET' => :gitlab_qa_1p_secret,
           'GITLAB_QA_1P_GITHUB_UUID' => :gitlab_qa_1p_github_uuid,
           'GITLAB_QA_LOOP_RUNNER_MINUTES' => :gitlab_qa_loop_runner_minutes,
-          'QA_CAN_TEST_ADMIN_FEATURES' => :qa_can_test_admin_features
+          'QA_CAN_TEST_ADMIN_FEATURES' => :qa_can_test_admin_features,
+          'MAILHOG_HOSTNAME' => :mailhog_hostname
         }.freeze
 
         ENV_VARIABLES.each_value do |accessor|

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

@@ -0,0 +1,58 @@
+require 'yaml'
+
+module Gitlab
+  module QA
+    module Scenario
+      module Test
+        module Integration
+          class SMTP < Scenario::Template
+            def initialize
+              @gitlab_name = 'gitlab-smtp'
+              @spec_suite = 'Test::Integration::SMTP'
+            end
+
+            attr_reader :gitlab_name, :spec_suite
+
+            def configure_omnibus(gitlab, mail_hog)
+              gitlab.omnibus_config = <<~OMNIBUS
+                    gitlab_rails['smtp_enable'] = true;
+                    gitlab_rails['smtp_address'] = '#{mail_hog.hostname}';
+                    gitlab_rails['smtp_port'] = 1025
+              OMNIBUS
+            end
+
+            def perform(release, *rspec_args)
+              release = Release.new(release)
+
+              Component::Gitlab.perform do |gitlab|
+                gitlab.release = release
+                gitlab.network = 'test'
+                gitlab.name = gitlab_name
+
+                Component::MailHog.perform do |mail_hog|
+                  mail_hog.network = gitlab.network
+                  mail_hog.set_mailhog_hostname
+
+                  configure_omnibus(gitlab, mail_hog)
+
+                  mail_hog.instance do
+                    gitlab.instance do
+                      puts "Running #{spec_suite} specs!"
+
+                      Component::Specs.perform do |specs|
+                        specs.suite = spec_suite
+                        specs.release = release
+                        specs.network = gitlab.network
+                        specs.args = [gitlab.address, *rspec_args]
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/qa/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   module QA
-    VERSION = '4.12.0'.freeze
+    VERSION = '4.13.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-qa
 version: !ruby/object:Gem::Version
-  version: 4.12.0
+  version: 4.13.0
 platform: ruby
 authors:
 - Grzegorz Bizon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-02 00:00:00.000000000 Z
+date: 2019-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -168,6 +168,7 @@ files:
 - lib/gitlab/qa/component/gitlab.rb
 - lib/gitlab/qa/component/internet_tunnel.rb
 - lib/gitlab/qa/component/ldap.rb
+- lib/gitlab/qa/component/mail_hog.rb
 - lib/gitlab/qa/component/minio.rb
 - lib/gitlab/qa/component/preprod.rb
 - lib/gitlab/qa/component/production.rb
@@ -207,6 +208,7 @@ files:
 - lib/gitlab/qa/scenario/test/integration/packages.rb
 - lib/gitlab/qa/scenario/test/integration/praefect.rb
 - lib/gitlab/qa/scenario/test/integration/saml.rb
+- lib/gitlab/qa/scenario/test/integration/smtp.rb
 - lib/gitlab/qa/scenario/test/omnibus/image.rb
 - lib/gitlab/qa/scenario/test/omnibus/update.rb
 - lib/gitlab/qa/scenario/test/omnibus/upgrade.rb