Scrapy Autounit is an automatic test generation tool for your Scrapy spiders.
Scrapy Autounit generates test fixtures and tests cases as you run your spiders. The test fixtures are generated from the items and requests that your spider yields, then the test cases evaluate those fixtures against your spiders' callbacks.
Scrapy Autounit generates fixtures and tests per spider and callback under the Scrapy project root directory.
Here is an example of the directory tree of your project once the tests are created:
my_project
├── autounit
│ ├── __init__.py
│ └── tests
│ ├── __init__.py
│ └── my_spider
│ ├── __init__.py
│ └── my_callback
│ ├── __init__.py
│ ├── fixture1.bin
│ ├── fixture2.bin
│ ├── test_fixture1.py
│ ├── test_fixture2.py
├── my_project
│ ├── __init__.py
│ ├── items.py
│ ├── middlewares.py
│ ├── pipelines.py
│ ├── settings.py
│ └── spiders
│ ├── __init__.py
│ └── my_spider.py
└── scrapy.cfg
pip install scrapy_autounit
Add the spider middleware to your SPIDER_MIDDLEWARES
setting (no specific order required):
SPIDER_MIDDLEWARES = {
'scrapy_autounit.AutounitMiddleware': 950
}
Make sure you enable Scrapy Autounit in your settings:
AUTOUNIT_ENABLED = True
To generate your fixtures and tests just run your spiders as usual, Scrapy Autounit will generate them for you.
$ scrapy crawl my_spider
When the spider finishes, a directory autounit
is created in your project root dir, containing all the generated tests/fixtures for the spider you just ran (see the directory tree example above).
If you want to update your tests and fixtures you only need to run your spiders again.
To run your tests you can use unittest
regular commands.
$ python -m unittest
$ python -m unittest discover -s autounit.tests.my_spider
$ python -m unittest discover -s autounit.tests.my_spider.my_callback
$ python -m unittest autounit.tests.my_spider.my_callback.test_fixture2
-
Keep in mind that as long as
AUTOUNIT_ENABLED
is on, each time you run a spider tests/fixtures are going to be generated for its callbacks.
This means that if you have your tests/fixtures ready to go, this setting should be off to prevent undesired overwrites.
Each time you want to regenerate your tests (e.g.: due to changes in your spiders), you can turn this on again and run your spiders as usual. -
Autounit uses an internal
_autounit
key in requests' meta dictionaries. Avoid using/overriding this key in your spiders when adding data to meta to prevent unexpected behaviours.
AUTOUNIT_ENABLED
Set this to True
or False
to enable or disable unit test generation.
AUTOUNIT_MAX_FIXTURES_PER_CALLBACK
Sets the maximum number of fixtures to store per callback.
Minimum: 10
Default: 10
AUTOUNIT_EXCLUDED_FIELDS
Sets a list of fields to be excluded when recording your callbacks' items. It's useful to bypass fields that return a different value on each run.
For example if you have a field that is always set to datetime.now()
in your spider, you probably want to add that field to this list to be excluded from fixtures. Otherwise you'll get a different value when you're generating your fixtures than when you're running your tests, making your tests fail.
Default: []
AUTOUNIT_SKIPPED_FIELDS
Sets a list of item fields to be skipped when running your tests.
It's very similar to AUTOUNIT_EXCLUDED_FIELDS with the difference that these fields will still be recorded in fixtures but they'll be skipped on tests.
Default: []
AUTOUNIT_REQUEST_SKIPPED_FIELDS
Sets a list of request fields to be skipped when running your tests.
Similar to AUTOUNIT_SKIPPED_FIELDS but applied to requests instead of items.
Default: []
AUTOUNIT_EXCLUDED_HEADERS
Sets a list of headers to exclude from requests recording.
For security reasons, Autounit already excludes Authorization
and Proxy-Authorization
headers by default, if you want to include them in your fixtures see AUTOUNIT_INCLUDED_AUTH_HEADERS
.
Default: []
AUTOUNIT_INCLUDED_AUTH_HEADERS
If you want to include Authorization
or Proxy-Authorization
headers in your fixtures, add one or both of them to this list.
Default: []
AUTOUNIT_INCLUDED_SETTINGS
Sets a list of settings names to be recorded in the generated test case.
Default: []
AUTOUNIT_EXTRA_PATH
This is an extra string element to add to the test path and name between the spider name and callback name. You can use this to separate tests from the same spider with different configurations.
Default: None
Note: Remember that you can always apply any of these settings per spider including them in your spider's custom_settings
class attribute - see https://docs.scrapy.org/en/latest/topics/settings.html#settings-per-spider.