gitlab_quality-test_tooling 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9bcb8c6202edb63313039592fdf1a6c953c0b43db4566d9e84105e31d2029d3
-  data.tar.gz: 27dcc6d668da50a3ec76bd13b8898d61b24bbe2835faeee6fc6dbce684945388
+  metadata.gz: 145ee9c8df7307958d5fa46edbff45de7ed0bb604dc213fb9ac5813cd1057327
+  data.tar.gz: 4308fca7357956cf7a236cd59337eb9677de2582f459c2a617da06ba157c60cb
 SHA512:
-  metadata.gz: cd3003fced80af3cd8ebafa3495d799eb63756b659b4c6e002c27557ea84beb3ec4bba1bbb08784cf27fe74ab6f4d1c6eb2ed7888fdbf317209683475247310b
-  data.tar.gz: 579e87d66fa4107263220501f4959e3b08b0dbb887224ecb11917a69e5d6774e9cfdd2298d62a20992bc27b7b4be3f561e35574f599a4cbb165230331261e9c5
+  metadata.gz: d5a96691899147d6e61e6d98c24e63b8efe2e5d6cbf4870ea9c1095dfdc7d5091e9381def5a77a5b43dfa85e8c49b6b64bce34852f00b5a4dd61fbda6da70d10
+  data.tar.gz: daa62f692125939eb89b2ffe0664527bcc7078574327a874fe180889358d421686de8cbaeb22ddb83ef71247cea967f3b5d2dd3888415eb764569b2f701034e0

data/Gemfile.lock

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

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

@@ -10,6 +10,17 @@ module GitlabQuality
 
         FILE_BASE_URL = "https://gitlab.com/gitlab-org/gitlab/-/blob/master/"
 
+        OTHER_TESTS_MAX_DURATION = 45.40 # seconds
+
+        TestLevelSpecification = Struct.new(:regex, :max_duration)
+
+        TEST_LEVEL_SPECIFICATIONS = [
+          TestLevelSpecification.new(%r{spec/features/}, 50.13),
+          TestLevelSpecification.new(%r{spec/(controllers|requests)/}, 19.20),
+          TestLevelSpecification.new(%r{spec/lib/}, 27.12),
+          TestLevelSpecification.new(%r{qa/specs/features/}, 240)
+        ].freeze
+
         def initialize(token:, input_files:, project: nil, dry_run: false, **_kwargs)
           @project = project
           @gitlab = (dry_run ? GitlabIssueDryClient : GitlabIssueClient).new(token: token, project: project)
@@ -42,7 +53,10 @@ module GitlabQuality
           | ------ | ------ |
           | File | #{test_file_link(test)} |
           | Description | `#{test.name}` |
+          | Test level | #{test.level} |
           | Hash | `#{test_hash(test)}` |
+          | Duration | #{test.run_time} seconds |
+          | Expected duration | < #{max_duration_for_test(test)} seconds |
           #{"| Test case | #{test.testcase} |" if test.testcase}
           DESCRIPTION
         end
@@ -50,7 +64,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}#L#{test.line_number})"
+          "[`#{path_prefix}#{test.file}#L#{test.line_number}`](#{FILE_BASE_URL}#{path_prefix}#{test.file}#L#{test.line_number})"
         end
 
         def new_issue_labels(_test)
@@ -155,6 +169,15 @@ module GitlabQuality
         def ee_test?(test)
           test.file =~ %r{features/ee/(api|browser_ui)}
         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

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

@@ -13,21 +13,11 @@ module GitlabQuality
         include Concerns::FindSetDri
         include Concerns::GroupAndCategoryLabels
 
-        NEW_ISSUE_LABELS = Set.new(%w[test type::maintenance maintenance::performance priority::3 severity::3]).freeze
+        NEW_ISSUE_LABELS = Set.new(['test', 'type::maintenance', 'maintenance::performance', 'priority::3', 'severity::3', 'rspec profiling', 'rspec:slow test']).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!
@@ -47,13 +37,11 @@ module GitlabQuality
         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")
+          super +
+            <<~DESCRIPTION
+              Slow tests were detected, please see the [test speed best practices guide](https://docs.gitlab.com/ee/development/testing_guide/best_practices.html#test-speed)
+              to improve them. More context available about this issue in the [top slow tests guide](https://docs.gitlab.com/ee/development/testing_guide/best_practices.html#top-slow-tests).
+            DESCRIPTION
         end
 
         def create_slow_issue(test)
@@ -73,15 +61,6 @@ module GitlabQuality
         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

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

@@ -89,6 +89,10 @@ module GitlabQuality
           report['line_number']
         end
 
+        def level
+          report['level']
+        end
+
         def failures # rubocop:disable Metrics/AbcSize
           @failures ||=
             report.fetch('exceptions', []).filter_map do |exception|

data/lib/gitlab_quality/test_tooling/version.rb

@@ -2,6 +2,6 @@
 
 module GitlabQuality
   module TestTooling
-    VERSION = "0.9.0"
+    VERSION = "0.9.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_quality-test_tooling
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - GitLab Quality
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-07-05 00:00:00.000000000 Z
+date: 2023-07-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control