gitlab_quality-test_tooling 1.12.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b88e790bd74462ff96779cb28d8f8f2cdadd99356e3889f50ec56ed7f5ea691d
-  data.tar.gz: 865098baec02cb4f7cf6634fc7e7cb45a0394261957d9b0cdc33b9c0efd74c29
+  metadata.gz: 0b5576ca28a8e8cbf76564017a53418fd059747789bbbb8146835285d8f5b37c
+  data.tar.gz: b1d7c6dd581dccabe91f64687b420a83f5561aa407e1e4583e7a5146183890f4
 SHA512:
-  metadata.gz: 1bdaa39d9a6e2ea9000d3318d54e1c3385c552fa967b86780f697ee10becf7e6f0cc3c8edf19a7ac7d29988babaf6ad735a1191d7132ed7f635939cde3575fa6
-  data.tar.gz: 3edfd0209db270145f48338dbf0ebc1785176f8fd158fef8880b13b3280e8a569437d30f26234203bb58bbb6b111992265209882df4c783b83342b942d2d7d00
+  metadata.gz: d245b9be5a9a127630d934096277c339e649e9e719727f871d8b794245b385e6f4dbfba3175c546f44b2ee833099ef5398738dcaa631bab39b44eb9734fe338f
+  data.tar.gz: 33a391d891853d45e75198462d504641d090e0f619e31a9fbf5c613b4fe5cef6443d6b465e9e2ffc27d643a3d8d8426030bb10c872a83ca0a2def1b0232ae0ae

data/Gemfile.lock

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

data/README.md

@@ -141,6 +141,21 @@ Usage: exe/slow-test-issues [options]
     -h, --help                       Show the usage
 ```
 
+### `exe/knapsack-report-issues`
+
+```shell
+Purpose: Create spec run time issue when a spec file almost caused job timeout because it ran significantly longer than what Knapsack expected.
+Usage: exe/knapsack-report-issues [options]
+    -i, --input-file INPUT_FILE      Knapsack actual run time report file path glob
+    -e EXPECTED_REPORT,              Knapsack expected report file path
+        --expected-report
+    -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 issues)
+    -v, --version                    Show the version
+    -h, --help                       Show the usage
+```
+
 ### `exe/flaky-test-issues`
 
 ```shell

data/exe/knapsack-report-issues

@@ -0,0 +1,54 @@
+#!/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-file INPUT_FILE", String, "Knapsack actual run time report file path glob") do |input_file|
+    params[:input_files] = input_file
+  end
+
+  opts.on("-e", "--expected-report EXPECTED_REPORT", String, "Knapsack expected report file path") do |report_path|
+    params[:expected_report] = report_path.strip
+  end
+
+  opts.on('-p', '--project PROJECT', String, 'Can be an integer or a group/project string') do |project|
+    params[:project] = project
+  end
+
+  opts.on('-t', '--token TOKEN', String, 'A valid access token with `api` scope and Maintainer permission in PROJECT') do |token|
+    params[:token] = token
+  end
+
+  opts.on('--dry-run', "Perform a dry-run (don't create issues)") 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: Create spec run time issue when a spec file almost caused job timeout because it ran significantly longer than what Knapsack expected."
+    puts opts
+    exit
+  end
+
+  opts.parse(ARGV)
+end
+
+if params.any?
+  GitlabQuality::TestTooling::Report::KnapsackReportIssue.new(**params).invoke!
+else
+  puts options
+  exit 1
+end

data/lib/gitlab_quality/test_tooling/knapsack_reports/spec_run_time.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    module KnapsackReports
+      class SpecRunTime
+        attr_reader :file, :expected, :actual, :expected_suite_duration, :actual_suite_duration
+
+        ACTUAL_TO_EXPECTED_SPEC_RUN_TIME_RATIO_THRESHOLD = 1.5 # actual run time is longer than expected by 50% +
+        SPEC_WEIGHT_PERCENTAGE_TRESHOLD = 15 # a spec file takes 15%+ of the total test suite run time
+        SUITE_DURATION_THRESHOLD = 70 * 60 # if test suite takes more than 70 minutes, job risks timing out
+
+        def initialize(file:, expected:, actual:, expected_suite_duration:, actual_suite_duration:)
+          @file = file
+          @expected = expected.to_f
+          @actual = actual.to_f
+          @expected_suite_duration = expected_suite_duration.to_f
+          @actual_suite_duration = actual_suite_duration.to_f
+        end
+
+        def should_report?
+          # guideline proposed in https://gitlab.com/gitlab-org/quality/engineering-productivity/team/-/issues/354
+          exceed_actual_to_expected_ratio_threshold? && test_suite_bottleneck?
+        end
+
+        def ci_pipeline_url_markdown
+          "[#{ci_pipeline_id}](#{ci_pipeline_url})"
+        end
+
+        def ci_pipeline_created_at
+          ENV.fetch('CI_PIPELINE_CREATED_AT', nil)
+        end
+
+        def ci_job_link_markdown
+          "[#{ci_job_name}](#{ci_job_url})"
+        end
+
+        def file_link_markdown
+          "[#{file}](#{file_link})"
+        end
+
+        def actual_percentage
+          (actual / actual_suite_duration * 100).round(2)
+        end
+
+        def name
+          nil
+        end
+
+        private
+
+        def exceed_actual_to_expected_ratio_threshold?
+          actual / expected >= ACTUAL_TO_EXPECTED_SPEC_RUN_TIME_RATIO_THRESHOLD
+        end
+
+        def test_suite_bottleneck?
+          # now we only report bottlenecks when they risk causing job timeouts
+          return unless actual_suite_duration > SUITE_DURATION_THRESHOLD
+
+          actual_percentage > SPEC_WEIGHT_PERCENTAGE_TRESHOLD
+        end
+
+        def ci_job_url
+          ENV.fetch('CI_JOB_URL', nil)
+        end
+
+        def ci_job_name
+          ENV.fetch('CI_JOB_NAME_SLUG', nil)
+        end
+
+        def ci_pipeline_id
+          ENV.fetch('CI_PIPELINE_IID', nil)
+        end
+
+        def ci_pipeline_url
+          ENV.fetch('CI_PIPELINE_URL', nil)
+        end
+
+        def file_link
+          "#{Runtime::Env.file_base_url}#{file}"
+        end
+      end
+    end
+  end
+end

data/lib/gitlab_quality/test_tooling/knapsack_reports/spec_run_time_report.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module GitlabQuality
+  module TestTooling
+    module KnapsackReports
+      class SpecRunTimeReport
+        attr_reader :expected_report, :actual_report
+
+        def initialize(expected_report_path:, actual_report_path:)
+          @expected_report = parse(expected_report_path)
+          @actual_report = parse(actual_report_path)
+        end
+
+        def filtered_report
+          @filtered_report = actual_report.keys.filter_map do |spec_file|
+            expected_run_time = expected_report[spec_file]
+            actual_run_time = actual_report[spec_file]
+
+            if expected_run_time.nil?
+              puts "#{spec_file} missing from the expected Knapsack report, skipping."
+              next
+            end
+
+            spec_run_time = SpecRunTime.new(
+              file: spec_file,
+              expected: expected_run_time,
+              actual: actual_run_time,
+              expected_suite_duration: expected_test_suite_run_time_total,
+              actual_suite_duration: actual_test_suite_run_time_total
+            )
+
+            spec_run_time if spec_run_time.should_report?
+          end
+        end
+
+        private
+
+        def parse(report_path)
+          JSON.parse(File.read(report_path))
+        end
+
+        def expected_test_suite_run_time_total
+          @expected_test_suite_run_time_total ||=
+            expected_report.reduce(0) do |total_run_time, (_spec_file, run_time)|
+              total_run_time + run_time
+            end
+        end
+
+        def actual_test_suite_run_time_total
+          @actual_test_suite_run_time_total ||=
+            actual_report.reduce(0) do |total_run_time, (_spec_file, run_time)|
+              total_run_time + run_time
+            end
+        end
+      end
+    end
+  end
+end

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

@@ -45,6 +45,28 @@ module GitlabQuality
 
             @pipeline ||= Runtime::Env.pipeline_from_project_name
           end
+
+          def readable_duration(duration_in_seconds)
+            minutes = (duration_in_seconds / 60).to_i
+            seconds = (duration_in_seconds % 60).round(2)
+
+            min_output = normalize_duration_output(minutes, 'minute')
+            sec_output = normalize_duration_output(seconds, 'second')
+
+            "#{min_output} #{sec_output}".strip
+          end
+
+          private
+
+          def normalize_duration_output(number, unit)
+            if number <= 0
+              ""
+            elsif number <= 1
+              "#{number} #{unit}"
+            else
+              "#{number} #{unit}s"
+            end
+          end
         end
       end
     end

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

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    module Report
+      # Uses the API to create GitLab issues for spec run time exceeding Knapsack expectation
+      #
+      # - Takes the expected and actual Knapsack JSON reports from the knapsack output
+      # - Takes a project where issues should be created
+      # - For every test file reported with unexpectedly long run time:
+      #   - Find issue by test file name, and if found:
+      #     - Reopen issue if it already exists, but is closed
+      #     - Update the issue with the new run time data
+      #   - If not found:
+      #     - Create a new issue with the run time data
+      class KnapsackReportIssue < ReportAsIssue
+        NEW_ISSUE_LABELS = Set.new(['test', 'type::maintenance', 'maintenance::performance', 'priority::3', 'severity::3', 'knapsack_report']).freeze
+        SEARCH_LABELS = %w[test maintenance::performance knapsack_report].freeze
+        JOB_TIMEOUT_EPIC_URL = 'https://gitlab.com/groups/gitlab-org/quality/engineering-productivity/-/epics/19'
+
+        def initialize(token:, input_files:, expected_report:, project: nil, dry_run: false)
+          super
+
+          @expected_report = expected_report
+        end
+
+        private
+
+        attr_reader :expected_report
+
+        def run!
+          puts "Reporting spec file exceeding Knapsack expectaton issues in project `#{project}` via the API at `#{Runtime::Env.gitlab_api_base}`."
+
+          search_and_create_issue
+        end
+
+        def search_and_create_issue
+          filtered_report = KnapsackReports::SpecRunTimeReport.new(
+            expected_report_path: expected_report_path,
+            actual_report_path: actual_report_path
+          ).filtered_report
+
+          puts "=> Reporting #{filtered_report.count} spec files exceeding Knapsack expectation."
+
+          filtered_report.each do |spec_with_run_time|
+            existing_issues = find_issues_for_test(spec_with_run_time, labels: SEARCH_LABELS)
+
+            if existing_issues.empty?
+              puts "Creating issue for #{spec_with_run_time.file}"
+              create_issue(spec_with_run_time)
+            else
+              update_issue(issue: existing_issues.last, spec_run_time: spec_with_run_time)
+            end
+          end
+        end
+
+        def expected_report_path
+          return if expected_report.nil? || !File.exist?(expected_report)
+
+          expected_report
+        end
+
+        def actual_report_path
+          return if files.nil? || !File.exist?(files.first)
+
+          files.first
+        end
+
+        def new_issue_labels(_spec_run_time)
+          NEW_ISSUE_LABELS
+        end
+
+        def new_issue_title(spec_run_time)
+          "Job timeout risk: #{spec_run_time.file} ran much longer than expected"
+        end
+
+        def new_issue_description(spec_run_time)
+          <<~MARKDOWN.chomp
+          /epic #{JOB_TIMEOUT_EPIC_URL}
+
+          ### Why was this issue created?
+
+          #{spec_run_time.file_link_markdown} was reported to have:
+
+          1. exceeded Knapsack's expected runtime by at least 50%, and
+          2. been identified as a notable pipeline bottleneck and a job timeout risk
+
+          ### Suggested steps for investigation
+
+          1. To reproduce in CI by running test files in the same order, you can follow the steps listed [here](https://docs.gitlab.com/ee/development/testing_guide/flaky_tests.html#recreate-job-failure-in-ci-by-forcing-the-job-to-run-the-same-set-of-test-files).
+          1. Identify if a specific test case is stalling the run time. Hint: You can search the job's log for `Starting example group #{spec_run_time.file}` and view the elapsed time after each test case in the proceeding lines starting with `[RSpecRunTime]`.
+          1. If the test file is large, consider refactoring it into multiple files to allow better test parallelization across runners.
+          1. If the run time cannot be fixed in time, consider quarantine the spec(s) to restore performance.
+
+          ### Run time details
+
+          #{run_time_detail(spec_run_time)}
+          MARKDOWN
+        end
+
+        def update_issue(issue:, spec_run_time:)
+          state_event = issue.state == 'closed' ? 'reopen' : nil
+          updated_description = <<~MARKDOWN.chomp
+          #{issue.description}
+
+          #{run_time_detail(spec_run_time)}
+          MARKDOWN
+
+          issue_attrs = {
+            description: updated_description
+          }
+
+          issue_attrs[:state_event] = state_event if state_event
+
+          gitlab.edit_issue(iid: issue.iid, options: issue_attrs)
+          puts "  => Added a report in #{issue.web_url}!"
+        end
+
+        def run_time_detail(spec_run_time)
+          <<~MARKDOWN.chomp
+            - Reported from pipeline #{spec_run_time.ci_pipeline_url_markdown} created at `#{spec_run_time.ci_pipeline_created_at}`
+
+            | Field | Value |
+            | ------ | ------ |
+            | Job URL| #{spec_run_time.ci_job_link_markdown} |
+            | Job total RSpec suite run time | expected: `#{readable_duration(spec_run_time.expected_suite_duration)}`, actual: `#{readable_duration(spec_run_time.actual_suite_duration)}` |
+            | Spec file run time | expected: `#{readable_duration(spec_run_time.expected)}`, actual: `#{readable_duration(spec_run_time.actual)}` |
+            | Spec file weight | `#{spec_run_time.actual_percentage}%` of total suite run time |
+          MARKDOWN
+        end
+
+        def assert_input_files!(_files)
+          missing_expected_report_msg = "Missing a valid expected Knapsack report."
+          missing_actual_report_msg = "Missing a valid actual Knapsack report."
+
+          abort missing_expected_report_msg if expected_report_path.nil?
+          abort missing_actual_report_msg if actual_report_path.nil?
+        end
+      end
+    end
+  end
+end

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

@@ -64,8 +64,6 @@ module GitlabQuality
             puts "=> Reporting #{test_results.count} tests in #{test_results.path}"
             process_test_results(test_results)
           end
-
-          write_issues_log_file
         end
 
         def test_metric_collections

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

@@ -19,7 +19,11 @@ module GitlabQuality
         def invoke!
           validate_input!
 
-          run!
+          issue_url = run!
+
+          write_issues_log_file
+
+          issue_url
         end
 
         private
@@ -162,7 +166,12 @@ module GitlabQuality
         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))
-          issue_title.include?(test.name) || test_file_path_found
+
+          if test.name
+            issue_title.include?(test.name) || test_file_path_found
+          else
+            test_file_path_found
+          end
         end
 
         def pipeline_name_label

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

@@ -33,8 +33,6 @@ module GitlabQuality
               create_slow_issue(test) if test.slow_test?
             end
           end
-
-          write_issues_log_file
         end
 
         def new_issue_title(test)

data/lib/gitlab_quality/test_tooling/version.rb

@@ -2,6 +2,6 @@
 
 module GitlabQuality
   module TestTooling
-    VERSION = "1.12.0"
+    VERSION = "1.13.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_quality-test_tooling
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 1.13.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-11 00:00:00.000000000 Z
+date: 2024-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -348,6 +348,7 @@ email:
 executables:
 - flaky-test-issues
 - generate-test-session
+- knapsack-report-issues
 - post-to-slack
 - prepare-stage-reports
 - relate-failure-issue
@@ -374,6 +375,7 @@ files:
 - Rakefile
 - exe/flaky-test-issues
 - exe/generate-test-session
+- exe/knapsack-report-issues
 - exe/post-to-slack
 - exe/prepare-stage-reports
 - exe/relate-failure-issue
@@ -396,6 +398,8 @@ files:
 - lib/gitlab_quality/test_tooling/gitlab_client/merge_requests_client.rb
 - lib/gitlab_quality/test_tooling/gitlab_client/merge_requests_dry_client.rb
 - lib/gitlab_quality/test_tooling/gitlab_client/repository_files_client.rb
+- lib/gitlab_quality/test_tooling/knapsack_reports/spec_run_time.rb
+- lib/gitlab_quality/test_tooling/knapsack_reports/spec_run_time_report.rb
 - 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
@@ -404,6 +408,7 @@ files:
 - lib/gitlab_quality/test_tooling/report/flaky_test_issue.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/knapsack_report_issue.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