Tests with a twist!
Zest is to assist with docker-driven workflow in both a local dev environment and in build servers.
Zest requires zest, _zester, docker, and docker-compose (v1.12 or newer, see below)
to be installed in your PATH. The Docker daemon must be running.
You must have docker-compose >= 1.12 installed. It is included in Docker for Mac edge since 17.04. The latest version of Docker for Mac stable (17.03) does not yet bundle this version. Either use https://github.com/axiomzen/zest/commit/d6afabaa7100b56b326abab55fa11c4e4b71c4b1 or update docker-compose.
To install things system wide use sudo make install, which will attempt to copy the binaries and relevant configs into /usr/local as well as the users ~/.zest directories.
Zest also runs fine out of a local directory, if this repository is present as ./zest
zest init-service expects to copy the initial Zestfile from /usr/local/share/zest so if your zest is not installed system wide you can copy the Zestfile.example into Zestfile manually to init a service.
If installed globally with sudo make install then sudo make uninstall will remove zest. Otherwise just remove the local directory containing zest.
Zest works in 2 ways: operating on single services, and on multi-service projects.
A service is a single container containing a running binary. This could be a database, a webapp, etc.
Each service to be built and tested with zest need to have a Zestfile and a Dockerfile. The name of the service will be taken from the current directory name
| Command | Result |
|---|---|
| init-service | Creates the prerequisite files for the current directory to be a zestable service |
| build | Runs the Build() script inside the build container |
| enter | Launch an interactive shell inside the build container |
| test | Runs the Test() script inside the test container |
| bundle | Build the final container with the provided Dockerfile and tag with both version and latest |
| version | Execute Version() to see what the container will be tagged as |
A project is a collection of services that run together to form an application stack.
Each project must container a docker-compose.yml that defines the services in the project, and a Peelfile for determining what services are the root of the project.
The Peelfile can also optinally specify where to find the relavent compose files.
| Command | Result |
|---|---|
| init-project | Creates the prerequisite files for the current directory to be a zestable project |
| integrate | Run integration tests on a project |
| run | Start the environment with docker-compose |
| stop | clean up the docker-compose environment |
| all | build, test, bundle all folders in the pwd that are services, then integrate |
Zest integration tests assume that your integration tests are written as a standalone service, and that service depends on the service to be tested in the docker-compose config.
To run integration tests, use zest integrate. This is equivilant to running docker-compose up <integrate-service> where <integrate-service> is the service tagged with integrate: in the project's Peelfile.
Zest will clean up the compose environment when the tests are done.