gitlab-qa 7.24.4 → 7.25.0

data/Dangerfile

@@ -1,9 +1,7 @@
 require 'gitlab-dangerfiles'
 
 Gitlab::Dangerfiles.for_project(self) do |dangerfiles|
-  # Import all plugins from the gem
   dangerfiles.import_plugins
 
-  # Import only a subset of rules
-  dangerfiles.import_dangerfiles(only: %w[changes_size commit_messages simple_roulette])
+  dangerfiles.import_dangerfiles(except: %w[changelog])
 end

data/docs/what_tests_can_be_run.md

@@ -818,6 +818,21 @@ $ export GITLAB_PASSWORD="$GITLAB_QA_PASSWORD"
 $ gitlab-qa Test::Instance::StagingGeo
 ```
 
+### `Test::Instance::StagingRefGeo`
+
+This scenario tests that the Geo staging deployment (with [`staging-ref.gitlab.com`](https://staging-ref.gitlab.com) as the primary site and [`geo.staging-ref.gitlab.com`](https://geo.staging-ref.gitlab.com) as the secondary site) works as expected by running tests tagged `:geo` against it. This is done by spinning up a GitLab QA (`gitlab/gitlab-qa`) container and running the `QA::EE::Scenario::Test::Geo` scenario. Note that the Geo setup steps in the `QA::EE::Scenario::Test::Geo` scenario are skipped when testing a live Geo deployment.
+
+Scenario requirements are the same as [`Test::Instance::StagingGeo`](#testinstancestaginggeo) described above.
+
+```
+$ export GITLAB_QA_ACCESS_TOKEN=your_api_access_token
+$ export GITLAB_QA_DEV_ACCESS_TOKEN=your_dev_registry_access_token
+$ export GITLAB_USERNAME="gitlab-qa"
+$ export GITLAB_PASSWORD="$GITLAB_QA_PASSWORD"
+
+$ gitlab-qa Test::Instance::StagingRefGeo
+```
+
 ### `Test::Instance::Production`
 
 This scenario functions the same as `Test::Instance::Staging`

data/gitlab-qa.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_development_dependency 'climate_control', '~> 1.0.1'
-  spec.add_development_dependency 'gitlab-dangerfiles', '~> 2.10'
+  spec.add_development_dependency 'gitlab-dangerfiles', '~> 2.11'
   spec.add_development_dependency 'gitlab-styles', '~> 6.2.1'
   spec.add_development_dependency 'pry', '~> 0.11'
   spec.add_development_dependency 'rake', '~> 13.0'

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

@@ -5,6 +5,7 @@ require 'net/http'
 require 'uri'
 require 'forwardable'
 require 'openssl'
+require 'tempfile'
 
 module Gitlab
   module QA
@@ -19,9 +20,11 @@ module Gitlab
         def_delegators :release, :tag, :image, :edition
 
         CERTIFICATES_PATH = File.expand_path('../../../../tls_certificates', __dir__)
+        DATA_SEED_PATH = File.expand_path('../../../../support/data', __dir__)
 
         SSL_PATH = '/etc/gitlab/ssl'
         TRUSTED_PATH = '/etc/gitlab/trusted-certs'
+        DATA_PATH = '/tmp/data-seeds'
 
         def initialize
           super
@@ -40,6 +43,7 @@ module Gitlab
           @volumes[@authority_cert_path] = TRUSTED_PATH
 
           self.release = 'CE'
+          self.exec_commands += seed_test_data_command if Runtime::Scenario.seed_db
         end
 
         def set_formless_login_token
@@ -166,6 +170,12 @@ module Gitlab
           end
         end
 
+        def process_exec_commands
+          @docker.copy(name, DATA_SEED_PATH, DATA_PATH) if Runtime::Scenario.seed_db
+
+          exec_commands.each { |command| @docker.exec(name, command) }
+        end
+
         def sha_version
           json = @docker.read_file(
             @release.image, @release.tag,
@@ -176,6 +186,19 @@ module Gitlab
           manifest['software']['gitlab-rails']['locked_version']
         end
 
+        def copy_key_file(env_key)
+          key_dir = ENV['CI_PROJECT_DIR'] || Dir.tmpdir
+          key_file = Tempfile.new(env_key.downcase, key_dir)
+          key_file.write(ENV.fetch(env_key))
+          key_file.close
+
+          File.chmod(0o744, key_file.path)
+
+          @volumes[key_file.path] = key_file.path
+
+          key_file.path
+        end
+
         private
 
         # Copy certs to a temporary directory in current working directory.
@@ -196,6 +219,18 @@ module Gitlab
           end
         end
 
+        def seed_test_data_command
+          cmd = []
+
+          Runtime::Scenario.seed_db.each do |file_patterns|
+            Dir["#{DATA_SEED_PATH}/#{file_patterns}"].map { |f| File.basename f }.each do |file|
+              cmd << "gitlab-rails runner #{DATA_PATH}/#{file}"
+            end
+          end
+
+          cmd.uniq
+        end
+
         class Availability
           def initialize(name, relative_path: '', scheme: 'http', protocol_port: 80)
             @docker = Docker::Engine.new

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

@@ -3,6 +3,7 @@ module Gitlab
     module Component
       class StagingRef < Staging
         ADDRESS = 'https://staging-ref.gitlab.com'.freeze
+        GEO_SECONDARY_ADDRESS = 'https://geo.staging-ref.gitlab.com'.freeze
       end
     end
   end

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

@@ -76,6 +76,10 @@ module Gitlab
           Docker::Command.execute("attach --sig-proxy=false #{name}", &block)
         end
 
+        def copy(name, src_path, dest_path)
+          Docker::Command.execute("cp #{src_path} #{name}:#{dest_path}")
+        end
+
         def restart(name)
           Docker::Command.execute("restart #{name}")
         end

data/lib/gitlab/qa/release.rb

@@ -147,7 +147,7 @@ module Gitlab
             registry: DEV_REGISTRY
           }
         elsif omnibus_mirror?
-          username, password = if Runtime::Env.ci_job_token && Runtime::Env.ci_pipeline_source == 'pipeline'
+          username, password = if Runtime::Env.ci_job_token && Runtime::Env.ci_pipeline_source.include?('pipeline')
                                  ['gitlab-ci-token', Runtime::Env.ci_job_token]
                                elsif Runtime::Env.qa_container_registry_access_token
                                  [Runtime::Env.gitlab_username, Runtime::Env.qa_container_registry_access_token]

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

@@ -77,12 +77,24 @@ module Gitlab
           end
         end
 
+        def find_issue_notes(iid:)
+          handle_gitlab_client_exceptions do
+            Gitlab.issue_notes(project, iid, order_by: 'created_at', sort: 'asc').auto_paginate
+          end
+        end
+
         def create_issue_note(iid:, note:)
           handle_gitlab_client_exceptions do
             Gitlab.create_issue_note(project, iid, note)
           end
         end
 
+        def edit_issue_note(issue_iid:, note_id:, note:)
+          handle_gitlab_client_exceptions do
+            Gitlab.edit_issue_note(project, issue_iid, note_id, note)
+          end
+        end
+
         def add_note_to_issue_discussion_as_thread(iid:, discussion_id:, body:)
           handle_gitlab_client_exceptions do
             Gitlab.add_note_to_issue_discussion_as_thread(project, iid, discussion_id, body: body)

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

@@ -61,7 +61,7 @@ module Gitlab
 
           if issue
             puts "  => Found issue #{issue.web_url} for test '#{test.name}' with a diff ratio of #{(diff_ratio * 100).round(2)}%."
-            @commented_issue_list.include?(issue.web_url) ? (puts " => Failure already commented on issue.") : post_failed_job_note(issue, test)
+            @commented_issue_list.include?(issue.web_url) ? (puts " => Failure already commented on issue.") : post_or_update_failed_job_note(issue, test)
             @commented_issue_list.add(issue.web_url)
           end
 
@@ -86,14 +86,16 @@ module Gitlab
           ld = Class.new.extend(Gem::Text).method(:levenshtein_distance)
           full_stacktrace = test.failures.first['message_lines'].join("\n")
           first_test_failure_stacktrace = sanitize_stacktrace(full_stacktrace, FAILURE_STACKTRACE_REGEX) || full_stacktrace
+          clean_first_test_failure_stacktrace = remove_unique_resource_names(first_test_failure_stacktrace)
 
           # Search with the `search` param returns 500 errors, so we filter by ~QA and then filter further in Ruby
           failure_issues(test).each_with_object({}) do |issue, memo|
             relevant_issue_stacktrace = find_issue_stacktrace(issue)
             next unless relevant_issue_stacktrace
 
-            distance = ld.call(first_test_failure_stacktrace, relevant_issue_stacktrace)
-            diff_ratio = distance.zero? ? 0.0 : (distance.to_f / first_test_failure_stacktrace.size).round(3)
+            clean_relevant_issue_stacktrace = remove_unique_resource_names(relevant_issue_stacktrace)
+            distance = ld.call(clean_first_test_failure_stacktrace, clean_relevant_issue_stacktrace)
+            diff_ratio = distance.zero? ? 0.0 : (distance.to_f / clean_first_test_failure_stacktrace.size).round(3)
 
             if diff_ratio <= max_diff_ratio
               puts "  => [DEBUG] Issue #{issue.web_url} has an acceptable diff ratio of #{(diff_ratio * 100).round(2)}%."
@@ -128,6 +130,10 @@ module Gitlab
           end
         end
 
+        def remove_unique_resource_names(stacktrace)
+          stacktrace.gsub(/qa-(test|user)-[a-z0-9-]+/, '<unique-test-resource>').gsub(/(?:-|_)(?:\d+[a-z]|[a-z]+\d)[a-z\d]{4,}/, '<unique-hash>')
+        end
+
         def find_failure_issue(test)
           relevant_issues = find_relevant_failure_issues(test)
 
@@ -164,14 +170,30 @@ module Gitlab
           super << pipeline_name_label
         end
 
-        def post_failed_job_note(issue, test)
-          gitlab.create_issue_note(iid: issue.iid, note: "Failure occurred in #{pipeline} pipeline: #{test.ci_job_url}")
+        def post_or_update_failed_job_note(issue, test)
+          current_note = "Failed most recently in #{pipeline} pipeline: #{test.ci_job_url}"
+          existing_note = existing_failure_note(issue)
+
+          if existing_note
+            gitlab.edit_issue_note(issue_iid: issue.iid, note_id: existing_note.id, note: current_note)
+          else
+            gitlab.create_issue_note(iid: issue.iid, note: current_note)
+          end
+
           puts "  => Linked #{test.ci_job_url} to #{issue.web_url}."
         end
 
         def new_issue_title(test)
           "Failure in #{super}"
         end
+
+        def existing_failure_note(issue)
+          gitlab.find_issue_notes(iid: issue.iid).each do |note|
+            return note if note.body.include?('Failed most recently in')
+          end
+
+          false
+        end
       end
     end
   end

data/lib/gitlab/qa/runner.rb

@@ -12,9 +12,11 @@ module Gitlab
         Runtime::Scenario.define(:run_tests, true)
         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)
 
         # Omnibus Configurators specified by flags
         @active_configurators = []
+        @seed_scripts = []
         @omnibus_configurations = %w[default] # always load default configuration
 
         @options = OptionParser.new do |opts|
@@ -45,6 +47,14 @@ module Gitlab
             end
           end
 
+          opts.on('--seed-db search_pattern1[,search_pattern2,...]', 'Seed application database with sample test data') do |file_pattern|
+            file_pattern.split(',').each do |pattern|
+              @seed_scripts << pattern
+            end
+
+            Runtime::Scenario.define(:seed_db, @seed_scripts)
+          end
+
           opts.on_tail('-h', '--help', 'Show the usage') do
             puts opts
             exit

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

@@ -127,6 +127,11 @@ module Gitlab
           'GOOGLE_PROJECT' => :google_project,
           'GOOGLE_CLIENT_EMAIL' => :google_client_email,
           'GOOGLE_JSON_KEY' => :google_json_key,
+          'GOOGLE_CDN_JSON_KEY' => :google_cdn_json_key,
+          'GOOGLE_CDN_LB' => :google_cdn_load_balancer,
+          'GOOGLE_CDN_SIGNURL_KEY' => :google_cdn_signurl_key,
+          'GOOGLE_CDN_SIGNURL_KEY_NAME' => :google_cdn_signurl_key_name,
+          'GCS_CDN_BUCKET_NAME' => :gcs_cdn_bucket_name,
           'GCS_BUCKET_NAME' => :gcs_bucket_name,
           'SMOKE_ONLY' => :smoke_only,
           'NO_ADMIN' => :no_admin,
@@ -275,6 +280,14 @@ module Gitlab
           end
         end
 
+        def require_gcs_with_cdn_environment!
+          %w[GOOGLE_CDN_JSON_KEY GCS_CDN_BUCKET_NAME GOOGLE_CDN_LB GOOGLE_CDN_SIGNURL_KEY GOOGLE_CDN_SIGNURL_KEY_NAME].each do |env_key|
+            unless ENV.key?(env_key)
+              raise ArgumentError, "Environment variable #{env_key} must be set to run GCS with CDN enabled scenario"
+            end
+          end
+        end
+
         def require_initial_password!
           return unless env_var_value_if_defined('GITLAB_INITIAL_ROOT_PASSWORD').to_s.strip.empty?
 

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

@@ -0,0 +1,27 @@
+module Gitlab
+  module QA
+    module Scenario
+      module Test
+        module Instance
+          class StagingRefGeo < DeploymentBase
+            def initialize
+              @suite = 'QA::EE::Scenario::Test::Geo'
+            end
+
+            def deployment_component
+              Component::StagingRef
+            end
+
+            def non_rspec_args
+              [
+                '--primary-address', deployment_component::ADDRESS,
+                '--secondary-address', deployment_component::GEO_SECONDARY_ADDRESS,
+                '--without-setup'
+              ]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module QA
+    module Scenario
+      module Test
+        module Integration
+          class RegistryWithCDN < Scenario::Template
+            def perform(release, *rspec_args)
+              Runtime::Env.require_gcs_with_cdn_environment!
+
+              Component::Gitlab.perform do |gitlab|
+                gitlab.release = release
+                gitlab.network = 'test'
+                gitlab.name = 'gitlab'
+                sign_url_key_path = gitlab.copy_key_file('GOOGLE_CDN_SIGNURL_KEY')
+                cdn_gcloud_path = gitlab.copy_key_file('GOOGLE_CDN_JSON_KEY')
+
+                gitlab.omnibus_configuration << <<~OMNIBUS
+                  external_url 'http://#{gitlab.name}.#{gitlab.network}';
+                  registry_external_url 'http://#{gitlab.name}.#{gitlab.network}:5050';
+
+                  registry['middleware'] = { 'storage' => [{ 'name' => 'googlecdn', 'options' => { 'baseurl' => '#{Runtime::Env.google_cdn_load_balancer}', 'privatekey' => '#{sign_url_key_path}', 'keyname' => '#{Runtime::Env.google_cdn_signurl_key_name}' } }] }
+                  registry['storage'] = { 'gcs' => { 'bucket' => '#{Runtime::Env.gcs_cdn_bucket_name}', 'keyfile' => '#{cdn_gcloud_path}' } }
+                OMNIBUS
+
+                gitlab.instance do
+                  Component::Specs.perform do |specs|
+                    specs.suite = 'Test::Integration::RegistryWithCDN'
+                    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 = '7.24.4'
+    VERSION = '7.25.0'
   end
 end

data/lib/gitlab/qa.rb

@@ -43,6 +43,7 @@ module Gitlab
           autoload :Release, 'gitlab/qa/scenario/test/instance/release'
           autoload :Geo, 'gitlab/qa/scenario/test/instance/geo'
           autoload :StagingGeo, 'gitlab/qa/scenario/test/instance/staging_geo'
+          autoload :StagingRefGeo, 'gitlab/qa/scenario/test/instance/staging_ref_geo'
           autoload :Airgapped, 'gitlab/qa/scenario/test/instance/airgapped'
         end
 
@@ -76,6 +77,7 @@ module Gitlab
           autoload :RegistryTLS, 'gitlab/qa/scenario/test/integration/registry_tls'
           autoload :ServicePingDisabled, 'gitlab/qa/scenario/test/integration/service_ping_disabled'
           autoload :Integrations, 'gitlab/qa/scenario/test/integration/integrations'
+          autoload :RegistryWithCDN, 'gitlab/qa/scenario/test/integration/registry_with_cdn'
         end
 
         module Sanity