author | Denis Laxalde <denis.laxalde@logilab.fr> |
Fri, 12 Jun 2015 09:18:02 +0200 | |
changeset 10375 | 28ec01db78b3 |
parent 10066 | 313ce53a7232 |
child 10588 | fdaa0e4b7eaf |
permissions | -rw-r--r-- |
8937
8a1809c9a043
[htmlparser] add missing deprecation message
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8695
diff
changeset
|
1 |
# copyright 2003-2013 LOGILAB S.A. (Paris, FRANCE), all rights reserved. |
5421
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5276
diff
changeset
|
2 |
# contact http://www.logilab.fr/ -- mailto:contact@logilab.fr |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5276
diff
changeset
|
3 |
# |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5276
diff
changeset
|
4 |
# This file is part of CubicWeb. |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5276
diff
changeset
|
5 |
# |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5276
diff
changeset
|
6 |
# CubicWeb is free software: you can redistribute it and/or modify it under the |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5276
diff
changeset
|
7 |
# terms of the GNU Lesser General Public License as published by the Free |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5276
diff
changeset
|
8 |
# Software Foundation, either version 2.1 of the License, or (at your option) |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5276
diff
changeset
|
9 |
# any later version. |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5276
diff
changeset
|
10 |
# |
5424
8ecbcbff9777
replace logilab-common by CubicWeb in disclaimer
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5421
diff
changeset
|
11 |
# CubicWeb is distributed in the hope that it will be useful, but WITHOUT |
5421
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5276
diff
changeset
|
12 |
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5276
diff
changeset
|
13 |
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5276
diff
changeset
|
14 |
# details. |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5276
diff
changeset
|
15 |
# |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5276
diff
changeset
|
16 |
# You should have received a copy of the GNU Lesser General Public License along |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5276
diff
changeset
|
17 |
# with CubicWeb. If not, see <http://www.gnu.org/licenses/>. |
6771
da71f1ad1721
minor code cleanup
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5424
diff
changeset
|
18 |
"""defines a validating HTML parser used in web application tests""" |
0 | 19 |
|
20 |
import re |
|
3325
44caeccd2db9
fix sys import
Julien Jehannet <julien.jehannet@logilab.fr>
parents:
3151
diff
changeset
|
21 |
import sys |
8977
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
22 |
from xml import sax |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
23 |
from cStringIO import StringIO |
0 | 24 |
|
25 |
from lxml import etree |
|
26 |
||
8938
198fdadafed6
[htmlparser] rename SaxOnlyValidator to XMLValidator
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8937
diff
changeset
|
27 |
from logilab.common.deprecation import class_deprecated, class_renamed |
6772
68bb0943d192
[test, html validation] make validator selection somewhat smarter (at least it works properly when content is demoted from xhtml to html, making the XMLDemotingValidator class useless
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6771
diff
changeset
|
28 |
|
1421
77ee26df178f
doc type handling refactoring: do the ext substitution at the module level
sylvain.thenault@logilab.fr
parents:
1132
diff
changeset
|
29 |
from cubicweb.view import STRICT_DOCTYPE, TRANSITIONAL_DOCTYPE |
6771
da71f1ad1721
minor code cleanup
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5424
diff
changeset
|
30 |
|
1485 | 31 |
STRICT_DOCTYPE = str(STRICT_DOCTYPE) |
32 |
TRANSITIONAL_DOCTYPE = str(TRANSITIONAL_DOCTYPE) |
|
0 | 33 |
|
34 |
ERR_COUNT = 0 |
|
35 |
||
8977
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
36 |
_REM_SCRIPT_RGX = re.compile(r"<script[^>]*>.*?</script>", re.U|re.M|re.I|re.S) |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
37 |
def _remove_script_tags(data): |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
38 |
"""Remove the script (usually javascript) tags to help the lxml |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
39 |
XMLParser / HTMLParser do their job. Without that, they choke on |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
40 |
tags embedded in JS strings. |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
41 |
""" |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
42 |
# Notice we may want to use lxml cleaner, but it's far too intrusive: |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
43 |
# |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
44 |
# cleaner = Cleaner(scripts=True, |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
45 |
# javascript=False, |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
46 |
# comments=False, |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
47 |
# style=False, |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
48 |
# links=False, |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
49 |
# meta=False, |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
50 |
# page_structure=False, |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
51 |
# processing_instructions=False, |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
52 |
# embedded=False, |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
53 |
# frames=False, |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
54 |
# forms=False, |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
55 |
# annoying_tags=False, |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
56 |
# remove_tags=(), |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
57 |
# remove_unknown_tags=False, |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
58 |
# safe_attrs_only=False, |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
59 |
# add_nofollow=False) |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
60 |
# >>> cleaner.clean_html('<body></body>') |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
61 |
# '<span></span>' |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
62 |
# >>> cleaner.clean_html('<!DOCTYPE html><body></body>') |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
63 |
# '<html><body></body></html>' |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
64 |
# >>> cleaner.clean_html('<body><div/></body>') |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
65 |
# '<div></div>' |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
66 |
# >>> cleaner.clean_html('<html><body><div/><br></body><html>') |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
67 |
# '<html><body><div></div><br></body></html>' |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
68 |
# >>> cleaner.clean_html('<html><body><div/><br><span></body><html>') |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
69 |
# '<html><body><div></div><br><span></span></body></html>' |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
70 |
# |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
71 |
# using that, we'll miss most actual validation error we want to |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
72 |
# catch. For now, use dumb regexp |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
73 |
return _REM_SCRIPT_RGX.sub('', data) |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
74 |
|
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
75 |
|
0 | 76 |
class Validator(object): |
8977
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
77 |
""" base validator API """ |
8973
6711f78c18be
[testlib] unspaghettify Validator / PageInfo api
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8972
diff
changeset
|
78 |
parser = None |
1485 | 79 |
|
8973
6711f78c18be
[testlib] unspaghettify Validator / PageInfo api
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8972
diff
changeset
|
80 |
def parse_string(self, source): |
6711f78c18be
[testlib] unspaghettify Validator / PageInfo api
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8972
diff
changeset
|
81 |
etree = self._parse(self.preprocess_data(source)) |
6711f78c18be
[testlib] unspaghettify Validator / PageInfo api
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8972
diff
changeset
|
82 |
return PageInfo(source, etree) |
6711f78c18be
[testlib] unspaghettify Validator / PageInfo api
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8972
diff
changeset
|
83 |
|
6711f78c18be
[testlib] unspaghettify Validator / PageInfo api
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8972
diff
changeset
|
84 |
def preprocess_data(self, data): |
6711f78c18be
[testlib] unspaghettify Validator / PageInfo api
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8972
diff
changeset
|
85 |
return data |
6711f78c18be
[testlib] unspaghettify Validator / PageInfo api
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8972
diff
changeset
|
86 |
|
6711f78c18be
[testlib] unspaghettify Validator / PageInfo api
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8972
diff
changeset
|
87 |
def _parse(self, pdata): |
0 | 88 |
try: |
8973
6711f78c18be
[testlib] unspaghettify Validator / PageInfo api
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8972
diff
changeset
|
89 |
return etree.fromstring(pdata, self.parser) |
8695
358d8bed9626
[toward-py3k] rewrite to "except AnException as exc:" (part of #2711624)
Nicolas Chauvat <nicolas.chauvat@logilab.fr>
parents:
7014
diff
changeset
|
90 |
except etree.XMLSyntaxError as exc: |
8941
7b26fe71404f
drop xhtml content-type support (closes #2065651)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
8940
diff
changeset
|
91 |
new_exc = AssertionError(u'invalid document: %s' % exc) |
0 | 92 |
new_exc.position = exc.position |
93 |
raise new_exc |
|
94 |
||
95 |
||
96 |
class DTDValidator(Validator): |
|
97 |
def __init__(self): |
|
98 |
Validator.__init__(self) |
|
3151 | 99 |
# XXX understand what's happening under windows |
6771
da71f1ad1721
minor code cleanup
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5424
diff
changeset
|
100 |
self.parser = etree.XMLParser(dtd_validation=sys.platform != 'win32') |
0 | 101 |
|
102 |
def preprocess_data(self, data): |
|
103 |
"""used to fix potential blockquote mess generated by docutils""" |
|
1485 | 104 |
if STRICT_DOCTYPE not in data: |
0 | 105 |
return data |
106 |
# parse using transitional DTD |
|
1485 | 107 |
data = data.replace(STRICT_DOCTYPE, TRANSITIONAL_DOCTYPE) |
8979
8f5416b1562a
[devtools] use self._parse so AssertionError is properly raised instead of lxml error (test failure introduced in 6711f78c18be)
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8977
diff
changeset
|
108 |
tree = self._parse(data) |
0 | 109 |
namespace = tree.nsmap.get(None) |
110 |
# this is the list of authorized child tags for <blockquote> nodes |
|
111 |
expected = 'p h1 h2 h3 h4 h5 h6 div ul ol dl pre hr blockquote address ' \ |
|
112 |
'fieldset table form noscript ins del script'.split() |
|
113 |
if namespace: |
|
114 |
blockquotes = tree.findall('.//{%s}blockquote' % namespace) |
|
115 |
expected = ['{%s}%s' % (namespace, tag) for tag in expected] |
|
116 |
else: |
|
117 |
blockquotes = tree.findall('.//blockquote') |
|
118 |
# quick and dirty approach: remove all blockquotes |
|
119 |
for blockquote in blockquotes: |
|
120 |
parent = blockquote.getparent() |
|
121 |
parent.remove(blockquote) |
|
122 |
data = etree.tostring(tree) |
|
1485 | 123 |
return '<?xml version="1.0" encoding="UTF-8"?>%s\n%s' % ( |
124 |
STRICT_DOCTYPE, data) |
|
0 | 125 |
|
1485 | 126 |
|
8938
198fdadafed6
[htmlparser] rename SaxOnlyValidator to XMLValidator
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8937
diff
changeset
|
127 |
class XMLValidator(Validator): |
8977
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
128 |
"""XML validator, checks that XML is well-formed and used XMLNS are defined""" |
0 | 129 |
|
130 |
def __init__(self): |
|
131 |
Validator.__init__(self) |
|
132 |
self.parser = etree.XMLParser() |
|
133 |
||
8938
198fdadafed6
[htmlparser] rename SaxOnlyValidator to XMLValidator
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8937
diff
changeset
|
134 |
SaxOnlyValidator = class_renamed('SaxOnlyValidator', |
198fdadafed6
[htmlparser] rename SaxOnlyValidator to XMLValidator
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8937
diff
changeset
|
135 |
XMLValidator, |
198fdadafed6
[htmlparser] rename SaxOnlyValidator to XMLValidator
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8937
diff
changeset
|
136 |
'[3.17] you should use the ' |
198fdadafed6
[htmlparser] rename SaxOnlyValidator to XMLValidator
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8937
diff
changeset
|
137 |
'XMLValidator class instead') |
198fdadafed6
[htmlparser] rename SaxOnlyValidator to XMLValidator
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8937
diff
changeset
|
138 |
|
8977
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
139 |
|
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
140 |
class XMLSyntaxValidator(Validator): |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
141 |
"""XML syntax validator, check XML is well-formed""" |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
142 |
|
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
143 |
class MySaxErrorHandler(sax.ErrorHandler): |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
144 |
"""override default handler to avoid choking because of unknown entity""" |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
145 |
def fatalError(self, exception): |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
146 |
# XXX check entity in htmlentitydefs |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
147 |
if not str(exception).endswith('undefined entity'): |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
148 |
raise exception |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
149 |
_parser = sax.make_parser() |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
150 |
_parser.setContentHandler(sax.handler.ContentHandler()) |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
151 |
_parser.setErrorHandler(MySaxErrorHandler()) |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
152 |
|
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
153 |
def __init__(self): |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
154 |
super(XMLSyntaxValidator, self).__init__() |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
155 |
# XMLParser() wants xml namespaces defined |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
156 |
# XMLParser(recover=True) will accept almost anything |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
157 |
# |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
158 |
# -> use the later but preprocess will check xml well-formness using a |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
159 |
# dumb SAX parser |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
160 |
self.parser = etree.XMLParser(recover=True) |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
161 |
|
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
162 |
def preprocess_data(self, data): |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
163 |
return _remove_script_tags(data) |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
164 |
|
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
165 |
def _parse(self, data): |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
166 |
inpsrc = sax.InputSource() |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
167 |
inpsrc.setByteStream(StringIO(data)) |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
168 |
try: |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
169 |
self._parser.parse(inpsrc) |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
170 |
except sax.SAXParseException, exc: |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
171 |
new_exc = AssertionError(u'invalid document: %s' % exc) |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
172 |
new_exc.position = (exc._linenum, exc._colnum) |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
173 |
raise new_exc |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
174 |
return super(XMLSyntaxValidator, self)._parse(data) |
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
175 |
|
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
176 |
|
0 | 177 |
class HTMLValidator(Validator): |
178 |
||
179 |
def __init__(self): |
|
180 |
Validator.__init__(self) |
|
8940
ae898a084da2
[htmlparser] exclude <script> tag from html source
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8939
diff
changeset
|
181 |
self.parser = etree.HTMLParser(recover=False) |
0 | 182 |
|
8940
ae898a084da2
[htmlparser] exclude <script> tag from html source
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
8939
diff
changeset
|
183 |
def preprocess_data(self, data): |
8977
57e564c0118e
[testlib] introduce a validator that check xml-well formness
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8973
diff
changeset
|
184 |
return _remove_script_tags(data) |
1485 | 185 |
|
0 | 186 |
|
187 |
class PageInfo(object): |
|
188 |
"""holds various informations on the view's output""" |
|
8973
6711f78c18be
[testlib] unspaghettify Validator / PageInfo api
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8972
diff
changeset
|
189 |
def __init__(self, source, root): |
0 | 190 |
self.source = source |
191 |
self.etree = root |
|
192 |
self.raw_text = u''.join(root.xpath('//text()')) |
|
193 |
self.namespace = self.etree.nsmap |
|
194 |
self.default_ns = self.namespace.get(None) |
|
195 |
self.a_tags = self.find_tag('a') |
|
196 |
self.h1_tags = self.find_tag('h1') |
|
197 |
self.h2_tags = self.find_tag('h2') |
|
198 |
self.h3_tags = self.find_tag('h3') |
|
199 |
self.h4_tags = self.find_tag('h4') |
|
200 |
self.input_tags = self.find_tag('input') |
|
201 |
self.title_tags = [self.h1_tags, self.h2_tags, self.h3_tags, self.h4_tags] |
|
1485 | 202 |
|
7014
7e3e80f4179a
[testlib pageinfo] extract matching_node method from has_tag to ease looking for a node with a given set of attributes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6977
diff
changeset
|
203 |
def _iterstr(self, tag): |
6977
cb78108bf603
[testlib] new method on page info object to ensure some tag with arbitrary attributes is found
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6772
diff
changeset
|
204 |
if self.default_ns is None: |
cb78108bf603
[testlib] new method on page info object to ensure some tag with arbitrary attributes is found
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6772
diff
changeset
|
205 |
return ".//%s" % tag |
cb78108bf603
[testlib] new method on page info object to ensure some tag with arbitrary attributes is found
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6772
diff
changeset
|
206 |
else: |
cb78108bf603
[testlib] new method on page info object to ensure some tag with arbitrary attributes is found
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6772
diff
changeset
|
207 |
return ".//{%s}%s" % (self.default_ns, tag) |
cb78108bf603
[testlib] new method on page info object to ensure some tag with arbitrary attributes is found
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6772
diff
changeset
|
208 |
|
7014
7e3e80f4179a
[testlib pageinfo] extract matching_node method from has_tag to ease looking for a node with a given set of attributes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6977
diff
changeset
|
209 |
def matching_nodes(self, tag, **attrs): |
7e3e80f4179a
[testlib pageinfo] extract matching_node method from has_tag to ease looking for a node with a given set of attributes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6977
diff
changeset
|
210 |
for elt in self.etree.iterfind(self._iterstr(tag)): |
7e3e80f4179a
[testlib pageinfo] extract matching_node method from has_tag to ease looking for a node with a given set of attributes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6977
diff
changeset
|
211 |
eltattrs = elt.attrib |
7e3e80f4179a
[testlib pageinfo] extract matching_node method from has_tag to ease looking for a node with a given set of attributes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6977
diff
changeset
|
212 |
for attr, value in attrs.iteritems(): |
7e3e80f4179a
[testlib pageinfo] extract matching_node method from has_tag to ease looking for a node with a given set of attributes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6977
diff
changeset
|
213 |
try: |
7e3e80f4179a
[testlib pageinfo] extract matching_node method from has_tag to ease looking for a node with a given set of attributes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6977
diff
changeset
|
214 |
if eltattrs[attr] != value: |
7e3e80f4179a
[testlib pageinfo] extract matching_node method from has_tag to ease looking for a node with a given set of attributes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6977
diff
changeset
|
215 |
break |
7e3e80f4179a
[testlib pageinfo] extract matching_node method from has_tag to ease looking for a node with a given set of attributes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6977
diff
changeset
|
216 |
except KeyError: |
7e3e80f4179a
[testlib pageinfo] extract matching_node method from has_tag to ease looking for a node with a given set of attributes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6977
diff
changeset
|
217 |
break |
7e3e80f4179a
[testlib pageinfo] extract matching_node method from has_tag to ease looking for a node with a given set of attributes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6977
diff
changeset
|
218 |
else: # all attributes match |
7e3e80f4179a
[testlib pageinfo] extract matching_node method from has_tag to ease looking for a node with a given set of attributes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6977
diff
changeset
|
219 |
yield elt |
7e3e80f4179a
[testlib pageinfo] extract matching_node method from has_tag to ease looking for a node with a given set of attributes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6977
diff
changeset
|
220 |
|
7e3e80f4179a
[testlib pageinfo] extract matching_node method from has_tag to ease looking for a node with a given set of attributes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6977
diff
changeset
|
221 |
def has_tag(self, tag, nboccurs=1, **attrs): |
7e3e80f4179a
[testlib pageinfo] extract matching_node method from has_tag to ease looking for a node with a given set of attributes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6977
diff
changeset
|
222 |
"""returns True if tag with given attributes appears in the page |
7e3e80f4179a
[testlib pageinfo] extract matching_node method from has_tag to ease looking for a node with a given set of attributes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6977
diff
changeset
|
223 |
`nbtimes` (any if None) |
7e3e80f4179a
[testlib pageinfo] extract matching_node method from has_tag to ease looking for a node with a given set of attributes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6977
diff
changeset
|
224 |
""" |
7e3e80f4179a
[testlib pageinfo] extract matching_node method from has_tag to ease looking for a node with a given set of attributes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6977
diff
changeset
|
225 |
for elt in self.matching_nodes(tag, **attrs): |
7e3e80f4179a
[testlib pageinfo] extract matching_node method from has_tag to ease looking for a node with a given set of attributes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6977
diff
changeset
|
226 |
if nboccurs is None: # no need to check number of occurences |
7e3e80f4179a
[testlib pageinfo] extract matching_node method from has_tag to ease looking for a node with a given set of attributes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6977
diff
changeset
|
227 |
return True |
7e3e80f4179a
[testlib pageinfo] extract matching_node method from has_tag to ease looking for a node with a given set of attributes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6977
diff
changeset
|
228 |
if not nboccurs: # too much occurences |
7e3e80f4179a
[testlib pageinfo] extract matching_node method from has_tag to ease looking for a node with a given set of attributes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6977
diff
changeset
|
229 |
return False |
7e3e80f4179a
[testlib pageinfo] extract matching_node method from has_tag to ease looking for a node with a given set of attributes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6977
diff
changeset
|
230 |
nboccurs -= 1 |
7e3e80f4179a
[testlib pageinfo] extract matching_node method from has_tag to ease looking for a node with a given set of attributes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6977
diff
changeset
|
231 |
if nboccurs == 0: # correct number of occurences |
7e3e80f4179a
[testlib pageinfo] extract matching_node method from has_tag to ease looking for a node with a given set of attributes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6977
diff
changeset
|
232 |
return True |
7e3e80f4179a
[testlib pageinfo] extract matching_node method from has_tag to ease looking for a node with a given set of attributes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6977
diff
changeset
|
233 |
return False # no matching tag/attrs |
7e3e80f4179a
[testlib pageinfo] extract matching_node method from has_tag to ease looking for a node with a given set of attributes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6977
diff
changeset
|
234 |
|
1945
2b59d9ae17ae
new argument telling if we want text or (text / attrs), keeping bw compat
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1485
diff
changeset
|
235 |
def find_tag(self, tag, gettext=True): |
0 | 236 |
"""return a list which contains text of all "tag" elements """ |
7014
7e3e80f4179a
[testlib pageinfo] extract matching_node method from has_tag to ease looking for a node with a given set of attributes
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6977
diff
changeset
|
237 |
iterstr = self._iterstr(tag) |
1945
2b59d9ae17ae
new argument telling if we want text or (text / attrs), keeping bw compat
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1485
diff
changeset
|
238 |
if not gettext or tag in ('a', 'input'): |
6977
cb78108bf603
[testlib] new method on page info object to ensure some tag with arbitrary attributes is found
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6772
diff
changeset
|
239 |
return [(elt.text, elt.attrib) |
cb78108bf603
[testlib] new method on page info object to ensure some tag with arbitrary attributes is found
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6772
diff
changeset
|
240 |
for elt in self.etree.iterfind(iterstr)] |
cb78108bf603
[testlib] new method on page info object to ensure some tag with arbitrary attributes is found
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6772
diff
changeset
|
241 |
return [u''.join(elt.xpath('.//text()')) |
cb78108bf603
[testlib] new method on page info object to ensure some tag with arbitrary attributes is found
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
6772
diff
changeset
|
242 |
for elt in self.etree.iterfind(iterstr)] |
1485 | 243 |
|
0 | 244 |
def appears(self, text): |
245 |
"""returns True if <text> appears in the page""" |
|
246 |
return text in self.raw_text |
|
247 |
||
248 |
def __contains__(self, text): |
|
249 |
return text in self.source |
|
1485 | 250 |
|
0 | 251 |
def has_title(self, text, level=None): |
252 |
"""returns True if <h?>text</h?> |
|
253 |
||
254 |
:param level: the title's level (1 for h1, 2 for h2, etc.) |
|
255 |
""" |
|
256 |
if level is None: |
|
257 |
for hlist in self.title_tags: |
|
258 |
if text in hlist: |
|
259 |
return True |
|
260 |
return False |
|
261 |
else: |
|
262 |
hlist = self.title_tags[level - 1] |
|
263 |
return text in hlist |
|
264 |
||
265 |
def has_title_regexp(self, pattern, level=None): |
|
266 |
"""returns True if <h?>pattern</h?>""" |
|
267 |
sre = re.compile(pattern) |
|
268 |
if level is None: |
|
269 |
for hlist in self.title_tags: |
|
270 |
for title in hlist: |
|
271 |
if sre.match(title): |
|
272 |
return True |
|
273 |
return False |
|
274 |
else: |
|
275 |
hlist = self.title_tags[level - 1] |
|
276 |
for title in hlist: |
|
277 |
if sre.match(title): |
|
278 |
return True |
|
279 |
return False |
|
1485 | 280 |
|
0 | 281 |
def has_link(self, text, url=None): |
282 |
"""returns True if <a href=url>text</a> was found in the page""" |
|
283 |
for link_text, attrs in self.a_tags: |
|
284 |
if text == link_text: |
|
285 |
if url is None: |
|
286 |
return True |
|
287 |
try: |
|
288 |
href = attrs['href'] |
|
289 |
if href == url: |
|
290 |
return True |
|
291 |
except KeyError: |
|
292 |
continue |
|
293 |
return False |
|
1485 | 294 |
|
0 | 295 |
def has_link_regexp(self, pattern, url=None): |
296 |
"""returns True if <a href=url>pattern</a> was found in the page""" |
|
297 |
sre = re.compile(pattern) |
|
298 |
for link_text, attrs in self.a_tags: |
|
299 |
if sre.match(link_text): |
|
300 |
if url is None: |
|
301 |
return True |
|
302 |
try: |
|
303 |
href = attrs['href'] |
|
304 |
if href == url: |
|
305 |
return True |
|
306 |
except KeyError: |
|
307 |
continue |
|
308 |
return False |
|
2773
b2530e3e0afb
[testlib] #345052 and #344207: major test lib refactoring/cleanup + update usage
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
309 |
|
8972
771337c3a754
[testlib] update htmlparsers.VALMAP: stop using SaxOnlyValidator and add an entry for html
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8951
diff
changeset
|
310 |
VALMAP = {None: None, |
771337c3a754
[testlib] update htmlparsers.VALMAP: stop using SaxOnlyValidator and add an entry for html
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8951
diff
changeset
|
311 |
'dtd': DTDValidator, |
771337c3a754
[testlib] update htmlparsers.VALMAP: stop using SaxOnlyValidator and add an entry for html
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8951
diff
changeset
|
312 |
'xml': XMLValidator, |
771337c3a754
[testlib] update htmlparsers.VALMAP: stop using SaxOnlyValidator and add an entry for html
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8951
diff
changeset
|
313 |
'html': HTMLValidator, |
771337c3a754
[testlib] update htmlparsers.VALMAP: stop using SaxOnlyValidator and add an entry for html
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
8951
diff
changeset
|
314 |
} |