Allow mutiple paths for logrotate_entries.

Author: robertdebock

README.md

@@ -92,6 +92,12 @@ This example is taken from [`molecule/default/converge.yml`](https://github.com/
       - name: example-prerotate
         path: "/var/log/example-prerotate/*.log"
         prerotate: touch /tmp/logrotate-prerotate
+      - name: example-paths
+        paths:
+          - "/var/log/example-paths/a.log"
+          - "/var/log/example-paths/b.log"
+        frequency: weekly
+        keep: 4
       - name: example-absent
         state: absent
         # Negative numbers work on some distributions: `error: example-negative:10 bad rotation count '-1'\`
@@ -135,6 +141,7 @@ The machine needs to be prepared. In CI this is done using [`molecule/default/pr
         - /var/log/example-dateyesterday
         - /var/log/example-prerotate
         - /var/log/example-su
+        - /var/log/example-paths
 
     - name: Create log file
       ansible.builtin.copy:
@@ -154,6 +161,8 @@ The machine needs to be prepared. In CI this is done using [`molecule/default/pr
         - /var/log/example-dateyesterday/app.log
         - /var/log/example-prerotate/app.log
         - /var/log/example-su/app.log
+        - /var/log/example-paths/a.log
+        - /var/log/example-paths/b.log
         - /var/log/btmp
         - /var/log/wtmp
         - /var/log/hawkey.log

meta/argument_specs.yml

@@ -48,3 +48,18 @@ argument_specs:
         type: bool
         description: "Set the enabled state the service."
         default: true
+      logrotate_entries:
+        type: list
+        elements: dict
+        description: "List of logrotate.d entries. Each entry must have either path (single path) or paths (list of paths), mutually exclusive."
+        suboptions:
+          name:
+            type: str
+            description: "Name of the config file in logrotate.d."
+          path:
+            type: str
+            description: "Single log path. Mutually exclusive with paths."
+          paths:
+            type: list
+            elements: str
+            description: "Multiple log paths for one block. Mutually exclusive with path."

molecule/default/converge.yml

@@ -79,6 +79,12 @@
       - name: example-prerotate
         path: "/var/log/example-prerotate/*.log"
         prerotate: touch /tmp/logrotate-prerotate
+      - name: example-paths
+        paths:
+          - "/var/log/example-paths/a.log"
+          - "/var/log/example-paths/b.log"
+        frequency: weekly
+        keep: 4
       - name: example-absent
         state: absent
         # Negative numbers work on some distributions: `error: example-negative:10 bad rotation count '-1'\`

molecule/default/prepare.yml

@@ -27,6 +27,7 @@
         - /var/log/example-dateyesterday
         - /var/log/example-prerotate
         - /var/log/example-su
+        - /var/log/example-paths
 
     - name: Create log file
       ansible.builtin.copy:
@@ -46,6 +47,8 @@
         - /var/log/example-dateyesterday/app.log
         - /var/log/example-prerotate/app.log
         - /var/log/example-su/app.log
+        - /var/log/example-paths/a.log
+        - /var/log/example-paths/b.log
         - /var/log/btmp
         - /var/log/wtmp
         - /var/log/hawkey.log

molecule/default/verify.yml

@@ -20,3 +20,17 @@
           - logrotate_prerotate_marker.stat.exists
           - logrotate_prerotate_marker.stat.isreg
         quiet: true
+
+    - name: Read example-paths logrotate config
+      ansible.builtin.slurp:
+        src: /etc/logrotate.d/example-paths
+      register: example_paths_config
+
+    - name: Assert example-paths config contains both paths and shared block
+      ansible.builtin.assert:
+        that:
+          - (example_paths_config.content | b64decode) is search("/var/log/example-paths/a.log")
+          - (example_paths_config.content | b64decode) is search("/var/log/example-paths/b.log")
+          - (example_paths_config.content | b64decode) is search("weekly")
+          - (example_paths_config.content | b64decode) is search("rotate 4")
+        quiet: true

tasks/assert.yml

@@ -65,9 +65,12 @@
       - item.name is defined
       - item.name is string
       - item.name is not none
-      - item.path is defined
-      - item.path is string
-      - item.path is not none
+      - >
+        (item.path is defined and item.path is string and item.path is not none
+         and item.paths is not defined)
+        or
+        (item.paths is defined and item.paths is iterable and item.paths is not string
+         and item.paths is not mapping and item.path is not defined)
     quiet: true
   loop: "{{ logrotate_entries }}"
   loop_control:
@@ -76,6 +79,20 @@
     - logrotate_entries is defined
     - item.state is not defined or item.state != "absent"
 
+- name: assert | Test paths in logrotate_entries (each path is string)
+  ansible.builtin.assert:
+    that:
+      - (item.paths | reject("string") | list | length) == 0
+      - (item.paths | select("none") | list | length) == 0
+    quiet: true
+  loop: "{{ logrotate_entries }}"
+  loop_control:
+    label: "{{ item.name }}"
+  when:
+    - logrotate_entries is defined
+    - item.state is not defined or item.state != "absent"
+    - item.paths is defined
+
 - name: assert | Test state in logrotate_entries
   ansible.builtin.assert:
     that:

templates/entry.j2

@@ -1,6 +1,6 @@
 {{ ansible_managed | comment }}
 
-{{ item.path }} {
+{% if item.paths is defined %}{{ item.paths | join(' ') }} {% else %}{{ item.path }} {% endif %}{
 
 {% if item.frequency is defined %}    {{ item.frequency }}
 {% endif -%}{% if item.compress is defined and item.compress %}    compress