From 44d033747da39826bcf6e50adc26e7130159f90b Mon Sep 17 00:00:00 2001 From: GitLab Bot Date: Fri, 31 Mar 2023 19:27:02 +0000 Subject: Add latest changes from gitlab-org/gitlab@15-10-stable-ee --- scripts/api/create_merge_request_discussion.rb | 33 +++++++++ scripts/api/get_package_and_test_job.rb | 39 +++++++++++ .../generate-failed-package-and-test-mr-message.rb | 79 ++++++++++++++++++++++ 3 files changed, 151 insertions(+) create mode 100644 scripts/api/create_merge_request_discussion.rb create mode 100644 scripts/api/get_package_and_test_job.rb create mode 100755 scripts/generate-failed-package-and-test-mr-message.rb (limited to 'scripts') diff --git a/scripts/api/create_merge_request_discussion.rb b/scripts/api/create_merge_request_discussion.rb new file mode 100644 index 00000000000..2b380d2e216 --- /dev/null +++ b/scripts/api/create_merge_request_discussion.rb @@ -0,0 +1,33 @@ +# frozen_string_literal: true + +require 'gitlab' +require_relative 'default_options' + +class CreateMergeRequestDiscussion + def initialize(options) + @merge_request = options.fetch(:merge_request) + @project = options.fetch(:project) + + # If api_token is nil, it's set to '' to allow unauthenticated requests (for forks). + api_token = options.fetch(:api_token, '') + + warn "No API token given." if api_token.empty? + + @client = Gitlab.client( + endpoint: options.fetch(:endpoint, API::DEFAULT_OPTIONS[:endpoint]), + private_token: api_token + ) + end + + def execute(content) + client.create_merge_request_discussion( + project, + merge_request.fetch('iid'), + body: content + ) + end + + private + + attr_reader :merge_request, :client, :project +end diff --git a/scripts/api/get_package_and_test_job.rb b/scripts/api/get_package_and_test_job.rb new file mode 100644 index 00000000000..dbc29f754d0 --- /dev/null +++ b/scripts/api/get_package_and_test_job.rb @@ -0,0 +1,39 @@ +# frozen_string_literal: true + +require 'gitlab' + +require_relative 'default_options' + +class GetPackageAndTestJob + def initialize(options) + @project = options.fetch(:project) + @pipeline_id = options.fetch(:pipeline_id) + + # If api_token is nil, it's set to '' to allow unauthenticated requests (for forks). + api_token = options.fetch(:api_token, '') + + warn "No API token given." if api_token.empty? + + @client = Gitlab.client( + endpoint: options.fetch(:endpoint) || API::DEFAULT_OPTIONS[:endpoint], + private_token: api_token + ) + end + + def execute + package_and_test_job = nil + + client.pipeline_bridges(project, pipeline_id, scope: 'failed', per_page: 100).auto_paginate do |job| + if job['name'].include?('package-and-test') + package_and_test_job = job + break + end + end + + package_and_test_job + end + + private + + attr_reader :project, :pipeline_id, :exclude_allowed_to_fail_jobs, :client +end diff --git a/scripts/generate-failed-package-and-test-mr-message.rb b/scripts/generate-failed-package-and-test-mr-message.rb new file mode 100755 index 00000000000..a53b393498c --- /dev/null +++ b/scripts/generate-failed-package-and-test-mr-message.rb @@ -0,0 +1,79 @@ +#!/usr/bin/env ruby + +# frozen_string_literal: true + +require 'optparse' +require 'json' + +require_relative 'api/create_merge_request_discussion' +require_relative 'api/commit_merge_requests' +require_relative 'api/get_package_and_test_job' + +class GenerateFailedPackageAndTestMrMessage + DEFAULT_OPTIONS = { + project: nil + }.freeze + + def initialize(options) + @project = options.fetch(:project) + end + + def execute + return unless failed_package_and_test_job + + add_discussion_to_mr + end + + private + + attr_reader :project + + def add_discussion_to_mr + CreateMergeRequestDiscussion.new( + API::DEFAULT_OPTIONS.merge(merge_request: merge_request) + ).execute(content) + end + + def failed_package_and_test_job + @failed_package_and_test_job ||= GetPackageAndTestJob.new(API::DEFAULT_OPTIONS).execute + end + + def merge_request + @merge_request ||= CommitMergeRequests.new( + API::DEFAULT_OPTIONS.merge(sha: ENV['CI_MERGE_REQUEST_SOURCE_BRANCH_SHA']) + ).execute.first + end + + def content + <<~MARKDOWN + :warning: @#{author_username} The `e2e:package-and-test-ee` job has failed. + + - Pipeline: #{pipeline_link} + - `package-and-test` pipeline: #{failed_package_and_test_job['web_url']} + + Ping your team's associated Software Engineer in Test (SET) to confirm the failures are unrelated to the merge request. + If there's no SET assigned, ask for assistance on the `#quality` Slack channel. + MARKDOWN + end + + def author_username + merge_request['author']['username'] if merge_request + end + + def pipeline_link + "[##{ENV['CI_PIPELINE_ID']}](#{ENV['CI_PIPELINE_URL']})" + end +end + +if $PROGRAM_NAME == __FILE__ + options = GenerateFailedPackageAndTestMrMessage::DEFAULT_OPTIONS.dup + + OptionParser.new do |opts| + opts.on("-h", "--help", "Prints this help") do + puts opts + exit + end + end.parse! + + GenerateFailedPackageAndTestMrMessage.new(options).execute +end -- cgit v1.2.3