Merge branch 'feature/first-working-version' into 'main'

Feature/first working version

See merge request homelab/ansible-resources/roles/manage_apt_packages!1

.ansible-lint

@@ -0,0 +1,8 @@
+---
+warn_list:
+  - experimental  # all rules tagged as experimental
+  - yaml  # violations reported by yamllint
+  - meta-no-info
+
+skip_list:
+  - jinja[spacing]  # Rule that looks inside jinja2 templates.

.github/workflows/publish.yml

@@ -0,0 +1,18 @@
+---
+name: publish
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  publish:
+    name: Publish to galaxy
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Publish
+        uses: ednxzu/galaxy-import-role@v1
+        with:
+          galaxy-api-key: ${{ secrets.GALAXY_API_TOKEN }}

.gitignore

@@ -0,0 +1,2 @@
+# ignore molecule/testinfra pycache 
+**/__pycache__

.gitlab-ci.yml

@@ -0,0 +1,82 @@
+---
+stages:
+  - verify
+  - test-default
+  - test-with-custom-packages
+
+image:
+  name: registry.ednz.fr/forge/ansible-runner
+
+variables:
+  ANSIBLE_HOST_KEY_CHECKING: 'false'
+  ANSIBLE_FORCE_COLOR: 'true'
+  ANSIBLE_PYTHON_INTERPRETER: /usr/bin/python3
+  DOCKER_AUTH_CONFIG: $CI_DOCKER_AUTH_CONFIG
+
+.stage-test-default:
+  stage: test-default
+
+.stage-test-with-custom-packages:
+  stage: test-with-custom-packages
+
+.variables-ubuntu-2004:
+  variables:
+    MOLECULE_TEST_OS: "ubuntu2004"
+
+.variables-ubuntu-2204:
+  variables:
+    MOLECULE_TEST_OS: "ubuntu2204"
+
+.variables-debian-11:
+  variables:
+    MOLECULE_TEST_OS: "debian11"
+
+.script-molecule-test-default:
+  script:
+    - molecule test
+
+.script-molecule-test-with-custom-packages:
+  script:
+    - molecule test -s with_custom_packages
+
+ansible-verify:
+  stage: verify
+  script:
+    - yamllint . -c .yamllint
+    - ansible-lint
+
+ansible-test-ubuntu-2004-default:
+  extends:
+    - .stage-test-default
+    - .variables-ubuntu-2004
+    - .script-molecule-test-default
+
+ansible-test-ubuntu-2204-default:
+  extends:
+    - .stage-test-default
+    - .variables-ubuntu-2204
+    - .script-molecule-test-default
+
+ansible-test-debian-11-default:
+  extends:
+    - .stage-test-default
+    - .variables-debian-11
+    - .script-molecule-test-default
+
+ansible-test-ubuntu-2004-with-custom-packages:
+  extends:
+    - .stage-test-with-custom-packages
+    - .variables-ubuntu-2004
+    - .script-molecule-test-with-custom-packages
+
+ansible-test-ubuntu-2204-with-custom-packages:
+  extends:
+    - .stage-test-with-custom-packages
+    - .variables-ubuntu-2204
+    - .script-molecule-test-with-custom-packages
+
+ansible-test-debian-11-with-custom-packages:
+  extends:
+    - .stage-test-with-custom-packages
+    - .variables-debian-11
+    - .script-molecule-test-with-custom-packages

.yamllint

@@ -0,0 +1,40 @@
+---
+# Based on ansible-lint config
+extends: default
+
+rules:
+  braces:
+    max-spaces-inside: 1
+    level: error
+  brackets:
+    max-spaces-inside: 1
+    level: error
+  colons:
+    max-spaces-after: -1
+    level: error
+  commas:
+    max-spaces-after: -1
+    level: error
+  comments: enable
+  comments-indentation: disable
+  document-start: enable
+  empty-lines:
+    max: 3
+    level: error
+  hyphens:
+    level: error
+  indentation: enable
+  key-duplicates: enable
+  line-length:
+    max: 80
+    level: warning
+  new-line-at-end-of-file: enable
+  new-lines:
+    type: unix
+  trailing-spaces: enable
+  truthy:
+    allowed-values:
+      - 'true'
+      - 'false'
+      - 'yes'
+      - 'no'

LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jeff Geerling
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,92 +1,63 @@
-# manage_apt_packages
+Manage apt packages
+=========
+> This repository is only a mirror. Development and testing is done on a private gitlab server.
 
+This role enables you to manage packages on **debian-based** distributions. It can be used on its own , or be called by other roles the install/remove packages on demand.
 
+Requirements
+------------
 
-## Getting started
+None.
 
-To make it easy for you to get started with GitLab, here's a list of recommended next steps.
+Role Variables
-
+--------------
-Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
+Available variables are listed below, along with default values. A sample file for the default values is available in `default/manage_apt_packages.yml.sample` in case you need it for any `group_vars` or `host_vars` configuration.
-
-## Add your files
-
-- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-- [ ] [Add files using the command line](https://docs.gitlab.com/ee/gitlab-basics/add-file.html#add-a-file-using-the-command-line) or push an existing Git repository with the following command:
 
+```yaml
+manage_apt_packages_list: # by default, not defined
+  - name: nginx
+    version: latest # Leaving empty or setting '' will be considered as latest
+    state: absent
+  - name: ...
 ```
-cd existing_repo
+This variable is a list of packages, with their name, desired version and state. Note that the role allows version rollbacks, so unless you absolutely need a specific version, it is usualy advised to keep the version on `latest` on empty (which is considered the same).
-git remote add origin https://gitlab.ednz.fr/homelab/ansible-resources/roles/manage_apt_packages.git
+
-git branch -M main
+Dependencies
-git push -uf origin main
+------------
+
+None.
+
+Example Playbook
+----------------
+
+Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
+```yaml
+# calling the role inside a playbook with either the default or group_vars/host_vars
+- hosts: servers
+  roles:
+    - ednxzu.manage_apt_packages
 ```
 
-## Integrate with your tools
+```yaml
+# calling the role inside a playbook and injecting variables (in another role for example)
+- hosts: servers
+  tasks:
+    - name: "Install nginx package"
+      ansible.builtin.include_role: 
+        name: ednxzu.manage_apt_packages
+      vars:
+        manage_apt_packages_list:
+          - name: consul
+            version: 1.13.1-1
+            state: present
+```
 
-- [ ] [Set up project integrations](https://gitlab.ednz.fr/homelab/ansible-resources/roles/manage_apt_packages/-/settings/integrations)
+License
+-------
 
-## Collaborate with your team
+MIT / BSD
 
-- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
+Author Information
-- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
+------------------
-- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
-- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
-- [ ] [Automatically merge when pipeline succeeds](https://docs.gitlab.com/ee/user/project/merge_requests/merge_when_pipeline_succeeds.html)
 
-## Test and Deploy
+This role was created by Bertrand Lanson in 2023.
-
-Use the built-in continuous integration in GitLab.
-
-- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/index.html)
-- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing(SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
-
-***
-
-# Editing this README
-
-When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thank you to [makeareadme.com](https://www.makeareadme.com/) for this template.
-
-## Suggestions for a good README
-Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
-
-## Name
-Choose a self-explaining name for your project.
-
-## Description
-Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
-
-## Badges
-On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
-
-## Visuals
-Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
-
-## Installation
-Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
-
-## Usage
-Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
-
-## Support
-Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
-
-## Roadmap
-If you have ideas for releases in the future, it is a good idea to list them in the README.
-
-## Contributing
-State if you are open to contributions and what your requirements are for accepting them.
-
-For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
-
-You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
-
-## Authors and acknowledgment
-Show your appreciation to those who have contributed to the project.
-
-## License
-For open source projects, say how it is licensed.
-
-## Project status
-If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.

defaults/main.yml

@@ -0,0 +1,6 @@
+---
+# defaults file for manage_apt_packages
+manage_apt_packages_list:
+  - name: nginx
+    version: latest
+    state: absent

defaults/manage_apt_packages.yml.sample

@@ -0,0 +1,11 @@
+---
+# manage_apt_packages_list:
+#   - name: nginx
+#     version: 1.18.0-6ubuntu14
+#     state: present
+#   - name: apache2
+#     version: 2.4.52-1ubuntu4.4
+#     state: present
+#   - name:
+#     version:
+#     state:

handlers/main.yml

@@ -0,0 +1,6 @@
+---
+# handlers file for manage_apt_packages
+- name: "Remove unnecessary dependencies"
+  ansible.builtin.apt:
+    autoremove: yes
+  listen: "apt-autoremove"

meta/main.yml

@@ -0,0 +1,23 @@
+---
+# meta file for manage_repositories
+galaxy_info:
+  namespace: 'ednxzu'
+  role_name: 'manage_apt_packages'
+  author: 'Bertrand Lanson'
+  description: 'Package management for debian-based distros.'
+  license: 'license (BSD, MIT)'
+  min_ansible_version: '2.10'
+  platforms:
+    - name: Ubuntu
+      versions:
+        - focal
+        - jammy
+    - name: Debian
+      versions:
+        - bullseye
+  galaxy_tags:
+    - 'ubuntu'
+    - 'debian'
+    - 'packages'
+
+dependencies: []

molecule/default/converge.yml

@@ -0,0 +1,7 @@
+---
+- name: Converge
+  hosts: all
+  tasks:
+    - name: "Include ednxzu.manage_apt_packages"
+      ansible.builtin.include_role:
+        name: "ednxzu.manage_apt_packages"

molecule/default/molecule.yml

@@ -0,0 +1,41 @@
+---
+dependency:
+  name: galaxy
+  options:
+    requirements-file: ./requirements.yml
+driver:
+  name: docker
+platforms:
+  - name: instance
+    image: geerlingguy/docker-${MOLECULE_TEST_OS}-ansible
+    command: ""
+    volumes:
+      - /sys/fs/cgroup:/sys/fs/cgroup
+    cgroupns_mode: host
+    privileged: true
+    pre_build_image: true
+provisioner:
+  name: ansible
+  config_options:
+    defaults:
+      remote_tmp: /tmp/.ansible
+verifier:
+  name: testinfra
+lint: |
+  yamllint -c .yamllint .
+  ansible-lint
+scenario:
+  name: default
+  test_sequence:
+    - dependency
+    - lint
+    - cleanup
+    - destroy
+    - syntax
+    - create
+    - prepare
+    - converge
+    - idempotence
+    - verify
+    - cleanup
+    - destroy

molecule/default/requirements.yml

@@ -0,0 +1,3 @@
+---
+# requirements file for molecule
+roles: []

molecule/default/tests/conftest.py

@@ -0,0 +1,22 @@
+"""PyTest Fixtures."""
+from __future__ import absolute_import
+
+import os
+
+import pytest
+
+
+def pytest_runtest_setup(item):
+    """Run tests only when under molecule with testinfra installed."""
+    try:
+        import testinfra
+    except ImportError:
+        pytest.skip("Test requires testinfra", allow_module_level=True)
+    if "MOLECULE_INVENTORY_FILE" in os.environ:
+        pytest.testinfra_hosts = testinfra.utils.ansible_runner.AnsibleRunner(
+            os.environ["MOLECULE_INVENTORY_FILE"]
+        ).get_hosts("all")
+    else:
+        pytest.skip(
+            "Test should run only from inside molecule.", allow_module_level=True
+        )

molecule/default/tests/test_default.py

@@ -0,0 +1,16 @@
+"""Role testing files using testinfra."""
+
+
+def test_hosts_file(host):
+    """Validate /etc/hosts file."""
+    etc_hosts = host.file("/etc/hosts")
+    assert etc_hosts.exists
+    assert etc_hosts.user == "root"
+    assert etc_hosts.group == "root"
+
+def test_packages_not_installed(host):
+    """Validate nginx and apache2 are not installed"""
+    apt_package_nginx = host.package("nginx")
+    apt_package_apache2 = host.package("apache2")
+    assert not apt_package_nginx.is_installed
+    assert not apt_package_apache2.is_installed

molecule/with_custom_packages/converge.yml

@@ -0,0 +1,7 @@
+---
+- name: Converge
+  hosts: all
+  tasks:
+    - name: "Include ednxzu.manage_apt_packages"
+      ansible.builtin.include_role:
+        name: "ednxzu.manage_apt_packages"

molecule/with_custom_packages/group_vars/all.yml

@@ -0,0 +1,11 @@
+---
+manage_apt_packages_list:
+  - name: mariadb-server
+    version: latest
+    state: present
+  - name: apache2
+    version: latest
+    state: present
+  - name: consul
+    version: 1.13.1-1
+    state: present

molecule/with_custom_packages/molecule.yml

@@ -0,0 +1,40 @@
+---
+dependency:
+  name: galaxy
+  options:
+    requirements-file: ./requirements.yml
+driver:
+  name: docker
+platforms:
+  - name: instance
+    image: geerlingguy/docker-${MOLECULE_TEST_OS}-ansible
+    command: ""
+    volumes:
+      - /sys/fs/cgroup:/sys/fs/cgroup
+    cgroupns_mode: host
+    privileged: true
+    pre_build_image: true
+provisioner:
+  name: ansible
+  config_options:
+    defaults:
+      remote_tmp: /tmp/.ansible
+verifier:
+  name: testinfra
+lint: |
+  yamllint -c .yamllint .
+  ansible-lint
+scenario:
+  name: with_custom_packages
+  test_sequence:
+    - dependency
+    - lint
+    - cleanup
+    - destroy
+    - syntax
+    - create
+    - prepare
+    - converge
+    - idempotence
+    - verify
+    - destroy

molecule/with_custom_packages/prepare.yml

@@ -0,0 +1,18 @@
+---
+- name: Prepare
+  hosts: all
+  tasks:
+    - name: "Include manage_repositories"
+      ansible.builtin.include_role:
+        name: "ednxzu.manage_repositories"
+      vars:
+        manage_repositories_enable_default_repo: true
+        manage_repositories_enable_custom_repo: true
+        manage_repositories_custom_repo:
+          - uri: "https://apt.releases.hashicorp.com"
+            gpg_key: "https://apt.releases.hashicorp.com/gpg"
+            comments: "hashicorp repository"
+            type: "deb"
+            suites: "{{ ansible_distribution_release }}"
+            components: "main"
+            filename: "hashicorp"

molecule/with_custom_packages/requirements.yml

@@ -0,0 +1,4 @@
+---
+# requirements file for molecule
+roles:
+  - name: ednxzu.manage_repositories

molecule/with_custom_packages/tests/conftest.py

@@ -0,0 +1,22 @@
+"""PyTest Fixtures."""
+from __future__ import absolute_import
+
+import os
+
+import pytest
+
+
+def pytest_runtest_setup(item):
+    """Run tests only when under molecule with testinfra installed."""
+    try:
+        import testinfra
+    except ImportError:
+        pytest.skip("Test requires testinfra", allow_module_level=True)
+    if "MOLECULE_INVENTORY_FILE" in os.environ:
+        pytest.testinfra_hosts = testinfra.utils.ansible_runner.AnsibleRunner(
+            os.environ["MOLECULE_INVENTORY_FILE"]
+        ).get_hosts("all")
+    else:
+        pytest.skip(
+            "Test should run only from inside molecule.", allow_module_level=True
+        )

molecule/with_custom_packages/tests/test_default.py

@@ -0,0 +1,19 @@
+"""Role testing files using testinfra."""
+
+
+def test_hosts_file(host):
+    """Validate /etc/hosts file."""
+    etc_hosts = host.file("/etc/hosts")
+    assert etc_hosts.exists
+    assert etc_hosts.user == "root"
+    assert etc_hosts.group == "root"
+
+def test_packages_is_installed(host):
+    """Validate mariadb-server, apache2 and consul are installed"""
+    apt_package_mariadb = host.package("mariadb-server")
+    apt_package_apache2 = host.package("apache2")
+    apt_package_consul = host.package("consul")
+    assert apt_package_mariadb.is_installed
+    assert apt_package_apache2.is_installed
+    assert apt_package_consul.is_installed
+    assert apt_package_consul.version == "1.13.1-1"

tasks/main.yml

@@ -0,0 +1,16 @@
+---
+# task/main file for manage_apt_packages
+- name: "Update apt caches"
+  ansible.builtin.apt:
+    update_cache: yes
+    cache_valid_time: 3600
+
+- name: "Install/remove required packages"
+  ansible.builtin.apt:
+    name: "{{ item.name }}{% if item.version not in [None, '', 'latest'] %}={{ item.version }}{% endif %}"
+    state: "{{ item.state }}"
+    allow_downgrade:
+  loop: "{{ manage_apt_packages_list }}"
+  when: manage_apt_packages_list is defined
+    and manage_apt_packages_list not in [None, '']
+  notify: "apt-autoremove"

vars/main.yml

@@ -0,0 +1,2 @@
+---
+# vars file for manage_apt_packages