bolt 3.17.0 → 3.21.0

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
@@ -376,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
@@ -14,7 +14,8 @@ module Bolt
     attr_reader :path, :data, :inventory_file, :hiera_config,
                 :puppetfile, :rerunfile, :type, :resource_types, :project_file,
                 :downloads, :plans_path, :modulepath, :managed_moduledir,
-                :backup_dir, :plugin_cache_file, :plan_cache_file, :task_cache_file
+                :backup_dir, :plugin_cache_file, :plan_cache_file, :task_cache_file,
+                :manifests
 
     def self.default_project
       create_project(File.expand_path(File.join('~', '.puppetlabs', 'bolt')), 'user')
@@ -116,6 +117,7 @@ module Bolt
       @plan_cache_file   = @path + '.plan_cache.json'
       @task_cache_file   = @path + '.task_cache.json'
       @modulepath        = [(@path + 'modules').to_s]
+      @manifests         = @path + 'manifests'
 
       if (tc = Bolt::Config::INVENTORY_OPTIONS.keys & data.keys).any?
         Bolt::Logger.warn(

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).flatten!
+              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',
@@ -244,7 +254,7 @@ module Bolt
         if interpreter
           StringIO.new(<<~SCRIPT)
             #!/bin/sh
-            '#{interpreter}' '#{task_path}' <<'EOF'
+            #{Array(interpreter).map { |word| "'#{word}'" }.join(' ')} '#{task_path}' <<'EOF'
             #{stdin}
             EOF
           SCRIPT
@@ -325,11 +335,7 @@ module Bolt
       # Returns string with the interpreter conditionally prepended
       def inject_interpreter(interpreter, command)
         if interpreter
-          if command.is_a?(Array)
-            command.unshift(interpreter)
-          else
-            command = [interpreter, command]
-          end
+          command = Array(command).unshift(interpreter).flatten
         end
 
         command.is_a?(String) ? command : Shellwords.shelljoin(command)

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,20 @@ 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
+                        # interpreter can be a String or Array here. Cast it to an array.
+                        interpreter_array = Array(interpreter)
+                        # Make path the first part of the array - this should be the binary
+                        path = interpreter_array.shift
+                        # Anything else in interpreters should get prepended to
+                        # the command. If interpreters was a string this will
+                        # just be [script_path]
+                        args = escape_arguments(interpreter_array + Array(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
@@ -261,8 +274,14 @@ module Bolt
                       run_ps_task(task_path, arguments, input_method)
                     else
                       if (interpreter = select_interpreter(task_path, target.options['interpreters']))
-                        path = interpreter
-                        args = [task_path]
+                        # interpreter can be a String or Array here. Cast it to an array.
+                        interpreter_array = Array(interpreter)
+                        # Make path the first part of the array - this should be the binary
+                        path = interpreter_array.shift
+                        # Anything else in interpreters should get prepended to
+                        # the command. If interpreters was a string this will
+                        # just be [task_path]
+                        args = interpreter_array + [task_path]
                       else
                         path, args = *process_from_extension(task_path)
                       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

data/lib/bolt/transport/podman.rb

@@ -2,7 +2,7 @@
 
 require 'json'
 require 'shellwords'
-require 'bolt/transport/base'
+require_relative '../../bolt/transport/base'
 
 module Bolt
   module Transport
@@ -16,4 +16,4 @@ module Bolt
   end
 end
 
-require 'bolt/transport/podman/connection'
+require_relative 'podman/connection'

data/lib/bolt/transport/remote.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'bolt/task'
-require 'bolt/transport/base'
+require_relative '../../bolt/task'
+require_relative '../../bolt/transport/base'
 
 module Bolt
   module Transport

data/lib/bolt/transport/simple.rb

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

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

@@ -2,9 +2,9 @@
 
 require 'logging'
 require 'shellwords'
-require 'bolt/node/errors'
-require 'bolt/node/output'
-require 'bolt/util'
+require_relative '../../../bolt/node/errors'
+require_relative '../../../bolt/node/output'
+require_relative '../../../bolt/util'
 
 module Bolt
   module Transport

data/lib/bolt/transport/ssh.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
@@ -44,5 +44,5 @@ module Bolt
   end
 end
 
-require 'bolt/transport/ssh/connection'
-require 'bolt/transport/ssh/exec_connection'
+require_relative 'ssh/connection'
+require_relative 'ssh/exec_connection'

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

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

data/lib/bolt/transport/winrm.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'bolt/node/errors'
-require 'bolt/transport/base'
+require_relative '../../bolt/node/errors'
+require_relative '../../bolt/transport/base'
 
 module Bolt
   module Transport
@@ -30,4 +30,4 @@ module Bolt
   end
 end
 
-require 'bolt/transport/winrm/connection'
+require_relative 'winrm/connection'

data/lib/bolt/util.rb

@@ -65,6 +65,9 @@ module Bolt
         raise Bolt::FileError.new("Could not parse #{file_name} file at #{path}, line #{e.line}, "\
                                   "column #{e.column}\n#{e.problem}",
                                   path)
+      rescue Psych::BadAlias => e
+        raise Bolt::FileError.new('Bolt does not support the use of aliases in YAML files. Alias '\
+                                  "detected in #{file_name} file at #{path}\n#{e.message}", path)
       rescue Psych::Exception => e
         raise Bolt::FileError.new("Could not parse #{file_name} file at #{path}\n#{e.message}",
                                   path)
@@ -103,7 +106,7 @@ module Bolt
       # absolute path or Puppet module syntax lookup. Returns the path to the
       # file if found, or nil.
       #
-      def find_file_from_scope(file, scope, fallback = false)
+      def find_file_from_scope(file, scope)
         # If we got an absolute path, just return that.
         return file if Pathname.new(file).absolute?
 
@@ -112,44 +115,21 @@ module Bolt
         mod_path = scope.compiler.environment.module(module_name)&.path
 
         # Search the module for the file, falling back to new-style paths if enabled.
-        find_file_in_module(mod_path, file_pattern, fallback) if mod_path
+        search_module(mod_path, file_pattern) if mod_path
       end
 
-      # This method is used by Bolt to find files when provided a
-      # module-style path without loading Puppet. It takes the absolute path to
-      # the module root and the module-style path minus the module name and
-      # searches subdirectories in the module in order of precedence.
+      # This searches a module for files under 'files/' or 'scripts/', falling
+      # back to the new style of file loading. It takes the absolute path to the
+      # module root and the relative path provided by the user.
       #
-      def find_file_in_module(module_path, module_file, fallback = false)
-        # If the first part of the path is 'scripts' or 'files', the path may
-        # be a new-style file location and should fall back to the new path.
-        subdir_or_file = split_path(module_file).first
-        case subdir_or_file
-          # For any subdirs that may indicate the user passed a new-style path,
-          # first look in 'mymod/files/<relative_path>' (old-style) then fall
-          # back to 'mymod/<relative_path>' (new-style) if enabled.
-        when 'scripts', 'files'
-          search_module(module_path, module_file, fallback)
-        else
-          # If the path definitely isn't new-style, only look in the 'files/'
-          # directory.
-          search_module(module_path, module_file)
-        end
-      end
-
-      # This searches a module for files under 'files/' or 'scripts/',
-      # optionally falling back to the new style of file loading. It takes the
-      # absolute path to the module root, the relative path provided by the
-      # user, and whether to fall back to the new-style script loading if the
-      # file isn't found in 'files/'.
-      #
-      private def search_module(module_path, module_file, fallback = false)
+      def search_module(module_path, module_file)
         if File.exist?(File.join(module_path, 'files', module_file))
           File.join(module_path, 'files', module_file)
-        elsif File.exist?(File.join(module_path, module_file)) && fallback
+        elsif File.exist?(File.join(module_path, module_file))
           File.join(module_path, module_file)
         end
       end
+      alias find_file_in_module search_module
 
       # Copied directly from puppet/lib/puppet/parser/files.rb
       #

data/lib/bolt/validator.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'bolt/error'
+require_relative '../bolt/error'
 
 # This class validates config against a schema, raising an error that includes
 # details about any invalid configuration.

data/lib/bolt/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Bolt
-  VERSION = '3.17.0'
+  VERSION = '3.21.0'
 end