Merge pull request puppetlabs#83 from donoghuc/BOLT-1103

(BOLT-1103) Unify output of task implementations

Author: donoghuc

.sync.yml

@@ -42,7 +42,7 @@ Gemfile:
           - mingw
           - x64_mingw
       - gem: bolt
-        version: '~> 1.3'
+        version: '~> 1.15'
         condition: ENV['GEM_BOLT']
 
 Rakefile:

Gemfile

@@ -32,7 +32,7 @@ end
 group :system_tests do
   gem "puppet-module-posix-system-r#{minor_version}", require: false, platforms: [:ruby]
   gem "puppet-module-win-system-r#{minor_version}",   require: false, platforms: [:mswin, :mingw, :x64_mingw]
-  gem "bolt", '~> 1.3',                               require: false if ENV['GEM_BOLT']
+  gem "bolt", "~> 1.15",                              require: false if ENV['GEM_BOLT']
 end
 
 puppet_version = ENV['PUPPET_GEM_VERSION']

spec/acceptance/init_spec.rb

@@ -5,86 +5,95 @@
   include Beaker::TaskHelper::Inventory
   include BoltSpec::Run
 
+  def bolt_config
+    { 'modulepath' => RSpec.configuration.module_path }
+  end
+
+  let(:bolt_inventory) { hosts_to_inventory.merge('features' => ['puppet-agent']) }
+
   package_to_use = ''
   before(:all) do
+    options = { inventory: hosts_to_inventory.merge('features' => ['puppet-agent']) }
     if os[:family] != 'windows'
       if os[:family] == 'redhat' && os[:release].to_i < 6
-        task_run('service', 'action' => 'stop', 'name' => 'syslog')
+        params = { 'action' => 'stop', 'name' => 'syslog' }
+        run_task('service', 'default', params, options)
       end
       package_to_use = 'rsyslog'
       apply_manifest_on(default, "package { \"#{package_to_use}\": ensure => present, }")
     else
       package_to_use = 'W32Time'
-      task_run('service', 'action' => 'start', 'name' => package_to_use)
+      params = { 'action' => 'start', 'name' => package_to_use }
+      run_task('service', 'default', params, options)
     end
   end
 
   describe 'enable action' do
     it 'enable/status a service' do
-      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_task('service', 'default', 'action' => 'enable', 'name' => package_to_use)
+      expect(result[0]).to include('status' => 'success')
+      expect(result[0]['result']).to include('status' => %r{in_sync|enabled})
 
-      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')
+      result = run_task('service', 'default', 'action' => 'status', 'name' => package_to_use)
+      expect(result[0]).to include('status' => 'success')
+      expect(result[0]['result']).to include('enabled' => 'true')
     end
   end
 
   describe 'restart action' do
     it 'restart/status a service' do
-      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_task('service', 'default', 'action' => 'restart', 'name' => package_to_use)
+      expect(result[0]).to include('status' => 'success')
+      expect(result[0]['result']).to include('status' => 'restarted')
 
-      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')
+      result = run_task('service', 'default', 'action' => 'status', 'name' => package_to_use)
+      expect(result[0]).to include('status' => 'success')
+      expect(result[0]['result']).to include('status' => 'running')
+      expect(result[0]['result']).to include('enabled' => 'true')
     end
   end
 
   describe 'stop action' do
     it 'stop/status a service' do
-      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})
+      result = run_task('service', 'default', 'action' => 'stop', 'name' => package_to_use)
+      expect(result[0]).to include('status' => 'success')
+      expect(result[0]['result']).to include('status' => %r{in_sync|stopped})
 
       # Debian can give incorrect status
       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')
+        result = run_task('service', 'default', 'action' => 'status', 'name' => package_to_use)
+        expect(result[0]).to include('status' => 'success')
+        expect(result[0]['result']).to include('status' => 'stopped')
+        expect(result[0]['result']).to include('enabled' => 'true')
       end
     end
   end
 
   describe 'start action' do
     it 'start/status a service' do
-      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})
+      result = run_task('service', 'default', 'action' => 'start', 'name' => package_to_use)
+      expect(result[0]).to include('status' => 'success')
+      expect(result[0]['result']).to include('status' => %r{in_sync|started})
 
       # Debian can give incorrect status
       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')
+        result = run_task('service', 'default', 'action' => 'status', 'name' => package_to_use)
+        expect(result[0]).to include('status' => 'success')
+        expect(result[0]['result']).to include('status' => 'running')
+        expect(result[0]['result']).to include('enabled' => 'true')
       end
     end
   end
 
   describe 'disable action' do
     it 'disable/status a service' do
-      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_task('service', 'default', 'action' => 'disable', 'name' => package_to_use)
+      expect(result[0]).to include('status' => 'success')
+      expect(result[0]['result']).to include('status' => 'disabled')
 
-      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')
+      result = run_task('service', 'default', 'action' => 'status', 'name' => package_to_use)
+      expect(result[0]).to include('status' => 'success')
+      expect(result[0]['result']).to include('enabled' => 'false')
     end
   end
 end

spec/acceptance/linux_spec.rb

@@ -5,35 +5,67 @@
   include Beaker::TaskHelper::Inventory
   include BoltSpec::Run
 
+  def bolt_config
+    { 'modulepath' => RSpec.configuration.module_path }
+  end
+
+  let(:bolt_inventory) { hosts_to_inventory.merge('features' => ['puppet-agent']) }
+
   package_to_use = 'rsyslog'
   before(:all) do
     if os[:family] == 'redhat' && os[:release].to_i < 6
-      task_run('service::linux', 'action' => 'stop', 'name' => 'syslog')
+      options = { inventory: hosts_to_inventory.merge('features' => ['puppet-agent']) }
+      params = { 'action' => 'stop', 'name' => 'syslog' }
+      run_task('service::linux', 'default', params, options)
     end
     apply_manifest_on(default, "package { \"#{package_to_use}\": ensure => present, }")
   end
 
   describe 'stop action' do
     it "stop #{package_to_use}" do
-      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})
+      result = run_task('service::linux', 'default', 'action' => 'stop', 'name' => package_to_use)
+      expect(result[0]).to include('status' => 'success')
+      expect(result[0]['result']).to include('status' => %r{ActiveState=inactive|stop})
     end
   end
 
   describe 'start action' do
     it "start #{package_to_use}" do
-      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})
+      result = run_task('service::linux', 'default', 'action' => 'start', 'name' => package_to_use)
+      expect(result[0]).to include('status' => 'success')
+      expect(result[0]['result']).to include('status' => %r{ActiveState=active|running})
     end
   end
 
   describe 'restart action' do
     it "restart #{package_to_use}" do
-      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})
+      result = run_task('service::linux', 'default', 'action' => 'restart', 'name' => package_to_use)
+      expect(result[0]).to include('status' => 'success')
+      expect(result[0]['result']).to include('status' => %r{ActiveState=active|running})
+    end
+  end
+
+  context 'when puppet-agent feature not available on target' do
+    let(:bolt_inventory) { hosts_to_inventory }
+
+    it 'enable action fails' do
+      params = { 'action' => 'enable', 'name' => package_to_use }
+      result = run_task('service', 'default', params)
+      expect(result[0]).to include('status' => 'failure')
+      expect(result[0]['result']).to include('status' => 'failure')
+      expect(result[0]['result']['_error']).to include('msg' => %r{'enable' action not supported})
+      expect(result[0]['result']['_error']).to include('kind' => 'bash-error')
+      expect(result[0]['result']['_error']).to include('details')
+    end
+
+    it 'disable action fails' do
+      params = { 'action' => 'disable', 'name' => package_to_use }
+      result = run_task('service', 'default', params)
+      expect(result[0]).to include('status' => 'failure')
+      expect(result[0]['result']).to include('status' => 'failure')
+      expect(result[0]['result']['_error']).to include('msg' => %r{'disable' action not supported})
+      expect(result[0]['result']['_error']).to include('kind' => 'bash-error')
+      expect(result[0]['result']['_error']).to include('details')
     end
   end
 end

spec/acceptance/windows_spec.rb

@@ -0,0 +1,72 @@
+# run a test task
+require 'spec_helper_acceptance'
+
+describe 'windows service task', if: os[:family] == 'windows' do
+  include Beaker::TaskHelper::Inventory
+  include BoltSpec::Run
+
+  def bolt_config
+    { 'modulepath' => RSpec.configuration.module_path }
+  end
+
+  let(:bolt_inventory) { hosts_to_inventory.merge('features' => ['puppet-agent']) }
+
+  package_to_use = 'Spooler'
+
+  describe 'stop action' do
+    it "stop #{package_to_use}" do
+      result = run_task('service::windows', 'default', 'action' => 'stop', 'name' => package_to_use)
+      expect(result[0]).to include('status' => 'success')
+      expect(result[0]['result']).to include('status' => 'Stopped')
+    end
+  end
+
+  describe 'start action' do
+    it "start #{package_to_use}" do
+      result = run_task('service::windows', 'default', 'action' => 'start', 'name' => package_to_use)
+      expect(result[0]).to include('status' => 'success')
+      expect(result[0]['result']).to include('status' => 'Started')
+    end
+  end
+
+  describe 'restart action' do
+    it "restart #{package_to_use}" do
+      result = run_task('service::windows', 'default', 'action' => 'restart', 'name' => package_to_use)
+      expect(result[0]).to include('status' => 'success')
+      expect(result[0]['result']).to include('status' => 'Restarted')
+    end
+  end
+
+  describe 'status action' do
+    it "status #{package_to_use}" do
+      result = run_task('service::windows', 'default', 'action' => 'status', 'name' => package_to_use)
+      expect(result[0]).to include('status' => 'success')
+      expect(result[0]['result']).to include('status' => 'Started')
+      expect(result[0]['result']).to include('enabled')
+    end
+  end
+
+  context 'when puppet-agent feature not available on target' do
+    let(:bolt_inventory) { hosts_to_inventory }
+
+    it 'enable action fails' do
+      params = { 'action' => 'enable', 'name' => package_to_use }
+      result = run_task('service', 'default', params)
+      expect(result[0]).to include('status' => 'failure')
+      expect(result[0]['result']).to include('status' => 'failure')
+      expect(result[0]['result']['_error']).to include('msg' => %r{'enable' action not supported})
+      expect(result[0]['result']['_error']).to include('kind' => 'powershell_error')
+      expect(result[0]['result']['_error']).to include('details')
+    end
+
+    it 'disable action fails' do
+      params = { 'action' => 'disable', 'name' => package_to_use }
+      result = run_task('service', 'default', params)
+      expect(result[0]).to include('status' => 'failure')
+      expect(result[0]['result']).to include('status' => 'failure')
+      expect(result[0]['result']['_error']).to include('msg' => %r{'disable' action not supported})
+      expect(result[0]['result']['_error']).to include('kind' => 'powershell_error')
+      expect(result[0]['result']['_error']).to include('details')
+    end
+  end
+end

spec/spec_helper_acceptance.rb

@@ -13,14 +13,6 @@
 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

tasks/linux.json

@@ -1,11 +1,11 @@
 {
-  "description": "Manage the state of services (without a puppet agent)",
+  "description": "Manage and inspect the state of services (without a puppet agent)",
   "private": true,
   "input_method": "environment",
   "parameters": {
     "action": {
-      "description": "The operation (start, stop) to perform on the service",
-      "type": "Enum[start, stop, restart]"
+      "description": "The operation (start, stop, restart, status) to perform on the service.",
+      "type": "Enum[start, stop, restart, status]"
     },
     "name": {
       "description": "The name of the service to operate on.",