(FM-7798) Test audit making making testing more efficient (puppetlabs#81)

Author: lionce

README.md

@@ -18,9 +18,9 @@ This module provides services tasks, There are two kinds of tasks. The default t
 ## Requirements
 This module is compatible with Puppet Enterprise and Puppet Bolt.
 
-* To run tasks with Puppet Enterprise, PE 2017.3 or later must be installed on the machine from which you are running task commands. Machines receiving task requests must be Puppet agents.
+* To run tasks with Puppet Enterprise, PE 2018.1 or later must be installed on the machine from which you are running task commands. Machines receiving task requests must be Puppet agents.
 
-* To run tasks with Puppet Bolt, Bolt 0.5 or later must be installed on the machine from which you are running task commands. Machines receiving task requests must have SSH or WinRM services enabled.
+* To run tasks with Puppet Bolt, Bolt 1.0 or later must be installed on the machine from which you are running task commands. Machines receiving task requests must have SSH or WinRM services enabled.
 
 ## Usage
 
@@ -68,6 +68,8 @@ For a complete list of services that are supported see the Puppet [services](htt
 
 ## Limitations
 
+To run acceptance tests against Windows machines, ensure that the `BEAKER_password` environment variable has been set to the password of the Administrator user of the target machine.
+
 For an extensive list of supported operating systems, see [metadata.json](https://github.com/puppetlabs/puppetlabs-service/blob/master/metadata.json)
 
 ## Getting Help

metadata.json

@@ -65,7 +65,7 @@
     }
   ],
   "description": "Tasks that manipulate a service",
-  "pdk-version": "1.8.0",
-  "template-url": "https://github.com/puppetlabs/pdk-templates",
+  "pdk-version": "1.9.0",
+  "template-url": "https://github.com/puppetlabs/pdk-templates.git",
   "template-ref": "heads/master-0-gfde5699"
 }

spec/acceptance/init_spec.rb

@@ -5,57 +5,39 @@
   include Beaker::TaskHelper::Inventory
   include BoltSpec::Run
 
-  def module_path
-    RSpec.configuration.module_path
-  end
-
-  def config
-    { 'modulepath' => module_path }
-  end
-
-  def inventory
-    hosts_to_inventory.merge('features' => ['puppet-agent'])
-  end
-
-  def run(params)
-    run_task('service', 'default', params, config: config, inventory: inventory)
-  end
-
-  osfamily_fact = fact('osfamily')
-
   package_to_use = ''
   before(:all) do
-    if osfamily_fact != 'windows'
-      if osfamily_fact == 'RedHat' && fact('operatingsystemrelease') < '6'
-        run('action' => 'stop', 'name' => 'syslog')
+    if os[:family] != 'windows'
+      if os[:family] == 'redhat' && os[:release].to_i < 6
+        task_run('service', 'action' => 'stop', 'name' => 'syslog')
       end
       package_to_use = 'rsyslog'
       apply_manifest_on(default, "package { \"#{package_to_use}\": ensure => present, }")
     else
       package_to_use = 'W32Time'
-      run('action' => 'start', 'name' => package_to_use)
+      task_run('service', 'action' => 'start', 'name' => package_to_use)
     end
   end
 
   describe 'enable action' do
     it 'enable/status a service' do
-      result = run('action' => 'enable', 'name' => package_to_use)
+      result = task_run('service', 'action' => 'enable', 'name' => package_to_use)
       expect(result[0]['status']).to eq('success')
       expect(result[0]['result']['status']).to match(%r{in_sync|enabled})
 
-      result = run('action' => 'status', 'name' => package_to_use)
+      result = task_run('service', 'action' => 'status', 'name' => package_to_use)
       expect(result[0]['status']).to eq('success')
       expect(result[0]['result']['enabled']).to eq('true')
     end
   end
 
   describe 'restart action' do
     it 'restart/status a service' do
-      result = run('action' => 'restart', 'name' => package_to_use)
+      result = task_run('service', 'action' => 'restart', 'name' => package_to_use)
       expect(result[0]['status']).to eq('success')
       expect(result[0]['result']['status']).to eq('restarted')
 
-      result = run('action' => 'status', 'name' => package_to_use)
+      result = task_run('service', 'action' => 'status', 'name' => package_to_use)
       expect(result[0]['status']).to eq('success')
       expect(result[0]['result']['status']).to eq('running')
       expect(result[0]['result']['enabled']).to eq('true')
@@ -64,13 +46,13 @@ def run(params)
 
   describe 'stop action' do
     it 'stop/status a service' do
-      result = run('action' => 'stop', 'name' => package_to_use)
+      result = task_run('service', 'action' => 'stop', 'name' => package_to_use)
       expect(result[0]['status']).to eq('success')
       expect(result[0]['result']['status']).to match(%r{in_sync|stopped})
 
       # Debian can give incorrect status
-      if osfamily_fact != 'Debian'
-        result = run('action' => 'status', 'name' => package_to_use)
+      unless ['debian', 'ubuntu'].include?(os[:family])
+        result = task_run('service', 'action' => 'status', 'name' => package_to_use)
         expect(result[0]['status']).to eq('success')
         expect(result[0]['result']['status']).to eq('stopped')
         expect(result[0]['result']['enabled']).to eq('true')
@@ -80,13 +62,13 @@ def run(params)
 
   describe 'start action' do
     it 'start/status a service' do
-      result = run('action' => 'start', 'name' => package_to_use)
+      result = task_run('service', 'action' => 'start', 'name' => package_to_use)
       expect(result[0]['status']).to eq('success')
       expect(result[0]['result']['status']).to match(%r{in_sync|started})
 
       # Debian can give incorrect status
-      if osfamily_fact != 'Debian'
-        result = run('action' => 'status', 'name' => package_to_use)
+      if os[:family] != 'debian'
+        result = task_run('service', 'action' => 'status', 'name' => package_to_use)
         expect(result[0]['status']).to eq('success')
         expect(result[0]['result']['status']).to eq('running')
         expect(result[0]['result']['enabled']).to eq('true')
@@ -96,11 +78,11 @@ def run(params)
 
   describe 'disable action' do
     it 'disable/status a service' do
-      result = run('action' => 'disable', 'name' => package_to_use)
+      result = task_run('service', 'action' => 'disable', 'name' => package_to_use)
       expect(result[0]['status']).to eq('success')
       expect(result[0]['result']['status']).to eq('disabled')
 
-      result = run('action' => 'status', 'name' => package_to_use)
+      result = task_run('service', 'action' => 'status', 'name' => package_to_use)
       expect(result[0]['status']).to eq('success')
       expect(result[0]['result']['enabled']).to eq('false')
     end

spec/acceptance/linux_spec.rb

@@ -1,53 +1,37 @@
 # run a test task
 require 'spec_helper_acceptance'
 
-describe 'linux service task', unless: fact('osfamily') == 'windows' do
+describe 'linux service task', unless: os[:family] == 'windows' do
   include Beaker::TaskHelper::Inventory
   include BoltSpec::Run
 
-  def module_path
-    RSpec.configuration.module_path
-  end
-
-  def config
-    { 'modulepath' => module_path }
-  end
-
-  def inventory
-    hosts_to_inventory
-  end
-
-  def run(params)
-    run_task('service::linux', 'default', params, config: config, inventory: inventory)
-  end
-
   package_to_use = 'rsyslog'
   before(:all) do
-    if fact('osfamily') == 'RedHat' && fact('operatingsystemrelease') < '6'
-      run('action' => 'stop', 'name' => 'syslog')
+    if os[:family] == 'redhat' && os[:release].to_i < 6
+      task_run('service::linux', 'action' => 'stop', 'name' => 'syslog')
     end
     apply_manifest_on(default, "package { \"#{package_to_use}\": ensure => present, }")
   end
 
   describe 'stop action' do
     it "stop #{package_to_use}" do
-      result = run('action' => 'stop', 'name' => package_to_use)
+      result = task_run('service::linux', 'action' => 'stop', 'name' => package_to_use)
       expect(result[0]['status']).to eq('success')
       expect(result[0]['result']['status']).to match(%r{stop})
     end
   end
 
   describe 'start action' do
     it "start #{package_to_use}" do
-      result = run('action' => 'start', 'name' => package_to_use)
+      result = task_run('service::linux', 'action' => 'start', 'name' => package_to_use)
       expect(result[0]['status']).to eq('success')
       expect(result[0]['result']['status']).to match(%r{start})
     end
   end
 
   describe 'restart action' do
     it "restart #{package_to_use}" do
-      result = run('action' => 'restart', 'name' => package_to_use)
+      result = task_run('service::linux', 'action' => 'restart', 'name' => package_to_use)
       expect(result[0]['status']).to eq('success')
       expect(result[0]['result']['status']).to match(%r{restart})
     end

spec/spec_helper_acceptance.rb

@@ -13,6 +13,14 @@
 install_module_on(hosts)
 install_module_dependencies_on(hosts)
 
+# Bolt helper task
+def task_run(task_name, params)
+  module_path = RSpec.configuration.module_path
+  config = { 'modulepath' => module_path }
+  inventory = hosts_to_inventory.merge('features' => ['puppet-agent'])
+  run_task(task_name, 'default', params, config: config, inventory: inventory)
+end
+
 RSpec.configure do |c|
   # Readable test descriptions
   c.formatter = :documentation