gitlab-qa 7.24.3 → 7.24.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e2b176f3463abe8bce6879fad13baf9053f8d51175ce9b4c2994b2ad72a308b5
-  data.tar.gz: a93d60ad2678d98b2e94e89e2c97cc24c1a81b42e5e838f5eaa20285a92a92a1
+  metadata.gz: 1ab5663ab224b79f77ee02d363fa0e38d5a14f53e895b5135e87a79e91ebb89a
+  data.tar.gz: 0b42e0776e042612565fe7e55af86db3dd3559dcdce549e4d937948e55173f81
 SHA512:
-  metadata.gz: a6739f73c98c6fc9e044915632a747d990d1f1bb354eaaf77bb0de4d6c6c5abbaffda10a8f60927757a16ca48affc3dca2b8aa8a6bf4f4e6b6977eda9c3b4c20
-  data.tar.gz: 17379496d96c009b6c96ea8953a38bacb253eb6ac80006889557bb068a6270991100926601936dcddd92cf02dca6ea7c3159990a6f3264e601803d5460394259
+  metadata.gz: a9046b2ee0a0a41d289a3551c4fe5179198b86854bcda525b1bc25915f5cc43f1b2d43f7197f077b55a43dd92bd3e40cd38c5d672bff4aa8b3c166933f7bd941
+  data.tar.gz: c3b2491338c9a433cf3cf1ae83864484e1f769cc3626497e2ef2e3b37717b1a58b481aec74fe37024ed7a18e7cd80364f749f6d9cab481a761c81b16aaab2cd8

data/.gitlab/issue_templates/Default.md

@@ -0,0 +1,13 @@
+<!--
+Before raising an issue to the GitLab issue tracker, please read through our guide for finding help to determine the best place to post:
+
+* https://about.gitlab.com/getting-help/
+
+If you are experiencing an issue when using GitLab.com, your first port of call should be the Community Forum. Your issue may have already been reported there by another user. Please check:
+
+* https://forum.gitlab.com/
+
+If you feel that your issue can be categorized as a reproducible bug or a feature proposal, please use one of the issue templates provided and include as much information as possible.
+
+Thank you for helping to make GitLab a better product.
+-->

data/.gitlab/merge_request_templates/Default.md

@@ -0,0 +1,46 @@
+## What does this MR do and why?
+
+_Describe in detail what your merge request does and why._
+
+<!--
+Please keep this description updated with any discussion that takes place so
+that reviewers can understand your intent. Keeping the description updated is
+especially important if they didn't participate in the discussion.
+-->
+
+## Screenshots or screen recordings 
+
+_These are strongly recommended to assist reviewers and reduce the time to merge your change._
+
+<!-- 
+Please include any relevant screenshots or screen recordings that will assist
+reviewers and future readers. If you need help visually verifying the change,
+please leave a comment and ping a GitLab reviewer, maintainer, or MR coach.
+-->
+
+## How to set up and validate locally 
+
+_Numbered steps to set up and validate the change are strongly suggested._
+
+<!-- 
+Example below:
+ 
+1. Enable the invite modal
+   ```ruby
+   Feature.enable(:invite_members_group_modal)
+   ```
+1. In rails console enable the experiment fully
+   ```ruby
+   Feature.enable(:member_areas_of_focus)
+   ```
+1. Visit any group or project member pages such as `http://127.0.0.1:3000/groups/flightjs/-/group_members`
+1. Click the `invite members` button.
+-->
+
+## MR acceptance checklist
+
+This checklist encourages us to confirm any changes have been analyzed to reduce risks in quality, performance, reliability, security, and maintainability. 
+
+* [ ] I have evaluated the [MR acceptance checklist](https://docs.gitlab.com/ee/development/code_review.html#acceptance-checklist) for this MR.
+
+/label ~QA ~Quality

data/.gitlab-ci.yml

@@ -820,7 +820,7 @@ ee:object_storage-quarantine:
     GITLAB_QA_OPTIONS_COMBINED: "$GITLAB_QA_OPTIONS --omnibus-config object_storage"
     QA_RSPEC_TAGS: "--tag quarantine --tag object_storage"
 
-ee:packages:
+ee:packages-parallel:
   extends:
     - .rules:ee-never-when-triggered-by-feature-flag-definition-change
     - .test
@@ -828,6 +828,7 @@ ee:packages:
     - .ee-variables
     - .rspec-report-opts
     - .combined-gitlab-qa-options-script
+  parallel: 2
   variables:
     GITLAB_QA_OPTIONS_COMBINED: "$GITLAB_QA_OPTIONS --omnibus-config packages"
     QA_RSPEC_TAGS: "--tag packages"
@@ -1388,3 +1389,7 @@ include:
       - '/ci/gem-release.yml'
       - '/ci/allure-report.yml'
       - '/ci/knapsack-report.yml'
+      - '/ci/danger-review.yml'
+
+danger-review:
+  stage: check

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/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/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/runtime/logger.rb

@@ -1,34 +1,17 @@
 # frozen_string_literal: true
 
-require 'logger'
 require 'forwardable'
-require'rainbow/refinement'
 
 module Gitlab
   module QA
     module Runtime
-      module Logger
+      class Logger
         extend SingleForwardable
-        using Rainbow
 
         def_delegators :logger, :debug, :info, :warn, :error, :fatal, :unknown
 
-        singleton_class.module_eval do
-          attr_writer :logger
-
-          def logger
-            Rainbow.enabled = Runtime::Env.colorized_logs?
-
-            @logger ||= ::Logger.new($stdout).tap do |logger|
-              logger.level = Runtime::Env.debug? ? ::Logger::DEBUG : ::Logger::INFO
-
-              logger.formatter = proc do |severity, datetime, progname, msg|
-                date_format = datetime.strftime("%Y-%m-%d %H:%M:%S")
-
-                "[date=#{date_format} from=GitLab QA] #{severity.ljust(5)}-- ".yellow + "#{msg}\n"
-              end
-            end
-          end
+        def self.logger
+          @logger ||= QA::TestLogger.logger(level: Runtime::Env.debug? ? ::Logger::DEBUG : ::Logger::INFO)
         end
       end
     end

data/lib/gitlab/qa/test_logger.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'logger'
+require 'rainbow'
+
+module Gitlab
+  module QA
+    # Common test logger implementation
+    #
+    class TestLogger
+      LEVEL_COLORS = {
+        "DEBUG" => :magenta,
+        "INFO" => :green,
+        "WARN" => :yellow,
+        "ERROR" => :red,
+        "FATAL" => :indianred
+      }.freeze
+
+      Rainbow.enabled = Runtime::Env.colorized_logs?
+
+      def self.logger(level: ::Logger::INFO, source: 'Gitlab QA')
+        ::Logger.new($stdout).tap do |logger|
+          logger.level = level
+
+          logger.formatter = proc do |severity, datetime, progname, msg|
+            date_format = datetime.strftime("%Y-%m-%d %H:%M:%S")
+            msg_prefix = "[date=#{date_format} from=#{source}] #{severity.ljust(5)} -- "
+
+            Rainbow(msg_prefix).public_send(LEVEL_COLORS.fetch(severity, :silver)) + "#{msg}\n" # rubocop:disable GitlabSecurity/PublicSend
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/qa/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   module QA
-    VERSION = '7.24.3'
+    VERSION = '7.24.6'
   end
 end

data/lib/gitlab/qa.rb

@@ -3,6 +3,7 @@ module Gitlab
     autoload :Release, 'gitlab/qa/release'
     autoload :Reporter, 'gitlab/qa/reporter'
     autoload :Runner, 'gitlab/qa/runner'
+    autoload :TestLogger, 'gitlab/qa/test_logger'
 
     module Runtime
       autoload :Env, 'gitlab/qa/runtime/env'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-qa
 version: !ruby/object:Gem::Version
-  version: 7.24.3
+  version: 7.24.6
 platform: ruby
 authors:
 - GitLab Quality
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-11 00:00:00.000000000 Z
+date: 2022-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: '2.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.10'
+        version: '2.11'
 - !ruby/object:Gem::Dependency
   name: gitlab-styles
   requirement: !ruby/object:Gem::Requirement
@@ -218,8 +218,9 @@ files:
 - ".dockerignore"
 - ".gitignore"
 - ".gitlab-ci.yml"
-- ".gitlab/ci/danger.gitlab-ci.yml"
 - ".gitlab/ci/rules.gitlab-ci.yml"
+- ".gitlab/issue_templates/Default.md"
+- ".gitlab/merge_request_templates/Default.md"
 - ".gitlab/merge_request_templates/Release.md"
 - ".rspec"
 - ".rubocop.yml"
@@ -356,6 +357,7 @@ files:
 - lib/gitlab/qa/support/get_request.rb
 - lib/gitlab/qa/support/http_request.rb
 - lib/gitlab/qa/support/invalid_response_error.rb
+- lib/gitlab/qa/test_logger.rb
 - lib/gitlab/qa/version.rb
 - tls_certificates/authority/ca.crt
 - tls_certificates/authority/ca.key

data/.gitlab/ci/danger.gitlab-ci.yml

@@ -1,25 +0,0 @@
-danger-review:
-  image: ruby:3.0
-  stage: check
-  rules:
-    - if: '$CI_MERGE_REQUEST_IID'
-  needs: []
-  retry:
-    max: 2
-    when:
-      - unknown_failure
-      - api_failure
-      - runner_system_failure
-      - stuck_or_timeout_failure
-  before_script:
-    - bundle install
-  script:
-    - >
-      if [ -z "$DANGER_GITLAB_API_TOKEN" ]; then
-        # Force danger to skip CI source GitLab and fallback to "local only git repo".
-        unset GITLAB_CI
-        # We need the base SHA of the merge request diff to help danger determine the base commit for this shallow clone.
-        bundle exec danger dry_run --fail-on-errors=true --verbose --base='$CI_MERGE_REQUEST_DIFF_BASE_SHA' --head='${CI_MERGE_REQUEST_SOURCE_BRANCH_SHA:-$CI_COMMIT_SHA}'
-      else
-        bundle exec danger --fail-on-errors=true --verbose
-      fi