377 lines
12 KiB
Ruby
377 lines
12 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
require 'spec_helper'
|
|
|
|
RSpec.describe Label do
|
|
let_it_be(:project) { create(:project) }
|
|
|
|
describe 'modules' do
|
|
it { is_expected.to include_module(Referable) }
|
|
it { is_expected.to include_module(Subscribable) }
|
|
end
|
|
|
|
describe 'associations' do
|
|
it { is_expected.to have_many(:issues).through(:label_links).source(:target) }
|
|
it { is_expected.to have_many(:label_links).dependent(:destroy) }
|
|
it { is_expected.to have_many(:lists).dependent(:destroy) }
|
|
it { is_expected.to have_many(:priorities).class_name('LabelPriority') }
|
|
end
|
|
|
|
describe 'validation' do
|
|
it { is_expected.to validate_uniqueness_of(:title).scoped_to([:group_id, :project_id]) }
|
|
|
|
it 'validates color code' do
|
|
is_expected.not_to allow_value('G-ITLAB').for(:color)
|
|
is_expected.not_to allow_value('AABBCC').for(:color)
|
|
is_expected.not_to allow_value('#AABBCCEE').for(:color)
|
|
is_expected.not_to allow_value('GGHHII').for(:color)
|
|
is_expected.not_to allow_value('#').for(:color)
|
|
is_expected.not_to allow_value('').for(:color)
|
|
|
|
is_expected.to allow_value('#AABBCC').for(:color)
|
|
is_expected.to allow_value('#abcdef').for(:color)
|
|
end
|
|
|
|
it 'validates title' do
|
|
is_expected.not_to allow_value('G,ITLAB').for(:title)
|
|
is_expected.not_to allow_value('').for(:title)
|
|
is_expected.not_to allow_value('s' * 256).for(:title)
|
|
|
|
is_expected.to allow_value('GITLAB').for(:title)
|
|
is_expected.to allow_value('gitlab').for(:title)
|
|
is_expected.to allow_value('G?ITLAB').for(:title)
|
|
is_expected.to allow_value('G&ITLAB').for(:title)
|
|
is_expected.to allow_value("customer's request").for(:title)
|
|
is_expected.to allow_value('s' * 255).for(:title)
|
|
end
|
|
|
|
describe 'description length' do
|
|
let(:invalid_description) { 'x' * (::Label::DESCRIPTION_LENGTH_MAX + 1) }
|
|
let(:valid_description) { 'short description' }
|
|
let(:label) { build(:label, project: project, description: description) }
|
|
|
|
let(:error_message) do
|
|
format(
|
|
_('is too long (%{size}). The maximum size is %{max_size}.'),
|
|
size: ActiveSupport::NumberHelper.number_to_human_size(invalid_description.bytesize),
|
|
max_size: ActiveSupport::NumberHelper.number_to_human_size(::Label::DESCRIPTION_LENGTH_MAX)
|
|
)
|
|
end
|
|
|
|
subject(:validate) { label.validate }
|
|
|
|
context 'when label is a new record' do
|
|
context 'when description exceeds the maximum size' do
|
|
let(:description) { invalid_description }
|
|
|
|
it 'adds a description too long error' do
|
|
validate
|
|
|
|
expect(label.errors[:description]).to contain_exactly(error_message)
|
|
end
|
|
end
|
|
|
|
context 'when description is within the allowed limits' do
|
|
let(:description) { valid_description }
|
|
|
|
it 'does not add a validation error' do
|
|
validate
|
|
|
|
expect(label.errors).not_to have_key(:description)
|
|
end
|
|
end
|
|
end
|
|
|
|
context 'when label is an existing record' do
|
|
before do
|
|
label.description = existing_description
|
|
label.save!(validate: false)
|
|
label.description = description
|
|
end
|
|
|
|
context 'when record already had a valid description' do
|
|
let(:existing_description) { 'small difference so it triggers description_changed?' }
|
|
|
|
context 'when new description exceeds the maximum size' do
|
|
let(:description) { invalid_description }
|
|
|
|
it 'adds a description too long error' do
|
|
validate
|
|
|
|
expect(label.errors[:description]).to contain_exactly(error_message)
|
|
end
|
|
end
|
|
|
|
context 'when new description is within the allowed limits' do
|
|
let(:description) { valid_description }
|
|
|
|
it 'does not add a validation error' do
|
|
validate
|
|
|
|
expect(label.errors).not_to have_key(:description)
|
|
end
|
|
end
|
|
end
|
|
|
|
context 'when record existed with an invalid description' do
|
|
let(:existing_description) { "#{invalid_description} small difference so it triggers description_changed?" }
|
|
|
|
context 'when description is not changed' do
|
|
let(:description) { existing_description }
|
|
|
|
it 'does not add a validation error' do
|
|
validate
|
|
|
|
expect(label.errors).not_to have_key(:description)
|
|
end
|
|
end
|
|
|
|
context 'when new description exceeds the maximum size' do
|
|
context 'when new description is shorter than existing description' do
|
|
let(:description) { invalid_description }
|
|
|
|
it 'allows updating descriptions that already existed above the limit' do
|
|
validate
|
|
|
|
expect(label.errors).not_to have_key(:description)
|
|
end
|
|
end
|
|
|
|
context 'when new description is longer than existing description' do
|
|
let(:description) { "#{existing_description}1" }
|
|
|
|
it 'adds a description too long error' do
|
|
validate
|
|
|
|
expect(label.errors[:description]).to contain_exactly(error_message)
|
|
end
|
|
end
|
|
end
|
|
|
|
context 'when new description is within the allowed limits' do
|
|
let(:description) { valid_description }
|
|
|
|
it 'does not add a validation error' do
|
|
validate
|
|
|
|
expect(label.errors).not_to have_key(:description)
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|
|
end
|
|
|
|
describe 'scopes' do
|
|
describe '.on_board' do
|
|
let(:board) { create(:board, project: project) }
|
|
let!(:list1) { create(:list, board: board, label: development) }
|
|
let!(:list2) { create(:list, board: board, label: testing) }
|
|
|
|
let!(:development) { create(:label, project: project, name: 'Development') }
|
|
let!(:testing) { create(:label, project: project, name: 'Testing') }
|
|
let!(:regression) { create(:label, project: project, name: 'Regression') }
|
|
|
|
it 'returns only the board labels' do
|
|
expect(described_class.on_board(board.id)).to match_array([development, testing])
|
|
end
|
|
end
|
|
end
|
|
|
|
describe '#color' do
|
|
it 'strips color' do
|
|
label = described_class.new(color: ' #abcdef ')
|
|
label.valid?
|
|
|
|
expect(label.color).to be_color('#abcdef')
|
|
end
|
|
|
|
it 'uses default color if color is missing' do
|
|
label = described_class.new(color: nil)
|
|
|
|
expect(label.color).to be_color(Label::DEFAULT_COLOR)
|
|
end
|
|
end
|
|
|
|
describe '#text_color' do
|
|
it 'uses default color if color is missing' do
|
|
label = described_class.new(color: nil)
|
|
|
|
expect(label.text_color).to eq(Label::DEFAULT_COLOR.contrast)
|
|
end
|
|
end
|
|
|
|
describe '#title' do
|
|
it 'sanitizes title' do
|
|
label = described_class.new(title: '<b>foo & bar?</b>')
|
|
expect(label.title).to eq('foo & bar?')
|
|
end
|
|
|
|
it 'strips title' do
|
|
label = described_class.new(title: ' label ')
|
|
label.valid?
|
|
|
|
expect(label.title).to eq('label')
|
|
end
|
|
end
|
|
|
|
describe '#description' do
|
|
it 'sanitizes description' do
|
|
label = described_class.new(description: '<b>foo & bar?</b>')
|
|
expect(label.description).to eq('foo & bar?')
|
|
end
|
|
|
|
it 'accepts an empty string' do
|
|
label = described_class.new(title: 'foo', description: 'bar')
|
|
label.update!(description: '')
|
|
expect(label.description).to eq('')
|
|
end
|
|
end
|
|
|
|
describe 'priorization' do
|
|
subject(:label) { create(:label, project: project) }
|
|
|
|
describe '#prioritize!' do
|
|
context 'when label is not prioritized' do
|
|
it 'creates a label priority' do
|
|
expect { label.prioritize!(project, 1) }.to change(label.priorities, :count).by(1)
|
|
end
|
|
|
|
it 'sets label priority' do
|
|
label.prioritize!(project, 1)
|
|
|
|
expect(label.priorities.first.priority).to eq 1
|
|
end
|
|
end
|
|
|
|
context 'when label is prioritized' do
|
|
let!(:priority) { create(:label_priority, project: project, label: label, priority: 0) }
|
|
|
|
it 'does not create a label priority' do
|
|
expect { label.prioritize!(project, 1) }.not_to change(label.priorities, :count)
|
|
end
|
|
|
|
it 'updates label priority' do
|
|
label.prioritize!(project, 1)
|
|
|
|
expect(priority.reload.priority).to eq 1
|
|
end
|
|
end
|
|
end
|
|
|
|
describe '#unprioritize!' do
|
|
it 'removes label priority' do
|
|
create(:label_priority, project: project, label: label, priority: 0)
|
|
|
|
expect { label.unprioritize!(project) }.to change(label.priorities, :count).by(-1)
|
|
end
|
|
end
|
|
|
|
describe '#priority' do
|
|
context 'when label is not prioritized' do
|
|
it 'returns nil' do
|
|
expect(label.priority(project)).to be_nil
|
|
end
|
|
end
|
|
|
|
context 'when label is prioritized' do
|
|
it 'returns label priority' do
|
|
create(:label_priority, project: project, label: label, priority: 1)
|
|
|
|
expect(label.priority(project)).to eq 1
|
|
end
|
|
end
|
|
end
|
|
end
|
|
|
|
describe '.search' do
|
|
let(:label) { create(:label, title: 'bug', description: 'incorrect behavior') }
|
|
|
|
it 'returns labels with a partially matching title' do
|
|
expect(described_class.search(label.title[0..2])).to eq([label])
|
|
end
|
|
|
|
it 'returns labels with a partially matching description' do
|
|
expect(described_class.search(label.description[0..5])).to eq([label])
|
|
end
|
|
|
|
it 'returns nothing' do
|
|
expect(described_class.search('feature')).to be_empty
|
|
end
|
|
end
|
|
|
|
describe '.subscribed_by' do
|
|
let!(:user) { create(:user) }
|
|
let!(:label) { create(:label) }
|
|
let!(:label2) { create(:label) }
|
|
|
|
before do
|
|
label.subscribe(user)
|
|
end
|
|
|
|
it 'returns subscribed labels' do
|
|
expect(described_class.subscribed_by(user.id)).to eq([label])
|
|
end
|
|
|
|
it 'returns nothing' do
|
|
expect(described_class.subscribed_by(0)).to be_empty
|
|
end
|
|
end
|
|
|
|
describe '.top_labels_by_target' do
|
|
let(:label) { create(:label) }
|
|
let(:popular_label) { create(:label) }
|
|
let(:merge_request1) { create(:merge_request) }
|
|
let(:merge_request2) { create(:merge_request) }
|
|
|
|
before do
|
|
merge_request1.labels = [label, popular_label]
|
|
merge_request2.labels = [popular_label]
|
|
end
|
|
|
|
it 'returns distinct labels, ordered by usage in the given target relation' do
|
|
top_labels = described_class.top_labels_by_target(MergeRequest.all)
|
|
|
|
expect(top_labels).to match_array([popular_label, label])
|
|
end
|
|
|
|
it 'excludes labels that are not assigned to any records in the given target relation' do
|
|
merge_requests = MergeRequest.where(id: merge_request2.id)
|
|
top_labels = described_class.top_labels_by_target(merge_requests)
|
|
|
|
expect(top_labels).to match_array([popular_label])
|
|
end
|
|
end
|
|
|
|
describe '.optionally_subscribed_by' do
|
|
let!(:user) { create(:user) }
|
|
let!(:label) { create(:label) }
|
|
let!(:label2) { create(:label) }
|
|
|
|
before do
|
|
label.subscribe(user)
|
|
end
|
|
|
|
it 'returns subscribed labels' do
|
|
expect(described_class.optionally_subscribed_by(user.id)).to eq([label])
|
|
end
|
|
|
|
it 'returns all labels if user_id is nil' do
|
|
expect(described_class.optionally_subscribed_by(nil)).to match_array([label, label2])
|
|
end
|
|
end
|
|
|
|
describe '#templates' do
|
|
context 'with invalid template labels' do
|
|
it 'returns only valid template labels' do
|
|
create(:label)
|
|
# Project labels should not have template set to true
|
|
create(:label, template: true)
|
|
valid_template_label = described_class.create!(title: 'test', template: true, type: nil)
|
|
|
|
expect(described_class.templates).to eq([valid_template_label])
|
|
end
|
|
end
|
|
end
|
|
end
|