Skip to content

Latest commit

 

History

History
37 lines (22 loc) · 1.83 KB

README.md

File metadata and controls

37 lines (22 loc) · 1.83 KB
Raw

rule34Py Tests Readme

This project is tested by an organic test suite based on pytest.

Running the Test Suite

To run the unit tests on your repo's source code, install the test suite dependencies declared in :tests/requirements.txt and invoke pytest.

# from the repository root directory ...
source venv/bin/activate
pip install -r tests/requirements.txt

python3 -m pytest tests/

Test Code Layout

  • fixtures/ contains pytest Fixtures common to many testing contexts.
    • mock34/ contains an implementation of the Responses module that intercepts and either proxies or replays requests calls to the rule34 API and website. This fixture allows you to test this project without making real requests over the internet.
  • unit/ contains tests that can be run against the rule34Py source code without building or installing the module.

Updating the Mock34 Responses

The mock34 test fixture maintains a registry of rule34.xxx responses in its responses.yml file. When you run the test suite normally, all requests calls will be intercepted and delivered a replayed response from this registry. If requests makes a call to a URL that is not in the registry, the mock34 Fixture will throw an error.

If you are confident that the requested content is well-formed (as when you are adding a new test case), or if you wish to generally update the registry after an update to the upstream Rule34 API, you can switch the mock34 Fixture into a "record" mode by asserting the environment variable R34_RECORD_RESPONSES=True. When asserted the mock34 Fixture will proxy requests through to the public servers and record their responses in the registry.

export R34_RECORD_RESPONSES=True
python3 -m pytest tests/

Remember to commmit the registry file changes with your test changes.