Fix module errors discovered while testing.

- The $splunk_user variable was referenced but undeclared.
  for this repo.
- Update the build and version to correctly reference the most recent
  values.
- The $staged_package variable was referenced before declaration.
- Creates separate spec files for testing the splunk and
  splunk::forwarder classes.
- Removes the path parameter from the enable_splunk and
  enable_splunkforwarder execs because it causes issues on platforms
  that use the systemd service provider. The resulting init script that
  the exec generates will not get loaded by the systemd-sysv-generate
  module.
- Fixes an issue where the splunkweb Service would change from 'stopped'
  to 'running' on every Puppet run. The pattern for discovering the
  running service had an incorrect regex.

Author: Ziaunys

manifests/forwarder.pp

@@ -128,7 +128,6 @@
   # dependency chains.
   include splunk::virtual
 
-  realize Package[$package_name]
   realize Service[$virtual_service]
 
   Package                <| title  == $package_name     |> ->

manifests/init.pp

@@ -43,14 +43,15 @@
 # Requires: nothing
 #
 class splunk (
-  $package_source = $splunk::params::server_pkg_src,
-  $package_name   = $splunk::params::server_pkg_name,
-  $package_ensure = $splunk::params::server_pkg_ensure,
-  $logging_port   = $splunk::params::logging_port,
-  $splunkd_port   = $splunk::params::splunkd_port,
-  $pkg_provider   = $splunk::params::pkg_provider,
-  $splunkd_listen = '127.0.0.1',
-  $web_port       = '8000',
+  $package_source       = $splunk::params::server_pkg_src,
+  $package_name         = $splunk::params::server_pkg_name,
+  $package_ensure       = $splunk::params::server_pkg_ensure,
+  $logging_port         = $splunk::params::logging_port,
+  $splunkd_port         = $splunk::params::splunkd_port,
+  $splunk_user          = $splunk::params::splunk_user,
+  $pkg_provider         = $splunk::params::pkg_provider,
+  $splunkd_listen       = '127.0.0.1',
+  $web_port             = '8000',
   $purge_authentication = false,
   $purge_authorize      = false,
   $purge_distsearch     = false,
@@ -71,11 +72,12 @@
 
   if $pkg_provider != undef and $pkg_provider != 'yum' and  $pkg_provider != 'apt' {
     include staging
+
+    $staged_package  = staging_parse($package_source)
     $pkg_path_parts  = [$staging::path, $staging_subdir, $staged_package]
     $pkg_source      = join($pkg_path_parts, $path_delimiter)
 
     #no need for staging the source if we have yum or apt
-    $staged_package  = staging_parse($package_source)
     staging::file { $staged_package:
       source => $package_source,
       subdir => $staging_subdir,
@@ -182,7 +184,6 @@
 
   # This realize() call is because the collectors don't seem to work well with
   # arrays. They'll set the dependencies but not realize all Service resources
-  realize(Package[$package_name])
   realize(Service[$virtual_service])
 
   Package                <| title == $package_name    |> ->

manifests/params.pp

@@ -67,8 +67,8 @@
 # Requires: nothing
 #
 class splunk::params (
-  $version              = '5.0.5',
-  $build                = '179365',
+  $version              = '6.3.3',
+  $build                = 'f44afce176d0',
   $src_root             = 'puppet:///modules/splunk',
   $splunkd_port         = '8089',
   $logging_port         = '9997',
@@ -127,7 +127,7 @@
       $forwarder_service    = [ 'SplunkForwarder' ] # UNKNOWN
       $forwarder_confdir    = "${forwarder_dir}/etc/system/local"
       $server_src_subdir    = 'splunk/windows'
-      $server_service       = [ 'Splunkd', 'Splunkweb' ] # UNKNOWN
+      $server_service       = [ 'Splunkd', 'SplunkWeb' ] # UNKNOWN
       $server_confdir       = "${server_dir}/etc/system/local"
       $forwarder_install_options = [
         'AGREETOLICENSE=Yes',
@@ -238,6 +238,7 @@
   $create_password   = true
 
   $forwarder_pkg_ensure = 'installed'
+  $splunk_user = 'root'
 
   # A meta resource so providers know where splunk is installed:
   splunk_config { 'splunk':

manifests/platform/posix.pp

@@ -16,40 +16,43 @@
 #
 class splunk::platform::posix (
   $splunkd_port = $splunk::splunkd_port,
+  $splunk_user = $splunk::params::splunk_user,
 ) inherits splunk::virtual {
 
+  include ::splunk::params
   # Many of the resources declared here are virtual. They will be realized by
   # the appropriate including class if required.
 
   # Commands to run to enable the SplunkUniversalForwarder
   @exec { 'license_splunkforwarder':
-    path    => '/opt/splunkforwarder/bin',
+    path    => "${splunk::params::forwarder_dir}/bin",
     command => 'splunk start --accept-license --answer-yes',
     user    => $splunk_user,
     creates => '/opt/splunkforwarder/etc/auth/server.pem',
     timeout => 0,
     tag     => 'splunk_forwarder',
   }
   @exec { 'enable_splunkforwarder':
-    path    => '/opt/splunkforwarder/bin',
-    command => "splunk enable boot-start -user $splunk_user",
+
+    # The path parameter can't be set because the boot-start silently fails on systemd service providers
+    command => "${splunk::params::forwarder_dir}/bin/splunk enable boot-start -user ${splunk_user}",
     creates => '/etc/init.d/splunk',
     require => Exec['license_splunkforwarder'],
     tag     => 'splunk_forwarder',
   }
 
   # Commands to run to enable full Splunk
   @exec { 'license_splunk':
-    path    => '/opt/splunk/bin',
+    path    => "${splunk::params::server_dir}/bin",
     command => 'splunk start --accept-license --answer-yes',
     user    => $splunk_user,
     creates => '/opt/splunk/etc/auth/splunk.secret',
     timeout => 0,
     tag     => 'splunk_server',
   }
   @exec { 'enable_splunk':
-    path    => '/opt/splunk/bin',
-    command => "splunk enable boot-start -user $splunk_user",
+    # The path parameter can't be set because the boot-start silently fails on systemd service providers
+    command => "${splunk::params::server_dir}/bin/splunk enable boot-start -user ${splunk_user}",
     creates => '/etc/init.d/splunk',
     require => Exec['license_splunk'],
     tag     => 'splunk_server',
@@ -71,7 +74,7 @@
     restart  => '/opt/splunk/bin/splunk restart splunkweb',
     start    => '/opt/splunk/bin/splunk start splunkweb',
     stop     => '/opt/splunk/bin/splunk stop splunkweb',
-    pattern  => 'python -O /opt/splunk/lib/python.*/splunk/.*/root.py (restart|start)',
+    pattern  => 'python -O /opt/splunk/lib/python.*/splunk/.*/root.py.*',
     require  => Service['splunk'],
   }
 

spec/acceptance/class_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper_acceptance'
+
+describe 'splunk::forwarder class' do
+  context 'default parameters' do
+    # Using puppet_apply as a helper
+    it 'should work idempotently with no errors' do
+      pp = <<-EOS
+      class { '::splunk::forwarder': }
+      EOS
+
+      # Run it twice and test for idempotency
+      apply_manifest(pp, :catch_failures => true)
+      apply_manifest(pp, :catch_changes  => true)
+    end
+
+    describe package('splunkforwarder') do
+      it { is_expected.to be_installed }
+    end
+
+    describe service('splunk') do
+      it { is_expected.to be_enabled }
+      it { is_expected.to be_running }
+    end
+  end
+end

spec/acceptance/splunk_forwarder_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper_acceptance'
+
+describe 'splunk class' do
+  context 'default parameters' do
+    # Using puppet_apply as a helper
+    it 'should work idempotently with no errors' do
+      pp = <<-EOS
+      class { '::splunk': }
+      EOS
+
+      # Run it twice and test for idempotency
+      apply_manifest(pp, :catch_failures => true)
+      apply_manifest(pp, :catch_changes  => true)
+    end
+
+    describe package('splunk') do
+      it { is_expected.to be_installed }
+    end
+
+    describe service('splunk') do
+      it { is_expected.to be_enabled }
+      it { is_expected.to be_running }
+    end
+  end
+end
+