Automate testing of poor network conditions with Shopify's Toxiproxy in Go
Posted on Sunday, 5th December 2021
What is Toxiproxy?
Toxiproxy is a TCP Proxy built by Shopify and written in Go designed for simulating a wide range of network conditions.
Built specifically to work in testing, continuous integration and development environments, Toxiproxy's strength comes from the fact that it provides a dynamic API that allows you to easily add, remove and configure the type of network conditions you want to test against on the fly.
Toxiproxy comes in two parts:
- A TCP Proxy written in Go, this acts as a server for proxying TCP traffic between the host machine and the upstream service you wish to simulate network conditions against.
- A client used for communicating with the Toxiproxy server over HTTP. There are a wide range of Toxiproxy clients available from .NET, Ruby and PHP to Rust, Elixir and Haskell.
Let's get started
Starting the Toxiproxy server
Before we can begin we need to download and run the Toxiproxy server. You can either run the server in a Docker container (really helpful for automated tests) or directly via an executable.
Head over to the Toxiproxy installation section to find your preferred approach.
Once running you should see the following output in your terminal:
$ INFO API HTTP server starting host=localhost port=8474 version=git
With the Toxiproxy server now running, let's take a look at writing our first test.
Writing our first tests using Toxiproxy
In this example I'm going to use the
TestMain(m *testing.M) function for setup and tearing down Toxiproxy.
Looking at the setup code below you'll see I first connect to the Toxiproxy server (in our case running on port
8474 as per the above terminal output), then add my first proxy. A proxy is a service you wish to control network conditions for such as PostgreSQL, a Redis cache or an HTTP API.
When creating the client you'll notice we inform Toxiproxy to listen on
localhost:5050. This instructs Toxiproxy to listen on the aforementioned address and proxy any network traffic from port
:5050 to whatever is listening on port
:8080 (in this case a simple web service)
Next we'll add our test method to simulate latency on the upstream request (Toxiproxy enables you introduce latency on either the upstream or downstream network traffic). We do this by adding what Toxiproxy calls a "Toxic".
What's a Toxic?
A Toxic is a network condition such as latency, bandwidth limitation, connection reset etc. There are a number of toxics available out of the box but you can even create your own if desired.
As you'll see from the test code above, first we get the proxy (named
upstream_api) we wish to introduce network issues into then we add the latency toxi that introduces latency of 3000 millisecods. We then defer the removal of the toxic to ensure it doesn't affect subsequent tests using that proxy, then finish up by asserting that our request took the expected length of time to respond.
Hopefully the above example has provided you with a good introduction to Toxiproxy and how you can use it to create automated tests that verify expected behaviour of services under various network conditions.