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
|
"""The the pyzor.digest module
"""
import unittest
import pyzor.digest
from pyzor.digest import *
try:
from unittest.mock import patch, Mock, call
except ImportError:
from mock import patch, Mock, call
HTML_TEXT = """<html><head><title>Email spam</title></head><body>
<p><b>Email spam</b>, also known as <b>junk email</b>
or <b>unsolicited bulk email</b> (<i>UBE</i>), is a subset of
<a href="/wiki/Spam_(electronic)" title="Spam (electronic)">electronic spam</a>
involving nearly identical messages sent to numerous recipients by <a href="/wiki/Email" title="Email">
email</a>. Clicking on <a href="/wiki/Html_email#Security_vulnerabilities" title="Html email" class="mw-redirect">
links in spam email</a> may send users to <a href="/wiki/Phishing" title="Phishing">phishing</a>
web sites or sites that are hosting <a href="/wiki/Malware" title="Malware">malware</a>.</body></html>"""
HTML_TEXT_STRIPED = (
"Email spam Email spam , also known as junk email or unsolicited bulk email ( UBE ),"
" is a subset of electronic spam involving nearly identical messages sent to numerous recipients by email"
" . Clicking on links in spam email may send users to phishing web sites or sites that are hosting malware ."
)
HTML_STYLE = """<html><head></head><sTyle>Some random style</stylE>
<body>This is a test.</body></html>
"""
HTML_SCRIPT = """<html><head></head><SCRIPT>Some random script</SCRIPT>
<body>This is a test.</body></html>
"""
class HTMLStripperTests(unittest.TestCase):
def setUp(self):
unittest.TestCase.setUp(self)
self.data = []
def tearDown(self):
unittest.TestCase.tearDown(self)
def test_HTMLStripper(self):
stripper = HTMLStripper(self.data)
stripper.feed(HTML_TEXT)
res = " ".join(self.data)
self.assertEqual(res, HTML_TEXT_STRIPED)
def test_strip_style(self):
stripper = HTMLStripper(self.data)
stripper.feed(HTML_STYLE)
res = " ".join(self.data)
self.assertEqual(res, "This is a test.")
def test_strip_script(self):
stripper = HTMLStripper(self.data)
stripper.feed(HTML_SCRIPT)
res = " ".join(self.data)
self.assertEqual(res, "This is a test.")
class PreDigestTests(unittest.TestCase):
def setUp(self):
unittest.TestCase.setUp(self)
self.lines = []
def mock_digest_paylods(c, message):
yield message.decode("utf8")
def mock_handle_line(s, line):
self.lines.append(line.decode("utf8"))
self.real_digest_payloads = DataDigester.digest_payloads
self.real_handle_line = DataDigester.handle_line
DataDigester.digest_payloads = mock_digest_paylods
DataDigester.handle_line = mock_handle_line
def tearDown(self):
unittest.TestCase.tearDown(self)
DataDigester.digest_payloads = self.real_digest_payloads
DataDigester.handle_line = self.real_handle_line
def test_predigest_emails(self):
"""Test email removal in the predigest process"""
real_longstr = DataDigester.longstr_ptrn
DataDigester.longstr_ptrn = re.compile(r"\S{100,}")
emails = [
"test@example.com",
"test123@example.com",
"test+abc@example.com",
"test.test2@example.com",
"test.test2+abc@example.com",
]
message = "Test %s Test2"
expected = "TestTest2"
try:
for email in emails:
self.lines = []
DataDigester((message % email).encode("utf8"))
self.assertEqual(self.lines[0], expected)
finally:
DataDigester.longstr_ptrn = real_longstr
def test_predigest_urls(self):
"""Test url removal in the predigest process"""
real_longstr = DataDigester.longstr_ptrn
DataDigester.longstr_ptrn = re.compile(r"\S{100,}")
urls = [
"http://www.example.com",
# "www.example.com", # XXX This also fail
"http://example.com",
# "example.com", # XXX This also fails
"http://www.example.com/test/" "http://www.example.com/test/test2",
]
message = "Test %s Test2"
expected = "TestTest2"
try:
for url in urls:
self.lines = []
DataDigester((message % url).encode("utf8"))
self.assertEqual(self.lines[0], expected)
finally:
DataDigester.longstr_ptrn = real_longstr
def test_predigest_long(self):
"""Test long "words" removal in the predigest process"""
strings = ["0A2D3f%a#S", "3sddkf9jdkd9", "@@#@@@@@@@@@"]
message = "Test %s Test2"
expected = "TestTest2"
for string in strings:
self.lines = []
DataDigester((message % string).encode("utf8"))
self.assertEqual(self.lines[0], expected)
def test_predigest_min_line_lenght(self):
"""Test small lines removal in the predigest process"""
message = "This line is included\n" "not this\n" "This also"
expected = ["Thislineisincluded", "Thisalso"]
DataDigester(message.encode("utf8"))
self.assertEqual(self.lines, expected)
def test_predigest_atomic(self):
"""Test atomic messages (lines <= 4) in the predigest process"""
message = "All this message\nShould be included\nIn the predigest"
expected = ["Allthismessage", "Shouldbeincluded", "Inthepredigest"]
DataDigester(message.encode("utf8"))
self.assertEqual(self.lines, expected)
def test_predigest_pieced(self):
"""Test pieced messages (lines > 4) in the predigest process"""
message = ""
for i in range(100):
message += "Line%d test test test\n" % i
expected = []
for i in [20, 21, 22, 60, 61, 62]:
expected.append("Line%dtesttesttest" % i)
DataDigester(message.encode("utf8"))
self.assertEqual(self.lines, expected)
class DigestTests(unittest.TestCase):
def setUp(self):
unittest.TestCase.setUp(self)
self.lines = []
def mock_digest_paylods(c, message):
yield message.decode("utf8")
self.real_digest_payloads = DataDigester.digest_payloads
DataDigester.digest_payloads = mock_digest_paylods
def tearDown(self):
unittest.TestCase.tearDown(self)
DataDigester.digest_payloads = self.real_digest_payloads
def test_digest(self):
message = b"That's some good ham right there"
predigested = b"That'ssomegoodhamrightthere"
digest = hashlib.sha1()
digest.update(predigested)
expected = digest.hexdigest()
result = DataDigester(message).value
self.assertEqual(result, expected)
def test_digest_w_null(self):
message = b"That's some good ham rig\x00ht there"
predigested = b"That'ssomegoodhamrightthere"
digest = hashlib.sha1()
digest.update(predigested)
expected = digest.hexdigest()
result = DataDigester(message).value
self.assertEqual(result, expected)
class MessageDigestTest(unittest.TestCase):
def setUp(self):
unittest.TestCase.setUp(self)
patch(
"pyzor.digest.DataDigester.normalize_html_part", return_value="normalized"
).start()
self.config = {
"get_content_maintype.return_value": "text",
"get_content_charset.return_value": "utf8",
"get_payload.return_value": Mock(),
"get_payload.return_value.decode.return_value": "decoded",
}
def tearDown(self):
unittest.TestCase.tearDown(self)
patch.stopall()
def check_msg(self):
mock_part = Mock(**self.config)
conf = {"walk.return_value": [mock_part]}
mock_msg = Mock(**conf)
return mock_part, mock_msg, list(DataDigester.digest_payloads(mock_msg))
def test_text(self):
mock_part, mock_msg, result = self.check_msg()
self.assertEqual(result, ["decoded"])
expected = [call.decode("utf8", "ignore")]
payload = mock_part.get_payload.return_value
payload.assert_has_calls(expected, True)
def test_text_no_charset(self):
self.config["get_content_charset.return_value"] = None
mock_part, mock_msg, result = self.check_msg()
self.assertEqual(result, ["decoded"])
expected = [call.decode("ascii", "ignore")]
payload = mock_part.get_payload.return_value
payload.assert_has_calls(expected)
def test_text_quopri(self):
self.config["get_content_charset.return_value"] = "quopri"
mock_part, mock_msg, result = self.check_msg()
self.assertEqual(result, ["decoded"])
expected = [call.decode("quopri", "strict")]
payload = mock_part.get_payload.return_value
payload.assert_has_calls(expected)
def test_text_lookuperror(self):
def _decode(encoding, errors):
if encoding not in ("ascii",):
raise LookupError()
return "decoded"
self.config["get_payload.return_value.decode.side_effect"] = _decode
mock_part, mock_msg, result = self.check_msg()
self.assertEqual(result, ["decoded"])
expected = [call.decode("utf8", "ignore"), call.decode("ascii", "ignore")]
payload = mock_part.get_payload.return_value
payload.assert_has_calls(expected)
def test_text_unicodeerror(self):
self.config["get_payload.return_value.decode.side_effect"] = UnicodeError
mock_part, mock_msg, result = self.check_msg()
self.assertEqual(result, [])
expected = [call.decode("utf8", "ignore"), call.decode("ascii", "ignore")]
payload = mock_part.get_payload.return_value
payload.assert_has_calls(expected)
def test_html(self):
self.config["get_content_subtype.return_value"] = "html"
mock_part, mock_msg, result = self.check_msg()
self.assertEqual(result, ["normalized"])
def test_multipart(self):
self.config["get_content_maintype.return_value"] = "nottext"
self.config["is_multipart.return_value"] = True
mock_part, mock_msg, result = self.check_msg()
self.assertEqual(result, [])
def test_nontext(self):
self.config["get_content_maintype.return_value"] = "nottext"
self.config["is_multipart.return_value"] = False
mock_part, mock_msg, result = self.check_msg()
self.assertEqual(result, [mock_part.get_payload.return_value])
def suite():
"""Gather all the tests from this module in a test suite."""
test_suite = unittest.TestSuite()
test_suite.addTest(unittest.makeSuite(HTMLStripperTests))
test_suite.addTest(unittest.makeSuite(PreDigestTests))
test_suite.addTest(unittest.makeSuite(DigestTests))
test_suite.addTest(unittest.makeSuite(MessageDigestTest))
return test_suite
if __name__ == "__main__":
unittest.main()
|