debian-mirror-gitlab/spec/services/import/github_service_spec.rb
2022-11-25 23:54:43 +05:30

230 lines
7.1 KiB
Ruby

# frozen_string_literal: true
require 'spec_helper'
RSpec.describe Import::GithubService do
let_it_be(:user) { create(:user) }
let_it_be(:token) { 'complex-token' }
let_it_be(:access_params) { { github_access_token: 'github-complex-token' } }
let(:settings) { instance_double(Gitlab::GithubImport::Settings) }
let(:optional_stages) { nil }
let(:params) do
{
repo_id: 123,
new_name: 'new_repo',
target_namespace: 'root',
optional_stages: optional_stages
}
end
subject(:github_importer) { described_class.new(client, user, params) }
before do
allow(subject).to receive(:authorized?).and_return(true)
end
shared_examples 'handles errors' do |klass|
let(:client) { klass.new(token) }
let(:project_double) { instance_double(Project, persisted?: true) }
before do
allow(Gitlab::GithubImport::Settings).to receive(:new).with(project_double).and_return(settings)
allow(settings).to receive(:write).with(optional_stages)
end
context 'do not raise an exception on input error' do
let(:exception) { Octokit::ClientError.new(status: 404, body: 'Not Found') }
before do
expect(client).to receive(:repository).and_raise(exception)
end
it 'logs the original error' do
expect(Gitlab::Import::Logger).to receive(:error).with({
message: 'Import failed due to a GitHub error',
status: 404,
error: 'Not Found'
}).and_call_original
subject.execute(access_params, :github)
end
it 'returns an error with message and code' do
result = subject.execute(access_params, :github)
expect(result).to include(
message: 'Import failed due to a GitHub error: Not Found (HTTP 404)',
status: :error,
http_status: :unprocessable_entity
)
end
end
it 'raises an exception for unknown error causes' do
exception = StandardError.new('Not Implemented')
expect(client).to receive(:repository).and_raise(exception)
expect(Gitlab::Import::Logger).not_to receive(:error)
expect { subject.execute(access_params, :github) }.to raise_error(exception)
end
context 'repository size validation' do
let(:repository_double) { { name: 'repository', size: 99 } }
before do
expect(client).to receive(:repository).and_return(repository_double)
allow_next_instance_of(Gitlab::LegacyGithubImport::ProjectCreator) do |creator|
allow(creator).to receive(:execute).and_return(project_double)
end
end
context 'when there is no repository size limit defined' do
it 'skips the check and succeeds' do
expect(subject.execute(access_params, :github)).to include(status: :success)
expect(settings).to have_received(:write).with(nil)
end
end
context 'when the target namespace repository size limit is defined' do
let_it_be(:group) { create(:group, repository_size_limit: 100) }
before do
params[:target_namespace] = group.full_path
end
it 'succeeds when the repository is smaller than the limit' do
expect(subject.execute(access_params, :github)).to include(status: :success)
expect(settings).to have_received(:write).with(nil)
end
it 'returns error when the repository is larger than the limit' do
repository_double[:size] = 101
expect(subject.execute(access_params, :github)).to include(size_limit_error)
end
end
context 'when target namespace repository limit is not defined' do
let_it_be(:group) { create(:group) }
before do
stub_application_setting(repository_size_limit: 100)
end
context 'when application size limit is defined' do
it 'succeeds when the repository is smaller than the limit' do
expect(subject.execute(access_params, :github)).to include(status: :success)
expect(settings).to have_received(:write).with(nil)
end
it 'returns error when the repository is larger than the limit' do
repository_double[:size] = 101
expect(subject.execute(access_params, :github)).to include(size_limit_error)
end
end
end
context 'when optional stages params present' do
let(:optional_stages) do
{
single_endpoint_issue_events_import: true,
single_endpoint_notes_import: 'false',
attachments_import: false
}
end
it 'saves optional stages choice to import_data' do
subject.execute(access_params, :github)
expect(settings).to have_received(:write).with(optional_stages)
end
end
end
context 'when import source is disabled' do
let(:repository_double) do
{
name: 'vim',
description: 'test',
full_name: 'test/vim',
clone_url: 'http://repo.com/repo/repo.git',
private: false,
has_wiki?: false
}
end
before do
stub_application_setting(import_sources: nil)
allow(client).to receive(:repository).and_return(repository_double)
end
it 'returns forbidden' do
result = subject.execute(access_params, :github)
expect(result).to include(
status: :error,
http_status: :forbidden
)
end
end
context 'when a blocked/local URL is used as github_hostname' do
let(:message) { 'Error while attempting to import from GitHub' }
let(:error) { "Invalid URL: #{url}" }
before do
stub_application_setting(allow_local_requests_from_web_hooks_and_services: false)
end
where(url: %w[https://localhost https://10.0.0.1])
with_them do
it 'returns and logs an error' do
allow(github_importer).to receive(:url).and_return(url)
expect(Gitlab::Import::Logger).to receive(:error).with({
message: message,
error: error
}).and_call_original
expect(github_importer.execute(access_params, :github)).to include(blocked_url_error(url))
end
end
end
end
context 'when remove_legacy_github_client feature flag is enabled' do
before do
stub_feature_flags(remove_legacy_github_client: true)
end
include_examples 'handles errors', Gitlab::GithubImport::Client
end
context 'when remove_legacy_github_client feature flag is disabled' do
before do
stub_feature_flags(remove_legacy_github_client: false)
end
include_examples 'handles errors', Gitlab::LegacyGithubImport::Client
end
def size_limit_error
{
status: :error,
http_status: :unprocessable_entity,
message: '"repository" size (101 Bytes) is larger than the limit of 100 Bytes.'
}
end
def blocked_url_error(url)
{
status: :error,
http_status: :bad_request,
message: "Invalid URL: #{url}"
}
end
end