apply_prep installs openvox-agent via puppet-openvox_bootstrap

Author: jessereynolds

Puppetfile

@@ -6,7 +6,7 @@ moduledir File.join(File.dirname(__FILE__), 'modules')
 
 # Core modules used by 'apply'
 mod 'puppetlabs-service', '3.0.0'
-mod 'puppetlabs-puppet_agent', '4.21.0'
+mod 'puppet-openvox_bootstrap', '1.0.0'
 mod 'puppetlabs-facts', '1.6.0'
 
 # Core types and providers for Puppet 6

bolt-modules/boltlib/lib/puppet/functions/apply_prep.rb

@@ -3,13 +3,14 @@
 require 'bolt/logger'
 require 'bolt/task'
 
-# Installs the `puppet-agent` package on targets if needed, then collects facts,
+# Installs the `openvox-agent` package on targets if needed, then collects facts,
 # including any custom facts found in Bolt's module path. The package is
 # installed using either the configured plugin or the `task` plugin with the
-# `puppet_agent::install` task.
+# `openvox_bootstrap::install` task.
 #
-# Agent installation will be skipped if the target includes the `puppet-agent`
-# feature, either as a property of its transport (PCP) or by explicitly setting
+# Agent installation will be skipped if the target includes either the `openvox-agent`
+# or the `puppet-agent`
+# feature, either as a property of its transport or by explicitly setting
 # it as a feature in Bolt's inventory.
 #
 # > **Note:** Not available in apply block
@@ -66,10 +67,11 @@ def run_task(targets, task, args = {}, options = {})
     executor.run_task(targets, task, args, options)
   end
 
-  # Returns true if the target has the puppet-agent feature defined, either from
+  # Returns true if the target has the openvox-agent or the puppet-agent feature defined, either from
   # inventory or transport.
   #
   private def agent?(target)
+    inventory.features(target).include?('openvox-agent') ||
     inventory.features(target).include?('puppet-agent') ||
     executor.transport(target.transport).provided_features.include?('puppet-agent') ||
     target.remote?
@@ -93,15 +95,15 @@ def run_task(targets, task, args = {}, options = {})
     Puppet::Pops::Types::PSensitiveType::Sensitive.new(tarball)
   end
 
-  # Install the puppet-agent package on targets that need it.
+  # Install the openvox-agent package on targets that need it.
   #
   private def install_agents(targets, options)
     results = []
 
     agent_targets, agentless_targets = targets.partition { |target| agent?(target) }
 
     agent_targets.each do |target|
-      Puppet.debug("Puppet Agent feature declared for #{target}")
+      Puppet.debug("openvox-agent or puppet-agent feature declared for #{target}")
       results << Bolt::Result.new(target)
     end
 
@@ -111,7 +113,7 @@ def run_task(targets, task, args = {}, options = {})
 
       hook_results.each do |result|
         next unless result.ok?
-        inventory.set_feature(result.target, 'puppet-agent')
+        inventory.set_feature(result.target, 'openvox-agent')
       end
 
       results.concat(hook_results).concat(errors)

bolt-modules/boltlib/lib/puppet/functions/get_resources.rb

@@ -6,7 +6,7 @@
 # The results are returned as a list of hashes representing each resource.
 #
 # Requires the Puppet Agent be installed on the target, which can be accomplished with apply_prep
-# or by directly running the `puppet_agent::install` task. In order to be able to reference types without
+# or by directly running the `openvox_bootstrap::install` task. In order to be able to reference types without
 # string quoting (for example `get_resources($target, Package)` instead of `get_resources($target, 'Package')`),
 # run the command `bolt puppetfile generate-types` to generate type references in `$Boldir/.resource_types`.
 #

bolt-modules/boltlib/lib/puppet/functions/set_feature.rb

@@ -8,16 +8,16 @@
 # Supported features are:
 # - `powershell`
 # - `shell`
-# - `puppet-agent`
+# - `openvox-agent`
 #
 # > **Note:** Not available in apply block
 Puppet::Functions.create_function(:set_feature) do
   # @param target The Target object to add features to. See {get_targets}.
   # @param feature The string identifying the feature.
   # @param value Whether the feature is supported.
   # @return The target with the updated feature
-  # @example Add the `puppet-agent` feature to a target
-  #   set_feature($target, 'puppet-agent', true)
+  # @example Add the `openvox-agent` feature to a target
+  #   set_feature($target, 'openvox-agent', true)
   dispatch :set_feature do
     param 'Target', :target
     param 'String', :feature

bolt-modules/boltlib/spec/functions/apply_prep_spec.rb

@@ -36,31 +36,31 @@
     let(:unknown_targets)   { targets.reject { |target| target.protocol == 'pcp' } }
     let(:fact)              { { 'osfamily' => 'none' } }
     let(:custom_facts_task) { Bolt::Task.new('custom_facts_task') }
-    let(:version_task)      { Bolt::Task.new('puppet_agent::version') }
-    let(:install_task)      { Bolt::Task.new('puppet_agent::install') }
+    let(:version_task)      { Bolt::Task.new('openvox_bootstrap::check') }
+    let(:install_task)      { Bolt::Task.new('openvox_bootstrap::install') }
     let(:service_task)      { Bolt::Task.new('service') }
 
     before(:each) do
       applicator.stubs(:build_plugin_tarball).returns(:tarball)
       applicator.stubs(:custom_facts_task).returns(custom_facts_task)
       inventory.get_targets(targets)
-      targets.each { |t| inventory.set_feature(t, 'puppet-agent', false) }
+      targets.each { |t| inventory.set_feature(t, 'openvox-agent', false) }
 
       task1 = mock('version_task')
-      task1.stubs(:task_hash).returns('name' => 'puppet_agent::version')
+      task1.stubs(:task_hash).returns('name' => 'openvox_bootstrap::check')
       task1.stubs(:runnable_with?).returns(true)
-      Puppet::Pal::ScriptCompiler.any_instance.stubs(:task_signature).with('puppet_agent::version').returns(task1)
+      Puppet::Pal::ScriptCompiler.any_instance.stubs(:task_signature).with('openvox_bootstrap::check').returns(task1)
       task2 = mock('install_task')
-      task2.stubs(:task_hash).returns('name' => 'puppet_agent::install')
+      task2.stubs(:task_hash).returns('name' => 'openvox_bootstrap::install')
       task2.stubs(:runnable_with?).returns(true)
-      Puppet::Pal::ScriptCompiler.any_instance.stubs(:task_signature).with('puppet_agent::install').returns(task2)
+      Puppet::Pal::ScriptCompiler.any_instance.stubs(:task_signature).with('openvox_bootstrap::install').returns(task2)
       task3 = mock('service_task')
       task3.stubs(:task_hash).returns('name' => 'service')
       task3.stubs(:runnable_with?).returns(true)
       Puppet::Pal::ScriptCompiler.any_instance.stubs(:task_signature).with('service').returns(task3)
     end
 
-    it 'sets puppet-agent feature and gathers facts' do
+    it 'sets openvox-agent feature and gathers facts' do
       facts = Bolt::ResultSet.new(targets.map { |t| Bolt::Result.new(t, value: fact) })
       executor.expects(:run_task)
               .with(anything, custom_facts_task, includes('plugins'), {})
@@ -73,7 +73,7 @@
 
       is_expected.to run.with_params(hostnames.join(','))
       targets.each do |target|
-        expect(inventory.features(target)).to include('puppet-agent') unless target.transport == 'pcp'
+        expect(inventory.features(target)).to include('openvox-agent') unless target.transport == 'pcp'
         expect(inventory.facts(target)).to eq(fact)
       end
     end
@@ -91,7 +91,7 @@
 
       is_expected.to run.with_params(hostnames, '_run_as' => 'root')
       targets.each do |target|
-        expect(inventory.features(target)).to include('puppet-agent') unless target.transport == 'pcp'
+        expect(inventory.features(target)).to include('openvox-agent') unless target.transport == 'pcp'
         expect(inventory.facts(target)).to eq(fact)
       end
     end
@@ -109,7 +109,7 @@
 
       is_expected.to run.with_params(hostnames, '_noop' => true)
       targets.each do |target|
-        expect(inventory.features(target)).to include('puppet-agent') unless target.transport == 'pcp'
+        expect(inventory.features(target)).to include('openvox-agent') unless target.transport == 'pcp'
         expect(inventory.facts(target)).to eq(fact)
       end
     end
@@ -141,7 +141,7 @@
             'plugin_hooks' => {
               'puppet_library' => {
                 'plugin' => 'task',
-                'task' => 'puppet_agent::install'
+                'task' => 'openvox_bootstrap::install'
               }
             }
           }]
@@ -161,7 +161,7 @@
                .returns(task_hook)
 
         is_expected.to run.with_params(hostname)
-        expect(inventory.features(target)).to include('puppet-agent')
+        expect(inventory.features(target)).to include('openvox-agent')
         expect(inventory.facts(target)).to eq(fact)
       end
     end
@@ -192,7 +192,7 @@
                .returns(task_hook)
 
         is_expected.to run.with_params(hostname)
-        expect(inventory.features(target)).to include('puppet-agent')
+        expect(inventory.features(target)).to include('openvox-agent')
         expect(inventory.facts(target)).to eq(fact)
       end
     end
@@ -217,13 +217,13 @@
 
       is_expected.to run.with_params(hostnames.join(','))
       targets.each do |target|
-        expect(inventory.features(target)).to include('puppet-agent') unless target.transport == 'pcp'
+        expect(inventory.features(target)).to include('openvox-agent') unless target.transport == 'pcp'
         expect(inventory.facts(target)).to eq(fact)
       end
     end
   end
 
-  context 'with targets assigned the puppet-agent feature' do
+  context 'with targets assigned the openvox-agent feature' do
     let(:hostnames)         { %w[foo bar] }
     let(:targets)           { hostnames.map { |h| inventory.get_target(h) } }
     let(:fact)              { { 'osfamily' => 'none' } }
@@ -232,7 +232,7 @@
     before(:each) do
       applicator.stubs(:build_plugin_tarball).returns(:tarball)
       applicator.stubs(:custom_facts_task).returns(custom_facts_task)
-      targets.each { |target| inventory.set_feature(target, 'puppet-agent') }
+      targets.each { |target| inventory.set_feature(target, 'openvox-agent') }
     end
 
     it 'sets feature and gathers facts' do
@@ -243,7 +243,7 @@
 
       is_expected.to run.with_params(hostnames.join(','))
       targets.each do |target|
-        expect(inventory.features(target)).to include('puppet-agent')
+        expect(inventory.features(target)).to include('openvox-agent')
         expect(inventory.facts(target)).to eq(fact)
       end
     end
@@ -258,7 +258,7 @@
     before(:each) do
       applicator.stubs(:build_plugin_tarball).returns(:tarball)
       applicator.stubs(:custom_facts_task).returns(custom_facts_task)
-      targets.each { |target| inventory.set_feature(target, 'puppet-agent') }
+      targets.each { |target| inventory.set_feature(target, 'openvox-agent') }
     end
 
     it 'only uses required plugins' do

lib/bolt/inventory/target.rb

@@ -65,7 +65,7 @@ def set_local_defaults
         old_config = @config
         @config = Bolt::Util.deep_merge(defaults, @config)
         invalidate_config_cache! if old_config != @config
-        set_feature('puppet-agent')
+        set_feature('openvox-agent')
         @set_local_default = true
       end
 

lib/bolt/pal.rb

@@ -792,7 +792,7 @@ def plan_hierarchy_lookup(key, plan_vars: {})
     end
 
     def lookup(key, targets, inventory, executor, plan_vars: {})
-      # Install the puppet-agent package and collect facts. Facts are
+      # Install the openvox-agent package and collect facts. Facts are
       # automatically added to the targets.
       in_plan_compiler(executor, inventory, nil) do |compiler|
         compiler.call_function('apply_prep', targets)

spec/bolt_spec/run_spec.rb

@@ -105,7 +105,7 @@
     end
   end
 
-  context 'with a target that has a puppet-agent installed' do
+  context 'with a target that has a openvox-agent installed' do
     def root_config
       { 'ssh' => {
         'run-as' => 'root',
@@ -115,22 +115,22 @@ def root_config
     end
 
     before(:all) do
-      result = run_task('puppet_agent::version', 'ssh', {}, inventory: conn_inventory, config: root_config)
+      result = run_task('openvox_bootstrap::check', 'ssh', {}, inventory: conn_inventory, config: root_config)
       expect(result.first['status']).to eq('success')
       unless result.first['value']['version']
-        result = run_task('puppet_agent::install', 'ssh', {}, inventory: conn_inventory, config: root_config)
+        result = run_task('openvox_bootstrap::install', 'ssh', {}, inventory: conn_inventory, config: root_config)
       end
       expect(result.first['status']).to eq('success')
     end
 
     after(:all) do
-      uninstall = '/opt/puppetlabs/bin/puppet resource package puppet-agent ensure=absent'
+      uninstall = '/opt/puppetlabs/bin/puppet resource package openvox-agent ensure=absent'
       run_command(uninstall, 'ssh', inventory: conn_inventory, config: root_config)
     end
 
     describe 'apply_manifest' do
       it 'should apply a manifest file' do
-        bolt_inventory['features'] = ['puppet-agent']
+        bolt_inventory['features'] = ['openvox-agent']
         with_tempfile_containing('manifest', "notify { 'hello world': }", '.pp') do |manifest|
           results = apply_manifest(manifest.path, 'ssh')
           results.each do |result|
@@ -142,7 +142,7 @@ def root_config
       end
 
       it 'should apply a manifest code block' do
-        bolt_inventory['features'] = ['puppet-agent']
+        bolt_inventory['features'] = ['openvox-agent']
         results = apply_manifest("notify { 'hello world': }", 'ssh', execute: true)
         results.each do |result|
           expect(result['status']).to eq('success')
@@ -152,15 +152,15 @@ def root_config
       end
 
       it 'should raise an error when manifest file does not exist' do
-        bolt_inventory['features'] = ['puppet-agent']
+        bolt_inventory['features'] = ['openvox-agent']
         expect do
           apply_manifest("missing.na", 'ssh')
         end.to raise_error(Bolt::FileError)
         bolt_inventory.delete('features')
       end
 
       it 'should return a failure' do
-        bolt_inventory['features'] = ['puppet-agent']
+        bolt_inventory['features'] = ['openvox-agent']
         results = apply_manifest("fail()", 'ssh', execute: true)
         results.each do |result|
           expect(result['status']).to eq('failure')

spec/integration/apply_error_spec.rb

@@ -19,7 +19,7 @@
     let(:tflags) { %w[--no-host-key-check] }
 
     it 'prints a helpful error if Puppet is not present' do
-      uninstall = '/opt/puppetlabs/bin/puppet resource package puppet-agent ensure=absent'
+      uninstall = '/opt/puppetlabs/bin/puppet resource package openvox-agent ensure=absent'
       run_cli_json(%W[command run #{uninstall} --run-as root --sudo-password #{password}] + config_flags)
 
       result = run_cli_json(%w[plan run basic::class] + config_flags)

spec/integration/apply_spec.rb

@@ -75,7 +75,7 @@
     let(:user)     { conn_info('ssh')[:user] }
     let(:password) { conn_info('ssh')[:password] }
 
-    # Run tests that require the puppet-agent package to be installed on the target.
+    # Run tests that require the openvox-agent package to be installed on the target.
     # Each test is run against all agent targets unless otherwise noted.
     context 'with puppet installed' do
       # Set up a project directory for the tests. Include an inventory file so Bolt
@@ -304,7 +304,7 @@
       end
     end
 
-    # Run tests for installing the puppet-agent package using apply_prep.
+    # Run tests for installing the openvox-agent package using apply_prep.
     context 'installing puppet' do
       let(:config) do
         {
@@ -391,7 +391,7 @@
                 'plugin_hooks' => {
                   'puppet_library' => {
                     'plugin' => 'task',
-                    'task' => 'puppet_agent::install',
+                    'task' => 'openvox_bootstrap::install',
                     'parameters' => {
                       'version' => '7.0.0'
                     }
@@ -412,7 +412,7 @@
           report = result[0]['value']['report']
           expect(report['resource_statuses']).to include("Notify[Hello #{uri}]")
 
-          results = run_cli_json(%W[task run puppet_agent::version -t #{uri}], project: project)
+          results = run_cli_json(%W[task run openvox_bootstrap::check -t #{uri}], project: project)
 
           result = results['items']
           expect(result.count).to eq(1)