Skip to main content

unittest_sandbox provides a @sandbox decorator which ensures unit test methods do not make any socket/web requests during test execution.

Project description

# unittest-sandbox
unittest-sandbox provides a @sandbox decorator which ensures unit test methods do not make any socket/web requests during test execution.
Note: This currently only works with Python 3.

## Installation
To install run:
`pip install unittest_sandbox`

## Example usage
```python
from unittest import TestCase

import requests

from unittest_sandbox import InternetAccessBlockedException, sandbox

# The @sandbox() decorator can be applied to methods individually like below

class RequestTests(TestCase):
def test_non_request_works(self):
self.assertEqual(1 + 1, 2)

@sandbox()
def test_web_request_raises_exception_when_sandbox_decorator_is_applied(self):
# If a web request is sent in a test method wrapped with the @sandbox decorator,
# an InternetAccessBlockedException will be raised.

with self.assertRaises(InternetAccessBlockedException):
requests.get('https://www.google.com')

# The @sandbox() decorator can also be applied to the class as a whole. This is the same as decorating
# all 'test_' methods with @sandbox()

@sandbox()
class RequestTests(TestCase):
def test_non_request_works(self):
self.assertEqual(1 + 1, 2)

def test_web_request_raises_exception_when_sandbox_decorator_is_applied(self):
# If a web request is sent in a test method wrapped with the @sandbox decorator,
# an InternetAccessBlockedException will be raised.

with self.assertRaises(InternetAccessBlockedException):
requests.get('https://www.google.com')

```

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

unittest_sandbox-1.0.1.tar.gz (2.3 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page