remove scope.lookupvar

Author: saz

REFERENCE.md

@@ -14,11 +14,9 @@ You propably want rsyslog::client or rsyslog::server
 * [`rsyslog::database`](#rsyslog--database): This class manages rsyslog database connection
 * [`rsyslog::params`](#rsyslog--params): Manages default configuration values for this module.
 * [`rsyslog::server`](#rsyslog--server): This class manages rsyslog as server
-* [`rsyslog::service`](#rsyslog--service): == Class: rsyslog::service  This class enforces running of the rsyslog service.  === Parameters  === Variables  === Examples   class { 'rsysl
 
 #### Private Classes
 
-* `rsyslog::config`: Manages rsyslog configuration
 * `rsyslog::install`: Manages rsyslog packages
 
 ### Defined types
@@ -994,20 +992,6 @@ Array of hashes for configuring custom rules for the server. If set, this replac
 
 Default value: `undef`
 
-### <a name="rsyslog--service"></a>`rsyslog::service`
-
-== Class: rsyslog::service
-
-This class enforces running of the rsyslog service.
-
-=== Parameters
-
-=== Variables
-
-=== Examples
-
- class { 'rsyslog::service': }
-
 ## Defined types
 
 ### <a name="rsyslog--imfile"></a>`rsyslog::imfile`

manifests/config.pp

@@ -167,17 +167,52 @@
   Optional[Variant[String[1], Integer[0]]] $im_journal_ratelimit_burst = $rsyslog::params::im_journal_ratelimit_burst,
   Optional[Enum['on', 'off']] $im_journal_ignore_previous_messages = $rsyslog::params::im_journal_ignore_previous_messages
 ) inherits rsyslog::params {
-  contain rsyslog::install
-  contain rsyslog::config
-  contain rsyslog::service
+  require rsyslog::install
 
-  if $extra_modules != [] {
-    rsyslog::snippet { '10-modload':
-      ensure  => present,
-      content => template("${module_name}/modload.erb"),
-      require => Class['rsyslog::install'],
-    }
+  file { $rsyslog_d:
+    ensure  => directory,
+    owner   => 'root',
+    group   => $run_group,
+    purge   => $purge_rsyslog_d,
+    recurse => true,
+    force   => true,
+    notify  => Service[$service_name],
+    require => Class['rsyslog::install'],
   }
 
-  Class['rsyslog::install'] -> Class['rsyslog::config'] ~> Class['rsyslog::service']
+  file { $rsyslog_conf:
+    ensure  => file,
+    owner   => 'root',
+    group   => $run_group,
+    content => template($rsyslog_conf_template_file),
+    notify  => Service[$service_name],
+    require => File[$rsyslog_d],
+  }
+
+  file { $rsyslog_default:
+    ensure  => file,
+    owner   => 'root',
+    group   => $run_group,
+    content => template("${module_name}/${rsyslog_default_file}.erb"),
+    notify  => Service[$service_name],
+    require => File[$rsyslog_conf],
+  }
+
+  file { $spool_dir:
+    ensure  => directory,
+    owner   => $run_user,
+    group   => $run_group,
+    mode    => '0700',
+    seltype => 'syslogd_var_lib_t',
+    notify  => Service[$service_name],
+    require => File[$rsyslog_default],
+  }
+
+  service { $service_name:
+    ensure     => running,
+    enable     => true,
+    hasstatus  => $service_hasstatus,
+    hasrestart => $service_hasrestart,
+    require    => File[$spool_dir],
+  }
 }

manifests/init.pp

@@ -9,21 +9,21 @@
   if $rsyslog::rsyslog_package_name != false {
     package { $rsyslog::rsyslog_package_name:
       ensure => $rsyslog::package_status,
-      notify => Class['rsyslog::service'],
+      notify => Service[$rsyslog::service_name],
     }
   }
 
   if $rsyslog::relp_package_name != false {
     package { $rsyslog::relp_package_name:
       ensure => $rsyslog::package_status,
-      notify => Class['rsyslog::service'],
+      notify => Service[$rsyslog::service_name],
     }
   }
 
   if $rsyslog::gnutls_package_name != false {
     package { $rsyslog::gnutls_package_name:
       ensure => $rsyslog::package_status,
-      notify => Class['rsyslog::service'],
+      notify => Service[$rsyslog::service_name],
     }
   }
 }

manifests/install.pp

@@ -20,7 +20,7 @@
   Enum['present', 'file', 'absent'] $ensure = 'present',
   Optional[Stdlib::Filemode] $file_mode = undef,
 ) {
-  include rsyslog
+  require rsyslog
 
   if $file_mode {
     $file_mode_real = $file_mode
@@ -41,7 +41,7 @@
     group   => $rsyslog::run_group,
     mode    => $file_mode_real,
     content => $content_real,
-    require => Class['rsyslog::config'],
-    notify  => Class['rsyslog::service'],
+    notify  => Service[$rsyslog::service_name],
+    require => File[$rsyslog::rsyslog_d],
   }
 }

manifests/service.pp

@@ -26,6 +26,9 @@
         it 'compiles' do
           is_expected.to contain_file(server_conf).with_content(%r{\(\[A-Za-z-\]\*\)--end%/auth.log})
           is_expected.to contain_file(server_conf).with_content(%r{\(\[A-Za-z-\]\*\)--end%/messages})
+          is_expected.to contain_file(server_conf).with_content(%r{\$UDPServerRun 514})
+          is_expected.to contain_file(server_conf).with_content(%r{\$InputTCPServerRun 514})
+          is_expected.to contain_file(server_conf).with_content(%r{\$InputRELPServerRun 20514})
         end
       end
 
@@ -57,6 +60,33 @@
           is_expected.to contain_file(server_conf).with_content(%r{if \$msg contains 'error0' then /var/log/err.log})
         end
       end
+
+      context 'enable_tcp = false' do
+        let(:title) { 'tcp-listener-disabled' }
+        let(:params) { { 'enable_tcp' => false } }
+
+        it 'compiles' do
+          is_expected.to contain_file(server_conf).without_content(%r{\$InputTCPServerRun})
+        end
+      end
+
+      context 'enable_udp = false' do
+        let(:title) { 'udp-listener-disabled' }
+        let(:params) { { 'enable_udp' => false } }
+
+        it 'compiles' do
+          is_expected.to contain_file(server_conf).without_content(%r{\$UDPServerRun})
+        end
+      end
+
+      context 'enable_relp = false' do
+        let(:title) { 'relp-listener-disabled' }
+        let(:params) { { 'enable_relp' => false } }
+
+        it 'compiles' do
+          is_expected.to contain_file(server_conf).without_content(%r{\$InputRELPServerRun})
+        end
+      end
     end
   end
 end

manifests/snippet.pp

@@ -54,11 +54,10 @@
 
         it 'compiles' do
           is_expected.to contain_class('rsyslog::install')
-          is_expected.to contain_class('rsyslog::config').that_requires('Class[rsyslog::install]')
-          is_expected.to contain_class('rsyslog::service').that_subscribes_to('Class[rsyslog::config]')
           is_expected.to contain_package(rsyslog_package)
           is_expected.to contain_package(relp_package) if relp_package
-          is_expected.to contain_file(rsyslog_d).with_ensure('directory')
+          is_expected.to contain_file(rsyslog_d).with_ensure('directory').that_requires('Class[rsyslog::install]')
+          is_expected.to contain_file(rsyslog_conf).with_ensure('file').that_requires("File[#{rsyslog_d}]")
           is_expected.to contain_service(service_name)
           if im_journal_ratelimit_burst
             is_expected.to contain_file(rsyslog_conf).with_content(%r{\$imjournalRatelimitBurst #{im_journal_ratelimit_burst}})
@@ -70,6 +69,15 @@
         end
       end
 
+      context 'extra_modules set' do
+        let(:title) { 'rsyslog-extra-modules-set' }
+
+        let(:params) { { extra_modules: ['modA'] } }
+        it 'compiles' do
+          is_expected.to contain_file(rsyslog_conf).with_content(%r{\$ModLoad modA})
+        end
+      end
+
       context 'local host name' do
         let(:title) { 'rsyslog-local-hostname' }
 

spec/classes/rsyslog_server_spec.rb

@@ -1,39 +1,39 @@
 # An "In-Memory Queue" is created for remote logging.
-$WorkDirectory <%= scope.lookupvar('rsyslog::spool_dir') -%>    # where to place spool files
+$WorkDirectory <%= scope['rsyslog::spool_dir'] -%>    # where to place spool files
 $ActionQueueFileName queue      # unique name prefix for spool files
-$ActionQueueMaxDiskSpace <%= scope.lookupvar('rsyslog::client::spool_size') -%>     # spool space limit (use as much as possible)
+$ActionQueueMaxDiskSpace <%= @spool_size -%>     # spool space limit (use as much as possible)
 $ActionQueueSaveOnShutdown on   # save messages to disk on shutdown
-<% if scope.lookupvar('rsyslog::client::spool_timeoutenqueue') -%>
-$ActionQueueTimeoutEnqueue <%= scope.lookupvar('rsyslog::client::spool_timeoutenqueue') -%>   # time to wait before discarding on full spool
+<% if @spool_timeoutenqueue -%>
+$ActionQueueTimeoutEnqueue <%= @spool_timeoutenqueue -%>   # time to wait before discarding on full spool
 <% end -%>
 $ActionQueueType LinkedList     # run asynchronously
 $ActionResumeRetryCount -1      # infinety retries if host is down
-<% if scope.lookupvar('rsyslog::client::log_templates') and ! scope.lookupvar('rsyslog::client::log_templates').empty?-%>
+<% if @log_templates and ! @log_templates.empty?-%>
 
 # Define custom logging templates
-<% scope.lookupvar('rsyslog::client::log_templates').flatten.compact.each do |log_template| -%>
+<% @log_templates.flatten.compact.each do |log_template| -%>
 $template <%= log_template['name'] %>,"<%= log_template['template'] %>"
 <% end -%>
 <% end -%>
-<% if scope.lookupvar('rsyslog::client::log_filters') -%>
+<% if @log_filters -%>
 
 # Define custom if/then log conditions
-<% scope.lookupvar('rsyslog::client::log_filters').each do |log_filter| -%>
+<% @log_filters.each do |log_filter| -%>
 if <%= log_filter['expression'] %> then <%= log_filter['action'] %>
 <% end -%>
 <% end -%>
-<% if scope.lookupvar('rsyslog::client::actionfiletemplate_cust') and scope.lookupvar('rsyslog::client::actionfiletemplate') -%>
+<% if @actionfiletemplate_cust and @actionfiletemplate -%>
 
 # Setting custom action file formatting
-$template <%= scope.lookupvar('rsyslog::client::actionfiletemplate') %>, <%= scope.lookupvar('rsyslog::client::actionfiletemplate_cust') %>
+$template <%= @actionfiletemplate %>, <%= @actionfiletemplate_cust %>
 <% end -%>
-<% if scope.lookupvar('rsyslog::client::actionfiletemplate') -%>
+<% if @actionfiletemplate -%>
 
 # Using specified format for default logging format:
-$ActionFileDefaultTemplate <%= scope.lookupvar('rsyslog::client::actionfiletemplate') %>
+$ActionFileDefaultTemplate <%= @actionfiletemplate %>
 <% else -%>
 
-<% if scope.lookupvar('rsyslog::client::high_precision_timestamps') == false -%>
+<% if @high_precision_timestamps == false -%>
 # Use default format
 $ActionFileDefaultTemplate RSYSLOG_TraditionalFileFormat
 <% else -%>
@@ -42,32 +42,32 @@ $ActionFileDefaultTemplate RSYSLOG_FileFormat
 <% end -%>
 <% end -%>
 
-<% if scope.lookupvar('rsyslog::client::listen_localhost') -%>
+<% if @listen_localhost -%>
 # Provides UDP syslog reception
 $ModLoad imudp
 $UDPServerAddress 127.0.0.1
 $UDPServerRun 514
 <% end %>
 
-<% if scope.lookupvar('rsyslog::client::ssl') -%>
+<% if @ssl -%>
 # Setup SSL connection.
 # CA/Cert
-$DefaultNetStreamDriverCAFile <%= scope.lookupvar('rsyslog::client::ssl_ca') %>
-<% if scope.lookupvar('rsyslog::client::ssl_cert') -%>
-$DefaultNetstreamDriverCertFile <%= scope.lookupvar('rsyslog::client::ssl_cert') %>
-$DefaultNetstreamDriverKeyFile <%= scope.lookupvar('rsyslog::client::ssl_key') %>
+$DefaultNetStreamDriverCAFile <%= @ssl_ca %>
+<% if @ssl_cert -%>
+$DefaultNetstreamDriverCertFile <%= @ssl_cert %>
+$DefaultNetstreamDriverKeyFile <%= @ssl_key %>
 <% end -%>
 
 # Connection settings.
 $DefaultNetstreamDriver gtls
 $ActionSendStreamDriverMode 1
-$ActionSendStreamDriverAuthMode <%= scope.lookupvar('rsyslog::client::ssl_auth_mode') %>
+$ActionSendStreamDriverAuthMode <%= @ssl_auth_mode %>
 <% if @ssl_permitted_peer -%>
-$ActionSendStreamDriverPermittedPeer <%= scope.lookupvar('rsyslog::client::ssl_permitted_peer') %>
+$ActionSendStreamDriverPermittedPeer <%= @ssl_permitted_peer %>
 <% end -%>
 <% end -%>
 
-<% if scope.lookupvar('rsyslog::client::remote_type') == 'relp' -%>
+<% if @remote_type == 'relp' -%>
 # Load RELP module.
 $ModLoad omrelp
 <% end -%>