debian-mirror-gitlab/qa/spec/specs/allure_report_spec.rb

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

118 lines
4.1 KiB
Ruby
Raw Normal View History

2021-10-27 15:23:28 +05:30
# frozen_string_literal: true
describe QA::Runtime::AllureReport do
2021-11-11 11:23:49 +05:30
include QA::Support::Helpers::StubEnv
2021-10-27 15:23:28 +05:30
2022-06-21 17:19:12 +05:30
let(:rspec_config) { instance_double('RSpec::Core::Configuration', 'add_formatter': nil, append_after: nil) }
2021-10-27 15:23:28 +05:30
let(:png_path) { 'png_path' }
let(:html_path) { 'html_path' }
let(:allure_config) do
# need to mock config in case the test itself is executed with allure reporting enabled
AllureRspec::RspecConfig.send(:new).tap do |conf|
conf.instance_variable_set(:@allure_config, Allure::Config.send(:new))
end
end
before do
stub_env('QA_GENERATE_ALLURE_REPORT', generate_report)
allow(AllureRspec).to receive(:configure).and_yield(allure_config)
allow(RSpec).to receive(:configure).and_yield(rspec_config)
allow(Capybara::Screenshot).to receive(:after_save_screenshot).and_yield(png_path)
allow(Capybara::Screenshot).to receive(:after_save_html).and_yield(html_path)
end
context 'with report generation disabled' do
let(:generate_report) { 'false' }
it 'does not perform configuration' do
aggregate_failures do
expect(described_class.configure!).to be_nil
expect(AllureRspec).not_to have_received(:configure)
expect(RSpec).not_to have_received(:configure)
expect(Capybara::Screenshot).not_to have_received(:after_save_screenshot)
expect(Capybara::Screenshot).not_to have_received(:after_save_html)
end
end
end
context 'with report generation enabled' do
let(:generate_report) { 'true' }
2022-06-21 17:19:12 +05:30
let(:session) { instance_double('Capybara::Session') }
let(:attributes) { class_spy('Runtime::Scenario') }
let(:version_response) { instance_double('HTTPResponse', code: 200, body: versions.to_json) }
2021-10-27 15:23:28 +05:30
let(:png_file) { 'png-file' }
let(:html_file) { 'html-file' }
let(:ci_job) { 'ee:relative 5' }
2021-11-18 22:05:49 +05:30
let(:versions) { { version: '14', revision: '6ced31db947' } }
2021-12-11 22:18:48 +05:30
let(:browser_log) { ['log message 1', 'log message 2'] }
2021-10-27 15:23:28 +05:30
before do
stub_env('CI', 'true')
stub_env('CI_JOB_NAME', ci_job)
2021-11-18 22:05:49 +05:30
stub_env('GITLAB_QA_ADMIN_ACCESS_TOKEN', 'token')
2021-10-27 15:23:28 +05:30
2022-06-21 17:19:12 +05:30
stub_const('QA::Runtime::Scenario', attributes)
2021-10-27 15:23:28 +05:30
allow(Allure).to receive(:add_attachment)
allow(File).to receive(:open).with(png_path) { png_file }
allow(File).to receive(:open).with(html_path) { html_file }
2022-06-21 17:19:12 +05:30
allow(RestClient::Request).to receive(:execute) { version_response }
allow(attributes).to receive(:gitlab_address).and_return("https://gitlab.com")
2021-10-27 15:23:28 +05:30
2021-12-11 22:18:48 +05:30
allow(Capybara).to receive(:current_session).and_return(session)
allow(session).to receive_message_chain('driver.browser.logs.get').and_return(browser_log)
2021-10-27 15:23:28 +05:30
described_class.configure!
end
it 'configures Allure options' do
aggregate_failures do
expect(allure_config.results_directory).to eq('tmp/allure-results')
expect(allure_config.clean_results_directory).to eq(true)
2021-11-18 22:05:49 +05:30
expect(allure_config.environment_properties.call).to eq(versions)
2021-10-27 15:23:28 +05:30
expect(allure_config.environment).to eq('ee:relative')
end
end
it 'adds rspec and metadata formatter' do
2022-05-07 20:08:51 +05:30
expect(rspec_config).to have_received(:add_formatter).with(
QA::Support::Formatters::AllureMetadataFormatter
).ordered
2021-10-27 15:23:28 +05:30
expect(rspec_config).to have_received(:add_formatter).with(AllureRspecFormatter).ordered
end
2021-12-11 22:18:48 +05:30
it 'configures attachments saving' do
expect(rspec_config).to have_received(:append_after) do |&arg|
arg.call
end
2021-10-27 15:23:28 +05:30
aggregate_failures do
expect(Allure).to have_received(:add_attachment).with(
name: 'screenshot',
source: png_file,
type: Allure::ContentType::PNG,
test_case: true
)
expect(Allure).to have_received(:add_attachment).with(
name: 'html',
source: html_file,
type: 'text/html',
test_case: true
)
2021-12-11 22:18:48 +05:30
expect(Allure).to have_received(:add_attachment).with(
name: 'browser.log',
source: browser_log.join("\n\n"),
type: Allure::ContentType::TXT,
test_case: true
)
2021-10-27 15:23:28 +05:30
end
end
end
end