gitlab_quality-test_tooling 2.16.0 → 2.24.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0017f4373fb21a5d7313301ca050e381a4e462ec74a50a41aab37ab2afbd31d7
-  data.tar.gz: 10c3f5d6750b27058de16f482b3286b5bc96c57b3565f2494965d2d255512462
+  metadata.gz: b18e1abd81ec1c5b3c2d215c28fe53d68880a94d76b12c8693afb64d4b3cc9c2
+  data.tar.gz: f9b3ede1d0e05492f9395ffedfd3132ee528df4343074a89518cffe1521f466d
 SHA512:
-  metadata.gz: c4963020e2f5e405efd8e984966e918430eedb95ba354a6aff4fef068330cd3a152d68d5008b0d4325c5871654c54251206f11e2386f58fa34893e7338f5bb76
-  data.tar.gz: 5489a80567198e869517b5aca8e9f1d35871ec470d9e716f62c97e6b15e8afae7f5f7f7622e62e6273294f9268845e1874bcba9677c5f2f52bf5ccefb806774e
+  metadata.gz: 4f36f26d06eda97591aa4b46b5beb6db2563b269cc97e8cc987b6fb17310e836efeb2b600fef03a0d70305fbf82282bc251a6206c1e7123b80500fe3f6d6b6d5
+  data.tar.gz: 53f3dd0472c5539605440db234c7c6b3f361831af54e418dbc482a5ae9b608b33179c9bdc2d671fe2b0a99b11b873433c2fe3c8b6c0d0394fae2a58021fd7f08

data/.ruby-version

@@ -1 +1 @@
-3.2.5
+3.3.9

data/.tool-versions

@@ -1,2 +1,2 @@
-ruby 3.2.5
+ruby 3.3.9
 lefthook 1.7.14

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab_quality-test_tooling (2.16.0)
+    gitlab_quality-test_tooling (2.24.1)
       activesupport (>= 7.0, < 7.3)
       amatch (~> 0.4.1)
       fog-google (~> 1.24, >= 1.24.1)
@@ -128,13 +128,15 @@ GEM
       danger (>= 8.4.5)
       danger-gitlab (>= 8.0.0)
       rake
-    gitlab-styles (12.0.1)
-      rubocop (~> 1.62.1)
-      rubocop-factory_bot (~> 2.25.1)
-      rubocop-graphql (~> 1.5.0)
-      rubocop-performance (~> 1.20.2)
-      rubocop-rails (~> 2.24.0)
-      rubocop-rspec (~> 2.27.1)
+    gitlab-styles (13.1.0)
+      rubocop (= 1.71.1)
+      rubocop-capybara (~> 2.21.0)
+      rubocop-factory_bot (~> 2.26.1)
+      rubocop-graphql (~> 1.5.4)
+      rubocop-performance (~> 1.21.1)
+      rubocop-rails (~> 2.26.0)
+      rubocop-rspec (~> 3.0.4)
+      rubocop-rspec_rails (~> 2.30.0)
     google-apis-compute_v1 (0.108.0)
       google-apis-core (>= 0.15.0, < 2.a)
     google-apis-core (0.15.1)
@@ -262,7 +264,7 @@ GEM
       pry (>= 0.13, < 0.15)
     public_suffix (6.0.1)
     racc (1.8.1)
-    rack (3.1.7)
+    rack (3.2.1)
     rainbow (3.1.1)
     rake (13.2.1)
     rb-fsevent (0.11.2)
@@ -270,7 +272,7 @@ GEM
       ffi (~> 1.0)
     rbs (2.8.4)
     rchardet (1.8.0)
-    regexp_parser (2.9.2)
+    regexp_parser (2.11.2)
     representable (3.2.0)
       declarative (< 0.1.0)
       trailblazer-option (>= 0.1.1, < 0.2.0)
@@ -311,37 +313,37 @@ GEM
     rspec-support (3.13.1)
     rspec_junit_formatter (0.6.0)
       rspec-core (>= 2, < 4, != 2.12.0)
-    rubocop (1.62.1)
+    rubocop (1.71.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.38.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.32.3)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.40.0)
       parser (>= 3.3.1.0)
     rubocop-capybara (2.21.0)
       rubocop (~> 1.41)
-    rubocop-factory_bot (2.25.1)
-      rubocop (~> 1.41)
+    rubocop-factory_bot (2.26.1)
+      rubocop (~> 1.61)
     rubocop-graphql (1.5.4)
       rubocop (>= 1.50, < 2)
-    rubocop-performance (1.20.2)
+    rubocop-performance (1.21.1)
       rubocop (>= 1.48.1, < 2.0)
-      rubocop-ast (>= 1.30.0, < 2.0)
-    rubocop-rails (2.24.1)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rails (2.26.2)
       activesupport (>= 4.2.0)
       rack (>= 1.1)
-      rubocop (>= 1.33.0, < 2.0)
+      rubocop (>= 1.52.0, < 2.0)
       rubocop-ast (>= 1.31.1, < 2.0)
-    rubocop-rspec (2.27.1)
-      rubocop (~> 1.40)
-      rubocop-capybara (~> 2.17)
-      rubocop-factory_bot (~> 2.22)
+    rubocop-rspec (3.0.5)
+      rubocop (~> 1.61)
+    rubocop-rspec_rails (2.30.0)
+      rubocop (~> 1.61)
+      rubocop-rspec (~> 3, >= 3.0.1)
     ruby-progressbar (1.13.0)
     sawyer (0.9.2)
       addressable (>= 2.3.5)
@@ -409,7 +411,7 @@ PLATFORMS
 DEPENDENCIES
   climate_control (~> 1.2)
   gitlab-dangerfiles (~> 3.8)
-  gitlab-styles (~> 12.0)
+  gitlab-styles (~> 13.1)
   gitlab_quality-test_tooling!
   guard-rspec (~> 4.7)
   lefthook (~> 1.3)
@@ -425,4 +427,4 @@ DEPENDENCIES
   webmock (= 3.7.0)
 
 BUNDLED WITH
-   2.5.19
+   2.7.2

data/README.md

@@ -324,7 +324,7 @@ See an [example](https://gitlab.com/gitlab-org/gitlab/-/merge_requests/92580) fo
 
 [Automated gem release process](https://gitlab.com/gitlab-org/quality/pipeline-common#release-process) is used to release new version of `gitlab_quality-test_tooling` through pipelines, and this will:
 
-- Publish the gem: https://rubygems.org/gems/gitlab_quality-test_tooling
+- Publish the gem: https://rubygems.org/gems/gitlab_quality-test_tooling (once the version bump is done below in [Steps to release](https://gitlab.com/gitlab-org/ruby/gems/gitlab_quality-test_tooling#steps-to-release))
 - Add a release in the `gitlab_quality-test_tooling` project: https://gitlab.com/gitlab-org/ruby/gems/gitlab_quality-test_tooling/-/releases
 - Populate the release log with the API contents. For example: https://gitlab.com/api/v4/projects/19861191/repository/changelog?version=3.4.4
 

data/exe/epic-readiness-notification

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "optparse"
+require 'active_support/core_ext/hash'
+
+require_relative "../lib/gitlab_quality/test_tooling"
+params = {}
+
+options = OptionParser.new do |opts|
+  opts.banner = "Usage: #{$PROGRAM_NAME} [options]"
+
+  opts.on('-u', '--epic-urls URLS', String, 'Comma-separated list of epic URLs') do |urls|
+    params[:epic_urls] = urls.split(',').map(&:strip)
+  end
+
+  opts.on('-f', '--epic-urls-file FILE', String, 'File containing epic URLs (one per line)') do |file|
+    params[:epic_urls_file] = file
+  end
+
+  opts.on('-t', '--token TOKEN', String, 'A valid access token with `api` scope and appropriate permissions') do |token|
+    params[:token] = token
+  end
+
+  opts.on('-m', '--message MESSAGE', String, 'Custom message template (optional)') do |message|
+    params[:message] = message
+  end
+
+  opts.on('--dry-run', "Perform a dry-run (don't post comments)") 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: Send feature readiness assessment notifications to epic authors via @mentions"
+    puts opts
+    exit
+  end
+
+  opts.parse(ARGV)
+end
+
+# Validate required arguments
+raise ArgumentError, "Missing required argument: --token" unless params[:token]
+raise ArgumentError, "Must provide either --epic-urls or --epic-urls-file" unless params[:epic_urls] || params[:epic_urls_file]
+
+if params.any?
+  GitlabQuality::TestTooling::FeatureReadiness::EpicReadinessNotifier.new(**params).invoke!
+else
+  puts options
+  exit 1
+end

data/exe/post-to-slack

@@ -77,6 +77,10 @@ options = OptionParser.new do |opts|
     params[:icon_emoji] = icon_emoji
   end
 
+  opts.on('-e', '--environment-issues-file FILE', String, 'Add environment issues alert based on grouped failure data in a file') do |file|
+    params[:environment_issues_file] = file
+  end
+
   opts.on_tail('-v', '--version', 'Show the version') do
     require_relative "../lib/gitlab_quality/test_tooling/version"
     puts "#{$PROGRAM_NAME} : #{GitlabQuality::TestTooling::VERSION}"

data/exe/relate-failure-issue

@@ -58,6 +58,14 @@ options = OptionParser.new do |opts|
     params[:dry_run] = true
   end
 
+  opts.on("--group-similar", "Enable grouping similar issues") do
+    params[:group_similar] = true
+  end
+
+  opts.on('--environment-issues-output-file FILE', String, 'Output file for environment issues data (JSON)') do |file|
+    params[:environment_issues_output_file] = file
+  end
+
   opts.on_tail('-v', '--version', 'Show the version') do
     require_relative "../lib/gitlab_quality/test_tooling/version"
     puts "#{$PROGRAM_NAME} : #{GitlabQuality::TestTooling::VERSION}"
@@ -66,6 +74,7 @@ options = OptionParser.new do |opts|
 
   opts.on_tail('-h', '--help', 'Show the usage') do
     puts "Purpose: Relate test failures to failure issues from RSpec report files (JSON or JUnit XML)"
+    puts ""
     puts opts
     exit
   end

data/exe/test-coverage

@@ -0,0 +1,123 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "optparse"
+
+require_relative "../lib/gitlab_quality/test_tooling"
+
+require_relative '../lib/gitlab_quality/test_tooling/code_coverage/category_owners'
+require_relative '../lib/gitlab_quality/test_tooling/code_coverage/click_house/category_owners_table'
+require_relative '../lib/gitlab_quality/test_tooling/code_coverage/click_house/coverage_metrics_table'
+require_relative '../lib/gitlab_quality/test_tooling/code_coverage/coverage_data'
+require_relative '../lib/gitlab_quality/test_tooling/code_coverage/lcov_file'
+require_relative '../lib/gitlab_quality/test_tooling/code_coverage/artifacts'
+require_relative '../lib/gitlab_quality/test_tooling/code_coverage/rspec_report'
+require_relative '../lib/gitlab_quality/test_tooling/code_coverage/test_map'
+
+params = {}
+required_params = [:working_dir, :rspec_reports_jobs, :rspec_reports_glob, :coverage_report_path, :test_map_url]
+
+options = OptionParser.new do |opts|
+  opts.banner = "Usage: #{$PROGRAM_NAME} [options]"
+
+  opts.on('--working_dir PATH', 'Working directory path') do |path|
+    params[:working_dir] = path
+  end
+
+  opts.on('--rspec-reports-jobs JOB1,...', Array, 'Comma-separated names of RSpec JSON jobs') do |jobs|
+    params[:rspec_reports_jobs] = jobs
+  end
+
+  opts.on('--rspec-reports-glob GLOB', 'Glob pattern for RSpec JSON reports') do |pattern|
+    params[:rspec_reports_glob] = pattern
+  end
+
+  opts.on('--coverage-report-path PATH', 'Path to LCOV coverage report') do |path|
+    params[:coverage_report_path] = path
+  end
+
+  opts.on('--test-map-url URL', 'URL for the test map') do |url|
+    params[:test_map_url] = url
+  end
+
+  opts.on('-h', '--help', 'Show the usage') do
+    puts opts
+    puts "\nExamples:"
+    puts "  #{$PROGRAM_NAME}"
+    exit
+  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.parse(ARGV)
+end
+
+if params.any? && (required_params - params.keys).none?
+  artifacts = GitlabQuality::TestTooling::CodeCoverage::Artifacts.new(
+    working_dir: params[:working_dir],
+    rspec_reports_jobs: params[:rspec_reports_jobs],
+    rspec_reports_glob: params[:rspec_reports_glob],
+    coverage_report_path: params[:coverage_report_path],
+    test_map_url: params[:test_map_url]
+  )
+
+  coverage_report = artifacts.coverage_report
+  rspec_reports = artifacts.rspec_reports
+  test_map = artifacts.test_map
+
+  code_coverage_by_source_file = GitlabQuality::TestTooling::CodeCoverage::LcovFile.new(coverage_report).parsed_content
+
+  source_file_to_tests = GitlabQuality::TestTooling::CodeCoverage::TestMap.new(test_map).source_to_tests
+
+  tests_to_categories = rspec_reports.reduce({}) do |combined_hash, rspec_report_file|
+    file_categories = GitlabQuality::TestTooling::CodeCoverage::RspecReport.new(rspec_report_file).tests_to_categories
+    combined_hash.merge(file_categories) { |_, old_val, new_val| (old_val + new_val).uniq }
+  end
+
+  category_owners = GitlabQuality::TestTooling::CodeCoverage::CategoryOwners.new
+
+  coverage_data = GitlabQuality::TestTooling::CodeCoverage::CoverageData.new(
+    code_coverage_by_source_file,
+    source_file_to_tests,
+    tests_to_categories,
+    category_owners.categories_to_teams
+  )
+
+  if ENV.fetch('CLICKHOUSE_URL', nil) &&
+      ENV.fetch('CLICKHOUSE_DATABASE', nil) &&
+      ENV.fetch('CLICKHOUSE_USERNAME', nil) &&
+      ENV.fetch('CLICKHOUSE_PASSWORD', nil)
+
+    clickhouse_data = {
+      url: ENV.fetch('CLICKHOUSE_URL', nil),
+      database: ENV.fetch('CLICKHOUSE_DATABASE', nil),
+      username: ENV.fetch('CLICKHOUSE_USERNAME', nil),
+      password: ENV.fetch('CLICKHOUSE_PASSWORD', nil)
+    }
+
+    category_owners_table  = GitlabQuality::TestTooling::CodeCoverage::ClickHouse::CategoryOwnersTable.new(**clickhouse_data)
+    coverage_metrics_table = GitlabQuality::TestTooling::CodeCoverage::ClickHouse::CoverageMetricsTable.new(**clickhouse_data)
+
+    category_owners_table.create  if ENV['CLICKHOUSE_CREATE_CATEGORY_OWNERS_TABLE']  == 'true'
+    coverage_metrics_table.create if ENV['CLICKHOUSE_CREATE_COVERAGE_METRICS_TABLE'] == 'true'
+
+    if ENV['CLICKHOUSE_PUSH_CATEGORY_DATA'] == 'true'
+      category_owners_table.truncate
+      category_owners_table.push(category_owners.as_db_table)
+    end
+
+    coverage_metrics_table.push(coverage_data.as_db_table)
+  else
+    puts "ClickHouse configuration not found.\n" \
+      'Set CLICKHOUSE_URL, CLICKHOUSE_DATABASE, CLICKHOUSE_USERNAME, ' \
+      'CLICKHOUSE_PASSWORD environment variables to enable ClickHouse export.'
+  end
+else
+  puts "Missing argument(s). Required arguments are: #{required_params}\nPassed arguments are: #{params}\n"
+  puts options
+  exit 1
+end

data/lib/gitlab_quality/test_tooling/click_house/client.rb

@@ -0,0 +1,111 @@
+# frozen_string_literal: true
+
+require "httparty"
+require "json"
+require "logger"
+require "active_support/core_ext/object/blank"
+
+module GitlabQuality
+  module TestTooling
+    module ClickHouse
+      class Client
+        DEFAULT_BATCH_SIZE = 100_000
+        LOG_PREFIX = "[ClickHouse]"
+
+        def initialize(url:, database:, username: nil, password: nil, logger: ::Logger.new($stdout, level: 1))
+          @url = url
+          @database = database
+          @username = username
+          @password = password
+          @logger = logger
+        end
+
+        # Perform sql query
+        #
+        # @param sql [String]
+        # @param format [String]
+        # @return [Array, Hash, String]
+        def query(sql, format: "JSONEachRow")
+          logger.debug("Running #{sql}")
+          response = post(
+            body: sql,
+            content_type: "text/plain",
+            query_opts: { default_format: format }
+          )
+          raise "ClickHouse query failed: code: #{response.code}, error: #{response.body}" if response.code != 200
+
+          if format == "JSONEachRow"
+            response.body.split("\n").map { |row| JSON.parse(row) }
+          elsif %w[JSON JSONCompact].include?(format)
+            JSON.parse(response.body.presence || "{}")
+          else
+            response.body
+          end
+        end
+
+        # Push data to ClickHouse
+        #
+        # @param table_name [String]
+        # @param data [Array<Hash>]
+        # @param batch_size [Integer]
+        # @return [void]
+        def insert_json_data(table_name, data, batch_size: DEFAULT_BATCH_SIZE) # rubocop:disable Metrics/AbcSize
+          raise ArgumentError, "Expected data to be an Array, got #{data.class}" unless data.is_a?(Array)
+          raise ArgumentError, "Expected all elements of array to be hashes" unless data.is_a?(Array) && data.all?(Hash)
+          raise ArgumentError, "Expected data to not be empty" if data.empty?
+
+          total_batches = (data.size.to_f / batch_size).ceil
+          results = data.each_slice(batch_size).with_index.map do |batch, index|
+            logger.debug("#{LOG_PREFIX} Pushing batch #{index + 1} of #{total_batches}")
+            send_batch(table_name, batch)
+          end
+          logger.debug("#{LOG_PREFIX} Processed #{results.size} result batches")
+          return if results.all? { |res| res[:success] }
+
+          err = results
+            .reject { |res| res[:success] }
+            .map { |res| "batch_size: #{res[:count]}, err: #{res[:error]}" }
+            .join("\n")
+          raise "Failures detected when pushing data to ClickHouse, errors:\n#{err}"
+        end
+
+        private
+
+        attr_reader :url, :database, :username, :password, :logger
+
+        # Push batch of data
+        #
+        # @param table_name [String] table name
+        # @param batch [Array<Hash>] data batch
+        # @return [Hash]
+        def send_batch(table_name, batch)
+          response = post(
+            body: batch.map(&:to_json).join("\n"),
+            content_type: 'application/json',
+            query_opts: { query: "INSERT INTO #{table_name} FORMAT JSONEachRow" }
+          )
+          return { success: true, count: batch.size, response: response.body } if response.code == 200
+
+          { success: false, count: batch.size, error: response.body }
+        rescue StandardError => e
+          { success: false, count: batch.size, error: e.message }
+        end
+
+        # Execute post request
+        #
+        # @param body [String]
+        # @param content_type [String]
+        # @param query_opts [Hash] additional query options
+        # @return [HTTParty::Response]
+        def post(body:, content_type:, query_opts: {})
+          HTTParty.post(url, {
+            body: body,
+            headers: { "Content-Type" => content_type },
+            query: { database: database, **query_opts }.compact,
+            basic_auth: !!(username && password) ? { username: username, password: password } : nil
+          }.compact)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require 'json'
+require 'net/http'
+require 'stringio'
+require 'uri'
+require 'zlib'
+
+require_relative 'utils'
+
+module GitlabQuality
+  module TestTooling
+    module CodeCoverage
+      class Artifacts
+        include Utils
+
+        MAX_RETRIES = 7 # retries with exponential backoff: 1s, 2s, 4s, 8s, 16s, 32s, 64s (+ 0-1s jitter)
+
+        def initialize(working_dir:, coverage_report_path:, rspec_reports_jobs:, rspec_reports_glob:, test_map_url:)
+          @working_dir = working_dir
+          @rspec_reports_jobs = rspec_reports_jobs
+          @rspec_reports_glob = rspec_reports_glob
+          @coverage_report_path = coverage_report_path
+          @test_map_uri = URI.parse(test_map_url)
+        end
+
+        def rspec_reports
+          @rspec_report_files ||= rspec_reports_paths.map do |report_path|
+            JSON.parse(File.read(report_path))
+          rescue JSON::ParserError => e
+            raise "Invalid JSON in RSpec report file #{report_path}: #{e.message}"
+          end
+        end
+
+        def coverage_report
+          @coverage_report ||= read_coverage_reports
+        end
+
+        def test_map
+          @test_map ||= fetch_test_map_from_url
+        end
+
+        private
+
+        def rspec_reports_paths
+          @rspec_reports_paths ||= begin
+            paths = @rspec_reports_jobs.flat_map do |job_name|
+              Dir.glob(File.join(@working_dir, job_name, @rspec_reports_glob))
+            end.compact
+
+            if paths.empty? || paths.none? { |path| File.exist?(path) } # rubocop:disable Style/IfUnlessModifier
+              raise "No RSpec reports found in #{@working_dir}/<job-name>/ for these jobs: #{@rspec_reports_jobs}."
+            end
+
+            paths
+          end
+        end
+
+        def read_coverage_reports
+          raise "Coverage report not found in: #{@coverage_report_path}" unless File.exist?(@coverage_report_path)
+
+          File.read(@coverage_report_path)
+        end
+
+        def fetch_test_map_from_url
+          attempt = 0
+
+          begin
+            attempt += 1
+            response = http_get(@test_map_uri)
+            raise "HTTP #{response.code}: #{response.message}" unless response.is_a?(Net::HTTPSuccess)
+
+            JSON.parse(decompressed_gzip(response.body))
+          rescue StandardError => e
+            if attempt <= MAX_RETRIES
+              sleep_duration = exponential_delay_with_jitter(attempt)
+              warn "Attempt #{attempt}/#{MAX_RETRIES} failed: #{e.message}. Retrying in #{sleep_duration.round(2)}s..."
+              sleep(sleep_duration)
+              retry
+            end
+
+            raise "Failed to fetch test map from #{@test_map_uri} after #{MAX_RETRIES} attempts: #{e.message}"
+          end
+        end
+
+        def http_get(uri)
+          Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https') do |http|
+            http.get(uri.request_uri)
+          end
+        end
+
+        def decompressed_gzip(gzipped_data)
+          Zlib::GzipReader.new(StringIO.new(gzipped_data)).read
+        end
+      end
+    end
+  end
+end