spec/lib/gitlab/markdown/external_issue_reference_filter_spec.rb


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

require 'spec_helper'

module Gitlab::Markdown
  describe ExternalIssueReferenceFilter do
    include FilterSpecHelper

    def helper
      IssuesHelper
    end

    let(:project) { create(:jira_project) }

    context 'JIRA issue references' do
      let(:issue)     { ExternalIssue.new('JIRA-123', project) }
      let(:reference) { issue.to_reference }

      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}")
        expect(doc.css('a').first.attr('href'))
          .to eq helper.url_for_issue(reference, project)
      end

      it 'links to the external tracker' do
        doc = filter("Issue #{reference}")
        link = doc.css('a').first.attr('href')

        expect(link).to eq "http://jira.example/browse/#{reference}"
      end

      it 'links with adjacent text' do
        doc = filter("Issue (#{reference}.)")
        expect(doc.to_html).to match(/\(<a.+>#{reference}<\/a>\.\)/)
      end

      it 'includes a title attribute' do
        doc = filter("Issue #{reference}")
        expect(doc.css('a').first.attr('title')).to eq "Issue in JIRA tracker"
      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'
      end

      it 'includes an optional custom class' do
        doc = filter("Issue #{reference}", reference_class: 'custom')
        expect(doc.css('a').first.attr('class')).to include 'custom'
      end

      it 'supports an :only_path context' do
        doc = filter("Issue #{reference}", only_path: true)
        link = doc.css('a').first.attr('href')

        expect(link).to eq helper.url_for_issue("#{reference}", project, only_path: true)
      end
    end
  end
end