356 lines
10 KiB
Ruby
356 lines
10 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
require 'spec_helper'
|
|
|
|
describe ErrorTracking::ProjectErrorTrackingSetting do
|
|
include ReactiveCachingHelpers
|
|
|
|
set(:project) { create(:project) }
|
|
|
|
subject { create(:project_error_tracking_setting, project: project) }
|
|
|
|
describe 'Associations' do
|
|
it { is_expected.to belong_to(:project) }
|
|
end
|
|
|
|
describe 'Validations' do
|
|
context 'when api_url is over 255 chars' do
|
|
before do
|
|
subject.api_url = 'https://' + 'a' * 250
|
|
end
|
|
|
|
it 'fails validation' do
|
|
expect(subject).not_to be_valid
|
|
expect(subject.errors.messages[:api_url]).to include('is too long (maximum is 255 characters)')
|
|
end
|
|
end
|
|
|
|
context 'With unsafe url' do
|
|
it 'fails validation' do
|
|
subject.api_url = "https://replaceme.com/'><script>alert(document.cookie)</script>"
|
|
|
|
expect(subject).not_to be_valid
|
|
end
|
|
end
|
|
|
|
context 'presence validations' do
|
|
using RSpec::Parameterized::TableSyntax
|
|
|
|
valid_api_url = 'http://example.com/api/0/projects/org-slug/proj-slug/'
|
|
valid_token = 'token'
|
|
|
|
where(:enabled, :token, :api_url, :valid?) do
|
|
true | nil | nil | false
|
|
true | nil | valid_api_url | false
|
|
true | valid_token | nil | false
|
|
true | valid_token | valid_api_url | true
|
|
false | nil | nil | true
|
|
false | nil | valid_api_url | true
|
|
false | valid_token | nil | true
|
|
false | valid_token | valid_api_url | true
|
|
end
|
|
|
|
with_them do
|
|
before do
|
|
subject.enabled = enabled
|
|
subject.token = token
|
|
subject.api_url = api_url
|
|
end
|
|
|
|
it { expect(subject.valid?).to eq(valid?) }
|
|
end
|
|
end
|
|
|
|
context 'URL path' do
|
|
it 'fails validation without api/0/projects' do
|
|
subject.api_url = 'http://gitlab.com/project1/something'
|
|
|
|
expect(subject).not_to be_valid
|
|
expect(subject.errors.messages[:api_url]).to include('is invalid')
|
|
end
|
|
|
|
it 'fails validation without org and project slugs' do
|
|
subject.api_url = 'http://gitlab.com/api/0/projects/'
|
|
|
|
expect(subject).not_to be_valid
|
|
expect(subject.errors.messages[:project]).to include('is a required field')
|
|
end
|
|
|
|
it 'fails validation when api_url has extra parts' do
|
|
subject.api_url = 'http://gitlab.com/api/0/projects/org/proj/something'
|
|
|
|
expect(subject).not_to be_valid
|
|
expect(subject.errors.messages[:api_url]).to include("is invalid")
|
|
end
|
|
|
|
it 'fails validation when api_url has less parts' do
|
|
subject.api_url = 'http://gitlab.com/api/0/projects/org'
|
|
|
|
expect(subject).not_to be_valid
|
|
expect(subject.errors.messages[:api_url]).to include("is invalid")
|
|
end
|
|
|
|
it 'passes validation with correct path' do
|
|
subject.api_url = 'http://gitlab.com/api/0/projects/project1/something'
|
|
|
|
expect(subject).to be_valid
|
|
end
|
|
end
|
|
|
|
context 'non ascii chars in api_url' do
|
|
before do
|
|
subject.api_url = 'http://gitlab.com/api/0/projects/project1/something€'
|
|
end
|
|
|
|
it 'fails validation' do
|
|
expect(subject).not_to be_valid
|
|
end
|
|
end
|
|
end
|
|
|
|
describe '#sentry_external_url' do
|
|
let(:sentry_url) { 'https://sentrytest.gitlab.com/api/0/projects/sentry-org/sentry-project' }
|
|
|
|
before do
|
|
subject.api_url = sentry_url
|
|
end
|
|
|
|
it 'returns the correct url' do
|
|
expect(subject.class).to receive(:extract_sentry_external_url).with(sentry_url).and_call_original
|
|
|
|
result = subject.sentry_external_url
|
|
|
|
expect(result).to eq('https://sentrytest.gitlab.com/sentry-org/sentry-project')
|
|
end
|
|
end
|
|
|
|
describe '#sentry_client' do
|
|
it 'returns sentry client' do
|
|
expect(subject.sentry_client).to be_a(Sentry::Client)
|
|
end
|
|
end
|
|
|
|
describe '#list_sentry_issues' do
|
|
let(:issues) { [:list, :of, :issues] }
|
|
|
|
let(:opts) do
|
|
{ issue_status: 'unresolved', limit: 10 }
|
|
end
|
|
|
|
let(:result) do
|
|
subject.list_sentry_issues(**opts)
|
|
end
|
|
|
|
context 'when cached' do
|
|
let(:sentry_client) { spy(:sentry_client) }
|
|
|
|
before do
|
|
stub_reactive_cache(subject, issues, opts)
|
|
synchronous_reactive_cache(subject)
|
|
|
|
expect(subject).to receive(:sentry_client).and_return(sentry_client)
|
|
end
|
|
|
|
it 'returns cached issues' do
|
|
expect(sentry_client).to receive(:list_issues).with(opts)
|
|
.and_return(issues)
|
|
|
|
expect(result).to eq(issues: issues)
|
|
end
|
|
end
|
|
|
|
context 'when not cached' do
|
|
it 'returns nil' do
|
|
expect(subject).not_to receive(:sentry_client)
|
|
|
|
expect(result).to be_nil
|
|
end
|
|
end
|
|
|
|
context 'when sentry client raises Sentry::Client::Error' do
|
|
let(:sentry_client) { spy(:sentry_client) }
|
|
|
|
before do
|
|
synchronous_reactive_cache(subject)
|
|
|
|
allow(subject).to receive(:sentry_client).and_return(sentry_client)
|
|
allow(sentry_client).to receive(:list_issues).with(opts)
|
|
.and_raise(Sentry::Client::Error, 'error message')
|
|
end
|
|
|
|
it 'returns error' do
|
|
expect(result).to eq(
|
|
error: 'error message',
|
|
error_type: ErrorTracking::ProjectErrorTrackingSetting::SENTRY_API_ERROR_TYPE_NON_20X_RESPONSE
|
|
)
|
|
expect(subject).to have_received(:sentry_client)
|
|
expect(sentry_client).to have_received(:list_issues)
|
|
end
|
|
end
|
|
|
|
context 'when sentry client raises Sentry::Client::MissingKeysError' do
|
|
let(:sentry_client) { spy(:sentry_client) }
|
|
|
|
before do
|
|
synchronous_reactive_cache(subject)
|
|
|
|
allow(subject).to receive(:sentry_client).and_return(sentry_client)
|
|
allow(sentry_client).to receive(:list_issues).with(opts)
|
|
.and_raise(Sentry::Client::MissingKeysError, 'Sentry API response is missing keys. key not found: "id"')
|
|
end
|
|
|
|
it 'returns error' do
|
|
expect(result).to eq(
|
|
error: 'Sentry API response is missing keys. key not found: "id"',
|
|
error_type: ErrorTracking::ProjectErrorTrackingSetting::SENTRY_API_ERROR_TYPE_MISSING_KEYS
|
|
)
|
|
expect(subject).to have_received(:sentry_client)
|
|
expect(sentry_client).to have_received(:list_issues)
|
|
end
|
|
end
|
|
end
|
|
|
|
describe '#list_sentry_projects' do
|
|
let(:projects) { [:list, :of, :projects] }
|
|
let(:sentry_client) { spy(:sentry_client) }
|
|
|
|
it 'calls sentry client' do
|
|
expect(subject).to receive(:sentry_client).and_return(sentry_client)
|
|
expect(sentry_client).to receive(:list_projects).and_return(projects)
|
|
|
|
result = subject.list_sentry_projects
|
|
|
|
expect(result).to eq(projects: projects)
|
|
end
|
|
end
|
|
|
|
context 'slugs' do
|
|
shared_examples_for 'slug from api_url' do |method, slug|
|
|
context 'when api_url is correct' do
|
|
before do
|
|
subject.api_url = 'http://gitlab.com/api/0/projects/org-slug/project-slug/'
|
|
end
|
|
|
|
it 'returns slug' do
|
|
expect(subject.public_send(method)).to eq(slug)
|
|
end
|
|
end
|
|
|
|
context 'when api_url is blank' do
|
|
before do
|
|
subject.api_url = nil
|
|
end
|
|
|
|
it 'returns nil' do
|
|
expect(subject.public_send(method)).to be_nil
|
|
end
|
|
end
|
|
end
|
|
|
|
it_behaves_like 'slug from api_url', :project_slug, 'project-slug'
|
|
it_behaves_like 'slug from api_url', :organization_slug, 'org-slug'
|
|
end
|
|
|
|
context 'names from api_url' do
|
|
shared_examples_for 'name from api_url' do |name, titleized_slug|
|
|
context 'name is present in DB' do
|
|
it 'returns name from DB' do
|
|
subject[name] = 'Sentry name'
|
|
subject.api_url = 'http://gitlab.com/api/0/projects/org-slug/project-slug'
|
|
|
|
expect(subject.public_send(name)).to eq('Sentry name')
|
|
end
|
|
end
|
|
|
|
context 'name is null in DB' do
|
|
it 'titleizes and returns slug from api_url' do
|
|
subject[name] = nil
|
|
subject.api_url = 'http://gitlab.com/api/0/projects/org-slug/project-slug'
|
|
|
|
expect(subject.public_send(name)).to eq(titleized_slug)
|
|
end
|
|
|
|
it 'returns nil when api_url is incorrect' do
|
|
subject[name] = nil
|
|
subject.api_url = 'http://gitlab.com/api/0/projects/'
|
|
|
|
expect(subject.public_send(name)).to be_nil
|
|
end
|
|
|
|
it 'returns nil when api_url is blank' do
|
|
subject[name] = nil
|
|
subject.api_url = nil
|
|
|
|
expect(subject.public_send(name)).to be_nil
|
|
end
|
|
end
|
|
end
|
|
|
|
it_behaves_like 'name from api_url', :organization_name, 'Org Slug'
|
|
it_behaves_like 'name from api_url', :project_name, 'Project Slug'
|
|
end
|
|
|
|
describe '.build_api_url_from' do
|
|
it 'correctly builds api_url with slugs' do
|
|
api_url = described_class.build_api_url_from(
|
|
api_host: 'http://sentry.com/',
|
|
organization_slug: 'org-slug',
|
|
project_slug: 'proj-slug'
|
|
)
|
|
|
|
expect(api_url).to eq('http://sentry.com/api/0/projects/org-slug/proj-slug/')
|
|
end
|
|
|
|
it 'correctly builds api_url without slugs' do
|
|
api_url = described_class.build_api_url_from(
|
|
api_host: 'http://sentry.com/',
|
|
organization_slug: nil,
|
|
project_slug: nil
|
|
)
|
|
|
|
expect(api_url).to eq('http://sentry.com/api/0/projects/')
|
|
end
|
|
|
|
it 'does not raise exception with invalid url' do
|
|
api_url = described_class.build_api_url_from(
|
|
api_host: ':::',
|
|
organization_slug: 'org-slug',
|
|
project_slug: 'proj-slug'
|
|
)
|
|
|
|
expect(api_url).to eq(':::')
|
|
end
|
|
|
|
it 'returns nil when api_host is blank' do
|
|
api_url = described_class.build_api_url_from(
|
|
api_host: '',
|
|
organization_slug: 'org-slug',
|
|
project_slug: 'proj-slug'
|
|
)
|
|
|
|
expect(api_url).to be_nil
|
|
end
|
|
end
|
|
|
|
describe '#api_host' do
|
|
context 'when api_url exists' do
|
|
before do
|
|
subject.api_url = 'https://example.com/api/0/projects/org-slug/proj-slug/'
|
|
end
|
|
|
|
it 'extracts the api_host from api_url' do
|
|
expect(subject.api_host).to eq('https://example.com/')
|
|
end
|
|
end
|
|
|
|
context 'when api_url is nil' do
|
|
before do
|
|
subject.api_url = nil
|
|
end
|
|
|
|
it 'returns nil' do
|
|
expect(subject.api_url).to eq(nil)
|
|
end
|
|
end
|
|
end
|
|
end
|