{"id":3929,"date":"2024-09-02T07:00:00","date_gmt":"2024-09-02T05:00:00","guid":{"rendered":"https:\/\/www.my-it-brain.de\/wordpress\/?p=3929"},"modified":"2024-08-21T16:47:50","modified_gmt":"2024-08-21T14:47:50","slug":"demonstration-von-ansible-lint-am-beispiel-einer-ansible-collection","status":"publish","type":"post","link":"https:\/\/www.my-it-brain.de\/wordpress\/demonstration-von-ansible-lint-am-beispiel-einer-ansible-collection\/","title":{"rendered":"Demonstration von Ansible Lint am Beispiel einer Ansible Collection"},"content":{"rendered":"\n

In diesem Beitrag erkl\u00e4re ich kurz, was Ansible Lint<\/a> ist und demonstriere dessen Anwendung am Beispiel meiner Ansible Collection tronde\/nextcloud<\/a>.<\/p>\n\n\n\n

Er richtet sich prim\u00e4r an Personen, die mit Ansible Lint noch nicht vertraut sind. Linting-Profis werden vermutlich keine neuen Erkenntnisse gewinnen.<\/p>\n\n\n\n

Was ist Ansible Lint und wof\u00fcr ist es gut?<\/h2>\n\n\n\n
\n

Lint<\/strong> (englisch<\/a> f\u00fcr \u201eFussel<\/a>\u201c) ist eine Software<\/a> zur statischen Code-Analyse<\/a>. Davon abgeleitet hat sich das Verb linten<\/strong> (englisch to lint<\/em>) f\u00fcr das Durchf\u00fchren der statischen Code-Analyse etabliert.<\/p>\nhttps:\/\/de.wikipedia.org\/wiki\/Lint_(Programmierwerkzeug)<\/a><\/cite><\/blockquote>\n\n\n\n

Dem obigen Zitat und der Projektdokumentation<\/a> folgend, ist Ansible Lint dementsprechend ein Werkzeug zur statischen Code-Analyse von Ansible Playbooks, Roles und Collections. Mit der Anwendung dieses Werkzeugs auf die eigenen Ansible-Inhalte kann sichergestellt werden, dass diese g\u00e4ngigen Konventionen und Standards entsprechen.<\/p>\n\n\n\n

Wie wird Ansible Lint installiert?<\/h2>\n\n\n\n

Die Dokumentation beschreibt verschiedene Installationsverfahren<\/a>. Ich habe ansible-lint<\/code> als Bestandteil der Ansible Development Tools (ADT)<\/a> installiert<\/a>. Dies ist ein Werkzeugkasten mit weiteren Programmen wie z.B. `ansible-core` und Ansible Molecule<\/a>, welche ich f\u00fcr die Entwicklung meiner Ansible Collection nutze.<\/p>\n\n\n\n

Auf meiner Fedora Workstation habe ich die ADT wie folgt installiert:<\/p>\n\n\n\n

~]$ mkdir venv\n~]$ cd venv\nvenv]$ ]$ python -m venv adt\nvenv]$ source adt\/bin\/activate\n(adt) venv]$ pip install pip --upgrade\nRequirement already satisfied: pip in .\/adt\/lib64\/python3.12\/site-packages (23.3.2)\nCollecting pip\n  Using cached pip-24.2-py3-none-any.whl.metadata (3.6 kB)\nUsing cached pip-24.2-py3-none-any.whl (1.8 MB)\nInstalling collected packages: pip\n  Attempting uninstall: pip\n    Found existing installation: pip 23.3.2\n    Uninstalling pip-23.3.2:\n      Successfully uninstalled pip-23.3.2\nSuccessfully installed pip-24.2\n(adt) venv]$  pip install ansible-dev-tools\nCollecting ansible-dev-tools\n  Using cached ansible_dev_tools-24.7.2-py3-none-any.whl.metadata (11 kB)\n\u2026 Ausgabe gek\u00fcrzt\n(adt) venv]$ adt --version\nansible-builder                          3.1.0\nansible-core                             2.17.3\nansible-creator                          24.7.1\nansible-dev-environment                  24.7.0\nansible-dev-tools                        24.7.2\nansible-lint                             24.7.0\nansible-navigator                        24.8.0\nansible-sign                             0.1.1\nmolecule                                 24.8.0\npytest-ansible                           24.8.0\ntox-ansible                              24.8.0<\/code><\/pre>\n\n\n\n
Ansible Lint liefert eine ganze Reihe von Profilen<\/a> mit, welche Autoren unterst\u00fctzen, die Code-Qualit\u00e4t schrittweise zu verbessern. Der Befehl ansible-lint --list-profiles<\/code> gibt die verf\u00fcgbaren Profile mit einer Beschreibung aus.<\/p>\n\n\n\n
Ich werde im Folgenden mit dem Profil shared<\/a><\/em> arbeiten, welches f\u00fcr Autoren gedacht ist, die ihre Collection auf https:\/\/galaxy.ansible.com<\/a> ver\u00f6ffentlichen m\u00f6chten.<\/p>\n\n\n\n
Eine Collection linten<\/h2>\n\n\n\n
Bevor es zur Sache geht, wechsel ich in das Projektverzeichnis meiner Ansible Collection und erstelle einen neuen Branch, mit dem Befehl git checkout -b lint<\/code>. Die in meinem Repo vorhandene Datei .ansible-lint-ignore<\/code> l\u00f6sche ich, da ich im folgenden alle Fehler und Regelverst\u00f6\u00dfe sehen m\u00f6chte. Zu Beginn stellt sich mein Arbeitsverzeichnis wie folgt dar:<\/p>\n\n\n\n
(adt) nextcloud]$ git status\nOn branch lint\nChanges not staged for commit:\n  (use \"git add\/rm <file>...\" to update what will be committed)\n  (use \"git restore <file>...\" to discard changes in working directory)\n\tdeleted:    .ansible-lint-ignore\n\nno changes added to commit (use \"git add\" and\/or \"git commit -a\")<\/code><\/pre>\n\n\n\n
Das Programm ansible-lint<\/code> besitzt mit der Option --fix<\/code> die F\u00e4higkeit, Fehler automatisch zu korrigieren und auch YAML-Dateien neu zu formatieren. Der folgende Code-Block umfasst die gek\u00fcrzte Ausgabe, wenn das Kommando ansible-lint --profile=shared --fix<\/code> im Arbeitsverzeichnis ausgef\u00fchrt wird.<\/p>\n\n\n\n
(adt) nextcloud]$ ansible-lint --profile=shared --fix\nWARNING  Listing 37 violation(s) that are fatal\ngalaxy[no-changelog]: No changelog found. Please add a changelog file. Refer to the galaxy.md file for more info.\ngalaxy.yml:1\n\nvar-naming[pattern]: Variables names should match ^[a-z_][a-z0-9_]*$ regex. (NC_HTML) (vars: NC_HTML)\nroles\/backup_restore_nextcloud\/defaults\/main.yml:4\n\n\u2026\n\nrisky-file-permissions: File permissions unset or incorrect.\nroles\/backup_restore_nextcloud\/tasks\/main.yml:18 Task\/Handler: Copy backup files to container host\n\nno-changed-when: Commands should not change things if nothing needs doing.\nroles\/backup_restore_nextcloud\/tasks\/main.yml:40 Task\/Handler: Import tarball contents into an existing podman volume\n\nno-changed-when: Commands should not change things if nothing needs doing.\nroles\/backup_restore_nextcloud\/tasks\/main.yml:54 Task\/Handler: Export podman volumes to tarballs\n\nvar-naming[pattern]: Variables names should match ^[a-z_][a-z0-9_]*$ regex. (MYSQL_DATABASE) (vars: MYSQL_DATABASE)\nroles\/deploy_nextcloud_with_mariadb_pod\/defaults\/main.yml:13\n\n\u2026\n\nRead documentation for instructions on how to ignore specific rule violations.\n\nModified 6 files.\n                     Rule Violation Summary                      \n count tag                    profile rule associated tags       \n    33 var-naming[pattern]    basic   idiom                      \n     1 risky-file-permissions safety  unpredictability           \n     1 galaxy[no-changelog]   shared  metadata                   \n     2 no-changed-when        shared  command-shell, idempotency \n\nFailed: 37 failure(s), 0 warning(s) on 25 files. Profile 'shared' was required, but 'min' profile passed.<\/code><\/pre>\n\n\n\n
Obige Ausgabe:<\/p>\n\n\n\n