gitlab_quality-test_tooling 1.29.0 → 1.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ca3b15faac90436068b21df05071cbcd06dd1a71d33b3220a58d17201a893a2d
-  data.tar.gz: dee6c41cfe097f6af193890eee46a95a17f1fa7724377fb8529f75142931bbb1
+  metadata.gz: ba1faa3616687c598a2d2b69e469c90d92ba687a9693ed87367998e1a747313d
+  data.tar.gz: 1486372498629cb6e21b63a999a856f40e7b393295f12bcf52cd8f74c4803efc
 SHA512:
-  metadata.gz: ab45b4d7059cfb911b103f952f0e072dd578057a24fb539ac322087b09d4cd646ecdeb0c7a528427cd378f67a056d374a663c1effb62945a2001b18fea26af8c
-  data.tar.gz: 387923350e8554c3fd99d17d3a1ea502768d4cfc251805a5c76a17bca950ef28e616ec161eb329c0482b678f5e3a037c3235ca6562eb93008e57c6963838a3ba
+  metadata.gz: f67bc6c00ad80ab20e33b7f69356a30e27415674211ce14c4ceb17dd80d7621ce6a441a279889e344b8e8a87d1488dec5e799f5c712d0eae629d44ee2b6019e6
+  data.tar.gz: ceb443481a7528bca028c3070dcf71739bdd9b90a4173890dbd5f54a4d0e22ef2b9458c0d00ac13bf23dad0354bde5465a153a4f23c92c9ccf0c44cef04822a9

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab_quality-test_tooling (1.29.0)
+    gitlab_quality-test_tooling (1.30.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

@@ -9,8 +9,7 @@ module GitlabQuality
         def initialize(file_path:, ref:, **kwargs)
           @file_path = file_path
           @ref = ref
-
-          super
+          super(**kwargs)
         end
 
         def file_contents
@@ -20,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/report/health_problem_reporter.rb

@@ -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, token: token, project: project).test_results_per_file do |test_results|
+          TestResults::Builder.new(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)

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

@@ -9,6 +9,7 @@ module GitlabQuality
         SLOW_TEST_NOTE_SOURCE_CODE = 'Generated by [`gitlab_quality-test_tooling`](https://gitlab.com/gitlab-org/ruby/gems/gitlab_quality-test_tooling/-/blob/main/lib/gitlab_quality/test_tooling/report/merge_request_slow_tests_report.rb).'
 
         def initialize(token:, input_files:, merge_request_iid:, project: nil, dry_run: false, **_kwargs)
+          @token = token
           @project = project
           @gitlab_merge_request = (dry_run ? GitlabClient::MergeRequestsDryClient : GitlabClient::MergeRequestsClient).new(token: token, project: project)
           @files = Array(input_files)

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

@@ -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

@@ -10,7 +10,6 @@ module GitlabQuality
 
         def initialize(token:, input_files:, related_issues_file: nil, project: nil, confidential: false, dry_run: false, **_kwargs)
           @project = project
-          @token = token
           @gitlab = (dry_run ? GitlabClient::IssuesDryClient : GitlabClient::IssuesClient).new(token: token, project: project)
           @files = Array(input_files)
           @confidential = confidential
@@ -29,7 +28,7 @@ module GitlabQuality
 
         private
 
-        attr_reader :gitlab, :files, :project, :issue_type, :confidential, :issue_logger, :token
+        attr_reader :gitlab, :files, :project, :issue_type, :confidential, :issue_logger
 
         def run!
           raise NotImplementedError
@@ -47,7 +46,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,7 +57,7 @@ module GitlabQuality
           | Field | Value |
           | ------ | ------ |
           | File URL | #{test.test_file_link} |
-          | Filename | `#{test.file}` |
+          | Filename | `#{test.relative_file}` |
           | Description | `#{test.name}` |
           | Test level | `#{test.level}` |
           | Hash | `#{test_hash(test)}` |

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

@@ -14,6 +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
           @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(
@@ -42,7 +43,7 @@ module GitlabQuality
             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/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,10 +13,8 @@ module GitlabQuality
 
         attr_reader :report
 
-        def initialize(report:, token: nil, project: nil, ref: 'master')
+        def initialize(report:, ref: 'master')
           @report = report
-          @token = token
-          @project = project
           @ref = ref
         end
 
@@ -28,7 +26,7 @@ module GitlabQuality
           raise NotImplementedError
         end
 
-        def file
+        def relative_file
           raise NotImplementedError
         end
 
@@ -56,6 +54,10 @@ module GitlabQuality
           failures.any?
         end
 
+        def file
+          @file ||= relative_file.start_with?('qa/') ? "qa/#{relative_file}" : relative_file
+        end
+
         def full_stacktrace
           failures.each do |failure|
             message = failure['message'] || ""
@@ -77,15 +79,15 @@ module GitlabQuality
 
         def files_client
           @files_client ||= GitlabClient::RepositoryFilesClient.new(
-            token: token,
-            project: project,
+            token: '',
+            project: 'gitlab-org/gitlab',
             file_path: file,
             ref: ref)
         end
 
         private
 
-        attr_reader :token, :project, :ref
+        attr_reader :ref
       end
     end
   end

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
 

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
 
@@ -179,9 +179,7 @@ module GitlabQuality
         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})"
+          "[`#{file}#L#{line_number}`](#{Runtime::Env.file_base_url}#{file}#L#{line_number})"
         end
 
         private

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

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

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

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

data/lib/gitlab_quality/test_tooling/version.rb

@@ -2,6 +2,6 @@
 
 module GitlabQuality
   module TestTooling
-    VERSION = "1.29.0"
+    VERSION = "1.30.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.0
+  version: 1.30.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-06-18 00:00:00.000000000 Z
+date: 2024-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control