debian-mirror-gitlab/spec/models/todo_spec.rb

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

577 lines
16 KiB
Ruby
Raw Normal View History

2019-07-07 11:18:12 +05:30
# frozen_string_literal: true
2016-04-02 18:10:28 +05:30
require 'spec_helper'
2020-07-28 23:09:34 +05:30
RSpec.describe Todo do
2016-06-02 11:05:42 +05:30
let(:issue) { create(:issue) }
2016-04-02 18:10:28 +05:30
describe 'relationships' do
it { is_expected.to belong_to(:author).class_name("User") }
it { is_expected.to belong_to(:note) }
it { is_expected.to belong_to(:project) }
2018-11-18 11:00:15 +05:30
it { is_expected.to belong_to(:group) }
2016-04-02 18:10:28 +05:30
it { is_expected.to belong_to(:target).touch(true) }
it { is_expected.to belong_to(:user) }
end
describe 'respond to' do
it { is_expected.to respond_to(:author_name) }
it { is_expected.to respond_to(:author_email) }
end
describe 'validations' do
it { is_expected.to validate_presence_of(:action) }
2016-06-02 11:05:42 +05:30
it { is_expected.to validate_presence_of(:target_type) }
2016-04-02 18:10:28 +05:30
it { is_expected.to validate_presence_of(:user) }
2018-03-17 18:26:18 +05:30
it { is_expected.to validate_presence_of(:author) }
2016-06-02 11:05:42 +05:30
context 'for commits' do
subject { described_class.new(target_type: 'Commit') }
it { is_expected.to validate_presence_of(:commit_id) }
it { is_expected.not_to validate_presence_of(:target_id) }
end
context 'for issuables' do
subject { described_class.new(target: issue) }
it { is_expected.to validate_presence_of(:target_id) }
it { is_expected.not_to validate_presence_of(:commit_id) }
end
2016-04-02 18:10:28 +05:30
end
describe '#body' do
before do
subject.target = build(:issue, title: 'Bugfix')
end
it 'returns target title when note is blank' do
subject.note = nil
expect(subject.body).to eq 'Bugfix'
end
it 'returns note when note is present' do
subject.note = build(:note, note: 'quick fix')
expect(subject.body).to eq 'quick fix'
end
2023-03-04 22:38:38 +05:30
it 'returns full path of target when action is member_access_requested' do
group = create(:group)
subject.target = group
subject.action = Todo::MEMBER_ACCESS_REQUESTED
expect(subject.body).to eq group.full_path
end
2016-04-02 18:10:28 +05:30
end
2016-06-02 11:05:42 +05:30
describe '#done' do
2016-04-02 18:10:28 +05:30
it 'changes state to done' do
todo = create(:todo, state: :pending)
2020-05-24 23:13:21 +05:30
2016-06-02 11:05:42 +05:30
expect { todo.done }.to change(todo, :state).from('pending').to('done')
2016-04-02 18:10:28 +05:30
end
it 'does not raise error when is already done' do
todo = create(:todo, state: :done)
2020-05-24 23:13:21 +05:30
2016-06-02 11:05:42 +05:30
expect { todo.done }.not_to raise_error
end
end
describe '#for_commit?' do
it 'returns true when target is a commit' do
subject.target_type = 'Commit'
2020-05-24 23:13:21 +05:30
2016-06-02 11:05:42 +05:30
expect(subject.for_commit?).to eq true
end
it 'returns false when target is an issuable' do
subject.target_type = 'Issue'
2020-05-24 23:13:21 +05:30
2016-06-02 11:05:42 +05:30
expect(subject.for_commit?).to eq false
end
end
2020-05-24 23:13:21 +05:30
describe '#for_design?' do
it 'returns true when target is a Design' do
subject.target_type = 'DesignManagement::Design'
expect(subject.for_design?).to eq(true)
end
it 'returns false when target is not a Design' do
subject.target_type = 'Issue'
expect(subject.for_design?).to eq(false)
end
end
2020-06-23 00:09:42 +05:30
describe '#for_alert?' do
it 'returns true when target is a Alert' do
subject.target_type = 'AlertManagement::Alert'
expect(subject.for_alert?).to eq(true)
end
it 'returns false when target is not a Alert' do
subject.target_type = 'Issue'
expect(subject.for_alert?).to eq(false)
end
end
2022-08-13 15:12:31 +05:30
describe '#for_issue_or_work_item?' do
it 'returns true when target is an Issue' do
subject.target_type = 'Issue'
expect(subject.for_issue_or_work_item?).to be_truthy
end
it 'returns true when target is a WorkItem' do
subject.target_type = 'WorkItem'
expect(subject.for_issue_or_work_item?).to be_truthy
end
it 'returns false when target is not an Issue' do
subject.target_type = 'DesignManagement::Design'
expect(subject.for_issue_or_work_item?).to be_falsey
end
end
2016-06-02 11:05:42 +05:30
describe '#target' do
context 'for commits' do
2017-08-17 22:00:37 +05:30
let(:project) { create(:project, :repository) }
let(:commit) { project.commit }
2016-06-02 11:05:42 +05:30
it 'returns an instance of Commit when exists' do
subject.project = project
subject.target_type = 'Commit'
subject.commit_id = commit.id
expect(subject.target).to be_a(Commit)
expect(subject.target).to eq commit
end
it 'returns nil when does not exists' do
subject.project = project
subject.target_type = 'Commit'
subject.commit_id = 'xxxx'
expect(subject.target).to be_nil
end
end
it 'returns the issuable for issuables' do
subject.target_id = issue.id
subject.target_type = issue.class.name
2020-05-24 23:13:21 +05:30
2016-06-02 11:05:42 +05:30
expect(subject.target).to eq issue
end
end
describe '#target_reference' do
2023-03-17 16:20:25 +05:30
shared_examples 'returns full_path' do
specify do
subject.target = target
subject.action = Todo::MEMBER_ACCESS_REQUESTED
expect(subject.target_reference).to eq target.full_path
end
end
2017-08-17 22:00:37 +05:30
it 'returns commit full reference with short id' do
project = create(:project, :repository)
commit = project.commit
2016-06-02 11:05:42 +05:30
subject.project = project
subject.target_type = 'Commit'
subject.commit_id = commit.id
2019-12-04 20:38:33 +05:30
expect(subject.target_reference).to eq commit.reference_link_text(full: false)
2016-06-02 11:05:42 +05:30
end
2017-08-17 22:00:37 +05:30
it 'returns full reference for issuables' do
2016-06-02 11:05:42 +05:30
subject.target = issue
2020-05-24 23:13:21 +05:30
2019-12-04 20:38:33 +05:30
expect(subject.target_reference).to eq issue.to_reference(full: false)
2017-08-17 22:00:37 +05:30
end
2023-03-04 22:38:38 +05:30
context 'when target is member access requested' do
2023-03-17 16:20:25 +05:30
%i[project group].each do |target_type|
it_behaves_like 'returns full_path' do
let(:target) { create(target_type, :public) }
end
2023-03-04 22:38:38 +05:30
end
end
2017-08-17 22:00:37 +05:30
end
describe '#self_added?' do
let(:user_1) { build(:user) }
before do
subject.user = user_1
end
it 'is true when the user is the author' do
subject.author = user_1
expect(subject).to be_self_added
end
it 'is false when the user is not the author' do
subject.author = build(:user)
expect(subject).not_to be_self_added
end
end
2019-12-26 22:10:19 +05:30
describe '#done?' do
let_it_be(:todo1) { create(:todo, state: :pending) }
let_it_be(:todo2) { create(:todo, state: :done) }
it 'returns true for todos with done state' do
expect(todo2.done?).to be_truthy
end
it 'returns false for todos with state pending' do
expect(todo1.done?).to be_falsey
end
end
2017-08-17 22:00:37 +05:30
describe '#self_assigned?' do
let(:user_1) { build(:user) }
2021-01-03 14:25:43 +05:30
context 'when self_added' do
before do
subject.user = user_1
subject.author = user_1
end
2017-08-17 22:00:37 +05:30
2021-01-03 14:25:43 +05:30
it 'returns true for ASSIGNED' do
subject.action = Todo::ASSIGNED
expect(subject).to be_self_assigned
end
2017-08-17 22:00:37 +05:30
2021-01-03 14:25:43 +05:30
it 'returns true for REVIEW_REQUESTED' do
subject.action = Todo::REVIEW_REQUESTED
2017-08-17 22:00:37 +05:30
2021-01-03 14:25:43 +05:30
expect(subject).to be_self_assigned
end
it 'returns false for other action' do
subject.action = Todo::MENTIONED
expect(subject).not_to be_self_assigned
end
2017-08-17 22:00:37 +05:30
end
2021-01-03 14:25:43 +05:30
context 'when todo is not self_added' do
before do
subject.user = user_1
subject.author = build(:user)
end
2017-08-17 22:00:37 +05:30
2021-01-03 14:25:43 +05:30
it 'returns false' do
subject.action = Todo::ASSIGNED
expect(subject).not_to be_self_assigned
end
2016-04-02 18:10:28 +05:30
end
end
2018-12-13 13:39:08 +05:30
describe '.for_action' do
it 'returns the todos for a given action' do
create(:todo, action: Todo::MENTIONED)
todo = create(:todo, action: Todo::ASSIGNED)
expect(described_class.for_action(Todo::ASSIGNED)).to eq([todo])
end
end
describe '.for_author' do
it 'returns the todos for a given author' do
user1 = create(:user)
user2 = create(:user)
todo = create(:todo, author: user1)
create(:todo, author: user2)
expect(described_class.for_author(user1)).to eq([todo])
end
end
describe '.for_project' do
it 'returns the todos for a given project' do
project1 = create(:project)
project2 = create(:project)
todo = create(:todo, project: project1)
create(:todo, project: project2)
expect(described_class.for_project(project1)).to eq([todo])
end
2019-12-26 22:10:19 +05:30
it 'returns the todos for many projects' do
project1 = create(:project)
project2 = create(:project)
project3 = create(:project)
todo1 = create(:todo, project: project1)
todo2 = create(:todo, project: project2)
create(:todo, project: project3)
expect(described_class.for_project([project2, project1])).to contain_exactly(todo2, todo1)
end
end
describe '.for_undeleted_projects' do
let(:project1) { create(:project) }
let(:project2) { create(:project) }
let(:project3) { create(:project) }
let!(:todo1) { create(:todo, project: project1) }
let!(:todo2) { create(:todo, project: project2) }
let!(:todo3) { create(:todo, project: project3) }
it 'returns the todos for a given project' do
expect(described_class.for_undeleted_projects).to contain_exactly(todo1, todo2, todo3)
end
context 'when todo belongs to deleted project' do
let(:project2) { create(:project, pending_delete: true) }
it 'excludes todos of deleted projects' do
expect(described_class.for_undeleted_projects).to contain_exactly(todo1, todo3)
end
end
2018-12-13 13:39:08 +05:30
end
describe '.for_group' do
it 'returns the todos for a given group' do
group1 = create(:group)
group2 = create(:group)
todo = create(:todo, group: group1)
create(:todo, group: group2)
expect(described_class.for_group(group1)).to eq([todo])
end
end
describe '.for_type' do
it 'returns the todos for a given target type' do
todo = create(:todo, target: create(:issue))
create(:todo, target: create(:merge_request))
2019-02-15 15:39:39 +05:30
expect(described_class.for_type(Issue.name)).to eq([todo])
2018-12-13 13:39:08 +05:30
end
end
describe '.for_target' do
it 'returns the todos for a given target' do
todo = create(:todo, target: create(:issue))
create(:todo, target: create(:merge_request))
2019-02-15 15:39:39 +05:30
expect(described_class.for_type(Issue.name).for_target(todo.target))
.to contain_exactly(todo)
2018-12-13 13:39:08 +05:30
end
end
describe '.for_commit' do
it 'returns the todos for a commit ID' do
todo = create(:todo, commit_id: '123')
create(:todo, commit_id: '456')
expect(described_class.for_commit('123')).to eq([todo])
end
end
2019-12-21 20:55:43 +05:30
describe '.for_group_ids_and_descendants' do
2018-12-13 13:39:08 +05:30
it 'returns the todos for a group and its descendants' do
parent_group = create(:group)
child_group = create(:group, parent: parent_group)
todo1 = create(:todo, group: parent_group)
todo2 = create(:todo, group: child_group)
2019-12-21 20:55:43 +05:30
todos = described_class.for_group_ids_and_descendants([parent_group.id])
2018-12-13 13:39:08 +05:30
2019-10-12 21:52:04 +05:30
expect(todos).to contain_exactly(todo1, todo2)
2018-12-13 13:39:08 +05:30
end
end
2020-03-13 15:44:24 +05:30
describe '.for_user' do
it 'returns the expected todos' do
user1 = create(:user)
user2 = create(:user)
todo1 = create(:todo, user: user1)
todo2 = create(:todo, user: user1)
create(:todo, user: user2)
expect(described_class.for_user(user1)).to contain_exactly(todo1, todo2)
end
end
2021-09-04 01:27:46 +05:30
describe '.for_note' do
it 'returns todos that belongs to notes' do
note_1 = create(:note, noteable: issue, project: issue.project)
note_2 = create(:note, noteable: issue, project: issue.project)
todo_1 = create(:todo, note: note_1)
todo_2 = create(:todo, note: note_2)
create(:todo, note: create(:note))
expect(described_class.for_note([note_1, note_2])).to contain_exactly(todo_1, todo_2)
end
end
2021-04-29 21:17:54 +05:30
describe '.group_by_user_id_and_state' do
let_it_be(:user1) { create(:user) }
let_it_be(:user2) { create(:user) }
before do
create(:todo, user: user1, state: :pending)
create(:todo, user: user1, state: :pending)
create(:todo, user: user1, state: :done)
create(:todo, user: user2, state: :pending)
end
specify do
expect(Todo.count_grouped_by_user_id_and_state).to eq({ [user1.id, "done"] => 1, [user1.id, "pending"] => 2, [user2.id, "pending"] => 1 })
end
end
2018-12-13 13:39:08 +05:30
describe '.any_for_target?' do
it 'returns true if there are todos for a given target' do
todo = create(:todo)
expect(described_class.any_for_target?(todo.target)).to eq(true)
end
2019-12-04 20:38:33 +05:30
it 'returns true if there is at least one todo for a given target with state pending' do
issue = create(:issue)
create(:todo, state: :done, target: issue)
create(:todo, state: :pending, target: issue)
expect(described_class.any_for_target?(issue)).to eq(true)
end
it 'returns false if there are only todos for a given target with state done while searching for pending' do
issue = create(:issue)
create(:todo, state: :done, target: issue)
create(:todo, state: :done, target: issue)
expect(described_class.any_for_target?(issue, :pending)).to eq(false)
end
2018-12-13 13:39:08 +05:30
it 'returns false if there are no todos for a given target' do
issue = create(:issue)
expect(described_class.any_for_target?(issue)).to eq(false)
end
end
2020-06-23 00:09:42 +05:30
describe '.batch_update' do
2018-12-13 13:39:08 +05:30
it 'updates the state of todos' do
todo = create(:todo, :pending)
2020-06-23 00:09:42 +05:30
ids = described_class.batch_update(state: :done)
2018-12-13 13:39:08 +05:30
todo.reload
expect(ids).to eq([todo.id])
expect(todo.state).to eq('done')
end
it 'does not update todos that already have the given state' do
create(:todo, :pending)
2020-06-23 00:09:42 +05:30
expect(described_class.batch_update(state: :pending)).to be_empty
2018-12-13 13:39:08 +05:30
end
2020-05-24 23:13:21 +05:30
it 'updates updated_at' do
create(:todo, :pending)
2021-01-03 14:25:43 +05:30
travel_to(1.day.from_now) do
2020-06-23 00:09:42 +05:30
expected_update_date = Time.current.utc
2020-05-24 23:13:21 +05:30
2020-06-23 00:09:42 +05:30
ids = described_class.batch_update(state: :done)
2020-05-24 23:13:21 +05:30
expect(Todo.where(id: ids).map(&:updated_at)).to all(be_like_time(expected_update_date))
end
end
2018-12-13 13:39:08 +05:30
end
2021-04-29 21:17:54 +05:30
2021-06-08 01:23:25 +05:30
describe '.distinct_user_ids' do
subject { described_class.distinct_user_ids }
2021-04-29 21:17:54 +05:30
2021-06-08 01:23:25 +05:30
let_it_be(:user1) { create(:user) }
let_it_be(:user2) { create(:user) }
let_it_be(:todo) { create(:todo, user: user1) }
let_it_be(:todo) { create(:todo, user: user1) }
let_it_be(:todo) { create(:todo, user: user2) }
2021-04-29 21:17:54 +05:30
2021-06-08 01:23:25 +05:30
it { is_expected.to contain_exactly(user1.id, user2.id) }
2021-04-29 21:17:54 +05:30
end
2022-07-29 17:44:30 +05:30
describe '.for_internal_notes' do
it 'returns todos created from internal notes' do
2023-01-13 00:05:48 +05:30
internal_note = create(:note, confidential: true)
2022-07-29 17:44:30 +05:30
todo = create(:todo, note: internal_note)
create(:todo)
expect(described_class.for_internal_notes).to contain_exactly(todo)
end
end
2023-03-17 16:20:25 +05:30
describe '#access_request_url' do
shared_examples 'returns member access requests tab url/path' do
it 'returns group access requests tab url/path if target is group' do
group = create(:group)
subject.target = group
expect(subject.access_request_url(only_path: only_path)).to eq(Gitlab::Routing.url_helpers.group_group_members_url(group, tab: 'access_requests', only_path: only_path))
end
it 'returns project access requests tab url/path if target is project' do
project = create(:project)
subject.target = project
expect(subject.access_request_url(only_path: only_path)).to eq(Gitlab::Routing.url_helpers.project_project_members_url(project, tab: 'access_requests', only_path: only_path))
end
it 'returns empty string if target is neither group nor project' do
subject.target = issue
expect(subject.access_request_url(only_path: only_path)).to eq("")
end
end
context 'when only_path param is false' do
it_behaves_like 'returns member access requests tab url/path' do
let_it_be(:only_path) { false }
end
end
context 'when only_path param is nil' do
it_behaves_like 'returns member access requests tab url/path' do
let_it_be(:only_path) { nil }
end
end
context 'when only_path param is true' do
it_behaves_like 'returns member access requests tab url/path' do
let_it_be(:only_path) { true }
end
end
end
2016-04-02 18:10:28 +05:30
end