bolt 3.16.1 → 3.20.0

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.16.1'
+  VERSION = '3.20.0'
 end

data/lib/bolt.rb

@@ -4,5 +4,5 @@
 require 'logging_extensions/logging'
 
 module Bolt
-  require 'bolt/executor'
+  require_relative 'bolt/executor'
 end

data/lib/bolt_server/transport_app.rb

@@ -184,6 +184,7 @@ module BoltServer
             search_dirs << mod.pluginfacts if mod.pluginfacts?
             if tarball_type == 'all_plugins'
               search_dirs << mod.files if mod.files?
+              search_dirs << mod.scripts if mod.scripts?
               type_files = "#{mod.path}/types"
               search_dirs << type_files if File.exist?(type_files)
             end
@@ -413,6 +414,8 @@ module BoltServer
           'path' => case mount_segment
                     when 'files'
                       "/puppet/v3/file_content/modules/#{module_segment}/#{name_segment}"
+                    when 'scripts'
+                      "/puppet/v3/file_content/scripts/#{module_segment}/#{name_segment}"
                     when 'tasks'
                       "/puppet/v3/file_content/tasks/#{module_segment}/#{name_segment}"
                     when 'lib'
@@ -462,28 +465,46 @@ module BoltServer
     end
 
     def file_metadatas(versioned_project, module_name, file)
-      abs_file_path = @pal_mutex.synchronize do
+      result = @pal_mutex.synchronize do
         bolt_config = config_from_project(versioned_project)
         pal = pal_from_project_bolt_config(bolt_config)
         pal.in_bolt_compiler do
           mod = Puppet.lookup(:current_environment).module(module_name)
           raise BoltServer::RequestError, "module_name: '#{module_name}' does not exist" unless mod
-          mod.file(file)
+          # First, look in the 'old' location <module>/files/<path>.
+          # If not found, and the path starts with `files` or `scripts`, munge
+          # the path and look inside that directory.
+          if (abs_path = mod.file(file))
+            { abs_file_path: abs_path, puppetserver_root: "modules/#{module_name}/#{file}" }
+          else
+            subdir, relative_path = file.split(File::SEPARATOR, 2)
+            abs_path, mount = case subdir
+                              when 'files'
+                                [mod.file(relative_path), 'modules']
+                              when 'scripts'
+                                [mod.script(relative_path), 'scripts']
+                              end
+            next nil unless abs_path
+            { abs_file_path: abs_path, puppetserver_root: "#{mount}/#{module_name}/#{relative_path}" }
+          end
         end
       end
 
-      unless abs_file_path
+      unless result
         raise BoltServer::RequestError,
-              "file: '#{file}' does not exist inside the module's 'files' directory"
+              "file: '#{file}' does not exist inside #{module_name} 'files' or 'scripts' directories"
       end
 
+      abs_file_path = result[:abs_file_path]
+      puppetserver_root = result[:puppetserver_root]
+
       fileset = Puppet::FileServing::Fileset.new(abs_file_path, 'recurse' => 'yes')
       Puppet::FileServing::Fileset.merge(fileset).collect do |relative_file_path, base_path|
         metadata = Puppet::FileServing::Metadata.new(base_path, relative_path: relative_file_path)
         metadata.checksum_type = 'sha256'
         metadata.links = 'follow'
         metadata.collect
-        metadata.to_data_hash
+        metadata.to_data_hash.merge(puppetserver_root: puppetserver_root)
       end
     end
 
@@ -832,7 +853,7 @@ module BoltServer
           }
 
           connect_plugin = BoltServer::Plugin::PuppetConnectData.new(body['puppet_connect_data'])
-          plugins = Bolt::Plugin.setup(context[:config], context[:pal], load_plugins: false)
+          plugins = Bolt::Plugin.new(context[:config], context[:pal], load_plugins: false)
           plugins.add_plugin(connect_plugin)
           %w[aws_inventory azure_inventory gcloud_inventory].each do |plugin_name|
             plugins.add_module_plugin(plugin_name) if plugins.known_plugin?(plugin_name)

data/lib/bolt_spec/bolt_context.rb

@@ -39,13 +39,15 @@ require 'bolt/plugin'
 #
 # Stubs:
 # - allow_command(cmd), expect_command(cmd): expect the exact command
-# - allow_script(script), expect_script(script): expect the script as <module>/path/to/file
+# - allow_script(script), expect_script(script): expect the script as <module>/path/to/file or an absolute path
 # - allow_task(task), expect_task(task): expect the named task
 # - allow_download(file), expect_download(file): expect the identified source file
-# - allow_upload(file), expect_upload(file): expect the identified source file
+# - allow_upload(file), expect_upload(file): expect the source file as <module>/path/to/file or an absolute path
 # - allow_out_message, expect_out_message: expect a message to be passed to out::message (only modifiers are
 #   be_called_times(n), with_params(params), and not_be_called)
 #
+# Files with absolute path (for upload and script) must exist or those functions will fail.
+#
 # Stub modifiers:
 # - be_called_times(n): if allowed, fail if the action is called more than 'n' times
 #                       if expected, fail unless the action is called 'n' times
@@ -154,7 +156,7 @@ module BoltSpec
     end
 
     def plugins
-      @plugins ||= Bolt::Plugin.setup(config, pal)
+      @plugins ||= Bolt::Plugin.new(config, pal)
     end
 
     def pal
@@ -211,8 +213,8 @@ module BoltSpec
     # def allow_script(script_name)
     #
     # file uploads and downloads have a single destination and no arguments
-    # def allow_file_upload(source_name)
-    # def allow_file_download(source_name)
+    # def allow_upload(source_name)
+    # def allow_download(source_name)
     #
     # Most of the information in commands is in the command string itself
     # we may need more flexible allows than just the name/command string

data/lib/bolt_spec/plans/mock_executor.rb

@@ -44,7 +44,7 @@ module BoltSpec
 
       def module_file_id(file)
         modpath = @modulepath.select { |path| file =~ /^#{path}/ }
-        raise "Could not identify modulepath containing #{file}: #{modpath}" unless modpath.size == 1
+        return nil unless modpath.size == 1
 
         path = Pathname.new(file)
         relative = path.relative_path_from(Pathname.new(modpath.first))
@@ -66,7 +66,7 @@ module BoltSpec
       end
 
       def run_script(targets, script_path, arguments, options = {}, _position = [])
-        script = module_file_id(script_path)
+        script = module_file_id(script_path) || script_path
         result = nil
         if (doub = @script_doubles[script] || @script_doubles[:default])
           result = doub.process(targets, script, arguments, options)
@@ -116,7 +116,7 @@ module BoltSpec
       end
 
       def upload_file(targets, source_path, destination, options = {}, _position = [])
-        source = module_file_id(source_path)
+        source = module_file_id(source_path) || source_path
         result = nil
         if (doub = @upload_doubles[source] || @upload_doubles[:default])
           result = doub.process(targets, source, destination, options)

data/lib/bolt_spec/run.rb

@@ -171,7 +171,7 @@ module BoltSpec
       end
 
       def plugins
-        @plugins ||= Bolt::Plugin.setup(config, pal)
+        @plugins ||= Bolt::Plugin.new(config, pal)
       end
 
       def puppetdb_client

data/libexec/bolt_catalog

@@ -59,7 +59,7 @@ when "compile"
     puts({ message: message, backtrace: e.backtrace }.to_json)
     exit 1
   rescue StandardError => e
-    puts({ message: e.message }.to_json)
+    puts({ message: e.message, backtrace: e.backtrace }.to_json)
     exit 1
   end
 else

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bolt
 version: !ruby/object:Gem::Version
-  version: 3.16.1
+  version: 3.20.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-16 00:00:00.000000000 Z
+date: 2021-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -260,14 +260,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.10'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: ruby_smb
   requirement: !ruby/object:Gem::Requirement
@@ -288,14 +288,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: winrm
   requirement: !ruby/object:Gem::Requirement