[FEATURE REQUEST] Add Ansible Lint to build pipeline

[to-bar]

Is your feature request related to a problem? Please describe.
Currently we have the ability to use Ansible-lint in the devcontainer and output the results in junit format.

Describe the solution you'd like
We want to integrate this into the Azure build pipelines as well and publish the results:

https://docs.microsoft.com/en-us/azure/devops/pipelines/tasks/test/publish-test-results?view=azure-devops&tabs=trx%2Cyaml

Describe alternatives you've considered
None

Additional context
See https://github.com/epiphany-platform/epiphany/blob/develop/core/src/epicli/.vscode/tasks.json how Ansible-lint can be executed.

---

DoD checklist

• Changelog updated
• COMPONENTS.md updated / doesn't need to be updated
• Schema updated / doesn't need to be updated
• Feature has automated tests
• Automated tests passed (QA pipelines)
  • apply
  • upgrade
• Idempotency tested
• Documentation added / updated / doesn't need to be updated
• All conversations in PR resolved
• Solution meets requirements and is done according to design doc
• Usage compliant with license
• Backport tasks created / doesn't need to be backported

[atsikham]

@rafzei It also can be configured via pre-commit git hooks.

[rafzei]

@rafzei It also can be configured via pre-commit git hooks.

GH Actions is also an option. Anyway, first thing is to create a list of roles as in issue description.

[to-bar]

Useful article: https://medium.com/faun/linting-your-ansible-playbooks-and-make-a-continuous-integration-ci-solution-bcf8b4ea4c03

[seriva]

Also generate output using: https://pypi.org/project/ansible-lint-junit/
Then publish with: https://docs.microsoft.com/en-us/azure/devops/pipelines/tasks/test/publish-test-results?view=azure-devops&tabs=trx%2Cyaml

This because pytest and pylint are also producing junit output at this point, so we can have everything similar.

[mkyc]

Consider using GitHub Actions.

[to-bar]

Waits for ansible/ansible-lint#1446

[asciible]

I tried all workarounds mentioned in ansible/ansible-lint#1446, without success; the load-failure false positives keep showing.
So, as @to-bar said, this should wait for the resolution of that bug.

[asciible]

Tested on pipeline with:

cd $(System.DefaultWorkingDirectory)

mkdir -p linting_tests
ansible-lint --nocolor \
             --parseable-severity \
             > linting_tests/ansible_lint_errors

# Suppress the next line when the "load-failure" bug in ansible-lint is solved
sed -i '/load-failure/d' linting_tests/ansible_lint_errors

error_count=$(wc -l linting_tests/ansible_lint_errors | awk '{ print $1 }')

# Convert to junit
ansible-lint-junit linting_tests/ansible_lint_errors \
             -o linting_tests/ansible_lint_errors.xml

test $error_count -le $(ansible_lint_error_threshold)

Take a look at the [DRAFT] CI build ansible-lint pipeline for a full picture

[to-bar]

1. Please add the bug number/link to the comment over sed -i '/load-failure/d'
2. I think we can install all prerequisites in Dockerfile to save time - then they will be present in Azure DevOps agent image we use