Compare commits

..

No commits in common. "master" and "v2.0.0" have entirely different histories.

6 changed files with 39 additions and 77 deletions

View File

@ -9,8 +9,11 @@ workspace:
steps:
- name: test
image: iamthefij/drone-pre-commit@sha256:6ed8dae6b0067bd2e145e36421bcfbbc68975ff7ddaa5a3f285b5bcdaf0989c8
image: python:3-slim
commands:
- apt-get update
- apt-get install -y --no-install-recommends make shellcheck
- pip install docker-compose
- make all
- name: notify

View File

@ -1,14 +0,0 @@
repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v3.2.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
- id: check-yaml
args:
- --allow-multiple-documents
- id: check-merge-conflict
- repo: https://github.com/shellcheck-py/shellcheck-py
rev: v0.7.1.1
hooks:
- id: shellcheck

View File

@ -1,7 +1,19 @@
---
- id: docker-compose-check
name: Validate docker compose files
description: Checks that docker compose files are valid
name: Validate docker-compose files
description: Checks that docker-compose files are valid
language: script
entry: compose-check.sh
files: (docker-)?compose\.ya?ml$
files: docker-compose.y[a]{0,1}ml$
- id: hadolint
name: Lint Dockerfiles
description: Runs hadolint Docker image to lint Dockerfiles
language: docker_image
entry: hadolint/hadolint hadolint
files: Dockerfile
- id: hadolint-system
name: Lint Dockerfiles
description: Runs system hadolint to lint Dockerfiles
language: system
entry: hadolint
files: Dockerfile

View File

@ -1,8 +1,12 @@
.PHONY: all test clean
all: check test
all: test shellcheck
test: test-negative test-positive test-hooks
test: test-negative test-positive
.PHONY: shellcheck
shellcheck:
shellcheck *.sh
.PHONY: test-positive
test-positive:
@ -15,17 +19,3 @@ test-negative:
./compose-check.sh tests/docker-compose.bad.yml && { echo 'fail'; exit 1; } || echo 'ok'
@echo "Check multiple files. Should error."
./compose-check.sh tests/docker-compose* && { echo 'fail'; exit 1; } || echo 'ok'
.PHONY: test-hooks
test-hooks:
pre-commit try-repo . --all-files
# Installs pre-commit hooks
.PHONY: install-hooks
install-hooks:
pre-commit install --install-hooks
# Checks files for encryption
.PHONY: check
check:
pre-commit run --all-files

View File

@ -2,21 +2,13 @@
A set of [pre-commit](http://pre-commit.com) hooks for Docker services
# Installation
Add the following to your `.pre-commit-config.yaml` file
```yaml
- repo: https://github.com/iamthefij/docker-pre-commit
rev: master
hooks:
- id: docker-compose-check
```
and then run `pre-commit autoupdate`.
## Hooks
### docker-compose-check
Verifies that docker compose files are valid by using `docker compose config` to parse them.
Verifies that docker-compose files are valid by using `docker-compose config` to parse them.
### hadolint
Uses the [hadolint Docker image](https://hub.docker.com/hadolint/hadolint) to lint Dockerfiles.
### hadolint-system
Uses the whatever version of hadolint that you have installed to lint Dockerfiles. This requires you to have hadolint installed somewhere in your path.

View File

@ -1,41 +1,20 @@
#! /usr/bin/env bash
#! /bin/bash
# Verifies that files passed in are valid for docker-compose
set -e
# Check if docker or podman commands are available
if [[ -z "${CONTAINER_ENGINE}" ]]; then
if command -v docker &>/dev/null; then
CONTAINER_ENGINE=docker
elif command -v podman &>/dev/null; then
CONTAINER_ENGINE=podman
else
echo "ERROR: Neither 'docker' or 'podman' were found"
exit 1
fi
fi
if command -v "${CONTAINER_ENGINE}" &>/dev/null && ${CONTAINER_ENGINE} help compose &> /dev/null; then
COMPOSE="${CONTAINER_ENGINE} compose"
elif command -v "${CONTAINER_ENGINE}-compose" &> /dev/null; then
COMPOSE="${CONTAINER_ENGINE}-compose"
else
echo "ERROR: Neither '${CONTAINER_ENGINE}-compose' or '${CONTAINER_ENGINE} compose' were found"
exit 1
fi
check_file() {
local file=$1
env $COMPOSE --file "$file" config --quiet 2>&1 |
sed "/variable is not set. Defaulting/d"
docker-compose -f "$file" config -q 2>&1 \
| sed "/variable is not set. Defaulting/d"
return "${PIPESTATUS[0]}"
}
check_files() {
local all_files=( "$@" )
has_error=0
for file in "${all_files[@]}"; do
for file in "${all_files[@]}" ; do
if [[ -f "$file" ]]; then
if ! check_file "$file"; then
if ! check_file "$file" ; then
echo "ERROR: $file"
has_error=1
fi
@ -44,8 +23,8 @@ check_files() {
return $has_error
}
if ! check_files "$@"; then
echo "Some compose files failed"
if ! check_files "$@" ; then
echo "To ignore, use --no-verify"
fi
exit $has_error