Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/zuazo/docker-in-travis

Docker image example using TDD with Serverspec and Travis CI.
https://github.com/zuazo/docker-in-travis

devops docker example serverspec spec tdd testing travis-ci

Last synced: about 2 months ago
JSON representation

Docker image example using TDD with Serverspec and Travis CI.

Host: GitHub
URL: https://github.com/zuazo/docker-in-travis
Owner: zuazo
License: apache-2.0
Created: 2015-07-07T18:29:56.000Z (over 9 years ago)
Default Branch: master
Last Pushed: 2015-12-12T10:36:30.000Z (about 9 years ago)
Last Synced: 2023-04-13T12:56:54.839Z (almost 2 years ago)
Topics: devops, docker, example, serverspec, spec, tdd, testing, travis-ci
Language: Ruby
Homepage: https://hub.docker.com/r/zuazo/docker-in-travis/
Size: 21.5 KB
Stars: 4
Watchers: 1
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE

Awesome Lists containing this project

README

### Important Note

The procedure described below is considered outdated. From now on, I recommend using the [`dockerspec`](https://github.com/zuazo/dockerspec) gem for testing docker images.

---

### Docker Tests Example
[![Source Code](https://img.shields.io/badge/source-GitHub-blue.svg?style=flat)](https://github.com/zuazo/docker-in-travis) [![Docker Repository on Quay.io](https://quay.io/repository/zuazo/docker-in-travis/status "Docker Repository on Quay.io")](https://quay.io/repository/zuazo/tests-example) [![Build Status](http://img.shields.io/travis/zuazo/docker-in-travis.svg?style=flat)](https://travis-ci.org/zuazo/docker-in-travis)

Docker image example using [TDD](https://en.wikipedia.org/wiki/Test-driven_development).

The tests are implemented in **Ruby**, using the [`docker-api`](https://github.com/swipely/docker-api) and [`serverspec`](http://serverspec.org/) gems.

The following features are currently implemented:

* [Test the built image](https://github.com/zuazo/docker-in-travis/tree/master/spec/build/dockerfile_spec.rb) using [`docker-api`](https://github.com/swipely/docker-api).
* [Test the image running](https://github.com/zuazo/docker-in-travis/tree/master/spec/run/dockerfile_spec.rb) using [Serverspec](http://serverspec.org/).
* Run the tests inside [Travis CI](https://travis-ci.org). See the [.travis.yml](https://github.com/zuazo/docker-in-travis/blob/master/.travis.yml) file.
* Check the tests with [`should_not`](https://github.com/should-not/should_not) gem to avoid redundant test descriptions.
* Run the tests in random order.

**Note:** This example installs a simple Apache & PHP application, but could be anything else.

#### Run the Tests

You can use the [`bundler`](http://bundler.io/) Ruby gem to install all the requirements to run the tests:

$ gem install bundler
$ bundle install

You can now run the tests running RSpec:

$ rspec

Output example:

```
Randomized with seed 52614

Docker image run
installs PHP version 5.6
returns my web page
Process "apache2"
should be running
File "/var/www/html/index.php"
should be file
Package "apache2"
should be installed

Dockerfile build
has the website path as workdir
has PHP installed
creates image
runs apache in foreground
exposes the port 80

Finished in 1.26 seconds (files took 0.20144 seconds to load)
10 examples, 0 failures

Randomized with seed 52614
```

See also the [Travis CI output](https://travis-ci.org/zuazo/docker-in-travis) as an example.

#### Directory Structure

```
├── Dockerfile
├── .dockerignore: Files to be ignored by docker copy instructions.
├── Gemfile: File to install the gems required to run the tests.
├── .gitignore: Intentionally untracked files to be ignored by git.
├── LICENSE: Software license.
├── README.md
├── spec/
│   ├── build/: Tests to verify the built image.
│   ├── run/: Tests to verify the image running (Serverspec).
│   ├── serverspec_helper.rb: Helper file to setup Serverspec.
│   └── spec_helper.rb: Helper file to setup all the tests.
├── .travis.yml: Travis CI configuration file.
└── webapp/: Example application to install.
```

#### How to Run Docker in Travis CI

You can use a *.travis.yml* similar to the following:

```yaml
language: ruby

sudo: true

before_script:
- source <(curl -sL https://raw.githubusercontent.com/zuazo/docker-in-travis/0.2.0/scripts/start_docker.sh)

script:
- bundle exec rspec

after_failure: cat docker_daemon.log
```

##### Using the Official Travis CI Docker Stacks

[Since August 2015](http://blog.travis-ci.com/2015-08-19-using-docker-on-travis-ci/) you can try to use the official Docker service provided by Travis CI workers using the following *.travis.yml*:

```yaml
language: ruby

sudo: required

services:
- docker

script:
- bundle exec rspec
```

Please, [let me know](https://github.com/zuazo/docker-in-travis/issues/new?title=Travis%20Docker%20worked%20for%20me) if this has worked for you.

#### Change *Dockerfile* Location

You can set the `DOCKERFILE_LOCATION` environment variable to change the *Dockerfile* subdirectory (defaults to `.`).

For example, to run multiple tests:

```yaml
language: ruby

sudo: true

env:
- DOCKERFILE_LOCATION=directory1
- DOCKERFILE_LOCATION=directory2

before_script:
- source <(curl -sL https://raw.githubusercontent.com/zuazo/docker-in-travis/0.2.0/scripts/start_docker.sh)

script:
- bundle exec rspec

after_failure: cat docker_daemon.log
```

#### Real-world Examples

* [chef-local](https://github.com/zuazo/chef-local-docker/tree/ff79f619f76a5a50052db76132ea16b39915caa7) image ([*.travis.yml*](https://github.com/zuazo/chef-local-docker/tree/ff79f619f76a5a50052db76132ea16b39915caa7/.travis.yml), [*spec/*](https://github.com/zuazo/chef-local-docker/tree/ff79f619f76a5a50052db76132ea16b39915caa7/spec), [*Gemfile*](https://github.com/zuazo/chef-local-docker/tree/ff79f619f76a5a50052db76132ea16b39915caa7/Gemfile)): Runs a Travis CI build for each image tag.

* [keywhiz](https://github.com/zuazo/keywhiz-docker/tree/a15def5e83de765e6881bd4305f06fc0a9d4f9c1) image ([*.travis.yml*](https://github.com/zuazo/keywhiz-docker/tree/a15def5e83de765e6881bd4305f06fc0a9d4f9c1/.travis.yml), [*spec/*](https://github.com/zuazo/keywhiz-docker/tree/a15def5e83de765e6881bd4305f06fc0a9d4f9c1/spec), [*Gemfile*](https://github.com/zuazo/keywhiz-docker/tree/a15def5e83de765e6881bd4305f06fc0a9d4f9c1/Gemfile)): Runs one Travis CI build.

#### Questions and Improvements

This is proof of concept used by myself in my projects. If you encounter any problems or have ideas for improvements, please [open an issue](https://github.com/zuazo/docker-in-travis/issues/new)!

#### Acknowledgements

This docker example does not contain anything new. It is based on multiple online sources. Mainly the following:

* https://github.com/tcnksm-sample/test-driven-development-dockerfile
* https://coderwall.com/p/5xylsg/tdd-for-dockerfile-by-rspec-severspec
* https://github.com/voidlock/travis-docker
* https://gist.github.com/masonforest/194e0cb6bb16c88e21a0
* https://robots.thoughtbot.com/tdd-your-dockerfiles-with-rspec-and-serverspec
* https://github.com/lukecyca/travis-docker-example
* https://github.com/mdarse/travis-docker-build
* https://github.com/d11wtq/dockerpty/blob/master/.travis.yml
* https://github.com/gap-system/gap-docker-travis
* https://github.com/rocker-org/rocker/blob/56cb59cc262e9d2c02f9e11cfacab65f0b659c5f/.travis.yml

Thanks to all of you ;-)