Skip to content

Commit bb5c6fc

Browse files
authored
Add extra background to toxiproxy module docs
1 parent cb27c41 commit bb5c6fc

File tree

1 file changed

+12
-3
lines changed

1 file changed

+12
-3
lines changed

docs/modules/toxiproxy.md

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
11
# Toxiproxy Module
22

33
Testcontainers module for Shopify's [Toxiproxy](https://github.com/Shopify/toxiproxy).
4-
This TCP proxy can be used to simulate network failure conditions in between tests and containers.
5-
6-
[toxiproxy-java](https://github.com/trekawek/toxiproxy-java) is used as a client.
4+
This TCP proxy can be used to simulate network failure conditions.
5+
6+
You can simulate network failures:
7+
8+
* between Java code and containers, ideal for testing resilience features of client code
9+
* between containers, for testing resilience and emergent behaviour of multi-container systems
10+
* if desired, between Java code/containers and external resources (non-Dockerized!), for scenarios where not all dependencies can be/have been dockerized
711

12+
Testcontainers Toxiproxy support allows resilience features to be easily verified as part of isolated dev/CI testing. This allows earlier testing of resilience features, and broader sets of failure conditions to be covered.
13+
814
## Usage example
915

1016
A Toxiproxy container can be placed in between test code and a container, or in between containers.
@@ -74,3 +80,6 @@ testCompile "org.testcontainers:toxiproxy:{{latest_version}}"
7480
## Acknowledgements
7581

7682
This module was inspired by a [hotels.com blog post](https://medium.com/hotels-com-technology/i-dont-know-about-resilience-testing-and-so-can-you-b3c59d80012d).
83+
84+
[toxiproxy-java](https://github.com/trekawek/toxiproxy-java) is used to help control failure conditions.
85+

0 commit comments

Comments
 (0)