# Spiders Contracts

Testing spiders can get particularly annoying and while nothing prevents you from writing unit tests the task gets cumbersome quickly. Scrapy offers an integrated way of testing your spiders by the means of contracts.

This allows you to test each callback of your spider by hardcoding a sample url and check various constraints for how the callback processes the response. Each contract is prefixed with an `@` and included in the docstring. See the following example:

    def parse(self, response):
        """
        This function parses a sample response. Some contracts are mingled
        with this docstring.

        @url http://www.example.com/s?field-keywords=selfish+gene
        @returns items 1 16
        @returns requests 0 0
        @scrapes Title Author Year Price
        """

You can use the following contracts:

class scrapy.contracts.default.UrlContract

  This contract (`@url`) sets the sample URL used when checking other contract conditions for this spider. This contract is mandatory. All callbacks lacking this contract are ignored when running the checks:

      @url url

class scrapy.contracts.default.CallbackKeywordArgumentsContract

  This contract (`@cb_kwargs`) sets the `cb_kwargs` attribute for the sample request. It must be a valid JSON dictionary.

      @cb_kwargs {"arg1": "value1", "arg2": "value2", ...}

class scrapy.contracts.default.MetadataContract

  This contract (`@meta`) sets the `meta` attribute for the sample request. It must be a valid JSON dictionary.

      @meta {"arg1": "value1", "arg2": "value2", ...}

class scrapy.contracts.default.ReturnsContract

  This contract (`@returns`) sets lower and upper bounds for the items and requests returned by the spider. The upper bound is optional:

      @returns item(s)|request(s) [min [max]]

class scrapy.contracts.default.ScrapesContract

  This contract (`@scrapes`) checks that all the items returned by the callback have the specified fields:

      @scrapes field_1 field_2 ...

Use the `check` command to run the contract checks.

## Custom Contracts

If you find you need more power than the built-in Scrapy contracts you can create and load your own contracts in the project by using the `SPIDER_CONTRACTS` setting:

    SPIDER_CONTRACTS = {
        "myproject.contracts.ResponseCheck": 10,
        "myproject.contracts.ItemValidate": 10,
    }

Each contract must inherit from `Contract` and can override three methods:

class scrapy.contracts.Contract(method, *args)
  Parameters:

    - method (collections.abc.Callable) – callback function to which the contract is associated

    - args (list) – list of arguments passed into the docstring (whitespace separated)

  adjust_request_args(args)

    This receives a `dict` as an argument containing default arguments for request object. `Request` is used by default, but this can be changed with the `request_cls` attribute. If multiple contracts in chain have this attribute defined, the last one is used.

    Must return the same or a modified version of it.

  pre_process(response)

    This allows hooking in various checks on the response received from the sample request, before it’s being passed to the callback.

  post_process(output)

    This allows processing the output of the callback. Iterators are converted to lists before being passed to this hook.

Raise `ContractFail` from `pre_process` or `post_process` if expectations are not met:

class scrapy.exceptions.ContractFail

  Error raised in case of a failing contract

Here is a demo contract which checks the presence of a custom header in the response received:

    from scrapy.contracts import Contract
    from scrapy.exceptions import ContractFail

    class HasHeaderContract(Contract):
        """
        Demo contract which checks the presence of a custom header
        @has_header X-CustomHeader
        """

        name = "has_header"

        def pre_process(self, response):
            for header in self.args:
                if header not in response.headers:
                    raise ContractFail("X-CustomHeader not present")

## Detecting check runs

When `scrapy check` is running, the `SCRAPY_CHECK` environment variable is set to the `true` string. You can use `os.environ` to perform any change to your spiders or your settings when `scrapy check` is used:

    import os
    import scrapy

    class ExampleSpider(scrapy.Spider):
        name = "example"

        def __init__(self):
            if os.environ.get("SCRAPY_CHECK"):
                pass  # Do some scraper adjustments when a check is running