Pytest Plugin to disable socket calls during tests
A plugin to use with Pytest to disable or restrict socket calls during tests to ensure network calls are prevented.
- Disables all network calls flowing through Python’s socket interface.
- Pytest 3.6.3 or greater
Run pytest --disable-socket, tests should fail on any access to socket or libraries using socket with a SocketBlockedError.
To add this flag as the default behavior, add this section to your pytest.ini or setup.cfg:
[pytest] addopts = --disable-socket
or update your conftest.py to include:
from pytest_socket import disable_socket def pytest_runtest_setup(): disable_socket()
To enable specific tests use of socket, pass in the fixture to the test or use a marker:
def test_explicitly_enable_socket(socket_enabled): assert socket.socket(socket.AF_INET, socket.SOCK_STREAM) @pytest.mark.enable_socket def test_explicitly_enable_socket_with_mark(): assert socket.socket(socket.AF_INET, socket.SOCK_STREAM)
To allow only specific hosts per-test:
@pytest.mark.allow_hosts(['127.0.0.1']) def test_explicitly_enable_socket_with_mark(): assert socket.socket.connect(('127.0.0.1', 80))
or for whole test run
[pytest] addopts = --allow-hosts=127.0.0.1,127.0.1.1
Contributions are very welcome. Tests can be run with tox, please ensure the coverage at least stays the same before you submit a pull request.
Distributed under the terms of the MIT license, “pytest-socket” is free and open source software
If you encounter any problems, please file an issue along with a detailed description.