52 lines
1.9 KiB
Ruby
52 lines
1.9 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
RSpec.shared_examples 'Gitlab-style deprecations' do
|
|
describe 'validations' do
|
|
it 'raises an informative error if `deprecation_reason` is used' do
|
|
expect { subject(deprecation_reason: 'foo') }.to raise_error(
|
|
ArgumentError,
|
|
'Use `deprecated` property instead of `deprecation_reason`. ' \
|
|
'See https://docs.gitlab.com/ee/development/api_graphql_styleguide.html#deprecating-fields-arguments-and-enum-values'
|
|
)
|
|
end
|
|
|
|
it 'raises an error if a required property is missing', :aggregate_failures do
|
|
expect { subject(deprecated: { milestone: '1.10' }) }.to raise_error(
|
|
ArgumentError,
|
|
'Please provide a `reason` within `deprecated`'
|
|
)
|
|
expect { subject(deprecated: { reason: 'Deprecation reason' }) }.to raise_error(
|
|
ArgumentError,
|
|
'Please provide a `milestone` within `deprecated`'
|
|
)
|
|
end
|
|
|
|
it 'raises an error if milestone is not a String', :aggregate_failures do
|
|
expect { subject(deprecated: { milestone: 1.10, reason: 'Deprecation reason' }) }.to raise_error(
|
|
ArgumentError,
|
|
'`milestone` must be a `String`'
|
|
)
|
|
end
|
|
end
|
|
|
|
it 'adds a formatted `deprecated_reason` to the subject' do
|
|
deprecable = subject(deprecated: { milestone: '1.10', reason: 'Deprecation reason' })
|
|
|
|
expect(deprecable.deprecation_reason).to eq('Deprecation reason. Deprecated in 1.10.')
|
|
end
|
|
|
|
it 'appends to the description if given' do
|
|
deprecable = subject(
|
|
deprecated: { milestone: '1.10', reason: 'Deprecation reason' },
|
|
description: 'Deprecable description.'
|
|
)
|
|
|
|
expect(deprecable.description).to eq('Deprecable description. Deprecated in 1.10: Deprecation reason.')
|
|
end
|
|
|
|
it 'does not append to the description if it is absent' do
|
|
deprecable = subject(deprecated: { milestone: '1.10', reason: 'Deprecation reason' })
|
|
|
|
expect(deprecable.description).to be_nil
|
|
end
|
|
end
|