gitlab-org--gitlab-foss/spec/models/project_import_state_spec.rb

250 lines
7.7 KiB
Ruby

# frozen_string_literal: true
require 'spec_helper'
RSpec.describe ProjectImportState, type: :model do
let_it_be(:correlation_id) { 'cid' }
let_it_be(:import_state, refind: true) { create(:import_state, correlation_id_value: correlation_id) }
subject { import_state }
describe 'associations' do
it { is_expected.to belong_to(:project) }
end
describe 'validations' do
it { is_expected.to validate_presence_of(:project) }
end
describe 'Project import job' do
let_it_be(:import_state) { create(:import_state, import_url: generate(:url)) }
let_it_be(:project) { import_state.project }
before do
allow_any_instance_of(Gitlab::GitalyClient::RepositoryService).to receive(:import_repository)
.with(project.import_url, http_authorization_header: '', mirror: false).and_return(true)
# Works around https://github.com/rspec/rspec-mocks/issues/910
allow(Project).to receive(:find).with(project.id).and_return(project)
expect(project).to receive(:after_import).and_call_original
end
it 'imports a project', :sidekiq_might_not_need_inline do
expect(RepositoryImportWorker).to receive(:perform_async).and_call_original
expect { import_state.schedule }.to change { import_state.status }.from('none').to('finished')
end
it 'records job and correlation IDs', :sidekiq_might_not_need_inline do
allow(Labkit::Correlation::CorrelationId).to receive(:current_or_new_id).and_return(correlation_id)
import_state.schedule
expect(import_state.jid).to be_an_instance_of(String)
expect(import_state.correlation_id).to eq(correlation_id)
end
end
describe '#relation_hard_failures' do
let_it_be(:failures) { create_list(:import_failure, 2, :hard_failure, project: import_state.project, correlation_id_value: correlation_id) }
it 'returns hard relation failures related to this import' do
expect(subject.relation_hard_failures(limit: 100)).to match_array(failures)
end
it 'limits returned collection to given maximum' do
expect(subject.relation_hard_failures(limit: 1).size).to eq(1)
end
end
describe '#mark_as_failed' do
let(:error_message) { 'some message' }
it 'logs error when update column fails' do
allow(import_state).to receive(:update_column).and_raise(ActiveRecord::ActiveRecordError)
expect_next_instance_of(Gitlab::Import::Logger) do |logger|
expect(logger).to receive(:error).with(
{
error: 'ActiveRecord::ActiveRecordError',
message: 'Error setting import status to failed',
original_error: error_message
}
)
end
import_state.mark_as_failed(error_message)
end
it 'updates last_error with error message' do
import_state.mark_as_failed(error_message)
expect(import_state.last_error).to eq(error_message)
end
it 'removes project import data' do
import_data = ProjectImportData.new(data: { 'test' => 'some data' })
project = create(:project, import_data: import_data)
import_state = create(:import_state, :started, project: project)
expect do
import_state.mark_as_failed(error_message)
end.to change { project.reload.import_data }.from(import_data).to(nil)
end
end
describe '#human_status_name' do
context 'when import_state exists' do
it 'returns the humanized status name' do
import_state = build(:import_state, :started)
expect(import_state.human_status_name).to eq("started")
end
end
end
describe '#expire_etag_cache' do
context 'when project import type has realtime changes endpoint' do
before do
import_state.project.import_type = 'github'
end
it 'expires revelant etag cache' do
expect_next_instance_of(Gitlab::EtagCaching::Store) do |instance|
expect(instance).to receive(:touch).with(Gitlab::Routing.url_helpers.realtime_changes_import_github_path(format: :json))
end
subject.expire_etag_cache
end
end
context 'when project import type does not have realtime changes endpoint' do
before do
import_state.project.import_type = 'jira'
end
it 'does not touch etag caches' do
expect(Gitlab::EtagCaching::Store).not_to receive(:new)
subject.expire_etag_cache
end
end
end
describe 'import state transitions' do
context 'state transition: [:started] => [:finished]' do
it 'resets last_error' do
error_message = 'Some error'
import_state = create(:import_state, :started, last_error: error_message)
expect { import_state.finish }.to change { import_state.last_error }.from(error_message).to(nil)
end
it 'enqueues housekeeping when an import of a fresh project is completed' do
project = create(:project_empty_repo, :import_started, import_type: :github)
expect(Projects::AfterImportWorker).to receive(:perform_async).with(project.id)
project.import_state.finish
end
it 'does not perform housekeeping when project repository does not exist' do
project = create(:project, :import_started, import_type: :github)
expect(Projects::AfterImportWorker).not_to receive(:perform_async)
project.import_state.finish
end
it 'does not enqueue housekeeping when project does not have a valid import type' do
project = create(:project, :import_started, import_type: nil)
expect(Projects::AfterImportWorker).not_to receive(:perform_async)
project.import_state.finish
end
end
context 'state transition: [:none, :scheduled, :started] => [:canceled]' do
it 'updates the import status' do
import_state = create(:import_state, :none)
expect { import_state.cancel }
.to change { import_state.status }
.from('none').to('canceled')
end
it 'unsets the JID' do
import_state = create(:import_state, :started, jid: '123')
expect(Gitlab::SidekiqStatus)
.to receive(:unset)
.with('123')
.and_call_original
import_state.cancel!
expect(import_state.jid).to be_nil
end
it 'removes import data' do
import_data = ProjectImportData.new(data: { 'test' => 'some data' })
project = create(:project, :import_scheduled, import_data: import_data)
expect(project)
.to receive(:remove_import_data)
.and_call_original
expect do
project.import_state.cancel
project.reload
end.to change { project.import_data }
.from(import_data).to(nil)
end
end
end
describe 'clearing `jid` after finish', :clean_gitlab_redis_cache do
context 'without an JID' do
it 'does nothing' do
import_state = create(:import_state, :started)
expect(Gitlab::SidekiqStatus)
.not_to receive(:unset)
import_state.finish!
end
end
context 'with a JID' do
it 'unsets the JID' do
import_state = create(:import_state, :started, jid: '123')
expect(Gitlab::SidekiqStatus)
.to receive(:unset)
.with('123')
.and_call_original
import_state.finish!
expect(import_state.jid).to be_nil
end
end
end
describe 'callbacks' do
context 'after_commit :expire_etag_cache' do
before do
import_state.project.import_type = 'github'
end
it 'expires etag cache' do
expect_next_instance_of(Gitlab::EtagCaching::Store) do |instance|
expect(instance).to receive(:touch).with(Gitlab::Routing.url_helpers.realtime_changes_import_github_path(format: :json))
end
subject.save!
end
end
end
end