apply_prep to install openvox-agent

- replaces puppetlabs-puppet_agent with puppet-openvox_bootstrap for automatic
  installation of openvox-agent rather than puppet-agent packages.
  (Nb, this doesn’t yet support Windows)
- temporarily set to a branch of openvox_bootstrap

Author: jessereynolds

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

@@ -3,13 +3,13 @@
 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
+# 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

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/spec/functions/apply_prep_spec.rb

@@ -36,8 +36,8 @@
     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
@@ -47,13 +47,13 @@
       targets.each { |t| inventory.set_feature(t, 'puppet-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)
@@ -141,7 +141,7 @@
             'plugin_hooks' => {
               'puppet_library' => {
                 'plugin' => 'task',
-                'task' => 'puppet_agent::install'
+                'task' => 'openvox_bootstrap::install'
               }
             }
           }]

documentation/applying_manifest_blocks.md

@@ -33,10 +33,10 @@ Manifest blocks require facts to compile. When Bolt applies Puppet manifests, it
 automatically installs the packages necessary to run the apply command and
 gathers facts using [facter](https://puppet.com/docs/facter/latest/), making the
 facts available to the manifest block. Bolt also identifies targets that do not
-have Puppet agents and runs the [`puppet_agent::install`
-task](https://forge.puppet.com/puppetlabs/puppet_agent) to install the agent.
+have Puppet agents and runs the [`openvox_bootstrap::install`
+task](https://forge.puppet.com/puppet/openvox_bootstrap) to install the agent.
 
-> **Note:** Bolt installs the Puppet agent package to enable the use of Puppet
+> **Note:** Bolt installs the OpenVox agent package to enable the use of Puppet
   code. It does not require setting up a server-agent architecture between the
   remote systems and the local system running Bolt.
 
@@ -240,7 +240,7 @@ access the `logs` key in the report hash:
 plan example (
   TargetSpec $targets
 ) {
-  # Install the puppet-agent package and gather facts
+  # Install the openvox-agent package and gather facts
   $targets.apply_prep
 
   # Apply Puppet code
@@ -400,7 +400,7 @@ Create a manifest that sets up a web server with nginx, and run it as a plan.
          String $site_content = 'hello!',
        ) {
 
-         # Install the puppet-agent package if Puppet is not detected.
+         # Install the openvox-agent package if Puppet is not detected.
          # Copy over custom facts from the Bolt modulepath.
          # Run the `facter` command line tool to gather target information.
          $targets.apply_prep
@@ -479,7 +479,7 @@ Create a manifest that sets up a web server with IIS and run it as a plan.
         String $site_content = 'hello!',
    ) {
 
-     # Install the puppet-agent package if Puppet is not detected. 
+     # Install the openvox-agent package if Puppet is not detected. 
      # Copy over custom facts from the Bolt modulepath.
      # Run the `facter` command line tool to gather target information.
      $targets.apply_prep

documentation/bolt_inventory_reference.md

@@ -55,7 +55,7 @@ level apply to all groups and targets in the inventory file.
 - **Type:** Array
 
 > 🔩 **Tip:** You can set the `puppet-agent` feature to indicate that Bolt
-> should skip installing the Puppet agent on all targets when using
+> should skip installing the OpenVox agent on all targets when using
 > `bolt apply` or the `apply_prep` plan function.
 
 ```yaml
@@ -155,7 +155,7 @@ all groups and targets under the group.
 - **Type:** Array
 
 > 🔩 **Tip:** You can set the `puppet-agent` feature on the group to indicate
-> that Bolt should skip installing the Puppet agent on all targets under the
+> that Bolt should skip installing the OpenVox agent on all targets under the
 > group when using `bolt apply` or the `apply_prep` plan function.
 
 ```yaml
@@ -316,7 +316,7 @@ A list of available features for the target.
 - **Type:** Array
 
 > 🔩 **Tip:** You can set the `puppet-agent` feature on the target to indicate
-> that Bolt should skip installing the Puppet agent on the target when using
+> that Bolt should skip installing the OpenVox agent on the target when using
 > `bolt apply` or the `apply_prep` plan function.
 
 ```yaml

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,16 +115,16 @@ 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
 

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)

spec/integration/inventory_spec.rb

@@ -681,7 +681,7 @@ def fact_plan(name = 'facts_test')
       {
         'puppet_library' => {
           'plugin'     => 'task',
-          'task'       => 'puppet_agent::install',
+          'task'       => 'openvox_bootstrap::install',
           'parameters' => {
             'version'    => '6.19.0',
             'collection' => 'puppet6'