weeheavy/pre-commit-opentofu
1
0
Fork 0
forked from github/pre-commit-opentofu
Code Pull requests Activity

chore: add dockerfile (#183)

Browse source
This commit is contained in:
Manuel Vogel 2021-03-12 15:35:21 +01:00 • committed by GitHub
commit 36a269f109
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 62 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

3
.dockerignore Normal file
View file

@ -0,0 +1,3 @@
*
!.dockerignore
!Dockerfile

47
Dockerfile Normal file
View file

@ -0,0 +1,47 @@
FROM ubuntu:18.04
ARG PRE_COMMIT_VERSION="2.11.1"
ARG GOLANG_VERSION="1.16"
ARG TERRAFORM_VERSION="0.14.8"
ARG TFSEC_VERSION="v0.39.6"
ARG TERRAFORM_DOCS_VERSION="latest"
ARG TFLINT_VERSION="latest"
ARG TFSEC_VERSION="v0.39.6"
ARG CHECKOV_VERSION="1.0.838"
# Install general dependencies
RUN apt update && \
apt install -y curl git gawk unzip software-properties-common
# Install golang
RUN curl -L https://dl.google.com/go/go${GOLANG_VERSION}.linux-amd64.tar.gz > go${GOLANG_VERSION}.linux-amd64.tar.gz && \
tar xzf go${GOLANG_VERSION}.linux-amd64.tar.gz && \
rm -f go${GOLANG_VERSION}.linux-amd64.tar.gz
ENV GOPATH /go
RUN mkdir -p "$GOPATH/src" "$GOPATH/bin" && chmod -R 777 "$GOPATH"
ENV PATH $GOPATH/bin:/usr/local/go/bin:$PATH
# Install tools
RUN add-apt-repository ppa:deadsnakes/ppa && \
apt install -y python3.7 python3-pip && \
pip3 install pre-commit==${PRE_COMMIT_VERSION} && \
curl -L "$(curl -s https://api.github.com/repos/terraform-docs/terraform-docs/releases/${TERRAFORM_DOCS_VERSION} | grep -o -E "https://.+?-linux-amd64.tar.gz")" > terraform-docs.tgz && tar xzf terraform-docs.tgz && chmod +x terraform-docs && mv terraform-docs /usr/bin/ && \
curl -L "$(curl -s https://api.github.com/repos/terraform-linters/tflint/releases/${TFLINT_VERSION} | grep -o -E "https://.+?_linux_amd64.zip")" > tflint.zip && unzip tflint.zip && rm tflint.zip && mv tflint /usr/bin/ && \
python3.7 -m pip install -U checkov==${CHECKOV_VERSION}
RUN env GO111MODULE=on go get -u github.com/tfsec/tfsec/cmd/tfsec@${TFSEC_VERSION}
# Install terraform because pre-commit needs it
RUN curl -fsSL https://apt.releases.hashicorp.com/gpg | apt-key add - && \
apt-add-repository "deb [arch=amd64] https://apt.releases.hashicorp.com $(lsb_release -cs) main" && \
apt-get update && apt-get install terraform=${TERRAFORM_VERSION}
# Checking all binaries are in the PATH
RUN go version
RUN terraform --help
RUN pre-commit --help
RUN terraform-docs --help
RUN tflint --help
RUN tfsec --help
RUN checkov --help
ENTRYPOINT [ "pre-commit" ]

12
README.md
View file

@ -13,6 +13,8 @@
* [`coreutils`](https://formulae.brew.sh/formula/coreutils) required for `terraform_validate` hook on macOS (due to use of `realpath`).
* [`checkov`](https://github.com/bridgecrewio/checkov) required for `checkov` hook.
or build and use the Docker image locally as mentioned below in the `Run` section.
##### MacOS
```bash
@ -34,6 +36,7 @@ python3.7 -m pip install -U checkovpython3.7 -m pip install -U checkov
```
### 2. Install the pre-commit hook globally
Note: not needed if you use the Docker image
```bash
DIR=~/.git-template
@ -65,6 +68,15 @@ After pre-commit hook has been installed you can run it manually on all files in
pre-commit run -a
```
or you can also build and use the provided Docker container, which wraps all dependencies by
```bash
# first building it
docker build -t pre-commit .
# and then running it in the folder
# with the terraform code you want to check by executing
docker run -v $(pwd):/lint -w /lint pre-commit run -a
```
## Available Hooks
There are several [pre-commit](https://pre-commit.com/) hooks to keep Terraform configurations (both `*.tf` and `*.tfvars`) and Terragrunt configurations (`*.hcl`) in a good shape: