gitlab_quality-test_tooling 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7237e27f052e0d9934df2a8ad8d8d413cb1db81b4bc30fd334458cd05ee23494
-  data.tar.gz: 1775470edd1236836c8f4a2f729d40d642d6e9fde2c40630b79925f84c821e8c
+  metadata.gz: 7ac9e211aa370a7163c4173c7a1dec921cbf237fc406d28e1c3c5cfe296e9750
+  data.tar.gz: 99a599cdb8f65c74a489210004f9b34918f03c0d3eb54cd47e3e2dc5a1ee01a1
 SHA512:
-  metadata.gz: 0d77a24b7561c7d1b194a68290d0334d46e2c10120b3457f0288b53f161421bedccb6ff6c638e519d1a8c788e300b4b7ba543b7b5c45ad59b314ec05867e1be4
-  data.tar.gz: c384fda5b0c98647804c19880d581c0ccdf233dccd82c52b0f1aaf83fd56c729b3fdd33628433b9b278f48073a0e446ced610c5ee04408717dfbe919e9d3e77b
+  metadata.gz: '009549cacd5c20ec47ecc157801f272e00a4681decfa5fbf5ae62e252127f8482313857ad328cda1a68327ae7047c771ec7f6d39cfb0fa835834f9b1a53b519a'
+  data.tar.gz: 4bc8d5f83edf2c193ff2fadbc4ae525210a9d9c817dfc48ce35bfa9efcabdecd7801e59165e761a10c2a46d382bc276e1567d45e3ba64905649ce8abab530703

data/Gemfile.lock

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

data/exe/relate-failure-issue

@@ -27,6 +27,10 @@ options = OptionParser.new do |opts|
     params[:token] = token
   end
 
+  opts.on('-r', '--related-issues-file RELATED_ISSUES_FILE', String, 'The file path for the related issues') do |related_issues_file|
+    params[:related_issues_file] = related_issues_file
+  end
+
   opts.on('--system-log-files SYSTEM_LOG_FILES', String,
     'Include errors from system logs in failure issues') do |system_log_files|
     params[:system_logs] = system_log_files

data/exe/slow-test-issues

@@ -23,6 +23,10 @@ options = OptionParser.new do |opts|
     params[:token] = token
   end
 
+  opts.on('-r', '--related-issues-file RELATED_ISSUES_FILE', String, 'The file path for the related issues') do |related_issues_file|
+    params[:related_issues_file] = related_issues_file
+  end
+
   opts.on('--dry-run', "Perform a dry-run (don't create issues)") do
     params[:dry_run] = true
   end

data/lib/gitlab_quality/test_tooling/gitlab_issue_dry_client.rb

@@ -3,8 +3,8 @@
 module GitlabQuality
   module TestTooling
     class GitlabIssueDryClient < GitlabIssueClient
-      def create_issue(title:, description:, labels:, issue_type: 'issue')
-        attrs = { description: description, labels: labels }
+      def create_issue(title:, description:, labels:, issue_type: 'issue', confidential: false)
+        attrs = { description: description, labels: labels, confidential: confidential }
 
         puts "The following #{issue_type} would have been created:"
         puts "project: #{project}, title: #{title}, attrs: #{attrs}"

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

@@ -138,6 +138,8 @@ module GitlabQuality
             growth
             fulfillment
             enablement
+            self-managed
+            saas
           ]
 
           tests.sort_by do |test|

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    module Report
+      class IssueLogger
+        def initialize(file_path:)
+          @file_path = file_path
+          @data = File.exist?(file_path) ? JSON.parse(File.read(file_path)) : Hash.new { |h, k| h[k] = [] }
+        end
+
+        def collect(test, issues)
+          data[test.ci_job_url] += Array(issues).map(&:web_url)
+          data[test.ci_job_url].uniq!
+        end
+
+        def write
+          dirname = File.dirname(file_path)
+
+          FileUtils.mkdir_p(dirname) unless File.directory?(dirname)
+
+          File.write(file_path, JSON.pretty_generate(data))
+        end
+
+        private
+
+        attr_reader :file_path, :data
+      end
+    end
+  end
+end

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

@@ -55,15 +55,20 @@ module GitlabQuality
 
           TestResults::Builder.new(files).test_results_per_file do |test_results|
             puts "=> Reporting #{test_results.count} tests in #{test_results.path}"
+            process_test_results(test_results)
+          end
 
-            systemic_failures = systemic_failures_for_test_results(test_results)
+          write_issues_log_file
+        end
 
-            test_results.each do |test|
-              relate_failure_to_issue(test) if should_report?(test, systemic_failures)
-            end
+        def process_test_results(test_results)
+          systemic_failures = systemic_failures_for_test_results(test_results)
 
-            test_results.write
+          test_results.each do |test|
+            collect_issues(test, relate_failure_to_issue(test)) if should_report?(test, systemic_failures)
           end
+
+          test_results.write
         end
 
         def systemic_failures_for_test_results(test_results)

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

@@ -8,11 +8,12 @@ module GitlabQuality
       class ReportAsIssue
         include Concerns::Utils
 
-        def initialize(token:, input_files:, project: nil, confidential: false, dry_run: false, **_kwargs)
+        def initialize(token:, input_files:, related_issues_file: nil, project: nil, confidential: false, dry_run: false, **_kwargs)
           @project = project
           @gitlab = (dry_run ? GitlabIssueDryClient : GitlabIssueClient).new(token: token, project: project)
           @files = Array(input_files)
           @confidential = confidential
+          @issue_logger = IssueLogger.new(file_path: related_issues_file) if related_issues_file.present?
         end
 
         def invoke!
@@ -23,12 +24,20 @@ module GitlabQuality
 
         private
 
-        attr_reader :gitlab, :files, :project, :issue_type, :confidential
+        attr_reader :gitlab, :files, :project, :issue_type, :confidential, :issue_logger
 
         def run!
           raise NotImplementedError
         end
 
+        def collect_issues(test, issues)
+          issue_logger.collect(test, issues) if issue_logger.present?
+        end
+
+        def write_issues_log_file
+          issue_logger.write if issue_logger.present?
+        end
+
         def test_hash(test)
           OpenSSL::Digest.hexdigest('SHA256', "#{test.file}#{test.name}")
         end

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

@@ -30,6 +30,8 @@ module GitlabQuality
               create_slow_issue(test) if test.slow_test?
             end
           end
+
+          write_issues_log_file
         end
 
         def new_issue_title(test)
@@ -51,11 +53,15 @@ module GitlabQuality
 
           issues = find_issues(test, SEARCH_LABELS, state: 'opened')
 
-          issues.each do |issue|
-            puts "   => Existing issue link #{issue['web_url']}"
+          if issues.blank?
+            issues << create_issue(test)
+          else
+            issues.each do |issue|
+              puts "   => Existing issue link #{issue['web_url']}"
+            end
           end
 
-          create_issue(test) unless issues.any?
+          collect_issues(test, issues)
         rescue MultipleIssuesFound => e
           warn(e.message)
         end

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

@@ -11,7 +11,7 @@ module GitlabQuality
         end
 
         def stage
-          @stage ||= file[%r{(?:api|browser_ui)/(?:(?:\d+_)?(\w+))}, 1]
+          @stage ||= file[%r{(?:api|browser_ui)/(?:(?:\d+_)?(\w+))}, 1] || category
         end
 
         def name
@@ -22,6 +22,10 @@ module GitlabQuality
           raise NotImplementedError
         end
 
+        def category
+          raise NotImplementedError
+        end
+
         def skipped?
           raise NotImplementedError
         end

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

@@ -88,6 +88,10 @@ module GitlabQuality
           report['feature_category']
         end
 
+        def category
+          report['category']
+        end
+
         def run_time
           report['run_time'].to_f.round(2)
         end

data/lib/gitlab_quality/test_tooling/version.rb

@@ -2,6 +2,6 @@
 
 module GitlabQuality
   module TestTooling
-    VERSION = "1.4.0"
+    VERSION = "1.5.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_quality-test_tooling
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-10-27 00:00:00.000000000 Z
+date: 2023-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -377,6 +377,7 @@ files:
 - lib/gitlab_quality/test_tooling/report/concerns/results_reporter.rb
 - lib/gitlab_quality/test_tooling/report/concerns/utils.rb
 - lib/gitlab_quality/test_tooling/report/generate_test_session.rb
+- lib/gitlab_quality/test_tooling/report/issue_logger.rb
 - lib/gitlab_quality/test_tooling/report/merge_request_slow_tests_report.rb
 - lib/gitlab_quality/test_tooling/report/prepare_stage_reports.rb
 - lib/gitlab_quality/test_tooling/report/relate_failure_issue.rb