summaryrefslogtreecommitdiff
path: root/qa/qa/runtime/allure_report.rb
blob: bcfdb09e09fea99d95af973549fc9a0bc9174728 (plain)
1
2
3
4
5
6
7
8
9
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
# frozen_string_literal: true

require 'active_support/core_ext/enumerable'

module QA
  module Runtime
    class AllureReport
      class << self
        # Configure allure reports
        #
        # @return [void]
        def configure!
          return unless Env.generate_allure_report?

          require 'allure-rspec'

          configure_allure
          configure_attachments
          configure_rspec
        end

        private

        # Configure allure reporter
        #
        # @return [void]
        def configure_allure
          # Match job names like ee:relative, ce:update etc. and set as execution environment
          env_matcher = /^(?<env>\w{2}:\S+)/

          AllureRspec.configure do |config|
            config.results_directory = 'tmp/allure-results'
            config.clean_results_directory = true
            config.environment_properties = environment_info if Env.running_in_ci?

            # Set custom environment name to separate same specs executed on different environments
            if Env.running_in_ci? && Env.ci_job_name.match?(env_matcher)
              config.environment = Env.ci_job_name.match(env_matcher).named_captures['env']
            end
          end
        end

        # Set up failure screenshot attachments
        #
        # @return [void]
        def configure_attachments
          Capybara::Screenshot.after_save_screenshot do |path|
            Allure.add_attachment(
              name: 'screenshot',
              source: File.open(path),
              type: Allure::ContentType::PNG,
              test_case: true
            )
          end
          Capybara::Screenshot.after_save_html do |path|
            Allure.add_attachment(
              name: 'html',
              source: File.open(path),
              type: 'text/html',
              test_case: true
            )
          end
        end

        # Configure rspec
        #
        # @return [void]
        def configure_rspec
          RSpec.configure do |config|
            config.formatter = AllureRspecFormatter

            config.after do |example|
              next if example.attempts && example.attempts > 0

              testcase = example.metadata[:testcase]
              example.tms('Testcase', testcase) if testcase

              quarantine_issue = example.metadata.dig(:quarantine, :issue)
              example.issue('Quarantine issue', quarantine_issue) if quarantine_issue

              spec_file = example.file_path.split('/').last
              example.issue(
                'Failure issues',
                "https://gitlab.com/gitlab-org/gitlab/-/issues?scope=all&state=opened&search=#{spec_file}"
              )

              example.add_link(name: "Job(#{Env.ci_job_name})", url: Env.ci_job_url) if Env.running_in_ci?
            end
          end
        end

        # Custom environment info hash
        #
        # @return [Hash]
        def environment_info
          %w[
            CI_COMMIT_SHA
            CI_MERGE_REQUEST_SOURCE_BRANCH_SHA
            CI_MERGE_REQUEST_IID
            TOP_UPSTREAM_SOURCE_SHA
            TOP_UPSTREAM_MERGE_REQUEST_IID
            DEPLOY_VERSION
            GITLAB_VERSION
            GITLAB_SHELL_VERSION
            GITLAB_ELASTICSEARCH_INDEXER_VERSION
            GITLAB_KAS_VERSION
            GITLAB_WORKHORSE_VERSION
            GITLAB_PAGES_VERSION
            GITALY_SERVER_VERSION
            QA_IMAGE
            QA_BROWSER
          ].index_with { |val| ENV[val] }.compact_blank
        end
      end
    end
  end
end