gitlab_quality-test_tooling 0.1.0 → 0.2.1

data/lib/gitlab_quality/test_tooling/system_logs/finders/json_log_finder.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module GitlabQuality
+  module TestTooling
+    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_quality/test_tooling/system_logs/finders/rails/api_log_finder.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    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_quality/test_tooling/system_logs/finders/rails/application_log_finder.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    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_quality/test_tooling/system_logs/finders/rails/exception_log_finder.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    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_quality/test_tooling/system_logs/finders/rails/graphql_log_finder.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    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_quality/test_tooling/system_logs/log_types/log.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    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_quality/test_tooling/system_logs/log_types/rails/api_log.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    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_quality/test_tooling/system_logs/log_types/rails/application_log.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    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_quality/test_tooling/system_logs/log_types/rails/exception_log.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    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_quality/test_tooling/system_logs/log_types/rails/graphql_log.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    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_quality/test_tooling/system_logs/shared_fields.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    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_quality/test_tooling/system_logs/system_logs_formatter.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    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_quality/test_tooling/test_results/base_test_results.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    module TestResults
+      class BaseTestResults
+        include Enumerable
+
+        attr_reader :path
+
+        def initialize(path)
+          @path = path
+          @results = parse
+          @testcases = process
+        end
+
+        def each(&block)
+          testcases.each(&block)
+        end
+
+        def write
+          raise NotImplementedError
+        end
+
+        private
+
+        attr_reader :results, :testcases
+
+        def parse
+          raise NotImplementedError
+        end
+
+        def process
+          raise NotImplementedError
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module GitlabQuality
+  module TestTooling
+    module TestResults
+      class Builder
+        def initialize(file_glob)
+          @file_glob = file_glob
+        end
+
+        def test_results_per_file
+          Dir.glob(file_glob).each do |path|
+            extension = File.extname(path)
+
+            test_results =
+              case extension
+              when '.json'
+                TestResults::JsonTestResults.new(path)
+              when '.xml'
+                TestResults::JUnitTestResults.new(path)
+              else
+                raise "Unknown extension #{extension}"
+              end
+
+            yield test_results
+          end
+        end
+
+        private
+
+        attr_reader :file_glob
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'nokogiri'
+
+module GitlabQuality
+  module TestTooling
+    module TestResults
+      class JUnitTestResults < BaseTestResults
+        def write
+          # Ignore it for now
+        end
+
+        private
+
+        def parse
+          Nokogiri::XML.parse(File.read(path))
+        end
+
+        def process
+          results.xpath('//testcase').map do |test|
+            TestResult.from_junit(test)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'json'
+
+module GitlabQuality
+  module TestTooling
+    module TestResults
+      class JsonTestResults < BaseTestResults
+        def write
+          json = results.merge('examples' => testcases.map(&:report))
+
+          File.write(path, JSON.pretty_generate(json))
+        end
+
+        private
+
+        def parse
+          JSON.parse(File.read(path))
+        end
+
+        def process
+          results['examples'].map do |test|
+            TestResult.from_json(test)
+          end
+        end
+      end
+    end
+  end
+end