gitlab_quality-test_tooling 0.1.0 → 0.2.0

data/lib/gitlab_quality/test_tooling/test_results/test_result.rb

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/object/blank'
+
+module GitlabQuality
+  module TestTooling
+    module TestResults
+      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'].delete_prefix('./')
+          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'].delete_prefix('./')
+          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_quality/test_tooling/version.rb

@@ -2,6 +2,6 @@
 
 module GitlabQuality
   module TestTooling
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/lib/gitlab_quality/test_tooling.rb

@@ -1,10 +1,19 @@
 # frozen_string_literal: true
 
-require_relative "test_tooling/version"
+require 'rainbow/refinement'
+require 'zeitwerk'
 
 module GitlabQuality
   module TestTooling
     Error = Class.new(StandardError)
-    # Your code goes here...
+    loader = Zeitwerk::Loader.new
+    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.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-05-04 00:00:00.000000000 Z
+date: 2023-05-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -311,7 +311,13 @@ dependencies:
 description: A collection of test-related tools.
 email:
 - quality@gitlab.com
-executables: []
+executables:
+- generate-test-session
+- post-to-slack
+- prepare-stage-reports
+- relate-failure-issue
+- report-results
+- update-screenshot-paths
 extensions: []
 extra_rdoc_files: []
 files:
@@ -328,8 +334,50 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- exe/generate-test-session
+- exe/post-to-slack
+- exe/prepare-stage-reports
+- exe/relate-failure-issue
+- exe/report-results
+- exe/update-screenshot-paths
 - lefthook.yml
 - lib/gitlab_quality/test_tooling.rb
+- lib/gitlab_quality/test_tooling/gitlab_issue_client.rb
+- lib/gitlab_quality/test_tooling/gitlab_issue_dry_client.rb
+- lib/gitlab_quality/test_tooling/report/concerns/find_set_dri.rb
+- lib/gitlab_quality/test_tooling/report/concerns/results_reporter.rb
+- lib/gitlab_quality/test_tooling/report/concerns/utils.rb
+- lib/gitlab_quality/test_tooling/report/generate_test_session.rb
+- lib/gitlab_quality/test_tooling/report/prepare_stage_reports.rb
+- lib/gitlab_quality/test_tooling/report/relate_failure_issue.rb
+- 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/update_screenshot_path.rb
+- lib/gitlab_quality/test_tooling/runtime/env.rb
+- lib/gitlab_quality/test_tooling/runtime/logger.rb
+- lib/gitlab_quality/test_tooling/runtime/token_finder.rb
+- lib/gitlab_quality/test_tooling/slack/post_to_slack.rb
+- lib/gitlab_quality/test_tooling/summary_table.rb
+- lib/gitlab_quality/test_tooling/support/http_request.rb
+- lib/gitlab_quality/test_tooling/system_logs/finders/json_log_finder.rb
+- lib/gitlab_quality/test_tooling/system_logs/finders/rails/api_log_finder.rb
+- lib/gitlab_quality/test_tooling/system_logs/finders/rails/application_log_finder.rb
+- lib/gitlab_quality/test_tooling/system_logs/finders/rails/exception_log_finder.rb
+- lib/gitlab_quality/test_tooling/system_logs/finders/rails/graphql_log_finder.rb
+- lib/gitlab_quality/test_tooling/system_logs/log_types/log.rb
+- lib/gitlab_quality/test_tooling/system_logs/log_types/rails/api_log.rb
+- lib/gitlab_quality/test_tooling/system_logs/log_types/rails/application_log.rb
+- lib/gitlab_quality/test_tooling/system_logs/log_types/rails/exception_log.rb
+- lib/gitlab_quality/test_tooling/system_logs/log_types/rails/graphql_log.rb
+- lib/gitlab_quality/test_tooling/system_logs/shared_fields.rb
+- lib/gitlab_quality/test_tooling/system_logs/system_logs_formatter.rb
+- lib/gitlab_quality/test_tooling/test_results/base_test_results.rb
+- lib/gitlab_quality/test_tooling/test_results/builder.rb
+- lib/gitlab_quality/test_tooling/test_results/j_unit_test_results.rb
+- lib/gitlab_quality/test_tooling/test_results/json_test_results.rb
+- lib/gitlab_quality/test_tooling/test_results/test_result.rb
 - lib/gitlab_quality/test_tooling/version.rb
 - sig/gitlab_quality/test_tooling.rbs
 homepage: https://gitlab.com/gitlab-org/ruby/gems/gitlab_quality-test_tooling