gitlab-qa 10.4.1 → 11.1.0

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

@@ -1,176 +0,0 @@
-# frozen_string_literal: true
-
-require 'set'
-
-module Gitlab
-  module QA
-    module Report
-      class ReportAsIssue
-        MAX_TITLE_LENGTH = 255
-
-        def initialize(token:, input_files:, project: nil, dry_run: false, **kwargs)
-          @project = project
-          @gitlab = (dry_run ? GitlabIssueDryClient : GitlabIssueClient).new(token: token, project: project)
-          @files = Array(input_files)
-        end
-
-        def invoke!
-          validate_input!
-
-          run!
-        end
-
-        private
-
-        attr_reader :gitlab, :files, :project, :issue_type
-
-        def run!
-          raise NotImplementedError
-        end
-
-        def new_issue_title(test)
-          "#{partial_file_path(test.file)} | #{search_safe(test.name)}".strip
-        end
-
-        def new_issue_description(test)
-          "### Full description\n\n#{search_safe(test.name)}\n\n### File path\n\n#{test.file}"
-        end
-
-        def new_issue_labels(test)
-          []
-        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
-
-        def test_results_per_file
-          Dir.glob(files).each do |path|
-            extension = File.extname(path)
-
-            test_results =
-              case extension
-              when '.json'
-                Report::JsonTestResults.new(path)
-              when '.xml'
-                Report::JUnitTestResults.new(path)
-              else
-                raise "Unknown extension #{extension}"
-              end
-
-            yield test_results
-          end
-        end
-
-        def create_issue(test)
-          issue = gitlab.create_issue(
-            title: title_from_test(test),
-            description: new_issue_description(test),
-            labels: new_issue_labels(test).to_a,
-            issue_type: issue_type
-          )
-
-          new_link = issue_type == 'test_case' ? issue.web_url.sub('/issues/', '/quality/test_cases/') : issue.web_url
-
-          puts "Created new #{issue_type}: #{new_link}"
-
-          issue
-        end
-
-        def issue_labels(issue)
-          issue&.labels&.to_set || Set.new
-        end
-
-        def update_labels(issue, test, new_labels = Set.new)
-          labels = up_to_date_labels(test: test, issue: issue, new_labels: new_labels)
-
-          return if issue_labels(issue) == labels
-
-          gitlab.edit_issue(iid: issue.iid, options: { labels: labels.to_a })
-        end
-
-        def up_to_date_labels(test:, issue: nil, new_labels: Set.new)
-          labels = issue_labels(issue)
-          labels |= new_labels
-          ee_test?(test) ? labels << 'Enterprise Edition' : labels.delete('Enterprise Edition')
-
-          if test.quarantine?
-            labels << 'quarantine'
-            labels << "quarantine::#{test.quarantine_type}"
-          else
-            labels.delete_if { |label| label.include?('quarantine') }
-          end
-
-          labels
-        end
-
-        def pipeline_name_label
-          case pipeline
-          when 'production'
-            'found:gitlab.com'
-          when 'canary', 'staging'
-            "found:#{pipeline}.gitlab.com"
-          when 'staging-canary'
-            "found:canary.staging.gitlab.com"
-          when 'preprod'
-            'found:pre.gitlab.com'
-          when 'nightly', QA::Runtime::Env.default_branch, 'staging-ref', 'release'
-            "found:#{pipeline}"
-          else
-            raise "No `found:*` label for the `#{pipeline}` pipeline!"
-          end
-        end
-
-        def ee_test?(test)
-          test.file =~ %r{features/ee/(api|browser_ui)}
-        end
-
-        def partial_file_path(path)
-          path.match(/((ee|api|browser_ui).*)/i)[1]
-        end
-
-        def title_from_test(test)
-          title = new_issue_title(test)
-
-          return title unless title.length > MAX_TITLE_LENGTH
-
-          "#{title[0...MAX_TITLE_LENGTH - 3]}..."
-        end
-
-        def search_safe(value)
-          value.delete('"')
-        end
-
-        def pipeline
-          # Gets the name of the pipeline the test was run in, to be used as the key of a scoped label
-          #
-          # Tests can be run in several pipelines:
-          #   gitlab, nightly, staging, canary, production, preprod, MRs, and the default branch (master/main)
-          #
-          # Some of those run in their own project, so CI_PROJECT_NAME is the name we need. Those are:
-          #   nightly, staging, canary, production, and preprod
-          #
-          # MR, master/main, and gitlab tests run in gitlab-qa, but we only want to report tests run on
-          # master/main because the other pipelines will be monitored by the author of the MR that triggered them.
-          # So we assume that we're reporting a master/main pipeline if the project name is 'gitlab'.
-
-          @pipeline ||= Runtime::Env.pipeline_from_project_name
-        end
-      end
-    end
-  end
-end

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

@@ -1,64 +0,0 @@
-# frozen_string_literal: true
-
-module Gitlab
-  module QA
-    module Report
-      # Uses the API to create or update GitLab test cases and issues with the results of tests from RSpec report files.
-      class ReportResults < ReportAsIssue
-        attr_accessor :testcase_project_reporter, :results_issue_project_reporter, :files, :test_case_project, :results_issue_project, :gitlab
-
-        def initialize(token:, input_files:, test_case_project: nil, results_issue_project: nil, dry_run: false, **kwargs)
-          @testcase_project_reporter = Gitlab::QA::Report::ResultsInTestCases.new(token: token, input_files: input_files, project: test_case_project, dry_run: dry_run, **kwargs)
-          @results_issue_project_reporter = Gitlab::QA::Report::ResultsInIssues.new(token: token, input_files: input_files, project: results_issue_project, dry_run: dry_run, **kwargs)
-          @test_case_project = test_case_project
-          @results_issue_project = results_issue_project
-          @files = Array(input_files)
-          @gitlab = testcase_project_reporter.gitlab
-        end
-
-        def assert_project!
-          return if test_case_project && results_issue_project
-
-          abort "Please provide valid project IDs or paths with the `--results-issue-project` and `--test-case-project` options!"
-        end
-
-        # rubocop:disable Metrics/AbcSize
-        def run!
-          puts "Reporting test results in `#{files.join(',')}` as test cases in project `#{test_case_project}`"\
-               " and issues in project `#{results_issue_project}` via the API at `#{Runtime::Env.gitlab_api_base}`."
-
-          test_results_per_file do |test_results|
-            puts "Reporting tests in #{test_results.path}"
-
-            test_results.each do |test|
-              next if test.file.include?('/features/sanity/') || test.skipped
-
-              puts "Reporting test: #{test.file} | #{test.name}\n"
-
-              report_test(test)
-            end
-
-            test_results.write
-          end
-        end
-        # rubocop:enable Metrics/AbcSize
-
-        private
-
-        def report_test(test)
-          testcase = testcase_project_reporter.find_or_create_testcase(test)
-          # The API returns the test case with an issue URL since it is technically a type of issue.
-          # This updates the URL to a valid test case link.
-          test.testcase = testcase.web_url.sub('/issues/', '/quality/test_cases/')
-
-          issue, is_new = results_issue_project_reporter.get_related_issue(testcase, test)
-
-          testcase_project_reporter.add_issue_link_to_testcase(testcase, issue, test) if is_new
-
-          testcase_project_reporter.update_testcase(testcase, test)
-          results_issue_project_reporter.update_issue(issue, test)
-        end
-      end
-    end
-  end
-end

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