debian-mirror-gitlab/spec/services/preview_markdown_service_spec.rb

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

223 lines
5.8 KiB
Ruby
Raw Normal View History

2019-07-31 22:56:46 +05:30
# frozen_string_literal: true
2017-08-17 22:00:37 +05:30
require 'spec_helper'
2023-05-27 22:25:52 +05:30
RSpec.describe PreviewMarkdownService, feature_category: :team_planning do
2017-08-17 22:00:37 +05:30
let(:user) { create(:user) }
2019-07-07 11:18:12 +05:30
let(:project) { create(:project, :repository) }
2017-08-17 22:00:37 +05:30
before do
project.add_developer(user)
end
describe 'user references' do
let(:params) { { text: "Take a look #{user.to_reference}" } }
let(:service) { described_class.new(project, user, params) }
it 'returns users referenced in text' do
result = service.execute
expect(result[:users]).to eq [user.username]
end
end
2019-02-15 15:39:39 +05:30
describe 'suggestions' do
2019-07-07 11:18:12 +05:30
let(:merge_request) do
create(:merge_request, target_project: project, source_project: project)
end
2020-10-24 23:57:45 +05:30
2019-07-07 11:18:12 +05:30
let(:text) { "```suggestion\nfoo\n```" }
let(:params) do
suggestion_params.merge(text: text,
target_type: 'MergeRequest',
target_id: merge_request.iid)
end
2020-10-24 23:57:45 +05:30
2019-02-15 15:39:39 +05:30
let(:service) { described_class.new(project, user, params) }
context 'when preview markdown param is present' do
2019-07-07 11:18:12 +05:30
let(:path) { "files/ruby/popen.rb" }
let(:line) { 10 }
let(:diff_refs) { merge_request.diff_refs }
let(:suggestion_params) do
{
preview_suggestions: true,
file_path: path,
line: line,
base_sha: diff_refs.base_sha,
start_sha: diff_refs.start_sha,
head_sha: diff_refs.head_sha
}
end
it 'returns suggestions referenced in text' do
position = Gitlab::Diff::Position.new(new_path: path,
new_line: line,
diff_refs: diff_refs)
expect(Gitlab::Diff::SuggestionsParser)
.to receive(:parse)
2019-09-04 21:01:54 +05:30
.with(text, position: position,
project: merge_request.project,
supports_suggestion: true)
2019-07-07 11:18:12 +05:30
.and_call_original
2019-02-15 15:39:39 +05:30
result = service.execute
2019-07-07 11:18:12 +05:30
expect(result[:suggestions]).to all(be_a(Gitlab::Diff::Suggestion))
end
context 'when user is not authorized' do
let(:another_user) { create(:user) }
let(:service) { described_class.new(project, another_user, params) }
before do
project.add_guest(another_user)
end
it 'returns no suggestions' do
result = service.execute
expect(result[:suggestions]).to be_empty
end
2019-02-15 15:39:39 +05:30
end
end
context 'when preview markdown param is not present' do
2019-07-07 11:18:12 +05:30
let(:suggestion_params) do
{
preview_suggestions: false
}
end
2019-02-15 15:39:39 +05:30
2019-07-07 11:18:12 +05:30
it 'returns suggestions referenced in text' do
2019-02-15 15:39:39 +05:30
result = service.execute
expect(result[:suggestions]).to eq([])
end
end
end
2017-09-10 17:25:29 +05:30
context 'new note with quick actions' do
2017-08-17 22:00:37 +05:30
let(:issue) { create(:issue, project: project) }
let(:params) do
{
text: "Please do it\n/assign #{user.to_reference}",
2019-07-07 11:18:12 +05:30
target_type: 'Issue',
target_id: issue.id
2017-08-17 22:00:37 +05:30
}
end
2020-10-24 23:57:45 +05:30
2017-08-17 22:00:37 +05:30
let(:service) { described_class.new(project, user, params) }
2017-09-10 17:25:29 +05:30
it 'removes quick actions from text' do
2017-08-17 22:00:37 +05:30
result = service.execute
expect(result[:text]).to eq 'Please do it'
end
2023-07-09 08:55:56 +05:30
context 'when render_quick_actions' do
it 'keeps quick actions' do
params[:render_quick_actions] = true
result = service.execute
expect(result[:text]).to eq "Please do it\n\n/assign #{user.to_reference}"
end
end
2017-09-10 17:25:29 +05:30
it 'explains quick actions effect' do
2017-08-17 22:00:37 +05:30
result = service.execute
expect(result[:commands]).to eq "Assigns #{user.to_reference}."
end
end
context 'merge request description' do
let(:params) do
{
text: "My work\n/estimate 2y",
2019-07-07 11:18:12 +05:30
target_type: 'MergeRequest'
2017-08-17 22:00:37 +05:30
}
end
2020-10-24 23:57:45 +05:30
2017-08-17 22:00:37 +05:30
let(:service) { described_class.new(project, user, params) }
2017-09-10 17:25:29 +05:30
it 'removes quick actions from text' do
2017-08-17 22:00:37 +05:30
result = service.execute
expect(result[:text]).to eq 'My work'
end
2017-09-10 17:25:29 +05:30
it 'explains quick actions effect' do
2017-08-17 22:00:37 +05:30
result = service.execute
expect(result[:commands]).to eq 'Sets time estimate to 2y.'
2017-09-10 17:25:29 +05:30
end
2017-08-17 22:00:37 +05:30
end
2018-11-08 19:23:39 +05:30
2018-11-20 20:47:30 +05:30
context 'commit description' do
let(:project) { create(:project, :repository) }
let(:commit) { project.commit }
let(:params) do
{
text: "My work\n/tag v1.2.3 Stable release",
2019-07-07 11:18:12 +05:30
target_type: 'Commit',
target_id: commit.id
2018-11-20 20:47:30 +05:30
}
end
2020-10-24 23:57:45 +05:30
2018-11-20 20:47:30 +05:30
let(:service) { described_class.new(project, user, params) }
it 'removes quick actions from text' do
result = service.execute
expect(result[:text]).to eq 'My work'
end
it 'explains quick actions effect' do
result = service.execute
expect(result[:commands]).to eq 'Tags this commit to v1.2.3 with "Stable release".'
end
end
2022-08-13 15:12:31 +05:30
context 'note with multiple quick actions' do
let(:issue) { create(:issue, project: project) }
let(:params) do
{
text: "/confidential\n/due 2001-12-31\n/estimate 2y\n/assign #{user.to_reference}",
target_type: 'Issue',
target_id: issue.id
}
end
let(:service) { described_class.new(project, user, params) }
it 'renders quick actions on multiple lines' do
result = service.execute
expect(result[:commands]).to eq "Makes this issue confidential.<br>Sets the due date to Dec 31, 2001.<br>" \
"Sets time estimate to 2y.<br>Assigns #{user.to_reference}."
end
end
2023-04-23 21:23:45 +05:30
context 'work item quick action types' do
let(:work_item) { create(:work_item, :task, project: project) }
let(:params) do
{
text: "/title new title",
target_type: 'WorkItem',
target_id: work_item.iid
}
end
let(:result) { described_class.new(project, user, params).execute }
it 'renders the quick action preview' do
expect(result[:commands]).to eq "Changes the title to \"new title\"."
end
end
2017-08-17 22:00:37 +05:30
end