Drop OPNsense 22.7 support (#167)

DonGiovanni83 · web-flow · commit b8e704e34801 · 2025-02-19T08:12:19.000+01:00
* Remove 22.7 occurencies from doc

* Remove 22.7 molecule test cases

* Remove opnsense 22.7 from module support

* Add changelog fragment
diff --git a/changelogs/fragments/167-drop-22.7.yml b/changelogs/fragments/167-drop-22.7.yml
@@ -0,0 +1,3 @@
+---
+deprecated_features:
+  - OPNsense 22.7 support has been deprecated
diff --git a/docs/docsite/rst/development_guide.rst b/docs/docsite/rst/development_guide.rst
@@ -124,7 +124,7 @@ The ``VERSION_MAP`` is a crucial component in the OPNsense configuration utility
 Structure of VERSION_MAP
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
-- Top-Level Keys: Each top-level key represents a specific version of OPNsense, such as "OPNsense 22.7 (amd64/OpenSSL)".
+- Top-Level Keys: Each top-level key represents a specific version of OPNsense, such as "OPNsense 24.7 (amd64/OpenSSL)".
 
 - Config Context: Config context define a reusable context for modules to be consumed. They scope settings, configure functions and php requirements to single use cases. An Ansible Module can use one or multiple config contexts to access XML-Settings or php functions.
 
@@ -152,7 +152,7 @@ Example
 .. code-block:: python
 
     VERSION_MAP = {
-        "OPNsense 22.7 (amd64/OpenSSL)": {
+        "24.7": {
             "system_settings_general": {
                 "hostname": "system/hostname",
                 "domain": "system/domain",
@@ -170,12 +170,12 @@ Example
                 },
             }
         },
-        "OPNsense 23.1": {
+        "25.1": {
             ...
         },
     }
 
-In this example, the configuration for "OPNsense 22.7 (amd64/OpenSSL)" is outlined, detailing settings, PHP requirements, and configure functions specific to the 'system_settings_general' module.
+In this example, the configuration for "24.7" is outlined, detailing settings, PHP requirements, and configure functions specific to the 'system_settings_general' module.
 
 This detailed and version-specific mapping ensures the utility module operates correctly across different OPNsense releases, contributing significantly to the robustness and reliability of the configuration management process.
 
diff --git a/molecule/firewall_alias/molecule.yml b/molecule/firewall_alias/molecule.yml
@@ -16,16 +16,6 @@ driver:
     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
diff --git a/molecule/firewall_rules/molecule.yml b/molecule/firewall_rules/molecule.yml
@@ -16,16 +16,6 @@ driver:
   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
diff --git a/molecule/interfaces_assignments/molecule.yml b/molecule/interfaces_assignments/molecule.yml
@@ -16,16 +16,6 @@ driver:
     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
diff --git a/molecule/opnsense_config/molecule.yml b/molecule/opnsense_config/molecule.yml
@@ -16,16 +16,6 @@ driver:
     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
diff --git a/molecule/system_access_users/molecule.yml b/molecule/system_access_users/molecule.yml
@@ -18,16 +18,6 @@ driver:
     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
diff --git a/molecule/system_high_availability_settings/molecule.yml b/molecule/system_high_availability_settings/molecule.yml
@@ -15,16 +15,6 @@ driver:
     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
diff --git a/molecule/system_settings_general/molecule.yml b/molecule/system_settings_general/molecule.yml
@@ -16,16 +16,6 @@ driver:
     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
diff --git a/molecule/system_settings_logging/molecule.yml b/molecule/system_settings_logging/molecule.yml
@@ -16,16 +16,6 @@ driver:
     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
diff --git a/plugins/module_utils/module_index.py b/plugins/module_utils/module_index.py
@@ -9,13 +9,13 @@
 
 Structure of VERSION_MAP:
 - The top-level keys are strings representing OPNsense versions
-  (e.g., "OPNsense 22.7 (amd64/OpenSSL)").
+  (e.g., "24.7").
 - Each value under a version key is a nested dictionary that maps module names to
   their specific configurations.
 - Each module's configuration includes keys for settings (with XPath values),
   PHP requirements, and configure functions.
 
-For example, the 'system_settings_general' module for "OPNsense 22.7 (amd64/OpenSSL)" includes:
+For example, the 'system_settings_general' module for "24.7" includes:
 - Setting mappings: These are key-value pairs where the key is a friendly name for a setting
   (e.g., 'hostname'), and the value is the XPath in the OPNsense configuration file to access
   this setting (e.g., 'system/hostname').
@@ -29,159 +29,6 @@
 """
 # pylint: disable=duplicate-code; Since this is rewritten in some tests.
 VERSION_MAP = {
-    "22.7": {
-        "system_settings_general": {
-            "hostname": "system/hostname",
-            "domain": "system/domain",
-            "timezone": "system/timezone",
-            # Add other mappings here.
-            "php_requirements": [
-                "/usr/local/etc/inc/config.inc",
-                "/usr/local/etc/inc/util.inc",
-                "/usr/local/etc/inc/filter.inc",
-                "/usr/local/etc/inc/system.inc",
-                "/usr/local/etc/inc/interfaces.inc",
-            ],
-            "configure_functions": {
-                "system_timezone_configure": {
-                    "name": "system_timezone_configure",
-                    "configure_params": ["true"],
-                },
-                "system_trust_configure": {
-                    "name": "system_trust_configure",
-                    "configure_params": ["true"],
-                },
-                "system_hostname_configure": {
-                    "name": "system_hostname_configure",
-                    "configure_params": ["true"],
-                },
-                "system_hosts_generate": {
-                    "name": "system_hosts_generate",
-                    "configure_params": ["true"],
-                },
-                "system_resolvconf_generate": {
-                    "name": "system_resolvconf_generate",
-                    "configure_params": ["true"],
-                },
-                "plugins_configure_dns": {
-                    "name": "plugins_configure",
-                    "configure_params": ["'dns'", "true"],
-                },
-                "plugins_configure_dhcp": {
-                    "name": "plugins_configure",
-                    "configure_params": ["'dhcp'", "true"],
-                },
-                "filter_configure": {
-                    "name": "filter_configure",
-                    "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"],
-                },
-            },
-        },
-        "system_access_users": {
-            "users": "system/user",
-            "uid": "system/nextuid",
-            "gid": "system/nextgid",
-            "system": "system",
-            "maximumtableentries": "system/maximumtableentries",
-            "php_requirements": [
-                "/usr/local/etc/inc/system.inc",
-            ],
-            "configure_functions": {},
-        },
-        "password": {
-            "php_requirements": [
-                "/usr/local/etc/inc/auth.inc",
-            ],
-            "configure_functions": {
-                "password": {
-                    "name": "echo password_hash",
-                    "configure_params": [
-                        "'password'",
-                        "PASSWORD_BCRYPT",
-                        "[ 'cost' => 11 ]",
-                    ],
-                },
-            },
-        },
-        "firewall_rules": {
-            "rules": "filter",
-            "php_requirements": [
-                "/usr/local/etc/inc/config.inc",
-                "/usr/local/etc/inc/util.inc",
-                "/usr/local/etc/inc/filter.inc",
-                "/usr/local/etc/inc/system.inc",
-                "/usr/local/etc/inc/interfaces.inc",
-            ],
-            "configure_functions": {
-                "system_cron_configure": {
-                    "name": "system_cron_configure",
-                    "configure_params": ["true"],
-                },
-                "filter_configure": {
-                    "name": "filter_configure",
-                    "configure_params": [],
-                },
-            },
-        },
-        "interfaces_assignments": {
-            "interfaces": "interfaces",
-            # Add other mappings here.
-            "php_requirements": [
-                "/usr/local/etc/inc/config.inc",
-                "/usr/local/etc/inc/util.inc",
-                "/usr/local/etc/inc/filter.inc",
-                "/usr/local/etc/inc/system.inc",
-                "/usr/local/etc/inc/rrd.inc",
-                "/usr/local/etc/inc/interfaces.inc",
-            ],
-            "configure_functions": {
-                "filter_configure": {
-                    "name": "filter_configure",
-                    "configure_params": [],
-                },
-            },
-        },
-        "system_high_availability_settings": {
-            # Add other mappings here
-            "hasync": "hasync",
-            "synchronize_states": "hasync/pfsyncenabled",
-            "synchronize_interface": "hasync/pfsyncinterface",
-            "synchronize_peer_ip": "hasync/pfsyncpeerip",
-            "synchronize_config_to_ip": "hasync/synchronizetoip",
-            "remote_system_username": "hasync/username",
-            "remote_system_password": "hasync/password",
-            "disable_preempt": "hasync/disablepreempt",
-            "disconnect_dialup_interfaces": "hasync/disconnectppps",
-            "php_requirements": [
-                "/usr/local/etc/inc/interfaces.inc",
-                "/usr/local/etc/inc/util.inc",
-                "/usr/local/etc/inc/config.inc",
-                "/usr/local/etc/inc/plugins.inc",
-            ],
-            "configure_functions": {},
-        },
-        "firewall_alias": {
-            "alias": "OPNsense/Firewall/Alias/aliases",
-            "geoip": "OPNsense/Firewall/Alias/geoip",
-            "php_requirements": [],
-            "configure_functions": {},
-        },
-    },
     "23.1": {
         "system_settings_general": {
             "hostname": "system/hostname",

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+---`
	`2`	`+deprecated_features:`
	`3`	`+ - OPNsense 22.7 support has been deprecated`