gitlab_quality-test_tooling 1.29.1 → 1.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 523cbb3e59a928b4e438ec2f97818c6b756b5120d9d61ede7945bd5904de4b79
-  data.tar.gz: 750bb848167c76df6f6287d119eb211fa8281abfade44334ca1cb72142b03361
+  metadata.gz: 5d848eed10080ffc5f609ba56a75e7baf6f60cef5792d66c9c1bf9fdb8dbd2b9
+  data.tar.gz: 5d799f1628b689fda63e0ca68fb70c5f2e6e37d20d867d6ade61e4ff04ea7e57
 SHA512:
-  metadata.gz: ab633288538b5343309ed30766925b61c05685f457e1772f5c80113a013fd75910509cf76fa01feb9e9bffdf5d764357f221b8f7f53748f17daed1f60b240464
-  data.tar.gz: 2dbf75f6310a515c0c9eb43301fd6b669ba96e115cbdeec37a2570fc556cac94daac00ec81638aaf1288e465efd4284af167e7d060657eaff788d65aebb92362
+  metadata.gz: 2e881613627b3fb87abf0c00895a8b44919769b222aa1a42c60c81b8f77a79a99232145e60c798f0296d24f53f761cb6a5fd4c7d00d1cb982dcc3c58fd68a833
+  data.tar.gz: 90b1345308d5f4abb94ab81f16520bf79870de753f570223c5bc45ade1fdb7d2ca099004d682bdbcfe106c3557ebdd093ce0461b493fd98e6e687bb9930b293e

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab_quality-test_tooling (1.29.1)
+    gitlab_quality-test_tooling (1.31.0)
       activesupport (>= 7.0, < 7.2)
       amatch (~> 0.4.1)
       gitlab (~> 4.19)
@@ -330,4 +330,4 @@ DEPENDENCIES
   webmock (= 3.7.0)
 
 BUNDLED WITH
-   2.5.6
+   2.5.13

data/exe/post-to-slack

@@ -47,6 +47,10 @@ options = OptionParser.new do |opts|
     summary_table_opts[:sort_direction] = sort_direction.downcase.to_sym
   end
 
+  opts.on('--hide-passed-tests', 'Used with the `--include-summary-table` flag — Hide passed tests from the summary table') do
+    summary_table_opts[:hide_passed_tests] = true
+  end
+
   opts.on('-t', '--include-summary-table FILES', String, 'Add a test summary table based on RSpec report files (JUnit XML)') do |files|
     params[:summary_table_files] = files
   end

data/lib/gitlab_quality/test_tooling/gitlab_client/repository_files_client.rb

@@ -19,7 +19,9 @@ module GitlabQuality
         end
 
         def file_contents_at_line(line_number)
-          file_contents.lines(chomp: true)[line_number - 1]
+          ignore_gitlab_client_exceptions do
+            file_contents.lines(chomp: true)[line_number - 1]
+          end
         end
       end
     end

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"'
 
@@ -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(token: @token, project: @project, 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(token: @token, project: @project, 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
@@ -259,7 +259,7 @@ module GitlabQuality
 
           best_matching_issue, smaller_diff_ratio = relevant_issues.min_by { |_, diff_ratio| diff_ratio }
 
-          raise(MultipleIssuesFound, %(Too many issues found for test '#{test.name}' (`#{test.file}`)!)) unless relevant_issues.values.count(smaller_diff_ratio) == 1
+          raise(MultipleIssuesFound, %(Too many issues found for test '#{test.name}' (`#{test.relative_file}`)!)) unless relevant_issues.values.count(smaller_diff_ratio) == 1
 
           # Re-instantiate a `Gitlab::ObjectifiedHash` object after having converted it to a hash in #find_relevant_failure_issues above.
           best_matching_issue = Gitlab::ObjectifiedHash.new(best_matching_issue)

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

@@ -9,8 +9,8 @@ module GitlabQuality
         include Concerns::Utils
 
         def initialize(token:, input_files:, related_issues_file: nil, project: nil, confidential: false, dry_run: false, **_kwargs)
-          @project = project
           @token = token
+          @project = project
           @gitlab = (dry_run ? GitlabClient::IssuesDryClient : GitlabClient::IssuesClient).new(token: token, project: project)
           @files = Array(input_files)
           @confidential = confidential
@@ -29,7 +29,7 @@ module GitlabQuality
 
         private
 
-        attr_reader :gitlab, :files, :project, :issue_type, :confidential, :issue_logger, :token
+        attr_reader :token, :gitlab, :files, :project, :issue_type, :confidential, :issue_logger
 
         def run!
           raise NotImplementedError
@@ -47,7 +47,7 @@ module GitlabQuality
           # Should not be more than 50 characters if we want it indexed.
           #
           # See https://gitlab.com/gitlab-org/ruby/gems/gitlab_quality-test_tooling/-/issues/27#note_1607276486
-          OpenSSL::Digest.hexdigest('SHA256', "#{test.file}#{test.name}")[..40]
+          OpenSSL::Digest.hexdigest('SHA256', "#{test.relative_file}#{test.name}")[..40]
         end
 
         def new_issue_description(test)
@@ -58,8 +58,8 @@ module GitlabQuality
           | Field | Value |
           | ------ | ------ |
           | File URL | #{test.test_file_link} |
-          | Filename | `#{test.file}` |
-          | Description | `#{test.name}` |
+          | Filename | `#{test.relative_file}` |
+          | 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,18 +32,20 @@ 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(token: @results_issue_project_token, project: @results_issue_project, 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|
               next if test.file.include?('/features/sanity/') || test.skipped?
 
-              puts "Reporting test: #{test.file} | #{test.name}\n"
+              puts "Reporting test: #{test.relative_file} | #{test.name}\n"
 
               report_test(test)
             end

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/summary_table.rb

@@ -14,6 +14,7 @@ module GitlabQuality
       def self.collect_results(input_files, **options)
         sort_by = options[:sort_by]
         sort_direction = options[:sort_direction]
+        hide_passed_tests = options[:hide_passed_tests]
 
         stage_wise_results = Dir.glob(input_files).each_with_object([]) do |report_file, stage_wise_results|
           stage_hash = {}
@@ -21,6 +22,8 @@ module GitlabQuality
 
           report_stats = Nokogiri::XML(File.open(report_file)).children[0].attributes
 
+          next if hide_passed_tests && report_stats["failures"].value.to_i.zero? && report_stats["errors"].value.to_i.zero?
+
           stage_hash["Total"] = report_stats["tests"].value
           stage_hash["Failures"] = report_stats["failures"].value
           stage_hash["Errors"] = report_stats["errors"].value

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

@@ -13,7 +13,7 @@ module GitlabQuality
 
         attr_reader :report
 
-        def initialize(report:, token: nil, project: nil, 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
@@ -28,7 +28,7 @@ module GitlabQuality
           raise NotImplementedError
         end
 
-        def file
+        def relative_file
           raise NotImplementedError
         end
 
@@ -56,6 +56,18 @@ module GitlabQuality
           failures.any?
         end
 
+        def file
+          @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'] || ""

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

@@ -10,7 +10,7 @@ module GitlabQuality
           report['name']
         end
 
-        def file
+        def relative_file
           report['file']&.delete_prefix('./')
         end
 
@@ -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

@@ -40,7 +40,7 @@ module GitlabQuality
           report.fetch('full_description').split('#<').first
         end
 
-        def file
+        def relative_file
           report.fetch('file_path').delete_prefix('./')
         end
 
@@ -178,12 +178,6 @@ module GitlabQuality
           test_level_specification.max_duration
         end
 
-        def test_file_link
-          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
-
         private
 
         def quarantine

data/lib/gitlab_quality/test_tooling/version.rb

@@ -2,6 +2,6 @@
 
 module GitlabQuality
   module TestTooling
-    VERSION = "1.29.1"
+    VERSION = "1.31.0"
   end
 end

metadata

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