gitlab_quality-test_tooling 0.8.2 → 0.8.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d201b5e75d11490d7b8a3f7b3abdc883442487d07d19f9c5c7cf02577a867116
-  data.tar.gz: 0b50d503726912d587bb2b3d4bd1e1c2194b8f0773d2a37905afa0c66dfbbaee
+  metadata.gz: a3472eb65666a6691797e9e0f0332a1773bb6babe898245a375bd9976523866e
+  data.tar.gz: 6372e6df38afb56bbe300b39d25a65cb7cdd205765ded99cab3745f4fbe7d812
 SHA512:
-  metadata.gz: e5b8c615d62f29710c55a3d39373efb71cf1b7895d3b7ca08d6a4e0077e47b7a0c109f111716d49d7d5adcac4b3ffc8668c20fcb95fc01bfb2244c38bfafba62
-  data.tar.gz: 30b05b1eac9f9b6400e089b1de4e229fcd5769aae2a41066bc43e79e08f6a6c37db8e4b7cbbfd46933021eabafa098be601a546c5cc05d7a93fa4c01d5c14021
+  metadata.gz: 899483550e08f6f873d137d6a1bc90620ed58eff093827e76e5b4c92de8b7b1f95bba60181d2b726d79bf91b08b627cc93fb3817662dff73db8ba46e81557aad
+  data.tar.gz: 6b21fae0eb76efa44dd868113d22d36c30a9f5d06b5bb1b625dd42129a463a24ae77abf4edf6df05d06800b29261116492cb39aa892490aaa22cfca9ce442aa4

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.0.5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab_quality-test_tooling (0.8.2)
+    gitlab_quality-test_tooling (0.8.3)
       activesupport (>= 6.1, < 7.1)
       gitlab (~> 4.19)
       http (~> 5.0)

data/README.md

@@ -121,6 +121,18 @@ Usage: exe/update-screenshot-paths [options]
     -h, --help                       Show the usage
 ```
 
+### `slow-test-issues`
+
+```shell
+Purpose: Create slow test issues from JSON RSpec report files
+Usage: exe/slow-test-issue [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 issues)
+    -v, --version                    Show the version
+    -h, --help                       Show the usage
+```
 ## Development
 
 ### Initial setup

data/exe/slow-test-issues

@@ -0,0 +1,50 @@
+#!/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, 'JSON RSpec report files JSON') do |input_files|
+    params[:input_files] = input_files
+  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 slow test issues from JSON RSpec report files"
+    puts opts
+    exit
+  end
+
+  opts.parse(ARGV)
+end
+
+if params.any?
+  GitlabQuality::TestTooling::Report::SlowTestIssue.new(**params).invoke!
+else
+  puts options
+  exit 1
+end

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    module Report
+      module Concerns
+        module GroupAndCategoryLabels
+          def labels_inference
+            @labels_inference ||= GitlabQuality::TestTooling::LabelsInference.new
+          end
+
+          def new_issue_labels(test)
+            puts "  => [DEBUG] product_group: #{test.product_group}; feature_category: #{test.feature_category}"
+
+            new_labels = self.class::NEW_ISSUE_LABELS +
+              labels_inference.infer_labels_from_product_group(test.product_group) +
+              labels_inference.infer_labels_from_feature_category(test.feature_category)
+            up_to_date_labels(test: test, new_labels: new_labels)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -16,6 +16,7 @@ module GitlabQuality
       # - Add the failed job to the issue description, and update labels
       class RelateFailureIssue < ReportAsIssue
         include Concerns::FindSetDri
+        include Concerns::GroupAndCategoryLabels
 
         DEFAULT_MAX_DIFF_RATIO_FOR_DETECTION = 0.15
         SYSTEMIC_EXCEPTIONS_THRESHOLD = 10
@@ -313,18 +314,6 @@ module GitlabQuality
           "1. #{Time.new.utc.strftime('%F')}: #{test.ci_job_url} (#{ENV.fetch('CI_PIPELINE_URL', 'pipeline url is missing')})"
         end
 
-        def labels_inference
-          @labels_inference ||= GitlabQuality::TestTooling::LabelsInference.new
-        end
-
-        def new_issue_labels(test)
-          puts "  => [DEBUG] product_group: #{test.product_group}; feature_category: #{test.feature_category}"
-          new_labels = NEW_ISSUE_LABELS +
-            labels_inference.infer_labels_from_product_group(test.product_group) +
-            labels_inference.infer_labels_from_feature_category(test.feature_category)
-          up_to_date_labels(test: test, new_labels: new_labels)
-        end
-
         def up_to_date_labels(test:, issue: nil, new_labels: Set.new)
           (Set.new(base_issue_labels) + (super << pipeline_name_label)).to_a
         end

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

@@ -30,7 +30,7 @@ module GitlabQuality
           raise NotImplementedError
         end
 
-        def failed_test_hash(test)
+        def test_hash(test)
           OpenSSL::Digest::SHA256.hexdigest(test.file + test.name)
         end
 
@@ -42,7 +42,7 @@ module GitlabQuality
           | ------ | ------ |
           | File | #{test_file_link(test)} |
           | Description | `#{test.name}` |
-          | Hash | `#{failed_test_hash(test)}` |
+          | Hash | `#{test_hash(test)}` |
           #{"| Test case | #{test.testcase} |" if test.testcase}
           DESCRIPTION
         end
@@ -50,7 +50,7 @@ module GitlabQuality
         def test_file_link(test)
           path_prefix = test.file.start_with?('qa/') ? 'qa/' : ''
 
-          "[`#{path_prefix}#{test.file}`](#{FILE_BASE_URL}#{path_prefix}#{test.file})"
+          "[`#{path_prefix}#{test.file}`](#{FILE_BASE_URL}#{path_prefix}#{test.file}##{test.line_number})"
         end
 
         def new_issue_labels(_test)

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

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    module Report
+      # Uses the API to create GitLab issues for slow tests
+      #
+      # - Takes the JSON test reports like rspec-*.json`
+      # - Takes a project where slow issues should be created
+      # - Find issue by title (with test description or test file)
+      # - Add test metadata, duration to the issue with group and category labels
+      class SlowTestIssue < ReportAsIssue
+        include Concerns::FindSetDri
+        include Concerns::GroupAndCategoryLabels
+
+        NEW_ISSUE_LABELS = Set.new(%w[test type::maintenance maintenance::performance priority::3 severity::3]).freeze
+        SEARCH_LABELS = %w[test maintenance::performance].freeze
+
+        MultipleIssuesFound = Class.new(StandardError)
+
+        TestLevelSpecification = Struct.new(:regex, :max_duration)
+
+        OTHER_TESTS_MAX_DURATION = 45.40 # seconds
+
+        TEST_LEVEL_SPECIFICATIONS = [
+          TestLevelSpecification.new(%r{/features/}, 50.13),
+          TestLevelSpecification.new(%r{/controllers|requests/}, 19.20),
+          TestLevelSpecification.new(%r{/lib/}, 27.12)
+        ].freeze
+
+        private
+
+        def run!
+          puts "Reporting slow tests in `#{files.join(',')}` as issues in project `#{project}` via the API at `#{Runtime::Env.gitlab_api_base}`."
+
+          TestResults::Builder.new(files).test_results_per_file do |test_results|
+            puts "=> Reporting #{test_results.count} tests in #{test_results.path}"
+
+            test_results.each do |test|
+              create_slow_issue(test) if should_create_slow_issue?(test)
+            end
+          end
+        end
+
+        def new_issue_title(test)
+          "Slow test in #{super}"
+        end
+
+        def new_issue_description(test)
+          super + [
+            "\n### Slow test",
+            "Slow tests detected, see guides for more details and how to improve them:",
+            "- [Top slow tests](https://docs.gitlab.com/ee/development/testing_guide/best_practices.html#top-slow-tests)",
+            "- [Test speed](https://docs.gitlab.com/ee/development/testing_guide/best_practices.html#test-speed)",
+            "**Duration**: #{test.run_time} seconds"
+          ].compact.join("\n\n")
+        end
+
+        def create_slow_issue(test)
+          puts "   => Finding existing issues for slow test '#{test.name}' (run time: #{test.run_time} seconds)..."
+
+          issue = find_issue(test)
+
+          puts "   => Existing issue link #{issue['web_url']}" if issue.present?
+
+          create_issue(test) unless issue.present?
+        rescue MultipleIssuesFound => e
+          warn(e.message)
+        end
+
+        def find_issue(test)
+          search_labels = SEARCH_LABELS
+
+          gitlab.find_issues(options: { state: 'opened', labels: search_labels.to_a }).find do |issue|
+            issue_title = issue.title.strip
+            issue_title.include?(test.name) || issue_title.include?(partial_file_path(test.file))
+          end
+        end
+
+        def should_create_slow_issue?(test)
+          test.run_time > max_duration_for_test(test)
+        end
+
+        def max_duration_for_test(test)
+          test_level_specification = TEST_LEVEL_SPECIFICATIONS.find do |test_level_specification|
+            test.example_id =~ test_level_specification.regex
+          end
+          return OTHER_TESTS_MAX_DURATION unless test_level_specification
+
+          test_level_specification.max_duration
+        end
+      end
+    end
+  end
+end

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

@@ -115,6 +115,18 @@ module GitlabQuality
             report['feature_category']
           end
 
+          def run_time
+            report['run_time'].to_f.round(2)
+          end
+
+          def example_id
+            report['id']
+          end
+
+          def line_number
+            report['line_number']
+          end
+
           private
 
           # rubocop:disable Metrics/AbcSize

data/lib/gitlab_quality/test_tooling/version.rb

@@ -2,6 +2,6 @@
 
 module GitlabQuality
   module TestTooling
-    VERSION = "0.8.2"
+    VERSION = "0.8.3"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_quality-test_tooling
 version: !ruby/object:Gem::Version
-  version: 0.8.2
+  version: 0.8.3
 platform: ruby
 authors:
 - GitLab Quality
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-06-19 00:00:00.000000000 Z
+date: 2023-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -323,6 +323,7 @@ executables:
 - prepare-stage-reports
 - relate-failure-issue
 - report-results
+- slow-test-issues
 - update-screenshot-paths
 extensions: []
 extra_rdoc_files: []
@@ -331,6 +332,7 @@ files:
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".ruby-version"
+- ".tool-versions"
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
 - Dangerfile
@@ -345,6 +347,7 @@ files:
 - exe/prepare-stage-reports
 - exe/relate-failure-issue
 - exe/report-results
+- exe/slow-test-issues
 - exe/update-screenshot-paths
 - lefthook.yml
 - lib/gitlab_quality/test_tooling.rb
@@ -352,6 +355,7 @@ files:
 - lib/gitlab_quality/test_tooling/gitlab_issue_dry_client.rb
 - lib/gitlab_quality/test_tooling/labels_inference.rb
 - lib/gitlab_quality/test_tooling/report/concerns/find_set_dri.rb
+- lib/gitlab_quality/test_tooling/report/concerns/group_and_category_labels.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/generate_test_session.rb
@@ -361,6 +365,7 @@ files:
 - 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
 - lib/gitlab_quality/test_tooling/runtime/logger.rb