gitlab_quality-test_tooling 1.11.0 → 1.12.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9d5389523997b69a28fe068d576dc92e77c1bcc461fda4ed50292bb2ce6d8c9c
-  data.tar.gz: 541341b34aa04d235d8c1b068f28533ff804b57411ce56237cb16f64e3381ad3
+  metadata.gz: b88e790bd74462ff96779cb28d8f8f2cdadd99356e3889f50ec56ed7f5ea691d
+  data.tar.gz: 865098baec02cb4f7cf6634fc7e7cb45a0394261957d9b0cdc33b9c0efd74c29
 SHA512:
-  metadata.gz: 17a53fa74d99ebd6bde6397ed9a5976cdce5a7fef4eb2ac20256bf93ffd8f346b15ff467b6ff6207f07a930597ec5b7814c131293d8d9a29548b5f39b10ca90e
-  data.tar.gz: 1a918bc5b005653e9ce263c728f0068256df77c638961d59a62b0461cdeb9d774556a58fe41e2409a81e0fac98f838c53d057c5ba7483ab04facc17c0e54e999
+  metadata.gz: 1bdaa39d9a6e2ea9000d3318d54e1c3385c552fa967b86780f697ee10becf7e6f0cc3c8edf19a7ac7d29988babaf6ad735a1191d7132ed7f635939cde3575fa6
+  data.tar.gz: 3edfd0209db270145f48338dbf0ebc1785176f8fd158fef8880b13b3280e8a569437d30f26234203bb58bbb6b111992265209882df4c783b83342b942d2d7d00

data/Gemfile.lock

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

data/README.md

@@ -144,12 +144,14 @@ Usage: exe/slow-test-issues [options]
 ### `exe/flaky-test-issues`
 
 ```shell
-Purpose: Purpose: Create flaky test issues for any passed test coming from rspec-retry JSON report files
+Purpose: Create flaky test issues for any passed test coming from rspec-retry JSON report files.
 Usage: exe/flaky-test-issues [options]
     -i, --input-files INPUT_FILES    JSON rspec-retry report files
     -p, --project PROJECT            Can be an integer or a group/project string
     -m MERGE_REQUEST_IID,            An integer merge request IID
         --merge_request_iid
+        --base-issue-labels BASE_ISSUE_LABELS
+                                     Comma-separated labels (without tilde) to add to new flaky test issues
     -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
@@ -217,7 +219,7 @@ If you forget to set the changelog entry in your commit messages, you can also e
 
 ### Steps to release
 
-Use a `Release` merge request template and create a merge requet to update the version number in `version.rb`, and get the merge request merged by a maintainer.
+Use a `Release` merge request template and create a merge request to update the version number in `version.rb`, and get the merge request merged by a maintainer.
 
 This will then be packaged into a gem and pushed to [rubygems.org](https://rubygems.org) by the CI/CD.
 

data/exe/flaky-test-issues

@@ -23,6 +23,11 @@ options = OptionParser.new do |opts|
     params[:merge_request_iid] = merge_request_iid
   end
 
+  opts.on('--base-issue-labels BASE_ISSUE_LABELS', String,
+    'Comma-separated labels (without tilde) to add to new flaky test issues') do |base_issue_labels|
+    params[:base_issue_labels] = base_issue_labels.split(',')
+  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

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module GitlabQuality
+  module TestTooling
+    module Concerns
+      module FindSetDri
+        def set_dri_via_group(product_group, stage)
+          parse_json_with_sets
+          fetch_stage_sets(stage)
+
+          return @sets.sample['username'] if @stage_sets.empty?
+
+          fetch_group_sets(product_group)
+
+          if @group_sets.empty?
+            @stage_sets.sample['username']
+          else
+            @group_sets.sample['username']
+          end
+        end
+
+        private
+
+        def parse_json_with_sets
+          response = Support::HttpRequest.make_http_request(
+            url: 'https://gitlab-org.gitlab.io/gitlab-roulette/roulette.json'
+          )
+          @sets = JSON.parse(response.body).select { |user| user['role'].include?('software-engineer-in-test') }
+        end
+
+        def fetch_stage_sets(stage)
+          @stage_sets = @sets.select do |user|
+            user['role'].include?(stage.split("_").map(&:capitalize).join(" "))
+          end
+        end
+
+        def fetch_group_sets(product_group)
+          @group_sets = @stage_sets.select do |user|
+            user['role'].downcase.tr(' ', '_').include?(product_group)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    module GitlabClient
+      class BranchesClient < GitlabClient
+        def create(branch_name, ref)
+          branch = handle_gitlab_client_exceptions do
+            client.create_branch(project, branch_name, ref)
+          end
+
+          Runtime::Logger.debug("Created branch #{branch['name']} (#{branch['web_url']})")
+          branch
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    module GitlabClient
+      class BranchesDryClient < BranchesClient
+        def create(branch_name, ref)
+          branch = { 'name' => branch_name, 'web_url' => 'https://example.com/dummy/branch/url' }
+          puts "A branch would have been created with name: #{branch['name']}, web_url: #{branch['web_url']} and ref: #{ref}"
+          branch
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    module GitlabClient
+      class CommitsClient < GitlabClient
+        def create(branch_name, file_path, new_content, message)
+          commit = client.create_commit(project, branch_name, message, [
+            { action: :update, file_path: file_path, content: new_content }
+          ])
+
+          Runtime::Logger.debug("Created commit #{commit['id']} (#{commit['web_url']}) on #{branch_name}")
+          commit
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    module GitlabClient
+      class CommitsDryClient < CommitsClient
+        def create(branch_name, file_path, new_content, message)
+          puts "A commit would have been created on branch_name: #{branch_name}, file_path: #{file_path}, message: #{message} and content:"
+          puts new_content
+        end
+      end
+    end
+  end
+end

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

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require 'gitlab'
-
 module GitlabQuality
   module TestTooling
     module GitlabClient
@@ -10,19 +8,26 @@ module GitlabQuality
           client.merge_request_changes(project, merge_request_iid)
         end
 
-        def create_merge_request(title:, source_branch:, target_branch:, description:, labels:)
+        def create_merge_request(title:, source_branch:, target_branch:, description:, labels:, assignee_id: nil)
+          attrs = {
+            source_branch: source_branch,
+            target_branch: target_branch,
+            description: description,
+            labels: labels,
+            assignee_id: assignee_id,
+            squash: true,
+            remove_source_branch: true
+          }.compact
+
           merge_request = handle_gitlab_client_exceptions do
             client.create_merge_request(project,
               title,
-              source_branch: source_branch,
-              target_branch: target_branch,
-              description: description,
-              labels: labels,
-              squash: true,
-              remove_source_branch: true)
+              attrs)
           end
 
           Runtime::Logger.debug("Created merge request #{merge_request['iid']} (#{merge_request['web_url']})") if merge_request
+
+          merge_request
         end
 
         def find(iid: nil, options: {}, &select)

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

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    module GitlabClient
+      class RepositoryFilesClient < GitlabClient
+        attr_reader :file_path
+
+        def initialize(file_path:, **kwargs)
+          @file_path = file_path
+
+          super
+        end
+
+        def file_contents
+          handle_gitlab_client_exceptions do
+            client.file_contents(project, file_path.gsub(%r{^/}, ""))
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -19,14 +19,24 @@ module GitlabQuality
         FOUND_IN_MR_LABEL     = 'found:in MR'
         FOUND_IN_MASTER_LABEL = 'found:master'
 
-        def initialize(token:, input_files:, project: nil, merge_request_iid: nil, confidential: false, dry_run: false, **_kwargs)
+        def initialize(
+          token:,
+          input_files:,
+          base_issue_labels: nil,
+          confidential: false,
+          dry_run: false,
+          merge_request_iid: nil,
+          project: nil,
+          **_kwargs)
           super(token: token, input_files: input_files, project: project, confidential: confidential, dry_run: dry_run)
+
+          @base_issue_labels = Set.new(base_issue_labels)
           @merge_request_iid = merge_request_iid
         end
 
         private
 
-        attr_reader :merge_request_iid
+        attr_reader :base_issue_labels, :merge_request_iid
 
         def run!
           puts "Reporting flaky tests in `#{files.join(',')}` as issues in project `#{project}` via the API at `#{Runtime::Env.gitlab_api_base}`."
@@ -54,7 +64,7 @@ module GitlabQuality
               FOUND_IN_MR_LABEL
             end
 
-          NEW_ISSUE_LABELS + [found_label]
+          NEW_ISSUE_LABELS + base_issue_labels + [found_label]
         end
 
         def new_issue_description(test)

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

@@ -16,7 +16,7 @@ module GitlabQuality
       # - Find issue by title (with test description or test file), then further filter by stack trace, then pick the better-matching one
       # - Add the failed job to the issue description, and update labels
       class RelateFailureIssue < ReportAsIssue
-        include Concerns::FindSetDri
+        include TestTooling::Concerns::FindSetDri
         include Concerns::GroupAndCategoryLabels
         include Concerns::IssueReports
         include Amatch
@@ -332,7 +332,7 @@ module GitlabQuality
         def new_issue_assignee_id(test)
           return unless test.product_group?
 
-          dri = set_dri_via_group(test.product_group, test)
+          dri = set_dri_via_group(test.product_group, test.stage)
           puts "  => Assigning #{dri} as DRI for the issue."
 
           gitlab.find_user_id(username: dri)

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

@@ -10,7 +10,7 @@ module GitlabQuality
       # - 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 TestTooling::Concerns::FindSetDri
         include Concerns::GroupAndCategoryLabels
 
         NEW_ISSUE_LABELS = Set.new(['test', 'type::maintenance', 'maintenance::performance', 'priority::3', 'severity::3', 'rspec profiling', 'rspec:slow test']).freeze

data/lib/gitlab_quality/test_tooling/slack/post_to_slack_dry.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    module Slack
+      class PostToSlackDry < PostToSlack
+        def invoke!
+          puts "The following message would have posted to Slack:"
+          puts message
+        end
+      end
+    end
+  end
+end

data/lib/gitlab_quality/test_tooling/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_quality-test_tooling
 version: !ruby/object:Gem::Version
-  version: 1.11.0
+  version: 1.12.0
 platform: ruby
 authors:
 - GitLab Quality
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-08 00:00:00.000000000 Z
+date: 2024-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -383,15 +383,20 @@ files:
 - exe/update-screenshot-paths
 - lefthook.yml
 - lib/gitlab_quality/test_tooling.rb
+- lib/gitlab_quality/test_tooling/concerns/find_set_dri.rb
 - lib/gitlab_quality/test_tooling/failed_jobs_table.rb
+- lib/gitlab_quality/test_tooling/gitlab_client/branches_client.rb
+- lib/gitlab_quality/test_tooling/gitlab_client/branches_dry_client.rb
+- lib/gitlab_quality/test_tooling/gitlab_client/commits_client.rb
+- lib/gitlab_quality/test_tooling/gitlab_client/commits_dry_client.rb
 - lib/gitlab_quality/test_tooling/gitlab_client/gitlab_client.rb
 - lib/gitlab_quality/test_tooling/gitlab_client/issues_client.rb
 - lib/gitlab_quality/test_tooling/gitlab_client/issues_dry_client.rb
 - lib/gitlab_quality/test_tooling/gitlab_client/jobs_client.rb
 - 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/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/issue_reports.rb
 - lib/gitlab_quality/test_tooling/report/concerns/results_reporter.rb
@@ -411,6 +416,7 @@ files:
 - lib/gitlab_quality/test_tooling/runtime/env.rb
 - lib/gitlab_quality/test_tooling/runtime/logger.rb
 - lib/gitlab_quality/test_tooling/slack/post_to_slack.rb
+- lib/gitlab_quality/test_tooling/slack/post_to_slack_dry.rb
 - lib/gitlab_quality/test_tooling/summary_table.rb
 - lib/gitlab_quality/test_tooling/support/http_request.rb
 - lib/gitlab_quality/test_tooling/system_logs/finders/json_log_finder.rb
@@ -443,7 +449,7 @@ metadata:
   homepage_uri: https://gitlab.com/gitlab-org/ruby/gems/gitlab_quality-test_tooling
   source_code_uri: https://gitlab.com/gitlab-org/ruby/gems/gitlab_quality-test_tooling
   changelog_uri: https://gitlab.com/gitlab-org/ruby/gems/gitlab_quality-test_tooling/-/releases
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -458,8 +464,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.3.26
+signing_key:
 specification_version: 4
 summary: A collection of test-related tools.
 test_files: []

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

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-require 'json'
-
-module GitlabQuality
-  module TestTooling
-    module Report
-      module Concerns
-        module FindSetDri
-          def set_dri_via_group(product_group, test)
-            parse_json_with_sets
-            fetch_stage_sets(test)
-
-            return @sets.sample['username'] if @stage_sets.empty?
-
-            fetch_group_sets(product_group)
-
-            if @group_sets.empty?
-              @stage_sets.sample['username']
-            else
-              @group_sets.sample['username']
-            end
-          end
-
-          private
-
-          def parse_json_with_sets
-            response = Support::HttpRequest.make_http_request(
-              url: 'https://gitlab-org.gitlab.io/gitlab-roulette/roulette.json'
-            )
-            @sets = JSON.parse(response.body).select { |user| user['role'].include?('software-engineer-in-test') }
-          end
-
-          def fetch_stage_sets(test)
-            @stage_sets = @sets.select do |user|
-              user['role'].include?(test.stage.split("_").map(&:capitalize).join(" "))
-            end
-          end
-
-          def fetch_group_sets(product_group)
-            @group_sets = @stage_sets.select do |user|
-              user['role'].downcase.tr(' ', '_').include?(product_group)
-            end
-          end
-        end
-      end
-    end
-  end
-end