gitlab-qa 7.7.3 → 7.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d85e04e5802e15ef3b529ca3706e9fa1824029447bec5921c7648bba41257ad
-  data.tar.gz: 19fd7b127dc987528d7aebafa62c82fe13a495eb6dc789bcc86ef7c535dc770a
+  metadata.gz: a57eadb5d0c8b13166ba80108c3c183299097ff4f90a39080df27216bdf1eabf
+  data.tar.gz: ff74b7e345f0c8bec66f0fe9ce0d6688375a3cd4de6fdc3dfd1db027f0e6a0fc
 SHA512:
-  metadata.gz: 33a8d10016bef96fc1b947e8d9db5671c835c714f1511a989a3c9b4c75e12bee433559140844ba7ae78c9bbba49560b0e9dee6b890765b7fb565a17a4b50b133
-  data.tar.gz: 6656512bcf01fbb980ef4cf91b64ab78a8b8c0841eda4e4fa7389059259cd96eaeccf0f8131cbfb3328b71c1842a17731f6444f3bb3b6ae17d2d14435c1b3f87
+  metadata.gz: 44fbe3b8d2f2e17a0e2614d0e55a6445751de96b7fec209f71bca58ddcaeed7105c5d8d697ea855111e9d35f4c387a4ccd6bc7260085f4d50703784f0cb07b25
+  data.tar.gz: 72ff7585e4be89bfe42f210a864b775195c0e2dc9d47da2d5bf6c54406684c02faaf6e8fda6ea7e70d3f0f080e3213b845b8866830879b6956cfb8a57146c92c

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

@@ -196,7 +196,7 @@ module Gitlab
           if testcase && !passed
             # Workaround for reducing system notes on testcase issues
             # The first regex extracts the link to the issues list page from a link to a single issue show page by removing the issue id.
-            "[#{text}](#{testcase.match(%r{[\s\S]+\/[^\/\d]+})}?state=opened&search=#{encoded_text}) (testcase_id=#{testcase.match(/\d+/)})"
+            "[#{text}](#{testcase.match(%r{[\s\S]+\/[^\/\d]+})}?state=opened&search=#{encoded_text})"
           else
             text
           end

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

@@ -49,7 +49,7 @@ module Gitlab
           select ||= :itself
 
           handle_gitlab_client_exceptions do
-            return [Gitlab.issue(project, iid)] if iid
+            return [Gitlab.issue(project, iid)].select(&select) if iid
 
             Gitlab.issues(project, options)
               .auto_paginate
@@ -63,8 +63,8 @@ module Gitlab
           end
         end
 
-        def create_issue(title:, description:, labels:)
-          attrs = { description: description, labels: labels }
+        def create_issue(title:, description:, labels:, issue_type: 'issue')
+          attrs = { issue_type: issue_type, description: description, labels: labels }
 
           handle_gitlab_client_exceptions do
             Gitlab.create_issue(project, title, attrs)

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

@@ -4,10 +4,10 @@ module Gitlab
   module QA
     module Report
       class GitlabIssueDryClient < GitlabIssueClient
-        def create_issue(title:, description:, labels:)
+        def create_issue(title:, description:, labels:, issue_type: 'issue')
           attrs = { description: description, labels: labels }
 
-          puts "The following issue would have been created:"
+          puts "The following #{issue_type} would have been created:"
           puts "project: #{project}, title: #{title}, attrs: #{attrs}"
         end
 

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

@@ -150,10 +150,10 @@ module Gitlab
         end
 
         def new_issue_labels(test)
-          NEW_ISSUE_LABELS + up_to_date_labels(test: test)
+          up_to_date_labels(test: test, new_labels: NEW_ISSUE_LABELS)
         end
 
-        def up_to_date_labels(test:, issue: nil)
+        def up_to_date_labels(test:, issue: nil, new_labels: Set.new)
           super << pipeline_name_label
         end
 

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

@@ -88,17 +88,18 @@ module Gitlab
           issue&.labels&.to_set || Set.new
         end
 
-        def update_labels(issue, test)
-          new_labels = up_to_date_labels(test: test, issue: issue)
+        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) == new_labels
+          return if issue_labels(issue) == labels
 
-          gitlab.edit_issue(iid: issue.iid, options: { labels: new_labels.to_a })
+          gitlab.edit_issue(iid: issue.iid, options: { labels: labels.to_a })
         end
 
-        def up_to_date_labels(test:, issue: nil)
+        def up_to_date_labels(test:, issue: nil, new_labels: Set.new)
           labels = issue_labels(issue)
-          labels << "Enterprise Edition" if ee_test?(test)
+          labels |= new_labels
+          ee_test?(test) ? labels << "Enterprise Edition" : labels.delete("Enterprise Edition")
           quarantine_job? ? labels << "quarantine" : labels.delete("quarantine")
 
           labels

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

@@ -10,6 +10,8 @@ module Gitlab
       class ResultsInIssues < ReportAsIssue
         private
 
+        RESULTS_SECTION_TEMPLATE = "\n\n### DO NOT EDIT BELOW THIS LINE\n\nActive and historical test results:"
+
         def run!
           puts "Reporting test results in `#{files.join(',')}` as issues in project `#{project}` via the API at `#{Runtime::Env.gitlab_api_base}`."
 
@@ -17,7 +19,7 @@ module Gitlab
             puts "Reporting tests in #{test_results.path}"
 
             test_results.each do |test|
-              report_test(test)
+              report_test(test) unless test.skipped
             end
 
             test_results.write
@@ -27,56 +29,135 @@ module Gitlab
         def report_test(test)
           puts "Reporting test: #{test.file} | #{test.name}"
 
-          issue = find_issue(test)
+          testcase = find_testcase(test) || create_testcase(test)
+          test.testcase ||= testcase.web_url.sub('/issues/', '/quality/test_cases/')
+
+          issue = find_issue_by_iid(testcase, test)
+
+          unless issue
+            puts "No valid issue link found"
+            issue = find_or_create_issue(test)
+
+            add_issue_to_testcase(testcase, issue)
+            puts "Added issue #{issue.web_url} to testcase #{testcase.web_url}"
+          end
+
+          update_labels(testcase, test)
+          update_issue(issue, test)
+        end
+
+        def find_testcase(test)
+          iid = iid_from_testcase_url(test.testcase)
+
+          testcases = search_issues(test: test, issue_type: 'test_case', iid: iid)
+
+          warn(%(Test case url "#{test.testcase}" not valid)) if iid && testcases.blank?
+
+          warn(%(Too many test cases found with the file path "#{test.file}" and name "#{test.name}")) if testcases&.many?
+
+          testcases.first
+        end
+
+        def create_testcase(test)
+          title = title_from_test(test)
+          puts "Creating test case '#{title}' ..."
+
+          gitlab.create_issue(
+            title: title,
+            description: new_testcase_description(test),
+            labels: new_issue_labels(test),
+            issue_type: 'test_case'
+          )
+        end
+
+        def iid_from_testcase_url(url)
+          return warn(%(Please update #{url} to test case url")) if url&.include?('/-/issues/')
+
+          url && url.split('/').last.to_i
+        end
+
+        def new_testcase_description(test)
+          "#{new_issue_description(test)}#{RESULTS_SECTION_TEMPLATE}"
+        end
+
+        def issue_iid_from_testcase(testcase)
+          results = testcase.description.partition(RESULTS_SECTION_TEMPLATE).last if testcase.description.include?(RESULTS_SECTION_TEMPLATE)
+
+          return puts "No issue link found" unless results
+
+          issue_iid = results.split('/').last
+
+          issue_iid&.to_i
+        end
+
+        def find_or_create_issue(test)
+          issue = find_issue(test, 'issue')
 
           if issue
             puts "Found existing issue: #{issue.web_url}"
           else
-            # Don't create new issues for skipped tests
-            return if test.skipped
-
             issue = create_issue(test)
             puts "Created new issue: #{issue.web_url}"
           end
 
-          test.testcase ||= issue.web_url
+          issue
+        end
 
-          labels_updated = update_labels(issue, test)
-          note_posted = note_status(issue, test)
+        def find_issue_by_iid(testcase, test)
+          iid = issue_iid_from_testcase(testcase)
 
-          if labels_updated || note_posted
-            puts "Issue updated."
-          else
-            puts "Test passed, no update needed."
-          end
+          return unless iid
+
+          issues = search_issues(test: test, issue_type: 'issue', iid: iid)
+
+          warn(%(Issue iid "#{iid}" not valid)) if issues.empty?
+
+          issues.first
         end
 
-        def find_issue(test)
-          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
+        def find_issue(test, issue_type)
+          issues = search_issues(test: test, issue_type: 'issue')
 
           warn(%(Too many issues found with the file path "#{test.file}" and name "#{test.name}")) if issues.many?
 
           issues.first
         end
 
+        def add_issue_to_testcase(testcase, issue)
+          results_section = testcase.description.include?(RESULTS_SECTION_TEMPLATE) ? '' : RESULTS_SECTION_TEMPLATE
+
+          gitlab.edit_issue(iid: testcase.iid, options: { description: (testcase.description + results_section + "\n\n#{issue.web_url}") })
+        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."
+          else
+            puts "Test passed, no update needed."
+          end
+        end
+
         def new_issue_labels(test)
-          %w[status::automated]
+          ['Quality', "devops::#{test.stage}", 'status::automated']
         end
 
-        def up_to_date_labels(test:, issue: nil)
+        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 iid_from_testcase_url(url)
-          url && url.split('/').last.to_i
+        def search_issues(test:, issue_type:, iid: nil)
+          gitlab.find_issues(iid: iid, options: { search: search_term(test) }) do |issue|
+            issue.state == 'opened' && issue.issue_type == issue_type && issue.title.strip == title_from_test(test)
+          end
         end
 
         def search_term(test)

data/lib/gitlab/qa/reporter.rb

@@ -87,10 +87,8 @@ module Gitlab
             Gitlab::QA::Report::RelateFailureIssue.new(**report_options).invoke!
 
           elsif report_options.delete(:report_in_issues)
-            # Temporarily disable reporting while we switch to more efficient use of test cases and issues.
-            # report_options[:token] = Runtime::TokenFinder.find_token!(report_options[:token])
-            # Gitlab::QA::Report::ResultsInIssues.new(**report_options).invoke!
-            puts "Reporting temporarily disabled. See https://gitlab.com/gitlab-org/gitlab-qa/-/issues/639"
+            report_options[:token] = Runtime::TokenFinder.find_token!(report_options[:token])
+            Gitlab::QA::Report::ResultsInIssues.new(**report_options).invoke!
 
           elsif report_options.delete(:generate_test_session)
             report_options[:token] = Runtime::TokenFinder.find_token!(report_options[:token])

data/lib/gitlab/qa/version.rb

@@ -1,5 +1,5 @@
 module Gitlab
   module QA
-    VERSION = '7.7.3'.freeze
+    VERSION = '7.8.0'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-qa
 version: !ruby/object:Gem::Version
-  version: 7.7.3
+  version: 7.8.0
 platform: ruby
 authors:
 - GitLab Quality