cytopia / docker-ansible-lint Goto Github PK

Alpine-based multistage-build version of ansible-lint for reproducible usage in CI

License: MIT License

Makefile 100.00%

alpine multistage multistage-docker docker dockerfile docker-image docker-container ansible ansible-lint ci continuous-integration lint linting awesome-ci

docker-ansible-lint's Introduction

Docker image for `ansible-lint`

All #awesome-ci Docker images

ansible-lint • ansible • awesome-ci • bandit • black • checkmake • eslint • file-lint • gofmt • goimports • golint • jsonlint • kubeval • linkcheck • mypy • php-cs-fixer • phpcbf • phpcs • phplint • pycodestyle • pydocstyle • pylint • terraform-docs • terragrunt-fmt • terragrunt • yamlfmt • yamllint

View Dockerfiles on GitHub.

Available Architectures: amd64, i386, arm64

Tiny Alpine-based multistage-build dockerized version of ansible-lint^[1]. The image is built nightly against the latest stable version of ansible-lint and pushed to Dockerhub.

^{[1] Official project: https://github.com/ansible/ansible-lint}

Rolling releaess

The following Docker image tags are rolling releases and are built and updated every night.

Docker Tag	Git Ref	Ansible Lint	Flavour	Available Architectures
`latest`	master	latest	default	`amd64`, `i386`, `arm64`
`alpine`	master	latest	Alpine	`amd64`, `i386`, `arm64`

`6`	master	`6.x.x`	default	`amd64`, `i386`, `arm64`
`alpine-6`	master	`6.x.x`	Alpine	`amd64`, `i386`, `arm64`

`5`	master	`5.x.x`	default	`amd64`, `i386`, `arm64`
`alpine-5`	master	`5.x.x`	Alpine	`amd64`, `i386`, `arm64`

Point in time releases

The following Docker image tags are built once and can be used for reproducible builds. Its version never changes so you will have to update tags in your pipelines from time to time in order to stay up-to-date.

Docker Tag	Git Ref	Ansible Lint	Flavour	Available Architectures
`latest-0.7`	tag: 0.7	latest	default	`amd64`, `i386`, `arm64`
`alpine-latest-0.7`	tag: 0.7	latest	Alpine	`amd64`, `i386`, `arm64`

`6-0.7`	tag: 0.7	`6.x.x`	default	`amd64`, `i386`, `arm64`
`alpine-6-0.7`	tag: 0.7	`6.x.x`	Alpine	`amd64`, `i386`, `arm64`

`5-0.7`	tag: 0.7	`5.x.x`	default	`amd64`, `i386`, `arm64`
`alpine-5-0.7`	tag: 0.7	`5.x.x`	Alpine	`amd64`, `i386`, `arm64`

📂 Docker mounts

The working directory inside the Docker container is /data/ and should be mounted locally to the root of your project where your .ansible-lint config file is located.

💻 Usage

Display usage

# Single playbook
docker run --rm -v $(pwd):/data cytopia/ansible-lint playbook.yml

# All playbooks via wildcard
docker run --rm -v $(pwd):/data cytopia/ansible-lint *.yml

# Single role (run from within the role's root)
docker run --rm -v "$(pwd)":"/data/$(basename "$(pwd)" )" -e ANSIBLE_ROLES_PATH="/data" cytopia/ansible-lint "/data/$(basename "$(pwd)" )/tests/test.yml"

GitLabCI

GitLabCI requires a shell entrypoint to be specified. See here for details: Issue #14.

default:
  image:
    name: cytopia/ansible-lint:latest
    entrypoint: ["/bin/sh", "-c"]

stages:
  - lint

ansible-linter:
  stage: lint
  script:
    - ansible-lint *.yaml
  only:
    - merge_requests
    - master

🔄 Related #awesome-ci projects

Docker images

Save yourself from installing lot's of dependencies and pick a dockerized version of your favourite linter below for reproducible local or remote CI tests:

GitHub	Type	Description
awesome-ci	Basic	Tools for git, file and static source code analysis
file-lint	Basic	Baisc source code analysis
linkcheck	Basic	Search for URLs in files and validate their HTTP status code
ansible	Ansible	Multiple versions and flavours of Ansible
ansible-lint	Ansible	Lint Ansible
gofmt	Go	Format Go source code ^[1]
goimports	Go	Format Go source code ^[1]
golint	Go	Lint Go code
eslint	Javascript	Lint Javascript code
jsonlint	JSON	Lint JSON files ^[1]
kubeval	K8s	Lint Kubernetes files
checkmake	Make	Lint Makefiles
phpcbf	PHP	PHP Code Beautifier and Fixer
phpcs	PHP	PHP Code Sniffer
phplint	PHP	PHP Code Linter ^[1]
php-cs-fixer	PHP	PHP Coding Standards Fixer
bandit	Python	A security linter from PyCQA
black	Python	The uncompromising Python code formatter
mypy	Python	Static source code analysis
pycodestyle	Python	Python style guide checker
pydocstyle	Python	Python docstyle checker
pylint	Python	Python source code, bug and quality checker
terraform-docs	Terraform	Terraform doc generator (TF 0.12 ready) ^[1]
terragrunt	Terraform	Terragrunt and Terraform
terragrunt-fmt	Terraform	`terraform fmt` for Terragrunt files ^[1]
yamlfmt	Yaml	Format Yaml files ^[1]
yamllint	Yaml	Lint Yaml files

^[1] Uses a shell wrapper to add enhanced functionality not available by original project.

Makefiles

Visit cytopia/makefiles for dependency-less, seamless project integration and minimum required best-practice code linting for CI. The provided Makefiles will only require GNU Make and Docker itself removing the need to install anything else.

📄 License

MIT License

docker-ansible-lint's People

Contributors

Stargazers

Watchers

Forkers

wesley-dean-flexion jomach adaamz rasautomation aropc uberjew666 tomkuba

docker-ansible-lint's Issues

Does not work with GitLab CI

Trying to use this on GitLab CI:

.gitlab-ci.yml

ansible-lint:
  image: cytopia/ansible-lint
  stage: lint
  script:
    - ansible-lint -R -x idempotency,ANSIBLE0010 *.yml --nocolor

Output from GitLab CI:

WARNING: Couldn't open sh - No such file or directory

Missing jmespath

I have some Ansible that uses json_query, and when I run ansible-lint in a cytopia/ansible-lint container, I get the following error:

WARNING  Listing 2 violation(s) that are fatal
d=856173;https://ansible-lint.readthedocs.io/rules/jinja/1;91mjinja[invalid]: You need to install "jmespath" prior to running json_query filter

Per the message above, this occurs because jmespath is not on the image.

In my GitLab CI/CD pipeline before running ansible-lint, I'm able to install jmespath via pip with the following before_script:

  before_script:
    - /usr/bin/python3 -m pip install jmespath

Since it is needed for some linting, can jmespath be pre-installed in the image?

Latest ansible-lint image causes CI breakage

Hi, I'm running this in a private GitLab project's CI, but here's what I see (it's been running just fine for a little over a year without issues nightly until last night):

Executing "step_script" stage of the job script
00:07
Using docker image sha256:ac519d2d1dce79826ecc5c6afda2ecb07048978eac8b1fd4f1a8bc50b6017f11 for cytopia/ansible-lint:latest with digest cytopia/ansible-lint@sha256:4c4f8165b8ee9f88f173fa1[23](https://gitlab.cern.ch/scipp/pixels/orchestration/-/jobs/25365080#L23)d85c108031d21e1074d0c76728aecf99ba8a401 ...
$ ansible-lint playbooks/*.yml
Traceback (most recent call last):
  File "/usr/bin/ansible-lint", line 8, in <module>
    sys.exit(_run_cli_entrypoint())
  File "/usr/lib/python3.10/site-packages/ansiblelint/__main__.py", line 314, in _run_cli_entrypoint
    sys.exit(main(sys.argv))
  File "/usr/lib/python3.10/site-packages/ansiblelint/__main__.py", line 194, in main
    app = get_app(offline=options.offline)
  File "/usr/lib/python3.10/site-packages/ansiblelint/app.py", line 3[29](https://gitlab.cern.ch/scipp/pixels/orchestration/-/jobs/25365080#L29), in get_app
    app.runtime.prepare_environment(install_local=True, offline=offline)
  File "/usr/lib/python3.10/site-packages/ansible_compat/runtime.py", line [34](https://gitlab.cern.ch/scipp/pixels/orchestration/-/jobs/25365080#L34)0, in prepare_environment
    self.install_requirements(req_file, retry=retry)
  File "/usr/lib/python3.10/site-packages/ansible_compat/runtime.py", line 294, in install_requirements
    run = self.exec(cmd, retry=retry)
  File "/usr/lib/python3.10/site-packages/ansible_compat/runtime.py", line 150, in exec
    result = run_func(
  File "/usr/lib/python3.10/subprocess.py", line 501, in run
    with Popen(*popenargs, **kwargs) as process:
  File "/usr/lib/python3.10/subprocess.py", line 969, in __init__
    self._execute_child(args, executable, preexec_fn, close_fds,
  File "/usr/lib/python3.10/subprocess.py", line 1845, in _execute_child
    raise child_exception_type(errno_num, err_msg, err_filename)
FileNotFoundError: [Errno 2] No such file or directory: 'ansible-galaxy'

Any ideas how to fix this?

Failing builds

Builds for docker-ansible-lint 6.x have been failing since February. ansible-lint development got more active recently so it would be useful to have up to date images.

Unable to run ansible-lint without options

One should be able to run this like so:
docker run --rm -v $(pwd):/data cytopia/ansible-lint

... in which case ansible-lint will scan the directory recursively. But it defaults to an argument of --version and outputs:

ansible-lint 4.2.0

Would like to get rid of the default --version argument.

D:~ $ docker pull cytopia/ansible-lint:5
5: Pulling from cytopia/ansible-lint
Digest: sha256:c9eeefaac0b8928d551fb909fe7dd31796fb55af047ef118b04070cade7a1069
Status: Image is up to date for cytopia/ansible-lint:5
docker.io/cytopia/ansible-lint:5
D:~ $ docker run -it  cytopia/ansible-lint:5 --version
Failed to guess project directory using git:
ansible-lint 5.1.3 using ansible 2.11.5
D:~ $

And latest 5.x.x version of ansible-lint is currently 5.4.0: https://pypi.org/project/ansible-lint/#history

Install bash

It would be nice to have bash instead of sh only