gitlab_quality-test_tooling 2.9.0 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 737a2e86ac9d3545cf1c5f5b9344fead1e03d12dd4a6fe0f9b7ed44b00f604e6
-  data.tar.gz: 99cac62fe8e0672f28930be527ad4ef73743ca8d63c5e59734f610e2e3624ca9
+  metadata.gz: c38aa70a45607f4aa4fb6b5a30370451b4220983ff420e05bac40260bc361c70
+  data.tar.gz: 25fa008b29d0d8470efbd5ed2f5029b693031ab9b8fddba6884a9d4075241ee4
 SHA512:
-  metadata.gz: dac0023706ab1428abc046d6189e7c6df3ad684e4a7f70fcbed84633505c20a515e399e4050c3427584abceb1008e61908c9aacc5286f9dd74431d04e1423149
-  data.tar.gz: 876fa1ec99dcba949757b9f9073a4b118c4f98d877c1c2edfd3bcb55850cbf9de48683684de427536d13b21639d7f66aff98a552abe6d80ec1bd582db6385058
+  metadata.gz: 36061bbe33b1a7bab05481ccf8cebe1146a27846862373a6178cedddf3cc7f73ced1d7e98197a753650d5a82ea25ea4886b27f74f6fca13a2986d699e35a7b16
+  data.tar.gz: 54612a3243704341c2b19c3f6141cca89c88c2e62189b074643da8f5b7527008feb8df525b426a05daddd7107aec24bae32a36950a862dba8230e4099aadbc33

data/.rspec

@@ -1,3 +1,4 @@
 --color
---format documentation
+--order random
+--format progress
 --require spec_helper

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab_quality-test_tooling (2.9.0)
+    gitlab_quality-test_tooling (2.11.0)
       activesupport (>= 7.0, < 7.3)
       amatch (~> 0.4.1)
       fog-google (~> 1.24, >= 1.24.1)
@@ -187,6 +187,7 @@ GEM
       http-cookie (~> 1.0)
       http-form_data (~> 2.2)
       llhttp-ffi (~> 0.5.0)
+    http-accept (1.7.0)
     http-cookie (1.0.7)
       domain_name (~> 0.5)
     http-form_data (2.3.0)
@@ -233,6 +234,7 @@ GEM
     nenv (0.3.0)
     net-http (0.4.1)
       uri
+    netrc (0.11.0)
     nokogiri (1.16.7)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
@@ -273,6 +275,11 @@ GEM
       declarative (< 0.1.0)
       trailblazer-option (>= 0.1.1, < 0.2.0)
       uber (< 0.2.0)
+    rest-client (2.1.0)
+      http-accept (>= 1.7.0, < 2.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 4.0)
+      netrc (~> 0.8)
     retriable (3.1.2)
     reverse_markdown (2.1.1)
       nokogiri
@@ -408,6 +415,7 @@ DEPENDENCIES
   lefthook (~> 1.3)
   pry-byebug (= 3.10.1)
   rake (~> 13.0)
+  rest-client (~> 2.1.0)
   rspec (~> 3.12)
   rspec_junit_formatter (~> 0.6.0)
   simplecov (~> 0.22)

data/README.md

@@ -161,9 +161,17 @@ Usage: exe/knapsack-report-issues [options]
 ```shell
 Purpose: Relate test failures to failure issues from RSpec report files (JSON or JUnit XML)
 Usage: exe/failed-test-issues [options]
-    -i, --input-files INPUT_FILES    RSpec report files (JSON or JUnit XML)
-    -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
+    -i, --input-files INPUT_FILES    RSpec report files (JSON or JUnit XML) [REQUIRED]
+    -p, --project PROJECT            Can be an integer or a group/project string [REQUIRED]
+    -t, --token TOKEN                A valid access token with `api` scope and Maintainer permission in PROJECT [REQUIRED]
+        --enable-issue-update [BOOLEAN]
+                                     Enable/disable test health issue creation/update (default: true)
+        --enable-gcs [BOOLEAN]       Enable/disable the push of JSON data to a Google Cloud Storage (GCS) bucket (default: false)
+        --gcs-project-id GCS_PROJECT_ID
+                                     Google Cloud project ID for GCS bucket access
+        --gcs-bucket GCS_BUCKET      Name of the GCS bucket to store metrics data
+        --gcs-credentials GCS_CREDENTIALS
+                                     GCS service account credentials (file path or string)
         --max-diff-ratio MAX_DIFF_RATO
                                      Max stacktrace diff ratio for failure issues detection
     -r RELATED_ISSUES_FILE,          The file path for the related issues
@@ -249,6 +257,39 @@ Usage: exe/update-test-meta [options]
     -h, --help                       Show the usage
 ```
 
+### `exe/feature-readiness-checklist`
+
+```shell
+Purpose: Conditionally create operational readiness checklist and link it to the epic
+Usage: exe/feature-readiness-checklist [options]
+    -p, --project PROJECT            Name of the project
+    -g, --group GROUP                Name of the group
+    -t, --token TOKEN                A valid access token with `api` scope and Maintainer permission in PROJECT
+    -l, --search_labels LABELS       A comma seperated list of labels to filter the epics on
+    -m, --minutes MINUTES            Limit the search to issues and epics created with last MINUTES. Optional.
+    -b, --blocking                   Block the epic by any issues created and linked to it
+        --dry-run                    Perform a dry-run (don't create branches, commits or MRs)
+    -v, --version                    Show the version
+    -h, --help                       Show the usage
+```
+
+### `exe/feature-readiness-evaluation`
+
+```shell
+Purpose: Evaluate MRs for multiple feature readiness criteria and report the status to the corresponding epic
+Usage: exe/feature-readiness-evaluation [options]
+    -p, --project PROJECT            Name of the project
+    -g, --group GROUP                Name of the group
+    -t, --token TOKEN                A valid access token with `api` scope and Maintainer permission in PROJECT
+    -l, --search_labels LABELS       A comma seperated list of labels to filter the epics on
+    -m, --minutes MINUTES            Limit the search to issues and epics created with last MINUTES. Optional.
+    -e, --epic-iid EPIC_IID          evaluate an epic with iid
+    -o, --operational-readinessr     Perform the operational readiness checklist automation
+        --dry-run                    Perform a dry-run (don't create branches, commits or MRs)
+    -v, --version                    Show the version
+    -h, --help                       Show the usage
+```
+
 ## Development
 
 ### Initial setup

data/exe/failed-test-issues

@@ -9,20 +9,48 @@ require_relative "../lib/gitlab_quality/test_tooling"
 params = {}
 
 options = OptionParser.new do |opts|
+  def to_boolean(value, default)
+    return default if value.nil?
+    return true if value == true || value.to_s.casecmp('true').zero?
+
+    false
+  end
+
   opts.banner = "Usage: #{$PROGRAM_NAME} [options]"
 
-  opts.on('-i', '--input-files INPUT_FILES', String, 'RSpec report files (JSON or JUnit XML)') do |input_files|
+  opts.on('-i', '--input-files INPUT_FILES', String, 'RSpec report files (JSON or JUnit XML) [REQUIRED]') 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|
+  opts.on('-p', '--project PROJECT', String, 'Can be an integer or a group/project string [REQUIRED]') 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|
+  opts.on('-t', '--token TOKEN', String, 'A valid access token with `api` scope and Maintainer permission in PROJECT [REQUIRED]') do |token|
     params[:token] = token
   end
 
+  opts.on('--enable-issue-update [BOOLEAN]', "Enable/disable test health issue creation/update (default: true)") do |toggle|
+    params[:issue_update_enabled] = to_boolean(toggle, true)
+  end
+
+  # Google Cloud Storage (GCS) options
+  opts.on('--enable-gcs [BOOLEAN]', "Enable/disable the push of JSON data to a Google Cloud Storage (GCS) bucket (default: false)") do |toggle|
+    params[:gcs_enabled] = to_boolean(toggle, false)
+  end
+
+  opts.on('--gcs-project-id GCS_PROJECT_ID', String, 'Google Cloud project ID for GCS bucket access') do |project_id|
+    params[:gcs_project_id] = project_id
+  end
+
+  opts.on('--gcs-bucket GCS_BUCKET', String, 'Name of the GCS bucket to store metrics data') do |bucket|
+    params[:gcs_bucket] = bucket
+  end
+
+  opts.on('--gcs-credentials GCS_CREDENTIALS', String, 'GCS service account credentials (file path or string)') do |credentials|
+    params[:gcs_credentials] = credentials
+  end
+
   opts.on('--max-diff-ratio MAX_DIFF_RATO', Float, 'Max stacktrace diff ratio for failure issues detection') do |max_diff_ratio|
     params[:max_diff_ratio] = max_diff_ratio
   end
@@ -56,13 +84,30 @@ options = OptionParser.new do |opts|
     puts opts
     exit
   end
-
-  opts.parse(ARGV)
 end
 
-if params.any?
+begin
+  options.parse!(ARGV)
+
+  required_options = [:input_files, :project, :token]
+  missing_options = required_options.select { |option| params[option].nil? }
+
+  if params[:gcs_enabled]
+    gcs_required_options = [:gcs_project_id, :gcs_bucket, :gcs_credentials]
+    missing_gcs_options = gcs_required_options.select { |option| params[option].nil? }
+
+    missing_options.concat(missing_gcs_options) if missing_gcs_options.any?
+  end
+
+  if missing_options.any?
+    warn "Error: Missing required options: #{missing_options.map { |o| "--#{o.to_s.tr('_', '-')}" }.join(', ')}\n"
+    warn options
+    exit 1
+  end
+
   GitlabQuality::TestTooling::Report::FailedTestIssue.new(**params).invoke!
-else
-  puts options
+rescue OptionParser::InvalidOption, OptionParser::MissingArgument => e
+  warn "Error: #{e.message}"
+  warn options
   exit 1
 end

data/exe/feature-readiness-checklist

@@ -0,0 +1,61 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "optparse"
+
+require_relative "../lib/gitlab_quality/test_tooling"
+params = {}
+
+options = OptionParser.new do |opts|
+  opts.banner = "Usage: #{$PROGRAM_NAME} [options]"
+
+  opts.on('-p', '--project PROJECT', String, 'Name of the project') do |project|
+    params[:project] = project
+  end
+  opts.on('-g', '--group GROUP', String, 'Name of the group') do |group|
+    params[:group] = group
+  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('-l', '--search_labels LABELS', String, 'A comma seperated list of labels to filter the epics on') do |search_labels|
+    params[:search_labels] = search_labels.split(',')
+  end
+
+  opts.on('-m', '--minutes MINUTES', Integer, 'Limit the search to issues and epics created with last MINUTES. Optional.') do |minutes|
+    params[:limit_to_minutes] = minutes
+  end
+
+  opts.on('-b', '--blocking', 'Block the epic by any issues created and linked to it') do
+    params[:issue_is_blocking] = true
+  end
+
+  opts.on('--dry-run', "Perform a dry-run (don't create branches, commits or MRs)") 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: Conditionally create operational readiness checklist and link it to the epic"
+    puts opts
+    exit
+  end
+
+  opts.parse(ARGV)
+end
+
+raise ArgumentError, "Missing argument(s). Required arguments are: --project, --group, --token" if params.empty? || ([:project, :group, :token] - params.keys).any?
+
+if params.any?
+  GitlabQuality::TestTooling::FeatureReadiness::OperationalReadinessCheck.new(**params).invoke!
+else
+  puts options
+  exit 1
+end

data/exe/feature-readiness-evaluation

@@ -0,0 +1,62 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "optparse"
+require 'active_support/core_ext/hash'
+
+require_relative "../lib/gitlab_quality/test_tooling"
+params = {}
+
+options = OptionParser.new do |opts|
+  opts.banner = "Usage: #{$PROGRAM_NAME} [options]"
+
+  opts.on('-p', '--project PROJECT', String, 'Name of the project') do |project|
+    params[:project] = project
+  end
+  opts.on('-g', '--group GROUP', String, 'Name of the group') do |group|
+    params[:group] = group
+  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('-l', '--search_labels LABELS', String, 'A comma seperated list of labels to filter the epics on') do |search_labels|
+    params[:search_labels] = search_labels.split(',')
+  end
+
+  opts.on('-m', '--minutes MINUTES', Integer, 'Limit the search to issues and epics created with last MINUTES. Optional.') do |minutes|
+    params[:limit_to_minutes] = minutes
+  end
+
+  opts.on('-ei', '--epic-iid EPIC_IID', String, 'evaluate an epic with iid') do |epic_iid|
+    params[:epic_iid] = epic_iid
+  end
+
+  opts.on('--dry-run', "Perform a dry-run (don't create branches, commits or MRs)") 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: Evaluate MRs for multiple feature readiness criteria and report the status to the corresponding epic"
+    puts opts
+    exit
+  end
+
+  opts.parse(ARGV)
+end
+
+raise ArgumentError, "Missing argument(s). Required arguments are: --project, --group, --token" if params.empty? || ([:project, :group, :token] - params.keys).any?
+
+if params.any?
+  GitlabQuality::TestTooling::FeatureReadiness::Evaluation.new(**params).invoke!
+else
+  puts options
+  exit 1
+end

data/lib/gitlab_quality/test_tooling/feature_readiness/analyzed_items/analyzed_epic.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    module FeatureReadiness
+      module AnalyzedItems
+        class AnalyzedEpic
+          include Concerns::WorkItemConcern
+
+          def initialize(epic:, token:, project:, group:, dry_run:)
+            @token = token
+            @project = project
+            @group = group
+            @dry_run = dry_run
+            @epic = epic
+            @analyzed_issues = []
+          end
+
+          def analyze
+            issue_iids = get_issue_iids(epic, project)
+            return if issue_iids.none?
+
+            open_issues = fetch_open_issues(issue_iids)
+
+            puts "\nProcessing epic: #{epic[:webUrl]} with #{open_issues.count} open feature addition issues."
+
+            process_issues(open_issues)
+          end
+
+          def process_issues(issues)
+            @analyzed_issues.concat(
+              issues.map do |issue|
+                AnalyzedIssue.new(issue: issue, token: token, project: project, group: group, dry_run: dry_run)
+                             .tap(&:analyze)
+                             .result
+              end
+            )
+          end
+
+          def result
+            {
+              epic_iid: epic[:iid],
+              epic_id: epic[:id],
+              epic_web_url: epic[:webUrl],
+              issues: analyzed_issues,
+              doc_mrs: doc_mrs,
+              feature_spec_mrs: feature_spec_mrs,
+              e2e_spec_mrs: e2e_spec_mrs,
+              feature_flag_mrs: feature_flag_mrs
+            }
+          end
+
+          private
+
+          attr_reader :epic, :token, :project, :dry_run, :group, :analyzed_issues
+
+          def work_items_client
+            @work_items_client ||= (dry_run ? GitlabClient::WorkItemsDryClient : GitlabClient::WorkItemsClient).new(token: token, project: project, group: group)
+          end
+
+          def issue_client
+            @issue_client ||= (dry_run ? GitlabClient::IssuesDryClient : GitlabClient::IssuesClient).new(token: token, project: project)
+          end
+
+          def fetch_open_issues(issue_iids)
+            issue_client.find_issues(
+              options: {
+                iids: issue_iids,
+                labels: Evaluation::BASE_LABELS_FOR_SEARCH,
+                state: 'opened'
+              }
+            )
+          end
+
+          def doc_mrs
+            analyzed_issues.flat_map { |issue| issue[:doc_mrs].any? ? issue[:doc_mrs] : [] }
+          end
+
+          def feature_spec_mrs
+            analyzed_issues.flat_map { |issue| issue[:feature_spec_mrs].any? ? issue[:feature_spec_mrs] : [] }
+          end
+
+          def e2e_spec_mrs
+            analyzed_issues.flat_map { |issue| issue[:e2e_spec_mrs].any? ? issue[:e2e_spec_mrs] : [] }
+          end
+
+          def feature_flag_mrs
+            analyzed_issues.flat_map { |issue| issue[:feature_flag_mrs].any? ? issue[:feature_flag_mrs] : [] }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab_quality/test_tooling/feature_readiness/analyzed_items/analyzed_issue.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    module FeatureReadiness
+      module AnalyzedItems
+        class AnalyzedIssue
+          def initialize(issue:, token:, project:, group:, dry_run:)
+            @issue = issue
+            @token = token
+            @project = project
+            @group = group
+            @dry_run = dry_run
+            @analyzed_merge_requests = []
+          end
+
+          def analyze
+            contributing_mrs = contributing_mrs_for_issue(issue)
+            return if contributing_mrs.empty?
+
+            @analyzed_merge_requests.concat(
+              contributing_mrs
+                .reject { |mr| skip_merge_request?(mr, issue) }
+                .map do |merge_request|
+                AnalyzedMergeRequest.new(merge_request: merge_request, token: token, project: project, group: group, dry_run: dry_run)
+                                    .tap(&:analyze)
+                                    .result
+              end
+            )
+          end
+
+          def result
+            {
+              issue_iid: issue.iid,
+              issue_web_url: issue.web_url,
+              merge_requests: analyzed_merge_requests,
+              doc_mrs: doc_mrs,
+              feature_spec_mrs: feature_spec_mrs,
+              e2e_spec_mrs: e2e_spec_mrs,
+              feature_flag_mrs: feature_flag_mrs
+            }
+          end
+
+          private
+
+          attr_reader :issue, :token, :project, :group, :dry_run, :analyzed_merge_requests
+
+          def contributing_mrs_for_issue(issue)
+            related_mrs = issue_client.related_merge_requests(iid: issue.iid)
+
+            return [] if related_mrs.empty?
+
+            related_mrs.select do |mr|
+              mr.description&.include?("##{issue.iid}") || mr.description&.include?(issue.web_url)
+            end
+          end
+
+          def skip_merge_request?(merge_request, issue)
+            if (merge_request.target_project_id != issue.project_id) || (merge_request.draft == true)
+              puts "Skipping: #{merge_request.web_url} #{merge_request.draft == true ? 'as it is a draft' : 'due to different project id'}"
+              return true
+            end
+
+            false
+          end
+
+          def issue_client
+            @issue_client ||= (dry_run ? GitlabClient::IssuesDryClient : GitlabClient::IssuesClient).new(token: token, project: project)
+          end
+
+          def doc_mrs
+            analyzed_merge_requests
+              .select { |mr| mr[:has_docs] }
+              .map.with_index(1) { |mr, index| { "MR#{index}" => mr[:merge_request_web_url] } }
+          end
+
+          def feature_spec_mrs
+            analyzed_merge_requests.select { |mr| mr[:has_feature_specs] }.map.with_index(1) { |mr, index| { "MR#{index}" => mr[:merge_request_web_url] } }
+          end
+
+          def e2e_spec_mrs
+            analyzed_merge_requests.select { |mr| mr[:has_e2e_specs] }.map.with_index(1) { |mr, index| { "MR#{index}" => mr[:merge_request_web_url] } }
+          end
+
+          def feature_flag_mrs
+            analyzed_merge_requests.select { |mr| mr[:added_feature_flag] }.map.with_index(1) { |mr, index| { "MR#{index}" => mr[:merge_request_web_url] } }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab_quality/test_tooling/feature_readiness/analyzed_items/analyzed_merge_request.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    module FeatureReadiness
+      module AnalyzedItems
+        class AnalyzedMergeRequest
+          CODE_DIRECTORIES = %w[app lib config keeps scripts db].freeze
+          ADDITIONS_THRESHOLD = 5
+          CODE_FILES_EXT = "rb|js|vue"
+          SPEC_FILES_EXT = "rb|js"
+          DOC_FILES_EXT = "tmpl|yaml|yml|md"
+
+          def initialize(merge_request:, token:, project:, group:, dry_run:)
+            @merge_request = merge_request
+            @token = token
+            @project = project
+            @group = group
+            @dry_run = dry_run
+          end
+
+          def analyze
+            @files_with_missing_specs ||= fetch_files_with_missing_specs
+          end
+
+          def result
+            {
+              merge_request_iid: merge_request.iid,
+              merge_request_web_url: merge_request.web_url,
+              files_with_missing_specs: files_with_missing_specs,
+              has_docs: has_docs?,
+              has_feature_specs: has_feature_specs?,
+              has_e2e_specs: has_e2e_specs?,
+              added_feature_flag: added_feature_flag?
+            }
+          end
+
+          private
+
+          attr_reader :merge_request, :token, :project, :group, :dry_run, :files_with_missing_specs
+
+          def merge_request_client
+            @merge_request_client ||= (dry_run ? GitlabClient::MergeRequestsDryClient : GitlabClient::MergeRequestsClient).new(token: token, project: project)
+          end
+
+          def has_docs?
+            doc_diffs.any?
+          end
+
+          def has_feature_specs?
+            spec_diffs('features/').map { |diff| has_significant_addition?(diff) }.any?
+          end
+
+          def added_feature_flag?
+            filter_diffs(%r{^(ee/)?config/feature_flags/.*\.yml$}).any?(&:new_file)
+          end
+
+          def has_e2e_specs?
+            qa_spec_diffs.map { |diff| has_significant_addition?(diff) }.any?
+          end
+
+          def fetch_files_with_missing_specs
+            code_paths_with_missing_specs = []
+
+            CODE_DIRECTORIES.each do |dir|
+              code_diffs = diffs_for_dir(dir, CODE_FILES_EXT)
+              sp_diffs = spec_diffs
+              code_paths_with_missing_specs << collect_paths_with_missing_specs(code_diffs, sp_diffs)
+            end
+
+            code_paths_with_missing_specs.flatten
+          end
+
+          def collect_paths_with_missing_specs(code_diffs, sp_diffs)
+            result_array = []
+            code_diffs.each do |code_diff|
+              result_array << code_diff.new_path if has_significant_addition?(code_diff) && !skip_file?(code_diff.new_path) && !has_matching_spec_for_code?(code_diff, sp_diffs)
+            end
+
+            result_array
+          end
+
+          def has_matching_spec_for_code?(code_diff, sp_diffs)
+            spec_file_names = get_spec_file_names(code_diff.new_path)
+            sp_diffs.any? { |diff| ends_with_names?(diff.new_path, spec_file_names) }
+          end
+
+          def diffs
+            @diffs ||= merge_request_client.merge_request_diffs(merge_request_iid: merge_request.iid)
+          end
+
+          def has_significant_addition?(diff_obj)
+            content_lines = diff_obj.diff.split("\n")
+
+            additions = content_lines.count { |line| line.start_with?("+") }
+            subtractions = content_lines.count { |line| line.start_with?("-") }
+
+            # Return true if additions are above threshold and there are equal or more additions than subtractions
+            additions >= ADDITIONS_THRESHOLD && additions >= subtractions
+          end
+
+          def filter_diffs(pattern)
+            diffs.select { |diff| diff.new_path =~ pattern }
+          end
+
+          def diffs_for_dir(dir, ext)
+            filter_diffs(%r{^(ee/#{Regexp.escape(dir)}|#{Regexp.escape(dir)})/.*\.(#{ext})$})
+          end
+
+          def spec_diffs(spec_sub_dir = '')
+            filter_diffs(%r{^(spec|ee/spec)/#{spec_sub_dir}.+_spec\.(#{SPEC_FILES_EXT})$})
+          end
+
+          def qa_spec_diffs
+            filter_diffs(%r{^qa/qa/specs/features/.+(_spec|_shared_examples|_shared_context)\.rb$})
+          end
+
+          def doc_diffs
+            filter_diffs(%r{^doc/.+\.(#{DOC_FILES_EXT})$}o)
+          end
+
+          def get_spec_file_names(path)
+            filename = File.basename(path, ".*")
+
+            %W[#{filename}_spec #{filename}_shared_examples]
+          end
+
+          def ends_with_names?(path, target_names)
+            [File.basename(path, File.extname(path))].intersect?(target_names)
+          end
+
+          def skip_file?(path)
+            path.end_with?('index.js')
+          end
+        end
+      end
+    end
+  end
+end