Scrapy-Pytest

Scrapy-Pytest，是基于pytest的方便为Scrapy框架写的爬虫设计的单元测试工具。其主要基于Scrapy的HTTPCache 功能缓存的Request和Response数据，通过HTTP缓存，生产对应的Request和Response对象，可以不重新依赖 于网络进行对Scrapy爬虫的测试，目前可以支持自动生产Scrapy爬虫的各个解析函数（内置parse或自定义）单元测试文件， 模版，以及简单的HTTP缓存的Web Server管理功能

Install

以下提供两种方式：

1. 在项目根目录中执行以下命令即可

pip install -e git+https://github.com/Barnettxxf/scrapy_pytest#egg=scrapy_pytest

该方法会在项目根目录上自动创建src文件并将本项目代码克隆到src文件夹中作为library root 2. 将本项目克隆到本地，切换至其文件夹中，在用pip安装

git clone https://github.com/Barnettxxf/scrapy_pytest.git
cd scrapy_pytest && pip install .

该方法会将scrapy_pytest作为第三方包放置在对应python环境的site-packages文件夹下

Usage

1. 定义HTTP缓存的目录

# content of cache_dir.py 和spiders同一级目录
import os

cache_dir = os.path.join(os.path.dirname(__file__), 'cache')

2. Scrapy爬虫例子, 并运行，将HTTP缓存下来，供后面测试使用

# part content of spiders/wangyi.py, you can see all in tests/spiders/wangyi.py
import scrapy
from scrapy.crawler import CrawlerProcess
from scrapy_pytest import storage_class

from cache_dir import cache_dir


class WangyiSpider(scrapy.Spider):
    name = 'wangyi'

    def start_requests(self):
        ...

    def parse(self, response):
        ...

    def parse_detail(self, response):
        ...


if __name__ == '__main__':
    settings = {
        'HTTPCACHE_ENABLED': True,
        'HTTPCACHE_DIR': cache_dir,
        'HTTPCACHE_STORAGE': storage_class['filesystem']
    }
    cp = CrawlerProcess(settings=settings)
    cp.crawl(WangyiSpider)
    cp.start()

3. 编写单元测试模版生成脚本，使用scrapy_pytest生成基于pytest的单元测试文件

# content of template_factory.py
from scrapy_pytest.factory import TemplateFactory
from scrapy_pytest import env
from spiders import WangyiSpider
from cache_dir import cache_dir

env.set_httpcache_dir(cache_dir) # tell your httpcache dir location


tmpl_factory = TemplateFactory(WangyiSpider, test_dir_name='auto_gen_tests')
tmpl_factory.gen_template()

运行后将会得到类似的文件目录

cache_dir.py

template_factory.py
    # content .. see above

spiders/
    wangyi.py
        # content ... see above 

auto_gen_tests/  # automaically generated by template_factory.py
    __init__.py
    
    wangyi/
        __init__.py
        
        conftest.py
            # content of tests/tests/wangyi/contest.py
            # automatically created by scrapy_pytest
            
            
            import pytest
            from scrapy_pytest import factory, env
            from tests.spiders.Wangyi import WangyiSpider as _WangyiSpider
            
            ... # you can see all in tests/auto_gen_tests/wangyi/conftest.py
            
            @pytest.fixture(scope="module", params=rsp_factory.result['parse_detail'])
            def parse_detail_response(empty, request):
                if isinstance(request.param, (tuple, list)):
                    response = request.param[0]
                else:
                    response = request.param
                return response
        
        test_parse.py
            # content of tests/tests/wangyi/contest.py
            # automatically created by scrapy_pytest


            def test_parse(parse_response, WangyiSpider):
                gen = WangyiSpider().parse(parse_response)
                for result in gen:
                    # specified operation
                    pass
            
            ... # you can see all in tests/auto_gen_tests/wangyi/test_parse.py

cache/
    # httpcache dir
    ...

Web Server

...

TODO

...