gitlab_quality-test_tooling 1.31.0 → 1.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5d848eed10080ffc5f609ba56a75e7baf6f60cef5792d66c9c1bf9fdb8dbd2b9
-  data.tar.gz: 5d799f1628b689fda63e0ca68fb70c5f2e6e37d20d867d6ade61e4ff04ea7e57
+  metadata.gz: 19bea0cdd5a0f100cec11b00c6415c39f8ab637165f67171ad6edac7c33128b9
+  data.tar.gz: 9727a96a8ca06238ae89bacdb6f3cc88b66451a6190cac8df48fc82102e7c155
 SHA512:
-  metadata.gz: 2e881613627b3fb87abf0c00895a8b44919769b222aa1a42c60c81b8f77a79a99232145e60c798f0296d24f53f761cb6a5fd4c7d00d1cb982dcc3c58fd68a833
-  data.tar.gz: 90b1345308d5f4abb94ab81f16520bf79870de753f570223c5bc45ade1fdb7d2ca099004d682bdbcfe106c3557ebdd093ce0461b493fd98e6e687bb9930b293e
+  metadata.gz: 5dfdfea69e7e2f3500b243d83489050e6d0f2a251a1657a43250206a3710c0b848bdbb38ac34e645a2ec1dc4fc19ce4df47afa21a8c038754ac76f6b606cb14f
+  data.tar.gz: 7aa7942d0f0f86c75a2f07eea937c70c9f725b4025302778176e0fb0b9a14db41acd983d1202f86b6a59ce6f00b1c6f85ba214d86deb1a947167a57ff82ad3a4

data/Gemfile.lock

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

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

@@ -4,19 +4,39 @@ module GitlabQuality
   module TestTooling
     module KnapsackReports
       class SpecRunTime
-        attr_reader :project, :file, :expected, :actual, :expected_suite_duration, :actual_suite_duration
+        attr_reader :file, :expected, :actual, :expected_suite_duration, :actual_suite_duration, :project, :ref
 
         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(project:, file:, expected:, actual:, expected_suite_duration:, actual_suite_duration:)
-          @project = project
+        FEATURE_CATEGORY_METADATA_REGEX = /(?<=feature_category: :)(?<feature_category>\w+)/
+
+        def initialize(
+          file:,
+          expected:,
+          actual:,
+          expected_suite_duration:,
+          actual_suite_duration:,
+          token: '',
+          project: Runtime::Env.ci_project_path,
+          ref: Runtime::Env.ci_commit_ref_name)
           @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
+          @token = token
+          @project = project
+          @ref = ref
+        end
+
+        def feature_category
+          file_lines.each do |line|
+            match = FEATURE_CATEGORY_METADATA_REGEX.match(line)
+            next unless match
+
+            break match[:feature_category]
+          end
         end
 
         def should_report?
@@ -50,6 +70,8 @@ module GitlabQuality
 
         private
 
+        attr_reader :token
+
         def exceed_actual_to_expected_ratio_threshold?
           actual / expected >= ACTUAL_TO_EXPECTED_SPEC_RUN_TIME_RATIO_THRESHOLD
         end
@@ -80,6 +102,18 @@ module GitlabQuality
         def file_link
           "https://gitlab.com/#{project}/-/blob/#{Runtime::Env.ci_commit_ref_name}/#{file}"
         end
+
+        def file_lines
+          files_client.file_contents.lines(chomp: true)
+        end
+
+        def files_client
+          @files_client ||= GitlabClient::RepositoryFilesClient.new(
+            token: token,
+            project: project,
+            file_path: file,
+            ref: ref)
+        end
       end
     end
   end

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

@@ -8,10 +8,11 @@ module GitlabQuality
       class SpecRunTimeReport
         attr_reader :project, :expected_report, :actual_report
 
-        def initialize(project:, expected_report_path:, actual_report_path:)
+        def initialize(project:, expected_report_path:, actual_report_path:, token: '')
           @project = project
           @expected_report = parse(expected_report_path)
           @actual_report = parse(actual_report_path)
+          @token = token
         end
 
         def filtered_report
@@ -25,6 +26,7 @@ module GitlabQuality
             end
 
             spec_run_time = SpecRunTime.new(
+              token: token,
               project: project,
               file: spec_file,
               expected: expected_run_time,
@@ -39,6 +41,8 @@ module GitlabQuality
 
         private
 
+        attr_reader :token
+
         def parse(report_path)
           JSON.parse(File.read(report_path))
         end

data/lib/gitlab_quality/test_tooling/labels_inference.rb

@@ -10,7 +10,6 @@ module GitlabQuality
       WWW_GITLAB_COM_SITE = 'https://about.gitlab.com'
       WWW_GITLAB_COM_GROUPS_JSON = "#{WWW_GITLAB_COM_SITE}/groups.json".freeze
       WWW_GITLAB_COM_CATEGORIES_JSON = "#{WWW_GITLAB_COM_SITE}/categories.json".freeze
-      FEATURE_CATEGORY_METADATA_REGEX = /(?<=feature_category: :)\w+/
 
       def infer_labels_from_product_group(product_group)
         [groups_mapping.dig(product_group, 'label')].compact.to_set

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

@@ -10,11 +10,14 @@ module GitlabQuality
           end
 
           def new_issue_labels(test)
-            puts "  => [DEBUG] product_group: #{test.product_group}; feature_category: #{test.feature_category}"
+            debug_line = '  => [DEBUG] '
+            debug_line += "product_group: #{test&.product_group}; " if test.respond_to?(:product_group)
+            debug_line += "feature_category: #{test&.feature_category}" if test.respond_to?(:feature_category)
+            puts debug_line
 
-            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)
+            new_labels = self.class::NEW_ISSUE_LABELS
+            new_labels += labels_inference.infer_labels_from_product_group(test.product_group) if test.respond_to?(:product_group)
+            new_labels += labels_inference.infer_labels_from_feature_category(test.feature_category) if test.respond_to?(:feature_category)
             up_to_date_labels(test: test, new_labels: new_labels)
           end
         end

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

@@ -14,6 +14,8 @@ module GitlabQuality
       #   - If not found:
       #     - Create a new issue with the run time data
       class KnapsackReportIssue < ReportAsIssue
+        include Concerns::GroupAndCategoryLabels
+
         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'
@@ -36,6 +38,7 @@ module GitlabQuality
 
         def search_and_create_issue
           filtered_report = KnapsackReports::SpecRunTimeReport.new(
+            token: token,
             project: project,
             expected_report_path: expected_report_path,
             actual_report_path: actual_report_path
@@ -67,10 +70,6 @@ module GitlabQuality
           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

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

@@ -124,12 +124,12 @@ module GitlabQuality
           issue_attrs = {}
 
           new_description = new_issue_description(test)
-          issue_attrs[:description] = new_description unless issue.description == new_description
+          issue_attrs[:description] = new_description if issue.description != new_description
 
           new_labels = up_to_date_labels(test: test, issue: issue).to_a
-          issue_attrs[:labels] = new_labels unless issue.labels == new_labels
+          issue_attrs[:add_labels] = new_labels if (new_labels - issue.labels).any?
 
-          gitlab.edit_issue(iid: issue.iid, options: issue_attrs) unless issue_attrs.empty?
+          gitlab.edit_issue(iid: issue.iid, options: issue_attrs) if issue_attrs.any?
         end
 
         def issue_labels(issue)
@@ -149,14 +149,14 @@ module GitlabQuality
           labels |= new_labels.to_set
           ee_test?(test) ? labels << 'Enterprise Edition' : labels.delete('Enterprise Edition')
 
-          if test.quarantine?
+          if test.respond_to?(:quarantine?) && test.quarantine?
             labels << 'quarantine'
             labels << "quarantine::#{test.quarantine_type}"
           else
             labels.delete_if { |label| label.include?('quarantine') }
           end
 
-          labels << 'rspec-shared-examples' if test.calls_shared_examples?
+          labels << 'rspec-shared-examples' if test.respond_to?(:calls_shared_examples?) && test.calls_shared_examples?
 
           labels
         end

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

@@ -44,11 +44,11 @@ module GitlabQuality
 
         def health_problem_status_label_quick_action(reports_list)
           case reports_list.reports_count
-          when 40..Float::INFINITY
+          when 6099..Float::INFINITY
             '/label ~"slowness::1"'
-          when 28..39
+          when 2177..6098
             '/label ~"slowness::2"'
-          when 12..27
+          when 521..2176
             '/label ~"slowness::3"'
           else
             '/label ~"slowness::4"'

data/lib/gitlab_quality/test_tooling/test_meta/processor/add_to_blocking_processor.rb

@@ -50,18 +50,21 @@ module GitlabQuality
 
             private
 
-            attr_reader :context, :file_path, :file, :file_contents, :example_name, :mr_title, :changed_line_no
+            attr_reader :context, :file_path, :file, :file_contents, :example_name, :mr_title, :changed_line_no, :matched_lines
 
             # Checks if there is already an MR open
             #
             # @return [Boolean]
-            def proceed_with_commit?
+            def proceed_with_commit? # rubocop:disable Metrics/AbcSize
               if changed_line_no.negative?
                 Runtime::Logger.info("  No lines were changed in #{file_path}. Will not proceed with creating MR.")
                 return false
               elsif context.commit_processed?(file_path, changed_line_no)
                 Runtime::Logger.info("  Record already processed for #{file_path}:#{changed_line_no}. Will not proceed with creating MR.")
                 return false
+              elsif context.quarantined?(matched_lines, file_contents)
+                Runtime::Logger.info("  This test is in quarantine: #{file_path}:#{changed_line_no}. Will not proceed with creating MR.")
+                return false
               end
 
               true
@@ -120,7 +123,7 @@ module GitlabQuality
             #
             # @return [Array<String, Integer>] first value holds the new content, the second value holds the line number of the test
             def add_metadata # rubocop:disable Metrics/AbcSize
-              matched_lines = context.find_example_match_lines(file_contents, example_name)
+              @matched_lines = context.find_example_match_lines(file_contents, example_name)
 
               if matched_lines.any? { |line| line[0].include?(':blocking') }
                 Runtime::Logger.info("Example '#{example_name}' is already blocking")

data/lib/gitlab_quality/test_tooling/test_meta/processor/add_to_quarantine_processor.rb

@@ -60,12 +60,12 @@ module GitlabQuality
             private
 
             attr_reader :context, :file_path, :file_contents, :failure_issue_url, :example_name,
-              :mr_title, :failure_issue, :changed_line_no
+              :mr_title, :failure_issue, :changed_line_no, :matched_lines
 
             # Checks if the failure issue is closed or if there is already an MR open
             #
             # @return [Boolean]
-            def proceed_with_commit?
+            def proceed_with_commit? # rubocop:disable Metrics/AbcSize
               if context.issue_is_closed?(failure_issue)
                 Runtime::Logger.info("  Failure issue '#{failure_issue_url}' is closed. Will not proceed with creating MR.")
                 return false
@@ -75,6 +75,9 @@ module GitlabQuality
               elsif failure_is_related_to_test_environment?
                 Runtime::Logger.info("  Failure issue '#{failure_issue_url}' is environment related. Will not proceed with creating MR.")
                 return false
+              elsif context.quarantined?(matched_lines, file_contents)
+                Runtime::Logger.info("  This test is already in quarantine: #{file_path}:#{changed_line_no}. Will not proceed with creating MR.")
+                return false
               end
 
               true
@@ -199,7 +202,7 @@ module GitlabQuality
             #
             # @return [Array<String, Integer>] first value holds the new content, the second value holds the line number of the test
             def add_metadata # rubocop:disable Metrics/AbcSize
-              matched_lines = context.find_example_match_lines(file_contents, example_name)
+              @matched_lines = context.find_example_match_lines(file_contents, example_name)
 
               context.update_matched_line(matched_lines.last, file_contents.dup) do |line|
                 indentation = context.indentation(line)

data/lib/gitlab_quality/test_tooling/test_meta/test_meta_updater.rb

@@ -129,6 +129,26 @@ module GitlabQuality
           matched_lines
         end
 
+        # Scans the content from the matched line until `do` is found to look for quarantine token
+        #
+        # @param [Array] matched_lines an array of arrays containing the matched line and their index
+        # @param [String] file_contents the content of the spec file
+        # @return [Bolean]
+        def quarantined?(matched_lines, file_contents)
+          lines = file_contents.split("\n")
+
+          matched_lines.each do |matched_line|
+            matched_line_starting_index = matched_line[1]
+
+            lines[matched_line_starting_index..].each do |line|
+              return true if line.include?('quarantine: {')
+              break if / do$/.match?(line)
+            end
+          end
+
+          false
+        end
+
         # Update the provided matched_line with content from the block if given
         #
         # @param [Array<String, Integer>] matched_line first value holds the line content, the second value holds the line number

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

@@ -32,10 +32,6 @@ module GitlabQuality
           raise NotImplementedError
         end
 
-        def line_number
-          raise NotImplementedError
-        end
-
         def section
           raise NotImplementedError
         end
@@ -52,10 +48,53 @@ module GitlabQuality
           raise NotImplementedError
         end
 
+        def product_group
+          report['product_group'].to_s
+        end
+
+        def feature_category
+          report['feature_category']
+        end
+
         def failures?
           failures.any?
         end
 
+        def product_group?
+          product_group != ''
+        end
+
+        def failure_issue
+          report['failure_issue']
+        end
+
+        def failure_issue=(new_failure_issue)
+          report['failure_issue'] = new_failure_issue
+        end
+
+        def line_number
+          report['line_number']
+        end
+
+        def level
+          report['level']
+        end
+
+        def run_time
+          report['run_time'].to_f.round(2)
+        end
+
+        def screenshot?
+          !!screenshot
+        end
+
+        def quarantine?
+          # The value for 'quarantine' could be nil, a hash, a string,
+          # or true (if the test just has the :quarantine tag)
+          # But any non-nil or false value should means the test is in quarantine
+          !!quarantine
+        end
+
         def file
           @file ||= relative_file.start_with?('qa/') ? "qa/#{relative_file}" : relative_file
         end
@@ -98,6 +137,14 @@ module GitlabQuality
         private
 
         attr_reader :token, :project, :ref
+
+        def screenshot
+          report.fetch('screenshot', nil)
+        end
+
+        def quarantine
+          report.fetch('quarantine', nil)
+        end
       end
     end
   end

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

@@ -40,64 +40,13 @@ module GitlabQuality
           end
         end
 
-        def quarantine
-          !report['quarantine'].nil?
-        end
-
-        def quarantine?
-          # The value for 'quarantine' could be nil, a hash, a string,
-          # or true (if the test just has the :quarantine tag)
-          # But any non-nil or false value should means the test is in quarantine
-          !!quarantine
-        end
-
-        def line_number
-          report['line_number']
-        end
-
-        def level
-          report['level']
-        end
-
-        def run_time
-          report['run_time'].to_f.round(2)
-        end
-
-        def screenshot
-          report['screenshot']
-        end
-
-        def screenshot?
-          !!screenshot
-        end
-
         def max_duration_for_test
-          ""
+          ''
         end
 
         def ci_job_url
           ENV.fetch('CI_JOB_URL', '')
         end
-
-        def product_group
-          report['product_group'].to_s
-        end
-
-        def product_group?
-          product_group != ''
-        end
-
-        def feature_category
-          report['feature_category']
-        end
-
-        def failure_issue
-          report['failure_issue']
-        end
-
-        def failure_issue=(new_failure_issue)
-          report['failure_issue'] = new_failure_issue
-        end
       end
     end
   end

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

@@ -68,21 +68,6 @@ module GitlabQuality
           report['testcase'] = new_testcase
         end
 
-        def failure_issue
-          report['failure_issue']
-        end
-
-        def failure_issue=(new_failure_issue)
-          report['failure_issue'] = new_failure_issue
-        end
-
-        def quarantine?
-          # The value for 'quarantine' could be nil, a hash, a string,
-          # or true (if the test just has the :quarantine tag)
-          # But any non-nil or false value should means the test is in quarantine
-          !!quarantine
-        end
-
         def quarantine_type
           quarantine['type'] if quarantine?
         end
@@ -91,26 +76,10 @@ module GitlabQuality
           quarantine['issue'] if quarantine?
         end
 
-        def screenshot?
-          !!screenshot
-        end
-
         def screenshot_image
           screenshot['image'] if screenshot?
         end
 
-        def product_group
-          report['product_group'].to_s
-        end
-
-        def product_group?
-          product_group != ''
-        end
-
-        def feature_category
-          report['feature_category']
-        end
-
         def section
           report['section']
         end
@@ -119,22 +88,10 @@ module GitlabQuality
           report['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
-
-        def level
-          report['level']
-        end
-
         def ci_job_id
           report['ci_job_url'].split('/').last
         end
@@ -180,14 +137,6 @@ module GitlabQuality
 
         private
 
-        def quarantine
-          report.fetch('quarantine', nil)
-        end
-
-        def screenshot
-          report.fetch('screenshot', nil)
-        end
-
         def format_message_lines(message_lines)
           message_lines.is_a?(Array) ? message_lines.join("\n") : message_lines
         end

data/lib/gitlab_quality/test_tooling/version.rb

@@ -2,6 +2,6 @@
 
 module GitlabQuality
   module TestTooling
-    VERSION = "1.31.0"
+    VERSION = "1.33.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_quality-test_tooling
 version: !ruby/object:Gem::Version
-  version: 1.31.0
+  version: 1.33.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-15 00:00:00.000000000 Z
+date: 2024-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control