From f2c27c6f97cf138acaed79b90be7a5be520746fc Mon Sep 17 00:00:00 2001 From: GitLab Bot Date: Wed, 6 Jan 2021 12:10:58 +0000 Subject: Add latest changes from gitlab-org/gitlab@master --- spec/lib/atlassian/jira_connect/client_spec.rb | 89 +++++++++++++++++--- .../serializers/deployment_entity_spec.rb | 95 ++++++++++++++++++++++ 2 files changed, 173 insertions(+), 11 deletions(-) create mode 100644 spec/lib/atlassian/jira_connect/serializers/deployment_entity_spec.rb (limited to 'spec/lib/atlassian') diff --git a/spec/lib/atlassian/jira_connect/client_spec.rb b/spec/lib/atlassian/jira_connect/client_spec.rb index 6a161854dfb..7c05912a49d 100644 --- a/spec/lib/atlassian/jira_connect/client_spec.rb +++ b/spec/lib/atlassian/jira_connect/client_spec.rb @@ -8,6 +8,15 @@ RSpec.describe Atlassian::JiraConnect::Client do subject { described_class.new('https://gitlab-test.atlassian.net', 'sample_secret') } let_it_be(:project) { create_default(:project, :repository) } + let_it_be(:mrs_by_title) { create_list(:merge_request, 4, :unique_branches, :jira_title) } + let_it_be(:mrs_by_branch) { create_list(:merge_request, 2, :jira_branch) } + let_it_be(:red_herrings) { create_list(:merge_request, 1, :unique_branches) } + + let_it_be(:pipelines) do + (red_herrings + mrs_by_branch + mrs_by_title).map do |mr| + create(:ci_pipeline, merge_request: mr) + end + end around do |example| freeze_time { example.run } @@ -22,13 +31,19 @@ RSpec.describe Atlassian::JiraConnect::Client do end describe '#send_info' do - it 'calls store_build_info and store_dev_info as appropriate' do + it 'calls store_deploy_info, store_build_info and store_dev_info as appropriate' do expect(subject).to receive(:store_build_info).with( project: project, update_sequence_id: :x, pipelines: :y ).and_return(:build_stored) + expect(subject).to receive(:store_deploy_info).with( + project: project, + update_sequence_id: :x, + deployments: :q + ).and_return(:deploys_stored) + expect(subject).to receive(:store_dev_info).with( project: project, update_sequence_id: :x, @@ -43,10 +58,12 @@ RSpec.describe Atlassian::JiraConnect::Client do commits: :a, branches: :b, merge_requests: :c, - pipelines: :y + pipelines: :y, + deployments: :q } - expect(subject.send_info(**args)).to contain_exactly(:dev_stored, :build_stored) + expect(subject.send_info(**args)) + .to contain_exactly(:dev_stored, :build_stored, :deploys_stored) end it 'only calls methods that we need to call' do @@ -83,17 +100,65 @@ RSpec.describe Atlassian::JiraConnect::Client do } end - describe '#store_build_info' do - let_it_be(:mrs_by_title) { create_list(:merge_request, 4, :unique_branches, :jira_title) } - let_it_be(:mrs_by_branch) { create_list(:merge_request, 2, :jira_branch) } - let_it_be(:red_herrings) { create_list(:merge_request, 1, :unique_branches) } - - let_it_be(:pipelines) do - (red_herrings + mrs_by_branch + mrs_by_title).map do |mr| - create(:ci_pipeline, merge_request: mr) + describe '#store_deploy_info' do + let_it_be(:environment) { create(:environment, name: 'DEV', project: project) } + let_it_be(:deployments) do + pipelines.map do |p| + build = create(:ci_build, environment: environment.name, pipeline: p, project: project) + create(:deployment, deployable: build, environment: environment) end end + let(:schema) do + Atlassian::Schemata.deploy_info_payload + end + + let(:body) do + matcher = be_valid_json.according_to_schema(schema) + + ->(text) { matcher.matches?(text) } + end + + before do + path = '/rest/deployments/0.1/bulk' + stub_full_request('https://gitlab-test.atlassian.net' + path, method: :post) + .with(body: body, headers: expected_headers(path)) + end + + it "calls the API with auth headers" do + subject.send(:store_deploy_info, project: project, deployments: deployments) + end + + it 'only sends information about relevant MRs' do + expect(subject).to receive(:post).with('/rest/deployments/0.1/bulk', { deployments: have_attributes(size: 6) }) + + subject.send(:store_deploy_info, project: project, deployments: deployments) + end + + it 'does not call the API if there is nothing to report' do + expect(subject).not_to receive(:post) + + subject.send(:store_deploy_info, project: project, deployments: deployments.take(1)) + end + + it 'does not call the API if the feature flag is not enabled' do + stub_feature_flags(jira_sync_deployments: false) + + expect(subject).not_to receive(:post) + + subject.send(:store_deploy_info, project: project, deployments: deployments) + end + + it 'does call the API if the feature flag enabled for the project' do + stub_feature_flags(jira_sync_deployments: project) + + expect(subject).to receive(:post).with('/rest/deployments/0.1/bulk', { deployments: Array }) + + subject.send(:store_deploy_info, project: project, deployments: deployments) + end + end + + describe '#store_build_info' do let(:build_info_payload_schema) do Atlassian::Schemata.build_info_payload end @@ -143,6 +208,8 @@ RSpec.describe Atlassian::JiraConnect::Client do end it 'avoids N+1 database queries' do + pending 'https://gitlab.com/gitlab-org/gitlab/-/issues/292818' + baseline = ActiveRecord::QueryRecorder.new do subject.send(:store_build_info, project: project, pipelines: pipelines) end diff --git a/spec/lib/atlassian/jira_connect/serializers/deployment_entity_spec.rb b/spec/lib/atlassian/jira_connect/serializers/deployment_entity_spec.rb new file mode 100644 index 00000000000..42a10944dc9 --- /dev/null +++ b/spec/lib/atlassian/jira_connect/serializers/deployment_entity_spec.rb @@ -0,0 +1,95 @@ +# frozen_string_literal: true + +require 'spec_helper' + +RSpec.describe Atlassian::JiraConnect::Serializers::DeploymentEntity do + let_it_be(:user) { create_default(:user) } + let_it_be(:project) { create_default(:project, :repository) } + let_it_be(:environment) { create(:environment, name: 'prod', project: project) } + let_it_be_with_reload(:deployment) { create(:deployment, environment: environment) } + + subject { described_class.represent(deployment) } + + context 'when the deployment does not belong to any Jira issue' do + describe '#issue_keys' do + it 'is empty' do + expect(subject.issue_keys).to be_empty + end + end + + describe '#to_json' do + it 'can encode the object' do + expect(subject.to_json).to be_valid_json + end + + it 'is invalid, since it has no issue keys' do + expect(subject.to_json).not_to be_valid_json.according_to_schema(Atlassian::Schemata.deployment_info) + end + end + end + + context 'this is an external deployment' do + before do + deployment.update!(deployable: nil) + end + + it 'does not raise errors when serializing' do + expect { subject.to_json }.not_to raise_error + end + + it 'returns an empty list of issue keys' do + expect(subject.issue_keys).to be_empty + end + end + + describe 'environment type' do + using RSpec::Parameterized::TableSyntax + + where(:env_name, :env_type) do + 'prod' | 'production' + 'test' | 'testing' + 'staging' | 'staging' + 'dev' | 'development' + 'review/app' | 'development' + 'something-else' | 'unmapped' + end + + with_them do + before do + environment.update!(name: env_name) + end + + let(:exposed_type) { subject.send(:environment_entity).send(:type) } + + it 'has the correct environment type' do + expect(exposed_type).to eq(env_type) + end + end + end + + context 'when the deployment can be linked to a Jira issue' do + let(:pipeline) { create(:ci_pipeline, merge_request: merge_request) } + + before do + subject.deployable.update!(pipeline: pipeline) + end + + %i[jira_branch jira_title].each do |trait| + context "because it belongs to an MR with a #{trait}" do + let(:merge_request) { create(:merge_request, trait) } + + describe '#issue_keys' do + it 'is not empty' do + expect(subject.issue_keys).not_to be_empty + end + end + + describe '#to_json' do + it 'is valid according to the deployment info schema' do + expect(subject.to_json).to be_valid_json.according_to_schema(Atlassian::Schemata.deployment_info) + end + end + end + end + end +end -- cgit v1.2.3