1 files changed, 257 insertions, 0 deletions
diff --git a/spec/lib/banzai/filter/references/external_issue_reference_filter_spec.rb b/spec/lib/banzai/filter/references/external_issue_reference_filter_spec.rb
new file mode 100644
index 00000000000..3b274f98020
--- /dev/null
+++ b/spec/lib/banzai/filter/references/external_issue_reference_filter_spec.rb
@@ -0,0 +1,257 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+RSpec.describe Banzai::Filter::References::ExternalIssueReferenceFilter do
+  include FilterSpecHelper
+
+  let_it_be_with_refind(:project) { create(:project) }
+
+  shared_examples_for "external issue tracker" do
+    it_behaves_like 'a reference containing an element node'
+
+    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 #{reference}</#{elem}>"
+
+        expect(filter(act).to_html).to eq exp
+      end
+    end
+
+    it 'ignores valid references when using default tracker' do
+      expect(project).to receive(:default_issues_tracker?).and_return(true)
+
+      exp = act = "Issue #{reference}"
+      expect(filter(act).to_html).to eq exp
+    end
+
+    it 'links to a valid reference' do
+      doc = filter("Issue #{reference}")
+      issue_id = doc.css('a').first.attr("data-external-issue")
+
+      expect(doc.css('a').first.attr('href'))
+        .to eq project.external_issue_tracker.issue_url(issue_id)
+    end
+
+    it 'links to the external tracker' do
+      doc = filter("Issue #{reference}")
+
+      link = doc.css('a').first.attr('href')
+      issue_id = doc.css('a').first.attr("data-external-issue")
+
+      expect(link).to eq(project.external_issue_tracker.issue_url(issue_id))
+    end
+
+    it 'links with adjacent text' do
+      doc = filter("Issue (#{reference}.)")
+
+      expect(doc.to_html).to match(%r{\(<a.+>#{reference}</a>\.\)})
+    end
+
+    it 'includes a title attribute' do
+      doc = filter("Issue #{reference}")
+      expect(doc.css('a').first.attr('title')).to include("Issue in #{project.external_issue_tracker.title}")
+    end
+
+    it 'escapes the title attribute' do
+      allow(project.external_issue_tracker).to receive(:title)
+        .and_return(%{"></a>whatever<a title="})
+
+      doc = filter("Issue #{reference}")
+      expect(doc.text).to eq "Issue #{reference}"
+    end
+
+    it 'includes default classes' do
+      doc = filter("Issue #{reference}")
+      expect(doc.css('a').first.attr('class')).to eq 'gfm gfm-issue has-tooltip'
+    end
+
+    it 'supports an :only_path context' do
+      doc = filter("Issue #{reference}", only_path: true)
+
+      link = doc.css('a').first.attr('href')
+      issue_id = doc.css('a').first["data-external-issue"]
+
+      expect(link).to eq project.external_issue_tracker.issue_path(issue_id)
+    end
+
+    it 'has an empty link if issue_url is invalid' do
+      expect_any_instance_of(project.external_issue_tracker.class).to receive(:issue_url) { 'javascript:alert("foo");' }
+
+      doc = filter("Issue #{reference}")
+      link = doc.css('a').first.attr('href')
+
+      expect(link).to eq ''
+    end
+
+    it 'has an empty link if issue_path is invalid' do
+      expect_any_instance_of(project.external_issue_tracker.class).to receive(:issue_path) { 'javascript:alert("foo");' }
+
+      doc = filter("Issue #{reference}", only_path: true)
+      link = doc.css('a').first.attr('href')
+
+      expect(link).to eq ''
+    end
+
+    context 'with RequestStore enabled', :request_store do
+      let(:reference_filter) { HTML::Pipeline.new([described_class]) }
+
+      it 'queries the collection on the first call' do
+        expect_any_instance_of(Project).to receive(:default_issues_tracker?).once.and_call_original
+        expect_any_instance_of(Project).to receive(:external_issue_reference_pattern).once.and_call_original
+
+        not_cached = reference_filter.call("look for #{reference}", { project: project })
+
+        expect_any_instance_of(Project).not_to receive(:default_issues_tracker?)
+        expect_any_instance_of(Project).not_to receive(:external_issue_reference_pattern)
+
+        cached = reference_filter.call("look for #{reference}", { project: project })
+
+        # Links must be the same
+        expect(cached[:output].css('a').first[:href]).to eq(not_cached[:output].css('a').first[:href])
+      end
+    end
+  end
+
+  context "redmine project" do
+    let_it_be(:service) { create(:redmine_service, project: project) }
+
+    before do
+      project.update!(issues_enabled: false)
+    end
+
+    context "with a hash prefix" do
+      let(:issue) { ExternalIssue.new("#123", project) }
+      let(:reference) { issue.to_reference }
+
+      it_behaves_like "external issue tracker"
+    end
+
+    context "with a single-letter prefix" do
+      let(:issue) { ExternalIssue.new("T-123", project) }
+      let(:reference) { issue.to_reference }
+
+      it_behaves_like "external issue tracker"
+    end
+  end
+
+  context "youtrack project" do
+    let_it_be(:service) { create(:youtrack_service, project: project) }
+
+    before do
+      project.update!(issues_enabled: false)
+    end
+
+    context "with right markdown" do
+      let(:issue) { ExternalIssue.new("YT-123", project) }
+      let(:reference) { issue.to_reference }
+
+      it_behaves_like "external issue tracker"
+    end
+
+    context "with underscores in the prefix" do
+      let(:issue) { ExternalIssue.new("PRJ_1-123", project) }
+      let(:reference) { issue.to_reference }
+
+      it_behaves_like "external issue tracker"
+    end
+
+    context "with lowercase letters in the prefix" do
+      let(:issue) { ExternalIssue.new("YTkPrj-123", project) }
+      let(:reference) { issue.to_reference }
+
+      it_behaves_like "external issue tracker"
+    end
+
+    context "with a single-letter prefix" do
+      let(:issue) { ExternalIssue.new("T-123", project) }
+      let(:reference) { issue.to_reference }
+
+      it_behaves_like "external issue tracker"
+    end
+
+    context "with a lowercase prefix" do
+      let(:issue) { ExternalIssue.new("gl-030", project) }
+      let(:reference) { issue.to_reference }
+
+      it_behaves_like "external issue tracker"
+    end
+  end
+
+  context "jira project" do
+    let_it_be(:service) { create(:jira_service, project: project) }
+
+    let(:reference) { issue.to_reference }
+
+    context "with right markdown" do
+      let(:issue) { ExternalIssue.new("JIRA-123", project) }
+
+      it_behaves_like "external issue tracker"
+    end
+
+    context "with a single-letter prefix" do
+      let(:issue) { ExternalIssue.new("J-123", project) }
+
+      it "ignores reference" do
+        exp = act = "Issue #{reference}"
+        expect(filter(act).to_html).to eq exp
+      end
+    end
+
+    context "with wrong markdown" do
+      let(:issue) { ExternalIssue.new("#123", project) }
+
+      it "ignores reference" do
+        exp = act = "Issue #{reference}"
+        expect(filter(act).to_html).to eq exp
+      end
+    end
+  end
+
+  context "ewm project" do
+    let_it_be(:service) { create(:ewm_service, project: project) }
+
+    before do
+      project.update!(issues_enabled: false)
+    end
+
+    context "rtcwi keyword" do
+      let(:issue) { ExternalIssue.new("rtcwi 123", project) }
+      let(:reference) { issue.to_reference }
+
+      it_behaves_like "external issue tracker"
+    end
+
+    context "workitem keyword" do
+      let(:issue) { ExternalIssue.new("workitem 123", project) }
+      let(:reference) { issue.to_reference }
+
+      it_behaves_like "external issue tracker"
+    end
+
+    context "defect keyword" do
+      let(:issue) { ExternalIssue.new("defect 123", project) }
+      let(:reference) { issue.to_reference }
+
+      it_behaves_like "external issue tracker"
+    end
+
+    context "task keyword" do
+      let(:issue) { ExternalIssue.new("task 123", project) }
+      let(:reference) { issue.to_reference }
+
+      it_behaves_like "external issue tracker"
+    end
+
+    context "bug keyword" do
+      let(:issue) { ExternalIssue.new("bug 123", project) }
+      let(:reference) { issue.to_reference }
+
+      it_behaves_like "external issue tracker"
+    end
+  end
+end