Class: Gitlab::QA::Reporter

Inherits:
Object
  • Object
show all
Defined in:
lib/gitlab/qa/reporter.rb

Class Method Summary collapse

Class Method Details

.invoke(args) ⇒ Object

rubocop:disable Metrics/AbcSize rubocop:disable Metrics/PerceivedComplexity



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/gitlab/qa/reporter.rb', line 10

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('--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