gitlab_quality-test_tooling 3.21.4 → 3.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc1eb2f60dd3f394c55bfbaff26309fbad61afd5eeceaa9c794092c1997f03eb
-  data.tar.gz: 5bfe5172b7ef0212b31b3eba7eb2483d1bebe57d2627d8b0863e0b5df61d7348
+  metadata.gz: a2bfb7b97e0b3a58ac7cbf7cc5f4ab8eb49bf3bf117fce216a34996ed4b4e471
+  data.tar.gz: 93b21c6cf0608d72292514aa34770db9f7402813ac6b0aeafc383b74f48202b9
 SHA512:
-  metadata.gz: 9b892716ac4868efafa4dfebea723db41e0eb62d4bf036bbc2b36d0cd79f9e1fd3d58a6e8104f8a8ecf4999dae3315cd9f4103f3ef4e43556f28a0a0192062a7
-  data.tar.gz: 5c690dc16665ac12a38abb803af01399ded95c49c5b071127c7e0d67fc7e26dd1c9c87c9d122b8d3262f6e8ae7660a093238bbb8ba822d156caf9b6ed26f3abc
+  metadata.gz: b58cd4d33e53fccf07cd9ca8a1113f0e93a50f33a2217f46c50c3d4ec3e5a1e2f777fbd5546ec20813385a913e989f29b56fbb936be7a5b0bff1fe4f2ffd9231
+  data.tar.gz: 06a62a7194ebbdc04483a4691eef617c3e2d82d553851f82430ddef4634c0a53f1cb4d3e8cda82fb648bc57ef6a2dda581e4c774cc3eacb622473d7c86d6466d

data/.rubocop_todo.yml

@@ -31,7 +31,6 @@ Layout/ClassStructure:
 Layout/LineEndStringConcatenationIndentation:
   Exclude:
     - 'lib/gitlab_quality/test_tooling/gitlab_client/merge_requests_dry_client.rb'
-    - 'lib/gitlab_quality/test_tooling/report/report_results.rb'
     - 'spec/gitlab_quality/test_tooling/gitlab_client/issues_client_spec.rb'
     - 'spec/gitlab_quality/test_tooling/report/failed_test_issue_spec.rb'
     - 'spec/gitlab_quality/test_tooling/report/slow_test_issue_spec.rb'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab_quality-test_tooling (3.21.4)
+    gitlab_quality-test_tooling (3.22.0)
       activesupport (>= 7.0)
       amatch (~> 0.4.1)
       fog-google (~> 1.25)

data/README.md

@@ -98,25 +98,6 @@ Usage: exe/relate-failure-issue [options]
     -h, --help                       Show the usage
 ```
 
-### `exe/report-results`
-
-```shell
-Purpose: Report test results from RSpec report files (JSON or JUnit XML) in GitLab test cases and result issues
-Usage: exe/report-results [options]
-    -i, --input-files INPUT_FILES    RSpec report files (JSON or JUnit XML)
-        --test-case-project TEST_CASE_PROJECT
-                                     Can be an integer or a group/project string
-    -t TEST_CASE_PROJECT_TOKEN,      A valid access token with `api` scope and Reporter permission in TEST_CASE_PROJECT
-        --test-case-project-token
-        --results-issue-project RESULTS_ISSUE_PROJECT
-                                     Can be an integer or a group/project string
-    -r RESULTS_ISSUE_PROJECT_TOKEN,  A valid access token with `api` scope and Reporter permission in RESULTS_ISSUE_PROJECT
-        --results-issue-project-token
-        --dry-run                    Perform a dry-run (don't create/update issues or test cases)
-    -v, --version                    Show the version
-    -h, --help                       Show the usage
-```
-
 ### `exe/update-screenshot-paths`
 
 ```shell

data/exe/test-coverage

@@ -283,8 +283,7 @@ when :full_export
   # Export test-to-file mappings
   test_file_mapping_data = GitlabQuality::TestTooling::CodeCoverage::TestFileMappingData.new(
     test_to_sources,
-    tests_to_categories: tests_to_categories,
-    feature_categories_to_teams: category_owners.feature_categories_to_teams
+    tests_to_categories: tests_to_categories
   )
   test_file_mappings_table = GitlabQuality::TestTooling::CodeCoverage::ClickHouse::TestFileMappingsTable.new(**shared_clickhouse_data)
   test_file_mappings_table.push(test_file_mapping_data.as_db_table)

data/lib/gitlab_quality/test_tooling/code_coverage/click_house/test_file_mappings_table.rb

@@ -9,8 +9,7 @@ module GitlabQuality
         class TestFileMappingsTable < GitlabQuality::TestTooling::CodeCoverage::ClickHouse::Table
           TABLE_NAME = "test_file_mappings"
 
-          # Override push to filter out duplicate mappings before inserting
-          # This prevents accumulating 36M duplicate rows per day in ReplacingMergeTree
+          # Override push to skip mappings already stored with the same values.
           #
           # @param data [Array<Hash>] Code coverage related data to be pushed to ClickHouse
           # @return [nil]
@@ -18,7 +17,9 @@ module GitlabQuality
             return logger.warn("#{LOG_PREFIX} No data found, skipping ClickHouse export!") if data.empty?
 
             logger.debug("#{LOG_PREFIX} Starting data export to ClickHouse")
+            @dropped_source_files = []
             sanitized_data = sanitize(data)
+            report_dropped_source_files(sanitized_data.size)
 
             return logger.warn("#{LOG_PREFIX} No valid data found after sanitization, skipping ClickHouse export!") if sanitized_data.empty?
 
@@ -26,14 +27,14 @@ module GitlabQuality
             new_or_changed_records = filter_duplicates(sanitized_data)
 
             if new_or_changed_records.empty?
-              logger.info("#{LOG_PREFIX} All #{sanitized_data.size} mappings already exist with same values, skipping insert to #{full_table_name}")
+              logger.info("#{LOG_PREFIX} None of the #{sanitized_data.size} mappings need writing to #{full_table_name}, skipping insert")
               return
             end
 
             client.insert_json_data(table_name, new_or_changed_records)
             skipped_count = sanitized_data.size - new_or_changed_records.size
             logger.info("#{LOG_PREFIX} Successfully pushed #{new_or_changed_records.size} new/changed records " \
-              "to #{full_table_name} (skipped #{skipped_count} duplicates)")
+              "to #{full_table_name} (#{skipped_count} not written)")
           rescue StandardError => e
             logger.error("#{LOG_PREFIX} Error occurred while pushing data to #{full_table_name}: #{e.message}")
             raise
@@ -62,30 +63,74 @@ module GitlabQuality
             false
           end
 
-          # @return [Hash] Transformed mapping data including timestamp and CI metadata
+          # @return [Hash, nil] Transformed mapping data including timestamp and CI metadata,
+          #   or nil when the source path cannot be made repo-relative
           def sanitized_data_record(record)
+            source_file = relative_source_file(record[:source_file])
+
+            if source_file.nil?
+              dropped_source_files << record[:source_file]
+              return
+            end
+
             {
               timestamp: time,
               test_file: record[:test_file],
-              source_file: record[:source_file],
+              source_file: source_file,
               # CI_PROJECT_PATH is set by GitLab CI runner and considered trusted infrastructure input.
               # In non-CI environments, this may be user-controlled, but sanitize_for_clickhouse
               # provides SQL injection protection.
               ci_project_path: ENV.fetch('CI_PROJECT_PATH', nil),
-              category: record[:category] || '',
-              group: record[:group] || '',
-              stage: record[:stage] || '',
-              section: record[:section] || ''
+              category: record[:category] || ''
             }
           end
 
-          # Filter out mappings that already exist in ClickHouse with identical enriched column values
-          # Only returns records that are:
-          # - New mappings (test_file + source_file combination doesn't exist), OR
-          # - Changed mappings (enriched columns category/group/stage/section differ from existing)
+          def dropped_source_files
+            @dropped_source_files ||= []
+          end
+
+          # Reports the records that relative_source_file could not make repo-relative, once
+          # for the whole run, and raises when none survived. A CI_PROJECT_DIR that does not
+          # match the artifact's paths drops every mapping, so warning per record buries the
+          # job trace in one line per mapping, and warning alone would let a wholly empty
+          # export finish green.
+          #
+          # @return [void]
+          def report_dropped_source_files(kept_count)
+            return if dropped_source_files.empty?
+
+            message = "#{LOG_PREFIX} Skipped #{dropped_source_files.size} records with " \
+              "non-relative source_file, samples: #{dropped_source_files.first(3).join(', ')}"
+
+            raise message if kept_count.zero?
+
+            logger.warn(message)
+          end
+
+          # The repo-relative form of a source path, which is what the table's
+          # valid_source_file_format constraint accepts. Returns nil when the path cannot be
+          # made relative or normalizes to nothing, and the caller drops that record, because
+          # ClickHouse rejects the whole insert batch on a constraint violation rather than
+          # the offending row.
+          #
+          # @return [String, nil]
+          def relative_source_file(path)
+            ci_project_dir = ENV.fetch('CI_PROJECT_DIR', nil)
+
+            relative = path
+            relative = relative.delete_prefix("#{ci_project_dir.chomp('/')}/") if ci_project_dir.present?
+            relative = relative.sub(%r{\A(\./)+}, '')
+
+            relative.presence unless relative.start_with?('/')
+          end
+
+          # The records worth writing: mappings this project has not stored yet, plus ones
+          # whose category changed, except that a blank never replaces a stored category.
+          # Re-sending an unchanged mapping costs a row that survives until the table's TTL
+          # expires it, because section and stage are still part of the sort key and the
+          # values written here no longer match the stored ones.
           #
-          # This prevents inserting 36M duplicate rows per day while still allowing updates when
-          # ownership (category/group/stage/section) changes over time.
+          # If the stored categories cannot be read, see #insertable_without_lookup.
           #
           # @param records [Array<Hash>] Sanitized records to insert
           # @return [Array<Hash>] Records that are new or have changed values
@@ -98,11 +143,11 @@ module GitlabQuality
 
             logger.debug("#{LOG_PREFIX} Checking for duplicate mappings in #{full_table_name}")
 
-            # Build a hash of existing mappings with their current enriched column values
-            # Key: "test_file|source_file", Value: {category, group, stage, section}
             existing_mappings = fetch_existing_mappings(ci_project_path, records)
+            return insertable_without_lookup(records) if existing_mappings.nil?
+
+            blank_suppressed = 0
 
-            # Filter records: keep only new or changed mappings
             new_or_changed = records.select do |record|
               key = "#{record[:test_file]}|#{record[:source_file]}"
               existing = existing_mappings[key]
@@ -110,27 +155,64 @@ module GitlabQuality
               # New mapping - doesn't exist yet
               next true if existing.nil?
 
-              # Existing mapping - check if enriched columns changed
-              existing[:category] != record[:category] ||
-                existing[:group] != record[:group] ||
-                existing[:stage] != record[:stage] ||
-                existing[:section] != record[:section]
+              # A blank category means this pipeline's rspec reports didn't cover the test,
+              # not that the test has no category: the mappings come from the Crystalball map,
+              # which lists every test file regardless of what ran. Writing the blank erases a
+              # known category, and readers resolving ownership through category get nothing.
+              if record[:category].blank? && existing[:category].present?
+                blank_suppressed += 1
+                next false
+              end
+
+              existing[:category] != record[:category]
             end
 
+            log_blank_suppressions(blank_suppressed)
             logger.debug("#{LOG_PREFIX} Found #{new_or_changed.size} new/changed mappings out of #{records.size} total")
             new_or_changed
           rescue StandardError => e
-            # If duplicate detection fails, fall back to inserting all records (safer than failing completely)
-            logger.warn("#{LOG_PREFIX} Failed to check for duplicates: #{e.message}. Inserting all records.")
-            records
+            logger.warn("#{LOG_PREFIX} Failed to check for duplicates: #{e.message}")
+            insertable_without_lookup(records)
+          end
+
+          # What to write when the stored categories could not be read. Records carrying a
+          # category still go in, because a failed read must not silently drop mappings.
+          # Blanks are held back: with no stored value to compare against they look new, and
+          # writing one replaces whatever category is already there. The mapping comes back
+          # on the next export that can read.
+          #
+          # @param records [Array<Hash>] Sanitized records to insert
+          # @return [Array<Hash>] Records that carry a category
+          def insertable_without_lookup(records)
+            with_category = records.reject { |record| record[:category].blank? }
+
+            logger.warn("#{LOG_PREFIX} No duplicate check possible; inserting " \
+              "#{with_category.size} of #{records.size} mappings and holding back " \
+              "#{records.size - with_category.size} with no category")
+
+            with_category
+          end
+
+          # Reported at info because it is the only signal that a pipeline's reports were
+          # incomplete. A steady non-zero count across runs means categories are arriving
+          # from fewer reports than there are test files in the map.
+          #
+          # @param count [Integer] Mappings whose stored category was kept over an incoming blank
+          # @return [nil]
+          def log_blank_suppressions(count)
+            return unless count.positive?
+
+            logger.info("#{LOG_PREFIX} Kept the stored category for #{count} mappings " \
+              "this pipeline's reports did not cover")
           end
 
-          # Fetch existing mappings from ClickHouse for the given project
-          # Returns a hash mapping "test_file|source_file" => {category, group, stage, section}
+          # The category currently stored against each of this project's mappings. Only
+          # filter_duplicates reads it.
           #
           # @param ci_project_path [String] The CI project path to filter by
           # @param records [Array<Hash>] Records being inserted (used to limit query scope)
-          # @return [Hash] Existing mappings with their enriched column values
+          # @return [Hash, nil] "test_file|source_file" => { category: String }, or nil when
+          #   the read fails. An empty Hash means the table holds nothing for this project.
           def fetch_existing_mappings(ci_project_path, records) # rubocop:disable Metrics/AbcSize
             # Query for ALL latest mappings for this project
             # We filter in Ruby rather than building dynamic SQL to avoid injection risks
@@ -142,10 +224,7 @@ module GitlabQuality
               SELECT
                 test_file,
                 source_file,
-                argMax(category, timestamp) AS category,
-                argMax(`group`, timestamp) AS `group`,
-                argMax(stage, timestamp) AS stage,
-                argMax(section, timestamp) AS section
+                argMax(category, timestamp) AS category
               FROM #{full_table_name}
               WHERE ci_project_path = {project_path:String}
               GROUP BY test_file, source_file
@@ -163,16 +242,11 @@ module GitlabQuality
               next if test_files_set && !test_files_set.include?(row['test_file'])
 
               key = "#{row['test_file']}|#{row['source_file']}"
-              hash[key] = {
-                category: row['category'],
-                group: row['group'],
-                stage: row['stage'],
-                section: row['section']
-              }
+              hash[key] = { category: row['category'] }
             end
           rescue StandardError => e
             logger.warn("#{LOG_PREFIX} Failed to fetch existing mappings: #{e.message}")
-            {} # Return empty hash on error (will treat all records as new)
+            nil # nil, not {}: an empty table and an unreadable one need different handling
           end
 
           # Sanitize string for ClickHouse by escaping single quotes and backslashes

data/lib/gitlab_quality/test_tooling/code_coverage/test_file_mapping_data.rb

@@ -8,34 +8,37 @@ module GitlabQuality
         #   mapped to all source files they cover
         # @param [Hash<String, Array<String>>] tests_to_categories Test files
         #   mapped to their feature categories
-        # @param [Hash<String, Hash>] feature_categories_to_teams Feature categories
-        #   mapped to their org hierarchy (group, stage, section)
-        def initialize(test_to_sources, tests_to_categories: {}, feature_categories_to_teams: {})
+        def initialize(test_to_sources, tests_to_categories: {})
           @test_to_sources = test_to_sources
           @tests_to_categories = tests_to_categories
-          @feature_categories_to_teams = feature_categories_to_teams
         end
 
+        # Rows for shared.test_file_mappings, one per test-and-source pair.
+        #
+        # Carries no group, stage or section on purpose. Those describe the category
+        # rather than the mapping and change whenever stages.yml is reorganised, so
+        # storing them on every mapping multiplies rows for no gain.
+        #
+        # Readers resolve ownership from shared.category_owners through category. That
+        # table keeps every historical row, up to 57 for one category, so a plain join
+        # fans out; dedupe it with ORDER BY category, timestamp DESC LIMIT 1 BY category.
+        #
         # @return [Array<Hash<Symbol, String>>] Mapping data formatted for database insertion
         # @example Return value
         #   [
         #     { test_file: "spec/models/user_spec.rb", source_file: "app/models/user.rb",
-        #       category: "team_planning", group: "project_management", stage: "plan", section: "dev" },
+        #       category: "team_planning" },
         #     ...
         #   ]
         def as_db_table
           @test_to_sources.flat_map do |test_file, source_files|
             category = @tests_to_categories[test_file]&.first || ''
-            team = @feature_categories_to_teams[category] || {}
 
             source_files.map do |source_file|
               {
                 test_file: test_file,
                 source_file: source_file,
-                category: category,
-                group: team[:group] || '',
-                stage: team[:stage] || '',
-                section: team[:section] || ''
+                category: category
               }
             end
           end

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

@@ -134,14 +134,6 @@ module GitlabQuality
           issue&.labels&.to_set || Set.new
         end
 
-        def update_labels(issue, test, new_labels = Set.new)
-          labels = up_to_date_labels(test: test, issue: issue, new_labels: new_labels)
-
-          return if issue_labels(issue) == labels
-
-          gitlab.edit_issue(iid: issue.iid, options: { labels: labels.to_a })
-        end
-
         # Infer labels from the test, and optionally from the issue and new_labels in arguments
         #
         # Called when we're updating a test health issue with a new test report.

data/lib/gitlab_quality/test_tooling/version.rb

@@ -2,6 +2,6 @@
 
 module GitlabQuality
   module TestTooling
-    VERSION = "3.21.4"
+    VERSION = "3.22.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_quality-test_tooling
 version: !ruby/object:Gem::Version
-  version: 3.21.4
+  version: 3.22.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-09-03 00:00:00.000000000 Z
+date: 2026-09-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -437,7 +437,6 @@ executables:
 - post-to-slack
 - prepare-stage-reports
 - relate-failure-issue
-- report-results
 - slow-test-issues
 - slow-test-merge-request-report-note
 - sync-category-owners
@@ -471,7 +470,6 @@ files:
 - exe/post-to-slack
 - exe/prepare-stage-reports
 - exe/relate-failure-issue
-- exe/report-results
 - exe/slow-test-issues
 - exe/slow-test-merge-request-report-note
 - exe/sync-category-owners
@@ -539,7 +537,6 @@ files:
 - lib/gitlab_quality/test_tooling/labels_inference.rb
 - lib/gitlab_quality/test_tooling/report/concerns/group_and_category_labels.rb
 - lib/gitlab_quality/test_tooling/report/concerns/issue_reports.rb
-- 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/failed_test_issue.rb
 - lib/gitlab_quality/test_tooling/report/feature_readiness/report_on_epic.rb
@@ -561,9 +558,6 @@ files:
 - lib/gitlab_quality/test_tooling/report/prepare_stage_reports.rb
 - lib/gitlab_quality/test_tooling/report/relate_failure_issue.rb
 - lib/gitlab_quality/test_tooling/report/report_as_issue.rb
-- lib/gitlab_quality/test_tooling/report/report_results.rb
-- lib/gitlab_quality/test_tooling/report/results_in_issues.rb
-- lib/gitlab_quality/test_tooling/report/results_in_test_cases.rb
 - lib/gitlab_quality/test_tooling/report/slow_test_issue.rb
 - lib/gitlab_quality/test_tooling/report/update_screenshot_path.rb
 - lib/gitlab_quality/test_tooling/runtime/env.rb

data/exe/report-results

@@ -1,62 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "optparse"
-
-require_relative "../lib/gitlab_quality/test_tooling"
-
-params = {}
-
-options = OptionParser.new do |opts|
-  opts.banner = "Usage: #{$PROGRAM_NAME} [options]"
-
-  opts.on('-i', '--input-files INPUT_FILES', String, 'RSpec report files (JSON or JUnit XML)') do |input_files|
-    params[:input_files] = input_files
-  end
-
-  opts.on('--test-case-project TEST_CASE_PROJECT', String,
-    'Can be an integer or a group/project string') do |test_case_project|
-    params[:test_case_project] = test_case_project
-  end
-
-  opts.on('-t', '--test-case-project-token TEST_CASE_PROJECT_TOKEN', String,
-    'A valid access token with `api` scope and Reporter permission in TEST_CASE_PROJECT') do |test_case_project_token|
-    params[:test_case_project_token] = test_case_project_token
-  end
-
-  opts.on('--results-issue-project RESULTS_ISSUE_PROJECT', String,
-    'Can be an integer or a group/project string') do |results_issue_project|
-    params[:results_issue_project] = results_issue_project
-  end
-
-  opts.on('-r', '--results-issue-project-token RESULTS_ISSUE_PROJECT_TOKEN', String,
-    'A valid access token with `api` scope and Reporter permission in RESULTS_ISSUE_PROJECT') do |results_issue_project_token|
-    params[:results_issue_project_token] = results_issue_project_token
-  end
-
-  opts.on('--dry-run', "Perform a dry-run (don't create/update issues or test cases)") do
-    params[:dry_run] = true
-  end
-
-  opts.on_tail('-v', '--version', 'Show the version') do
-    require_relative "../lib/gitlab_quality/test_tooling/version"
-    puts "#{$PROGRAM_NAME} : #{GitlabQuality::TestTooling::VERSION}"
-    exit
-  end
-
-  opts.on_tail('-h', '--help', 'Show the usage') do
-    puts "Purpose: Report test results from RSpec report files (JSON or JUnit XML) in GitLab test cases and result issues"
-    puts opts
-    exit
-  end
-
-  opts.parse(ARGV)
-end
-
-if params.any?
-  GitlabQuality::TestTooling::Report::ReportResults.new(**params).invoke!
-else
-  puts options
-  exit 1
-end

data/lib/gitlab_quality/test_tooling/report/concerns/results_reporter.rb

@@ -1,88 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_support/core_ext/enumerable'
-
-module GitlabQuality
-  module TestTooling
-    module Report
-      module Concerns
-        module ResultsReporter
-          include Concerns::Utils
-
-          TEST_CASE_RESULTS_SECTION_TEMPLATE = "\n\n### DO NOT EDIT BELOW THIS LINE\n\nActive and historical test results:"
-
-          def find_issue(test)
-            issues = search_for_issues(test)
-
-            warn(%(Too many #{issue_type}s found with the file path "#{test.file}" and name "#{test.name}")) if issues.many?
-
-            puts "Found existing #{issue_type}: #{issues.first.web_url}" unless issues.empty?
-
-            issues.first
-          end
-
-          def find_issue_by_iid(iid)
-            issues = gitlab.find_issues(iid: iid) do |issue|
-              issue.state == 'opened' && issue.issue_type == issue_type
-            end
-
-            warn(%(#{issue_type} iid "#{iid}" not valid)) if issues.empty?
-
-            issues.first
-          end
-
-          def issue_title_needs_updating?(issue, test)
-            issue.title.strip != title_from_test(test) && !%w[canary production preprod release].include?(pipeline)
-          end
-
-          def new_issue_labels(_test)
-            %w[E2E status::automated suppress-contributor-links]
-          end
-
-          def up_to_date_labels(test:, issue: nil, new_labels: Set.new)
-            labels = super
-            labels |= new_issue_labels(test).to_set
-            labels.delete_if { |label| label.start_with?("#{pipeline}::") }
-            labels << (test.failures.empty? ? "#{pipeline}::passed" : "#{pipeline}::failed")
-          end
-
-          def update_issue(issue, test)
-            update_params = {}
-
-            old_title = issue.title.strip
-            new_title = title_from_test(test)
-
-            if old_title != new_title
-              update_params[:title] = new_title
-              warn(%(#{issue_type} title needs to be updated from '#{old_title}' to '#{new_title}'))
-            end
-
-            old_description = issue.description
-            new_description = updated_description(issue, test)
-
-            if old_description != new_description
-              warn(%(#{issue_type} description needs to be updated from '#{old_description}' to '#{new_description}'))
-              update_params[:description] = new_description
-            end
-
-            return if update_params.empty?
-
-            gitlab.edit_issue(iid: issue.iid, options: update_params)
-          end
-
-          private
-
-          def search_term(test)
-            %("#{partial_file_path(test.file)}" "#{search_safe(test.name)}")
-          end
-
-          def search_for_issues(test)
-            gitlab.find_issues(options: { search: search_term(test) }) do |issue|
-              issue.state == 'opened' && issue.issue_type == issue_type && issue.title.strip == title_from_test(test)
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,77 +0,0 @@
-# frozen_string_literal: true
-
-module GitlabQuality
-  module TestTooling
-    module Report
-      # Uses the API to:
-      # - create or update test cases
-      # - create or update issues
-      # based on the results of tests from RSpec run result files.
-      class ReportResults < ReportAsIssue
-        attr_accessor :testcase_project_reporter, :results_issue_project_reporter, :files, :test_case_project,
-          :results_issue_project, :gitlab
-
-        def initialize(
-          test_case_project_token:, results_issue_project_token:, input_files:, test_case_project: nil, results_issue_project: nil, dry_run: false,
-          **kwargs)
-          @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(
-            token: results_issue_project_token, input_files: input_files, project: results_issue_project, dry_run: dry_run, **kwargs)
-          @test_case_project = test_case_project
-          @results_issue_project = results_issue_project
-          @files = Array(input_files)
-          @gitlab = testcase_project_reporter.gitlab
-        end
-
-        def validate_input!
-          assert_input_files!(files)
-          gitlab.assert_user_permission!
-        end
-
-        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: 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.relative_file} | #{test.name}\n"
-
-              report_test(test)
-            end
-          end
-        end
-
-        def report_test(test)
-          testcase = testcase_project_reporter.find_or_create_testcase(test)
-
-          result_issue, is_new = results_issue_project_reporter.get_related_issue(testcase, test)
-
-          testcase_project_reporter.add_result_issue_link_to_testcase(testcase, result_issue, test) if is_new
-
-          testcase_project_reporter.update_testcase(testcase, test)
-
-          labels_updated = results_issue_project_reporter.update_issue_labels(result_issue, test)
-          note_posted = results_issue_project_reporter.post_note(result_issue, test)
-
-          if labels_updated || note_posted
-            puts "Issue updated: #{result_issue.web_url}"
-          else
-            puts "Test passed, no results issue update needed."
-          end
-        end
-        # rubocop:enable Metrics/AbcSize
-      end
-    end
-  end
-end

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

@@ -1,123 +0,0 @@
-# frozen_string_literal: true
-
-module GitlabQuality
-  module TestTooling
-    module Report
-      # Uses the API to create or update GitLab test result issues with the results of tests from RSpec report files.
-      class ResultsInIssues < ReportAsIssue
-        include Concerns::ResultsReporter
-
-        def initialize(**kwargs)
-          super
-          @issue_type = 'issue'
-        end
-
-        def get_related_issue(testcase, test)
-          issue = find_linked_results_issue_by_iid(testcase, test)
-          is_new = false
-
-          if issue
-            issue = update_issue(issue, test) if issue_title_needs_updating?(issue, test)
-          else
-            puts "No valid issue link found."
-            issue = find_or_create_results_issue(test)
-            is_new = true
-          end
-
-          [issue, is_new]
-        end
-
-        def update_issue_labels(issue, test)
-          new_labels = issue_labels(issue)
-          new_labels |= ['Testcase Linked']
-
-          update_labels(issue, test, new_labels)
-        end
-
-        def post_note(issue, test)
-          return false if test.skipped?
-          return false if test.failures.empty?
-
-          note = note_content(test)
-
-          gitlab.find_issue_discussions(iid: issue.iid).each do |discussion|
-            next unless new_note_matches_discussion?(note, discussion)
-
-            gitlab.add_note_to_issue_discussion_as_thread(
-              iid: issue.iid,
-              discussion_id: discussion.id,
-              note: failure_summary)
-            return true
-          end
-
-          gitlab.create_issue_note(iid: issue.iid, note: note)
-        end
-
-        private
-
-        def find_linked_results_issue_by_iid(testcase, _test)
-          iid = issue_iid_from_testcase(testcase)
-
-          return unless iid
-
-          find_issue_by_iid(iid)
-        end
-
-        def find_or_create_results_issue(test)
-          find_issue(test) || create_issue(test)
-        end
-
-        def issue_iid_from_testcase(testcase)
-          results = testcase.description.partition(TEST_CASE_RESULTS_SECTION_TEMPLATE).last if testcase.description.include?(TEST_CASE_RESULTS_SECTION_TEMPLATE)
-
-          return unless results
-
-          issue_iid = results.split('/').last
-
-          issue_iid&.to_i
-        end
-
-        def note_content(test)
-          errors = test.failures.each_with_object([]) do |failure, text|
-            text << <<~TEXT
-              Error:
-              ```
-              #{failure['message']}
-              ```
-
-              Stacktrace:
-              ```
-              #{failure['stacktrace']}
-              ```
-            TEXT
-          end.join("\n\n")
-
-          "#{failure_summary}\n\n#{errors}"
-        end
-
-        def failure_summary
-          summary = [%(:x: ~"#{pipeline}::failed")]
-          summary << "in job `#{Runtime::Env.ci_job_name}` in #{Runtime::Env.ci_job_url}"
-          summary.join(' ')
-        end
-
-        def new_note_matches_discussion?(note, discussion)
-          note_error = error_and_stack_trace(note)
-          discussion_error = error_and_stack_trace(discussion.notes.first['body'])
-
-          return false if note_error.empty? || discussion_error.empty?
-
-          note_error == discussion_error
-        end
-
-        def error_and_stack_trace(text)
-          text.strip[/Error:(.*)/m, 1].to_s
-        end
-
-        def updated_description(_issue, test)
-          new_issue_description(test)
-        end
-      end
-    end
-  end
-end

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

@@ -1,96 +0,0 @@
-# frozen_string_literal: true
-
-module GitlabQuality
-  module TestTooling
-    module Report
-      # Uses the API to create or update GitLab test cases with the results of tests from RSpec report files.
-      class ResultsInTestCases < ReportAsIssue
-        include Concerns::ResultsReporter
-
-        attr_reader :issue_type, :gitlab
-
-        def initialize(**kwargs)
-          super
-          @issue_type = 'test_case'
-        end
-
-        def find_or_create_testcase(test)
-          find_testcase(test) || create_issue(test)
-        end
-
-        def add_result_issue_link_to_testcase(testcase, result_issue, _test)
-          results_section = testcase.description.include?(TEST_CASE_RESULTS_SECTION_TEMPLATE) ? '' : TEST_CASE_RESULTS_SECTION_TEMPLATE
-
-          gitlab.edit_issue(iid: testcase.iid,
-            options: { description: (testcase.description + results_section + "\n\n#{result_issue.web_url}") })
-          puts "Added results issue #{result_issue.web_url} link to test case #{testcase.web_url}"
-        end
-
-        def update_testcase(testcase, test)
-          puts "Labels updated for test case #{testcase.web_url}." if update_labels(testcase, test)
-          puts "Quarantine section updated for test case #{testcase.web_url}." if update_quarantine_section(testcase, test)
-        end
-
-        private
-
-        def find_testcase(test)
-          testcase = find_issue(test)
-          return unless testcase
-
-          if testcase_needs_updating?(testcase, test)
-            update_issue(testcase, test)
-          else
-            testcase
-          end
-        end
-
-        def new_issue_description(test)
-          quarantine_section = test.quarantine? && test.quarantine_issue ? "\n\n### Quarantine issue\n\n#{test.quarantine_issue}" : ''
-
-          "#{super}#{quarantine_section}\n\n#{execution_graph_section(test)}"
-        end
-
-        def execution_graph_section(test)
-          formatted_path = CGI.escape(test.relative_file)
-
-          <<~MKDOWN.strip
-            ### Executions
-
-            [Spec metrics on all environments](https://dashboards.devex.gitlab.net/d/739c1bdd-a436-452b-bddc-fccb4d055768/single-test-overview?var-file_path=#{formatted_path})
-          MKDOWN
-        end
-
-        def updated_description(testcase, test)
-          historical_results_section = testcase.description.match(/### DO NOT EDIT BELOW THIS LINE[\s\S]+/)
-
-          "#{new_issue_description(test)}\n\n#{historical_results_section}"
-        end
-
-        def testcase_needs_updating?(testcase, test)
-          return false if %w[canary production preprod release].include?(pipeline)
-          return true if issue_title_needs_updating?(testcase, test)
-
-          !testcase.description.include?(execution_graph_section(test))
-        end
-
-        def quarantine_section_needs_updating?(testcase, test)
-          if test.quarantine? && test.quarantine_issue
-            return false if testcase.description.include?(test.quarantine_issue)
-          else
-            return false unless testcase.description.include?('Quarantine issue')
-          end
-
-          true
-        end
-
-        def update_quarantine_section(testcase, test)
-          return unless quarantine_section_needs_updating?(testcase, test)
-
-          new_description = updated_description(testcase, test)
-
-          gitlab.edit_issue(iid: testcase.iid, options: { description: new_description })
-        end
-      end
-    end
-  end
-end