gitlab-qa 7.25.1 → 7.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6d38407d98e8584368fc76399d9b317935ff72c3db389678582ea498dab1aa2e
-  data.tar.gz: e8d15459029b84436c36394372084d7a28607e1836dc34ef6ee3445b549d283b
+  metadata.gz: afdf52b910858a3f1ec0729d2eef2d170938d282cd116af17af424afc92fcae0
+  data.tar.gz: 1fb9f558a932a9344b774bc3d873e9184f8c31dd8472c4f51aa0a7ac0626422e
 SHA512:
-  metadata.gz: 25d386ced265585364f4482544d9d0ba72bb85dd2af7236caaae8ea1c7ac4c2af8701362eefbdd1a76ebaec8a80c7ca7b2e9cbd0fd2e935656a54f0183bb19ab
-  data.tar.gz: 48a6a13c849393cb3d3ed7ef27b5f3fab21041e1a2073fa6dc95c8b973fb34e33183b7081388ac1e5db77fc9a223f9c45e3aefb6bb8dd306fbf41f2219b8c165
+  metadata.gz: 3cb4ab49fee9a1ade2abd1125bb5a8ae020c0343a06415d74130709fd5556f715a49010ee6e9b31e1abb9b0c8ece9dc7f3f63e3c85606f21a02434ab276da030
+  data.tar.gz: bd5310d35ede8bef9b8aabc2113a76841a530b11e95e15bc87d82d45e7242b0efb7d6c170f6d2c785d7f7cf8b603c8367dc0b2994f8d1481fff2c8eab8d908a5

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

@@ -11,7 +11,7 @@ ee:cloud-activation:
     - .combined-gitlab-qa-options-script
   variables:
     QA_RSPEC_TAGS: "--tag cloud_activation"
-    GITLAB_QA_OPTIONS_COMBINED: "$GITLAB_QA_OPTIONS --seed-db license*.rb"
+    GITLAB_QA_OPTIONS_COMBINED: "$GITLAB_QA_OPTIONS --no-admin-token --seed-db license*.rb"
 
 ee:cloud-activation-quarantine:
   before_script:
@@ -27,4 +27,4 @@ ee:cloud-activation-quarantine:
     - .combined-gitlab-qa-options-script
   variables:
     QA_RSPEC_TAGS: "--tag cloud_activation"
-    GITLAB_QA_OPTIONS_COMBINED: "$GITLAB_QA_OPTIONS --seed-db license*.rb"
+    GITLAB_QA_OPTIONS_COMBINED: "$GITLAB_QA_OPTIONS --no-admin-token --seed-db license*.rb"

data/.gitlab/issue_templates/Default.md

@@ -11,3 +11,5 @@ If you feel that your issue can be categorized as a reproducible bug or a featur
 
 Thank you for helping to make GitLab a better product.
 -->
+
+<!-- template sourced from https://gitlab.com/gitlab-org/gitlab-qa/-/blob/master/.gitlab/issue_templates/Default.md -->

data/.gitlab/merge_request_templates/Default.md

@@ -44,3 +44,5 @@ This checklist encourages us to confirm any changes have been analyzed to reduce
 * [ ] I have evaluated the [MR acceptance checklist](https://docs.gitlab.com/ee/development/code_review.html#acceptance-checklist) for this MR.
 
 /label ~QA ~Quality
+
+<!-- template sourced from https://gitlab.com/gitlab-org/gitlab-qa/-/blob/master/.gitlab/merge_request_templates/Default.md -->

data/.gitlab-ci.yml

@@ -50,9 +50,8 @@ prepare:
   extends: .rules:never-on-version-change-or-tag
   script:
     - |
-      if [[ $TOP_UPSTREAM_SOURCE_PROJECT == "gitlab-org/gitlab" && -n $TOP_UPSTREAM_SOURCE_REF ]]; then
-        # Replace '\' with '-' and convert to downcase
-        export QA_IMAGE_TAG=$(echo "${TOP_UPSTREAM_SOURCE_REF//\//-}" | tr '[:upper:]' '[:lower:]')
+      if [[ $TOP_UPSTREAM_SOURCE_PROJECT == "gitlab-org/gitlab" && -n $TOP_UPSTREAM_SOURCE_SHA ]]; then
+        export QA_IMAGE_TAG=${TOP_UPSTREAM_SOURCE_SHA}
       else
         export QA_IMAGE_TAG=master
       fi

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

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+# rubocop:disable Metrics/AbcSize
 
 require 'securerandom'
 require 'net/http'
@@ -14,7 +15,7 @@ module Gitlab
         extend Forwardable
 
         attr_reader :release, :omnibus_configuration, :omnibus_gitlab_rails_env
-        attr_accessor :tls, :skip_availability_check, :runner_network
+        attr_accessor :tls, :skip_availability_check, :runner_network, :seed_admin_token, :seed_db
         attr_writer :name, :relative_path
 
         def_delegators :release, :tag, :image, :edition
@@ -42,8 +43,10 @@ module Gitlab
           @volumes[@gitlab_cert_path] = SSL_PATH
           @volumes[@authority_cert_path] = TRUSTED_PATH
 
+          @seed_admin_token = Runtime::Scenario.seed_admin_token
+          @seed_db = Runtime::Scenario.seed_db
+
           self.release = 'CE'
-          self.exec_commands += seed_test_data_command if Runtime::Scenario.seed_db
         end
 
         def set_formless_login_token
@@ -171,9 +174,13 @@ module Gitlab
         end
 
         def process_exec_commands
-          @docker.copy(name, DATA_SEED_PATH, DATA_PATH) if Runtime::Scenario.seed_db
+          @docker.copy(name, DATA_SEED_PATH, DATA_PATH) if seed_admin_token || seed_db
+
+          self.exec_commands += seed_admin_token_command if seed_admin_token
+          self.exec_commands += seed_test_data_command if seed_db
 
-          exec_commands.each { |command| @docker.exec(name, command) }
+          Runtime::Logger.info("Running exec_commands...")
+          exec_commands.flatten.uniq.each { |command| @docker.exec(name, command) }
         end
 
         def sha_version
@@ -231,6 +238,10 @@ module Gitlab
           cmd.uniq
         end
 
+        def seed_admin_token_command
+          ["gitlab-rails runner #{DATA_PATH}/admin_access_token_seed.rb"]
+        end
+
         class Availability
           def initialize(name, relative_path: '', scheme: 'http', protocol_port: 80)
             @docker = Docker::Engine.new
@@ -276,3 +287,4 @@ module Gitlab
     end
   end
 end
+# rubocop:enable Metrics/AbcSize

data/lib/gitlab/qa/report/gitlab_issue_client.rb

@@ -101,6 +101,18 @@ module Gitlab
           end
         end
 
+        def upload_file(file_fullpath:)
+          ignore_gitlab_client_exceptions do
+            Gitlab.upload_file(project, file_fullpath)
+          end
+        end
+
+        def ignore_gitlab_client_exceptions
+          yield
+        rescue StandardError, SystemCallError, OpenSSL::SSL::SSLError, Net::OpenTimeout, Net::ReadTimeout, Gitlab::Error::Error => e
+          puts "Ignoring the following error: #{e}"
+        end
+
         def handle_gitlab_client_exceptions
           yield
         rescue Gitlab::Error::NotFound

data/lib/gitlab/qa/report/relate_failure_issue.rb

@@ -72,6 +72,8 @@ module Gitlab
           issue = super
           puts "for test '#{test.name}'."
 
+          post_or_update_failed_job_note(issue, test)
+
           issue
         end
 
@@ -158,7 +160,8 @@ module Gitlab
             "\n\n### Stack trace",
             "```\n#{test.failures.first['message_lines'].join("\n")}\n```",
             "First happened in #{test.ci_job_url}.",
-            "Related test case: #{test.testcase}."
+            "Related test case: #{test.testcase}.",
+            screenshot_section(test)
           ].join("\n\n")
         end
 
@@ -194,6 +197,18 @@ module Gitlab
 
           false
         end
+
+        def screenshot_section(test)
+          section = ''
+
+          if test.screenshot? && !test.failures.first['message'].include?('500 Internal Server Error')
+            relative_url = gitlab.upload_file(file_fullpath: test.failure_screenshot)
+
+            section = "### Screenshot: #{relative_url.markdown}"
+          end
+
+          section
+        end
       end
     end
   end

data/lib/gitlab/qa/report/test_result.rb

@@ -95,6 +95,14 @@ module Gitlab
             report['quarantine']['issue'] if quarantine?
           end
 
+          def screenshot?
+            report['screenshot'].present?
+          end
+
+          def failure_screenshot
+            report['screenshot']['image'] if screenshot?
+          end
+
           private
 
           # rubocop:disable Metrics/AbcSize

data/lib/gitlab/qa/report/update_screenshot_path.rb

@@ -1,4 +1,6 @@
 require 'nokogiri'
+require 'json'
+require 'active_support/core_ext/object/blank'
 
 module Gitlab
   module QA
@@ -9,30 +11,50 @@ module Gitlab
         end
 
         REGEX = %r{(?<gitlab_qa_run>gitlab-qa-run-.*?(?=\/))\/(?<gitlab_ce_ee_qa>gitlab-(ee|ce)-qa-.*?(?=\/))}
+        CONTAINER_PATH = File.join(Docker::Volumes::QA_CONTAINER_WORKDIR, 'tmp').freeze
 
         def invoke!
           Dir.glob(@files).each do |rspec_report_file|
-            report = rewrite_each_screenshot_path(rspec_report_file)
+            match_data = rspec_report_file.match(REGEX)
+            artifact_path = "#{match_data[:gitlab_qa_run]}/#{match_data[:gitlab_ce_ee_qa]}"
 
-            File.write(rspec_report_file, report)
+            xml_report = rewrite_each_xml_screenshot_path(rspec_report_file, artifact_path)
+
+            File.write(rspec_report_file, xml_report)
 
             puts "Saved #{rspec_report_file}"
+
+            json_rspec_report_file = rspec_report_file.gsub('.xml', '.json')
+            json_report = rewrite_each_json_screenshot_path(json_rspec_report_file, artifact_path)
+
+            File.write(json_rspec_report_file, json_report)
+
+            puts "Saved #{json_rspec_report_file}"
           end
         end
 
         private
 
-        def rewrite_each_screenshot_path(rspec_report_file)
+        def rewrite_each_xml_screenshot_path(rspec_report_file, artifact_path)
           report = Nokogiri::XML(File.open(rspec_report_file))
 
-          match_data = rspec_report_file.match(REGEX)
-
           report.xpath('//system-out').each do |system_out|
-            system_out.content = system_out.content.gsub(File.join(Docker::Volumes::QA_CONTAINER_WORKDIR, 'tmp'), "#{match_data[:gitlab_qa_run]}/#{match_data[:gitlab_ce_ee_qa]}")
+            system_out.content = system_out.content.gsub(CONTAINER_PATH, artifact_path)
           end
 
           report.to_s
         end
+
+        def rewrite_each_json_screenshot_path(json_rspec_report_file, artifact_path)
+          report = JSON.parse(File.read(json_rspec_report_file))
+          examples = report['examples']
+
+          examples.each do |example|
+            example['screenshot']['image'] = example['screenshot']['image'].gsub(CONTAINER_PATH, artifact_path) if example['screenshot'].present?
+          end
+
+          JSON.pretty_generate(report)
+        end
       end
     end
   end

data/lib/gitlab/qa/runner.rb

@@ -13,6 +13,8 @@ module Gitlab
         Runtime::Scenario.define(:qa_image, Runtime::Env.qa_image) if Runtime::Env.qa_image
         Runtime::Scenario.define(:omnibus_configuration, Runtime::OmnibusConfiguration.new)
         Runtime::Scenario.define(:seed_db, false)
+        Runtime::Scenario.define(:seed_admin_token, true) # Create an admin access token for root user by default
+        Runtime::Scenario.define(:omnibus_exec_commands, [])
 
         # Omnibus Configurators specified by flags
         @active_configurators = []
@@ -31,6 +33,10 @@ module Gitlab
             Runtime::Scenario.define(:teardown, false)
           end
 
+          opts.on('--no-admin-token', 'Skip admin token creation for root user') do
+            Runtime::Scenario.define(:seed_admin_token, 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
@@ -135,6 +141,7 @@ module Gitlab
             # # Runtime::OmnibusConfiguration::Packages
             # gitlab_rails['packages_enabled'] = true
             Runtime::Scenario.omnibus_configuration << "# #{configurator.class.name}"
+            Runtime::Scenario.omnibus_exec_commands << configurator.exec_commands
 
             # Load the configuration
             configurator.configuration.split("\n").each { |c| Runtime::Scenario.omnibus_configuration << c }

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

@@ -33,7 +33,7 @@ module Gitlab
         # @return Any instance of [Gitlab::QA::Component::Base]
         def prepare; end
 
-        # Commands to execute before GitLab boots
+        # Commands to execute before tests are run against GitLab (after reconfigure)
         def exec_commands
           []
         end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module QA
+    module Runtime
+      module OmnibusConfigurations
+        class CiDecomposition < Default
+          def configuration
+            # HACK: commenting commands out as these commands should be run *after* the first
+            # reconfiguration (see first command in #exec_commands)
+            <<~OMNIBUS
+              #gitlab_rails['databases']['main']['enable'] = true
+              #gitlab_rails['databases']['ci']['enable'] = true
+              #gitlab_rails['databases']['ci']['db_database'] = 'gitlabhq_production_ci'
+            OMNIBUS
+          end
+
+          def exec_commands
+            [
+              "sed -i 's/#gitlab_rails/gitlab_rails/g' /etc/gitlab/gitlab.rb",
+              "gitlab-ctl reconfigure",
+              "gitlab-psql -c 'create database gitlabhq_production_ci owner gitlab'",
+              "gitlab-psql -d gitlabhq_production_ci -c 'create extension btree_gist'",
+              "gitlab-psql -d gitlabhq_production_ci -c 'create extension pg_trgm'",
+              "gitlab-rake db:structure:load:ci"
+            ].freeze
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -27,6 +27,7 @@ module Gitlab
                 specs.suite = @suite
                 specs.release = release
                 specs.args = non_rspec_args.push(*args)
+                specs.volumes[host_knapsack_report_path] = "/home/gitlab/qa/knapsack" if host_knapsack_report_path
               end
             end
 
@@ -37,6 +38,10 @@ module Gitlab
             def deployment_component
               raise NotImplementedError, 'Please define the Component for the deployment environment associated with this scenario.'
             end
+
+            def host_knapsack_report_path
+              ENV["QA_KNAPSACK_REPORT_PATH"]
+            end
           end
         end
       end

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

@@ -16,6 +16,7 @@ module Gitlab
                 primary.release = release
                 primary.name = 'gitlab-primary'
                 primary.network = 'geo'
+                primary.seed_admin_token = false
                 primary.omnibus_configuration << <<~OMNIBUS
                   gitlab_rails['db_key_base'] = '4dd58204865eb41bca93bd38131d51cc';
                   geo_primary_role['enable'] = true;
@@ -54,7 +55,7 @@ module Gitlab
                       sidekiq['concurrency'] = 2;
                       puma['worker_processes'] = 2;
                     OMNIBUS
-                    secondary.exec_commands = fast_ssh_key_lookup_commands + QA::Scenario::CLICommands.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

@@ -37,6 +37,7 @@ module Gitlab
                 praefect.name = @praefect_node_name
                 praefect.network = @network
                 praefect.skip_availability_check = true
+                praefect.seed_admin_token = false
 
                 praefect.omnibus_configuration << praefect_omnibus_configuration
 
@@ -196,6 +197,7 @@ module Gitlab
                 gitaly.name = name
                 gitaly.network = @network
                 gitaly.skip_availability_check = true
+                gitaly.seed_admin_token = false
                 gitaly.omnibus_configuration << gitaly_omnibus_configuration
                 gitaly.instance(skip_teardown: true)
               end

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

@@ -19,6 +19,7 @@ module Gitlab
                 gitaly.name = @gitaly_name
                 gitaly.network = @network
                 gitaly.skip_availability_check = true
+                gitaly.seed_admin_token = false
 
                 gitaly.omnibus_configuration << gitaly_omnibus
                 gitaly.gitaly_tls

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

@@ -16,6 +16,7 @@ module Gitlab
                   gitlab.release = previous_release
                   gitlab.volumes = volumes
                   gitlab.network = 'test'
+                  gitlab.seed_admin_token = false
                   gitlab.launch_and_teardown_instance
                 end
 

data/lib/gitlab/qa/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   module QA
-    VERSION = '7.25.1'
+    VERSION = '7.26.0'
   end
 end

data/lib/gitlab/qa.rb

@@ -20,6 +20,7 @@ module Gitlab
         autoload :ObjectStorageGcs, 'gitlab/qa/runtime/omnibus_configurations/object_storage_gcs'
         autoload :LicenseMode, 'gitlab/qa/runtime/omnibus_configurations/license_mode'
         autoload :RegistryObjectStorage, 'gitlab/qa/runtime/omnibus_configurations/registry_object_storage'
+        autoload :CiDecomposition, 'gitlab/qa/runtime/omnibus_configurations/ci_decomposition'
       end
     end
 

data/support/data/admin_access_token_seed.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+class AdminAccessTokenSeed
+  TOKEN_VALUE = 'yF4CpxN55A1V0sHMuYQa'
+  SCOPES = Gitlab::Auth.all_available_scopes
+
+  def self.seed!
+    admin_user = User.find_by(username: 'root')
+
+    token_params = {
+      scopes: SCOPES.map(&:to_s),
+      name: 'admin-api-token'
+    }
+
+    admin_user.personal_access_tokens.build(token_params).tap do |pat|
+      pat.set_token(TOKEN_VALUE)
+      pat.save!
+    end
+
+    puts 'Personal access token seeded for root user.'
+  end
+end
+
+AdminAccessTokenSeed.seed!

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-qa
 version: !ruby/object:Gem::Version
-  version: 7.25.1
+  version: 7.26.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-05-03 00:00:00.000000000 Z
+date: 2022-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -335,6 +335,7 @@ files:
 - lib/gitlab/qa/runtime/env.rb
 - lib/gitlab/qa/runtime/logger.rb
 - lib/gitlab/qa/runtime/omnibus_configuration.rb
+- lib/gitlab/qa/runtime/omnibus_configurations/ci_decomposition.rb
 - lib/gitlab/qa/runtime/omnibus_configurations/default.rb
 - lib/gitlab/qa/runtime/omnibus_configurations/license_mode.rb
 - lib/gitlab/qa/runtime/omnibus_configurations/object_storage.rb
@@ -398,6 +399,7 @@ files:
 - lib/gitlab/qa/test_logger.rb
 - lib/gitlab/qa/version.rb
 - scripts/generate-qa-jobs.rb
+- support/data/admin_access_token_seed.rb
 - support/data/license_usage_seed.rb
 - tls_certificates/authority/ca.crt
 - tls_certificates/authority/ca.key