initial version of the system_settings_logging module (#61)

* initial version of the system_settings_logging module --------- Co-authored-by: KiLLuuuhh <[email protected]>
puzzle · Apr 15, 2024 · 9d15fcd · 9d15fcd
1 parent 46c27a5
commit 9d15fcd
Show file tree

Hide file tree

Showing 7 changed files with 368 additions and 3 deletions.
diff --git a/molecule/system_settings_general/molecule.yml b/molecule/system_settings_general/molecule.yml
@@ -2,7 +2,7 @@
 scenario:
     name: system_settings_general
     test_sequence:
-        # - dependency not relevant uless we have requirements
+        # - dependency not relevant unless we have requirements
         - destroy
         - syntax
         - create

diff --git a/molecule/system_settings_logging/converge.yml b/molecule/system_settings_logging/converge.yml
@@ -0,0 +1,54 @@
+---
+- name: converge
+  hosts: all
+  become: true
+  tasks:
+
+    - name: Converge - Get OPNsense version
+      ansible.builtin.command: opnsense-version -O
+      register: opnsense_version_cmd
+
+    - name: Converge - Set OPNsense version fact
+      ansible.builtin.set_fact:
+        opnsense_version: "{{ opnsense_version_cmd.stdout | from_json }}"
+
+    - name: Converge - Set preserve logs
+      puzzle.opnsense.system_settings_logging:
+        preserve_logs: 11
+
+    - name: Converge - Set max log file size on supported opnsense versions
+      puzzle.opnsense.system_settings_logging:
+        max_log_file_size_mb: 15
+      when: opnsense_version["product_version"] is version('24.1', '>=')
+
+    - name: Converge - Set max log file size on unsupported opnsense versions
+      puzzle.opnsense.system_settings_logging:
+        max_log_file_size_mb: 15
+      when: opnsense_version["product_version"] is version('24.1', '<')
+      register: test_unsupported_max_log_file_size_mb
+      ignore_errors: yes
+
+    - name: Verify that setting max_log_file_size_mb failed to to unsupported OPNsense version
+      ansible.builtin.assert:
+        that:
+          - test_unsupported_max_log_file_size_mb is failed
+        fail_msg: "Setting max_log_file_size_mb should fail on unsupported OPNsense versions"
+        success_msg: "Setting max_log_file_size_mb failed as expected due to unsupported OPNsense version"
+      when: opnsense_version["product_version"] is version('24.1', '<')
+
+    # we have no alternative way to compare the values
+    # other than getting them from the config
+    # see https://github.com/opnsense/core/blob/24.1/src/opnsense/scripts/syslog/log_archive#L36
+    - name: Get current config
+      ansible.builtin.slurp:
+        src: /conf/config.xml
+      register: current_config
+
+    - name: Compare preserve logs
+      ansible.builtin.assert:
+        that: "'<preservelogs>11</preservelogs>' in ( current_config.content | b64decode )"
+
+    - name: Compare max log file size
+      ansible.builtin.assert:
+        that: "'<maxfilesize>15</maxfilesize>' in ( current_config.content | b64decode )"
+      when: opnsense_version["product_version"] is version('24.1', '>=')
diff --git a/molecule/system_settings_logging/molecule.yml b/molecule/system_settings_logging/molecule.yml
@@ -0,0 +1,67 @@
+---
+scenario:
+    name: system_settings_logging
+    test_sequence:
+        # - dependency not relevant unless we have requirements
+        - destroy
+        - syntax
+        - create
+        - converge
+        - idempotence
+        - verify
+        - destroy
+
+driver:
+    name: vagrant
+    parallel: true
+
+platforms:
+    - name: "22.7"
+      hostname: false
+      box: puzzle/opnsense
+      box_version: "22.7"
+      memory: 1024
+      cpus: 2
+      instance_raw_config_args:
+          - 'vm.guest = :freebsd'
+          - 'ssh.sudo_command = "%c"'
+          - 'ssh.shell = "/bin/sh"'
+    - name: "23.1"
+      box: puzzle/opnsense
+      hostname: false
+      box_version: "23.1"
+      memory: 1024
+      cpus: 2
+      instance_raw_config_args:
+          - 'vm.guest = :freebsd'
+          - 'ssh.sudo_command = "%c"'
+          - 'ssh.shell = "/bin/sh"'
+    - name: "23.7"
+      box: puzzle/opnsense
+      hostname: false
+      box_version: "23.7"
+      memory: 1024
+      cpus: 2
+      instance_raw_config_args:
+          - 'vm.guest = :freebsd'
+          - 'ssh.sudo_command = "%c"'
+          - 'ssh.shell = "/bin/sh"'
+    - name: "24.1"
+      box: puzzle/opnsense
+      hostname: false
+      box_version: "24.1"
+      memory: 1024
+      cpus: 2
+      instance_raw_config_args:
+          - 'vm.guest = :freebsd'
+          - 'ssh.sudo_command = "%c"'
+          - 'ssh.shell = "/bin/sh"'
+
+provisioner:
+    name: ansible
+    env:
+        ANSIBLE_VERBOSITY: 3
+verifier:
+    name: ansible
+    options:
+        become: true
diff --git a/molecule/system_settings_logging/verify.yml b/molecule/system_settings_logging/verify.yml
@@ -0,0 +1,6 @@
+---
+- name: Verify connectivity to server
+  hosts: all
+  tasks:
+    - name: Ping the server
+      ansible.builtin.ping:
diff --git a/plugins/module_utils/module_index.py b/plugins/module_utils/module_index.py
@@ -76,7 +76,22 @@
                     "configure_params": ["true"],
                 },
             },
-        }
+        },
+        "system_settings_logging": {
+            "preserve_logs": "syslog/preservelogs",
+            # Add other mappings here
+            "php_requirements": [
+                "/usr/local/etc/inc/config.inc",
+                "/usr/local/etc/inc/util.inc",
+                "/usr/local/etc/inc/system.inc",
+            ],
+            "configure_functions": {
+                "system_settings_logging": {
+                    "name": "system_syslog_start",
+                    "configure_params": ["true"],
+                },
+            },
+        },
     },
     "23.1": {
         "system_settings_general": {
@@ -126,6 +141,21 @@
                 },
             },
         },
+        "system_settings_logging": {
+            "preserve_logs": "syslog/preservelogs",
+            # Add other mappings here
+            "php_requirements": [
+                "/usr/local/etc/inc/config.inc",
+                "/usr/local/etc/inc/util.inc",
+                "/usr/local/etc/inc/system.inc",
+            ],
+            "configure_functions": {
+                "system_settings_logging": {
+                    "name": "system_syslog_start",
+                    "configure_params": ["true"],
+                },
+            },
+        },
     },
     "23.7": {
         "system_settings_general": {
@@ -175,6 +205,21 @@
                 },
             },
         },
+        "system_settings_logging": {
+            "preserve_logs": "syslog/preservelogs",
+            # Add other mappings here
+            "php_requirements": [
+                "/usr/local/etc/inc/config.inc",
+                "/usr/local/etc/inc/util.inc",
+                "/usr/local/etc/inc/system.inc",
+            ],
+            "configure_functions": {
+                "system_settings_logging": {
+                    "name": "system_syslog_start",
+                    "configure_params": ["true"],
+                },
+            },
+        },
     },
     "24.1": {
         "system_settings_general": {
@@ -223,6 +268,22 @@
                     "configure_params": ["true"],
                 },
             },
-        }
+        },
+        "system_settings_logging": {
+            "preserve_logs": "syslog/preservelogs",
+            "max_log_file_size_mb": "syslog/maxfilesize",
+            # Add other mappings here
+            "php_requirements": [
+                "/usr/local/etc/inc/config.inc",
+                "/usr/local/etc/inc/util.inc",
+                "/usr/local/etc/inc/system.inc",
+            ],
+            "configure_functions": {
+                "system_settings_logging": {
+                    "name": "system_syslog_start",
+                    "configure_params": ["true"],
+                },
+            },
+        },
     },
 }
diff --git a/plugins/modules/system_settings_general.py b/plugins/modules/system_settings_general.py
@@ -6,10 +6,12 @@
 
 """system_settings_general module: Module to configure general OPNsense system settings"""
 
+# pylint: disable=duplicate-code
 __metaclass__ = type
 
 # https://docs.ansible.com/ansible/latest/dev_guide/developing_modules_documenting.html
 # fmt: off
+# pylint: disable=duplicate-code
 DOCUMENTATION = r'''
 ---
 author: