dev tools configuration

.ansible-lint

@@ -0,0 +1,2 @@
+skip_list:
+  - 'var-naming[no-role-prefix]'

.github/workflows/lint.yml

@@ -1,41 +1,24 @@
 name: 'Lint'
 on:
-  pull_request: {}
-  push: {}
+  pull_request: { }
+  push: { }
 
 jobs:
   lint:
     name: 'Lint'
     runs-on: ubuntu-latest
-    container:
-      image: python:3.9-alpine
     steps:
       - name: 'Checkout'
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
-      - name: Setup ansible
-        run: |
-          apk add --update --no-cache --virtual build_dependencies gcc musl-dev libffi-dev openssl-dev rust cargo
-          pip install --no-cache-dir ansible-core
-
-          ansible-galaxy collection install community.general
-
-      - name: 'Yamllint'
-        uses: karancode/yamllint-github-action@master
+      - name: Cache .venv directory
+        uses: actions/cache@v3
         with:
-          yamllint_file_or_dir: 'roles'
-          yamllint_strict: false
-          yamllint_comment: false
+          path: .venv
+          key: ${{ runner.os }}-venv-${{ hashFiles('**/requirements.txt') }}
 
-      - name: Checkout
-        uses: actions/checkout@v3
-
-      - name: "Ansible lint playbooks"
-        uses: ansible/[email protected]
-        with:
-          path: "playbooks/*"
-
-      - name: "Ansible lint roles"
-        uses: ansible/[email protected]
-        with:
-          path: "roles/*"
+      - name: Lint
+        run: |
+          make init-venv
+
+          make lint

.github/workflows/release.yml

@@ -7,16 +7,16 @@ permissions:
 on:
   create:
     tags:
-      - v*
+      - 'v[0-9]+.[0-9]+.[0-9]+'
 
 jobs:
   release:
     runs-on: ubuntu-latest
     container:
-      image: python:3.9-alpine
+      image: python:3.11-alpine
     steps:
       - name: checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Publish collection to ansible galaxy
         env:

.github/workflows/test.yml

@@ -0,0 +1,26 @@
+name: 'Molecule Test'
+on:
+  pull_request: { }
+  push:
+    branches:
+      - master
+
+jobs:
+  lint:
+    name: 'Test'
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout'
+        uses: actions/checkout@v4
+
+      - name: Cache .venv directory
+        uses: actions/cache@v3
+        with:
+          path: .venv
+          key: ${{ runner.os }}-venv-${{ hashFiles('**/requirements.txt') }}
+
+      - name: Converge
+        run: |
+          make init-venv
+
+          make molecule-converge

.gitignore

@@ -1,3 +1,4 @@
 .idea
 .vagrant
 .vscode
+.venv

Makefile

@@ -0,0 +1,22 @@
+init-venv:
+	python3 -m venv .venv
+	. .venv/bin/activate
+	pip install -r requirements.txt
+	ansible-galaxy collection install community.general==8.3.0
+
+venv:
+	. .venv/bin/activate
+
+lint: venv
+	yamllint roles playbooks
+	ansible-lint roles/ playbooks/
+
+molecule-converge: venv
+	cd roles/single && molecule converge -s docker
+	cd roles/vmagent && molecule converge -s docker
+	cd roles/vmalert && molecule converge -s docker
+
+molecule-destroy: venv
+	cd roles/single && molecule destroy -s docker
+	cd roles/vmagent && molecule destroy -s docker
+	cd roles/vmalert && molecule destroy -s docker

README.md

@@ -27,9 +27,11 @@ Collection includes the following roles:
 - add non-docker environment
 - fix hardcoded ports
 
-# Testing
+# Development
 
-I'm using vagrant and libvirt for testing purpose. visit vendors' web-site for instructions of installing program.
-vagrant: https://www.vagrantup.com/downloads
+In order to set up development environment, you need to have `docker`, `python` and `make` installed.
+Run `make init-venv` to create virtual environment and install required packages for linting and testing with [molecule](https://ansible.readthedocs.io/projects/molecule).
 
-Also, most roles are tested with `molecule`. Please, check out installation docs: https://ansible.readthedocs.io/projects/molecule/installation/
+Please, note that [cluster](./roles/cluster) role is tested with `vagrant` and `libvirt` provider and requires `vagrant` [to be installed](https://www.vagrantup.com/downloads).
+
+Refer to [Makefile](./Makefile) for available commands for linting and molecule testing.

galaxy.yml

@@ -19,6 +19,8 @@ build_ignore:
     - inventory_example
     - Vagrantfile
     - '*.tar.gz'
+    - Makefile
+    - requirements.txt
 homepage: "https://github.com/VictoriaMetrics/ansible-playbooks"
 documentation: "https://github.com/VictoriaMetrics/ansible-playbooks"
 issues: "https://github.com/VictoriaMetrics/ansible-playbooks/issues"

requirements.txt

@@ -0,0 +1,7 @@
+ansible-compat==4.1.11
+ansible-core==2.16.3
+ansible-lint==24.2.0
+docker==7.0.0
+molecule==24.2.0
+molecule-plugins==23.5.3
+yamllint==1.35.1

roles/cluster/molecule/default/verify.yml

@@ -17,7 +17,7 @@
       ansible.builtin.get_url:
         url: "{{ goss_url }}"
         dest: "{{ goss_bin }}"
-        sha256sum: "{{ goss_sha256sum }}"
+        sha256sum: "{{ goss_sha256sum }}" # noqa: args[module]
         mode: "u=rwx,go=rx"
       register: download_goss
       until: download_goss is succeeded

roles/single/molecule/docker/converge.yml

@@ -0,0 +1,16 @@
+---
+- name: Converge
+  hosts: all
+  become: yes
+  vars:
+    victoriametrics_data_dir: "/tmp/victoria-metrics/"
+    victoriametrics_backup_enabled: false
+    victoriametrics_service_envflag_enabled: true
+    victoriametrics_service_envflag_data:
+      - "graphiteListenAddr=127.0.0.1:12345"
+    victoriametrics_service_args:
+      storageDataPath: "{{ victoriametrics_data_dir }}"
+  tasks:
+    - name: "Include single"
+      ansible.builtin.include_role:
+        name: "single"

roles/single/molecule/docker/molecule.yml

@@ -0,0 +1,27 @@
+---
+lint: |
+  yamllint .
+  ansible-lint .
+
+
+dependency:
+  name: galaxy
+
+driver:
+  name: docker
+
+platforms:
+  - name: vmsingle-debian11
+    image: "geerlingguy/docker-${MOLECULE_DISTRO:-debian11}-ansible:latest"
+    command: ${MOLECULE_DOCKER_COMMAND:-""}
+    volumes:
+      - /sys/fs/cgroup:/sys/fs/cgroup:rw
+    cgroupns_mode: host
+    privileged: true
+    pre_build_image: true
+
+provisioner:
+  name: ansible
+
+verifier:
+  name: ansible

roles/single/molecule/docker/verify.yml

@@ -0,0 +1,31 @@
+---
+# This is an example playbook to execute Ansible tests.
+
+- name: Verify
+  hosts: all
+  tasks:
+    - name: Check if port 12345 is listening
+      ansible.builtin.wait_for:
+        port: 12345
+        delay: 5
+        timeout: 10
+        msg: "Timeout waiting for port to respond"
+      register: port_check
+      ignore_errors: yes
+
+    - name: Validate victoria is listening
+      ansible.builtin.assert:
+        that: port_check is succeeded
+
+    - name: Check if port 8428 is listening
+      ansible.builtin.wait_for:
+        port: 8428
+        delay: 5
+        timeout: 10
+        msg: "Timeout waiting for port to respond"
+      register: port_check
+      ignore_errors: yes
+
+    - name: Validate victoria is listening
+      ansible.builtin.assert:
+        that: port_check is succeeded

roles/single/tasks/install.yml

@@ -72,7 +72,7 @@
         - not victoriametrics_is_installed.stat.exists or
           victoriametrics_version not in victoriametrics_current_version.stdout
 
-    - name: Upload VictoriaMetrics release binary
+    - name: Upload VictoriaMetrics release binary # noqa: no-handler
       ansible.builtin.copy:
         src: /tmp/vic-single/victoria-metrics-prod
         dest: /usr/local/bin
@@ -82,7 +82,7 @@
       when:
         - archive_downloaded is changed
 
-    - name: Download VictoriaMetrics utils
+    - name: Download VictoriaMetrics utils # noqa: no-handler
       become: no
       environment:
         http_proxy: ''
@@ -95,7 +95,7 @@
       when:
         - archive_downloaded is changed
 
-    - name: Upload VictoriaMetrics release binaries
+    - name: Upload VictoriaMetrics release binaries # noqa: no-handler
       ansible.builtin.copy:
         src: "/tmp/vic-utils/{{ item }}"
         dest: /usr/local/bin

roles/single/tests/playbook.yml

@@ -1,6 +1,6 @@
 ---
-- hosts: all
-  name: Test role
+- name: Test role
+  hosts: all
   become: true
   roles:
     - "single"

roles/vmagent/molecule/default/verify.yml

@@ -17,7 +17,7 @@
       ansible.builtin.get_url:
         url: "{{ goss_url }}"
         dest: "{{ goss_bin }}"
-        sha256sum: "{{ goss_sha256sum }}"
+        sha256sum: "{{ goss_sha256sum }}" # noqa: args[module]
         mode: "u=rwx,go=rx"
       register: download_goss
       until: download_goss is succeeded

roles/vmagent/molecule/docker/converge.yml

@@ -0,0 +1,8 @@
+---
+- name: Converge
+  hosts: all
+  become: yes
+  tasks:
+    - name: "Include vmagent"
+      ansible.builtin.include_role:
+        name: "vmagent"

roles/vmagent/molecule/docker/molecule.yml

@@ -0,0 +1,25 @@
+---
+lint: |
+  yamllint .
+  ansible-lint .
+
+
+dependency:
+  name: galaxy
+driver:
+  name: docker
+
+platforms:
+  - name: vmagent-debian11
+    image: "geerlingguy/docker-${MOLECULE_DISTRO:-debian11}-ansible:latest"
+    command: ${MOLECULE_DOCKER_COMMAND:-""}
+    volumes:
+      - /sys/fs/cgroup:/sys/fs/cgroup:rw
+    cgroupns_mode: host
+    privileged: true
+    pre_build_image: true
+
+provisioner:
+  name: ansible
+verifier:
+  name: ansible

roles/vmagent/molecule/docker/tests/test_default.yml

@@ -0,0 +1,4 @@
+service:
+  "vic-vmagent":
+    enabled: true
+    running: true