gitlab-qa 6.2.0 → 6.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20da7f808929fe216ed49cefd35aeeab33c0e0a2c35517aa5ef15569271e2d17
-  data.tar.gz: d87695289a8d8f13f4c9baa5547a46e45f4777e07adcbfc78570f4f35a0db71f
+  metadata.gz: 5c99ceb7cdd5d4c53dabf353157bbaf334c7c67febb2afc93620e8bca0fe3774
+  data.tar.gz: a0d26ee7c892402f37cb9bc0e311f649687878fb088bca8c881ce64a5a0bcd54
 SHA512:
-  metadata.gz: ba356e43063cf62c035364bf6e929d2545d4ad9d6042159cf68b58cce15af7099843ab556622076b705fa5f633d7defc3158cbdaaa948fd2014e79eb5bfbe290
-  data.tar.gz: ea5048047d6c5816e0401d0bf104757be344145740063255581fbbadc27c69334ad737a23b81049ede31f488f3f13858411a1126ca07b3ee14c6a87ad8e9b030
+  metadata.gz: 6984d1bcbfb7939d2b806f9857b6403db776458eba0c89ee719be35f563b4a96076a80ca2cf8bb765e4eccf819e7554343c59b08c702d8d45d4d0c85bcde618c
+  data.tar.gz: 4c44818ae663d2eece632825d8efd12535312f71a98e7211ab8b431b8dec5d8561d339a1b69e3884797f3324cb049b64164da4be4c0064c329de600cf731d020

data/lib/gitlab/qa.rb

@@ -97,9 +97,11 @@ module Gitlab
     end
 
     module Report
+      autoload :GitlabIssueClient, 'gitlab/qa/report/gitlab_issue_client'
       autoload :JsonTestResults, 'gitlab/qa/report/json_test_results'
       autoload :JUnitTestResults, 'gitlab/qa/report/junit_test_results'
       autoload :PrepareStageReports, 'gitlab/qa/report/prepare_stage_reports'
+      autoload :ReportAsIssue, 'gitlab/qa/report/report_as_issue'
       autoload :ResultsInIssues, 'gitlab/qa/report/results_in_issues'
       autoload :SummaryTable, 'gitlab/qa/report/summary_table'
       autoload :TestResult, 'gitlab/qa/report/test_result'

data/lib/gitlab/qa/component/specs.rb

@@ -23,6 +23,8 @@ module Gitlab
 
           @docker.login(**release.login_params) if release.login_params
 
+          @docker.pull(release.qa_image, release.qa_tag) unless Runtime::Env.skip_pull?
+
           puts "Running test suite `#{suite}` for #{release.project_name}"
 
           name = "#{release.project_name}-qa-#{SecureRandom.hex(4)}"

data/lib/gitlab/qa/report/gitlab_issue_client.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+require 'gitlab'
+
+module Gitlab
+  # Monkey patch the Gitlab client to use the correct API path and add required methods
+  class Client
+    def team_member(project, id)
+      get("/projects/#{url_encode(project)}/members/all/#{id}")
+    end
+
+    def issue_discussions(project, issue_id, options = {})
+      get("/projects/#{url_encode(project)}/issues/#{issue_id}/discussions", query: options)
+    end
+
+    def add_note_to_issue_discussion_as_thread(project, issue_id, discussion_id, options = {})
+      post("/projects/#{url_encode(project)}/issues/#{issue_id}/discussions/#{discussion_id}/notes", query: options)
+    end
+  end
+
+  module QA
+    module Report
+      # The GitLab client is used for API access: https://github.com/NARKOZ/gitlab
+      class GitlabIssueClient
+        MAINTAINER_ACCESS_LEVEL = 40
+        RETRY_BACK_OFF_DELAY = 60
+        MAX_RETRY_ATTEMPTS = 3
+
+        def initialize(token:, project:)
+          @token = token
+          @project = project
+          @retry_backoff = 0
+
+          configure_gitlab_client
+        end
+
+        def assert_user_permission!
+          handle_gitlab_client_exceptions do
+            user = Gitlab.user
+            member = Gitlab.team_member(project, user.id)
+
+            abort_not_permitted if member.access_level < MAINTAINER_ACCESS_LEVEL
+          end
+        rescue Gitlab::Error::NotFound
+          abort_not_permitted
+        end
+
+        def find_issues(iid:, options: {}, &select)
+          select ||= :itself
+
+          handle_gitlab_client_exceptions do
+            return [Gitlab.issue(project, iid)] if iid
+
+            Gitlab.issues(project, options)
+              .auto_paginate
+              .select(&select)
+          end
+        end
+
+        def create_issue(title:, description:, labels:)
+          puts "Creating issue..."
+
+          handle_gitlab_client_exceptions do
+            Gitlab.create_issue(
+              project,
+              title,
+              { description: description, labels: labels }
+            )
+          end
+        end
+
+        def edit_issue(iid:, options: {})
+          handle_gitlab_client_exceptions do
+            Gitlab.edit_issue(project, iid, options)
+          end
+        end
+
+        def handle_gitlab_client_exceptions
+          yield
+        rescue Gitlab::Error::NotFound
+          # This error could be raised in assert_user_permission!
+          # If so, we want it to terminate at that point
+          raise
+        rescue SystemCallError, OpenSSL::SSL::SSLError, Net::OpenTimeout, Net::ReadTimeout, Gitlab::Error::InternalServerError, Gitlab::Error::Parsing => e
+          @retry_backoff += RETRY_BACK_OFF_DELAY
+
+          raise if @retry_backoff > RETRY_BACK_OFF_DELAY * MAX_RETRY_ATTEMPTS
+
+          warn_exception(e)
+          warn("Sleeping for #{@retry_backoff} seconds before retrying...")
+          sleep @retry_backoff
+
+          retry
+        rescue StandardError => e
+          pipeline = QA::Runtime::Env.pipeline_from_project_name
+          channel = pipeline == "canary" ? "qa-production" : "qa-#{pipeline}"
+          error_msg = warn_exception(e)
+          slack_options = {
+            channel: channel,
+            icon_emoji: ':ci_failing:',
+            message: <<~MSG
+              An unexpected error occurred while reporting test results in issues.
+              The error occurred in job: #{QA::Runtime::Env.ci_job_url}
+              `#{error_msg}`
+            MSG
+          }
+          puts "Posting Slack message to channel: #{channel}"
+
+          Gitlab::QA::Slack::PostToSlack.new(**slack_options).invoke!
+        end
+
+        private
+
+        attr_reader :token, :project
+
+        def configure_gitlab_client
+          Gitlab.configure do |config|
+            config.endpoint = Runtime::Env.gitlab_api_base
+            config.private_token = token
+          end
+        end
+
+        def abort_not_permitted
+          abort "You must have at least Maintainer access to the project to use this feature."
+        end
+
+        def warn_exception(error)
+          error_msg = "#{error.class.name} #{error.message}"
+          warn(error_msg)
+          error_msg
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/qa/report/report_as_issue.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module QA
+    module Report
+      class ReportAsIssue
+        def initialize(token:, input_files:, project: nil)
+          @gitlab = GitlabIssueClient.new(token: token, project: project)
+          @files = Array(input_files)
+          @project = project
+        end
+
+        def invoke!
+          validate_input!
+
+          run!
+        end
+
+        private
+
+        attr_reader :gitlab, :files, :project
+
+        def run!
+          raise NotImplementedError
+        end
+
+        def validate_input!
+          assert_project!
+          assert_input_files!(files)
+          gitlab.assert_user_permission!
+        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/qa/report/results_in_issues.rb

@@ -1,47 +1,18 @@
 # frozen_string_literal: true
 
 require 'nokogiri'
-require 'gitlab'
 require 'active_support/core_ext/enumerable'
 
 module Gitlab
-  # Monkey patch the Gitlab client to use the correct API path and add required methods
-  class Client
-    def team_member(project, id)
-      get("/projects/#{url_encode(project)}/members/all/#{id}")
-    end
-
-    def issue_discussions(project, issue_id, options = {})
-      get("/projects/#{url_encode(project)}/issues/#{issue_id}/discussions", query: options)
-    end
-
-    def add_note_to_issue_discussion_as_thread(project, issue_id, discussion_id, options = {})
-      post("/projects/#{url_encode(project)}/issues/#{issue_id}/discussions/#{discussion_id}/notes", query: options)
-    end
-  end
-
   module QA
     module Report
       # Uses the API to create or update GitLab issues with the results of tests from RSpec report files.
-      # The GitLab client is used for API access: https://github.com/NARKOZ/gitlab
-      class ResultsInIssues
-        MAINTAINER_ACCESS_LEVEL = 40
+      class ResultsInIssues < ReportAsIssue
         MAX_TITLE_LENGTH = 255
-        RETRY_BACK_OFF_DELAY = 60
-        MAX_RETRY_ATTEMPTS = 3
-
-        def initialize(token:, input_files:, project: nil)
-          @token = token
-          @files = Array(input_files)
-          @project = project
-          @retry_backoff = 0
-        end
-
-        def invoke!
-          configure_gitlab_client
 
-          validate_input!
+        private
 
+        def run!
           puts "Reporting test results in `#{files.join(',')}` as issues in project `#{project}` via the API at `#{Runtime::Env.gitlab_api_base}`."
 
           Dir.glob(files).each do |file|
@@ -63,58 +34,13 @@ module Gitlab
           end
         end
 
-        private
-
-        attr_reader :files, :token, :project
-
-        def validate_input!
-          assert_project!
-          assert_input_files!(files)
-          assert_user_permission!
-        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
-
-        def assert_user_permission!
-          handle_gitlab_client_exceptions do
-            user = Gitlab.user
-            member = Gitlab.team_member(project, user.id)
-
-            abort_not_permitted if member.access_level < MAINTAINER_ACCESS_LEVEL
-          end
-        rescue Gitlab::Error::NotFound
-          abort_not_permitted
-        end
-
-        def abort_not_permitted
-          abort "You must have at least Maintainer access to the project to use this feature."
-        end
-
-        def configure_gitlab_client
-          handle_gitlab_client_exceptions do
-            Gitlab.configure do |config|
-              config.endpoint = Runtime::Env.gitlab_api_base
-              config.private_token = token
-            end
-          end
-        end
-
         def report_test(test)
           return if test.skipped
 
           puts "Reporting test: #{test.file} | #{test.name}"
 
           issue = find_issue(test)
+
           if issue
             puts "Found existing issue: #{issue.web_url}"
           else
@@ -128,36 +54,30 @@ module Gitlab
           puts "Issue updated"
         end
 
-        def create_issue(test)
-          puts "Creating issue..."
-
-          handle_gitlab_client_exceptions do
-            Gitlab.create_issue(
-              project,
-              title_from_test(test),
-              { description: "### Full description\n\n#{search_safe(test.name)}\n\n### File path\n\n#{test.file}", labels: 'status::automated' }
-            )
-          end
-        end
-
-        # rubocop:disable Metrics/AbcSize
         def find_issue(test)
-          handle_gitlab_client_exceptions do
-            return Gitlab.issue(project, id_from_testcase_url(test.testcase)) if test.testcase
+          title = title_from_test(test)
+          issues =
+            gitlab.find_issues(
+              iid: iid_from_testcase_url(test.testcase),
+              options: { search: search_term(test) }) do |issue|
+                issue.state == 'opened' && issue.title.strip == title
+              end
 
-            issues = Gitlab.issues(project, { search: search_term(test) })
-              .auto_paginate
-              .select { |issue| issue.state == 'opened' && issue.title.strip == title_from_test(test) }
+          warn(%(Too many issues found with the file path "#{test.file}" and name "#{test.name}")) if issues.many?
 
-            warn(%(Too many issues found with the file path "#{test.file}" and name "#{test.name}")) if issues.many?
+          issues.first
+        end
 
-            issues.first
-          end
+        def create_issue(test)
+          gitlab.create_issue(
+            title: title_from_test(test),
+            description: "### Full description\n\n#{search_safe(test.name)}\n\n### File path\n\n#{test.file}",
+            labels: 'status::automated'
+          )
         end
-        # rubocop:enable Metrics/AbcSize
 
-        def id_from_testcase_url(url)
-          url.split('/').last.to_i
+        def iid_from_testcase_url(url)
+          url && url.split('/').last.to_i
         end
 
         def search_term(test)
@@ -185,7 +105,7 @@ module Gitlab
 
           note = note_content(test)
 
-          handle_gitlab_client_exceptions do
+          gitlab.handle_gitlab_client_exceptions do
             Gitlab.issue_discussions(project, issue.iid, order_by: 'created_at', sort: 'asc').each do |discussion|
               return add_note_to_discussion(issue.iid, discussion.id) if new_note_matches_discussion?(note, discussion)
             end
@@ -241,12 +161,11 @@ module Gitlab
         end
 
         def add_note_to_discussion(issue_iid, discussion_id)
-          handle_gitlab_client_exceptions do
+          gitlab.handle_gitlab_client_exceptions do
             Gitlab.add_note_to_issue_discussion_as_thread(project, issue_iid, discussion_id, body: failure_summary)
           end
         end
 
-        # rubocop:disable Metrics/AbcSize
         def update_labels(issue, test)
           labels = issue.labels
           labels.delete_if { |label| label.start_with?("#{pipeline}::") }
@@ -254,11 +173,8 @@ module Gitlab
           labels << "Enterprise Edition" if ee_test?(test)
           quarantine_job? ? labels << "quarantine" : labels.delete("quarantine")
 
-          handle_gitlab_client_exceptions do
-            Gitlab.edit_issue(project, issue.iid, labels: labels)
-          end
+          gitlab.edit_issue(iid: issue.iid, options: { labels: labels })
         end
-        # rubocop:enable Metrics/AbcSize
 
         def ee_test?(test)
           test.file =~ %r{features/ee/(api|browser_ui)}
@@ -279,46 +195,6 @@ module Gitlab
 
           Runtime::Env.pipeline_from_project_name
         end
-
-        def handle_gitlab_client_exceptions
-          yield
-        rescue Gitlab::Error::NotFound
-          # This error could be raised in assert_user_permission!
-          # If so, we want it to terminate at that point
-          raise
-        rescue SystemCallError, OpenSSL::SSL::SSLError, Net::OpenTimeout, Net::ReadTimeout, Gitlab::Error::InternalServerError, Gitlab::Error::Parsing => e
-          @retry_backoff += RETRY_BACK_OFF_DELAY
-
-          raise if @retry_backoff > RETRY_BACK_OFF_DELAY * MAX_RETRY_ATTEMPTS
-
-          warn_exception(e)
-          warn("Sleeping for #{@retry_backoff} seconds before retrying...")
-          sleep @retry_backoff
-
-          retry
-        rescue StandardError => e
-          pipeline = QA::Runtime::Env.pipeline_from_project_name
-          channel = pipeline == "canary" ? "qa-production" : "qa-#{pipeline}"
-          error_msg = warn_exception(e)
-          slack_options = {
-            channel: channel,
-            icon_emoji: ':ci_failing:',
-            message: <<~MSG
-              An unexpected error occurred while reporting test results in issues.
-              The error occurred in job: #{QA::Runtime::Env.ci_job_url}
-              `#{error_msg}`
-            MSG
-          }
-          puts "Posting Slack message to channel: #{channel}"
-
-          Gitlab::QA::Slack::PostToSlack.new(**slack_options).invoke!
-        end
-
-        def warn_exception(error)
-          error_msg = "#{error.class.name} #{error.message}"
-          warn(error_msg)
-          error_msg
-        end
       end
     end
   end

data/lib/gitlab/qa/reporter.rb

@@ -60,34 +60,19 @@ module Gitlab
         end
 
         if args.any?
-          if report_options[:prepare_stage_reports]
-            report_options.delete(:prepare_stage_reports)
+          if report_options.delete(:prepare_stage_reports)
             Gitlab::QA::Report::PrepareStageReports.new(**report_options).invoke!
 
-            exit
-          end
-
-          if report_options[:report_in_issues]
-            report_options.delete(:report_in_issues)
+          elsif report_options.delete(:report_in_issues)
             report_options[:token] = Runtime::TokenFinder.find_token!(report_options[:token])
             Gitlab::QA::Report::ResultsInIssues.new(**report_options).invoke!
 
-            exit
-          end
-
-          if slack_options[:post_to_slack]
-            slack_options.delete(:post_to_slack)
+          elsif slack_options.delete(:post_to_slack)
             Gitlab::QA::Slack::PostToSlack.new(**slack_options).invoke!
 
-            exit
-          end
-
-          if report_options[:update_screenshot_path]
-            report_options.delete(:update_screenshot_path)
-
+          elsif report_options.delete(:update_screenshot_path)
             Gitlab::QA::Report::UpdateScreenshotPath.new(**report_options).invoke!
 
-            exit
           end
         else
           puts options

data/lib/gitlab/qa/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   module QA
-    VERSION = '6.2.0'.freeze
+    VERSION = '6.3.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-qa
 version: !ruby/object:Gem::Version
-  version: 6.2.0
+  version: 6.3.0
 platform: ruby
 authors:
 - Grzegorz Bizon
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-17 00:00:00.000000000 Z
+date: 2020-10-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -257,9 +257,11 @@ files:
 - lib/gitlab/qa/docker/shellout.rb
 - lib/gitlab/qa/docker/volumes.rb
 - lib/gitlab/qa/release.rb
+- lib/gitlab/qa/report/gitlab_issue_client.rb
 - lib/gitlab/qa/report/json_test_results.rb
 - lib/gitlab/qa/report/junit_test_results.rb
 - lib/gitlab/qa/report/prepare_stage_reports.rb
+- lib/gitlab/qa/report/report_as_issue.rb
 - lib/gitlab/qa/report/results_in_issues.rb
 - lib/gitlab/qa/report/summary_table.rb
 - lib/gitlab/qa/report/test_result.rb