pilgrim2go/hoverfly

Lightweight service virtualization/API simulation tool for developers and testers

Dependencies without the sting

Hoverfly is a light-weight open source tool for creating simulations of external services for use in development and testing. This technique is sometimes referred to as service virtualization.

Hoverfly was designed to provide you with the means to create your own "dependency sandbox": a simulated development and test environment that you control.

Hoverfly + hoverctl

Hoverctl is a command line interface for Hoverfly. It uses the Hoverfly REST API to control local or remote Hoverfly instances and manage Hoverfly data.

Quickstart

Homebrew (OS X)

brew install SpectoLabs/tap/hoverfly

Installation script (Linux and OS X)

Run the install script to install Hoverfly and hoverctl:

curl -o install.sh https://raw.githubusercontent.com/SpectoLabs/hoverfly/master/install.sh && bash install.sh

Binaries

Or download the Hoverfly and hoverctl binaries, set the correct permissions and copy them to a directory on your path.

Or get the docker image (Hoverfly only):

docker pull spectolabs/hoverfly
docker run -d -p 8888:8888 -p 8500:8500 spectolabs/hoverfly

Documentation

The Hoverfly documentation is available here.

For convenience:

Getting started

• Use cases
• "Modes" and middleware
• Installation and setup

Usage

• Capturing traffic
• Simulating services
• Exporting and importing
• Using middleware
• Creating synthetic services
• Modifying traffic
• Filtering destination URLs and hosts
• Using the metadata API
• Admin UI
• HTTPS & certificate management
• Authentication

Reference

• API
• Flags and environment variables
• Hoverctl

Further reading

Articles and blog posts with step-by-step Hoverfly tutorials:

• Creating fast versions of slow dependencies
• Modifying traffic on the fly
• Mocking APIs for development and testing
• Virtualizing the Meetup API
• Using Hoverfly to build Spring Boot microservices alongside a Java monolith
• Easy API simulation with the Hoverfly JUnit rule

Contributing

Contributions are welcome!

To submit a pull request you should fork the Hoverfly repository, and make your change on a feature branch of your fork. Then generate a pull request from your branch against master of the Hoverfly repository. Include in your pull request details of your change (why and how, as well as the testing you have performed). To read more about forking model, check out this link: forking workflow.

Hoverfly is a new project, we will soon provide detailed roadmap.

License

Apache License version 2.0 See LICENSE for details.

(c) SpectoLabs 2016.