File: markdown_formatter_test.rb

package info (click to toggle)
redmine 5.0.4-5%2Bdeb12u1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 21,152 kB
  • sloc: ruby: 111,982; javascript: 26,379; sh: 458; perl: 303; python: 166; makefile: 36
file content (354 lines) | stat: -rw-r--r-- 9,846 bytes parent folder | download
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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
# frozen_string_literal: true

# Redmine - project management software
# Copyright (C) 2006-2022  Jean-Philippe Lang
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.

require File.expand_path('../../../../../test_helper', __FILE__)

class Redmine::WikiFormatting::MarkdownFormatterTest < ActionView::TestCase
  def setup
    unless Object.const_defined?(:Redcarpet)
      skip "Redcarpet is not installed"
    end
    @formatter = Redmine::WikiFormatting::Markdown::Formatter
  end

  def test_syntax_error_in_image_reference_should_not_raise_exception
    assert @formatter.new("!>[](foo.png)").to_html
  end

  def test_empty_image_should_not_raise_exception
    assert @formatter.new("![]()").to_html
  end

  # re-using the formatter after getting above error crashes the
  # ruby interpreter. This seems to be related to
  # https://github.com/vmg/redcarpet/issues/318
  def test_should_not_crash_redcarpet_after_syntax_error
    @formatter.new("!>[](foo.png)").to_html rescue nil
    assert @formatter.new("![](foo.png)").to_html.present?
  end

  def test_inline_style
    assert_equal "<p><strong>foo</strong></p>", @formatter.new("**foo**").to_html.strip
  end

  def test_not_set_intra_emphasis
    assert_equal "<p>foo_bar_baz</p>", @formatter.new("foo_bar_baz").to_html.strip
  end

  def test_wiki_links_should_be_preserved
    text = 'This is a wiki link: [[Foo]]'
    assert_include '[[Foo]]', @formatter.new(text).to_html
  end

  def test_redmine_links_with_double_quotes_should_be_preserved
    text = 'This is a redmine link: version:"1.0"'
    assert_include 'version:"1.0"', @formatter.new(text).to_html
  end

  def test_should_support_syntax_highlight
    text = <<~STR
      ~~~ruby
      def foo
      end
      ~~~
    STR
    assert_select_in @formatter.new(text).to_html, 'pre code.ruby.syntaxhl' do
      assert_select 'span.k', :text => 'def'
      assert_select "[data-language='ruby']"
    end
  end

  def test_should_not_allow_invalid_language_for_code_blocks
    text = <<~STR
      ~~~foo
      test
      ~~~
    STR
    assert_equal "<pre><code data-language=\"foo\">test\n</code></pre>", @formatter.new(text).to_html
  end

  def test_should_preserve_code_block_language_in_data_language
    text = <<~STR
      ~~~c-k&r
      test
      ~~~
    STR
    assert_equal "<pre><code data-language=\"c-k&amp;r\">test\n</code></pre>", @formatter.new(text).to_html
  end

  def test_external_links_should_have_external_css_class
    text = 'This is a [link](http://example.net/)'
    assert_equal '<p>This is a <a href="http://example.net/" class="external">link</a></p>', @formatter.new(text).to_html.strip
  end

  def test_locals_links_should_not_have_external_css_class
    text = 'This is a [link](/issues)'
    assert_equal '<p>This is a <a href="/issues">link</a></p>', @formatter.new(text).to_html.strip
  end

  def test_markdown_should_not_require_surrounded_empty_line
    text = <<~STR
      This is a list:
      * One
      * Two
    STR
    assert_equal "<p>This is a list:</p>\n\n<ul>\n<li>One</li>\n<li>Two</li>\n</ul>", @formatter.new(text).to_html.strip
  end

  def test_footnotes
    text = <<~STR
      This is some text[^1].

      [^1]: This is the foot note
    STR
    expected = <<~EXPECTED
      <p>This is some text<sup id="fnref1"><a href="#fn1">1</a></sup>.</p>
      <div class="footnotes">
      <hr>
      <ol>

      <li id="fn1">
      <p>This is the foot note&nbsp;<a href="#fnref1">&#8617;</a></p>
      </li>

      </ol>
      </div>
    EXPECTED
    assert_equal expected.gsub(%r{[\r\n\t]}, ''), @formatter.new(text).to_html.gsub(%r{[\r\n\t]}, '')
  end

  STR_WITH_PRE = [
    # 0
    <<~STR.chomp,
      # Title

      Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Maecenas sed libero.
    STR
    # 1
    <<~STR.chomp,
      ## Heading 2

      ~~~ruby
        def foo
        end
      ~~~

      Morbi facilisis accumsan orci non pharetra.

      ~~~ ruby
      def foo
      end
      ~~~

      ```
      Pre Content:

      ## Inside pre

      <tag> inside pre block

      Morbi facilisis accumsan orci non pharetra.
      ```
    STR
    # 2
    <<~STR.chomp,
      ### Heading 3

      Nulla nunc nisi, egestas in ornare vel, posuere ac libero.
    STR
  ]

  def test_get_section_should_ignore_pre_content
    text = STR_WITH_PRE.join("\n\n")

    assert_section_with_hash STR_WITH_PRE[1..2].join("\n\n"), text, 2
    assert_section_with_hash STR_WITH_PRE[2], text, 3
  end

  def test_update_section_should_not_escape_pre_content_outside_section
    text = STR_WITH_PRE.join("\n\n")
    replacement = "New text"
    assert_equal(
      [STR_WITH_PRE[0..1], "New text"].flatten.join("\n\n"),
      @formatter.new(text).update_section(3, replacement)
    )
  end

  STR_SETEXT_LIKE = [
    # 0
    <<~STR.chomp,
      # Title
    STR
    # 1
    <<~STR.chomp,
      ## Heading 2

      Thematic breaks - not be confused with setext headings.

      ---

      Preceding CRLF is the default for web-submitted data.
      \r
      ---\r
      \r

      A space-only line does not mean much.
      \s
      ---

      End of thematic breaks.
    STR
    # 2
    <<~STR.chomp,
      ## Heading 2
      Nulla nunc nisi, egestas in ornare vel, posuere ac libero.
    STR
  ]

  STR_RARE_SETEXT_LIKE = [
    # 0
    <<~STR.chomp,
      # Title
    STR
    # 1
    <<~STR.chomp,
      ## Heading 2

      - item
      one
      -
      not a heading
    STR
    # 2
    <<~STR.chomp,
      ## Heading 2
      Nulla nunc nisi, egestas in ornare vel, posuere ac libero.
    STR
  ]

  def test_get_section_should_ignore_setext_like_text
    text = STR_SETEXT_LIKE.join("\n\n")
    assert_section_with_hash STR_SETEXT_LIKE[1], text, 2
    assert_section_with_hash STR_SETEXT_LIKE[2], text, 3
  end

  def test_get_section_should_ignore_rare_setext_like_text
    begin
      text = STR_RARE_SETEXT_LIKE.join("\n\n")
      assert_section_with_hash STR_RARE_SETEXT_LIKE[1], text, 2
      assert_section_with_hash STR_RARE_SETEXT_LIKE[2], text, 3
    rescue Minitest::Assertion => e
      skip "Section extraction is currently limited, see #35037. Known error: #{e.message}"
    end
    assert_not "This test should be adjusted when fixing the known error."
  end

  def test_should_support_underlined_text
    text = 'This _text_ should be underlined'
    assert_equal '<p>This <u>text</u> should be underlined</p>', format(text)
  end

  def test_should_autolink_mails
    input = "foo@example.org"
    assert_equal %(<p><a href="mailto:foo@example.org">foo@example.org</a></p>), format(input)

    # The redcloth autolinker parses "plain" mailto links a bit unfortunately.
    # We do the best we can here...
    input = "mailto:foo@example.org"
    assert_equal %(<p>mailto:<a href="mailto:foo@example.org">foo@example.org</a></p>), format(input)
  end

  def test_should_fixup_mailto_links
    input = "<mailto:foo@example.org>"
    assert_equal %(<p><a href="mailto:foo@example.org">foo@example.org</a></p>), format(input)
  end

  def test_should_fixup_autolinked_user_references
    text = "user:user@example.org"
    assert_equal "<p>#{text}</p>", format(text)

    text = "@user@example.org"
    assert_equal "<p>#{text}</p>", format(text)
  end

  def test_should_fixup_autolinked_hires_files
    text = "printscreen@2x.png"
    assert_equal "<p>#{text}</p>", format(text).strip
  end

  def test_should_allow_links_with_safe_url_schemes
    safe_schemes = %w(http https ftp)
    link_safe_schemes = %w(ssh foo)

    (safe_schemes + link_safe_schemes).each do |scheme|
      input = "[#{scheme}](#{scheme}://example.com)"
      expected = %(<p><a href="#{scheme}://example.com" class="external">#{scheme}</a></p>)

      assert_equal expected, format(input)
    end
  end

  def test_should_not_allow_links_with_unsafe_url_schemes
    unsafe_schemes = %w(data javascript vbscript)

    unsafe_schemes.each do |scheme|
      input = "[#{scheme}](#{scheme}:something)"
      assert_equal "<p>#{input}</p>", format(input)
    end
  end

  def test_should_allow_autolinks_with_safe_url_schemes
    safe_schemes = %w(http https ftp)
    link_safe_schemes = %w(ssh foo)

    (safe_schemes + link_safe_schemes).each do |scheme|
      input = "#{scheme}://example.org"
      expected = %(<p><a href="#{input}" class="external">#{input}</a></p>)

      assert_equal expected, format(input) if safe_schemes.include?(scheme)
      assert_equal expected, format("<#{input}>")
    end
  end

  def test_should_not_autolink_unsafe_schemes
    unsafe_schemes = %w(data javascript vbscript)

    unsafe_schemes.each do |scheme|
      link = "#{scheme}:something"

      assert_equal "<p>#{link}</p>", format(link)
      assert_equal "<p>#{link}</p>", format("<#{link}>")
    end
  end

  private

  def format(text)
    @formatter.new(text).to_html.strip
  end

  def assert_section_with_hash(expected, text, index)
    result = @formatter.new(text).get_section(index)

    assert_kind_of Array, result
    assert_equal 2, result.size
    assert_equal expected, result.first, "section content did not match"
    assert_equal Digest::MD5.hexdigest(expected), result.last, "section hash did not match"
  end
end