gitlab-qa 10.6.0 → 11.0.0

data/lib/gitlab/qa/reporter.rb

@@ -1,131 +0,0 @@
-# frozen_string_literal: true
-
-require 'optparse'
-
-module Gitlab
-  module QA
-    class Reporter
-      # rubocop:disable Metrics/AbcSize
-      # rubocop:disable Metrics/PerceivedComplexity
-      # rubocop:disable Metrics/CyclomaticComplexity
-      def self.invoke(args)
-        report_options = {}
-        slack_options = {}
-
-        options = OptionParser.new do |opts|
-          opts.banner = 'Usage: gitlab-qa-reporter [options]'
-
-          opts.on('--prepare-stage-reports FILES', 'Prepare separate reports for each Stage from the provided JUnit XML files') do |files|
-            report_options[:prepare_stage_reports] = true
-            report_options[:input_files] = files if files
-          end
-
-          opts.on('--report-results FILES', String, 'Report test results from JUnit XML files in GitLab test cases and results issues') do |files|
-            report_options[:report_results] = true
-            report_options[:input_files] = files if files
-          end
-
-          opts.on('--relate-failure-issue FILES', String, 'Relate test failures to failure issues from RSpec JSON files') do |files|
-            report_options[:relate_failure_issue] = true
-            report_options[:input_files] = files if files
-          end
-
-          opts.on('--max-diff-ratio DIFF_RATO', Float, 'Max stacktrace diff ratio for QA failure issues detection. Used by with --relate-failure-issue') do |value|
-            report_options[:max_diff_ratio] = value
-          end
-
-          opts.on('-p', '--project PROJECT_ID', String, 'A valid project ID. Can be an integer or a group/project string. Required by --relate-failure-issue') do |value|
-            report_options[:project] = value
-          end
-
-          opts.on('--results-issue-project RESULTS_ISSUE_PROJECT_ID', String, 'A valid project ID. Can be an integer or a group/project string. Required by --report-results') do |value|
-            report_options[:results_issue_project] = value
-          end
-
-          opts.on('--test-case-project TEST_CASE_PROJECT_ID', String, 'A valid project ID. Can be an integer or a group/project string. Required by --report-results') do |value|
-            report_options[:test_case_project] = value
-          end
-
-          opts.on('--generate-test-session FILES', String, 'Generate test session report') do |files|
-            report_options[:generate_test_session] = true
-            report_options[:input_files] = files if files
-          end
-
-          opts.on('-t', '--token ACCESS_TOKEN', String, 'A valid access token. Required by --report-results and --relate-failure-issue') do |value|
-            report_options[:token] = value
-          end
-
-          opts.on('--post-to-slack MSG', 'Post message to slack') do |msg|
-            slack_options[:post_to_slack] = true
-            slack_options[:message] = msg
-          end
-
-          opts.on('--include-summary-table FILES', 'Create a results summary table to post to slack. To be used with --post-to-slack.') do |files|
-            raise 'This option should be used with --post-to-slack.' unless slack_options[:post_to_slack]
-
-            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
-          end
-
-          opts.on('--dry-run', "Perform a dry-run (don't create or update issues or test cases)") do |files|
-            report_options[:dry_run] = true
-          end
-
-          opts.on_tail('-v', '--version', 'Show the version') do
-            require 'gitlab/qa/version'
-            puts "#{$PROGRAM_NAME} : #{VERSION}"
-            exit
-          end
-
-          opts.on_tail('-h', '--help', 'Show the usage') do
-            puts opts
-            exit
-          end
-
-          opts.parse(args)
-        end
-
-        if args.any?
-          if report_options.delete(:prepare_stage_reports)
-            Gitlab::QA::Report::PrepareStageReports.new(**report_options).invoke!
-
-          elsif report_options.delete(:relate_failure_issue)
-            report_options[:token] = Runtime::TokenFinder.find_token!(report_options[:token])
-            Gitlab::QA::Report::RelateFailureIssue.new(**report_options).invoke!
-
-          elsif report_options.delete(:report_results)
-            report_options[:token] = Runtime::TokenFinder.find_token!(report_options[:token])
-            Gitlab::QA::Report::ReportResults.new(**report_options).invoke!
-
-          elsif report_options.delete(:generate_test_session)
-            report_options[:token] = Runtime::TokenFinder.find_token!(report_options[:token])
-            Gitlab::QA::Report::GenerateTestSession.new(**report_options).invoke!
-
-          elsif slack_options.delete(:post_to_slack)
-            Gitlab::QA::Slack::PostToSlack.new(**slack_options).invoke!
-
-          elsif report_options.delete(:update_screenshot_path)
-            Gitlab::QA::Report::UpdateScreenshotPath.new(**report_options).invoke!
-
-          end
-        else
-          puts options
-          exit 1
-        end
-      end
-      # rubocop:enable Metrics/CyclomaticComplexity
-      # rubocop:enable Metrics/PerceivedComplexity
-      # rubocop:enable Metrics/AbcSize
-    end
-  end
-end

data/lib/gitlab/qa/runtime/token_finder.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-module Gitlab
-  module QA
-    module Runtime
-      class TokenFinder
-        def self.find_token!(token, suffix: nil)
-          new(token, suffix).find_token!
-        end
-
-        attr_reader :token, :suffix
-
-        def initialize(token, suffix)
-          @token = token
-          @suffix = suffix
-        end
-
-        def find_token!
-          find_token_from_attrs || find_token_from_env || find_token_from_file
-        end
-
-        def find_token_from_attrs
-          token
-        end
-
-        def find_token_from_env
-          Env.qa_access_token
-        end
-
-        def find_token_from_file
-          @token_from_file ||= File.read(token_file_path).strip
-        rescue Errno::ENOENT
-          fail "Please provide a valid access token with the `-t/--token` option, the `GITLAB_QA_ACCESS_TOKEN` environment variable, or in the `#{token_file_path}` file!"
-        end
-
-        private
-
-        def token_file_path
-          @token_file_path ||= File.expand_path("../api_token#{"_#{suffix}" if suffix}", __dir__)
-        end
-      end
-    end
-  end
-end

data/lib/gitlab/qa/slack/post_to_slack.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-module Gitlab
-  module QA
-    module Slack
-      class PostToSlack
-        def initialize(message:, icon_emoji: Runtime::Env.slack_icon_emoji, channel: Runtime::Env.slack_qa_channel)
-          @channel = channel
-          @message = message
-          @icon_emoji = icon_emoji
-        end
-
-        def invoke!
-          Runtime::Env.require_slack_qa_channel! unless @channel
-          Runtime::Env.require_ci_slack_webhook_url!
-
-          params = {}
-          params['channel'] = @channel
-          params['username'] = "GitLab QA Bot"
-          params['icon_emoji'] = @icon_emoji
-          params['text'] = @message
-
-          url = Runtime::Env.ci_slack_webhook_url
-
-          Support::HttpRequest.make_http_request(method: 'post', url: url, params: params, show_response: true)
-        end
-      end
-    end
-  end
-end

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

@@ -1,65 +0,0 @@
-# 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

@@ -1,21 +0,0 @@
-# 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

@@ -1,21 +0,0 @@
-# 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

@@ -1,21 +0,0 @@
-# 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

@@ -1,21 +0,0 @@
-# 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

@@ -1,38 +0,0 @@
-# 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

@@ -1,34 +0,0 @@
-# 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

@@ -1,27 +0,0 @@
-# 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

@@ -1,23 +0,0 @@
-# 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

@@ -1,30 +0,0 @@
-# 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

@@ -1,29 +0,0 @@
-# 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

@@ -1,65 +0,0 @@
-# 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