Merge pull request puppetlabs#61 from puppetlabs/MODULES-8391

(MODULES-8391) Enable implementations on the init task and hide others

Author: MikaelSmith

.fixtures.yml

@@ -0,0 +1,3 @@
+fixtures:
+  symlinks:
+    service: "#{source_dir}"

.sync.yml

@@ -5,9 +5,15 @@
     - set: docker/ubuntu-14.04
   docker_defaults:
     bundler_args: ""
+    script: bundle exec rake task_acceptance
   secure: ""
   branches:
     - release
+  remove_includes:
+    - env: PUPPET_GEM_VERSION="~> 5.0" CHECK=parallel_spec
+      rvm: 2.4.4
+    - env: PUPPET_GEM_VERSION="~> 4.0" CHECK=parallel_spec RUBYGEMS_VERSION=2.7.8
+      rvm: 2.1.9
 
 Gemfile:
   optional:
@@ -25,6 +31,8 @@ Gemfile:
           - mswin
           - mingw
           - x64_mingw
+      - gem: 'bolt'
+        version: '~> 1.4'
 
 .gitlab-ci.yml:
   unmanaged: true

.travis.yml

@@ -27,27 +27,21 @@ matrix:
       dist: trusty
       env: PUPPET_INSTALL_TYPE=agent BEAKER_debug=true BEAKER_PUPPET_COLLECTION=puppet6 BEAKER_set=docker/centos-7 BEAKER_TESTMODE=apply
       rvm: 2.5.1
-      script: bundle exec rake beaker
+      script: bundle exec rake task_acceptance
       services: docker
       sudo: required
     -
       bundler_args: 
       dist: trusty
       env: PUPPET_INSTALL_TYPE=agent BEAKER_debug=true BEAKER_PUPPET_COLLECTION=puppet6 BEAKER_set=docker/ubuntu-14.04 BEAKER_TESTMODE=apply
       rvm: 2.5.1
-      script: bundle exec rake beaker
+      script: bundle exec rake task_acceptance
       services: docker
       sudo: required
     -
       env: CHECK="syntax lint metadata_lint check:symlinks check:git_ignore check:dot_underscore check:test_file rubocop"
     -
       env: CHECK=parallel_spec
-    -
-      env: PUPPET_GEM_VERSION="~> 5.0" CHECK=parallel_spec
-      rvm: 2.4.4
-    -
-      env: PUPPET_GEM_VERSION="~> 4.0" CHECK=parallel_spec RUBYGEMS_VERSION=2.7.8 BUNDLER_VERSION=1.17.3
-      rvm: 2.1.9
 branches:
   only:
     - master

Gemfile

@@ -31,6 +31,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.4',                               require: false
 end
 
 puppet_version = ENV['PUPPET_GEM_VERSION']

Rakefile

@@ -74,3 +74,6 @@ EOM
   end
 end
 
+task :task_acceptance => [:spec_prep, :beaker] do
+  # nothing to do
+end

spec/acceptance/init_spec.rb

@@ -1,67 +1,110 @@
 # run a test task
 require 'spec_helper_acceptance'
-# bolt regexes
-# expect_multiple_regexes(result: result, regexes: [%r{"status":"(stopped|in_sync)"}, %r{Ran on 1 node}])
-# expect_multiple_regexes(result: result, regexes: [%r{"status":"stopped"}, %r{"enabled":"false"}, %r{Ran on 1 node}])
-
-def run_and_expect(params, regex_hash)
-  expect_multiple_regexes(result: run_task(task_name: 'service', params: params), regexes: regex_hash)
-end
+require 'beaker-task_helper/inventory'
+require 'bolt_spec/run'
 
 describe 'service task' 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.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 fact_on(default, 'osfamily') != 'windows'
-      if fact_on(default, 'osfamily') == 'RedHat' && fact_on(default, 'operatingsystemrelease') < '6'
-        run_task(task_name: 'service', params: 'action=stop name=syslog')
+    if osfamily_fact != 'windows'
+      if osfamily_fact == 'RedHat' && fact('operatingsystemrelease') < '6'
+        run('action' => 'stop', 'name' => 'syslog')
       end
       package_to_use = 'rsyslog'
-      apply_manifest("package { \"#{package_to_use}\": ensure => present, }")
+      apply_manifest_on(default, "package { \"#{package_to_use}\": ensure => present, }")
     else
       package_to_use = 'W32Time'
-      run_and_expect("action=start name=#{package_to_use}", [%r{status.*(in_sync|started)}, %r{#{task_summary_line}}])
+      run('action' => 'start', 'name' => package_to_use)
     end
   end
+
   describe 'enable action' do
     it 'enable/status a service' do
-      run_and_expect("action=enable name=#{package_to_use}",
-                     [%r{status.*(in_sync|enabled)}, %r{#{task_summary_line}}])
-      run_and_expect("action=status name=#{package_to_use}",
-                     [%r{enabled.*true}, %r{#{task_summary_line}}])
+      result = run('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)
+      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
-      run_and_expect("action=restart name=#{package_to_use}",
-                     [%r{status.*restarted}, %r{#{task_summary_line}}])
-      run_and_expect("action=status name=#{package_to_use}",
-                     [%r{status.*running}, %r{enabled.*true}, %r{#{task_summary_line}}])
+      result = run('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)
+      expect(result[0]['status']).to eq('success')
+      expect(result[0]['result']['status']).to eq('running')
+      expect(result[0]['result']['enabled']).to eq('true')
     end
   end
+
   describe 'stop action' do
     it 'stop/status a service' do
-      run_and_expect("action=stop name=#{package_to_use}", [%r{status.*(in_sync|stopped)}, %r{#{task_summary_line}}])
+      result = run('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 fact_on(default, 'osfamily') != 'Debian'
-        run_and_expect("action=status name=#{package_to_use}", [%r{status.*stopped}, %r{enabled.*true}, %r{#{task_summary_line}}])
+      if osfamily_fact != 'Debian'
+        result = run('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')
       end
     end
   end
+
   describe 'start action' do
     it 'start/status a service' do
-      run_and_expect("action=start name=#{package_to_use}", [%r{status.*(in_sync|started)}, %r{#{task_summary_line}}])
+      result = run('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 fact_on(default, 'osfamily') != 'Debian'
-        run_and_expect("action=status name=#{package_to_use}", [%r{status.*running}, %r{enabled.*true}, %r{#{task_summary_line}}])
+      if osfamily_fact != 'Debian'
+        result = run('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')
       end
     end
   end
+
   describe 'disable action' do
     it 'disable/status a service' do
-      run_and_expect("action=disable name=#{package_to_use}",
-                     [%r{status.*disabled}, %r{#{task_summary_line}}])
-      run_and_expect("action=status name=#{package_to_use}",
-                     [%r{enabled.*false}, %r{#{task_summary_line}}])
+      result = run('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)
+      expect(result[0]['status']).to eq('success')
+      expect(result[0]['result']['enabled']).to eq('false')
     end
   end
 end

spec/acceptance/linux_spec.rb

@@ -1,34 +1,57 @@
 # run a test task
 require 'spec_helper_acceptance'
-# bolt regexes
-# expect_multiple_regexes(result: result, regexes: [%r{"status":"(stopped|in_sync)"}, %r{Ran on 1 node}])
-# expect_multiple_regexes(result: result, regexes: [%r{"status":"stopped"}, %r{"enabled":"false"}, %r{Ran on 1 node}])
+require 'beaker-task_helper/inventory'
+require 'bolt_spec/run'
 
-describe 'linux service task', unless: fact_on(default, 'osfamily') == 'windows' do
-  package_to_use = ''
+describe 'linux service task', unless: fact('osfamily') == '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_on(default, 'osfamily') == 'RedHat' && fact_on(default, 'operatingsystemrelease') < '6'
-      run_task(task_name: 'service::linux', params: 'action=stop name=syslog')
+    if fact('osfamily') == 'RedHat' && fact('operatingsystemrelease') < '6'
+      run('action' => 'stop', 'name' => 'syslog')
     end
-    package_to_use = 'rsyslog'
-    apply_manifest("package { \"#{package_to_use}\": ensure => present, }")
+    apply_manifest_on(default, "package { \"#{package_to_use}\": ensure => present, }")
   end
+
   describe 'stop action' do
     it "stop #{package_to_use}" do
-      result = run_task(task_name: 'service::linux', params: "action=stop name=#{package_to_use}")
-      expect_multiple_regexes(result: result, regexes: [%r{status.*(stop)}, %r{#{task_summary_line}}])
+      result = run('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_task(task_name: 'service::linux', params: "action=start name=#{package_to_use}")
-      expect_multiple_regexes(result: result, regexes: [%r{status.*(start)}, %r{#{task_summary_line}}])
+      result = run('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_task(task_name: 'service::linux', params: "action=restart name=#{package_to_use}")
-      expect_multiple_regexes(result: result, regexes: [%r{status.*(restart)}, %r{#{task_summary_line}}])
+      result = run('action' => 'restart', 'name' => package_to_use)
+      expect(result[0]['status']).to eq('success')
+      expect(result[0]['result']['status']).to match(%r{restart})
     end
   end
 end

spec/spec_helper_acceptance.rb

@@ -4,21 +4,17 @@
 require 'beaker-rspec'
 require 'beaker/puppet_install_helper'
 require 'beaker/module_install_helper'
-require 'beaker-task_helper'
 
 run_puppet_install_helper
 configure_type_defaults_on(hosts)
-install_ca_certs unless pe_install?
-install_bolt_on(hosts) unless pe_install?
+install_ca_certs
 install_module_on(hosts)
 install_module_dependencies_on(hosts)
 
 RSpec.configure do |c|
   # Readable test descriptions
   c.formatter = :documentation
 
-  # Configure all nodes in nodeset
-  c.before :suite do
-    run_puppet_access_login(user: 'admin') if pe_install?
-  end
+  c.add_setting :module_path
+  c.module_path = File.join(File.dirname(File.expand_path(__FILE__)), 'fixtures', 'modules')
 end

tasks/init.json

@@ -3,16 +3,21 @@
   "input_method": "stdin",
   "parameters": {
     "action": {
-      "description": "The operation (start, stop, restart, enable, disable, status) to perform on the service",
+      "description": "The operation (start, stop, restart, enable, disable, status) to perform on the service.",
       "type": "Enum[start, stop, restart, enable, disable, status]"
     },
     "name": {
       "description": "The name of the service to operate on.",
       "type": "String[1]"
     },
     "provider": {
-      "description": "The provider to use to manage or inspect the service, defaults to the system service manager",
+      "description": "The provider to use to manage or inspect the service, defaults to the system service manager. Only used when the 'puppet-agent' feature is available on the target so we can leverage Puppet.",
       "type": "Optional[String[1]]"
     }
-  }
+  },
+  "implementations": [
+    {"name": "init.rb", "requirements": ["puppet-agent"]},
+    {"name": "windows.ps1", "requirements": ["powershell"], "input_method": "powershell"},
+    {"name": "linux.sh", "requirements": ["shell"], "input_method": "environment"}
+  ]
 }

tasks/linux.json

@@ -1,5 +1,6 @@
 {
   "description": "Manage the state of services (without a puppet agent)",
+  "private": true,
   "input_method": "environment",
   "parameters": {
     "action": {

tasks/windows.json

@@ -1,5 +1,6 @@
 {
   "description": "Manage the state of Windows services (without a puppet agent)",
+  "private": true,
   "input_method": "powershell",
   "parameters": {
     "action": {