(PE-40350) add module version to logging

Author: davidmalloncares

functions/log_plan_parameters.pp

@@ -1,4 +1,5 @@
 function peadm::log_plan_parameters(Hash $params) {
+  out::message("PEADM Module version: ${peadm::module_version()}")
   $params.each |$key, $value| {
     out::message("Parameter '${key}': [${value}]")
   }

lib/puppet/functions/peadm/module_version.rb

@@ -0,0 +1,9 @@
+Puppet::Functions.create_function(:'peadm::module_version', Puppet::Functions::InternalFunction) do
+    dispatch :module_version do
+        scope_param
+    end
+
+    def module_version(scope)
+        scope.compiler.environment.module('peadm').version
+    end
+end

spec/plans/install_spec.rb

@@ -5,10 +5,10 @@
 
   describe 'basic functionality' do
     it 'runs successfully with the minimum required parameters' do
+      allow_out_message
       expect_plan('peadm::subplans::install')
       expect_plan('peadm::subplans::configure')
       expect(run_plan('peadm::install', 'primary_host' => 'primary', 'console_password' => 'puppetLabs123!', 'version' => '2021.7.9')).to be_ok
-      allow_any_instance_of(Out).to receive(:message).and_return(true)
     end
   end
 end

spec/plans/subplans/install_spec.rb

@@ -26,7 +26,7 @@
 
     #########
     ## <🤮>
-    rubocop:disable AnyInstance
+    # rubocop:disable AnyInstance
     allow(Tempfile).to receive(:new).and_call_original
     allow(Pathname).to receive(:new).and_call_original
     allow(Puppet::FileSystem).to receive(:exist?).and_call_original