gitlab-qa 10.6.0 → 11.0.0

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

@@ -1,126 +0,0 @@
-# frozen_string_literal: true
-
-module Gitlab
-  module QA
-    module Report
-      # Uses the API to create or update GitLab test result issues with the results of tests from RSpec report files.
-      class ResultsInIssues < ReportAsIssue
-        include ResultsReporterShared
-
-        def initialize(**kwargs)
-          super
-          @issue_type = 'issue'
-        end
-
-        def get_related_issue(testcase, test)
-          issue = find_linked_results_issue_by_iid(testcase, test)
-          is_new = false
-
-          if issue
-            issue = update_issue_title(issue, test) if issue_title_needs_updating?(issue, test)
-          else
-            puts "No valid issue link found"
-            issue = find_or_create_results_issue(test)
-            is_new = true
-          end
-
-          [issue, is_new]
-        end
-
-        def update_issue(issue, test)
-          new_labels = issue_labels(issue)
-          new_labels |= ['Testcase Linked']
-
-          labels_updated = update_labels(issue, test, new_labels)
-          note_posted = note_status(issue, test)
-
-          if labels_updated || note_posted
-            puts "Issue updated: #{issue.web_url}"
-          else
-            puts "Test passed, no results issue update needed."
-          end
-        end
-
-        private
-
-        def find_linked_results_issue_by_iid(testcase, test)
-          iid = issue_iid_from_testcase(testcase)
-
-          return unless iid
-
-          find_issue_by_iid(iid)
-        end
-
-        def find_or_create_results_issue(test)
-          find_issue(test) || create_issue(test)
-        end
-
-        def issue_iid_from_testcase(testcase)
-          results = testcase.description.partition(TEST_CASE_RESULTS_SECTION_TEMPLATE).last if testcase.description.include?(TEST_CASE_RESULTS_SECTION_TEMPLATE)
-
-          return puts "No issue link found" unless results
-
-          issue_iid = results.split('/').last
-
-          issue_iid&.to_i
-        end
-
-        def note_status(issue, test)
-          return false if test.skipped
-          return false if test.failures.empty?
-
-          note = note_content(test)
-
-          gitlab.find_issue_discussions(iid: issue.iid).each do |discussion|
-            return gitlab.add_note_to_issue_discussion_as_thread(iid: issue.iid, discussion_id: discussion.id, body: failure_summary) if new_note_matches_discussion?(note, discussion)
-          end
-
-          gitlab.create_issue_note(iid: issue.iid, note: note)
-
-          true
-        end
-
-        def note_content(test)
-          errors = test.failures.each_with_object([]) do |failure, text|
-            text << <<~TEXT
-              Error:
-              ```
-              #{failure['message']}
-              ```
-
-              Stacktrace:
-              ```
-              #{failure['stacktrace']}
-              ```
-            TEXT
-          end.join("\n\n")
-
-          "#{failure_summary}\n\n#{errors}"
-        end
-
-        def failure_summary
-          summary = [":x: ~\"#{pipeline}::failed\""]
-          summary << "in job `#{Runtime::Env.ci_job_name}` in #{Runtime::Env.ci_job_url}"
-          summary.join(' ')
-        end
-
-        def new_note_matches_discussion?(note, discussion)
-          note_error = error_and_stack_trace(note)
-          discussion_error = error_and_stack_trace(discussion.notes.first['body'])
-
-          return false if note_error.empty? || discussion_error.empty?
-
-          note_error == discussion_error
-        end
-
-        def error_and_stack_trace(text)
-          text.strip[/Error:(.*)/m, 1].to_s
-        end
-
-        def updated_description(issue, test)
-          new_issue_description(test)
-        end
-      end
-    end
-  end
-end

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

@@ -1,111 +0,0 @@
-# frozen_string_literal: true
-
-require 'erb'
-
-module Gitlab
-  module QA
-    module Report
-      # Uses the API to create or update GitLab test cases with the results of tests from RSpec report files.
-      class ResultsInTestCases < ReportAsIssue
-        attr_reader :issue_type, :gitlab
-
-        include ResultsReporterShared
-
-        def initialize(**kwargs)
-          super
-          @issue_type = 'test_case'
-        end
-
-        def find_or_create_testcase(test)
-          find_testcase(test) || create_issue(test)
-        end
-
-        def add_issue_link_to_testcase(testcase, issue, test)
-          results_section = testcase.description.include?(TEST_CASE_RESULTS_SECTION_TEMPLATE) ? '' : TEST_CASE_RESULTS_SECTION_TEMPLATE
-
-          gitlab.edit_issue(iid: testcase.iid, options: { description: (testcase.description + results_section + "\n\n#{issue.web_url}") })
-          # We are using test.testcase for the url here instead of testcase.web_url since it has the updated test case path
-          puts "Added results issue #{issue.web_url} link to test case #{test.testcase}"
-        end
-
-        def update_testcase(testcase, test)
-          puts "Test case labels updated." if update_labels(testcase, test)
-          puts "Test case quarantine section updated." if update_quarantine_link(testcase, test)
-        end
-
-        private
-
-        def find_testcase(test)
-          testcase = find_testcase_by_iid(test)
-
-          if testcase
-            testcase = update_issue_title(testcase, test) if issue_title_needs_updating?(testcase, test)
-          else
-            testcase = find_issue(test)
-          end
-
-          testcase
-        end
-
-        def find_testcase_by_iid(test)
-          iid = testcase_iid_from_url(test.testcase)
-
-          return unless iid
-
-          find_issue_by_iid(iid)
-        end
-
-        def testcase_iid_from_url(url)
-          return warn(%(\nPlease update #{url} to test case url")) if url&.include?('/-/issues/')
-
-          url && url.split('/').last.to_i
-        end
-
-        def new_issue_description(test)
-          quarantine_section = test.quarantine? && test.quarantine_issue ? "\n\n### Quarantine issue\n\n#{test.quarantine_issue}" : ''
-
-          "#{super}#{quarantine_section}\n\n#{execution_graph_section(test)}"
-        end
-
-        def execution_graph_section(test)
-          formatted_title = ERB::Util.url_encode(test.name)
-
-          <<~MKDOWN.strip
-            ### Executions
-
-            All Environments:
-            <img src="https://dashboards.quality.gitlab.net/render/d-solo/cW0UMgv7k/spec-health?orgId=1&var-run_type=All&var-name=#{formatted_title}&panelId=4&width=1000&height=500" />
-          MKDOWN
-        end
-
-        def updated_description(testcase, test)
-          historical_results_section = testcase.description.match(/### DO NOT EDIT BELOW THIS LINE[\s\S]+/)
-
-          "#{new_issue_description(test)}\n\n#{historical_results_section}"
-        end
-
-        def issue_title_needs_updating?(testcase, test)
-          super || !testcase.description.include?(execution_graph_section(test)) && !%w[canary production preprod release].include?(pipeline)
-        end
-
-        def quarantine_link_needs_updating?(testcase, test)
-          if test.quarantine? && test.quarantine_issue
-            return false if testcase.description.include?(test.quarantine_issue)
-          else
-            return false unless testcase.description.include?('Quarantine issue')
-          end
-
-          true
-        end
-
-        def update_quarantine_link(testcase, test)
-          return unless quarantine_link_needs_updating?(testcase, test)
-
-          new_description = updated_description(testcase, test)
-
-          gitlab.edit_issue(iid: testcase.iid, options: { description: new_description })
-        end
-      end
-    end
-  end
-end

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

@@ -1,70 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_support/core_ext/enumerable'
-
-module Gitlab
-  module QA
-    module Report
-      module ResultsReporterShared
-        TEST_CASE_RESULTS_SECTION_TEMPLATE = "\n\n### DO NOT EDIT BELOW THIS LINE\n\nActive and historical test results:"
-
-        def find_issue(test)
-          issues = search_for_issues(test)
-
-          warn(%(Too many #{issue_type}s found with the file path "#{test.file}" and name "#{test.name}")) if issues.many?
-          puts "Found existing #{issue_type}: #{issues.first.web_url}" unless issues.empty?
-
-          issues.first
-        end
-
-        def find_issue_by_iid(iid)
-          issues = gitlab.find_issues(iid: iid) do |issue|
-            issue.state == 'opened' && issue.issue_type == issue_type
-          end
-
-          warn(%(#{issue_type} iid "#{iid}" not valid)) if issues.empty?
-
-          issues.first
-        end
-
-        def issue_title_needs_updating?(issue, test)
-          issue.title.strip != title_from_test(test) && !%w[canary production preprod release].include?(pipeline)
-        end
-
-        def new_issue_labels(test)
-          %w[Quality status::automated]
-        end
-
-        def search_term(test)
-          %("#{partial_file_path(test.file)}" "#{search_safe(test.name)}")
-        end
-
-        def up_to_date_labels(test:, issue: nil, new_labels: Set.new)
-          labels = super
-          labels |= new_issue_labels(test).to_set
-          labels.delete_if { |label| label.start_with?("#{pipeline}::") }
-          labels << (test.failures.empty? ? "#{pipeline}::passed" : "#{pipeline}::failed")
-        end
-
-        def update_issue_title(issue, test)
-          old_title = issue.title.strip
-          new_title = title_from_test(test)
-
-          warn(%(#{issue_type} title needs to be updated from '#{old_title}' to '#{new_title}'))
-
-          new_description = updated_description(issue, test)
-
-          gitlab.edit_issue(iid: issue.iid, options: { title: new_title, description: new_description })
-        end
-
-        private
-
-        def search_for_issues(test)
-          gitlab.find_issues(options: { search: search_term(test) }) do |issue|
-            issue.state == 'opened' && issue.issue_type == issue_type && issue.title.strip == title_from_test(test)
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-require 'nokogiri'
-require 'table_print'
-
-module Gitlab
-  module QA
-    module Report
-      class SummaryTable
-        def self.create(input_files:)
-          "```\n#{TablePrint::Printer.table_print(collect_results(input_files))}```\n"
-        end
-
-        # rubocop:disable Metrics/AbcSize
-        def self.collect_results(input_files)
-          stage_wise_results = []
-
-          Dir.glob(input_files).each do |report_file|
-            stage_hash = {}
-            stage_hash["Dev Stage"] = File.basename(report_file, ".*").capitalize
-
-            report_stats = Nokogiri::XML(File.open(report_file)).children[0].attributes
-
-            stage_hash["Total"] = report_stats["tests"].value
-            stage_hash["Failures"] = report_stats["failures"].value
-            stage_hash["Errors"] = report_stats["errors"].value
-            stage_hash["Skipped"] = report_stats["skipped"].value
-            stage_hash["Result"] = result_emoji(report_stats)
-
-            stage_wise_results << stage_hash
-          end
-
-          stage_wise_results
-        end
-        # rubocop:enable Metrics/AbcSize
-
-        def self.result_emoji(report_stats)
-          report_stats["failures"].value.to_i.positive? || report_stats["errors"].value.to_i.positive? ? "❌" : "✅"
-        end
-      end
-    end
-  end
-end

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

@@ -1,184 +0,0 @@
-# frozen_string_literal: true
-
-require 'active_support/core_ext/object/blank'
-
-module Gitlab
-  module QA
-    module Report
-      class TestResult
-        def self.from_json(report)
-          JsonTestResult.new(report)
-        end
-
-        def self.from_junit(report)
-          JUnitTestResult.new(report)
-        end
-
-        attr_accessor :report, :failures
-
-        def initialize(report)
-          self.report = report
-          self.failures = failures_from_exceptions
-        end
-
-        def stage
-          @stage ||= file[%r{(?:api|browser_ui)/(?:(?:\d+_)?(\w+))}, 1]
-        end
-
-        def name
-          raise NotImplementedError
-        end
-
-        def file
-          raise NotImplementedError
-        end
-
-        def skipped
-          raise NotImplementedError
-        end
-
-        private
-
-        def failures_from_exceptions
-          raise NotImplementedError
-        end
-
-        class JsonTestResult < TestResult
-          def name
-            report['full_description']
-          end
-
-          def file
-            report['file_path']
-          end
-
-          def status
-            report['status']
-          end
-
-          def ci_job_url
-            report['ci_job_url']
-          end
-
-          def skipped
-            status == 'pending'
-          end
-
-          def testcase
-            report['testcase']
-          end
-
-          def testcase=(new_testcase)
-            report['testcase'] = new_testcase
-          end
-
-          def failure_issue
-            report['failure_issue']
-          end
-
-          def failure_issue=(new_failure_issue)
-            report['failure_issue'] = new_failure_issue
-          end
-
-          def quarantine?
-            # The value for 'quarantine' could be nil, a hash, a string,
-            # or true (if the test just has the :quarantine tag)
-            # But any non-nil or false value should means the test is in quarantine
-            report['quarantine'].present?
-          end
-
-          def quarantine_type
-            report['quarantine']['type'] if quarantine?
-          end
-
-          def quarantine_issue
-            report['quarantine']['issue'] if quarantine?
-          end
-
-          def screenshot?
-            report['screenshot'].present?
-          end
-
-          def failure_screenshot
-            report['screenshot']['image'] if screenshot?
-          end
-
-          def product_group?
-            report['product_group'].present?
-          end
-
-          def product_group
-            report['product_group'] if product_group?
-          end
-
-          private
-
-          # rubocop:disable Metrics/AbcSize
-          def failures_from_exceptions
-            return [] unless report.key?('exceptions')
-
-            report['exceptions'].map do |exception|
-              spec_file_first_index = exception['backtrace'].rindex do |line|
-                line.include?(File.basename(report['file_path']))
-              end
-
-              exception['message'].gsub!(/(private_token=)[\w-]+/, '********')
-              Array(exception['message_lines']).each { |line| line.gsub!(/(private_token=)([\w-]+)/, '********') }
-
-              {
-                'message' => "#{exception['class']}: #{exception['message']}",
-                'message_lines' => exception['message_lines'],
-                'stacktrace' => "#{format_message_lines(exception['message_lines'])}\n#{exception['backtrace'].slice(0..spec_file_first_index).join("\n")}",
-                'correlation_id' => exception['correlation_id']
-              }
-            end
-          end
-
-          def format_message_lines(message_lines)
-            message_lines.is_a?(Array) ? message_lines.join("\n") : message_lines
-          end
-          # rubocop:enable Metrics/AbcSize
-        end
-
-        class JUnitTestResult < TestResult
-          def name
-            report['name']
-          end
-
-          def file
-            report['file']
-          end
-
-          def skipped
-            report.search('skipped').any?
-          end
-
-          attr_accessor :testcase # Ignore it for now
-
-          private
-
-          # rubocop:disable Metrics/AbcSize
-          def failures_from_exceptions
-            failures = report.search('failure')
-            return [] if failures.empty?
-
-            failures.map do |exception|
-              trace = exception.content.split("\n").map(&:strip)
-              spec_file_first_index = trace.rindex do |line|
-                line.include?(File.basename(report['file']))
-              end
-
-              exception['message'].gsub!(/(private_token=)[\w-]+/, '********')
-
-              {
-                'message' => "#{exception['type']}: #{exception['message']}",
-                'stacktrace' => trace.slice(0..spec_file_first_index).join("\n")
-              }
-            end
-          end
-          # rubocop:enable Metrics/AbcSize
-        end
-      end
-    end
-  end
-end

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

@@ -1,63 +0,0 @@
-# frozen_string_literal: true
-
-require 'nokogiri'
-require 'json'
-require 'active_support/core_ext/object/blank'
-
-module Gitlab
-  module QA
-    module Report
-      class UpdateScreenshotPath
-        def initialize(files:)
-          @files = files
-        end
-
-        REGEX = %r{(?<gitlab_qa_run>gitlab-qa-run-.*?(?=\/))\/(?<gitlab_ce_ee_qa>gitlab-(ee|ce)-qa-.*?(?=\/))}
-        CONTAINER_PATH = File.join(Docker::Volumes::QA_CONTAINER_WORKDIR, 'tmp').freeze
-
-        def invoke!
-          Dir.glob(@files).each do |rspec_report_file|
-            match_data = rspec_report_file.match(REGEX)
-            artifact_path = "#{match_data[:gitlab_qa_run]}/#{match_data[:gitlab_ce_ee_qa]}"
-
-            xml_report = rewrite_each_xml_screenshot_path(rspec_report_file, artifact_path)
-
-            File.write(rspec_report_file, xml_report)
-
-            puts "Saved #{rspec_report_file}"
-
-            json_rspec_report_file = rspec_report_file.gsub('.xml', '.json')
-            json_report = rewrite_each_json_screenshot_path(json_rspec_report_file, artifact_path)
-
-            File.write(json_rspec_report_file, json_report)
-
-            puts "Saved #{json_rspec_report_file}"
-          end
-        end
-
-        private
-
-        def rewrite_each_xml_screenshot_path(rspec_report_file, artifact_path)
-          report = Nokogiri::XML(File.open(rspec_report_file))
-
-          report.xpath('//system-out').each do |system_out|
-            system_out.content = system_out.content.gsub(CONTAINER_PATH, artifact_path)
-          end
-
-          report.to_s
-        end
-
-        def rewrite_each_json_screenshot_path(json_rspec_report_file, artifact_path)
-          report = JSON.parse(File.read(json_rspec_report_file))
-          examples = report['examples']
-
-          examples.each do |example|
-            example['screenshot']['image'] = example['screenshot']['image'].gsub(CONTAINER_PATH, artifact_path) if example['screenshot'].present?
-          end
-
-          JSON.pretty_generate(report)
-        end
-      end
-    end
-  end
-end