gitlab-org--gitlab-foss/spec/models/ci/pipeline_artifact_spec.rb

313 lines
9.9 KiB
Ruby

# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Ci::PipelineArtifact, type: :model do
let(:coverage_report) { create(:ci_pipeline_artifact, :with_coverage_report) }
describe 'associations' do
it { is_expected.to belong_to(:pipeline) }
it { is_expected.to belong_to(:project) }
end
it_behaves_like 'having unique enum values'
it_behaves_like 'UpdateProjectStatistics' do
let_it_be(:pipeline, reload: true) { create(:ci_pipeline) }
subject { build(:ci_pipeline_artifact, :with_code_coverage_with_multiple_files, pipeline: pipeline) }
end
describe 'validations' do
it { is_expected.to validate_presence_of(:pipeline) }
it { is_expected.to validate_presence_of(:project) }
it { is_expected.to validate_presence_of(:file_type) }
it { is_expected.to validate_presence_of(:file_format) }
it { is_expected.to validate_presence_of(:size) }
it { is_expected.to validate_presence_of(:file) }
context 'when attributes are valid' do
it 'returns no errors' do
expect(coverage_report).to be_valid
end
end
context 'when file_store is invalid' do
it 'returns errors' do
coverage_report.file_store = 0
expect(coverage_report).to be_invalid
expect(coverage_report.errors.full_messages).to eq(["File store is not included in the list"])
end
end
context 'when size is over 10 megabytes' do
it 'returns errors' do
coverage_report.size = 11.megabytes
expect(coverage_report).to be_invalid
end
end
end
describe 'scopes' do
describe '.unlocked' do
subject(:pipeline_artifacts) { described_class.unlocked }
context 'when pipeline is locked' do
it 'returns an empty collection' do
expect(pipeline_artifacts).to be_empty
end
end
context 'when pipeline is unlocked' do
before do
create(:ci_pipeline_artifact, :with_coverage_report)
end
it 'returns unlocked artifacts' do
codequality_report = create(:ci_pipeline_artifact, :with_codequality_mr_diff_report, :unlocked)
expect(pipeline_artifacts).to eq([codequality_report])
end
end
end
end
describe 'file is being stored' do
subject { create(:ci_pipeline_artifact, :with_coverage_report) }
context 'when existing object has local store' do
it_behaves_like 'mounted file in local store'
end
context 'when direct upload is enabled' do
before do
stub_artifacts_object_storage(Ci::PipelineArtifactUploader, direct_upload: true)
end
context 'when file is stored' do
it_behaves_like 'mounted file in object store'
end
end
context 'when file contains multi-byte characters' do
let(:coverage_report_multibyte) { create(:ci_pipeline_artifact, :with_coverage_multibyte_characters) }
it 'sets the size in bytesize' do
expect(coverage_report_multibyte.size).to eq(14)
end
end
end
describe '.report_exists?' do
subject(:pipeline_artifact) { Ci::PipelineArtifact.report_exists?(file_type) }
context 'when file_type is code_coverage' do
let(:file_type) { :code_coverage }
context 'when pipeline artifact has a coverage report' do
let!(:pipeline_artifact) { create(:ci_pipeline_artifact, :with_coverage_report) }
it 'returns true' do
expect(pipeline_artifact).to be_truthy
end
end
context 'when pipeline artifact does not have a coverage report' do
it 'returns false' do
expect(pipeline_artifact).to be_falsey
end
end
end
context 'when file_type is code_quality_mr_diff' do
let(:file_type) { :code_quality_mr_diff }
context 'when pipeline artifact has a codequality mr diff report' do
let!(:pipeline_artifact) { create(:ci_pipeline_artifact, :with_codequality_mr_diff_report) }
it 'returns true' do
expect(pipeline_artifact).to be_truthy
end
end
context 'when pipeline artifact does not have a codequality mr diff report' do
it 'returns false' do
expect(pipeline_artifact).to be_falsey
end
end
end
context 'when file_type is nil' do
let(:file_type) { nil }
it 'returns false' do
expect(pipeline_artifact).to be_falsey
end
end
end
describe '.find_by_file_type' do
subject(:pipeline_artifact) { Ci::PipelineArtifact.find_by_file_type(file_type) }
context 'when file_type is code_coverage' do
let(:file_type) { :code_coverage }
context 'when pipeline artifact has a coverage report' do
let!(:coverage_report) { create(:ci_pipeline_artifact, :with_coverage_report) }
it 'returns a pipeline artifact with a coverage report' do
expect(pipeline_artifact.file_type).to eq('code_coverage')
end
end
context 'when pipeline artifact does not have a coverage report' do
it 'returns nil' do
expect(pipeline_artifact).to be_nil
end
end
end
context 'when file_type is code_quality_mr_diff' do
let(:file_type) { :code_quality_mr_diff }
context 'when pipeline artifact has a quality report' do
let!(:coverage_report) { create(:ci_pipeline_artifact, :with_codequality_mr_diff_report) }
it 'returns a pipeline artifact with a quality report' do
expect(pipeline_artifact.file_type).to eq('code_quality_mr_diff')
end
end
context 'when pipeline artifact does not have a quality report' do
it 'returns nil' do
expect(pipeline_artifact).to be_nil
end
end
end
context 'when file_type is nil' do
let(:file_type) { nil }
it 'returns nil' do
expect(pipeline_artifact).to be_nil
end
end
end
describe '.create_or_replace_for_pipeline!' do
let_it_be(:pipeline) { create(:ci_empty_pipeline) }
let(:file_type) { :code_coverage }
let(:file) { CarrierWaveStringFile.new_file(file_content: 'content', filename: 'file.json', content_type: 'json') }
let(:size) { file['tempfile'].size }
subject do
Ci::PipelineArtifact.create_or_replace_for_pipeline!(
pipeline: pipeline,
file_type: file_type,
file: file,
size: size
)
end
around do |example|
freeze_time { example.run }
end
context 'when there is no existing record' do
it 'creates a new pipeline artifact for the given parameters' do
expect { subject }.to change { Ci::PipelineArtifact.count }.from(0).to(1)
expect(subject.code_coverage?).to be(true)
expect(subject.pipeline).to eq(pipeline)
expect(subject.project_id).to eq(pipeline.project_id)
expect(subject.file.filename).to eq(file['filename'])
expect(subject.size).to eq(size)
expect(subject.file_format).to eq(Ci::PipelineArtifact::REPORT_TYPES[file_type].to_s)
expect(subject.expire_at).to eq(Ci::PipelineArtifact::EXPIRATION_DATE.from_now)
expect(subject.locked).to eq('unknown')
end
it "creates a new pipeline artifact with pipeline's locked state" do
artifact = Ci::PipelineArtifact.create_or_replace_for_pipeline!(
pipeline: pipeline,
file_type: file_type,
file: file,
size: size,
locked: pipeline.locked
)
expect(artifact.locked).to eq(pipeline.locked)
end
end
context 'when there are existing records with different types' do
let!(:existing_artifact) do
create(:ci_pipeline_artifact, pipeline: pipeline, file_type: file_type, expire_at: 1.day.from_now)
end
let!(:other_artifact) { create(:ci_pipeline_artifact, pipeline: pipeline, file_type: :code_quality_mr_diff) }
it 'replaces the existing pipeline artifact record with the given file type' do
expect { subject }.not_to change { Ci::PipelineArtifact.count }
expect(subject.id).not_to eq(existing_artifact.id)
expect(subject.code_coverage?).to be(true)
expect(subject.pipeline).to eq(pipeline)
expect(subject.project_id).to eq(pipeline.project_id)
expect(subject.file.filename).to eq(file['filename'])
expect(subject.size).to eq(size)
expect(subject.file_format).to eq(Ci::PipelineArtifact::REPORT_TYPES[file_type].to_s)
expect(subject.expire_at).to eq(Ci::PipelineArtifact::EXPIRATION_DATE.from_now)
end
end
context 'when ActiveRecordError is raised' do
let(:pipeline) { instance_double(Ci::Pipeline, id: 1) }
let(:file_type) { :code_coverage }
let(:error) { ActiveRecord::ActiveRecordError.new('something went wrong') }
before do
allow(pipeline).to receive(:pipeline_artifacts).and_raise(error)
end
it 'tracks and raise the exception' do
expect(Gitlab::ErrorTracking).to receive(:track_and_raise_exception)
.with(error, { pipeline_id: pipeline.id, file_type: file_type }).and_call_original
expect { subject }.to raise_error(ActiveRecord::ActiveRecordError, 'something went wrong')
end
end
end
describe '#present' do
subject(:presenter) { report.present }
context 'when file_type is code_coverage' do
let(:report) { coverage_report }
it 'uses code coverage presenter' do
expect(presenter).to be_kind_of(Ci::PipelineArtifacts::CodeCoveragePresenter)
end
end
context 'when file_type is code_quality_mr_diff' do
let(:report) { create(:ci_pipeline_artifact, :with_codequality_mr_diff_report) }
it 'uses code codequality mr diff presenter' do
expect(presenter).to be_kind_of(Ci::PipelineArtifacts::CodeQualityMrDiffPresenter)
end
end
end
context 'loose foreign key on ci_pipeline_artifacts.project_id' do
it_behaves_like 'cleanup by a loose foreign key' do
let!(:parent) { create(:project) }
let!(:model) { create(:ci_pipeline_artifact, project: parent) }
end
end
end