# frozen_string_literal: true RSpec.describe QA::Resource::ApiFabricator do let(:resource_without_api_support) do Class.new do def self.name 'FooBarResource' end end end let(:resource_with_api_support) do Class.new do def self.name 'FooBarResource' end def api_get_path '/foo' end def api_post_path '/bar' end def api_post_body { name: 'John Doe' } end end end before do allow(subject).to receive(:current_url).and_return('') end subject { resource.tap { |f| f.include(described_class) }.new } describe '#api_support?' do let(:api_client) { spy('Runtime::API::Client') } let(:api_client_instance) { double('API Client') } context 'when resource does not support fabrication via the API' do let(:resource) { resource_without_api_support } it 'returns false' do expect(subject).not_to be_api_support end end context 'when resource supports fabrication via the API' do let(:resource) { resource_with_api_support } it 'returns false' do expect(subject).to be_api_support end end end describe '#fabricate_via_api!' do let(:api_client) { spy('Runtime::API::Client') } let(:api_client_instance) { double('API Client') } before do stub_const('QA::Runtime::API::Client', api_client) allow(api_client).to receive(:new).and_return(api_client_instance) allow(api_client_instance).to receive(:personal_access_token).and_return('foo') end context 'when resource does not support fabrication via the API' do let(:resource) { resource_without_api_support } it 'raises a NotImplementedError exception' do expect { subject.fabricate_via_api! }.to raise_error(NotImplementedError, "Resource FooBarResource does not support fabrication via the API!") end end context 'when resource supports fabrication via the API' do let(:resource) { resource_with_api_support } let(:api_request) { spy('Runtime::API::Request') } let(:resource_web_url) { 'http://example.org/api/v4/foo' } let(:response) { { id: 1, name: 'John Doe', web_url: resource_web_url } } let(:raw_post) { double('Raw POST response', code: 201, body: response.to_json) } before do stub_const('QA::Runtime::API::Request', api_request) allow(api_request).to receive(:new).and_return(double(url: resource_web_url)) end context 'when creating a resource' do before do allow(subject).to receive(:post).with(resource_web_url, subject.api_post_body).and_return(raw_post) end it 'returns the resource URL' do expect(api_request).to receive(:new).with(api_client_instance, subject.api_post_path).and_return(double(url: resource_web_url)) expect(subject).to receive(:post).with(resource_web_url, subject.api_post_body).and_return(raw_post) expect(subject.fabricate_via_api!).to eq(resource_web_url) end it 'populates api_resource with the resource' do subject.fabricate_via_api! expect(subject.api_resource).to eq(response) end context 'when the POST fails' do let(:post_response) { { error: "Name already taken." } } let(:raw_post) { double('Raw POST response', code: 400, body: post_response.to_json, headers: {}) } it 'raises a ResourceFabricationFailedError exception' do expect(api_request).to receive(:new).with(api_client_instance, subject.api_post_path).and_return(double(url: resource_web_url)) expect(subject).to receive(:post).with(resource_web_url, subject.api_post_body).and_return(raw_post) expect { subject.fabricate_via_api! }.to raise_error do |error| expect(error.class).to eql(described_class::ResourceFabricationFailedError) expect(error.to_s).to eql(<<~ERROR.chomp) Fabrication of FooBarResource using the API failed (400) with `#{raw_post}`.\n ERROR end expect(subject.api_resource).to be_nil end it 'logs a correlation id' do response = double('Raw POST response', code: 400, body: post_response.to_json, headers: { x_request_id: 'foobar' }) allow(QA::Support::Loglinking).to receive(:logging_environment).and_return(nil) expect(api_request).to receive(:new).with(api_client_instance, subject.api_post_path).and_return(double(url: resource_web_url)) expect(subject).to receive(:post).with(resource_web_url, subject.api_post_body).and_return(response) expect { subject.fabricate_via_api! }.to raise_error do |error| expect(error.class).to eql(described_class::ResourceFabricationFailedError) expect(error.to_s).to eql(<<~ERROR.chomp) Fabrication of FooBarResource using the API failed (400) with `#{raw_post}`. Correlation Id: foobar ERROR end end it 'logs Sentry and Kibana URLs from staging' do response = double('Raw POST response', code: 400, body: post_response.to_json, headers: { x_request_id: 'foobar' }) cookies = [{ name: 'Foo', value: 'Bar' }, { name: 'gitlab_canary', value: 'true' }] time = Time.new(2022, 11, 14, 0, 0, 0, '+00:00') allow(Capybara.current_session).to receive_message_chain(:driver, :browser, :manage, :all_cookies).and_return(cookies) allow(QA::Runtime::Scenario).to receive(:attributes).and_return({ gitlab_address: 'https://staging.gitlab.com' }) allow(Time).to receive(:now).and_return(time) expect(api_request).to receive(:new).with(api_client_instance, subject.api_post_path).and_return(double(url: resource_web_url)) expect(subject).to receive(:post).with(resource_web_url, subject.api_post_body).and_return(response) expect { subject.fabricate_via_api! }.to raise_error do |error| expect(error.class).to eql(described_class::ResourceFabricationFailedError) expect(error.to_s).to eql(<<~ERROR.chomp) Fabrication of FooBarResource using the API failed (400) with `#{raw_post}`. Correlation Id: foobar Sentry Url: https://sentry.gitlab.net/gitlab/staginggitlabcom/?environment=gstg&query=correlation_id%3A%22foobar%22 Kibana - Discover Url: https://nonprod-log.gitlab.net/app/discover#/?_a=%28index:%27ed942d00-5186-11ea-ad8a-f3610a492295%27%2Cquery%3A%28language%3Akuery%2Cquery%3A%27json.correlation_id%20%3A%20foobar%27%29%29&_g=%28time%3A%28from%3A%272022-11-13T00:00:00.000Z%27%2Cto%3A%272022-11-14T00:00:00.000Z%27%29%29 Kibana - Dashboard Url: https://nonprod-log.gitlab.net/app/dashboards#/view/b74dc030-6f56-11ed-9af2-6131f0ee4ce6?_g=%28time%3A%28from:%272022-11-13T00:00:00.000Z%27%2Cto%3A%272022-11-14T00:00:00.000Z%27%29%29&_a=%28filters%3A%21%28%28query%3A%28match_phrase%3A%28json.correlation_id%3A%27foobar%27%29%29%29%29%29 ERROR end end end end describe '#transform_api_resource' do let(:resource) do Class.new do def self.name 'FooBarResource' end def api_get_path '/foo' end def api_post_path '/bar' end def api_post_body { name: 'John Doe' } end def transform_api_resource(resource) resource[:new] = 'foobar' resource end end end let(:response) { { existing: 'foo', web_url: resource_web_url } } let(:transformed_resource) { { existing: 'foo', new: 'foobar', web_url: resource_web_url } } it 'transforms the resource' do expect(subject).to receive(:post).with(resource_web_url, subject.api_post_body).and_return(raw_post) expect(subject).to receive(:transform_api_resource).with(response).and_return(transformed_resource) subject.fabricate_via_api! end end end end end