A test framework for Python that makes mocking and iterating over code with tests a breeze
Project description
# TestSlide: Fluent Python Testing
[](https://travis-ci.com/facebookincubator/TestSlide)
[](LICENSE)
[](https://badge.fury.io/py/TestSlide)
TestSlide makes writing tests fluid and easy. Whether you prefer classic [unit testing](https://docs.python.org/3/library/unittest.html), [TDD](https://en.wikipedia.org/wiki/Test-driven_development) or [BDD](https://en.wikipedia.org/wiki/Behavior-driven_development), it helps you be productive, with its easy to use well behaved mocks and its awesome test runner.
It is designed to work well with other test frameworks, so you can use it on top of existing `unittest.TestCase` without rewriting everything.
## Quickstart
Install:
```
pip install TestSlide
```
Scaffold the code you want to test `backup.py`:
```python
class Backup(object):
def delete(self, path):
pass
```
Write a test case `backup_test.py` describing the expected behavior:
```python
import testslide, backup, storage
class TestBackupDelete(testslide.TestCase):
def setUp(self):
super().setUp()
self.storage_mock = testslide.StrictMock(storage.Client)
# Makes storage.Client(timeout=60) return self.storage_mock
self.mock_constructor(storage, 'Client')\
.for_call(timeout=60)\
.to_return_value(self.storage_mock)
def test_delete_from_storage(self):
# Set behavior and assertion for the call at the mock
self.mock_callable(self.storage_mock, 'delete')\
.for_call('/file/to/delete')\
.to_return_value(True)\
.and_assert_called_once()
backup.Backup().delete('/file/to/delete')
```
TestSlide's `StrictMock`, `mock_constructor()` and `mock_callable()` are seamlessly integrated with Python's TestCase.
Run the test and see the failure:
TestSlide's mocks failure messages guide you towards the solution, that you can now implement:
```python
import storage
class Backup(object):
def __init__(self):
self.storage = storage.Client(timeout=60)
def delete(self, path):
self.storage.delete(path)
```
And watch the test go green:
It is all about letting the failure messages guide you towards the solution. There's a plethora of validation inside TestSlide's mocks, so you can trust they will help you iterate quickly when writing code and also cover you when breaking changes are introduced.
## Full documentation
There's a lot more that TestSlide can offer, please check the full documentation at https://testslide.readthedocs.io/ to learn more.
## Requirements
* Linux
* Python 2 / 3
## Join the TestSlide community
TestSlide is open source software, contributions are very welcome!
See the [CONTRIBUTING](CONTRIBUTING.md) file for how to help out.
## License
TestSlide is MIT licensed, as found in the [LICENSE](LICENSE) file.
[](https://travis-ci.com/facebookincubator/TestSlide)
[](LICENSE)
[](https://badge.fury.io/py/TestSlide)
TestSlide makes writing tests fluid and easy. Whether you prefer classic [unit testing](https://docs.python.org/3/library/unittest.html), [TDD](https://en.wikipedia.org/wiki/Test-driven_development) or [BDD](https://en.wikipedia.org/wiki/Behavior-driven_development), it helps you be productive, with its easy to use well behaved mocks and its awesome test runner.
It is designed to work well with other test frameworks, so you can use it on top of existing `unittest.TestCase` without rewriting everything.
## Quickstart
Install:
```
pip install TestSlide
```
Scaffold the code you want to test `backup.py`:
```python
class Backup(object):
def delete(self, path):
pass
```
Write a test case `backup_test.py` describing the expected behavior:
```python
import testslide, backup, storage
class TestBackupDelete(testslide.TestCase):
def setUp(self):
super().setUp()
self.storage_mock = testslide.StrictMock(storage.Client)
# Makes storage.Client(timeout=60) return self.storage_mock
self.mock_constructor(storage, 'Client')\
.for_call(timeout=60)\
.to_return_value(self.storage_mock)
def test_delete_from_storage(self):
# Set behavior and assertion for the call at the mock
self.mock_callable(self.storage_mock, 'delete')\
.for_call('/file/to/delete')\
.to_return_value(True)\
.and_assert_called_once()
backup.Backup().delete('/file/to/delete')
```
TestSlide's `StrictMock`, `mock_constructor()` and `mock_callable()` are seamlessly integrated with Python's TestCase.
Run the test and see the failure:
TestSlide's mocks failure messages guide you towards the solution, that you can now implement:
```python
import storage
class Backup(object):
def __init__(self):
self.storage = storage.Client(timeout=60)
def delete(self, path):
self.storage.delete(path)
```
And watch the test go green:
It is all about letting the failure messages guide you towards the solution. There's a plethora of validation inside TestSlide's mocks, so you can trust they will help you iterate quickly when writing code and also cover you when breaking changes are introduced.
## Full documentation
There's a lot more that TestSlide can offer, please check the full documentation at https://testslide.readthedocs.io/ to learn more.
## Requirements
* Linux
* Python 2 / 3
## Join the TestSlide community
TestSlide is open source software, contributions are very welcome!
See the [CONTRIBUTING](CONTRIBUTING.md) file for how to help out.
## License
TestSlide is MIT licensed, as found in the [LICENSE](LICENSE) file.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
TestSlide-1.0.0rc1.tar.gz
(23.1 kB
view details)
File details
Details for the file TestSlide-1.0.0rc1.tar.gz.
File metadata
- Download URL: TestSlide-1.0.0rc1.tar.gz
- Upload date:
- Size: 23.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.19.1 setuptools/39.0.1 requests-toolbelt/0.8.0 tqdm/4.26.0 CPython/3.6.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d78c92acd904e8e3815eaa73a1c484e672d2e2932d98cc2ea249d6ceb99e0611 |
|
| MD5 | c08934f26c4ff381aa5ac4dfcc3ed849 |
|
| BLAKE2b-256 | b076ef5c93590370e291ae329dcea27fa58c6981a7fc8b9ae862cdec16717991 |
