/
test_comments.rb
244 lines (220 loc) · 10.7 KB
/
test_comments.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
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
# frozen_string_literal: true
require "helper"
module Nokogiri
module HTML
# testing error edge cases of HTML comments from the living WHATWG spec
# as of 2020-08-03
# https://html.spec.whatwg.org/multipage/parsing.html
class TestComment < Nokogiri::TestCase
# https://html.spec.whatwg.org/multipage/parsing.html#parse-error-abrupt-closing-of-empty-comment
#
# This error occurs if the parser encounters an empty comment
# that is abruptly closed by a U+003E (>) code point (i.e.,
# <!--> or <!--->). The parser behaves as if the comment is
# closed correctly.
describe "abrupt closing of empty comment" do
let(:doc) { Nokogiri::HTML(html) }
let(:subject) { doc.at_css("div#under-test") }
let(:other_div) { doc.at_css("div#also-here") }
describe "two dashes" do
let(:html) { "<html><body><div id=under-test><!--></div><div id=also-here></div></body></html>" }
if Nokogiri.uses_libxml?
if Nokogiri.libxml2_patches.include?("0008-htmlParseComment-handle-abruptly-closed-comments.patch")
it "behaves as if the comment is closed correctly" do # COMPLIANT
assert_equal 1, subject.children.length
assert_predicate subject.children.first, :comment?
assert_equal "", subject.children.first.content
assert other_div
end
else
it "behaves as if the comment is unterminated and doesn't exist" do # NON-COMPLIANT
assert_equal 0, subject.children.length
assert_equal 1, doc.errors.length
assert_match(/Comment not terminated/, doc.errors.first.to_s)
refute other_div
end
end
end
if Nokogiri.jruby?
it "behaves as if the comment is closed correctly" do # COMPLIANT
assert_equal 1, subject.children.length
assert_predicate subject.children.first, :comment?
assert_equal "", subject.children.first.content
assert other_div
end
end
end
describe "three dashes" do
let(:html) { "<html><body><div id=under-test><!---></div><div id=also-here></div></body></html>" }
if Nokogiri.uses_libxml?
if Nokogiri.libxml2_patches.include?("0008-htmlParseComment-handle-abruptly-closed-comments.patch")
it "behaves as if the comment is closed correctly" do # COMPLIANT
assert_equal 1, subject.children.length
assert_predicate subject.children.first, :comment?
assert_equal "", subject.children.first.content
assert other_div
end
else
it "behaves as if the comment is unterminated and doesn't exist" do # NON-COMPLIANT
assert_equal 0, subject.children.length
assert_equal 1, doc.errors.length
assert_match(/Comment not terminated/, doc.errors.first.to_s)
refute other_div
end
end
end
if Nokogiri.jruby?
it "behaves as if the comment is closed correctly" do # COMPLIANT
assert_equal 1, subject.children.length
assert_predicate subject.children.first, :comment?
assert_equal "-", subject.children.first.content # curious, potentially non-compliant?
assert other_div
end
end
end
describe "four dashes" do
let(:html) { "<html><body><div id=under-test><!----></div><div id=also-here></div></body></html>" }
it "behaves as if the comment is closed correctly" do # COMPLIANT
assert_equal 1, subject.children.length
assert_predicate subject.children.first, :comment?
assert_equal "", subject.children.first.content
assert other_div
end
end
end
# https://html.spec.whatwg.org/multipage/parsing.html#parse-error-eof-in-comment
#
# This error occurs if the parser encounters the end of the
# input stream in a comment. The parser treats such comments as
# if they are closed immediately before the end of the input
# stream.
describe "eof in comment" do
let(:html) { "<html><body><div id=under-test><!--start of unterminated comment" }
let(:doc) { Nokogiri::HTML(html) }
let(:subject) { doc.at_css("div#under-test") }
if Nokogiri.uses_libxml?
it "behaves as if the comment is unterminated and doesn't exist" do # NON-COMPLIANT
assert_equal 0, subject.children.length
assert_equal 1, doc.errors.length
assert_match(/Comment not terminated/, doc.errors.first.to_s)
end
end
if Nokogiri.jruby?
it "behaves as if the comment is closed immediately before the end of the input stream" do # COMPLIANT
assert_equal 1, subject.children.length
assert_predicate subject.children.first, :comment?
assert_equal "start of unterminated comment", subject.children.first.content
end
end
end
# https://html.spec.whatwg.org/multipage/parsing.html#parse-error-incorrectly-closed-comment
#
# This error occurs if the parser encounters a comment that is
# closed by the "--!>" code point sequence. The parser treats
# such comments as if they are correctly closed by the "-->"
# code point sequence.
describe "incorrectly closed comment" do
let(:html) { "<html><body><div id=under-test><!--foo--!><div id=do-i-exist></div><!--bar--></div></body></html>" }
let(:doc) { Nokogiri::HTML(html) }
let(:subject) { doc.at_css("div#under-test") }
let(:inner_div) { doc.at_css("div#do-i-exist") }
if Nokogiri::VersionInfo.instance.libxml2_using_packaged? || (Nokogiri::VersionInfo.instance.libxml2_using_system? && Nokogiri.uses_libxml?(">=2.9.11"))
it "behaves as if the comment is normally closed" do # COMPLIANT
assert_equal 3, subject.children.length
assert_predicate subject.children[0], :comment?
assert_equal "foo", subject.children[0].content
assert inner_div
assert_equal inner_div, subject.children[1]
assert_predicate subject.children[2], :comment?
assert_equal "bar", subject.children[2].content
assert_equal 1, doc.errors.length
assert_match(/Comment incorrectly closed/, doc.errors.first.to_s)
end
end
if Nokogiri.jruby? || (Nokogiri::VersionInfo.instance.libxml2_using_system? && Nokogiri.uses_libxml?("<2.9.11"))
it "behaves as if the comment encompasses the inner div" do # NON-COMPLIANT
assert_equal 1, subject.children.length
assert_predicate subject.children.first, :comment?
refute inner_div
assert_match(/id=do-i-exist/, subject.children.first.content)
assert_equal 0, doc.errors.length
end
end
end
# https://html.spec.whatwg.org/multipage/parsing.html#parse-error-incorrectly-opened-comment
#
# This error occurs if the parser encounters the "<!" code point
# sequence that is not immidiately followed by two U+002D (-)
# code points and that is not the start of a DOCTYPE or a CDATA
# section. All content that follows the "<!" code point sequence
# up to a U+003E (>) code point (if present) or to the end of
# the input stream is treated as a comment.
describe "incorrectly opened comment" do
let(:html) { "<html><body><div id=under-test><! comment <div id=do-i-exist>inner content</div>-->hello</div></body></html>" }
let(:doc) { Nokogiri::HTML(html) }
let(:body) { doc.at_css("body") }
let(:subject) { doc.at_css("div#under-test") }
if Nokogiri.uses_libxml?("<=2.9.13")
it "ignores up to the next '>'" do # NON-COMPLIANT
assert_equal 2, body.children.length
assert_equal body.children[0], subject
assert_equal 1, subject.children.length
assert_predicate subject.children[0], :text?
assert_equal "inner content", subject.children[0].content
assert_predicate body.children[1], :text?
assert_equal "-->hello", body.children[1].content
end
elsif Nokogiri.uses_libxml?
it "parses as pcdata" do # NON-COMPLIANT
assert_equal 1, body.children.length
assert_equal subject, body.children.first
assert_equal 3, subject.children.length
subject.children[0].tap do |child|
assert_predicate(child, :text?)
assert_equal("<! comment ", child.content)
end
subject.children[1].tap do |child|
assert_predicate(child, :element?)
assert_equal("div", child.name)
assert_equal("inner content", child.content)
end
subject.children[2].tap do |child|
assert_predicate(child, :text?)
assert_equal("-->hello", child.content)
end
end
end
if Nokogiri.jruby?
it "ignores up to the next '-->'" do # NON-COMPLIANT
assert_equal 1, body.children.length
assert_equal subject, body.children.first
assert_equal 1, subject.children.length
assert_predicate subject.children[0], :text?
assert_equal "hello", subject.children[0].content
end
end
end
# https://html.spec.whatwg.org/multipage/parsing.html#parse-error-nested-comment
#
# This error occurs if the parser encounters a nested comment
# (e.g., <!-- <!-- nested --> -->). Such a comment will be
# closed by the first occuring "-->" code point sequence and
# everything that follows will be treated as markup.
describe "nested comment" do
let(:html) { "<html><body><div id=under-test><!-- outer <!-- inner --><div id=do-i-exist></div>--></div></body></html>" }
let(:doc) { Nokogiri::HTML(html) }
let(:subject) { doc.at_css("div#under-test") }
let(:inner_div) { doc.at_css("div#do-i-exist") }
it "ignores to the next '-->'" do # COMPLIANT
assert_equal 3, subject.children.length
assert_predicate subject.children[0], :comment?
assert_equal " outer <!-- inner ", subject.children[0].content
assert inner_div
assert_equal inner_div, subject.children[1]
assert_predicate subject.children[2], :text?
assert_equal "-->", subject.children[2].content
end
end
end
end
end