bolt 3.16.0 → 3.19.0

data/lib/bolt/pal/yaml_plan/transpiler.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'bolt/error'
-require 'bolt/pal/yaml_plan/loader'
-require 'bolt/util'
+require_relative '../../../bolt/error'
+require_relative '../../../bolt/pal/yaml_plan/loader'
+require_relative '../../../bolt/util'
 
 module Bolt
   class PAL

data/lib/bolt/pal/yaml_plan.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'bolt/pal/yaml_plan/parameter'
-require 'bolt/pal/yaml_plan/step'
+require_relative 'yaml_plan/parameter'
+require_relative 'yaml_plan/step'
 
 module Bolt
   class PAL

data/lib/bolt/pal.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require 'bolt/applicator'
-require 'bolt/executor'
-require 'bolt/error'
-require 'bolt/plan_result'
-require 'bolt/util'
-require 'bolt/config/modulepath'
+require_relative '../bolt/applicator'
+require_relative '../bolt/executor'
+require_relative '../bolt/error'
+require_relative '../bolt/plan_result'
+require_relative '../bolt/util'
+require_relative '../bolt/config/modulepath'
 require 'etc'
 
 module Bolt
@@ -101,10 +101,10 @@ module Bolt
         raise Bolt::Error.new("Puppet must be installed to execute tasks", "bolt/puppet-missing")
       end
 
-      require 'bolt/pal/logging'
-      require 'bolt/pal/issues'
-      require 'bolt/pal/yaml_plan/loader'
-      require 'bolt/pal/yaml_plan/transpiler'
+      require_relative 'pal/logging'
+      require_relative 'pal/issues'
+      require_relative 'pal/yaml_plan/loader'
+      require_relative 'pal/yaml_plan/transpiler'
 
       # Now that puppet is loaded we can include puppet mixins in data types
       Bolt::ResultSet.include_iterable
@@ -736,7 +736,7 @@ module Bolt
         #
         # Every future except for the main plan needs to have a plan id in
         # order to be tracked for the `wait()` function with no arguments.
-        future = executor.create_future(name: plan_name, plan_id: 1) do |_scope|
+        future = executor.create_future(name: plan_name, plan_id: 0) do |_scope|
           r = compiler.call_function('run_plan', plan_name, params.merge('_bolt_api_call' => true))
           Bolt::PlanResult.from_pcore(r, 'success')
         rescue Bolt::Error => e

data/lib/bolt/plan_creator.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require 'bolt/error'
-require 'bolt/logger'
-require 'bolt/module'
-require 'bolt/util'
+require_relative '../bolt/error'
+require_relative '../bolt/logger'
+require_relative '../bolt/module'
+require_relative '../bolt/util'
 
 module Bolt
   module PlanCreator
-    def self.validate_input(project, plan_name)
+    def self.validate_plan_name(project, plan_name)
       if project.name.nil?
         raise Bolt::Error.new(
           "Project directory '#{project.path}' is not a named project. Unable to create "\
@@ -51,7 +51,15 @@ module Bolt
       end
     end
 
-    def self.create_plan(plans_path, plan_name, is_puppet)
+    # Create a new plan from the plan templates based on which language the
+    # user configured, and whether the plan wraps a script.
+    #
+    # @param plans_path [string] The path to the new plan
+    # @param plan_name [string] The name of the new plan
+    # @param is_puppet [boolean] Whether to create a Puppet language plan
+    # @param script [string] A reference to a script for the new plan to run
+    #
+    def self.create_plan(plans_path, plan_name, is_puppet: false, script: nil)
       _, name_segments, basename = segment_plan_name(plan_name)
       dir_path = plans_path.join(*name_segments)
 
@@ -66,8 +74,15 @@ module Bolt
 
       type = is_puppet ? 'pp' : 'yaml'
       plan_path = dir_path + "#{basename}.#{type}"
-      plan_template = is_puppet ? puppet_plan(plan_name) : yaml_plan(plan_name)
-
+      plan_template = if is_puppet && script
+                        puppet_script_plan(plan_name, script)
+                      elsif is_puppet
+                        puppet_plan(plan_name)
+                      elsif script
+                        yaml_script_plan(script)
+                      else
+                        yaml_plan(plan_name)
+                      end
       begin
         File.write(plan_path, plan_template)
       rescue Errno::EACCES => e
@@ -90,7 +105,11 @@ module Bolt
       [prefix, name_segments, basename]
     end
 
-    def self.yaml_plan(plan_name)
+    # Template for a new simple YAML plan.
+    #
+    # @param plan_name [string] The name of the new plan
+    #
+    private_class_method def self.yaml_plan(plan_name)
       <<~YAML
         # This is the structure of a simple plan. To learn more about writing
         # YAML plans, see the documentation: http://pup.pt/bolt-yaml-plans
@@ -119,7 +138,42 @@ module Bolt
       YAML
     end
 
-    def self.puppet_plan(plan_name)
+    # Template for a new YAML plan that runs a script.
+    #
+    # @param script [string] A reference to the script to run.
+    #
+    private_class_method def self.yaml_script_plan(script)
+      <<~YAML
+        # This is the structure of a simple plan. To learn more about writing
+        # YAML plans, see the documentation: http://pup.pt/bolt-yaml-plans
+        
+        # The description sets the description of the plan that will appear
+        # in 'bolt plan show' output.
+        description: A plan created with bolt plan new
+
+        # The parameters key defines the parameters that can be passed to
+        # the plan.
+        parameters:
+          targets:
+            type: TargetSpec
+            description: A list of targets to run actions on
+
+        # The steps key defines the actions the plan will take in order.
+        steps:
+          - name: run_script
+            script: #{script}
+            targets: $targets
+
+        # The return key sets the return value of the plan.
+        return: $run_script
+      YAML
+    end
+
+    # Template for a new simple Puppet plan.
+    #
+    # @param plan_name [string] The name of the new plan
+    #
+    private_class_method def self.puppet_plan(plan_name)
       <<~PUPPET
         # This is the structure of a simple plan. To learn more about writing
         # Puppet plans, see the documentation: http://pup.pt/bolt-puppet-plans
@@ -138,5 +192,28 @@ module Bolt
         }
       PUPPET
     end
+
+    # Template for a new Puppet plan that only runs a script.
+    #
+    # @param plan_name [string] The name of the new plan
+    # @param script [string] A reference to the script to run
+    #
+    private_class_method def self.puppet_script_plan(plan_name, script)
+      <<~PUPPET
+        # This is the structure of a simple plan. To learn more about writing
+        # Puppet plans, see the documentation: http://pup.pt/bolt-puppet-plans
+
+        # The summary sets the description of the plan that will appear
+        # in 'bolt plan show' output. Bolt uses puppet-strings to parse the
+        # summary and parameters from the plan.
+        # @summary A plan created with bolt plan new.
+        # @param targets The targets to run on.
+        plan #{plan_name} (
+          TargetSpec $targets
+        ) {
+          return run_script('#{script}', $targets)
+        }
+      PUPPET
+    end
   end
 end

data/lib/bolt/plan_result.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 require 'json'
-require 'bolt/error'
-require 'bolt/util'
+require_relative '../bolt/error'
+require_relative '../bolt/util'
 
 module Bolt
   class PlanResult

data/lib/bolt/plugin/cache.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 require 'fileutils'
-require 'bolt/error'
-require 'bolt/util'
+require_relative '../../bolt/error'
+require_relative '../../bolt/util'
 
 module Bolt
   class Plugin

data/lib/bolt/plugin/module.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'bolt/task/run'
+require_relative '../../bolt/task/run'
 
 module Bolt
   class Plugin

data/lib/bolt/plugin.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
-require 'bolt/inventory'
-require 'bolt/executor'
-require 'bolt/module'
-require 'bolt/pal'
-require 'bolt/plugin/cache'
-require 'bolt/plugin/puppetdb'
+require_relative '../bolt/inventory'
+require_relative '../bolt/executor'
+require_relative '../bolt/module'
+require_relative '../bolt/pal'
+require_relative 'plugin/cache'
+require_relative 'plugin/puppetdb'
 
 module Bolt
   class Plugin
@@ -127,29 +127,15 @@ module Bolt
       end
     end
 
-    def self.setup(config, pal, analytics = Bolt::Analytics::NoopClient.new, **opts)
-      plugins = new(config, pal, analytics, **opts)
-
-      config.plugins.each_key do |plugin|
-        plugins.by_name(plugin)
-      end
-
-      plugins.plugin_hooks.merge!(plugins.resolve_references(config.plugin_hooks))
-
-      plugins
-    end
-
     RUBY_PLUGINS = %w[task prompt env_var puppetdb puppet_connect_data].freeze
     BUILTIN_PLUGINS = %w[task terraform pkcs7 prompt vault aws_inventory puppetdb azure_inventory
                          yaml env_var gcloud_inventory].freeze
     DEFAULT_PLUGIN_HOOKS = { 'puppet_library' => { 'plugin' => 'puppet_agent', 'stop_service' => true } }.freeze
 
     attr_reader :pal, :plugin_context
-    attr_accessor :plugin_hooks
+    attr_writer :plugin_hooks
 
-    private_class_method :new
-
-    def initialize(config, pal, analytics, load_plugins: true)
+    def initialize(config, pal, analytics = Bolt::Analytics::NoopClient.new, load_plugins: true)
       @config = config
       @analytics = analytics
       @plugin_context = PluginContext.new(config, pal, self)
@@ -166,7 +152,15 @@ module Bolt
         raise Bolt::Error.new(msg, 'bolt/plugin-error')
       end
       @unresolved_plugin_configs['puppetdb'] = config.puppetdb if config.puppetdb
-      @plugin_hooks = DEFAULT_PLUGIN_HOOKS.dup
+    end
+
+    # Returns a map of configured plugin hooks. Any unresolved plugin references
+    # are resolved.
+    #
+    # @return [Hash[String, Hash]]
+    #
+    def plugin_hooks
+      @plugin_hooks ||= DEFAULT_PLUGIN_HOOKS.merge(resolve_references(@config.plugin_hooks))
     end
 
     def modules
@@ -382,4 +376,4 @@ module Bolt
 end
 
 # references PluginError
-require 'bolt/plugin/module'
+require_relative 'plugin/module'

data/lib/bolt/project.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 require 'pathname'
-require 'bolt/config'
-require 'bolt/validator'
-require 'bolt/pal'
-require 'bolt/module'
+require_relative '../bolt/config'
+require_relative '../bolt/validator'
+require_relative '../bolt/pal'
+require_relative '../bolt/module'
 
 module Bolt
   class Project

data/lib/bolt/project_manager/config_migrator.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'bolt/project_manager/migrator'
+require_relative '../../bolt/project_manager/migrator'
 
 module Bolt
   class ProjectManager

data/lib/bolt/project_manager/inventory_migrator.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'bolt/project_manager/migrator'
+require_relative '../../bolt/project_manager/migrator'
 
 module Bolt
   class ProjectManager

data/lib/bolt/project_manager/migrator.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'fileutils'
-require 'bolt/error'
+require_relative '../../bolt/error'
 
 module Bolt
   class ProjectManager

data/lib/bolt/project_manager/module_migrator.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'bolt/project_manager/migrator'
+require_relative '../../bolt/project_manager/migrator'
 
 module Bolt
   class ProjectManager
@@ -43,10 +43,10 @@ module Bolt
       # to the new moduledir.
       #
       private def migrate_modules_from_puppetfile(config, puppetfile_path, managed_moduledir, modulepath)
-        require 'bolt/module_installer/installer'
-        require 'bolt/module_installer/puppetfile'
-        require 'bolt/module_installer/resolver'
-        require 'bolt/module_installer/specs'
+        require_relative '../../bolt/module_installer/installer'
+        require_relative '../../bolt/module_installer/puppetfile'
+        require_relative '../../bolt/module_installer/resolver'
+        require_relative '../../bolt/module_installer/specs'
 
         begin
           @outputter.print_action_step("Parsing Puppetfile at #{puppetfile_path}")

data/lib/bolt/project_manager.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'bolt/project_manager/config_migrator'
-require 'bolt/project_manager/inventory_migrator'
-require 'bolt/project_manager/module_migrator'
+require_relative 'project_manager/config_migrator'
+require_relative 'project_manager/inventory_migrator'
+require_relative 'project_manager/module_migrator'
 
 module Bolt
   class ProjectManager
@@ -36,6 +36,16 @@ module Bolt
       #     ssl: false
     INVENTORY
 
+    GITIGNORE_CONTENT = <<~GITIGNORE
+      .modules/
+      .resource_types/
+      bolt-debug.log
+      .plan_cache.json
+      .plugin_cache.json
+      .task_cache.json
+      .rerun.json
+    GITIGNORE
+
     def initialize(config, outputter, pal)
       @config    = config
       @outputter = outputter
@@ -45,7 +55,7 @@ module Bolt
     # Creates a new project at the specified directory.
     #
     def create(path, name, modules)
-      require 'bolt/module_installer'
+      require_relative '../bolt/module_installer'
 
       project       = Pathname.new(File.expand_path(path))
       old_config    = project + 'bolt.yaml'
@@ -53,6 +63,7 @@ module Bolt
       puppetfile    = project + 'Puppetfile'
       moduledir     = project + '.modules'
       inventoryfile = project + 'inventory.yaml'
+      gitignore     = project + '.gitignore'
       project_name  = name || File.basename(project)
 
       if config.exist?
@@ -125,6 +136,14 @@ module Bolt
         end
       end
 
+      unless gitignore.exist?
+        begin
+          File.write(gitignore.to_path, GITIGNORE_CONTENT)
+        rescue StandardError => e
+          raise Bolt::FileError.new("Could not create .gitignore at #{project}: #{e.message}", nil)
+        end
+      end
+
       @outputter.print_message("Successfully created Bolt project at #{project}")
 
       0

data/lib/bolt/puppetdb/config.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'json'
-require 'bolt/util'
+require_relative '../../bolt/util'
 
 module Bolt
   module PuppetDB

data/lib/bolt/puppetdb.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'bolt/error'
-require 'bolt/puppetdb/client'
-require 'bolt/puppetdb/config'
+require_relative '../bolt/error'
+require_relative 'puppetdb/client'
+require_relative 'puppetdb/config'
 
 module Bolt
   class PuppetDBError < Bolt::Error

data/lib/bolt/result.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'json'
-require 'bolt/error'
+require_relative '../bolt/error'
 
 module Bolt
   class Result

data/lib/bolt/shell/bash.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'bolt/shell/bash/tmpdir'
+require_relative 'bash/tmpdir'
 require 'shellwords'
 
 module Bolt
@@ -94,7 +94,17 @@ module Bolt
           with_tmpdir do |dir|
             path = write_executable(dir.to_s, script)
             dir.chown(run_as)
-            output = execute([path, *arguments], environment: options[:env_vars], sudoable: true)
+
+            exec_args   = [path, *arguments]
+            interpreter = select_interpreter(script, target.options['interpreters'])
+
+            # Only use interpreter if script_interpreter config is enabled
+            if options[:script_interpreter] && interpreter
+              exec_args.unshift(interpreter)
+              logger.trace("Running '#{script}' using '#{interpreter}' interpreter")
+            end
+
+            output = execute(exec_args, environment: options[:env_vars], sudoable: true)
             Bolt::Result.for_command(target,
                                      output.to_h,
                                      'script',

data/lib/bolt/shell/powershell.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'bolt/shell/powershell/snippets'
+require_relative 'powershell/snippets'
 
 module Bolt
   class Shell
@@ -212,7 +212,14 @@ module Bolt
                     elsif powershell_file?(script_path)
                       Snippets.run_script(arguments, script_path)
                     else
-                      path, args = *process_from_extension(script_path)
+                      interpreter = select_interpreter(script_path, target.options['interpreters'])
+                      if options[:script_interpreter] && interpreter
+                        path = interpreter
+                        args = escape_arguments([script_path])
+                        logger.trace("Running '#{script_path}' using '#{interpreter}' interpreter")
+                      else
+                        path, args = *process_from_extension(script_path)
+                      end
                       args += escape_arguments(arguments)
                       execute_process(path, args)
                     end

data/lib/bolt/shell.rb

@@ -101,5 +101,5 @@ module Bolt
   end
 end
 
-require 'bolt/shell/bash'
-require 'bolt/shell/powershell'
+require_relative 'shell/bash'
+require_relative 'shell/powershell'

data/lib/bolt/target.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'bolt/error'
-require 'bolt/util'
+require_relative '../bolt/error'
+require_relative '../bolt/util'
 
 module Bolt
   class Target

data/lib/bolt/transport/base.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'logging'
-require 'bolt/result'
+require_relative '../../bolt/result'
 
 module Bolt
   module Transport

data/lib/bolt/transport/docker/connection.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'logging'
-require 'bolt/node/errors'
+require_relative '../../../bolt/node/errors'
 
 module Bolt
   module Transport

data/lib/bolt/transport/docker.rb

@@ -2,7 +2,7 @@
 
 require 'json'
 require 'shellwords'
-require 'bolt/transport/simple'
+require_relative '../../bolt/transport/simple'
 
 module Bolt
   module Transport
@@ -20,4 +20,4 @@ module Bolt
   end
 end
 
-require 'bolt/transport/docker/connection'
+require_relative 'docker/connection'

data/lib/bolt/transport/local/connection.rb

@@ -3,8 +3,8 @@
 require 'open3'
 require 'fileutils'
 require 'tempfile'
-require 'bolt/node/output'
-require 'bolt/util'
+require_relative '../../../bolt/node/output'
+require_relative '../../../bolt/util'
 
 module Bolt
   module Transport

data/lib/bolt/transport/local.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'bolt/logger'
-require 'bolt/transport/simple'
+require_relative '../../bolt/logger'
+require_relative '../../bolt/transport/simple'
 
 module Bolt
   module Transport
@@ -21,4 +21,4 @@ module Bolt
   end
 end
 
-require 'bolt/transport/local/connection'
+require_relative 'local/connection'

data/lib/bolt/transport/lxd/connection.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'logging'
-require 'bolt/node/errors'
+require_relative '../../../bolt/node/errors'
 
 module Bolt
   module Transport

data/lib/bolt/transport/lxd.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'bolt/logger'
-require 'bolt/node/errors'
-require 'bolt/transport/simple'
+require_relative '../../bolt/logger'
+require_relative '../../bolt/node/errors'
+require_relative '../../bolt/transport/simple'
 
 module Bolt
   module Transport
@@ -23,4 +23,4 @@ module Bolt
   end
 end
 
-require 'bolt/transport/lxd/connection'
+require_relative 'lxd/connection'

data/lib/bolt/transport/orch.rb

@@ -4,8 +4,8 @@ require 'base64'
 require 'find'
 require 'json'
 require 'pathname'
-require 'bolt/transport/base'
-require 'bolt/transport/orch/connection'
+require_relative '../../bolt/transport/base'
+require_relative 'orch/connection'
 
 module Bolt
   module Transport

data/lib/bolt/transport/podman/connection.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'logging'
-require 'bolt/node/errors'
+require_relative '../../../bolt/node/errors'
 
 module Bolt
   module Transport