summaryrefslogtreecommitdiff
path: root/spec/lib/gitlab/markdown/issue_reference_filter_spec.rb
blob: dee0826336bc8e61e87ae425d2e326f8ce0ce047 (plain)
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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
require 'spec_helper'

module Gitlab::Markdown
  describe IssueReferenceFilter, lib: true do
    include FilterSpecHelper

    def helper
      IssuesHelper
    end

    let(:project) { create(:empty_project, :public) }
    let(:issue)   { create(:issue, project: project) }

    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

    context 'internal reference' do
      let(:reference) { issue.to_reference }

      it 'ignores valid references when using non-default tracker' do
        expect(project).to receive(:get_issue).with(issue.iid).and_return(nil)

        exp = act = "Issue #{reference}"
        expect(reference_filter(act).to_html).to eq exp
      end

      it 'links to a valid reference' do
        doc = reference_filter("Fixed #{reference}")

        expect(doc.css('a').first.attr('href')).
          to eq helper.url_for_issue(issue.iid, project)
      end

      it 'links with adjacent text' do
        doc = reference_filter("Fixed (#{reference}.)")
        expect(doc.to_html).to match(/\(<a.+>#{Regexp.escape(reference)}<\/a>\.\)/)
      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}")
        expect(doc.css('a').first.attr('title')).to eq "Issue: #{issue.title}"
      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}")
        expect(doc.css('a').first.attr('class')).to eq 'gfm gfm-issue'
      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

      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

      it 'adds to the results hash' do
        result = reference_pipeline_result("Fixed #{reference}")
        expect(result[:references][:issue]).to eq [issue]
      end
    end

    context 'cross-project reference' do
      let(:namespace) { create(:namespace, name: 'cross-reference') }
      let(:project2)  { create(:empty_project, :public, namespace: namespace) }
      let(:issue)     { create(:issue, project: project2) }
      let(:reference) { issue.to_reference(project) }

      it 'ignores valid references when cross-reference project uses external tracker' do
        expect_any_instance_of(Project).to receive(:get_issue).
          with(issue.iid).and_return(nil)

        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}")

        expect(doc.css('a').first.attr('href')).
          to eq helper.url_for_issue(issue.iid, project2)
      end

      it 'links with adjacent text' do
        doc = reference_filter("Fixed (#{reference}.)")
        expect(doc.to_html).to match(/\(<a.+>#{Regexp.escape(reference)}<\/a>\.\)/)
      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

      it 'adds to the results hash' do
        result = reference_pipeline_result("Fixed #{reference}")
        expect(result[:references][:issue]).to eq [issue]
      end
    end

    context 'cross-project URL reference' do
      let(:namespace) { create(:namespace, name: 'cross-reference') }
      let(:project2)  { create(:empty_project, :public, namespace: namespace) }
      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}")

        expect(doc.css('a').first.attr('href')).
          to eq reference
      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

      it 'adds to the results hash' do
        result = reference_pipeline_result("Fixed #{reference}")
        expect(result[:references][:issue]).to eq [issue]
      end
    end

    context 'cross-project reference in link href' do
      let(:namespace) { create(:namespace, name: 'cross-reference') }
      let(:project2)  { create(:empty_project, :public, namespace: namespace) }
      let(:issue)     { create(:issue, project: project2) }
      let(:reference) { %Q{<a href="#{issue.to_reference(project)}">Reference</a>} }

      it 'links to a valid reference' do
        doc = reference_filter("See #{reference}")

        expect(doc.css('a').first.attr('href')).
          to eq helper.url_for_issue(issue.iid, project2)
      end

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

      it 'adds to the results hash' do
        result = reference_pipeline_result("Fixed #{reference}")
        expect(result[:references][:issue]).to eq [issue]
      end
    end

    context 'cross-project URL in link href' do
      let(:namespace) { create(:namespace, name: 'cross-reference') }
      let(:project2)  { create(:empty_project, :public, namespace: namespace) }
      let(:issue)     { create(:issue, project: project2) }
      let(:reference) { %Q{<a href="#{helper.url_for_issue(issue.iid, project2) + "#note_123"}">Reference</a>} }

      it 'links to a valid reference' do
        doc = reference_filter("See #{reference}")

        expect(doc.css('a').first.attr('href')).
          to eq helper.url_for_issue(issue.iid, project2) + "#note_123"
      end

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

      it 'adds to the results hash' do
        result = reference_pipeline_result("Fixed #{reference}")
        expect(result[:references][:issue]).to eq [issue]
      end
    end
  end
end