gitlab_quality-test_tooling 1.8.0 → 1.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4ee3407afd5274be75c1bb63c7f7aeeb0d2353cf62f0fb75c1393bd2103c8c1e
-  data.tar.gz: a4965dd9d979a58c4202c6f25315d60e08d597d51322db491a077a0ae797cf34
+  metadata.gz: d7c32e6b11eb72bf1f453827d3c8c0dd98a8d37788c22000566fac4fe9b0daab
+  data.tar.gz: 573ea110d2d1bea41f217f135f6dfe57a814ecc261142813e4dbbda17f813e0e
 SHA512:
-  metadata.gz: 1619807ec2456f02c9d4a1c09dfb0aeba598de7d51fe7a0377c1e5a9f3f9fc82cf607fa34387bb5ee1691ad28b5637e75c18c38ce068269c3bba76e3c902df22
-  data.tar.gz: '0940057d402dfb8fbcd3a6d2d09f7ff698e26d140ebdda659fcc5347445574fa7f398b2bd91e8a39c872b0f8a9f368fa1f734e59e10262790ed2d507fb97e514'
+  metadata.gz: b7f5b809cd506c860edba93bc45c932183106da000b2eb14ae7149aa5d7a820502971fd5a26747664be1921334af3b1041a668fb128f8b4c739507ac63f850f2
+  data.tar.gz: 1a428ce49770515622c810bfaf2e918df2223b7ed23f38958d994de6bef4c591c5fd10efc7be071d1fdf6cde38eacc8598126b612fde62c300a01c0e9608c83a

data/Gemfile.lock

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

data/README.md

@@ -130,11 +130,13 @@ Usage: exe/update-screenshot-paths [options]
 
 ```shell
 Purpose: Create slow test issues from JSON RSpec report files
-Usage: exe/slow-test-issue [options]
+Usage: exe/slow-test-issues [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)
+    -r RELATED_ISSUES_FILE,          The file path for the related issues
+        --related-issues-file
+        --dry-run                    Perform a dry-run (don't create issues)
     -v, --version                    Show the version
     -h, --help                       Show the usage
 ```
@@ -143,13 +145,13 @@ Usage: exe/slow-test-issue [options]
 
 ```shell
 Purpose: Purpose: Create flaky test issues for any passed test coming from rspec-retry JSON report files
-Usage: exe/flaky-test-issue [options]
+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
     -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)
+        --dry-run                    Perform a dry-run (don't create issues)
     -v, --version                    Show the version
     -h, --help                       Show the usage
 ```
@@ -160,11 +162,11 @@ Usage: exe/flaky-test-issue [options]
 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
+    -p, --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)
+        --dry-run                    Perform a dry-run (don't create note)
     -v, --version                    Show the version
     -h, --help                       Show the usage
 ```

data/exe/post-to-slack

@@ -8,6 +8,9 @@ require_relative "../lib/gitlab_quality/test_tooling"
 
 params = {}
 
+messages = []
+gitlab_api_token = nil
+
 options = OptionParser.new do |opts|
   opts.banner = "Usage: #{$PROGRAM_NAME} [options]"
 
@@ -15,16 +18,34 @@ options = OptionParser.new do |opts|
     params[:slack_webhook_url] = slack_webhook_url
   end
 
+  opts.on('-a', '--gitlab-api-token TOKEN', String, 'GitLab API token') do |token|
+    gitlab_api_token = token unless token.empty?
+  end
+
   opts.on('-c', '--channel CHANNEL', String, 'Slack channel to post the message to') do |channel|
     params[:channel] = channel
   end
 
   opts.on('-m', '--message MESSAGE', String, 'Post message to Slack') do |message|
-    params[:message] = message
+    messages << message
   end
 
   opts.on('-t', '--include-summary-table FILES', String, 'Add a test summary table based on RSpec report files (JUnit XML)') do |files|
-    params[:message] += "\n\n#{GitlabQuality::TestTooling::SummaryTable.create(input_files: files)}"
+    messages << GitlabQuality::TestTooling::SummaryTable.create(input_files: files)
+  end
+
+  opts.on('-j', '--include-failed-jobs-table', 'Add a list of failed jobs in the pipeline') do
+    next puts("Failed jobs table requires api token to be set via --gitlab-api-token option, skipping failed jobs table") unless gitlab_api_token
+
+    project_id = ENV['CI_PROJECT_ID']&.to_i || (next puts("CI_PROJECT_ID not set, skipping failed jobs table"))
+    pipeline_id = ENV['CI_PIPELINE_ID']&.to_i || (next puts("CI_PIPELINE_ID not set, skipping failed jobs table"))
+
+    jobs = GitlabQuality::TestTooling::GitlabClient::FailedJobs.new(token: gitlab_api_token, project_id: project_id, pipeline_id: pipeline_id).fetch
+    next if jobs.empty?
+
+    messages << GitlabQuality::TestTooling::FailedJobsTable.create(jobs: jobs)
+  rescue StandardError => e
+    puts "Failed to fetch failed jobs. #{e.class}: #{e.message}"
   end
 
   opts.on('-u', '--username USERNAME', String, 'Username to use for the Slack message') do |username|
@@ -50,6 +71,8 @@ options = OptionParser.new do |opts|
   opts.parse(ARGV)
 end
 
+params[:message] = messages.join("\n\n")
+
 if params.any?
   GitlabQuality::TestTooling::Slack::PostToSlack.new(**params).invoke!
 else

data/lib/gitlab_quality/test_tooling/failed_jobs_table.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'table_print'
+
+module GitlabQuality
+  module TestTooling
+    module FailedJobsTable
+      class << self
+        # Create table with formatted list of failed jobs
+        #
+        # @param [Array<Gitlab::ObjectifiedHash>] jobs
+        # @return [String]
+        def create(jobs:)
+          "```\n#{TablePrint::Printer.table_print(collect_results(jobs))}\n```\n"
+        end
+
+        private
+
+        # Format list of failed jobs
+        #
+        # @param [Array<Gitlab::ObjectifiedHash>] jobs
+        # @return [Array]
+        def collect_results(jobs)
+          jobs.sort_by(&:stage).map do |job|
+            {
+              "Job" => job.name,
+              "Stage" => job.stage,
+              "Failure Reason" => job.failure_reason
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'gitlab'
+
+module GitlabQuality
+  module TestTooling
+    module GitlabClient
+      class FailedJobs
+        def initialize(token:, project_id:, pipeline_id:)
+          @token = token
+          @project_id = project_id
+          @pipeline_id = pipeline_id
+        end
+
+        def fetch
+          client.pipeline_jobs(project_id, pipeline_id, scope: 'failed')
+        end
+
+        private
+
+        attr_reader :token, :project_id, :pipeline_id
+
+        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/report/relate_failure_issue.rb

@@ -167,9 +167,7 @@ module GitlabQuality
         def pipeline_issues_with_similar_stacktrace(test)
           search_labels = (base_issue_labels + Set.new(%w[test failure::new])).to_a
           not_labels = exclude_labels_for_search.to_a
-          gitlab.find_issues(options: { labels: search_labels,
-                                        not: { labels: not_labels },
-                                        created_after: past_timestamp(2) }).select do |issue|
+          find_issues_created_after(past_timestamp(2), state: 'opened', labels: search_labels, not_labels: not_labels).select do |issue|
             job_url_from_issue = failed_issue_job_url(issue)
 
             next if pipeline != pipeline_env_from_job_url(job_url_from_issue)
@@ -196,6 +194,7 @@ module GitlabQuality
         def failure_issues(test)
           find_issues_for_test(
             test,
+            state: 'opened',
             labels: base_issue_labels + Set.new(%w[test]),
             not_labels: exclude_labels_for_search
           )

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

@@ -145,10 +145,19 @@ module GitlabQuality
         def find_issues_for_test(test, labels:, not_labels: Set.new, state: nil)
           search_options = { labels: labels.to_a, not: { labels: not_labels.to_a } }
           search_options[:state] = state if state
+          search_options[:search] = test.file.to_s.empty? ? test.name : partial_file_path(test.file)
+          search_options[:in] = 'title'
 
           gitlab.find_issues(options: search_options).find_all { |issue| issue_match_test?(issue, test) }
         end
 
+        def find_issues_created_after(timestamp, labels:, not_labels: Set.new, state: nil)
+          search_options = { labels: labels.to_a, not: { labels: not_labels.to_a }, created_after: timestamp }
+          search_options[:state] = state if state
+
+          gitlab.find_issues(options: search_options)
+        end
+
         def issue_match_test?(issue, test)
           issue_title = issue.title.strip
           test_file_path_found = !test.file.to_s.empty? && issue_title.include?(partial_file_path(test.file))

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

@@ -65,10 +65,18 @@ module GitlabQuality
           "1. #{Time.new.utc.strftime('%F')}: #{test.ci_job_url} (#{ENV.fetch('CI_PIPELINE_URL', 'pipeline url is missing')})"
         end
 
+        def slow_test_issues(test)
+          find_issues_for_test(
+            test,
+            state: 'opened',
+            labels: SEARCH_LABELS
+          )
+        end
+
         def create_slow_issue(test)
           puts "   => Finding existing issues for slow test '#{test.name}' (run time: #{test.run_time} seconds)..."
 
-          issues = find_issues_for_test(test, labels: SEARCH_LABELS, state: 'opened')
+          issues = slow_test_issues(test)
 
           if issues.blank?
             issues << create_issue(test)

data/lib/gitlab_quality/test_tooling/version.rb

@@ -2,6 +2,6 @@
 
 module GitlabQuality
   module TestTooling
-    VERSION = "1.8.0"
+    VERSION = "1.9.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_quality-test_tooling
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-11-30 00:00:00.000000000 Z
+date: 2023-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -383,6 +383,8 @@ files:
 - exe/update-screenshot-paths
 - lefthook.yml
 - lib/gitlab_quality/test_tooling.rb
+- lib/gitlab_quality/test_tooling/failed_jobs_table.rb
+- lib/gitlab_quality/test_tooling/gitlab_client/failed_jobs.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