gitlab_quality-test_tooling 0.9.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fa16a309741761cbce53a73d541cef1c6bb587cd790492cddc02face87e4338b
-  data.tar.gz: 9cdba5b6c53c83adba07ce9cc0316568b4e8137955fe46faef7705b4b577a5d9
+  metadata.gz: 57cea55a73290299387eff651dac61af423656f7404afb4bd954d08d6f5d71f1
+  data.tar.gz: 4ef22d91d38fa5f85fe71d022e5a77a6081b4c9d536310e1f37d614d1b672d81
 SHA512:
-  metadata.gz: dbb5472b2c4a5d70b26806c2467faae4a8b6770a2cf0ddc61f27e2c082f51459f5f8f7a4d640ec93ee3a8da0a126f5effdbae174d7aaf71d2054eddee0854529
-  data.tar.gz: 98bdef30f3db77c15256ed2ef02e9b3550d8ed6d653e932f0550b35ba3b4f99bd899cedd518dd9a3e0e422ad07e232b2ee1eb1a3abfa2713927312a788c17ad5
+  metadata.gz: be4e9f1eea90fa1407058e8fe9cc1bf7dc02e86d9cbe4c3d69a30919e989505fe6ef882abdfdc6a29a3c5a0dbdfb61588c1e359fa800366f38e8f67355230a8f
+  data.tar.gz: 36419f06e594ff1d9c39b307d3868d1265bf4cbd68cfbc3e2ea991b594958b8d1e7280380e44526beaf4866376e8493722e2f564744c874824ce783f15b83b24

data/Gemfile.lock

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

data/README.md

@@ -85,6 +85,9 @@ Usage: exe/relate-failure-issue [options]
     -t, --token TOKEN                A valid access token with `api` scope and Maintainer permission in PROJECT
         --system-log-files SYSTEM_LOG_FILES
                                      Include errors from system logs in failure issues
+        --base-issue-labels BASE_ISSUE_LABELS
+                                     Labels to add to new failure issues
+        --confidential               Makes created new issues confidential
         --dry-run                    Perform a dry-run (don't create or update issues)
     -v, --version                    Show the version
     -h, --help                       Show the usage
@@ -128,11 +131,28 @@ 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 note)
+    -v, --version                    Show the version
+    -h, --help                       Show the usage
+```
+
+### `slow-test-merge-request-report-note`
+
+```shell
+$ exe/slow-test-merge-request-report-note -h
+Purpose: Create slow test note on merge requests from JSON RSpec report files
+Usage: exe/slow-test-merge-request-report-note [options]
+    -i, --input-files INPUT_FILES    JSON RSpec report files JSON
+        --project PROJECT            Can be an integer or a group/project string
+    -m MERGE_REQUEST_IID,            An integer merge request IID
+        --merge_request_iid
     -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/relate-failure-issue

@@ -37,6 +37,10 @@ options = OptionParser.new do |opts|
     params[:base_issue_labels] = base_issue_labels.split(',')
   end
 
+  opts.on('--confidential', "Makes created new issues confidential") do
+    params[:confidential] = true
+  end
+
   opts.on('--dry-run', "Perform a dry-run (don't create or update issues)") do
     params[:dry_run] = true
   end

data/exe/slow-test-merge-request-report-note

@@ -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-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('-m', '--merge_request_iid MERGE_REQUEST_IID', String, 'An integer merge request IID') do |merge_request_iid|
+    params[:merge_request_iid] = merge_request_iid
+  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 note)") 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 note on merge requests from JSON RSpec report files"
+    puts opts
+    exit
+  end
+
+  opts.parse(ARGV)
+end
+
+if params.any?
+  GitlabQuality::TestTooling::Report::MergeRequestSlowTestsReport.new(**params).invoke!
+else
+  puts options
+  exit 1
+end

data/lib/gitlab_quality/test_tooling/gitlab_client/merge_request.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require 'gitlab'
+
+module GitlabQuality
+  module TestTooling
+    module GitlabClient
+      class MergeRequest
+        def initialize(token:, project:, merge_request_iid:)
+          @token = token
+          @project = project
+          @merge_request_iid = merge_request_iid
+        end
+
+        def find_merge_request
+          client.merge_request_changes(project, merge_request_iid)
+        end
+
+        def merge_request_changed_files
+          find_merge_request["changes"].map do |change|
+            change["new_path"]
+          end
+        end
+
+        def find_note(body:)
+          client.merge_request_notes(project, merge_request_iid, per_page: 100).auto_paginate.find do |mr_note|
+            mr_note['body'] =~ /#{body}/
+          end
+        end
+
+        def create_note(note:)
+          client.create_merge_request_note(project, merge_request_iid, note)
+        end
+
+        def update_note(id:, note:)
+          client.edit_merge_request_note(project, merge_request_iid, id, note)
+        end
+
+        private
+
+        attr_reader :project, :token, :merge_request_iid
+
+        def client
+          @client ||= Gitlab.client(
+            endpoint: Runtime::Env.gitlab_api_base,
+            private_token: token
+          )
+        end
+      end
+    end
+  end
+end

data/lib/gitlab_quality/test_tooling/gitlab_client/merge_request_dry_client.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    module GitlabClient
+      class MergeRequestDryClient < MergeRequest
+        def find_merge_request
+          puts "Finding merge_request_id #{merge_request_iid}"
+          puts "project: #{project}"
+        end
+
+        def merge_request_changed_files
+          puts "Changed files for #{merge_request_iid}"
+          []
+        end
+
+        def find_note(body:)
+          puts "Find note for #{merge_request_iid} with body: #{body}"
+        end
+
+        def create_note(note:)
+          puts "The following note would have been created with body: #{note}"
+        end
+
+        def update_note(id:, note:)
+          puts "The following note would have been update id: #{id} with body: #{note}"
+        end
+      end
+    end
+  end
+end

data/lib/gitlab_quality/test_tooling/gitlab_issue_client.rb

@@ -61,13 +61,14 @@ module GitlabQuality
         end
       end
 
-      def create_issue(title:, description:, labels:, issue_type: 'issue', assignee_id: nil, due_date: nil)
+      def create_issue(title:, description:, labels:, issue_type: 'issue', assignee_id: nil, due_date: nil, confidential: false)
         attrs = {
           issue_type: issue_type,
           description: description,
           labels: labels,
           assignee_id: assignee_id,
-          due_date: due_date
+          due_date: due_date,
+          confidential: confidential
         }.compact
 
         handle_gitlab_client_exceptions do

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

@@ -39,9 +39,7 @@ module GitlabQuality
 
           def fetch_group_sets(product_group)
             @group_sets = @stage_sets.select do |user|
-              user['role'].include?(product_group.split("_").map do |word|
-                                      word == 'and' ? word : word.capitalize
-                                    end.join(" "))
+              user['role'].downcase.tr(' ', '_').include?(product_group)
             end
           end
         end

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

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    module Report
+      class MergeRequestSlowTestsReport
+        SLOW_TEST_MESSAGE = '<!-- slow-test -->'
+        SLOW_TEST_LABEL = '/label ~"rspec:slow test detected"'
+        SLOW_TEST_NOTE_SOURCE_CODE = 'Generated by [`gitlab_quality-test_tooling`](https://gitlab.com/gitlab-org/ruby/gems/gitlab_quality-test_tooling/-/blob/main/lib/gitlab_quality/test_tooling/report/merge_request_slow_tests_report.rb).'
+        SLOW_TEST_NOTE_FEEDBACK = 'Please [share your feedback and suggestions](https://gitlab.com/gitlab-org/quality/engineering-productivity/team/-/issues/289).'
+
+        def initialize(token:, input_files:, merge_request_iid:, project: nil, dry_run: false, **_kwargs)
+          @project = project
+          @gitlab_merge_request = (dry_run ? GitlabClient::MergeRequestDryClient : GitlabClient::MergeRequest).new(token: token, project: project,
+            merge_request_iid: merge_request_iid)
+          @files = Array(input_files)
+          @merge_request_iid = merge_request_iid
+        end
+
+        def invoke!
+          validate_input!
+
+          run!
+        end
+
+        private
+
+        attr_reader :gitlab_merge_request, :files, :project, :merge_request_iid
+
+        def run!
+          puts "Reporting slow tests in MR #{merge_request_iid}"
+
+          TestResults::Builder.new(files).test_results_per_file do |test_results|
+            puts "=> Reporting #{test_results.count} tests in #{test_results.path}"
+
+            upsert_mr_note(slow_related_tests(slow_tests(test_results))) if should_create_mr_note?(test_results)
+          end
+        end
+
+        def should_create_mr_note?(test_results)
+          gitlab_merge_request.merge_request_changed_files.any? &&
+            slow_tests(test_results).any? &&
+            slow_related_tests(slow_tests(test_results)).any?
+        end
+
+        def slow_related_tests(slow_test_results)
+          slow_test_results.select do |slow_test_result|
+            base_file = slow_test_result.file.split('/').last.gsub('_spec.rb', '')
+
+            merge_request_changed_files.any? { |change| change =~ /#{base_file}/ }
+          end
+        end
+
+        def merge_request_changed_files
+          @merge_request_changed_files ||= gitlab_merge_request.merge_request_changed_files
+        end
+
+        def slow_tests(test_results)
+          test_results.select(&:slow_test?)
+        end
+
+        def note_header
+          [
+            SLOW_TEST_MESSAGE,
+            SLOW_TEST_LABEL,
+            ":tools: #{SLOW_TEST_NOTE_SOURCE_CODE}\n",
+            ":recycle: #{SLOW_TEST_NOTE_FEEDBACK}\n",
+            "---\n",
+            ':snail: Slow tests detected in this merge request, might be related with changed RSpec files.',
+            '| Job | File | Name | Duration | Expected duration |',
+            '| --- | --- | --- | --- | --- |'
+          ]
+        end
+
+        def slow_test_rows(slow_test)
+          rows = []
+
+          slow_test.each do |test|
+            rows << slow_test_table_row(test)
+          end
+
+          rows
+        end
+
+        def build_note(slow_test)
+          rows = note_header + slow_test_rows(slow_test)
+
+          rows.join("\n")
+        end
+
+        def note_comment_includes_slow_test?(gitlab_note, slow_test)
+          gitlab_note.include?("[##{slow_test.ci_job_id}](#{slow_test.ci_job_url}) | #{slow_test.test_file_link}")
+        end
+
+        def slow_test_table_row(slow_test)
+          row = [
+            "[##{slow_test.ci_job_id}](#{slow_test.ci_job_url})",
+            slow_test.test_file_link,
+            slow_test.name,
+            "#{slow_test.run_time} s",
+            "< #{slow_test.max_duration_for_test} s"
+          ]
+
+          "| #{row.join(' | ')} |"
+        end
+
+        def add_slow_test_rows(gitlab_note, slow_tests)
+          slow_tests.each do |slow_test|
+            gitlab_note += "\n#{slow_test_table_row(slow_test)}" unless note_comment_includes_slow_test?(gitlab_note, slow_test)
+          end
+
+          gitlab_note
+        end
+
+        def upsert_mr_note(slow_tests)
+          existing_note = gitlab_merge_request.find_note(body: SLOW_TEST_MESSAGE)
+
+          if existing_note
+            puts "Update note for merge request: #{merge_request_iid}"
+
+            up_to_date_note = add_slow_test_rows(existing_note.body, slow_tests)
+
+            gitlab_merge_request.update_note(id: existing_note['id'], note: up_to_date_note) if existing_note.body != up_to_date_note
+          else
+            up_to_date_note = build_note(slow_tests)
+
+            puts "Create note for merge request: #{merge_request_iid}"
+
+            gitlab_merge_request.create_note(note: up_to_date_note)
+          end
+        end
+
+        def validate_input!
+          assert_project!
+          assert_input_files!(files)
+        end
+
+        def assert_project!
+          return if project
+
+          abort "Please provide a valid project ID or path with the `-p/--project` option!"
+        end
+
+        def assert_input_files!(files)
+          return if Dir.glob(files).any?
+
+          abort "Please provide valid JUnit report files. No files were found matching `#{files.join(',')}`"
+        end
+      end
+    end
+  end
+end

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

@@ -8,23 +8,11 @@ module GitlabQuality
       class ReportAsIssue
         include Concerns::Utils
 
-        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)
+        def initialize(token:, input_files:, project: nil, confidential: false, dry_run: false, **_kwargs)
           @project = project
           @gitlab = (dry_run ? GitlabIssueDryClient : GitlabIssueClient).new(token: token, project: project)
           @files = Array(input_files)
+          @confidential = confidential
         end
 
         def invoke!
@@ -35,7 +23,7 @@ module GitlabQuality
 
         private
 
-        attr_reader :gitlab, :files, :project, :issue_type
+        attr_reader :gitlab, :files, :project, :issue_type, :confidential
 
         def run!
           raise NotImplementedError
@@ -51,22 +39,16 @@ module GitlabQuality
 
           | Field | Value |
           | ------ | ------ |
-          | File | #{test_file_link(test)} |
+          | File | #{test.test_file_link} |
           | Description | `#{test.name}` |
           | Test level | #{test.level} |
           | Hash | `#{test_hash(test)}` |
           | Duration | #{test.run_time} seconds |
-          | Expected duration | < #{max_duration_for_test(test)} seconds |
+          | Expected duration | < #{test.max_duration_for_test} seconds |
           #{"| Test case | #{test.testcase} |" if test.testcase}
           DESCRIPTION
         end
 
-        def test_file_link(test)
-          path_prefix = test.file.start_with?('qa/') ? 'qa/' : ''
-
-          "[`#{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)
           []
         end
@@ -104,7 +86,8 @@ module GitlabQuality
             labels: new_issue_labels(test).to_a,
             issue_type: issue_type,
             assignee_id: new_issue_assignee_id(test),
-            due_date: new_issue_due_date(test)
+            due_date: new_issue_due_date(test),
+            confidential: confidential
           }.compact
           issue = gitlab.create_issue(**attrs)
 
@@ -161,6 +144,8 @@ module GitlabQuality
             'found:pre.gitlab.com'
           when 'nightly', Runtime::Env.default_branch, 'staging-ref', 'release'
             "found:#{pipeline}"
+          when 'customers-gitlab-com'
+            'found:customers.stg.gitlab.com'
           else
             raise "No `found:*` label for the `#{pipeline}` pipeline!"
           end
@@ -169,15 +154,6 @@ 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

@@ -27,7 +27,7 @@ module GitlabQuality
             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)
+              create_slow_issue(test) if test.slow_test?
             end
           end
         end
@@ -59,10 +59,6 @@ module GitlabQuality
         rescue MultipleIssuesFound => e
           warn(e.message)
         end
-
-        def should_create_slow_issue?(test)
-          !test.allowed_to_be_slow? && test.run_time > max_duration_for_test(test)
-        end
       end
     end
   end

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

@@ -4,8 +4,21 @@ module GitlabQuality
   module TestTooling
     module TestResult
       class JsonTestResult < BaseTestResult
+        FILE_BASE_URL = "https://gitlab.com/gitlab-org/gitlab/-/blob/master/"
+
         PRIVATE_TOKEN_REGEX = /(private_token=)[\w-]+/
 
+        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 name
           report.fetch('full_description')
         end
@@ -93,6 +106,10 @@ module GitlabQuality
           report['level']
         end
 
+        def ci_job_id
+          report['ci_job_url'].split('/').last
+        end
+
         def failures # rubocop:disable Metrics/AbcSize
           @failures ||=
             report.fetch('exceptions', []).filter_map do |exception|
@@ -123,6 +140,25 @@ module GitlabQuality
           !!report['allowed_to_be_slow']
         end
 
+        def slow_test?
+          !allowed_to_be_slow? && run_time > max_duration_for_test
+        end
+
+        def max_duration_for_test
+          test_level_specification = TEST_LEVEL_SPECIFICATIONS.find do |test_level_specification|
+            example_id =~ test_level_specification.regex
+          end
+          return OTHER_TESTS_MAX_DURATION unless test_level_specification
+
+          test_level_specification.max_duration
+        end
+
+        def test_file_link
+          path_prefix = file.start_with?('qa/') ? 'qa/' : ''
+
+          "[`#{path_prefix}#{file}#L#{line_number}`](#{FILE_BASE_URL}#{path_prefix}#{file}#L#{line_number})"
+        end
+
         private
 
         def quarantine

data/lib/gitlab_quality/test_tooling/version.rb

@@ -2,6 +2,6 @@
 
 module GitlabQuality
   module TestTooling
-    VERSION = "0.9.3"
+    VERSION = "1.1.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_quality-test_tooling
 version: !ruby/object:Gem::Version
-  version: 0.9.3
+  version: 1.1.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-07-26 00:00:00.000000000 Z
+date: 2023-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -324,6 +324,7 @@ executables:
 - relate-failure-issue
 - report-results
 - slow-test-issues
+- slow-test-merge-request-report-note
 - update-screenshot-paths
 extensions: []
 extra_rdoc_files: []
@@ -348,9 +349,12 @@ files:
 - exe/relate-failure-issue
 - exe/report-results
 - exe/slow-test-issues
+- exe/slow-test-merge-request-report-note
 - exe/update-screenshot-paths
 - lefthook.yml
 - lib/gitlab_quality/test_tooling.rb
+- lib/gitlab_quality/test_tooling/gitlab_client/merge_request.rb
+- lib/gitlab_quality/test_tooling/gitlab_client/merge_request_dry_client.rb
 - lib/gitlab_quality/test_tooling/gitlab_issue_client.rb
 - lib/gitlab_quality/test_tooling/gitlab_issue_dry_client.rb
 - lib/gitlab_quality/test_tooling/labels_inference.rb
@@ -359,6 +363,7 @@ files:
 - 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
+- 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
 - lib/gitlab_quality/test_tooling/report/report_as_issue.rb