gitlab_quality-test_tooling 1.30.0 → 1.32.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba1faa3616687c598a2d2b69e469c90d92ba687a9693ed87367998e1a747313d
-  data.tar.gz: 1486372498629cb6e21b63a999a856f40e7b393295f12bcf52cd8f74c4803efc
+  metadata.gz: f3c72dad2be7e5a1e112667f8239dff242bac1d69298fd5bf664745c707d26ba
+  data.tar.gz: 2261f70832512fd425cc4f49316f3a0a2e5211b4a0d83d5149ae72cb9d899cb2
 SHA512:
-  metadata.gz: f67bc6c00ad80ab20e33b7f69356a30e27415674211ce14c4ceb17dd80d7621ce6a441a279889e344b8e8a87d1488dec5e799f5c712d0eae629d44ee2b6019e6
-  data.tar.gz: ceb443481a7528bca028c3070dcf71739bdd9b90a4173890dbd5f54a4d0e22ef2b9458c0d00ac13bf23dad0354bde5465a153a4f23c92c9ccf0c44cef04822a9
+  metadata.gz: '0395ec1d6abafc42099e47d961c468690265996fd903c1c105742735122aeef300baf27597163ccd510dc61d33721fa92180a72990881144f6a9a017a7a5d616'
+  data.tar.gz: 7b179fbba4870967780b53fc68b98f0f237bcc0c5595d9b68c37e5976b3964f286aeb480d321ff4e5daa1b8456881f1f49e3d72fb929809bc175ace04d70437e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab_quality-test_tooling (1.30.0)
+    gitlab_quality-test_tooling (1.32.0)
       activesupport (>= 7.0, < 7.2)
       amatch (~> 0.4.1)
       gitlab (~> 4.19)

data/lib/gitlab_quality/test_tooling/knapsack_reports/spec_run_time.rb

@@ -4,13 +4,14 @@ module GitlabQuality
   module TestTooling
     module KnapsackReports
       class SpecRunTime
-        attr_reader :file, :expected, :actual, :expected_suite_duration, :actual_suite_duration
+        attr_reader :project, :file, :expected, :actual, :expected_suite_duration, :actual_suite_duration
 
         ACTUAL_TO_EXPECTED_SPEC_RUN_TIME_RATIO_THRESHOLD = 1.5 # actual run time is longer than expected by 50% +
         SPEC_WEIGHT_PERCENTAGE_TRESHOLD = 15 # a spec file takes 15%+ of the total test suite run time
         SUITE_DURATION_THRESHOLD = 70 * 60 # if test suite takes more than 70 minutes, job risks timing out
 
-        def initialize(file:, expected:, actual:, expected_suite_duration:, actual_suite_duration:)
+        def initialize(project:, file:, expected:, actual:, expected_suite_duration:, actual_suite_duration:)
+          @project = project
           @file = file
           @expected = expected.to_f
           @actual = actual.to_f
@@ -77,7 +78,7 @@ module GitlabQuality
         end
 
         def file_link
-          "#{Runtime::Env.file_base_url}#{file}"
+          "https://gitlab.com/#{project}/-/blob/#{Runtime::Env.ci_commit_ref_name}/#{file}"
         end
       end
     end

data/lib/gitlab_quality/test_tooling/knapsack_reports/spec_run_time_report.rb

@@ -6,9 +6,10 @@ module GitlabQuality
   module TestTooling
     module KnapsackReports
       class SpecRunTimeReport
-        attr_reader :expected_report, :actual_report
+        attr_reader :project, :expected_report, :actual_report
 
-        def initialize(expected_report_path:, actual_report_path:)
+        def initialize(project:, expected_report_path:, actual_report_path:)
+          @project = project
           @expected_report = parse(expected_report_path)
           @actual_report = parse(actual_report_path)
         end
@@ -24,6 +25,7 @@ module GitlabQuality
             end
 
             spec_run_time = SpecRunTime.new(
+              project: project,
               file: spec_file,
               expected: expected_run_time,
               actual: actual_run_time,

data/lib/gitlab_quality/test_tooling/report/failed_test_issue.rb

@@ -19,8 +19,6 @@ module GitlabQuality
         ISSUE_STACKTRACE_REGEX = /##### Stack trace\s*(```)#{FAILURE_STACKTRACE_REGEX}(```)\n*/m
         DEFAULT_MAX_DIFF_RATIO_FOR_DETECTION = 0.15
 
-        MultipleNotesFound = Class.new(StandardError)
-
         def initialize(
           base_issue_labels: nil,
           max_diff_ratio: DEFAULT_MAX_DIFF_RATIO_FOR_DETECTION,
@@ -73,9 +71,7 @@ module GitlabQuality
           relevant_notes = find_relevant_failure_discussion_note(issue: issue, test: test, reports_discussion: reports_discussion)
           return if relevant_notes.empty?
 
-          best_matching_note, smaller_diff_ratio = relevant_notes.min_by { |_, diff_ratio| diff_ratio }
-
-          raise(MultipleNotesFound, %(Too many issues found for test '#{test.name}' (`#{test.file}`)!)) unless relevant_notes.values.count(smaller_diff_ratio) == 1
+          best_matching_note, _ = relevant_notes.min_by { |_, diff_ratio| diff_ratio }
 
           # Re-instantiate a `Gitlab::ObjectifiedHash` object after having converted it to a hash in #find_relevant_failure_issues above.
           best_matching_note = Gitlab::ObjectifiedHash.new(best_matching_note)

data/lib/gitlab_quality/test_tooling/report/health_problem_reporter.rb

@@ -16,7 +16,7 @@ module GitlabQuality
         include Concerns::GroupAndCategoryLabels
         include Concerns::IssueReports
 
-        BASE_SEARCH_LABELS = ['test'].freeze
+        BASE_SEARCH_LABELS    = ['test'].freeze
         FOUND_IN_MR_LABEL     = '~"found:in MR"'
         FOUND_IN_MASTER_LABEL = '~"found:master"'
 
@@ -65,7 +65,7 @@ module GitlabQuality
         def run!
           puts "Reporting tests in `#{files.join(',')}` as issues in project `#{project}` via the API at `#{Runtime::Env.gitlab_api_base}`."
 
-          TestResults::Builder.new(file_glob: files).test_results_per_file do |test_results|
+          TestResults::Builder.new(file_glob: files, token: token, project: project).test_results_per_file do |test_results|
             puts "=> Reporting #{test_results.count} tests in #{test_results.path}"
 
             process_test_results(test_results)
@@ -133,8 +133,6 @@ module GitlabQuality
           else
             gitlab.create_issue_note(iid: issue.iid, note: note_body)
           end
-        rescue MultipleNotesFound => e
-          warn(e.message)
         end
 
         def find_or_create_reports_discussion(issue:)

data/lib/gitlab_quality/test_tooling/report/knapsack_report_issue.rb

@@ -36,6 +36,7 @@ module GitlabQuality
 
         def search_and_create_issue
           filtered_report = KnapsackReports::SpecRunTimeReport.new(
+            project: project,
             expected_report_path: expected_report_path,
             actual_report_path: actual_report_path
           ).filtered_report

data/lib/gitlab_quality/test_tooling/report/merge_request_slow_tests_report.rb

@@ -25,12 +25,12 @@ module GitlabQuality
 
         private
 
-        attr_reader :gitlab_merge_request, :files, :project, :merge_request_iid, :slow_tests
+        attr_reader :token, :project, :gitlab_merge_request, :files, :merge_request_iid, :slow_tests
 
         def run!
           puts "Reporting slow tests in MR #{merge_request_iid}"
 
-          TestResults::Builder.new(file_glob: files).test_results_per_file do |test_results|
+          TestResults::Builder.new(token: token, project: project, file_glob: files).test_results_per_file do |test_results|
             puts "=> Reporting #{test_results.count} tests in #{test_results.path}"
 
             @slow_tests += slow_related_tests(find_slow_tests(test_results))

data/lib/gitlab_quality/test_tooling/report/relate_failure_issue.rb

@@ -52,7 +52,7 @@ module GitlabQuality
         def run!
           puts "Reporting test failures in `#{files.join(',')}` as issues in project `#{project}` via the API at `#{Runtime::Env.gitlab_api_base}`."
 
-          TestResults::Builder.new(file_glob: files).test_results_per_file do |test_results|
+          TestResults::Builder.new(token: token, project: project, file_glob: files).test_results_per_file do |test_results|
             puts "=> Reporting #{test_results.count} tests in #{test_results.path}"
             process_test_results(test_results)
           end

data/lib/gitlab_quality/test_tooling/report/report_as_issue.rb

@@ -9,6 +9,7 @@ module GitlabQuality
         include Concerns::Utils
 
         def initialize(token:, input_files:, related_issues_file: nil, project: nil, confidential: false, dry_run: false, **_kwargs)
+          @token = token
           @project = project
           @gitlab = (dry_run ? GitlabClient::IssuesDryClient : GitlabClient::IssuesClient).new(token: token, project: project)
           @files = Array(input_files)
@@ -28,7 +29,7 @@ module GitlabQuality
 
         private
 
-        attr_reader :gitlab, :files, :project, :issue_type, :confidential, :issue_logger
+        attr_reader :token, :gitlab, :files, :project, :issue_type, :confidential, :issue_logger
 
         def run!
           raise NotImplementedError
@@ -58,7 +59,7 @@ module GitlabQuality
           | ------ | ------ |
           | File URL | #{test.test_file_link} |
           | Filename | `#{test.relative_file}` |
-          | Description | `#{test.name}` |
+          | Description | `` #{test.name} `` |
           | Test level | `#{test.level}` |
           | Hash | `#{test_hash(test)}` |
           | Max expected duration | < #{test.max_duration_for_test} seconds |

data/lib/gitlab_quality/test_tooling/report/report_results.rb

@@ -14,7 +14,7 @@ module GitlabQuality
         def initialize(
           test_case_project_token:, results_issue_project_token:, input_files:, test_case_project: nil, results_issue_project: nil, dry_run: false,
           **kwargs)
-          @results_issue_project_token = results_issue_project_token
+          @test_case_project_token = test_case_project_token
           @testcase_project_reporter = GitlabQuality::TestTooling::Report::ResultsInTestCases.new(
             token: test_case_project_token, input_files: input_files, project: test_case_project, dry_run: dry_run, **kwargs)
           @results_issue_project_reporter = GitlabQuality::TestTooling::Report::ResultsInIssues.new(
@@ -32,12 +32,14 @@ module GitlabQuality
 
         private
 
+        attr_reader :test_case_project_token
+
         # rubocop:disable Metrics/AbcSize
         def run!
           puts "Reporting test results in `#{files.join(',')}` as test cases in project `#{test_case_project}` " \
                "and issues in project `#{results_issue_project}` via the API at `#{Runtime::Env.gitlab_api_base}`."
 
-          TestResults::Builder.new(file_glob: files).test_results_per_file do |test_results|
+          TestResults::Builder.new(token: test_case_project_token, project: test_case_project, file_glob: files).test_results_per_file do |test_results|
             puts "Reporting tests in #{test_results.path}"
 
             test_results.each do |test|

data/lib/gitlab_quality/test_tooling/runtime/env.rb

@@ -17,6 +17,7 @@ module GitlabQuality
           'CI_JOB_URL' => :ci_job_url,
           'CI_PROJECT_ID' => :ci_project_id,
           'CI_PROJECT_NAME' => :ci_project_name,
+          'CI_PROJECT_PATH' => :ci_project_path,
           'CI_PIPELINE_ID' => :ci_pipeline_id,
           'CI_PIPELINE_URL' => :ci_pipeline_url,
           'SLACK_QA_CHANNEL' => :slack_qa_channel,
@@ -90,10 +91,6 @@ module GitlabQuality
           "#{ci_project_name}-#{test_subset}"
         end
 
-        def file_base_url
-          env_var_value_if_defined('FILE_BASE_URL') || "https://gitlab.com/gitlab-org/gitlab/-/blob/master/"
-        end
-
         private
 
         def enabled?(value, default: true)

data/lib/gitlab_quality/test_tooling/test_meta/processor/add_to_blocking_processor.rb

@@ -50,18 +50,21 @@ module GitlabQuality
 
             private
 
-            attr_reader :context, :file_path, :file, :file_contents, :example_name, :mr_title, :changed_line_no
+            attr_reader :context, :file_path, :file, :file_contents, :example_name, :mr_title, :changed_line_no, :matched_lines
 
             # Checks if there is already an MR open
             #
             # @return [Boolean]
-            def proceed_with_commit?
+            def proceed_with_commit? # rubocop:disable Metrics/AbcSize
               if changed_line_no.negative?
                 Runtime::Logger.info("  No lines were changed in #{file_path}. Will not proceed with creating MR.")
                 return false
               elsif context.commit_processed?(file_path, changed_line_no)
                 Runtime::Logger.info("  Record already processed for #{file_path}:#{changed_line_no}. Will not proceed with creating MR.")
                 return false
+              elsif context.quarantined?(matched_lines, file_contents)
+                Runtime::Logger.info("  This test is in quarantine: #{file_path}:#{changed_line_no}. Will not proceed with creating MR.")
+                return false
               end
 
               true
@@ -120,7 +123,7 @@ module GitlabQuality
             #
             # @return [Array<String, Integer>] first value holds the new content, the second value holds the line number of the test
             def add_metadata # rubocop:disable Metrics/AbcSize
-              matched_lines = context.find_example_match_lines(file_contents, example_name)
+              @matched_lines = context.find_example_match_lines(file_contents, example_name)
 
               if matched_lines.any? { |line| line[0].include?(':blocking') }
                 Runtime::Logger.info("Example '#{example_name}' is already blocking")

data/lib/gitlab_quality/test_tooling/test_meta/processor/add_to_quarantine_processor.rb

@@ -60,12 +60,12 @@ module GitlabQuality
             private
 
             attr_reader :context, :file_path, :file_contents, :failure_issue_url, :example_name,
-              :mr_title, :failure_issue, :changed_line_no
+              :mr_title, :failure_issue, :changed_line_no, :matched_lines
 
             # Checks if the failure issue is closed or if there is already an MR open
             #
             # @return [Boolean]
-            def proceed_with_commit?
+            def proceed_with_commit? # rubocop:disable Metrics/AbcSize
               if context.issue_is_closed?(failure_issue)
                 Runtime::Logger.info("  Failure issue '#{failure_issue_url}' is closed. Will not proceed with creating MR.")
                 return false
@@ -75,6 +75,9 @@ module GitlabQuality
               elsif failure_is_related_to_test_environment?
                 Runtime::Logger.info("  Failure issue '#{failure_issue_url}' is environment related. Will not proceed with creating MR.")
                 return false
+              elsif context.quarantined?(matched_lines, file_contents)
+                Runtime::Logger.info("  This test is already in quarantine: #{file_path}:#{changed_line_no}. Will not proceed with creating MR.")
+                return false
               end
 
               true
@@ -199,7 +202,7 @@ module GitlabQuality
             #
             # @return [Array<String, Integer>] first value holds the new content, the second value holds the line number of the test
             def add_metadata # rubocop:disable Metrics/AbcSize
-              matched_lines = context.find_example_match_lines(file_contents, example_name)
+              @matched_lines = context.find_example_match_lines(file_contents, example_name)
 
               context.update_matched_line(matched_lines.last, file_contents.dup) do |line|
                 indentation = context.indentation(line)

data/lib/gitlab_quality/test_tooling/test_meta/test_meta_updater.rb

@@ -129,6 +129,26 @@ module GitlabQuality
           matched_lines
         end
 
+        # Scans the content from the matched line until `do` is found to look for quarantine token
+        #
+        # @param [Array] matched_lines an array of arrays containing the matched line and their index
+        # @param [String] file_contents the content of the spec file
+        # @return [Bolean]
+        def quarantined?(matched_lines, file_contents)
+          lines = file_contents.split("\n")
+
+          matched_lines.each do |matched_line|
+            matched_line_starting_index = matched_line[1]
+
+            lines[matched_line_starting_index..].each do |line|
+              return true if line.include?('quarantine: {')
+              break if / do$/.match?(line)
+            end
+          end
+
+          false
+        end
+
         # Update the provided matched_line with content from the block if given
         #
         # @param [Array<String, Integer>] matched_line first value holds the line content, the second value holds the line number

data/lib/gitlab_quality/test_tooling/test_result/base_test_result.rb

@@ -13,8 +13,10 @@ module GitlabQuality
 
         attr_reader :report
 
-        def initialize(report:, ref: 'master')
+        def initialize(report:, token: '', project: Runtime::Env.ci_project_path, ref: Runtime::Env.ci_commit_ref_name)
           @report = report
+          @token = token
+          @project = project
           @ref = ref
         end
 
@@ -58,6 +60,14 @@ module GitlabQuality
           @file ||= relative_file.start_with?('qa/') ? "qa/#{relative_file}" : relative_file
         end
 
+        def file_base_url
+          @file_base_url ||= "https://gitlab.com/#{project}/-/blob/#{ref}/"
+        end
+
+        def test_file_link
+          "[`#{file}#L#{line_number}`](#{file_base_url}#{file}#L#{line_number})"
+        end
+
         def full_stacktrace
           failures.each do |failure|
             message = failure['message'] || ""
@@ -79,15 +89,15 @@ module GitlabQuality
 
         def files_client
           @files_client ||= GitlabClient::RepositoryFilesClient.new(
-            token: '',
-            project: 'gitlab-org/gitlab',
+            token: token,
+            project: project,
             file_path: file,
             ref: ref)
         end
 
         private
 
-        attr_reader :ref
+        attr_reader :token, :project, :ref
       end
     end
   end

data/lib/gitlab_quality/test_tooling/test_result/j_unit_test_result.rb

@@ -98,14 +98,6 @@ module GitlabQuality
         def failure_issue=(new_failure_issue)
           report['failure_issue'] = new_failure_issue
         end
-
-        def test_file_link
-          return "" if file.nil?
-
-          path_prefix = file.start_with?('qa/') ? 'qa/' : ''
-
-          "[`#{path_prefix}#{file}#L#{line_number}`](#{Runtime::Env.file_base_url}#{path_prefix}#{file}#L#{line_number})"
-        end
       end
     end
   end

data/lib/gitlab_quality/test_tooling/test_result/json_test_result.rb

@@ -178,10 +178,6 @@ module GitlabQuality
           test_level_specification.max_duration
         end
 
-        def test_file_link
-          "[`#{file}#L#{line_number}`](#{Runtime::Env.file_base_url}#{file}#L#{line_number})"
-        end
-
         private
 
         def quarantine

data/lib/gitlab_quality/test_tooling/test_results/base_test_results.rb

@@ -8,8 +8,10 @@ module GitlabQuality
 
         attr_reader :path
 
-        def initialize(path:, ref: 'master')
+        def initialize(path:, token: nil, project: nil, ref: 'master')
           @path = path
+          @token = token
+          @project = project
           @ref = ref
           @results = parse
           @testcases = process
@@ -25,7 +27,7 @@ module GitlabQuality
 
         private
 
-        attr_reader :results, :testcases, :ref
+        attr_reader :results, :testcases, :token, :project, :ref
 
         def parse
           raise NotImplementedError

data/lib/gitlab_quality/test_tooling/test_results/builder.rb

@@ -4,8 +4,10 @@ module GitlabQuality
   module TestTooling
     module TestResults
       class Builder
-        def initialize(file_glob:, ref: 'master')
+        def initialize(file_glob:, token: nil, project: nil, ref: 'master')
           @file_glob = file_glob
+          @token = token
+          @project = project
           @ref = ref
         end
 
@@ -16,9 +18,9 @@ module GitlabQuality
             test_results =
               case extension
               when '.json'
-                TestResults::JsonTestResults.new(path: path, ref: ref)
+                TestResults::JsonTestResults.new(path: path, token: token, project: project, ref: ref)
               when '.xml'
-                TestResults::JUnitTestResults.new(path: path, ref: ref)
+                TestResults::JUnitTestResults.new(path: path, token: token, project: project, ref: ref)
               else
                 raise "Unknown extension #{extension}"
               end
@@ -29,7 +31,7 @@ module GitlabQuality
 
         private
 
-        attr_reader :file_glob, :ref
+        attr_reader :file_glob, :token, :project, :ref
       end
     end
   end

data/lib/gitlab_quality/test_tooling/test_results/j_unit_test_results.rb

@@ -18,7 +18,7 @@ module GitlabQuality
 
         def process
           results.xpath('//testcase').map do |test|
-            GitlabQuality::TestTooling::TestResult::JUnitTestResult.new(report: test)
+            GitlabQuality::TestTooling::TestResult::JUnitTestResult.new(report: test, project: project, token: token)
           end
         end
       end

data/lib/gitlab_quality/test_tooling/test_results/json_test_results.rb

@@ -20,7 +20,7 @@ module GitlabQuality
 
         def process
           results['examples'].map do |test|
-            GitlabQuality::TestTooling::TestResult::JsonTestResult.new(report: test)
+            GitlabQuality::TestTooling::TestResult::JsonTestResult.new(report: test, project: project, token: token)
           end
         end
       end

data/lib/gitlab_quality/test_tooling/version.rb

@@ -2,6 +2,6 @@
 
 module GitlabQuality
   module TestTooling
-    VERSION = "1.30.0"
+    VERSION = "1.32.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_quality-test_tooling
 version: !ruby/object:Gem::Version
-  version: 1.30.0
+  version: 1.32.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-26 00:00:00.000000000 Z
+date: 2024-07-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control