Impl Docker image with tests

Author: tyranron

.dockerignore

@@ -0,0 +1 @@
+*

.editorconfig

@@ -12,3 +12,19 @@ indent_style = space
 indent_size = 4
 trim_trailing_whitespace = false
 max_line_length = off
+
+[Dockerfile]
+indent_style = space
+indent_size = 4
+
+[Makefile]
+indent_style = tab
+indent_size = 4
+
+[{*.bats,post_push,post_push.tmpl}]
+indent_style = space
+indent_size = 2
+
+[*.{yml,yaml}]
+indent_style = space
+indent_size = 2

.travis.yml

@@ -0,0 +1,18 @@
+language: bash
+
+sudo: false
+
+services:
+  - docker
+
+before_script:
+  - make image no-cache=yes VERSION=test
+  - make deps.bats
+
+script:
+  - make test VERSION=test
+
+notifications:
+  email:
+    on_success: never
+    on_failure: always

Dockerfile

@@ -0,0 +1,14 @@
+# https://hub.docker.com/r/rustlang/rust
+FROM rustlang/rust:nightly-slim
+
+MAINTAINER Instrumentisto Team <developer@instrumentisto.com>
+
+
+# Download and install clippy
+RUN cargo install clippy --version 0.0.207 \
+    \
+ # Cleanup unnecessary files
+ && rm -rf /usr/local/cargo/registry
+
+
+CMD ["cargo", "clippy"]

Makefile

@@ -0,0 +1,132 @@
+# This Makefile automates possible operations of this project.
+#
+# Images and description on Docker Hub will be automatically rebuilt on
+# pushes to `master` branch of this repo and on updates of parent image.
+#
+# Note! Docker Hub `post_push` hook must be always up-to-date with default
+# values of current Makefile. To update it just use:
+#	make post-push-hook
+#
+# It's still possible to build, tag and push images manually. Just use:
+#	make release
+
+
+IMAGE_NAME := instrumentisto/clippy
+VERSION ?= 0.0.207
+TAGS ?= 0.0.207,0.0,0,latest
+
+
+comma := ,
+eq = $(if $(or $(1),$(2)),$(and $(findstring $(1),$(2)),\
+                                $(findstring $(2),$(1))),1)
+
+
+
+# Build Docker image.
+#
+# Usage:
+#	make image [VERSION=<image-version>]
+#	           [no-cache=(no|yes)]
+
+image:
+	docker build --network=host --force-rm \
+	$(if $(call eq,$(no-cache),yes),--no-cache --pull,) \
+		-t $(IMAGE_NAME):$(VERSION) .
+
+
+
+# Tag Docker image with given tags.
+#
+# Usage:
+#	make tags [VERSION=<image-version>]
+#	          [TAGS=<docker-tag-1>[,<docker-tag-2>...]]
+
+tags:
+	$(foreach tag,$(subst $(comma), ,$(TAGS)),\
+		$(call tags.do,$(VERSION),$(tag)))
+define tags.do
+	$(eval from := $(strip $(1)))
+	$(eval to := $(strip $(2)))
+	docker tag $(IMAGE_NAME):$(from) $(IMAGE_NAME):$(to)
+endef
+
+
+
+# Manually push Docker images to Docker Hub.
+#
+# Usage:
+#	make push [TAGS=<docker-tag-1>[,<docker-tag-2>...]]
+
+push:
+	$(foreach tag,$(subst $(comma), ,$(TAGS)),\
+		$(call push.do,$(tag)))
+define push.do
+	$(eval tag := $(strip $(1)))
+	docker push $(IMAGE_NAME):$(tag)
+endef
+
+
+
+# Make manual release of Docker images to Docker Hub.
+#
+# Usage:
+#	make release [VERSION=<image-version>] [no-cache=(no|yes)]
+#	             [TAGS=<docker-tag-1>[,<docker-tag-2>...]]
+
+release: | image tags push
+
+
+
+# Create `post_push` Docker Hub hook.
+#
+# When Docker Hub triggers automated build all the tags defined in `post_push`
+# hook will be assigned to built image. It allows to link the same image with
+# different tags, and not to build identical image for each tag separately.
+# See details:
+# http://windsock.io/automated-docker-image-builds-with-multiple-tags
+#
+# Usage:
+#	make post-push-hook [TAGS=<docker-tag-1>[,<docker-tag-2>...]]
+
+post-push-hook:
+	@mkdir -p hooks/
+	docker run --rm -v $(PWD)/post_push.tmpl:/post_push.tmpl:ro \
+	           -e TAGS='$(TAGS)' \
+		hairyhenderson/gomplate:slim -f /post_push.tmpl \
+		> hooks/post_push
+
+
+
+# Run Bats tests for Docker image.
+#
+# Documentation of Bats:
+#	https://github.com/sstephenson/bats
+#
+# Usage:
+#	make test [VERSION=<image-version>]
+
+test: deps.bats
+	IMAGE=$(IMAGE_NAME):$(VERSION) test/bats/bats test/suite.bats
+
+
+
+# Resolve project dependencies for running tests.
+#
+# Usage:
+#	make deps.bats [BATS_VER=<bats-version>]
+
+BATS_VER ?= 0.4.0
+
+deps.bats:
+ifeq ($(wildcard test/bats),)
+	@mkdir -p test/bats/vendor/
+	curl -fL -o test/bats/vendor/bats.tar.gz \
+		https://github.com/sstephenson/bats/archive/v$(BATS_VER).tar.gz
+	tar -xzf test/bats/vendor/bats.tar.gz -C test/bats/vendor/
+	@rm -f test/bats/vendor/bats.tar.gz
+	ln -s $(PWD)/test/bats/vendor/bats-$(BATS_VER)/libexec/* test/bats/
+endif
+
+
+
+.PHONY: image tags push release post-push-hook test deps.bats

hooks/post_push

@@ -0,0 +1,15 @@
+#!/bin/bash
+# AUTOMATICALLY GENERATED
+# DO NOT EDIT THIS FILE DIRECTLY, USE /post_push.tmpl
+
+set -e
+
+# Parse image name for repo name
+tagStart=$(expr index "$IMAGE_NAME" :)
+repoName=${IMAGE_NAME:0:tagStart-1}
+
+# Tag and push image for each additional tag
+for tag in {0.0.207,0.0,0,latest}; do
+  docker tag $IMAGE_NAME ${repoName}:${tag}
+  docker push ${repoName}:${tag}
+done

post_push.tmpl

@@ -0,0 +1,15 @@
+#!/bin/bash
+# AUTOMATICALLY GENERATED
+# DO NOT EDIT THIS FILE DIRECTLY, USE /post_push.tmpl
+
+set -e
+
+# Parse image name for repo name
+tagStart=$(expr index "$IMAGE_NAME" :)
+repoName=${IMAGE_NAME:0:tagStart-1}
+
+# Tag and push image for each additional tag
+for tag in { {{- .Env.TAGS -}} }; do
+  docker tag $IMAGE_NAME ${repoName}:${tag}
+  docker push ${repoName}:${tag}
+done

test/.gitignore

@@ -0,0 +1 @@
+/bats/

test/suite.bats

@@ -0,0 +1,35 @@
+#!/usr/bin/env bats
+
+
+@test "post_push hook is up-to-date" {
+  run sh -c "cat Makefile | grep 'TAGS ?= ' | cut -d ' ' -f 3"
+  [ "$status" -eq 0 ]
+  [ ! "$output" = '' ]
+  expected="$output"
+
+  run sh -c "cat hooks/post_push | grep 'for tag in' \
+                                 | cut -d '{' -f 2 \
+                                 | cut -d '}' -f 1"
+  [ "$status" -eq 0 ]
+  [ ! "$output" = '' ]
+  actual="$output"
+
+  [ "$actual" = "$expected" ]
+}
+
+
+@test "clippy runs ok" {
+  run docker run --rm --entrypoint sh $IMAGE -c 'cargo clippy --help'
+  [ "$status" -eq 0 ]
+}
+
+@test "clippy has correct version" {
+  run sh -c 'cat Makefile | grep "VERSION ?= " | cut -d " " -f 3 | tr -d "\n"'
+  [ "$status" -eq 0 ]
+  [ ! "$output" = '' ]
+  expected="$output"
+
+  run docker run --rm --entrypoint sh $IMAGE -c \
+    "cargo clippy --version | grep -Fx '$expected'"
+  [ "$status" -eq 0 ]
+}