Replace validate_apache_loglevel() with data type

The function was introduced before Puppet 4 was released. It was originally created to reduce duplicated use of stdlib's `validate_re`. See #1097
puppetlabs · May 2, 2020 · ce072b1 · ce072b1
1 parent e8465d2
commit ce072b1
Show file tree

Hide file tree

Showing 8 changed files with 27 additions and 117 deletions.
diff --git a/lib/puppet/functions/apache/validate_apache_log_level.rb b/lib/puppet/functions/apache/validate_apache_log_level.rb
diff --git a/lib/puppet/parser/functions/validate_apache_log_level.rb b/lib/puppet/parser/functions/validate_apache_log_level.rb
diff --git a/manifests/init.pp b/manifests/init.pp
@@ -520,7 +520,7 @@
   $limitreqfields                                                       = '100',
   $logroot                                                              = $::apache::params::logroot,
   $logroot_mode                                                         = $::apache::params::logroot_mode,
-  $log_level                                                            = $::apache::params::log_level,
+  Apache::LogLevel $log_level                                           = $::apache::params::log_level,
   $log_formats                                                          = {},
   $ssl_file                                                             = undef,
   $ports_file                                                           = $::apache::params::ports_file,
@@ -602,8 +602,6 @@
     }
   }
 
-  apache::validate_apache_log_level($log_level)
-
   class { '::apache::service':
     service_name    => $service_name,
     service_enable  => $service_enable,

diff --git a/manifests/vhost.pp b/manifests/vhost.pp
@@ -1735,7 +1735,7 @@
   $logroot_mode                                                                     = undef,
   $logroot_owner                                                                    = undef,
   $logroot_group                                                                    = undef,
-  $log_level                                                                        = undef,
+  Optional[Apache::LogLevel] $log_level                                             = undef,
   Boolean $access_log                                                               = true,
   $access_log_file                                                                  = false,
   $access_log_pipe                                                                  = false,
@@ -1940,10 +1940,6 @@
 
   # Input validation begins
 
-  if $log_level {
-    apache::validate_apache_log_level($log_level)
-  }
-
   if $access_log_file and $access_log_pipe {
     fail("Apache::Vhost[${name}]: 'access_log_file' and 'access_log_pipe' cannot be defined at the same time")
   }

diff --git a/spec/functions/validate_apache_log_level_spec.rb b/spec/functions/validate_apache_log_level_spec.rb
diff --git a/spec/type_aliases/loglevel_spec.rb b/spec/type_aliases/loglevel_spec.rb
@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe 'Apache::LogLevel' do
+  [
+    'info',
+    'warn ssl:info',
+    'warn mod_ssl.c:info',
+    'warn mod_ssl.c:info',
+    'warn ssl_module:info',
+    'trace4',
+  ].each do |allowed_value|
+    it { is_expected.to allow_value(allowed_value) }
+  end
+
+  [
+    'garbage',
+    '',
+    [],
+    ['info'],
+  ].each do |invalid_value|
+    it { is_expected.not_to allow_value(invalid_value) }
+  end
+end
diff --git a/spec/unit/puppet/parser/functions/validate_apache_log_level.rb b/spec/unit/puppet/parser/functions/validate_apache_log_level.rb
diff --git a/types/loglevel.pp b/types/loglevel.pp
@@ -0,0 +1,2 @@
+# @summary As per http://httpd.apache.org/docs/current/mod/core.html#loglevel
+type Apache::LogLevel = Pattern[/(emerg|alert|crit|error|warn|notice|info|debug|trace[1-8])/]
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		# @summary As per http://httpd.apache.org/docs/current/mod/core.html#loglevel
		type Apache::LogLevel = Pattern[/(emerg\|alert\|crit\|error\|warn\|notice\|info\|debug\|trace[1-8])/]