2015-12-23 02:04:40 +05:30
|
|
|
require 'spec_helper'
|
|
|
|
|
2017-09-10 17:25:29 +05:30
|
|
|
describe Banzai::Filter::IssueReferenceFilter do
|
2015-12-23 02:04:40 +05:30
|
|
|
include FilterSpecHelper
|
|
|
|
|
|
|
|
def helper
|
|
|
|
IssuesHelper
|
|
|
|
end
|
|
|
|
|
2017-09-10 17:25:29 +05:30
|
|
|
let(:project) { create(:project, :public) }
|
2017-08-17 22:00:37 +05:30
|
|
|
let(:issue) { create(:issue, project: project) }
|
2015-12-23 02:04:40 +05:30
|
|
|
|
|
|
|
it 'requires project context' do
|
|
|
|
expect { described_class.call('') }.to raise_error(ArgumentError, /:project/)
|
|
|
|
end
|
|
|
|
|
|
|
|
%w(pre code a style).each do |elem|
|
|
|
|
it "ignores valid references contained inside '#{elem}' element" do
|
|
|
|
exp = act = "<#{elem}>Issue #{issue.to_reference}</#{elem}>"
|
|
|
|
expect(reference_filter(act).to_html).to eq exp
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2017-08-17 22:00:37 +05:30
|
|
|
describe 'performance' do
|
|
|
|
let(:another_issue) { create(:issue, project: project) }
|
2015-12-23 02:04:40 +05:30
|
|
|
|
2017-08-17 22:00:37 +05:30
|
|
|
it 'does not have a N+1 query problem' do
|
|
|
|
single_reference = "Issue #{issue.to_reference}"
|
|
|
|
multiple_references = "Issues #{issue.to_reference} and #{another_issue.to_reference}"
|
2015-12-23 02:04:40 +05:30
|
|
|
|
2017-08-17 22:00:37 +05:30
|
|
|
control_count = ActiveRecord::QueryRecorder.new { reference_filter(single_reference).to_html }.count
|
|
|
|
|
|
|
|
expect { reference_filter(multiple_references).to_html }.not_to exceed_query_limit(control_count)
|
2015-12-23 02:04:40 +05:30
|
|
|
end
|
2017-08-17 22:00:37 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
context 'internal reference' do
|
|
|
|
it_behaves_like 'a reference containing an element node'
|
|
|
|
|
|
|
|
let(:reference) { "##{issue.iid}" }
|
2015-12-23 02:04:40 +05:30
|
|
|
|
|
|
|
it 'links to a valid reference' do
|
|
|
|
doc = reference_filter("Fixed #{reference}")
|
|
|
|
|
2017-09-10 17:25:29 +05:30
|
|
|
expect(doc.css('a').first.attr('href'))
|
|
|
|
.to eq helper.url_for_issue(issue.iid, project)
|
2015-12-23 02:04:40 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
it 'links with adjacent text' do
|
|
|
|
doc = reference_filter("Fixed (#{reference}.)")
|
2017-08-17 22:00:37 +05:30
|
|
|
expect(doc.text).to eql("Fixed (#{reference}.)")
|
2015-12-23 02:04:40 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
it 'ignores invalid issue IDs' do
|
|
|
|
invalid = invalidate_reference(reference)
|
|
|
|
exp = act = "Fixed #{invalid}"
|
|
|
|
|
|
|
|
expect(reference_filter(act).to_html).to eq exp
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'includes a title attribute' do
|
|
|
|
doc = reference_filter("Issue #{reference}")
|
2016-09-29 09:46:39 +05:30
|
|
|
expect(doc.css('a').first.attr('title')).to eq issue.title
|
2015-12-23 02:04:40 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
it 'escapes the title attribute' do
|
|
|
|
issue.update_attribute(:title, %{"></a>whatever<a title="})
|
|
|
|
|
|
|
|
doc = reference_filter("Issue #{reference}")
|
|
|
|
expect(doc.text).to eq "Issue #{reference}"
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'includes default classes' do
|
|
|
|
doc = reference_filter("Issue #{reference}")
|
2016-09-29 09:46:39 +05:30
|
|
|
expect(doc.css('a').first.attr('class')).to eq 'gfm gfm-issue has-tooltip'
|
2015-12-23 02:04:40 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
it 'includes a data-project attribute' do
|
|
|
|
doc = reference_filter("Issue #{reference}")
|
|
|
|
link = doc.css('a').first
|
|
|
|
|
|
|
|
expect(link).to have_attribute('data-project')
|
|
|
|
expect(link.attr('data-project')).to eq project.id.to_s
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'includes a data-issue attribute' do
|
|
|
|
doc = reference_filter("See #{reference}")
|
|
|
|
link = doc.css('a').first
|
|
|
|
|
|
|
|
expect(link).to have_attribute('data-issue')
|
|
|
|
expect(link.attr('data-issue')).to eq issue.id.to_s
|
|
|
|
end
|
|
|
|
|
2017-08-17 22:00:37 +05:30
|
|
|
it 'includes a data-original attribute' do
|
|
|
|
doc = reference_filter("See #{reference}")
|
|
|
|
link = doc.css('a').first
|
|
|
|
|
|
|
|
expect(link).to have_attribute('data-original')
|
|
|
|
expect(link.attr('data-original')).to eq reference
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'does not escape the data-original attribute' do
|
|
|
|
inner_html = 'element <code>node</code> inside'
|
|
|
|
doc = reference_filter(%{<a href="#{reference}">#{inner_html}</a>})
|
|
|
|
expect(doc.children.first.attr('data-original')).to eq inner_html
|
|
|
|
end
|
|
|
|
|
2015-12-23 02:04:40 +05:30
|
|
|
it 'supports an :only_path context' do
|
|
|
|
doc = reference_filter("Issue #{reference}", only_path: true)
|
|
|
|
link = doc.css('a').first.attr('href')
|
|
|
|
|
|
|
|
expect(link).not_to match %r(https?://)
|
|
|
|
expect(link).to eq helper.url_for_issue(issue.iid, project, only_path: true)
|
|
|
|
end
|
|
|
|
|
2016-06-02 11:05:42 +05:30
|
|
|
it 'does not process links containing issue numbers followed by text' do
|
|
|
|
href = "#{reference}st"
|
|
|
|
doc = reference_filter("<a href='#{href}'></a>")
|
|
|
|
link = doc.css('a').first.attr('href')
|
|
|
|
|
|
|
|
expect(link).to eq(href)
|
|
|
|
end
|
2015-12-23 02:04:40 +05:30
|
|
|
end
|
|
|
|
|
2017-08-17 22:00:37 +05:30
|
|
|
context 'cross-project / cross-namespace complete reference' do
|
|
|
|
it_behaves_like 'a reference containing an element node'
|
|
|
|
|
2017-09-10 17:25:29 +05:30
|
|
|
let(:project2) { create(:project, :public) }
|
2017-08-17 22:00:37 +05:30
|
|
|
let(:issue) { create(:issue, project: project2) }
|
2017-09-10 17:25:29 +05:30
|
|
|
let(:reference) { "#{project2.full_path}##{issue.iid}" }
|
2017-08-17 22:00:37 +05:30
|
|
|
|
|
|
|
it 'ignores valid references when cross-reference project uses external tracker' do
|
2017-09-10 17:25:29 +05:30
|
|
|
expect_any_instance_of(described_class).to receive(:find_object)
|
|
|
|
.with(project2, issue.iid)
|
|
|
|
.and_return(nil)
|
2017-08-17 22:00:37 +05:30
|
|
|
|
|
|
|
exp = act = "Issue #{reference}"
|
|
|
|
expect(reference_filter(act).to_html).to eq exp
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'links to a valid reference' do
|
|
|
|
doc = reference_filter("See #{reference}")
|
|
|
|
|
2017-09-10 17:25:29 +05:30
|
|
|
expect(doc.css('a').first.attr('href'))
|
|
|
|
.to eq helper.url_for_issue(issue.iid, project2)
|
2017-08-17 22:00:37 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
it 'link has valid text' do
|
|
|
|
doc = reference_filter("Fixed (#{reference}.)")
|
|
|
|
|
2017-09-10 17:25:29 +05:30
|
|
|
expect(doc.css('a').first.text).to eql("#{project2.full_path}##{issue.iid}")
|
2017-08-17 22:00:37 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
it 'has valid text' do
|
|
|
|
doc = reference_filter("Fixed (#{reference}.)")
|
|
|
|
|
2017-09-10 17:25:29 +05:30
|
|
|
expect(doc.text).to eq("Fixed (#{project2.full_path}##{issue.iid}.)")
|
2017-08-17 22:00:37 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
it 'ignores invalid issue IDs on the referenced project' do
|
|
|
|
exp = act = "Fixed #{invalidate_reference(reference)}"
|
|
|
|
|
|
|
|
expect(reference_filter(act).to_html).to eq exp
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
context 'cross-project / same-namespace complete reference' do
|
|
|
|
it_behaves_like 'a reference containing an element node'
|
|
|
|
|
|
|
|
let(:namespace) { create(:namespace) }
|
2017-09-10 17:25:29 +05:30
|
|
|
let(:project) { create(:project, :public, namespace: namespace) }
|
|
|
|
let(:project2) { create(:project, :public, namespace: namespace) }
|
2015-12-23 02:04:40 +05:30
|
|
|
let(:issue) { create(:issue, project: project2) }
|
2017-09-10 17:25:29 +05:30
|
|
|
let(:reference) { "#{project2.full_path}##{issue.iid}" }
|
2015-12-23 02:04:40 +05:30
|
|
|
|
|
|
|
it 'ignores valid references when cross-reference project uses external tracker' do
|
2017-09-10 17:25:29 +05:30
|
|
|
expect_any_instance_of(described_class).to receive(:find_object)
|
|
|
|
.with(project2, issue.iid)
|
|
|
|
.and_return(nil)
|
2015-12-23 02:04:40 +05:30
|
|
|
|
|
|
|
exp = act = "Issue #{reference}"
|
|
|
|
expect(reference_filter(act).to_html).to eq exp
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'links to a valid reference' do
|
|
|
|
doc = reference_filter("See #{reference}")
|
|
|
|
|
2017-09-10 17:25:29 +05:30
|
|
|
expect(doc.css('a').first.attr('href'))
|
|
|
|
.to eq helper.url_for_issue(issue.iid, project2)
|
2015-12-23 02:04:40 +05:30
|
|
|
end
|
|
|
|
|
2017-08-17 22:00:37 +05:30
|
|
|
it 'link has valid text' do
|
|
|
|
doc = reference_filter("Fixed (#{reference}.)")
|
|
|
|
|
|
|
|
expect(doc.css('a').first.text).to eql("#{project2.path}##{issue.iid}")
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'has valid text' do
|
2015-12-23 02:04:40 +05:30
|
|
|
doc = reference_filter("Fixed (#{reference}.)")
|
2017-08-17 22:00:37 +05:30
|
|
|
|
|
|
|
expect(doc.text).to eq("Fixed (#{project2.path}##{issue.iid}.)")
|
2015-12-23 02:04:40 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
it 'ignores invalid issue IDs on the referenced project' do
|
|
|
|
exp = act = "Fixed #{invalidate_reference(reference)}"
|
|
|
|
|
|
|
|
expect(reference_filter(act).to_html).to eq exp
|
|
|
|
end
|
2017-08-17 22:00:37 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
context 'cross-project shorthand reference' do
|
|
|
|
it_behaves_like 'a reference containing an element node'
|
|
|
|
|
|
|
|
let(:namespace) { create(:namespace) }
|
2017-09-10 17:25:29 +05:30
|
|
|
let(:project) { create(:project, :public, namespace: namespace) }
|
|
|
|
let(:project2) { create(:project, :public, namespace: namespace) }
|
2017-08-17 22:00:37 +05:30
|
|
|
let(:issue) { create(:issue, project: project2) }
|
|
|
|
let(:reference) { "#{project2.path}##{issue.iid}" }
|
|
|
|
|
|
|
|
it 'ignores valid references when cross-reference project uses external tracker' do
|
2017-09-10 17:25:29 +05:30
|
|
|
expect_any_instance_of(described_class).to receive(:find_object)
|
|
|
|
.with(project2, issue.iid)
|
|
|
|
.and_return(nil)
|
2017-08-17 22:00:37 +05:30
|
|
|
|
|
|
|
exp = act = "Issue #{reference}"
|
|
|
|
expect(reference_filter(act).to_html).to eq exp
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'links to a valid reference' do
|
|
|
|
doc = reference_filter("See #{reference}")
|
|
|
|
|
2017-09-10 17:25:29 +05:30
|
|
|
expect(doc.css('a').first.attr('href'))
|
|
|
|
.to eq helper.url_for_issue(issue.iid, project2)
|
2017-08-17 22:00:37 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
it 'link has valid text' do
|
|
|
|
doc = reference_filter("Fixed (#{reference}.)")
|
|
|
|
|
|
|
|
expect(doc.css('a').first.text).to eql("#{project2.path}##{issue.iid}")
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'has valid text' do
|
|
|
|
doc = reference_filter("Fixed (#{reference}.)")
|
2016-06-22 15:30:34 +05:30
|
|
|
|
2017-08-17 22:00:37 +05:30
|
|
|
expect(doc.text).to eq("Fixed (#{project2.path}##{issue.iid}.)")
|
|
|
|
end
|
|
|
|
|
|
|
|
it 'ignores invalid issue IDs on the referenced project' do
|
|
|
|
exp = act = "Fixed #{invalidate_reference(reference)}"
|
2016-06-22 15:30:34 +05:30
|
|
|
|
|
|
|
expect(reference_filter(act).to_html).to eq exp
|
|
|
|
end
|
2015-12-23 02:04:40 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
context 'cross-project URL reference' do
|
2017-08-17 22:00:37 +05:30
|
|
|
it_behaves_like 'a reference containing an element node'
|
|
|
|
|
2015-12-23 02:04:40 +05:30
|
|
|
let(:namespace) { create(:namespace, name: 'cross-reference') }
|
2017-09-10 17:25:29 +05:30
|
|
|
let(:project2) { create(:project, :public, namespace: namespace) }
|
2015-12-23 02:04:40 +05:30
|
|
|
let(:issue) { create(:issue, project: project2) }
|
|
|
|
let(:reference) { helper.url_for_issue(issue.iid, project2) + "#note_123" }
|
|
|
|
|
|
|
|
it 'links to a valid reference' do
|
|
|
|
doc = reference_filter("See #{reference}")
|
|
|
|
|
2017-09-10 17:25:29 +05:30
|
|
|
expect(doc.css('a').first.attr('href'))
|
|
|
|
.to eq reference
|
2015-12-23 02:04:40 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
it 'links with adjacent text' do
|
|
|
|
doc = reference_filter("Fixed (#{reference}.)")
|
|
|
|
expect(doc.to_html).to match(/\(<a.+>#{Regexp.escape(issue.to_reference(project))} \(comment 123\)<\/a>\.\)/)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
context 'cross-project reference in link href' do
|
2017-08-17 22:00:37 +05:30
|
|
|
it_behaves_like 'a reference containing an element node'
|
|
|
|
|
2015-12-23 02:04:40 +05:30
|
|
|
let(:namespace) { create(:namespace, name: 'cross-reference') }
|
2017-09-10 17:25:29 +05:30
|
|
|
let(:project2) { create(:project, :public, namespace: namespace) }
|
2015-12-23 02:04:40 +05:30
|
|
|
let(:issue) { create(:issue, project: project2) }
|
2017-08-17 22:00:37 +05:30
|
|
|
let(:reference) { issue.to_reference(project) }
|
|
|
|
let(:reference_link) { %{<a href="#{reference}">Reference</a>} }
|
2015-12-23 02:04:40 +05:30
|
|
|
|
|
|
|
it 'links to a valid reference' do
|
2017-08-17 22:00:37 +05:30
|
|
|
doc = reference_filter("See #{reference_link}")
|
2015-12-23 02:04:40 +05:30
|
|
|
|
2017-09-10 17:25:29 +05:30
|
|
|
expect(doc.css('a').first.attr('href'))
|
|
|
|
.to eq helper.url_for_issue(issue.iid, project2)
|
2015-12-23 02:04:40 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
it 'links with adjacent text' do
|
2017-08-17 22:00:37 +05:30
|
|
|
doc = reference_filter("Fixed (#{reference_link}.)")
|
2015-12-23 02:04:40 +05:30
|
|
|
expect(doc.to_html).to match(/\(<a.+>Reference<\/a>\.\)/)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
context 'cross-project URL in link href' do
|
2017-08-17 22:00:37 +05:30
|
|
|
it_behaves_like 'a reference containing an element node'
|
|
|
|
|
2015-12-23 02:04:40 +05:30
|
|
|
let(:namespace) { create(:namespace, name: 'cross-reference') }
|
2017-09-10 17:25:29 +05:30
|
|
|
let(:project2) { create(:project, :public, namespace: namespace) }
|
2015-12-23 02:04:40 +05:30
|
|
|
let(:issue) { create(:issue, project: project2) }
|
2017-08-17 22:00:37 +05:30
|
|
|
let(:reference) { "#{helper.url_for_issue(issue.iid, project2) + "#note_123"}" }
|
|
|
|
let(:reference_link) { %{<a href="#{reference}">Reference</a>} }
|
2015-12-23 02:04:40 +05:30
|
|
|
|
|
|
|
it 'links to a valid reference' do
|
2017-08-17 22:00:37 +05:30
|
|
|
doc = reference_filter("See #{reference_link}")
|
2015-12-23 02:04:40 +05:30
|
|
|
|
2017-09-10 17:25:29 +05:30
|
|
|
expect(doc.css('a').first.attr('href'))
|
|
|
|
.to eq helper.url_for_issue(issue.iid, project2) + "#note_123"
|
2015-12-23 02:04:40 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
it 'links with adjacent text' do
|
2017-08-17 22:00:37 +05:30
|
|
|
doc = reference_filter("Fixed (#{reference_link}.)")
|
2015-12-23 02:04:40 +05:30
|
|
|
expect(doc.to_html).to match(/\(<a.+>Reference<\/a>\.\)/)
|
|
|
|
end
|
|
|
|
end
|
2016-08-24 12:49:21 +05:30
|
|
|
|
2017-08-17 22:00:37 +05:30
|
|
|
describe '#issues_per_project' do
|
2016-08-24 12:49:21 +05:30
|
|
|
context 'using an internal issue tracker' do
|
|
|
|
it 'returns a Hash containing the issues per project' do
|
|
|
|
doc = Nokogiri::HTML.fragment('')
|
|
|
|
filter = described_class.new(doc, project: project)
|
|
|
|
|
2017-09-10 17:25:29 +05:30
|
|
|
expect(filter).to receive(:projects_per_reference)
|
|
|
|
.and_return({ project.full_path => project })
|
2016-08-24 12:49:21 +05:30
|
|
|
|
2017-09-10 17:25:29 +05:30
|
|
|
expect(filter).to receive(:references_per_project)
|
|
|
|
.and_return({ project.full_path => Set.new([issue.iid]) })
|
2016-08-24 12:49:21 +05:30
|
|
|
|
2017-09-10 17:25:29 +05:30
|
|
|
expect(filter.issues_per_project)
|
|
|
|
.to eq({ project => { issue.iid => issue } })
|
2016-08-24 12:49:21 +05:30
|
|
|
end
|
|
|
|
end
|
2017-08-17 22:00:37 +05:30
|
|
|
end
|
2016-08-24 12:49:21 +05:30
|
|
|
|
2017-08-17 22:00:37 +05:30
|
|
|
describe '.references_in' do
|
|
|
|
let(:merge_request) { create(:merge_request) }
|
2016-08-24 12:49:21 +05:30
|
|
|
|
2017-08-17 22:00:37 +05:30
|
|
|
it 'yields valid references' do
|
|
|
|
expect do |b|
|
|
|
|
described_class.references_in(issue.to_reference, &b)
|
|
|
|
end.to yield_with_args(issue.to_reference, issue.iid, nil, nil, MatchData)
|
|
|
|
end
|
2016-08-24 12:49:21 +05:30
|
|
|
|
2017-08-17 22:00:37 +05:30
|
|
|
it "doesn't yield invalid references" do
|
|
|
|
expect do |b|
|
|
|
|
described_class.references_in('#0', &b)
|
|
|
|
end.not_to yield_control
|
|
|
|
end
|
2016-08-24 12:49:21 +05:30
|
|
|
|
2017-08-17 22:00:37 +05:30
|
|
|
it "doesn't yield unsupported references" do
|
|
|
|
expect do |b|
|
|
|
|
described_class.references_in(merge_request.to_reference, &b)
|
|
|
|
end.not_to yield_control
|
2016-08-24 12:49:21 +05:30
|
|
|
end
|
|
|
|
end
|
2015-12-23 02:04:40 +05:30
|
|
|
end
|