Fixes #38558 - support for configuring WOL module

Author: ares

manifests/config.pp

@@ -65,6 +65,8 @@
 
   contain foreman_proxy::module::bmc
 
+  contain foreman_proxy::module::wol
+
   contain foreman_proxy::module::dhcp
   foreman_proxy::provider { ['dhcp_isc', 'dhcp_libvirt']:
   }

manifests/init.pp

@@ -219,6 +219,10 @@
 #
 # $bmc_ssh_poweron::            BMC SSH poweron command.
 #
+# $wol::                        Enable WOL feature
+#
+# $wol_listen_on::              WOL proxy to listen on https, http, or both
+#
 # $keyfile::                    DNS server keyfile path
 #
 # $realm::                      Enable realm management feature
@@ -404,6 +408,8 @@
   # lint:ignore:quoted_booleans
   String $bmc_ssh_poweron = 'false',
   # lint:endignore
+  Boolean $wol = false,
+  Foreman_proxy::ListenOn $wol_listen_on = 'https',
   Boolean $realm = false,
   Foreman_proxy::ListenOn $realm_listen_on = 'https',
   String $realm_provider = 'freeipa',

manifests/module/wol.pp

@@ -0,0 +1,17 @@
+# @summary The built in WOL module
+#
+# @param enabled
+#  Whether the module is enabled or disabled.
+#
+# @param listen_on
+#   Where to listen on.
+class foreman_proxy::module::wol (
+  Boolean $enabled = $foreman_proxy::wol,
+  Foreman_proxy::ListenOn $listen_on = $foreman_proxy::wol_listen_on,
+) {
+  foreman_proxy::module { 'wol':
+    enabled   => $enabled,
+    feature   => 'WOL',
+    listen_on => $listen_on,
+  }
+}

spec/classes/foreman_proxy__spec.rb

@@ -96,7 +96,7 @@
             'logs', 'httpboot', 'puppet', 'puppet_proxy_puppet_api',
             'puppetca', 'puppetca_http_api', 'puppetca_puppet_cert',
             'puppetca_hostname_whitelisting', 'puppetca_token_whitelisting',
-            'realm', 'templates', 'tftp'
+            'realm', 'templates', 'tftp', 'wol'
           ].each do |cfile|
             should contain_file("#{etc_dir}/foreman-proxy/settings.d/#{cfile}.yml")
               .with_owner('root')
@@ -151,6 +151,13 @@
           ])
         end
 
+        it 'should generate correct wol.yml' do
+          verify_exact_contents(catalogue, "#{etc_dir}/foreman-proxy/settings.d/wol.yml", [
+            '---',
+            ':enabled: false',
+          ])
+        end
+
         it 'should generate correct dhcp.yml' do
           verify_exact_contents(catalogue, "#{etc_dir}/foreman-proxy/settings.d/dhcp.yml", [
             '---',
@@ -536,6 +543,17 @@
         end
       end
 
+      context 'with wol' do
+        let(:params) { super().merge(wol: true) }
+
+        it 'should enable wol' do
+          verify_exact_contents(catalogue, "#{etc_dir}/foreman-proxy/settings.d/wol.yml", [
+            '---',
+            ':enabled: https',
+          ])
+        end
+      end
+
       context 'only http enabled' do
         let(:params) { super().merge(ssl: false, http: true) }
 

templates/wol.yml.erb

@@ -0,0 +1,7 @@
+---
+# Can be true, false, or http/https to enable just one of the protocols
+:enabled: <%= @module_enabled %>
+
+# Wake-on-LAN configuration
+# The module sends standard WoL magic packets via UDP broadcast on port 9
+# No additional configuration is required as it uses the standard protocol