gitlab-qa 8.8.0 → 8.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e89c4046779c498fad14fac05a4cc8ab68deb9d4ccb62e8eabaaace6af8be17d
-  data.tar.gz: a0c72ba4f7278b82f59678133578e11f23cb7e39449a82c21ec7beb967a524cc
+  metadata.gz: 0ffa49a5a85a5e660bb61689d01b0a7daa3a0004f7e05e5a9100dd83dbeeea55
+  data.tar.gz: 8f158219d4c59b3db6181534eafdd55e5ca2abbcae1a0402c4f80d3f8c77fa82
 SHA512:
-  metadata.gz: 7847ac077692217f68224ca9fdd31bcdadb833aa4aca0ab16113caf1efe6e1013689bca536d2b4c2b5fb3cd5d6e77a58f36b31e2b7c62d00f49abc66c2d0e683
-  data.tar.gz: 97e98ce591bb8a7cc2a804b1d1326605df8f68e0561cff27e235ddc48420be385794d8dd02ce635adafabd443b1e3f8ab9f4e4d194949b0fb91aedc06e243f32
+  metadata.gz: 7cb6f4b7197625d3db353048368716a80e7bdf17e7060cfaadf90a13d44c96805c76e396b3fa78a6e777dacad191305c12ec78e8c9e8920d3a09100f7d2ebd56
+  data.tar.gz: cfec5285a2a0d54986d3984f333497082911febee8d3a368dc2be3f81d04753e2c8a726bd8515d1be62181a591077eb4c47555865e1fc331ace507289adc47a3

data/.gitlab/ci/jobs/gitlab_pages.gitlab-ci.yml

@@ -0,0 +1,19 @@
+ce:gitlab_pages:
+  extends:
+    - .rules:ce-never-when-triggered-by-feature-flag-definition-change
+    - .test
+    - .high-capacity
+    - .ce-variables
+    - .rspec-report-opts
+  variables:
+    QA_SCENARIO: "Test::Integration::GitlabPages"
+
+ee:gitlab_pages:
+  extends:
+    - .rules:ee-never-when-triggered-by-feature-flag-definition-change
+    - .test
+    - .high-capacity
+    - .ee-variables
+    - .rspec-report-opts
+  variables:
+    QA_SCENARIO: "Test::Integration::GitlabPages"

data/.gitlab-ci.yml

@@ -100,6 +100,7 @@ generate-jobs:
     - bundle exec bin/qa Test::Instance::All http://dummy.test --count-examples-only -- $QA_TESTS --tag repository_storage
     - bundle exec bin/qa Test::Instance::All http://dummy.test --count-examples-only -- $QA_TESTS --tag packages
     - bundle exec bin/qa Test::Instance::All http://dummy.test --count-examples-only -- $QA_TESTS --tag integrations
+    - bundle exec bin/qa Test::Instance::All http://dummy.test --count-examples-only -- $QA_TESTS --tag gitlab_pages
     - bundle exec bin/qa Test::Instance::All http://dummy.test --count-examples-only -- $QA_TESTS --tag mtls
     - bundle exec bin/qa Test::Instance::All http://dummy.test --count-examples-only -- $QA_TESTS --tag jira
     - bundle exec bin/qa Test::Instance::All http://dummy.test --count-examples-only -- $QA_TESTS --tag can_use_large_setup

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab-qa (8.8.0)
+    gitlab-qa (8.9.0)
       activesupport (~> 6.1)
       gitlab (~> 4.18.0)
       http (~> 5.0)

data/docs/release_process.md

@@ -34,4 +34,8 @@ Note: The `gem-release` job uses:
 - the `GITLAB_API_TOKEN` environment variable to authenticate against GitLab.com's API in order to create the tag
 - the `GEM_HOST_API_KEY` environment variable to authenticate against Rubygems.org's API in order to release the gem
 
+## Post-release maintenance
+
+Please note that `gitlab-qa` version in `gitlab-org/gitlab` project will be updated automatically by [renovate-gitlab-bot](https://gitlab.com/gitlab-org/frontend/renovate-gitlab-bot). However, for live environment pipelines we need to specify the version in `pipeline-common` project manually. Remember to open an MR updating `GITLAB_QA_VERSION` value in [base.gitlab-ci.yml](https://gitlab.com/gitlab-org/quality/pipeline-common/-/blob/master/ci/base.gitlab-ci.yml#L4) shortly after the new version is released.
+
 [`lib/gitlab/qa/version.rb`]: https://gitlab.com/gitlab-org/gitlab-qa/blob/master/lib/gitlab/qa/version.rb#L3

data/docs/what_tests_can_be_run.md

@@ -368,6 +368,22 @@ Example:
 $ gitlab-qa Test::Integration::GitalyCluster EE
 ```
 
+### `Test::Integration::GitlabPages CE|EE|<full image address>`
+
+This tests that a GitLab Instance works as expected with [GitLab Pages](https://docs.gitlab.com/ee/user/project/pages/) enabled.
+
+The scenario configures the instance by setting up these instructions [here](https://gitlab.com/gitlab-org/gitlab-development-kit/blob/main/doc/howto/pages.md) through enabling `gitlab_pages['enable'] = true;`, setting up an external url and the adding of the GitLab Pages hostname and GitLab Instance IP into the `etc/hostfile` on the container that runs the specs so it can access the page on the GitLab container.
+
+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::Instance::All` scenario with the `:gitlab_pages` tag.
+
+Example:
+
+```
+$ gitlab-qa Test::Integration::GitlabPages EE
+```
+
 ### `Test::Integration::LDAPNoTLS CE|EE|<full image address>`
 
 This tests that a GitLab instance works as expected with an external

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

@@ -51,6 +51,10 @@ module Gitlab
           teardown unless skip_teardown
         end
 
+        def ip_address
+          docker.inspect(name) { |command| command << "-f '{{range.NetworkSettings.Networks}}{{.IPAddress}}{{end}}'" }
+        end
+
         alias_method :launch_and_teardown_instance, :instance
 
         def prepare

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:disable Metrics/CyclomaticComplexity
 
 require 'securerandom'
 
@@ -10,12 +11,13 @@ module Gitlab
       # the `qa/` directory located in GitLab CE / EE repositories.
       #
       class Specs < Scenario::Template
-        attr_accessor :suite, :release, :network, :args, :volumes, :env, :runner_network, :hostname
+        attr_accessor :suite, :release, :network, :args, :volumes, :env, :runner_network, :hostname, :additional_hosts
 
         def initialize
           @docker = Docker::Engine.new(stream_output: true) # stream test output directly instead of through logger
           @env = {}
           @volumes = {}
+          @additional_hosts = []
           @default_volumes = { '/var/run/docker.sock' => '/var/run/docker.sock' }
           return if Runtime::Env.qa_knapsack_report_path.blank?
 
@@ -56,8 +58,8 @@ module Gitlab
                 command.env('QA_HOSTNAME', hostname)
               end
 
-              unless Runtime::Env.docker_add_hosts.empty?
-                hosts = Runtime::Env.docker_add_hosts.map { |host| "--add-host=#{host} " }.join
+              if Runtime::Env.docker_add_hosts.present? || additional_hosts.present?
+                hosts = Runtime::Env.docker_add_hosts.concat(additional_hosts).map { |host| "--add-host=#{host} " }.join
                 command << hosts # override /etc/hosts in docker container when test runs
               end
 
@@ -111,3 +113,4 @@ module Gitlab
     end
   end
 end
+# rubocop:enable Metrics/CyclomaticComplexity

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

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module QA
+    module Scenario
+      module Test
+        module Integration
+          class GitlabPages < Scenario::Template
+            def initialize
+              @gitlab_name = 'gitlab-pages'
+              @network = 'test'
+              @pages_host = 'gitlab-pages.test'
+              @pages_sandbox_name = 'gitlab-qa-sandbox-group-pages'
+              @tag = 'gitlab_pages'
+            end
+
+            def gitlab_omnibus_configuration
+              <<~OMNIBUS
+                  pages_external_url 'http://#{@gitlab_name}.#{@network}';
+                  gitlab_pages['enable'] = true;
+              OMNIBUS
+            end
+
+            def set_sandbox_name(sandbox_name)
+              ::Gitlab::QA::Runtime::Env.gitlab_sandbox_name = sandbox_name
+            end
+
+            def perform(release, *rspec_args)
+              Component::Gitlab.perform do |gitlab|
+                gitlab.release = QA::Release.new(release)
+                gitlab.name = @gitlab_name
+                gitlab.network = @network
+
+                set_sandbox_name(@pages_sandbox_name)
+
+                gitlab.omnibus_configuration << gitlab_omnibus_configuration
+                gitlab.instance do
+                  if @tag
+                    rspec_args << "--" unless rspec_args.include?('--')
+                    rspec_args << "--tag" << @tag
+                  end
+
+                  Component::Specs.perform do |specs|
+                    specs.additional_hosts << "#{@pages_sandbox_name}.#{@pages_host}:#{gitlab.ip_address}"
+                    specs.suite = 'Test::Instance::All'
+                    specs.release = gitlab.release
+                    specs.network = gitlab.network
+                    specs.args = [gitlab.address, *rspec_args]
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/qa/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   module QA
-    VERSION = '8.8.0'
+    VERSION = '8.9.0'
   end
 end

data/scripts/generate-qa-jobs.rb

@@ -40,6 +40,7 @@ class GenerateQAJobs
     jobs.merge!(load_yml_contents('opensearch', should_automatically_run?('test_integration_opensearch')))
     jobs.merge!(load_yml_contents('praefect', should_automatically_run?('test_instance_all')))
     jobs.merge!(load_yml_contents('gitaly_cluster', should_automatically_run?('test_instance_all')))
+    jobs.merge!(load_yml_contents('gitlab_pages', should_automatically_run?('test_instance_all_gitlab_pages')))
     jobs.merge!(load_yml_contents('mtls', should_automatically_run?('test_instance_all_mtls')))
     jobs.merge!(load_yml_contents('smtp', should_automatically_run?('test_integration_smtp')))
     jobs.merge!(load_yml_contents('jira', should_automatically_run?('test_instance_all_jira')))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-qa
 version: !ruby/object:Gem::Version
-  version: 8.8.0
+  version: 8.9.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-19 00:00:00.000000000 Z
+date: 2022-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -268,6 +268,7 @@ files:
 - ".gitlab/ci/jobs/elasticsearch.gitlab-ci.yml"
 - ".gitlab/ci/jobs/geo.gitlab-ci.yml"
 - ".gitlab/ci/jobs/gitaly_cluster.gitlab-ci.yml"
+- ".gitlab/ci/jobs/gitlab_pages.gitlab-ci.yml"
 - ".gitlab/ci/jobs/group_saml.gitlab-ci.yml"
 - ".gitlab/ci/jobs/instance.gitlab-ci.yml"
 - ".gitlab/ci/jobs/instance_saml.gitlab-ci.yml"
@@ -416,6 +417,7 @@ files:
 - lib/gitlab/qa/scenario/test/integration/elasticsearch.rb
 - lib/gitlab/qa/scenario/test/integration/geo.rb
 - lib/gitlab/qa/scenario/test/integration/gitaly_cluster.rb
+- lib/gitlab/qa/scenario/test/integration/gitlab_pages.rb
 - lib/gitlab/qa/scenario/test/integration/group_saml.rb
 - lib/gitlab/qa/scenario/test/integration/instance_saml.rb
 - lib/gitlab/qa/scenario/test/integration/integrations.rb