debian-mirror-gitlab/spec/requests/api/notes_spec.rb

344 lines
11 KiB
Ruby
Raw Normal View History

2019-12-26 22:10:19 +05:30
# frozen_string_literal: true
2014-09-02 18:07:02 +05:30
require 'spec_helper'
2020-07-28 23:09:34 +05:30
RSpec.describe API::Notes do
2020-04-22 19:07:51 +05:30
let!(:user) { create(:user) }
let!(:project) { create(:project, :public) }
2019-03-02 22:35:43 +05:30
let(:private_user) { create(:user) }
2017-09-10 17:25:29 +05:30
before do
2018-03-17 18:26:18 +05:30
project.add_reporter(user)
2017-09-10 17:25:29 +05:30
end
2014-09-02 18:07:02 +05:30
2019-12-04 20:38:33 +05:30
context 'when there are cross-reference system notes' do
let(:url) { "/projects/#{project.id}/merge_requests/#{merge_request.iid}/notes" }
let(:notes_in_response) { json_response }
it_behaves_like 'with cross-reference system notes'
end
2018-03-27 19:54:05 +05:30
context "when noteable is an Issue" do
let!(:issue) { create(:issue, project: project, author: user) }
let!(:issue_note) { create(:note, noteable: issue, project: project, author: user) }
2018-03-17 18:26:18 +05:30
2022-06-21 17:19:12 +05:30
it_behaves_like "noteable API with confidential notes", 'projects', 'issues', 'iid' do
2018-03-27 19:54:05 +05:30
let(:parent) { project }
let(:noteable) { issue }
let(:note) { issue_note }
end
2018-03-17 18:26:18 +05:30
2018-03-27 19:54:05 +05:30
context 'when user does not have access to create noteable' do
let(:private_issue) { create(:issue, project: create(:project, :private)) }
2018-03-17 18:26:18 +05:30
2018-03-27 19:54:05 +05:30
##
# We are posting to project user has access to, but we use issue id
# from a different project, see #15577
#
before do
post api("/projects/#{private_issue.project.id}/issues/#{private_issue.iid}/notes", user),
2019-02-15 15:39:39 +05:30
params: { body: 'Hi!' }
2018-03-27 19:54:05 +05:30
end
2018-03-17 18:26:18 +05:30
2018-03-27 19:54:05 +05:30
it 'responds with resource not found error' do
2020-04-22 19:07:51 +05:30
expect(response).to have_gitlab_http_status(:not_found)
2018-03-17 18:26:18 +05:30
end
2018-03-27 19:54:05 +05:30
it 'does not create new note' do
expect(private_issue.notes.reload).to be_empty
end
end
2016-06-02 11:05:42 +05:30
2018-03-27 19:54:05 +05:30
context "when referencing other project" do
# For testing the cross-reference of a private issue in a public project
let(:private_project) do
create(:project, namespace: private_user.namespace)
2018-11-18 11:00:15 +05:30
.tap { |p| p.add_maintainer(private_user) }
2014-09-02 18:07:02 +05:30
end
2020-10-24 23:57:45 +05:30
2019-03-02 22:35:43 +05:30
let(:private_issue) { create(:issue, project: private_project) }
2014-09-02 18:07:02 +05:30
2018-03-27 19:54:05 +05:30
let(:ext_proj) { create(:project, :public) }
let(:ext_issue) { create(:issue, project: ext_proj) }
2016-06-02 11:05:42 +05:30
2018-03-27 19:54:05 +05:30
let!(:cross_reference_note) do
create :note,
noteable: ext_issue, project: ext_proj,
note: "mentioned in issue #{private_issue.to_reference(ext_proj)}",
system: true
2014-09-02 18:07:02 +05:30
end
2018-03-27 19:54:05 +05:30
describe "GET /projects/:id/noteable/:noteable_id/notes" do
context "current user cannot view the notes" do
it "returns an empty array" do
get api("/projects/#{ext_proj.id}/issues/#{ext_issue.iid}/notes", user)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2018-03-27 19:54:05 +05:30
expect(response).to include_pagination_headers
expect(json_response).to be_an Array
expect(json_response).to be_empty
2017-09-10 17:25:29 +05:30
end
2016-06-02 11:05:42 +05:30
2018-03-27 19:54:05 +05:30
context "issue is confidential" do
before do
2020-11-24 15:15:51 +05:30
ext_issue.update!(confidential: true)
2018-03-27 19:54:05 +05:30
end
2016-06-02 11:05:42 +05:30
2018-03-27 19:54:05 +05:30
it "returns 404" do
get api("/projects/#{ext_proj.id}/issues/#{ext_issue.iid}/notes", user)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:not_found)
2018-03-27 19:54:05 +05:30
end
2016-06-02 11:05:42 +05:30
end
end
2018-03-27 19:54:05 +05:30
context "current user can view the note" do
2020-01-01 13:55:28 +05:30
it "returns a non-empty array" do
2017-08-17 22:00:37 +05:30
get api("/projects/#{ext_proj.id}/issues/#{ext_issue.iid}/notes", private_user)
2016-06-02 11:05:42 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2017-08-17 22:00:37 +05:30
expect(response).to include_pagination_headers
expect(json_response).to be_an Array
expect(json_response.first['body']).to eq(cross_reference_note.note)
end
2020-03-13 15:44:24 +05:30
end
context "activity filters" do
let!(:user_reference_note) do
create :note,
noteable: ext_issue, project: ext_proj,
note: "Hello there general!",
system: false
end
let(:test_url) {"/projects/#{ext_proj.id}/issues/#{ext_issue.iid}/notes"}
shared_examples 'a notes request' do
it 'is a note array response' do
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
2020-03-13 15:44:24 +05:30
expect(response).to include_pagination_headers
expect(json_response).to be_an Array
end
end
context "when not provided" do
let(:count) { 2 }
before do
get api(test_url, private_user)
end
it_behaves_like 'a notes request'
it 'returns all the notes' do
expect(json_response.count).to eq(count)
end
end
context "when all_notes provided" do
let(:count) { 2 }
before do
get api(test_url + "?activity_filter=all_notes", private_user)
end
it_behaves_like 'a notes request'
it 'returns all the notes' do
expect(json_response.count).to eq(count)
end
end
context "when provided" do
using RSpec::Parameterized::TableSyntax
where(:filter, :count, :system_notable) do
"only_comments" | 1 | false
"only_activity" | 1 | true
end
with_them do
before do
get api(test_url + "?activity_filter=#{filter}", private_user)
end
it_behaves_like 'a notes request'
it "properly filters the returned notables" do
expect(json_response.count).to eq(count)
expect(json_response.first["system"]).to be system_notable
end
end
end
end
end
2018-03-17 18:26:18 +05:30
2018-03-27 19:54:05 +05:30
describe "GET /projects/:id/noteable/:noteable_id/notes/:note_id" do
context "current user cannot view the notes" do
it "returns a 404 error" do
get api("/projects/#{ext_proj.id}/issues/#{ext_issue.iid}/notes/#{cross_reference_note.id}", user)
2018-03-17 18:26:18 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:not_found)
2017-09-10 17:25:29 +05:30
end
2016-06-02 11:05:42 +05:30
2018-03-27 19:54:05 +05:30
context "when issue is confidential" do
before do
2020-11-24 15:15:51 +05:30
issue.update!(confidential: true)
2018-03-27 19:54:05 +05:30
end
2016-06-02 11:05:42 +05:30
2018-03-27 19:54:05 +05:30
it "returns 404" do
get api("/projects/#{project.id}/issues/#{issue.iid}/notes/#{issue_note.id}", private_user)
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:not_found)
2018-03-27 19:54:05 +05:30
end
2016-06-02 11:05:42 +05:30
end
end
2018-03-27 19:54:05 +05:30
context "current user can view the note" do
2016-09-13 17:45:13 +05:30
it "returns an issue note by id" do
2017-08-17 22:00:37 +05:30
get api("/projects/#{ext_proj.id}/issues/#{ext_issue.iid}/notes/#{cross_reference_note.id}", private_user)
2016-06-02 11:05:42 +05:30
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:ok)
expect(json_response['body']).to eq(cross_reference_note.note)
end
end
end
2014-09-02 18:07:02 +05:30
end
end
2018-03-27 19:54:05 +05:30
context "when noteable is a Snippet" do
let!(:snippet) { create(:project_snippet, project: project, author: user) }
let!(:snippet_note) { create(:note, noteable: snippet, project: project, author: user) }
2016-06-02 11:05:42 +05:30
2018-03-27 19:54:05 +05:30
it_behaves_like "noteable API", 'projects', 'snippets', 'id' do
let(:parent) { project }
let(:noteable) { snippet }
let(:note) { snippet_note }
2014-09-02 18:07:02 +05:30
end
2018-03-27 19:54:05 +05:30
end
2016-06-02 11:05:42 +05:30
2018-03-27 19:54:05 +05:30
context "when noteable is a Merge Request" do
let!(:merge_request) { create(:merge_request, source_project: project, target_project: project, author: user) }
let!(:merge_request_note) { create(:note, noteable: merge_request, project: project, author: user) }
2016-06-02 11:05:42 +05:30
2018-03-27 19:54:05 +05:30
it_behaves_like "noteable API", 'projects', 'merge_requests', 'iid' do
let(:parent) { project }
let(:noteable) { merge_request }
let(:note) { merge_request_note }
2016-06-02 11:05:42 +05:30
end
2018-03-17 18:26:18 +05:30
2020-04-22 19:07:51 +05:30
let(:request_body) { 'Hi!' }
2022-05-07 20:08:51 +05:30
let(:params) { { body: request_body } }
2020-04-22 19:07:51 +05:30
let(:request_path) { "/projects/#{project.id}/merge_requests/#{merge_request.iid}/notes" }
2022-05-07 20:08:51 +05:30
subject { post api(request_path, user), params: params }
2020-04-22 19:07:51 +05:30
context 'a command only note' do
2022-05-07 20:08:51 +05:30
context '/spend' do
let(:request_body) { "/spend 1h" }
2020-04-22 19:07:51 +05:30
2022-05-07 20:08:51 +05:30
before do
project.add_developer(user)
end
2020-04-22 19:07:51 +05:30
2022-05-07 20:08:51 +05:30
it 'returns 202 Accepted status' do
subject
2020-04-22 19:07:51 +05:30
2022-05-07 20:08:51 +05:30
expect(response).to have_gitlab_http_status(:accepted)
end
2020-04-22 19:07:51 +05:30
2022-05-07 20:08:51 +05:30
it 'does not actually create a new note' do
expect { subject }.not_to change { Note.where(system: false).count }
end
2020-04-22 19:07:51 +05:30
2022-05-07 20:08:51 +05:30
it 'does however create a system note about the change', :sidekiq_inline do
expect { subject }.to change { Note.system.count }.by(1)
end
it 'applies the commands' do
expect { subject }.to change { merge_request.reset.total_time_spent }
end
it 'reports the changes' do
subject
2020-04-22 19:07:51 +05:30
2022-05-07 20:08:51 +05:30
expect(json_response).to include(
'commands_changes' => include(
'spend_time' => include('duration' => 3600)
),
'summary' => include('Added 1h spent time.')
)
end
2020-04-22 19:07:51 +05:30
end
2022-05-07 20:08:51 +05:30
context '/merge' do
let(:request_body) { "/merge" }
let(:project) { create(:project, :public, :repository) }
let(:merge_request) { create(:merge_request_with_multiple_diffs, source_project: project, target_project: project, author: user) }
let(:params) { { body: request_body, merge_request_diff_head_sha: merge_request.diff_head_sha } }
before do
project.add_developer(user)
end
it 'returns 202 Accepted status' do
subject
expect(response).to have_gitlab_http_status(:accepted)
end
it 'does not actually create a new note' do
expect { subject }.not_to change { Note.where(system: false).count }
end
it 'applies the commands' do
expect { subject }.to change { merge_request.reload.merge_jid.present? }.from(false).to(true)
end
2020-04-22 19:07:51 +05:30
2022-05-07 20:08:51 +05:30
it 'reports the changes' do
subject
expect(json_response).to include(
'commands_changes' => include(
'merge' => merge_request.diff_head_sha
),
'summary' => ['Merged this merge request.']
)
end
2020-04-22 19:07:51 +05:30
end
end
2018-03-17 18:26:18 +05:30
context 'when the merge request discussion is locked' do
before do
merge_request.update_attribute(:discussion_locked, true)
end
context 'when a user is a team member' do
it 'returns 200 status' do
subject
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:created)
2018-03-17 18:26:18 +05:30
end
it 'creates a new note' do
expect { subject }.to change { Note.count }.by(1)
end
end
context 'when a user is not a team member' do
2019-02-15 15:39:39 +05:30
subject { post api("/projects/#{project.id}/merge_requests/#{merge_request.iid}/notes", private_user), params: { body: 'Hi!' } }
2018-03-17 18:26:18 +05:30
it 'returns 403 status' do
subject
2020-04-08 14:13:33 +05:30
expect(response).to have_gitlab_http_status(:forbidden)
2018-03-17 18:26:18 +05:30
end
it 'does not create a new note' do
expect { subject }.not_to change { Note.count }
end
end
end
2014-09-02 18:07:02 +05:30
end
end