gitlab_quality-test_tooling 0.3.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d279ff4333f75a706c86e3eced4a8b95c7612be05b740479ea032b8c7f49a62
-  data.tar.gz: 92783c9acf4188c3dc781c097f3d25073fc70abab6c503a4c8802a06fda1cfb2
+  metadata.gz: c7119bececf62cc7d2d1aa0a025c4ee193535d74cfe62777e2e4b2ff88590687
+  data.tar.gz: 3e5a13270e9718b683d9554583a4b6b3c1d5f2a3bd5109477b51cdd931610600
 SHA512:
-  metadata.gz: 0b0a7ab6ab95bb9356ddc3a5276a1b81083fe2056d102fc284d56e9b64890dcac5e76548f85dad95823bb0d1f8ceb1dc0ef0e4cb3e30ef7aad0ca11764a27b44
-  data.tar.gz: c6b06b7040e97db27912113cab68d0161d51d311efe7ae7f5fb81b5f6ef55d7aec0a9d8df310f40f109b5a94d099e0e2be2e617a8119066f967e9efeaeb84a81
+  metadata.gz: c4cbc83f6bba83bd34ed42e619382778b5255dcc94df168d1cf0436c3b7f2d16c191ed9a6997db3d31e2cc030551a6359d30dc0ec380a8badc8e99d7373e070d
+  data.tar.gz: a87000a5dec45c065e46f836e9f1a7002d43aedf5c4eb11f59f9e69f321bad17537cc035269a7ce3adabef06e189b53cf69d46441bb7c5c245abd3b595a8df8b

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab_quality-test_tooling (0.3.0)
+    gitlab_quality-test_tooling (0.4.1)
       activesupport (~> 6.1)
       gitlab (~> 4.18.0)
       http (~> 5.0)

data/README.md

@@ -36,6 +36,8 @@ Usage: exe/generate-test-session [options]
     -t, --token TOKEN                A valid access token with `api` scope and Reporter permission in PROJECT
     -c CI_PROJECT_TOKEN,             A valid access token with `read_api` scope permission in current ENV["CI_PROJECT_ID"]
         --ci-project-token
+    -f ISSUE_URL_FILE,               Output the created test session issue URL
+        --issue-url-file
         --dry-run                    Perform a dry-run (don't create or update issues or test cases)
     -v, --version                    Show the version
     -h, --help                       Show the usage
@@ -80,7 +82,7 @@ Usage: exe/relate-failure-issue [options]
         --max-diff-ratio MAX_DIFF_RATO
                                      Max stacktrace diff ratio for QA failure issues detection
     -p, --project PROJECT            Can be an integer or a group/project string
-    -t, --token TOKEN                A valid access token with `api` scope and Reporter permission in PROJECT
+    -t, --token TOKEN                A valid access token with `api` scope and Maintainer permission in PROJECT
         --system-log-files SYSTEM_LOG_FILES
                                      Include errors from system logs in failure issues
         --dry-run                    Perform a dry-run (don't create or update issues)

data/exe/generate-test-session

@@ -27,6 +27,10 @@ options = OptionParser.new do |opts|
     params[:ci_project_token] = ci_project_token
   end
 
+  opts.on('-f', '--issue-url-file ISSUE_URL_FILE', 'Output the created test session issue URL') do |issue_url_file|
+    params[:issue_url_file] = issue_url_file
+  end
+
   opts.on('--dry-run', "Perform a dry-run (don't create or update issues or test cases)") do
     params[:dry_run] = true
   end
@@ -46,8 +50,12 @@ options = OptionParser.new do |opts|
   opts.parse(ARGV)
 end
 
+issue_url_file = params.delete(:issue_url_file)
+
 if params.any?
-  GitlabQuality::TestTooling::Report::GenerateTestSession.new(**params).invoke!
+  issue_url = GitlabQuality::TestTooling::Report::GenerateTestSession.new(**params).invoke!
+
+  File.write(issue_url_file, issue_url) if issue_url_file && issue_url
 else
   puts options
   exit 1

data/exe/relate-failure-issue

@@ -23,7 +23,7 @@ options = OptionParser.new do |opts|
     params[:project] = project
   end
 
-  opts.on('-t', '--token TOKEN', String, 'A valid access token with `api` scope and Reporter permission in PROJECT') do |token|
+  opts.on('-t', '--token TOKEN', String, 'A valid access token with `api` scope and Maintainer permission in PROJECT') do |token|
     params[:token] = token
   end
 

data/lib/gitlab_quality/test_tooling/gitlab_issue_client.rb

@@ -31,28 +31,25 @@ module GitlabQuality
         @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)
+          member = client.team_member(project, user.id)
 
-          abort_not_permitted if member.access_level < REPORTER_ACCESS_LEVEL
+          abort_not_permitted(member.access_level) if member.access_level < REPORTER_ACCESS_LEVEL
         end
       rescue Gitlab::Error::NotFound
-        abort_not_permitted
+        abort_member_not_found(user)
       end
 
       def find_issues(iid: nil, options: {}, &select)
         select ||= :itself
 
         handle_gitlab_client_exceptions do
-          break [Gitlab.issue(project, iid)].select(&select) if iid
+          break [client.issue(project, iid)].select(&select) if iid
 
-          Gitlab.issues(project, options)
+          client.issues(project, options)
             .auto_paginate
             .select(&select)
         end
@@ -60,7 +57,7 @@ module GitlabQuality
 
       def find_issue_discussions(iid:)
         handle_gitlab_client_exceptions do
-          Gitlab.issue_discussions(project, iid, order_by: 'created_at', sort: 'asc').auto_paginate
+          client.issue_discussions(project, iid, order_by: 'created_at', sort: 'asc').auto_paginate
         end
       end
 
@@ -68,50 +65,50 @@ module GitlabQuality
         attrs = { issue_type: issue_type, description: description, labels: labels }
 
         handle_gitlab_client_exceptions do
-          Gitlab.create_issue(project, title, attrs)
+          client.create_issue(project, title, attrs)
         end
       end
 
       def edit_issue(iid:, options: {})
         handle_gitlab_client_exceptions do
-          Gitlab.edit_issue(project, iid, options)
+          client.edit_issue(project, iid, options)
         end
       end
 
       def find_issue_notes(iid:)
         handle_gitlab_client_exceptions do
-          Gitlab.issue_notes(project, iid, order_by: 'created_at', sort: 'asc')&.auto_paginate
+          client.issue_notes(project, iid, order_by: 'created_at', sort: 'asc')&.auto_paginate
         end
       end
 
       def create_issue_note(iid:, note:)
         handle_gitlab_client_exceptions do
-          Gitlab.create_issue_note(project, iid, note)
+          client.create_issue_note(project, iid, note)
         end
       end
 
       def edit_issue_note(issue_iid:, note_id:, note:)
         handle_gitlab_client_exceptions do
-          Gitlab.edit_issue_note(project, issue_iid, note_id, note)
+          client.edit_issue_note(project, issue_iid, note_id, note)
         end
       end
 
       def add_note_to_issue_discussion_as_thread(iid:, discussion_id:, body:)
         handle_gitlab_client_exceptions do
-          Gitlab.add_note_to_issue_discussion_as_thread(project, iid, discussion_id, body: body)
+          client.add_note_to_issue_discussion_as_thread(project, iid, discussion_id, body: body)
         end
       end
 
       def find_user_id(username:)
         handle_gitlab_client_exceptions do
-          user = Gitlab.users(username: username)&.first
+          user = client.users(username: username)&.first
           user['id'] unless user.nil?
         end
       end
 
       def upload_file(file_fullpath:)
         ignore_gitlab_client_exceptions do
-          Gitlab.upload_file(project, file_fullpath)
+          client.upload_file(project, file_fullpath)
         end
       end
 
@@ -173,15 +170,33 @@ module GitlabQuality
 
       attr_reader :token, :project
 
-      def configure_gitlab_client
-        Gitlab.configure do |config|
-          config.endpoint = Runtime::Env.gitlab_api_base
-          config.private_token = token
+      def client
+        @client ||= Gitlab.client(
+          endpoint: Runtime::Env.gitlab_api_base,
+          private_token: token
+        )
+      end
+
+      def user
+        return @user if defined?(@user)
+
+        @user ||= begin
+          client.user
+        rescue Gitlab::Error::NotFound
+          abort_user_not_found
         end
       end
 
-      def abort_not_permitted
-        abort "You must have at least Reporter access to the project to use this feature."
+      def abort_not_permitted(access_level)
+        abort "#{user.username} must have at least Reporter access to the project '#{project}' to use this feature. Current access level: #{access_level}"
+      end
+
+      def abort_user_not_found
+        abort "User not found for given token."
+      end
+
+      def abort_member_not_found(user)
+        abort "#{user.username} must be a member of the '#{project}' project."
       end
 
       def warn_exception(error)

data/lib/gitlab_quality/test_tooling/report/concerns/results_reporter.rb

@@ -46,15 +46,28 @@ module GitlabQuality
             labels << (test.failures.empty? ? "#{pipeline}::passed" : "#{pipeline}::failed")
           end
 
-          def update_issue_title(issue, test)
+          def update_issue(issue, test)
+            update_params = {}
+
             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}'))
+            if old_title != new_title
+              update_params[:title] = new_title
+              warn(%(#{issue_type} title needs to be updated from '#{old_title}' to '#{new_title}'))
+            end
 
+            old_description = issue.description
             new_description = updated_description(issue, test)
 
-            gitlab.edit_issue(iid: issue.iid, options: { title: new_title, description: new_description })
+            if old_description != new_description
+              warn(%(#{issue_type} description needs to be updated from '#{old_description}' to '#{new_description}'))
+              update_params[:description] = new_description
+            end
+
+            return if update_params.empty?
+
+            gitlab.edit_issue(iid: issue.iid, options: update_params)
           end
 
           private

data/lib/gitlab_quality/test_tooling/report/concerns/utils.rb

@@ -7,14 +7,6 @@ module GitlabQuality
         module Utils
           MAX_TITLE_LENGTH = 255
 
-          def partial_file_path(path)
-            path.match(/((ee|api|browser_ui).*)/i)[1]
-          end
-
-          def new_issue_title(test)
-            "#{partial_file_path(test.file)} | #{search_safe(test.name)}".strip
-          end
-
           def title_from_test(test)
             title = new_issue_title(test)
 
@@ -23,6 +15,14 @@ module GitlabQuality
             "#{title[0...MAX_TITLE_LENGTH - 3]}..."
           end
 
+          def new_issue_title(test)
+            "#{partial_file_path(test.file)} | #{search_safe(test.name)}".strip
+          end
+
+          def partial_file_path(path)
+            path.match(/((ee|api|browser_ui).*)/i)[1]
+          end
+
           def search_safe(value)
             value.delete('"')
           end

data/lib/gitlab_quality/test_tooling/report/report_results.rb

@@ -24,22 +24,12 @@ module GitlabQuality
           @gitlab = testcase_project_reporter.gitlab
         end
 
-        def invoke!
-          validate_input!
-
-          run!
-        end
-
         def validate_input!
           assert_input_files!(files)
           gitlab.assert_user_permission!
         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
+        private
 
         # rubocop:disable Metrics/AbcSize
         def run!
@@ -60,9 +50,6 @@ module GitlabQuality
             test_results.write
           end
         end
-        # rubocop:enable Metrics/AbcSize
-
-        private
 
         def report_test(test)
           testcase = testcase_project_reporter.find_or_create_testcase(test)
@@ -70,13 +57,22 @@ module GitlabQuality
           # 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)
+          result_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.add_result_issue_link_to_testcase(testcase, result_issue, test) if is_new
 
           testcase_project_reporter.update_testcase(testcase, test)
-          results_issue_project_reporter.update_issue(issue, test)
+
+          labels_updated = results_issue_project_reporter.update_issue_labels(result_issue, test)
+          note_posted = results_issue_project_reporter.post_note(result_issue, test)
+
+          if labels_updated || note_posted
+            puts "Issue updated: #{result_issue.web_url}"
+          else
+            puts "Test passed, no results issue update needed."
+          end
         end
+        # rubocop:enable Metrics/AbcSize
       end
     end
   end

data/lib/gitlab_quality/test_tooling/report/results_in_issues.rb

@@ -17,9 +17,9 @@ module GitlabQuality
           is_new = false
 
           if issue
-            issue = update_issue_title(issue, test) if issue_title_needs_updating?(issue, test)
+            issue = update_issue(issue, test) if issue_title_needs_updating?(issue, test)
           else
-            puts "No valid issue link found"
+            puts "No valid issue link found."
             issue = find_or_create_results_issue(test)
             is_new = true
           end
@@ -27,18 +27,30 @@ module GitlabQuality
           [issue, is_new]
         end
 
-        def update_issue(issue, test)
+        def update_issue_labels(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)
+          update_labels(issue, test, new_labels)
+        end
 
-          if labels_updated || note_posted
-            puts "Issue updated: #{issue.web_url}"
-          else
-            puts "Test passed, no results issue update needed."
+        def post_note(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|
+            next unless new_note_matches_discussion?(note, discussion)
+
+            gitlab.add_note_to_issue_discussion_as_thread(
+              iid: issue.iid,
+              discussion_id: discussion.id,
+              body: failure_summary)
+            return true
           end
+
+          gitlab.create_issue_note(iid: issue.iid, note: note)
         end
 
         private
@@ -58,32 +70,13 @@ module GitlabQuality
         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
+          return 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|
-            if new_note_matches_discussion?(
-              note, discussion)
-              return gitlab.add_note_to_issue_discussion_as_thread(iid: issue.iid, discussion_id: discussion.id,
-                body: failure_summary)
-            end
-          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
@@ -103,7 +96,7 @@ module GitlabQuality
         end
 
         def failure_summary
-          summary = [":x: ~\"#{pipeline}::failed\""]
+          summary = [%(:x: ~"#{pipeline}::failed")]
           summary << "in job `#{Runtime::Env.ci_job_name}` in #{Runtime::Env.ci_job_url}"
           summary.join(' ')
         end

data/lib/gitlab_quality/test_tooling/report/{results_in_testcases.rb → results_in_test_cases.rb}

@@ -20,32 +20,31 @@ module GitlabQuality
           find_testcase(test) || create_issue(test)
         end
 
-        def add_issue_link_to_testcase(testcase, issue, test)
+        def add_result_issue_link_to_testcase(testcase, result_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}") })
+            options: { description: (testcase.description + results_section + "\n\n#{result_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}"
+          puts "Added results issue #{result_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)
+          puts "Labels updated for test case #{test.testcase}." if update_labels(testcase, test)
+          puts "Quarantine section updated for test case #{test.testcase}." if update_quarantine_section(testcase, test)
         end
 
         private
 
         def find_testcase(test)
-          testcase = find_testcase_by_iid(test)
+          testcase = find_testcase_by_iid(test) || find_issue(test)
+          return unless testcase
 
-          if testcase
-            testcase = update_issue_title(testcase, test) if issue_title_needs_updating?(testcase, test)
+          if testcase_needs_updating?(testcase, test)
+            update_issue(testcase, test)
           else
-            testcase = find_issue(test)
+            testcase
           end
-
-          testcase
         end
 
         def find_testcase_by_iid(test)
@@ -57,7 +56,7 @@ module GitlabQuality
         end
 
         def testcase_iid_from_url(url)
-          return warn(%(\nPlease update #{url} to test case url")) if url&.include?('/-/issues/')
+          return warn(%(\nPlease update #{url} to test case url)) if url&.include?('/-/issues/')
 
           url && url.split('/').last.to_i
         end
@@ -85,12 +84,14 @@ module GitlabQuality
           "#{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))
+        def testcase_needs_updating?(testcase, test)
+          return false if %w[canary production preprod release].include?(pipeline)
+          return true if issue_title_needs_updating?(testcase, test)
+
+          !testcase.description.include?(execution_graph_section(test))
         end
 
-        def quarantine_link_needs_updating?(testcase, test)
+        def quarantine_section_needs_updating?(testcase, test)
           if test.quarantine? && test.quarantine_issue
             return false if testcase.description.include?(test.quarantine_issue)
           else
@@ -100,8 +101,8 @@ module GitlabQuality
           true
         end
 
-        def update_quarantine_link(testcase, test)
-          return unless quarantine_link_needs_updating?(testcase, test)
+        def update_quarantine_section(testcase, test)
+          return unless quarantine_section_needs_updating?(testcase, test)
 
           new_description = updated_description(testcase, test)
 

data/lib/gitlab_quality/test_tooling/version.rb

@@ -2,6 +2,6 @@
 
 module GitlabQuality
   module TestTooling
-    VERSION = "0.3.0"
+    VERSION = "0.4.1"
   end
 end

data/lib/gitlab_quality/test_tooling.rb

@@ -10,10 +10,6 @@ module GitlabQuality
     loader.push_dir("#{__dir__}/test_tooling", namespace: GitlabQuality::TestTooling)
     loader.ignore("#{__dir__}/test_tooling/version.rb")
 
-    loader.inflector.inflect(
-      'results_in_testcases' => 'ResultsInTestCases'
-    )
-
     loader.setup
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_quality-test_tooling
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.1
 platform: ruby
 authors:
 - GitLab Quality
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-11 00:00:00.000000000 Z
+date: 2023-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -353,7 +353,7 @@ files:
 - lib/gitlab_quality/test_tooling/report/report_as_issue.rb
 - lib/gitlab_quality/test_tooling/report/report_results.rb
 - lib/gitlab_quality/test_tooling/report/results_in_issues.rb
-- lib/gitlab_quality/test_tooling/report/results_in_testcases.rb
+- lib/gitlab_quality/test_tooling/report/results_in_test_cases.rb
 - lib/gitlab_quality/test_tooling/report/update_screenshot_path.rb
 - lib/gitlab_quality/test_tooling/runtime/env.rb
 - lib/gitlab_quality/test_tooling/runtime/logger.rb