gitlab-qa 10.0.0 → 10.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14c426ca85861845164d12c2bfe65ba51aeb3791d383920ce872b9066f7d50ca
-  data.tar.gz: 33e80bd2dd23bc1949018fe46f70bb892fecf0a9789f0365e0ccef6c01334267
+  metadata.gz: d3d71c9b26ee6da1b637bd155fc3dca98e47f739435802737110b8c76273068f
+  data.tar.gz: 4ede3accf59fadf7ba32c05cb49e0ba53eb3e9c809aa4c0978edb650e04ae529
 SHA512:
-  metadata.gz: 560b02f9b0a4321cb1b7be3c1e482f73a306b4c171bcc0bff4c6527fdd9fdabd68fb33ee042a4033cd047f3a23e8e5d84ae8017936ed6885cfd1de0c0c3eb646
-  data.tar.gz: 149bfc867c9913c3af4865964e12ba21d96509eaf0d4c1feb2bcf8c19c3d7da1933a68fa790bb41724ae824f4090f818d4240d5562a532e1fd2461a50138d21c
+  metadata.gz: 70441f243143e6d241f91729d1f35ba1d1668438bbd61bfe534e616e501c989af6382606986fdf593043d2a70a7e7dd59c9d7af5ccf52f93245b29a32dcf2bb7
+  data.tar.gz: 00ecb2e2599f15295e57bfda8313b9312e780693ddc9015b344a21f25d7b0ece878789e9ee6772825617abe8ae7d262429082fe7884cc4c8e8f07ff99a5a6018

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab-qa (10.0.0)
+    gitlab-qa (10.1.0)
       activesupport (~> 6.1)
       gitlab (~> 4.18.0)
       http (~> 5.0)

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

@@ -23,8 +23,9 @@ module Gitlab
 
         MultipleIssuesFound = Class.new(StandardError)
 
-        def initialize(max_diff_ratio: DEFAULT_MAX_DIFF_RATIO_FOR_DETECTION, **kwargs)
+        def initialize(system_logs: [], max_diff_ratio: DEFAULT_MAX_DIFF_RATIO_FOR_DETECTION, **kwargs)
           super
+          @system_logs = Dir.glob(system_logs)
           @max_diff_ratio = max_diff_ratio.to_f
           @issue_type = 'issue'
           @commented_issue_list = Set.new
@@ -217,7 +218,7 @@ module Gitlab
           stacktrace_match = stacktrace.match(regex)
 
           if stacktrace_match
-            stacktrace_match[:stacktrace].gsub(/^\s*#.*$/, '').gsub(/^[[:space:]]+/, '').strip
+            stacktrace_match[:stacktrace].split('First happened in')[0].gsub(/^\s*#.*$/, '').gsub(/^[[:space:]]+/, '').strip
           else
             puts "  => [DEBUG] Stacktrace doesn't match the expected regex (#{regex}):\n----------------\n#{stacktrace}\n----------------\n"
           end
@@ -252,10 +253,27 @@ module Gitlab
             "```\n#{full_stacktrace(test)}\n```",
             "First happened in #{test.ci_job_url}.",
             "Related test case: #{test.testcase}.",
-            screenshot_section(test)
+            screenshot_section(test),
+            system_log_errors_section(test)
           ].join("\n\n")
         end
 
+        def system_log_errors_section(test)
+          correlation_id = test.failures.first['correlation_id']
+          section = ''
+
+          if @system_logs.any? && !correlation_id.nil?
+            section = SystemLogs::SystemLogsFormatter.new(
+              @system_logs,
+              correlation_id
+            ).system_logs_summary_markdown
+          end
+
+          puts "  => No system logs or correlation id provided, skipping this section in issue description" if section.empty?
+
+          section
+        end
+
         def new_issue_labels(test)
           up_to_date_labels(test: test, new_labels: NEW_ISSUE_LABELS)
         end

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

@@ -128,7 +128,8 @@ module Gitlab
               {
                 '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")}"
+                '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

data/lib/gitlab/qa/reporter.rb

@@ -7,6 +7,7 @@ module Gitlab
     class Reporter
       # rubocop:disable Metrics/AbcSize
       # rubocop:disable Metrics/PerceivedComplexity
+      # rubocop:disable Metrics/CyclomaticComplexity
       def self.invoke(args)
         report_options = {}
         slack_options = {}
@@ -65,6 +66,12 @@ module Gitlab
             slack_options[:message] = slack_options[:message] + "\n\n" + Gitlab::QA::Report::SummaryTable.create(input_files: files)
           end
 
+          opts.on('--include-system-log-errors FILES', String, 'Include errors from system logs in failure issues. To be used with --relate-failure-issue') do |files|
+            raise 'This option should be used with --relate-failure-issue.' unless report_options[:relate_failure_issue]
+
+            report_options[:system_logs] = files if files
+          end
+
           opts.on('--update-screenshot-path FILES', "Update the path to screenshots to container's host") do |files|
             report_options[:update_screenshot_path] = true
             report_options[:files] = files
@@ -116,6 +123,7 @@ module Gitlab
           exit 1
         end
       end
+      # rubocop:enable Metrics/CyclomaticComplexity
       # rubocop:enable Metrics/PerceivedComplexity
       # rubocop:enable Metrics/AbcSize
     end

data/lib/gitlab/qa/system_logs/finders/json_log_finder.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module Gitlab
+  module QA
+    module SystemLogs
+      module Finders
+        class JsonLogFinder
+          def initialize(base_path, file_path)
+            @base_path = base_path
+            @file_path = file_path
+          end
+
+          def find(correlation_id)
+            log_file_path = "#{@base_path}/#{@file_path}"
+            logs = []
+
+            if File.exist?(log_file_path) && !correlation_id.nil?
+              File.foreach(log_file_path) do |line|
+                begin
+                  json_line = JSON.parse(line, symbolize_names: true)
+                rescue JSON::ParserError
+                  Runtime::Logger.debug("JsonLogFinder#find attempted to parse invalid JSON: #{line}")
+
+                  next
+                end
+
+                if (json_line[:correlation_id])&.casecmp?(correlation_id)
+                  normalized_line = normalize_keys(json_line)
+                  logs << new_log(normalized_line)
+                end
+              end
+            end
+
+            logs
+          end
+
+          def new_log(data)
+            raise 'abstract method new_log must be defined!'
+          end
+
+          private
+
+          def normalize_keys(json_line)
+            normalized_hash = {}
+
+            json_line.each_key do |old_key|
+              key_string = old_key.to_s
+
+              if key_string.include?('.')
+                normalized_key = key_string.tr('.', '_').to_sym
+                normalized_hash[normalized_key] = json_line[old_key]
+              else
+                normalized_hash[old_key] = json_line[old_key]
+              end
+            end
+
+            normalized_hash
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/qa/system_logs/finders/rails/api_log_finder.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module QA
+    module SystemLogs
+      module Finders
+        module Rails
+          class ApiLogFinder < JsonLogFinder
+            def initialize(base_path, file_path = 'gitlab-rails/api_json.log')
+              super(base_path, file_path)
+            end
+
+            def new_log(data)
+              LogTypes::Rails::ApiLog.new(data)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/qa/system_logs/finders/rails/application_log_finder.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module QA
+    module SystemLogs
+      module Finders
+        module Rails
+          class ApplicationLogFinder < JsonLogFinder
+            def initialize(base_path, file_path = 'gitlab-rails/application_json.log')
+              super(base_path, file_path)
+            end
+
+            def new_log(data)
+              LogTypes::Rails::ApplicationLog.new(data)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/qa/system_logs/finders/rails/exception_log_finder.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module QA
+    module SystemLogs
+      module Finders
+        module Rails
+          class ExceptionLogFinder < JsonLogFinder
+            def initialize(base_path, file_path = 'gitlab-rails/exceptions_json.log')
+              super(base_path, file_path)
+            end
+
+            def new_log(data)
+              LogTypes::Rails::ExceptionLog.new(data)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/qa/system_logs/finders/rails/graphql_log_finder.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module QA
+    module SystemLogs
+      module Finders
+        module Rails
+          class GraphqlLogFinder < JsonLogFinder
+            def initialize(base_path, file_path = 'gitlab-rails/graphql_json.log')
+              super(base_path, file_path)
+            end
+
+            def new_log(data)
+              LogTypes::Rails::GraphqlLog.new(data)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/qa/system_logs/log_types/log.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module QA
+    module SystemLogs
+      module LogTypes
+        class Log
+          def initialize(name, data)
+            @name = name
+            @data = data
+          end
+
+          attr_reader :name, :data
+
+          def summary_fields
+            [
+              :severity,
+              :correlation_id,
+              :time,
+              :message
+            ]
+          end
+
+          def summary
+            summary = {}
+
+            summary_fields.each do |field|
+              value = data[field]
+              summary[field] = value unless value.nil?
+            end
+
+            summary
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/qa/system_logs/log_types/rails/api_log.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module QA
+    module SystemLogs
+      module LogTypes
+        module Rails
+          class ApiLog < Log
+            include SharedFields::Exception
+            include SharedFields::Meta
+
+            def initialize(data)
+              super('Rails API', data)
+            end
+
+            def summary_fields
+              super.concat(
+                [
+                  :method,
+                  :path,
+                  :status,
+                  :params,
+                  :api_error
+                ],
+                exception_fields,
+                meta_fields
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/qa/system_logs/log_types/rails/application_log.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module QA
+    module SystemLogs
+      module LogTypes
+        module Rails
+          class ApplicationLog < Log
+            include SharedFields::Exception
+            include SharedFields::Meta
+
+            def initialize(data)
+              super('Rails Application', data)
+            end
+
+            def summary_fields
+              super.concat(
+                exception_fields,
+                meta_fields
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/qa/system_logs/log_types/rails/exception_log.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module QA
+    module SystemLogs
+      module LogTypes
+        module Rails
+          class ExceptionLog < Log
+            include SharedFields::Exception
+
+            def initialize(data)
+              super('Rails Exceptions', data)
+            end
+
+            def summary_fields
+              super.concat(exception_fields)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/qa/system_logs/log_types/rails/graphql_log.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module QA
+    module SystemLogs
+      module LogTypes
+        module Rails
+          class GraphqlLog < Log
+            include SharedFields::Meta
+
+            def initialize(data)
+              super('Rails GraphQL', data)
+            end
+
+            def summary_fields
+              super.concat(
+                [
+                  :operation_name,
+                  :query_string,
+                  :variables
+                ],
+                meta_fields
+              )
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/qa/system_logs/shared_fields.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module QA
+    module SystemLogs
+      module SharedFields
+        module Meta
+          def meta_fields
+            [
+              :meta_user,
+              :meta_project,
+              :meta_caller_id
+            ]
+          end
+        end
+
+        module Exception
+          def exception_fields
+            [
+              :exception_class,
+              :exception_message,
+              :exception_backtrace
+            ]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/qa/system_logs/system_logs_formatter.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Gitlab
+  module QA
+    module SystemLogs
+      class SystemLogsFormatter
+        NUM_OF_LOG_SECTIONS = 4
+
+        def initialize(base_paths, correlation_id)
+          @base_paths = base_paths
+          @correlation_id = correlation_id
+        end
+
+        def system_logs_summary_markdown
+          log_sections = Array.new(NUM_OF_LOG_SECTIONS) { [] }
+
+          @base_paths.each do |base_path|
+            all_logs = [
+              Finders::Rails::ApiLogFinder.new(base_path).find(@correlation_id),
+              Finders::Rails::ExceptionLogFinder.new(base_path).find(@correlation_id),
+              Finders::Rails::ApplicationLogFinder.new(base_path).find(@correlation_id),
+              Finders::Rails::GraphqlLogFinder.new(base_path).find(@correlation_id)
+            ]
+
+            create_log_summary_sections!(all_logs, log_sections)
+          end
+
+          log_sections.prepend('### System Logs') unless log_sections.all?(&:empty?)
+          log_sections.join("\n").rstrip
+        end
+
+        private
+
+        def create_log_summary_sections!(all_logs, sections)
+          sections.zip(all_logs) do |section, logs|
+            unless logs.empty?
+              section_title = "\n#### #{logs.first.name}"
+              section.append(section_title) unless section.include?(section_title)
+              section.append(create_log_summaries(logs))
+            end
+          end
+        end
+
+        def create_log_summaries(logs)
+          section = []
+
+          logs.each do |log|
+            log_summary = <<~MARKDOWN.chomp
+              <details><summary>Click to expand</summary>
+
+              ```json
+              #{JSON.pretty_generate(log.summary)}
+              ```
+              </details>
+            MARKDOWN
+
+            section.append(log_summary)
+          end
+
+          section.join("\n\n")
+        end
+      end
+    end
+  end
+end

data/lib/gitlab/qa/version.rb

@@ -2,6 +2,6 @@
 
 module Gitlab
   module QA
-    VERSION = '10.0.0'
+    VERSION = '10.1.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab-qa
 version: !ruby/object:Gem::Version
-  version: 10.0.0
+  version: 10.1.0
 platform: ruby
 authors:
 - GitLab Quality
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-04-07 00:00:00.000000000 Z
+date: 2023-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: climate_control
@@ -485,6 +485,18 @@ files:
 - lib/gitlab/qa/support/invalid_response_error.rb
 - lib/gitlab/qa/support/shell_command.rb
 - lib/gitlab/qa/support/shellout.rb
+- lib/gitlab/qa/system_logs/finders/json_log_finder.rb
+- lib/gitlab/qa/system_logs/finders/rails/api_log_finder.rb
+- lib/gitlab/qa/system_logs/finders/rails/application_log_finder.rb
+- lib/gitlab/qa/system_logs/finders/rails/exception_log_finder.rb
+- lib/gitlab/qa/system_logs/finders/rails/graphql_log_finder.rb
+- lib/gitlab/qa/system_logs/log_types/log.rb
+- lib/gitlab/qa/system_logs/log_types/rails/api_log.rb
+- lib/gitlab/qa/system_logs/log_types/rails/application_log.rb
+- lib/gitlab/qa/system_logs/log_types/rails/exception_log.rb
+- lib/gitlab/qa/system_logs/log_types/rails/graphql_log.rb
+- lib/gitlab/qa/system_logs/shared_fields.rb
+- lib/gitlab/qa/system_logs/system_logs_formatter.rb
 - lib/gitlab/qa/test_logger.rb
 - lib/gitlab/qa/version.rb
 - scripts/build-package-and-test-env