mirror of https://github.com/scrapy/scrapy.git
510 lines
22 KiB
Python
510 lines
22 KiB
Python
from gzip import GzipFile
|
|
from io import BytesIO
|
|
from pathlib import Path
|
|
from unittest import SkipTest, TestCase
|
|
from warnings import catch_warnings
|
|
|
|
from w3lib.encoding import resolve_encoding
|
|
|
|
from scrapy.downloadermiddlewares.httpcompression import (
|
|
ACCEPTED_ENCODINGS,
|
|
HttpCompressionMiddleware,
|
|
)
|
|
from scrapy.exceptions import NotConfigured, ScrapyDeprecationWarning
|
|
from scrapy.http import HtmlResponse, Request, Response
|
|
from scrapy.responsetypes import responsetypes
|
|
from scrapy.settings import Settings
|
|
from scrapy.spiders import Spider
|
|
from scrapy.utils.gz import gunzip
|
|
from scrapy.utils.test import get_crawler
|
|
from tests import tests_datadir
|
|
|
|
SAMPLEDIR = Path(tests_datadir, "compressed")
|
|
|
|
FORMAT = {
|
|
"gzip": ("html-gzip.bin", "gzip"),
|
|
"x-gzip": ("html-gzip.bin", "gzip"),
|
|
"rawdeflate": ("html-rawdeflate.bin", "deflate"),
|
|
"zlibdeflate": ("html-zlibdeflate.bin", "deflate"),
|
|
"br": ("html-br.bin", "br"),
|
|
# $ zstd raw.html --content-size -o html-zstd-static-content-size.bin
|
|
"zstd-static-content-size": ("html-zstd-static-content-size.bin", "zstd"),
|
|
# $ zstd raw.html --no-content-size -o html-zstd-static-no-content-size.bin
|
|
"zstd-static-no-content-size": ("html-zstd-static-no-content-size.bin", "zstd"),
|
|
# $ cat raw.html | zstd -o html-zstd-streaming-no-content-size.bin
|
|
"zstd-streaming-no-content-size": (
|
|
"html-zstd-streaming-no-content-size.bin",
|
|
"zstd",
|
|
),
|
|
}
|
|
|
|
|
|
class HttpCompressionTest(TestCase):
|
|
def setUp(self):
|
|
self.crawler = get_crawler(Spider)
|
|
self.spider = self.crawler._create_spider("scrapytest.org")
|
|
self.mw = HttpCompressionMiddleware.from_crawler(self.crawler)
|
|
self.crawler.stats.open_spider(self.spider)
|
|
|
|
def _getresponse(self, coding):
|
|
if coding not in FORMAT:
|
|
raise ValueError()
|
|
|
|
samplefile, contentencoding = FORMAT[coding]
|
|
|
|
body = (SAMPLEDIR / samplefile).read_bytes()
|
|
|
|
headers = {
|
|
"Server": "Yaws/1.49 Yet Another Web Server",
|
|
"Date": "Sun, 08 Mar 2009 00:41:03 GMT",
|
|
"Content-Length": len(body),
|
|
"Content-Type": "text/html",
|
|
"Content-Encoding": contentencoding,
|
|
}
|
|
|
|
response = Response("http://scrapytest.org/", body=body, headers=headers)
|
|
response.request = Request(
|
|
"http://scrapytest.org", headers={"Accept-Encoding": "gzip, deflate"}
|
|
)
|
|
return response
|
|
|
|
def assertStatsEqual(self, key, value):
|
|
self.assertEqual(
|
|
self.crawler.stats.get_value(key, spider=self.spider),
|
|
value,
|
|
str(self.crawler.stats.get_stats(self.spider)),
|
|
)
|
|
|
|
def test_setting_false_compression_enabled(self):
|
|
self.assertRaises(
|
|
NotConfigured,
|
|
HttpCompressionMiddleware.from_crawler,
|
|
get_crawler(settings_dict={"COMPRESSION_ENABLED": False}),
|
|
)
|
|
|
|
def test_setting_default_compression_enabled(self):
|
|
self.assertIsInstance(
|
|
HttpCompressionMiddleware.from_crawler(get_crawler()),
|
|
HttpCompressionMiddleware,
|
|
)
|
|
|
|
def test_setting_true_compression_enabled(self):
|
|
self.assertIsInstance(
|
|
HttpCompressionMiddleware.from_crawler(
|
|
get_crawler(settings_dict={"COMPRESSION_ENABLED": True})
|
|
),
|
|
HttpCompressionMiddleware,
|
|
)
|
|
|
|
def test_process_request(self):
|
|
request = Request("http://scrapytest.org")
|
|
assert "Accept-Encoding" not in request.headers
|
|
self.mw.process_request(request, self.spider)
|
|
self.assertEqual(
|
|
request.headers.get("Accept-Encoding"), b", ".join(ACCEPTED_ENCODINGS)
|
|
)
|
|
|
|
def test_process_response_gzip(self):
|
|
response = self._getresponse("gzip")
|
|
request = response.request
|
|
|
|
self.assertEqual(response.headers["Content-Encoding"], b"gzip")
|
|
newresponse = self.mw.process_response(request, response, self.spider)
|
|
self.assertNotEqual(newresponse, response)
|
|
self.assertTrue(newresponse.body.startswith(b"<!DOCTYPE"))
|
|
self.assertIn("Content-Encoding", newresponse.headers)
|
|
self.assertNotIn(b"gzip", newresponse.headers["Content-Encoding"])
|
|
self.assertStatsEqual("httpcompression/response_count", 1)
|
|
self.assertStatsEqual("httpcompression/response_bytes", 74837)
|
|
|
|
def test_process_response_gzip_no_stats(self):
|
|
mw = HttpCompressionMiddleware(
|
|
settings=Settings({"COMPRESSION_KEEP_ENCODING_HEADER": True})
|
|
)
|
|
response = self._getresponse("gzip")
|
|
request = response.request
|
|
|
|
self.assertEqual(response.headers["Content-Encoding"], b"gzip")
|
|
newresponse = mw.process_response(request, response, self.spider)
|
|
self.assertEqual(mw.stats, None)
|
|
self.assertNotEqual(newresponse, response)
|
|
self.assertTrue(newresponse.body.startswith(b"<!DOCTYPE"))
|
|
self.assertIn("Content-Encoding", newresponse.headers)
|
|
self.assertNotIn(b"gzip", newresponse.headers["Content-Encoding"])
|
|
|
|
def test_process_response_br(self):
|
|
try:
|
|
import brotli # noqa: F401
|
|
except ImportError:
|
|
raise SkipTest("no brotli")
|
|
response = self._getresponse("br")
|
|
request = response.request
|
|
self.assertEqual(response.headers["Content-Encoding"], b"br")
|
|
newresponse = self.mw.process_response(request, response, self.spider)
|
|
self.assertNotEqual(newresponse, response)
|
|
self.assertTrue(newresponse.body.startswith(b"<!DOCTYPE"))
|
|
self.assertIn("Content-Encoding", newresponse.headers)
|
|
self.assertEqual(b"br", newresponse.headers["Content-Encoding"])
|
|
self.assertStatsEqual("httpcompression/response_count", 1)
|
|
self.assertStatsEqual("httpcompression/response_bytes", 74837)
|
|
|
|
def test_process_response_zstd(self):
|
|
try:
|
|
import zstandard # noqa: F401
|
|
except ImportError:
|
|
raise SkipTest("no zstd support (zstandard)")
|
|
raw_content = None
|
|
for check_key in FORMAT:
|
|
if not check_key.startswith("zstd-"):
|
|
continue
|
|
response = self._getresponse(check_key)
|
|
request = response.request
|
|
self.assertEqual(response.headers["Content-Encoding"], b"zstd")
|
|
newresponse = self.mw.process_response(request, response, self.spider)
|
|
if raw_content is None:
|
|
raw_content = newresponse.body
|
|
else:
|
|
self.assertEqual(raw_content, newresponse.body)
|
|
self.assertNotEqual(newresponse, response)
|
|
self.assertTrue(newresponse.body.startswith(b"<!DOCTYPE"))
|
|
self.assertIn("Content-Encoding", newresponse.headers)
|
|
self.assertEqual(b"zstd", newresponse.headers["Content-Encoding"])
|
|
|
|
def test_process_response_rawdeflate(self):
|
|
response = self._getresponse("rawdeflate")
|
|
request = response.request
|
|
|
|
self.assertEqual(response.headers["Content-Encoding"], b"deflate")
|
|
newresponse = self.mw.process_response(request, response, self.spider)
|
|
self.assertNotEqual(newresponse, response)
|
|
self.assertTrue(newresponse.body.startswith(b"<!DOCTYPE"))
|
|
self.assertIn("Content-Encoding", newresponse.headers)
|
|
self.assertIn(b"deflate", newresponse.headers["Content-Encoding"])
|
|
self.assertStatsEqual("httpcompression/response_count", 1)
|
|
self.assertStatsEqual("httpcompression/response_bytes", 74840)
|
|
self.assertIn(b"decoded", newresponse.flags)
|
|
|
|
def test_process_response_zlibdelate(self):
|
|
response = self._getresponse("zlibdeflate")
|
|
request = response.request
|
|
|
|
self.assertEqual(response.headers["Content-Encoding"], b"deflate")
|
|
newresponse = self.mw.process_response(request, response, self.spider)
|
|
self.assertNotEqual(newresponse, response)
|
|
self.assertTrue(newresponse.body.startswith(b"<!DOCTYPE"))
|
|
self.assertIn("Content-Encoding", newresponse.headers)
|
|
self.assertIn(b"deflate", newresponse.headers["Content-Encoding"])
|
|
self.assertStatsEqual("httpcompression/response_count", 1)
|
|
self.assertStatsEqual("httpcompression/response_bytes", 74840)
|
|
self.assertIn(b"decoded", newresponse.flags)
|
|
|
|
def test_process_response_plain(self):
|
|
response = Response("http://scrapytest.org", body=b"<!DOCTYPE...")
|
|
request = Request("http://scrapytest.org")
|
|
|
|
self.assertTrue(not response.headers.get("Content-Encoding"))
|
|
newresponse = self.mw.process_response(request, response, self.spider)
|
|
self.assertEqual(newresponse, response)
|
|
self.assertTrue(newresponse.body.startswith(b"<!DOCTYPE"))
|
|
self.assertNotIn("Content-Encoding", newresponse.headers)
|
|
self.assertStatsEqual("httpcompression/response_count", None)
|
|
self.assertStatsEqual("httpcompression/response_bytes", None)
|
|
|
|
def test_multipleencodings(self):
|
|
response = self._getresponse("gzip")
|
|
response.headers["Content-Encoding"] = ["uuencode", "gzip"]
|
|
request = response.request
|
|
newresponse = self.mw.process_response(request, response, self.spider)
|
|
self.assertEqual(newresponse.headers.getlist("Content-Encoding"), [b"uuencode"])
|
|
self.assertNotEqual(newresponse, response)
|
|
self.assertEqual(
|
|
newresponse.headers.getlist("Content-Encoding"), [b"uuencode", b"gzip"]
|
|
)
|
|
self.assertIn(b"decoded", newresponse.flags)
|
|
|
|
def test_process_response_encoding_inside_body(self):
|
|
headers = {
|
|
"Content-Type": "text/html",
|
|
"Content-Encoding": "gzip",
|
|
}
|
|
f = BytesIO()
|
|
plainbody = (
|
|
b"<html><head><title>Some page</title>"
|
|
b'<meta http-equiv="Content-Type" content="text/html; charset=gb2312">'
|
|
)
|
|
zf = GzipFile(fileobj=f, mode="wb")
|
|
zf.write(plainbody)
|
|
zf.close()
|
|
response = Response(
|
|
"http;//www.example.com/", headers=headers, body=f.getvalue()
|
|
)
|
|
request = Request("http://www.example.com/")
|
|
|
|
newresponse = self.mw.process_response(request, response, self.spider)
|
|
self.assertIsInstance(newresponse, HtmlResponse)
|
|
self.assertEqual(newresponse.body, plainbody)
|
|
self.assertEqual(newresponse.encoding, resolve_encoding("gb2312"))
|
|
self.assertStatsEqual("httpcompression/response_count", 1)
|
|
self.assertIn("Content-Encoding", newresponse.headers)
|
|
self.assertEqual(b"gzip", newresponse.headers["Content-Encoding"])
|
|
self.assertIn(b"decoded", newresponse.flags)
|
|
self.assertStatsEqual("httpcompression/response_bytes", len(plainbody))
|
|
|
|
def test_process_response_force_recalculate_encoding(self):
|
|
headers = {
|
|
"Content-Type": "text/html",
|
|
"Content-Encoding": "gzip",
|
|
}
|
|
f = BytesIO()
|
|
plainbody = (
|
|
b"<html><head><title>Some page</title>"
|
|
b'<meta http-equiv="Content-Type" content="text/html; charset=gb2312">'
|
|
)
|
|
zf = GzipFile(fileobj=f, mode="wb")
|
|
zf.write(plainbody)
|
|
zf.close()
|
|
response = HtmlResponse(
|
|
"http;//www.example.com/page.html", headers=headers, body=f.getvalue()
|
|
)
|
|
request = Request("http://www.example.com/")
|
|
|
|
newresponse = self.mw.process_response(request, response, self.spider)
|
|
self.assertIsInstance(newresponse, HtmlResponse)
|
|
self.assertEqual(newresponse.body, plainbody)
|
|
self.assertEqual(newresponse.encoding, resolve_encoding("gb2312"))
|
|
self.assertIn("Content-Encoding", newresponse.headers)
|
|
self.assertEqual(b"gzip", newresponse.headers["Content-Encoding"])
|
|
self.assertStatsEqual("httpcompression/response_count", 1)
|
|
self.assertIn(b"decoded", newresponse.flags)
|
|
self.assertStatsEqual("httpcompression/response_bytes", len(plainbody))
|
|
|
|
def test_process_response_no_content_type_header(self):
|
|
headers = {
|
|
"Content-Encoding": "identity",
|
|
}
|
|
plainbody = (
|
|
b"<html><head><title>Some page</title>"
|
|
b'<meta http-equiv="Content-Type" content="text/html; charset=gb2312">'
|
|
)
|
|
respcls = responsetypes.from_args(
|
|
url="http://www.example.com/index", headers=headers, body=plainbody
|
|
)
|
|
response = respcls(
|
|
"http://www.example.com/index", headers=headers, body=plainbody
|
|
)
|
|
request = Request("http://www.example.com/index")
|
|
|
|
newresponse = self.mw.process_response(request, response, self.spider)
|
|
self.assertIsInstance(newresponse, respcls)
|
|
self.assertEqual(newresponse.body, plainbody)
|
|
self.assertEqual(newresponse.encoding, resolve_encoding("gb2312"))
|
|
self.assertIn("Content-Encoding", newresponse.headers)
|
|
self.assertEqual(b"identity", newresponse.headers["Content-Encoding"])
|
|
self.assertStatsEqual("httpcompression/response_count", 1)
|
|
self.assertIn(b"decode", newresponse.flags)
|
|
self.assertStatsEqual("httpcompression/response_bytes", len(plainbody))
|
|
|
|
def test_process_response_gzipped_contenttype(self):
|
|
response = self._getresponse("gzip")
|
|
response.headers["Content-Type"] = "application/gzip"
|
|
request = response.request
|
|
|
|
newresponse = self.mw.process_response(request, response, self.spider)
|
|
self.assertIsNot(newresponse, response)
|
|
self.assertTrue(newresponse.body.startswith(b"<!DOCTYPE"))
|
|
self.assertIn("Content-Encoding", newresponse.headers)
|
|
self.assertEqual(b"gzip", newresponse.headers["Content-Encoding"])
|
|
self.assertStatsEqual("httpcompression/response_count", 1)
|
|
self.assertStatsEqual("httpcompression/response_bytes", 74837)
|
|
self.assertIn(b"decoded", newresponse.flags)
|
|
|
|
def test_process_response_gzip_app_octetstream_contenttype(self):
|
|
response = self._getresponse("gzip")
|
|
response.headers["Content-Type"] = "application/octet-stream"
|
|
request = response.request
|
|
|
|
newresponse = self.mw.process_response(request, response, self.spider)
|
|
self.assertIsNot(newresponse, response)
|
|
self.assertTrue(newresponse.body.startswith(b"<!DOCTYPE"))
|
|
self.assertIn("Content-Encoding", newresponse.headers)
|
|
self.assertEqual(b"gzip", newresponse.headers["Content-Encoding"])
|
|
self.assertStatsEqual("httpcompression/response_count", 1)
|
|
self.assertStatsEqual("httpcompression/response_bytes", 74837)
|
|
self.assertIn(b"decoded", newresponse.flags)
|
|
|
|
def test_process_response_gzip_binary_octetstream_contenttype(self):
|
|
response = self._getresponse("x-gzip")
|
|
response.headers["Content-Type"] = "binary/octet-stream"
|
|
request = response.request
|
|
|
|
newresponse = self.mw.process_response(request, response, self.spider)
|
|
self.assertIsNot(newresponse, response)
|
|
self.assertTrue(newresponse.body.startswith(b"<!DOCTYPE"))
|
|
self.assertIn("Content-Encoding", newresponse.headers)
|
|
self.assertEqual(b"gzip", newresponse.headers["Content-Encoding"])
|
|
self.assertStatsEqual("httpcompression/response_count", 1)
|
|
self.assertStatsEqual("httpcompression/response_bytes", 74837)
|
|
self.assertIn(b"decoded", newresponse.flags)
|
|
|
|
def test_process_response_gzipped_gzip_file(self):
|
|
"""Test that a gzip Content-Encoded .gz file is gunzipped
|
|
only once by the middleware, leaving gunzipping of the file
|
|
to upper layers.
|
|
"""
|
|
headers = {
|
|
"Content-Type": "application/gzip",
|
|
"Content-Encoding": "gzip",
|
|
}
|
|
# build a gzipped file (here, a sitemap)
|
|
f = BytesIO()
|
|
plainbody = b"""<?xml version="1.0" encoding="UTF-8"?>
|
|
<urlset xmlns="http://www.google.com/schemas/sitemap/0.84">
|
|
<url>
|
|
<loc>http://www.example.com/</loc>
|
|
<lastmod>2009-08-16</lastmod>
|
|
<changefreq>daily</changefreq>
|
|
<priority>1</priority>
|
|
</url>
|
|
<url>
|
|
<loc>http://www.example.com/Special-Offers.html</loc>
|
|
<lastmod>2009-08-16</lastmod>
|
|
<changefreq>weekly</changefreq>
|
|
<priority>0.8</priority>
|
|
</url>
|
|
</urlset>"""
|
|
gz_file = GzipFile(fileobj=f, mode="wb")
|
|
gz_file.write(plainbody)
|
|
gz_file.close()
|
|
|
|
# build a gzipped response body containing this gzipped file
|
|
r = BytesIO()
|
|
gz_resp = GzipFile(fileobj=r, mode="wb")
|
|
gz_resp.write(f.getvalue())
|
|
gz_resp.close()
|
|
|
|
response = Response(
|
|
"http;//www.example.com/", headers=headers, body=r.getvalue()
|
|
)
|
|
request = Request("http://www.example.com/")
|
|
|
|
newresponse = self.mw.process_response(request, response, self.spider)
|
|
self.assertEqual(gunzip(newresponse.body), plainbody)
|
|
self.assertStatsEqual("httpcompression/response_count", 1)
|
|
self.assertStatsEqual("httpcompression/response_bytes", 230)
|
|
self.assertIn("Content-Encoding", newresponse.headers)
|
|
self.assertEqual(b"gzip", newresponse.headers["Content-Encoding"])
|
|
self.assertIn(b"decoded", newresponse.flags)
|
|
|
|
def test_process_response_head_request_no_decode_required(self):
|
|
response = self._getresponse("gzip")
|
|
response.headers["Content-Type"] = "application/gzip"
|
|
request = response.request
|
|
request.method = "HEAD"
|
|
response = response.replace(body=None)
|
|
newresponse = self.mw.process_response(request, response, self.spider)
|
|
self.assertIs(newresponse, response)
|
|
self.assertEqual(response.body, b"")
|
|
self.assertIn("Content-Encoding", newresponse.headers)
|
|
self.assertEqual(b"gzip", newresponse.headers["Content-Encoding"])
|
|
self.assertStatsEqual("httpcompression/response_count", None)
|
|
self.assertStatsEqual("httpcompression/response_bytes", None)
|
|
|
|
def test_process_response_keeps_content_encoding_header(self):
|
|
settings = {
|
|
"COMPRESSION_ENABLED": True,
|
|
"COMPRESSION_KEEP_ENCODING_HEADER": True,
|
|
}
|
|
crawler = get_crawler(Spider, settings)
|
|
spider = crawler._create_spider("example.com")
|
|
mw = HttpCompressionMiddleware.from_crawler(crawler)
|
|
response = self._getresponse("gzip")
|
|
request = response.request
|
|
|
|
self.assertEqual(response.headers["Content-Encoding"], b"gzip")
|
|
newresponse = mw.process_response(request, response, spider)
|
|
self.assertIsNot(newresponse, response)
|
|
self.assertTrue(newresponse.body.startswith(b"<!DOCTYPE"))
|
|
self.assertIn("Content-Encoding", newresponse.headers)
|
|
self.assertNotIn(b"gzip", newresponse.headers["Content-Encoding"])
|
|
self.assertIn(b"decoded", newresponse.flags)
|
|
|
|
def test_process_response_doesnt_keep_content_encoding_header(self):
|
|
settings = {
|
|
"COMPRESSION_ENABLED": True,
|
|
"COMPRESSION_KEEP_ENCODING_HEADER": False,
|
|
}
|
|
crawler = get_crawler(Spider, settings)
|
|
spider = crawler._create_spider("example.com")
|
|
mw = HttpCompressionMiddleware.from_crawler(crawler)
|
|
response = self._getresponse("gzip")
|
|
request = response.request
|
|
|
|
self.assertEqual(response.headers["Content-Encoding"], b"gzip")
|
|
newresponse = mw.process_response(request, response, spider)
|
|
self.assertIsNot(newresponse, response)
|
|
self.assertTrue(newresponse.body.startswith(b"<!DOCTYPE"))
|
|
self.assertNotIn("Content-Encoding", newresponse.headers)
|
|
self.assertIn(b"decoded", newresponse.flags)
|
|
|
|
|
|
class HttpCompressionSubclassTest(TestCase):
|
|
def test_from_crawler_missing_args(self):
|
|
class HttpCompressionMiddlewareSubclass(HttpCompressionMiddleware):
|
|
def __init__(self):
|
|
super().__init__()
|
|
|
|
crawler = get_crawler(Spider)
|
|
with catch_warnings(record=True) as caught_warnings:
|
|
HttpCompressionMiddlewareSubclass.from_crawler(crawler)
|
|
messages = tuple(
|
|
str(warning.message)
|
|
for warning in caught_warnings
|
|
if warning.category is ScrapyDeprecationWarning
|
|
)
|
|
self.assertEqual(
|
|
messages,
|
|
(
|
|
"HttpCompressionMiddleware subclasses must either modify "
|
|
"their '__init__' method to support 'stats' and 'settings' parameters "
|
|
"or reimplement the 'from_crawler' method.",
|
|
"HttpCompressionMiddleware now accepts a 'stats' parameter which should be specified.",
|
|
"HttpCompressionMiddleware now accepts a 'settings' parameter which should be specified.",
|
|
),
|
|
)
|
|
|
|
def test_init_missing_args(self):
|
|
with catch_warnings(record=True) as caught_warnings:
|
|
self.assertIsNotNone(HttpCompressionMiddleware(stats=None, settings=None))
|
|
messages = tuple(
|
|
str(warning.message)
|
|
for warning in caught_warnings
|
|
if warning.category is ScrapyDeprecationWarning
|
|
)
|
|
|
|
self.assertEqual(
|
|
messages,
|
|
(
|
|
"HttpCompressionMiddleware now accepts a 'stats' parameter which should be specified.",
|
|
"HttpCompressionMiddleware now accepts a 'settings' parameter which should be specified.",
|
|
),
|
|
)
|
|
|
|
def test_init_keep_encoding_header_deprecation_warning(self):
|
|
from scrapy.settings import Settings
|
|
|
|
settings = Settings({"COMPRESSION_KEEP_ENCODING_HEADER": False})
|
|
|
|
with catch_warnings(record=True) as caught_warnings:
|
|
mw = HttpCompressionMiddleware(stats={"foo": "bar"}, settings=settings)
|
|
self.assertIsNotNone(mw)
|
|
messages = tuple(
|
|
str(warning.message)
|
|
for warning in caught_warnings
|
|
if warning.category is ScrapyDeprecationWarning
|
|
)
|
|
|
|
self.assertEqual(
|
|
messages,
|
|
("Setting COMPRESSION_KEEP_ENCODING_HEADER=False is deprecated",),
|
|
)
|