gitlab_quality-test_tooling 1.7.0 → 1.8.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6924fc592c0dbb5e1ae0aed8710f7f7714c336bdd1d1d31b343e6edddd358ead
-  data.tar.gz: 0ebb5fbe0aeff0417193d4521cf52a78d849b83d116e08118b9cf87ee2655a71
+  metadata.gz: 4c8eda4a61584293cfb2f20a4ece0c5afd8963be75c56c5c3a1f71cbbf04a2ed
+  data.tar.gz: 72ea08e5a2fac3b5d9f0d5dada3bb71c7b655acbd7c03f4533e0bbe951be954e
 SHA512:
-  metadata.gz: f9a64cbae7e3a34ae66450ae7fe20181560dc6860950a92e53c5aaf61ab10343372044968b5a726bef51b082a45dd9150d6f161d93a45a4ccf75d550cf981be1
-  data.tar.gz: a77ea69469a02b3cbd089cade6be20347abc03cada1cf93fec8380456f000d083a914296e0b35faff573e60d73e4759abd1b5d224cb04e64b38862fe720cf65c
+  metadata.gz: fe64d9f93ff1343c36d1d478f63e9a4614587897b6414ec3a1f4c28fdd90ee1d245134e9350f546373350acf1f1355dd50d31da162a899d096ceb1114029767e
+  data.tar.gz: d4dd2ba2714e54c766592734481f7ba373692375f4c2011578f1b22da36fae3b8d58e721677e47ba214805d3798737c5ad6dec7711d586a46727029e555fb72e

data/Gemfile.lock

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

data/README.md

@@ -77,6 +77,8 @@ Usage: exe/prepare-stage-reports [options]
 Purpose: Relate test failures to failure issues from RSpec report files (JSON or JUnit XML)
 Usage: exe/relate-failure-issue [options]
     -i, --input-files INPUT_FILES    RSpec report files (JSON or JUnit XML)
+    -m METRICS_FILES,                Test metrics files (JSON)
+        --metrics-files
         --max-diff-ratio MAX_DIFF_RATO
                                      Max stacktrace diff ratio for failure issues detection
     -p, --project PROJECT            Can be an integer or a group/project string
@@ -128,11 +130,13 @@ Usage: exe/update-screenshot-paths [options]
 
 ```shell
 Purpose: Create slow test issues from JSON RSpec report files
-Usage: exe/slow-test-issue [options]
+Usage: exe/slow-test-issues [options]
     -i, --input-files INPUT_FILES    JSON RSpec report files JSON
     -p, --project PROJECT            Can be an integer or a group/project string
     -t, --token TOKEN                A valid access token with `api` scope and Maintainer permission in PROJECT
-        --dry-run                    Perform a dry-run (don't create note)
+    -r RELATED_ISSUES_FILE,          The file path for the related issues
+        --related-issues-file
+        --dry-run                    Perform a dry-run (don't create issues)
     -v, --version                    Show the version
     -h, --help                       Show the usage
 ```
@@ -141,13 +145,13 @@ Usage: exe/slow-test-issue [options]
 
 ```shell
 Purpose: Purpose: Create flaky test issues for any passed test coming from rspec-retry JSON report files
-Usage: exe/flaky-test-issue [options]
+Usage: exe/flaky-test-issues [options]
     -i, --input-files INPUT_FILES    JSON rspec-retry report files
     -p, --project PROJECT            Can be an integer or a group/project string
     -m MERGE_REQUEST_IID,            An integer merge request IID
         --merge_request_iid
     -t, --token TOKEN                A valid access token with `api` scope and Maintainer permission in PROJECT
-        --dry-run                    Perform a dry-run (don't create note)
+        --dry-run                    Perform a dry-run (don't create issues)
     -v, --version                    Show the version
     -h, --help                       Show the usage
 ```
@@ -158,11 +162,11 @@ Usage: exe/flaky-test-issue [options]
 Purpose: Create slow test note on merge requests from JSON RSpec report files
 Usage: exe/slow-test-merge-request-report-note [options]
     -i, --input-files INPUT_FILES    JSON RSpec report files JSON
-        --project PROJECT            Can be an integer or a group/project string
+    -p, --project PROJECT            Can be an integer or a group/project string
     -m MERGE_REQUEST_IID,            An integer merge request IID
         --merge_request_iid
     -t, --token TOKEN                A valid access token with `api` scope and Maintainer permission in PROJECT
-        --dry-run                    Perform a dry-run (don't create issues)
+        --dry-run                    Perform a dry-run (don't create note)
     -v, --version                    Show the version
     -h, --help                       Show the usage
 ```

data/exe/relate-failure-issue

@@ -15,6 +15,10 @@ options = OptionParser.new do |opts|
     params[:input_files] = input_files
   end
 
+  opts.on('-m', '--metrics-files METRICS_FILES', String, 'Test metrics files (JSON)') do |metrics_files|
+    params[:metrics_files] = metrics_files
+  end
+
   opts.on('--max-diff-ratio MAX_DIFF_RATO', Float, 'Max stacktrace diff ratio for failure issues detection') do |max_diff_ratio|
     params[:max_diff_ratio] = max_diff_ratio
   end

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

@@ -41,6 +41,7 @@ module GitlabQuality
           system_logs: [],
           base_issue_labels: nil,
           exclude_labels_for_search: nil,
+          metrics_files: [],
           **kwargs)
           super
           @max_diff_ratio = max_diff_ratio.to_f
@@ -49,11 +50,12 @@ module GitlabQuality
           @exclude_labels_for_search = Set.new(exclude_labels_for_search)
           @issue_type = 'issue'
           @commented_issue_list = Set.new
+          @metrics_files = Array(metrics_files)
         end
 
         private
 
-        attr_reader :max_diff_ratio, :system_logs, :base_issue_labels, :exclude_labels_for_search
+        attr_reader :max_diff_ratio, :system_logs, :base_issue_labels, :exclude_labels_for_search, :metrics_files
 
         def run!
           puts "Reporting test failures in `#{files.join(',')}` as issues in project `#{project}` via the API at `#{Runtime::Env.gitlab_api_base}`."
@@ -66,16 +68,39 @@ module GitlabQuality
           write_issues_log_file
         end
 
+        def test_metric_collections
+          @test_metric_collections ||= Dir.glob(metrics_files).map do |path|
+            TestMetrics::JsonTestMetricCollection.new(path)
+          end
+        end
+
         def process_test_results(test_results)
           systemic_failures = systemic_failures_for_test_results(test_results)
 
           test_results.each do |test|
             collect_issues(test, relate_failure_to_issue(test)) if should_report?(test, systemic_failures)
+
+            copy_failure_issue_to_test_metrics(test) if metrics_files.any?
           end
 
           test_results.write
         end
 
+        def copy_failure_issue_to_test_metrics(test)
+          failure_issue = test.failure_issue
+
+          return unless failure_issue
+
+          test_metric_collections.find do |test_metric_collection|
+            test_metric = test_metric_collection.metric_for_test_id(test.example_id)
+
+            if test_metric
+              test_metric.fields['failure_issue'] = failure_issue
+              test_metric_collection.write
+            end
+          end
+        end
+
         def systemic_failures_for_test_results(test_results)
           test_results
             .flat_map { |test| test.failures.map { |failure| failure['message'].lines.first.chomp } }
@@ -142,9 +167,7 @@ module GitlabQuality
         def pipeline_issues_with_similar_stacktrace(test)
           search_labels = (base_issue_labels + Set.new(%w[test failure::new])).to_a
           not_labels = exclude_labels_for_search.to_a
-          gitlab.find_issues(options: { labels: search_labels,
-                                        not: { labels: not_labels },
-                                        created_after: past_timestamp(2) }).select do |issue|
+          find_issues_created_after(past_timestamp(2), state: 'opened', labels: search_labels, not_labels: not_labels).select do |issue|
             job_url_from_issue = failed_issue_job_url(issue)
 
             next if pipeline != pipeline_env_from_job_url(job_url_from_issue)
@@ -171,6 +194,7 @@ module GitlabQuality
         def failure_issues(test)
           find_issues_for_test(
             test,
+            state: 'opened',
             labels: base_issue_labels + Set.new(%w[test]),
             not_labels: exclude_labels_for_search
           )

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

@@ -145,10 +145,19 @@ module GitlabQuality
         def find_issues_for_test(test, labels:, not_labels: Set.new, state: nil)
           search_options = { labels: labels.to_a, not: { labels: not_labels.to_a } }
           search_options[:state] = state if state
+          search_options[:search] = test.file.to_s.empty? ? test.name : partial_file_path(test.file)
+          search_options[:in] = 'title'
 
           gitlab.find_issues(options: search_options).find_all { |issue| issue_match_test?(issue, test) }
         end
 
+        def find_issues_created_after(timestamp, labels:, not_labels: Set.new, state: nil)
+          search_options = { labels: labels.to_a, not: { labels: not_labels.to_a }, created_after: timestamp }
+          search_options[:state] = state if state
+
+          gitlab.find_issues(options: search_options)
+        end
+
         def issue_match_test?(issue, test)
           issue_title = issue.title.strip
           test_file_path_found = !test.file.to_s.empty? && issue_title.include?(partial_file_path(test.file))

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

@@ -65,10 +65,18 @@ module GitlabQuality
           "1. #{Time.new.utc.strftime('%F')}: #{test.ci_job_url} (#{ENV.fetch('CI_PIPELINE_URL', 'pipeline url is missing')})"
         end
 
+        def slow_test_issues(test)
+          find_issues_for_test(
+            test,
+            state: 'opened',
+            labels: SEARCH_LABELS
+          )
+        end
+
         def create_slow_issue(test)
           puts "   => Finding existing issues for slow test '#{test.name}' (run time: #{test.run_time} seconds)..."
 
-          issues = find_issues_for_test(test, labels: SEARCH_LABELS, state: 'opened')
+          issues = slow_test_issues(test)
 
           if issues.blank?
             issues << create_issue(test)

data/lib/gitlab_quality/test_tooling/test_metric/json_test_metric.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    module TestMetric
+      class JsonTestMetric
+        attr_reader :metric
+
+        def initialize(metric)
+          @metric = metric
+        end
+
+        def name
+          metric.fetch('name')
+        end
+
+        def time
+          metric.fetch('time')
+        end
+
+        def tags
+          @tags ||= metric.fetch('tags')
+        end
+
+        def fields
+          @fields ||= metric.fetch('fields')
+        end
+
+        def to_json(*options)
+          as_json.to_json(*options)
+        end
+
+        private
+
+        def as_json
+          {
+            name: name,
+            time: time,
+            tags: tags,
+            fields: fields
+          }
+        end
+      end
+    end
+  end
+end

data/lib/gitlab_quality/test_tooling/test_metrics/json_test_metric_collection.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module GitlabQuality
+  module TestTooling
+    module TestMetrics
+      class JsonTestMetricCollection
+        include Enumerable
+
+        attr_reader :path, :metrics
+
+        def initialize(path)
+          @path = path
+          @metrics = process
+        end
+
+        def metric_for_test_id(test_id)
+          metrics.find do |metric|
+            metric.fields['id'] == test_id
+          end
+        end
+
+        def write
+          File.write(path, JSON.pretty_generate(metrics))
+        end
+
+        private
+
+        def parse
+          JSON.parse(File.read(path))
+        rescue JSON::ParserError
+          Runtime::Logger.debug("#{self.class.name}##{__method__} attempted to parse invalid JSON at path: #{path}")
+          {}
+        end
+
+        def process
+          parse.map do |test|
+            GitlabQuality::TestTooling::TestMetric::JsonTestMetric.new(test)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab_quality/test_tooling/version.rb

@@ -2,6 +2,6 @@
 
 module GitlabQuality
   module TestTooling
-    VERSION = "1.7.0"
+    VERSION = "1.8.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_quality-test_tooling
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.1
 platform: ruby
 authors:
 - GitLab Quality
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-11-29 00:00:00.000000000 Z
+date: 2023-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -422,6 +422,8 @@ files:
 - lib/gitlab_quality/test_tooling/system_logs/log_types/rails/graphql_log.rb
 - lib/gitlab_quality/test_tooling/system_logs/shared_fields.rb
 - lib/gitlab_quality/test_tooling/system_logs/system_logs_formatter.rb
+- lib/gitlab_quality/test_tooling/test_metric/json_test_metric.rb
+- lib/gitlab_quality/test_tooling/test_metrics/json_test_metric_collection.rb
 - lib/gitlab_quality/test_tooling/test_result/base_test_result.rb
 - lib/gitlab_quality/test_tooling/test_result/j_unit_test_result.rb
 - lib/gitlab_quality/test_tooling/test_result/json_test_result.rb