Rehearser makes writing reliable unit tests super easy!
Project description
Quick Start
You can use Rehearser
to build reliable unit tests quickly
Development Flow:
graph LR
R["Rehearsal<br>runs"]--"interactions<br>file<br>case 1"-->A1["Adjust your<br>expectation"]-->C1["Create<br>Mocks"]-->U1("Unit Test 1")-->F["Finalize<br>Implementation"]
R["Rehearsal<br>runs"]--"interactions<br>file<br>case 2"-->A2["Adjust your<br>expectation"]-->C2["Create<br>Mocks"]-->U2("Unit Test 2")-->F["Finalize<br>Implementation"]
R["Rehearsal<br>runs"]--"interactions<br>file<br>case ..."-->A3["Adjust your<br>expectation"]-->C3["Create<br>Mocks"]-->U3("Unit Test ...")-->F["Finalize<br>Implementation"]
R["Rehearsal<br>runs"]--"interactions<br>file<br>case N"-->AN["Adjust your<br>expectation"]-->CN["Create<br>Mocks"]-->UN("Unit Test N")-->F["Finalize<br>Implementation"]
1. Install Rehearser:
pip install rehearser
2. Creating a Rehearser Proxy:
- Component to be tested :
Usage
- External services:
ProductService
andUserService
graph LR
Usgae["Usage"] -- uses --> ProductService["ProductService"]-- uses -->C["Cache"]
Usgae["Usage"] -- uses --> UserService["UserService"]-- uses -->C["Cache"]
- In this step, we create Rehearser Proxies for instances
ProductService()
andUserService()
, respectively.
rp_product = RehearserProxy(ProductService())
rp_user = RehearserProxy(UserService())
3. Generate Interactions:
Generate mock objects using the interactions created in the previous step.
# Apply patches to UserService and ProductService
with patch(
"rehearser_examples.examples.example1.usage.UserService",
return_value=rp_user,
), patch(
"rehearser_examples.examples.example1.usage.ProductService",
return_value=rp_product,
):
# Rehearsal run
Usage().run_example()
# Generate interactions files
rp_user.set_interactions_file_directory("./raw_files/rehearser_proxy/")
rp_user.write_interactions_to_file()
rp_product.set_interactions_file_directory("./raw_files/rehearser_proxy/")
rp_product.write_interactions_to_file()
- Notes: The interaction files are in json format, and you can adjust these thru editor manually before using these for further Mock object generation.
4. Write Unit Test:
These will be your unit test body:
# Instantiate mock objects
mock_users = MockGenerator(
interactions_src="./raw_files/rehearser_proxy/UserService/latest_interactions.json"
).create_mock()
mock_products = MockGenerator(
interactions_src="./raw_files/rehearser_proxy/ProductService/latest_interactions.json"
).create_mock()
# Apply patches to UserService and ProductService
with patch(
"rehearser_examples.examples.example1.usage.UserService",
return_value=mock_users,
), patch(
"rehearser_examples.examples.example1.usage.ProductService",
return_value=mock_products,
):
# Instantiate Usage with the mocked services
result = Usage().run_example()
# Insert your test assertions here
self.assertTrue(result, "run_example() failed")
Project details
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
rehearser-0.1.4.tar.gz
(10.0 kB
view hashes)
Built Distribution
rehearser-0.1.4-py3-none-any.whl
(10.9 kB
view hashes)
Close
Hashes for rehearser-0.1.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 47b54f66bce66ea97ec105bcb0349dcd606f65312513bd3dd24afb9e004d8f8a |
|
MD5 | afb3ea3ae615f445081b8250b15d988e |
|
BLAKE2b-256 | a8fa7e22ad5f64b99bd4d50b6faf74a0ab119fb9d71f5754f1adf1302373156b |