zuazo/diffy repository overview

⁠Diffy Docker Container

A Docker⁠ image with Diffy⁠.

⁠Supported Tags and Respective Dockerfile Links

• latest (/Dockerfile⁠)

⁠What Is Diffy?

Diffy finds potential bugs in your service using running instances of your new code and your old code side by side. Diffy behaves as a proxy and multicasts whatever requests it receives to each of the running instances. It then compares the responses, and reports any regressions that may surface from those comparisons. The premise for Diffy is that if two implementations of the service return “similar” responses for a sufficiently large and diverse set of requests, then the two implementations can be treated as equivalent and the newer implementation is regression-free.

See the official Diffy documentation⁠ and the release blog post⁠ for more information.

⁠How to Use This Image

⁠Download the Image

$ docker pull zuazo/diffy

⁠Running Diffy

For example:

$ docker run -ti \
  -p 31900:31900 \
  -p 31149:31149 \
  zuazo/diffy \
    -candidate=http-candidate.herokuapp.com:9992 \
    -master.primary=http-primary.herokuapp.com:9990 \
    -master.secondary=http-secondary.herokuapp.com:9991 \
    -service.protocol=http \
    -serviceName="My Service" \
    -proxy.port=:31900 \
    -admin.port=:31159 \
    -http.port=:31149 \
    -rootUrl=localhost:31149

You need to replace the Candidate, the Primary Master and the Secondary Master values by your own API addresses.

You can now open http://localhost:31149 to see the web interface and use the 31900 port to make the API requests:

$ curl localhost:31900/your_application_route

⁠Build from Sources

Instead of installing the image from Docker Hub, you can build the image from sources if you prefer:

$ git clone https://github.com/zuazo/diffy-docker diffy
$ cd diffy
$ docker build -t zuazo/diffy .

⁠License and Author

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.