mirror of https://github.com/scrapy/scrapy.git
346 lines
11 KiB
Python
346 lines
11 KiB
Python
import shutil
|
|
import tempfile
|
|
import unittest
|
|
import collections
|
|
|
|
from twisted.internet import defer
|
|
from twisted.trial.unittest import TestCase
|
|
|
|
from scrapy.crawler import Crawler
|
|
from scrapy.core.downloader import Downloader
|
|
from scrapy.core.scheduler import Scheduler
|
|
from scrapy.http import Request
|
|
from scrapy.spiders import Spider
|
|
from scrapy.utils.httpobj import urlparse_cached
|
|
from scrapy.utils.test import get_crawler
|
|
from tests.mockserver import MockServer
|
|
|
|
|
|
MockEngine = collections.namedtuple('MockEngine', ['downloader'])
|
|
MockSlot = collections.namedtuple('MockSlot', ['active'])
|
|
|
|
|
|
class MockDownloader:
|
|
def __init__(self):
|
|
self.slots = dict()
|
|
|
|
def _set_slot_key(self, slot, request, spider):
|
|
request.meta[Downloader.DOWNLOAD_SLOT] = slot
|
|
|
|
def _get_slot_key(self, request, spider):
|
|
if Downloader.DOWNLOAD_SLOT in request.meta:
|
|
return request.meta[Downloader.DOWNLOAD_SLOT]
|
|
|
|
return urlparse_cached(request).hostname or ''
|
|
|
|
def increment(self, slot_key):
|
|
slot = self.slots.setdefault(slot_key, MockSlot(active=list()))
|
|
slot.active.append(1)
|
|
|
|
def decrement(self, slot_key):
|
|
slot = self.slots.get(slot_key)
|
|
slot.active.pop()
|
|
|
|
def close(self):
|
|
pass
|
|
|
|
|
|
class MockCrawler(Crawler):
|
|
def __init__(self, priority_queue_cls, jobdir):
|
|
|
|
settings = dict(
|
|
LOG_UNSERIALIZABLE_REQUESTS=False,
|
|
SCHEDULER_DISK_QUEUE='scrapy.squeues.PickleLifoDiskQueue',
|
|
SCHEDULER_MEMORY_QUEUE='scrapy.squeues.LifoMemoryQueue',
|
|
SCHEDULER_PRIORITY_QUEUE=priority_queue_cls,
|
|
JOBDIR=jobdir,
|
|
DUPEFILTER_CLASS='scrapy.dupefilters.BaseDupeFilter'
|
|
)
|
|
super(MockCrawler, self).__init__(Spider, settings)
|
|
self.engine = MockEngine(downloader=MockDownloader())
|
|
|
|
|
|
class SchedulerHandler:
|
|
priority_queue_cls = None
|
|
jobdir = None
|
|
|
|
def create_scheduler(self):
|
|
self.mock_crawler = MockCrawler(self.priority_queue_cls, self.jobdir)
|
|
self.scheduler = Scheduler.from_crawler(self.mock_crawler)
|
|
self.spider = Spider(name='spider')
|
|
self.scheduler.open(self.spider)
|
|
|
|
def close_scheduler(self):
|
|
self.scheduler.close('finished')
|
|
self.mock_crawler.stop()
|
|
self.mock_crawler.engine.downloader.close()
|
|
|
|
def setUp(self):
|
|
self.create_scheduler()
|
|
|
|
def tearDown(self):
|
|
self.close_scheduler()
|
|
|
|
|
|
_PRIORITIES = [("http://foo.com/a", -2),
|
|
("http://foo.com/d", 1),
|
|
("http://foo.com/b", -1),
|
|
("http://foo.com/c", 0),
|
|
("http://foo.com/e", 2)]
|
|
|
|
|
|
_URLS = {"http://foo.com/a", "http://foo.com/b", "http://foo.com/c"}
|
|
|
|
|
|
class BaseSchedulerInMemoryTester(SchedulerHandler):
|
|
def test_length(self):
|
|
self.assertFalse(self.scheduler.has_pending_requests())
|
|
self.assertEqual(len(self.scheduler), 0)
|
|
|
|
for url in _URLS:
|
|
self.scheduler.enqueue_request(Request(url))
|
|
|
|
self.assertTrue(self.scheduler.has_pending_requests())
|
|
self.assertEqual(len(self.scheduler), len(_URLS))
|
|
|
|
def test_dequeue(self):
|
|
for url in _URLS:
|
|
self.scheduler.enqueue_request(Request(url))
|
|
|
|
urls = set()
|
|
while self.scheduler.has_pending_requests():
|
|
urls.add(self.scheduler.next_request().url)
|
|
|
|
self.assertEqual(urls, _URLS)
|
|
|
|
def test_dequeue_priorities(self):
|
|
for url, priority in _PRIORITIES:
|
|
self.scheduler.enqueue_request(Request(url, priority=priority))
|
|
|
|
priorities = list()
|
|
while self.scheduler.has_pending_requests():
|
|
priorities.append(self.scheduler.next_request().priority)
|
|
|
|
self.assertEqual(priorities,
|
|
sorted([x[1] for x in _PRIORITIES], key=lambda x: -x))
|
|
|
|
|
|
class BaseSchedulerOnDiskTester(SchedulerHandler):
|
|
|
|
def setUp(self):
|
|
self.jobdir = tempfile.mkdtemp()
|
|
self.create_scheduler()
|
|
|
|
def tearDown(self):
|
|
self.close_scheduler()
|
|
|
|
shutil.rmtree(self.jobdir)
|
|
self.jobdir = None
|
|
|
|
def test_length(self):
|
|
self.assertFalse(self.scheduler.has_pending_requests())
|
|
self.assertEqual(len(self.scheduler), 0)
|
|
|
|
for url in _URLS:
|
|
self.scheduler.enqueue_request(Request(url))
|
|
|
|
self.close_scheduler()
|
|
self.create_scheduler()
|
|
|
|
self.assertTrue(self.scheduler.has_pending_requests())
|
|
self.assertEqual(len(self.scheduler), len(_URLS))
|
|
|
|
def test_dequeue(self):
|
|
for url in _URLS:
|
|
self.scheduler.enqueue_request(Request(url))
|
|
|
|
self.close_scheduler()
|
|
self.create_scheduler()
|
|
|
|
urls = set()
|
|
while self.scheduler.has_pending_requests():
|
|
urls.add(self.scheduler.next_request().url)
|
|
|
|
self.assertEqual(urls, _URLS)
|
|
|
|
def test_dequeue_priorities(self):
|
|
for url, priority in _PRIORITIES:
|
|
self.scheduler.enqueue_request(Request(url, priority=priority))
|
|
|
|
self.close_scheduler()
|
|
self.create_scheduler()
|
|
|
|
priorities = list()
|
|
while self.scheduler.has_pending_requests():
|
|
priorities.append(self.scheduler.next_request().priority)
|
|
|
|
self.assertEqual(priorities,
|
|
sorted([x[1] for x in _PRIORITIES], key=lambda x: -x))
|
|
|
|
|
|
class TestSchedulerInMemory(BaseSchedulerInMemoryTester, unittest.TestCase):
|
|
priority_queue_cls = 'scrapy.pqueues.ScrapyPriorityQueue'
|
|
|
|
|
|
class TestSchedulerOnDisk(BaseSchedulerOnDiskTester, unittest.TestCase):
|
|
priority_queue_cls = 'scrapy.pqueues.ScrapyPriorityQueue'
|
|
|
|
|
|
_SLOTS = [("http://foo.com/a", 'a'),
|
|
("http://foo.com/b", 'a'),
|
|
("http://foo.com/c", 'b'),
|
|
("http://foo.com/d", 'b'),
|
|
("http://foo.com/e", 'c'),
|
|
("http://foo.com/f", 'c')]
|
|
|
|
|
|
class TestMigration(unittest.TestCase):
|
|
|
|
def setUp(self):
|
|
self.tmpdir = tempfile.mkdtemp()
|
|
|
|
def tearDown(self):
|
|
shutil.rmtree(self.tmpdir)
|
|
|
|
def _migration(self, tmp_dir):
|
|
prev_scheduler_handler = SchedulerHandler()
|
|
prev_scheduler_handler.priority_queue_cls = 'scrapy.pqueues.ScrapyPriorityQueue'
|
|
prev_scheduler_handler.jobdir = tmp_dir
|
|
|
|
prev_scheduler_handler.create_scheduler()
|
|
for url in _URLS:
|
|
prev_scheduler_handler.scheduler.enqueue_request(Request(url))
|
|
prev_scheduler_handler.close_scheduler()
|
|
|
|
next_scheduler_handler = SchedulerHandler()
|
|
next_scheduler_handler.priority_queue_cls = 'scrapy.pqueues.DownloaderAwarePriorityQueue'
|
|
next_scheduler_handler.jobdir = tmp_dir
|
|
|
|
next_scheduler_handler.create_scheduler()
|
|
|
|
def test_migration(self):
|
|
with self.assertRaises(ValueError):
|
|
self._migration(self.tmpdir)
|
|
|
|
|
|
class TestSchedulerWithDownloaderAwareInMemory(BaseSchedulerInMemoryTester,
|
|
unittest.TestCase):
|
|
priority_queue_cls = 'scrapy.pqueues.DownloaderAwarePriorityQueue'
|
|
|
|
def test_logic(self):
|
|
downloader = self.mock_crawler.engine.downloader
|
|
for url, slot in _SLOTS:
|
|
request = Request(url)
|
|
downloader._set_slot_key(slot, request, None)
|
|
self.scheduler.enqueue_request(request)
|
|
|
|
slots = list()
|
|
requests = list()
|
|
while self.scheduler.has_pending_requests():
|
|
request = self.scheduler.next_request()
|
|
slot = downloader._get_slot_key(request, None)
|
|
slots.append(slot)
|
|
downloader.increment(slot)
|
|
requests.append(request)
|
|
self.assertEqual(len(slots), len(_SLOTS))
|
|
|
|
for request in requests:
|
|
slot = downloader._get_slot_key(request, None)
|
|
self.mock_crawler.engine.downloader.decrement(slot)
|
|
|
|
unique_slots = len(set(s for _, s in _SLOTS))
|
|
for i in range(0, len(_SLOTS), unique_slots):
|
|
part = slots[i:i + unique_slots]
|
|
self.assertEqual(len(part), len(set(part)))
|
|
|
|
|
|
def _is_slots_unique(base_slots, result_slots):
|
|
unique_slots = len(set(s for _, s in base_slots))
|
|
for i in range(0, len(result_slots), unique_slots):
|
|
part = result_slots[i:i + unique_slots]
|
|
assert len(part) == len(set(part))
|
|
|
|
|
|
class TestSchedulerWithDownloaderAwareOnDisk(BaseSchedulerOnDiskTester,
|
|
unittest.TestCase):
|
|
priority_queue_cls = 'scrapy.pqueues.DownloaderAwarePriorityQueue'
|
|
|
|
def test_logic(self):
|
|
downloader = self.mock_crawler.engine.downloader
|
|
|
|
for url, slot in _SLOTS:
|
|
request = Request(url)
|
|
downloader._set_slot_key(slot, request, None)
|
|
self.scheduler.enqueue_request(request)
|
|
|
|
self.close_scheduler()
|
|
self.create_scheduler()
|
|
|
|
slots = []
|
|
requests = []
|
|
downloader = self.mock_crawler.engine.downloader
|
|
while self.scheduler.has_pending_requests():
|
|
request = self.scheduler.next_request()
|
|
slot = downloader._get_slot_key(request, None)
|
|
slots.append(slot)
|
|
downloader.increment(slot)
|
|
requests.append(request)
|
|
|
|
self.assertEqual(len(slots), len(_SLOTS))
|
|
|
|
for request in requests:
|
|
slot = downloader._get_slot_key(request, None)
|
|
downloader.decrement(slot)
|
|
|
|
_is_slots_unique(_SLOTS, slots)
|
|
self.assertEqual(sum(len(s.active) for s in downloader.slots.values()), 0)
|
|
|
|
|
|
class StartUrlsSpider(Spider):
|
|
|
|
def __init__(self, start_urls):
|
|
self.start_urls = start_urls
|
|
|
|
def parse(self, response):
|
|
pass
|
|
|
|
|
|
class TestIntegrationWithDownloaderAwareOnDisk(TestCase):
|
|
def setUp(self):
|
|
self.crawler = get_crawler(
|
|
StartUrlsSpider,
|
|
{'SCHEDULER_PRIORITY_QUEUE': 'scrapy.pqueues.DownloaderAwarePriorityQueue',
|
|
'DUPEFILTER_CLASS': 'scrapy.dupefilters.BaseDupeFilter'}
|
|
)
|
|
|
|
@defer.inlineCallbacks
|
|
def tearDown(self):
|
|
yield self.crawler.stop()
|
|
|
|
@defer.inlineCallbacks
|
|
def test_integration_downloader_aware_priority_queue(self):
|
|
with MockServer() as mockserver:
|
|
|
|
url = mockserver.url("/status?n=200", is_secure=False)
|
|
slots = [url] * 6
|
|
yield self.crawler.crawl(slots)
|
|
self.assertEqual(self.crawler.stats.get_value('downloader/response_count'),
|
|
len(slots))
|
|
|
|
|
|
class TestIncompatibility(unittest.TestCase):
|
|
|
|
def _incompatible(self):
|
|
settings = dict(
|
|
SCHEDULER_PRIORITY_QUEUE='scrapy.pqueues.DownloaderAwarePriorityQueue',
|
|
CONCURRENT_REQUESTS_PER_IP=1
|
|
)
|
|
crawler = Crawler(Spider, settings)
|
|
scheduler = Scheduler.from_crawler(crawler)
|
|
spider = Spider(name='spider')
|
|
scheduler.open(spider)
|
|
|
|
def test_incompatibility(self):
|
|
with self.assertRaises(ValueError):
|
|
self._incompatible()
|