bolt 3.17.0 → 3.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '05192d9aa9b3da414b55a21bd75fe10238e8044eb49f75f92be7fac1d0576866'
-  data.tar.gz: 49302c6d080fda48080d5281c9480ce35a734caefa5be9f6f141aaea51f99b70
+  metadata.gz: 161a4fa9b8f36d32bd32964eeab21d3df8588e900f18999ee3ea9f0d56d56aec
+  data.tar.gz: bd8e0f955123e73058904f8e22335a516f1f41dcb5e8bdf4e7ad9bc0c01fe212
 SHA512:
-  metadata.gz: bd0966b7be3a7bba5a1bb0f040a2e8bd8c22708fa1a79492f04b8448037105ac66e12af74969787d3ab4efa69bfcd393c51168154c548d7d35f6f36fc6648c0c
-  data.tar.gz: e7f2741c6e7a2416ebbc61f7f008e1a550bde1897e906e53a8df0dc837cd4fcb0718c783f301cdbde1703ed95a65530cbad9e727ae5978a6c414988bc0206e23
+  metadata.gz: 7b27fc4df0159d56610a5c2ebadd0a78234bc4e88815b2705f1000400f786079bddbcff37544024a81bc221afc48c60cfd884d2cee7f18018df1644dc7370548
+  data.tar.gz: 42c757fd3f406760d7b8d01809568270e92fb1ff57771ac07d392e26dd04be2f340a845906b7ea039e095e72e66bf37d56762b4e067db12eedb6773ffd47f492

data/Puppetfile

@@ -5,31 +5,31 @@ forge "http://forge.puppetlabs.com"
 moduledir File.join(File.dirname(__FILE__), 'modules')
 
 # Core modules used by 'apply'
-mod 'puppetlabs-service', '2.0.0'
-mod 'puppetlabs-puppet_agent', '4.8.0'
+mod 'puppetlabs-service', '2.1.0'
+mod 'puppetlabs-puppet_agent', '4.9.0'
 mod 'puppetlabs-facts', '1.4.0'
 
 # Core types and providers for Puppet 6
-mod 'puppetlabs-augeas_core', '1.1.2'
-mod 'puppetlabs-host_core', '1.0.3'
+mod 'puppetlabs-augeas_core', '1.2.0'
+mod 'puppetlabs-host_core', '1.1.0'
 mod 'puppetlabs-scheduled_task', '3.0.1'
-mod 'puppetlabs-sshkeys_core', '2.2.0'
-mod 'puppetlabs-zfs_core', '1.2.0'
-mod 'puppetlabs-cron_core', '1.0.5'
-mod 'puppetlabs-mount_core', '1.0.4'
-mod 'puppetlabs-selinux_core', '1.1.0'
-mod 'puppetlabs-yumrepo_core', '1.0.7'
+mod 'puppetlabs-sshkeys_core', '2.3.0'
+mod 'puppetlabs-zfs_core', '1.3.0'
+mod 'puppetlabs-cron_core', '1.1.0'
+mod 'puppetlabs-mount_core', '1.1.0'
+mod 'puppetlabs-selinux_core', '1.2.0'
+mod 'puppetlabs-yumrepo_core', '1.1.0'
 mod 'puppetlabs-zone_core', '1.0.3'
 
 # Useful additional modules
-mod 'puppetlabs-package', '2.0.0'
+mod 'puppetlabs-package', '2.1.0'
 mod 'puppetlabs-powershell_task_helper', '0.1.0'
-mod 'puppetlabs-puppet_conf', '1.1.0'
+mod 'puppetlabs-puppet_conf', '1.2.0'
 mod 'puppetlabs-python_task_helper', '0.5.0'
-mod 'puppetlabs-reboot', '4.0.2'
+mod 'puppetlabs-reboot', '4.1.0'
 mod 'puppetlabs-ruby_task_helper', '0.6.0'
 mod 'puppetlabs-ruby_plugin_helper', '0.2.0'
-mod 'puppetlabs-stdlib', '7.1.0'
+mod 'puppetlabs-stdlib', '8.1.0'
 
 # Plugin modules
 mod 'puppetlabs-aws_inventory', '0.7.0'

data/bolt-modules/boltlib/lib/puppet/functions/run_script.rb

@@ -108,11 +108,8 @@ Puppet::Functions.create_function(:run_script, Puppet::Functions::InternalFuncti
     # Send Analytics Report
     executor.report_function_call(self.class.name)
 
-    future = executor&.future || {}
-    fallback = future.fetch('file_paths', false)
-
     # Find the file path if it exists, otherwise return nil
-    found = Bolt::Util.find_file_from_scope(script, scope, fallback)
+    found = Bolt::Util.find_file_from_scope(script, scope)
     unless found && Puppet::FileSystem.exist?(found)
       raise Puppet::ParseErrorWithIssue.from_issue_and_stack(
         Puppet::Pops::Issues::NO_SUCH_FILE_OR_DIRECTORY, file: script

data/bolt-modules/boltlib/lib/puppet/functions/upload_file.rb

@@ -70,11 +70,8 @@ Puppet::Functions.create_function(:upload_file, Puppet::Functions::InternalFunct
     # Send Analytics Report
     executor.report_function_call(self.class.name)
 
-    future = executor&.future || {}
-    fallback = future.fetch('file_paths', false)
-
     # Find the file path if it exists, otherwise return nil
-    found = Bolt::Util.find_file_from_scope(source, scope, fallback)
+    found = Bolt::Util.find_file_from_scope(source, scope)
     unless found && Puppet::FileSystem.exist?(found)
       raise Puppet::ParseErrorWithIssue.from_issue_and_stack(
         Puppet::Pops::Issues::NO_SUCH_FILE_OR_DIRECTORY, file: source

data/bolt-modules/file/lib/puppet/functions/file/exists.rb

@@ -21,11 +21,8 @@ Puppet::Functions.create_function(:'file::exists', Puppet::Functions::InternalFu
     executor = Puppet.lookup(:bolt_executor) {}
     executor&.report_function_call(self.class.name)
 
-    future = executor&.future || Puppet.lookup(:future) { {} }
-    fallback = future.fetch('file_paths', false)
-
     # Find the file path if it exists, otherwise return nil
-    found = Bolt::Util.find_file_from_scope(filename, scope, fallback)
+    found = Bolt::Util.find_file_from_scope(filename, scope)
     found ? Puppet::FileSystem.exist?(found) : false
   end
 end

data/bolt-modules/file/lib/puppet/functions/file/read.rb

@@ -20,11 +20,8 @@ Puppet::Functions.create_function(:'file::read', Puppet::Functions::InternalFunc
     executor = Puppet.lookup(:bolt_executor) {}
     executor&.report_function_call(self.class.name)
 
-    future = executor&.future || Puppet.lookup(:future) { {} }
-    fallback = future.fetch('file_paths', false)
-
     # Find the file path if it exists, otherwise return nil
-    found = Bolt::Util.find_file_from_scope(filename, scope, fallback)
+    found = Bolt::Util.find_file_from_scope(filename, scope)
     unless found && Puppet::FileSystem.exist?(found)
       raise Puppet::ParseErrorWithIssue.from_issue_and_stack(
         Puppet::Pops::Issues::NO_SUCH_FILE_OR_DIRECTORY, file: filename

data/bolt-modules/file/lib/puppet/functions/file/readable.rb

@@ -21,11 +21,8 @@ Puppet::Functions.create_function(:'file::readable', Puppet::Functions::Internal
     executor = Puppet.lookup(:bolt_executor) {}
     executor&.report_function_call(self.class.name)
 
-    future = executor&.future || Puppet.lookup(:future) { {} }
-    fallback = future.fetch('file_paths', false)
-
     # Find the file path if it exists, otherwise return nil
-    found = Bolt::Util.find_file_from_scope(filename, scope, fallback)
+    found = Bolt::Util.find_file_from_scope(filename, scope)
     found ? File.readable?(found) : false
   end
 end

data/lib/bolt/analytics.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'bolt/util'
-require 'bolt/version'
+require_relative '../bolt/util'
+require_relative '../bolt/version'
 require 'find'
 require 'json'
 require 'logging'

data/lib/bolt/application.rb

@@ -2,8 +2,8 @@
 
 require 'benchmark'
 
-require 'bolt/plan_creator'
-require 'bolt/util'
+require_relative '../bolt/plan_creator'
+require_relative '../bolt/util'
 
 module Bolt
   class Application
@@ -258,7 +258,7 @@ module Bolt
                     config.project.puppetfile,
                     config.project.managed_moduledir,
                     config.project.project_file,
-                    config.module_install)
+                    @plugins.resolve_references(config.module_install))
     end
 
     # Generate Puppet data types from project modules.
@@ -292,7 +292,7 @@ module Bolt
       installer.install(config.project.modules,
                         config.project.puppetfile,
                         config.project.managed_moduledir,
-                        config.module_install,
+                        @plugins.resolve_references(config.module_install),
                         force: force,
                         resolve: resolve)
     end
@@ -333,12 +333,6 @@ module Bolt
     def new_plan(name, puppet: false, plan_script: nil)
       Bolt::PlanCreator.validate_plan_name(config.project, name)
 
-      if plan_script && !config.future&.fetch('file_paths', false)
-        raise Bolt::CLIError,
-              "The --script flag can only be used if future.file_paths is " \
-              "configured in bolt-project.yaml."
-      end
-
       if plan_script
         Bolt::Util.validate_file('script', find_file(plan_script))
       end
@@ -419,6 +413,178 @@ module Bolt
       { plugins: plugins.list_plugins, modulepath: pal.user_modulepath }
     end
 
+    # Applies one or more policies to the specified targets.
+    #
+    # @param policies [String] A comma-separated list of policies to apply.
+    # @param targets [Array[String]] The list of targets to apply the policies to.
+    # @param noop [Boolean] Whether to apply the policies in no-operation mode.
+    # @return [Bolt::ResultSet]
+    #
+    def apply_policies(policies, targets, noop: false)
+      policies = policies.split(',')
+
+      # Validate that the policies are available to the project.
+      unavailable_policies = policies.reject do |policy|
+        @config.policies&.any? do |known_policy|
+          File.fnmatch?(known_policy, policy, File::FNM_EXTGLOB)
+        end
+      end
+
+      if unavailable_policies.any?
+        command = Bolt::Util.powershell? ? 'Get-BoltPolicy' : 'bolt policy show'
+
+        # CODEREVIEW: Phrasing
+        raise Bolt::Error.new(
+          "The following policies are not available to the project: '#{unavailable_policies.join("', '")}'. "\
+          "You must list policies in a project's 'policies' setting before Bolt can apply them to targets. "\
+          "For a list of policies available to the project, run '#{command}'.",
+          'bolt/unavailable-policy-error'
+        )
+      end
+
+      # Validate that the policies are loadable Puppet classes.
+      unloadable_policies = []
+
+      @pal.in_catalog_compiler do |_|
+        environment = Puppet.lookup(:current_environment)
+
+        unloadable_policies = policies.reject do |policy|
+          environment.known_resource_types.find_hostclass(policy)
+        end
+      end
+
+      # CODEREVIEW: Phrasing
+      if unloadable_policies.any?
+        raise Bolt::Error.new(
+          "The following policies cannot be loaded: '#{unloadable_policies.join("', '")}'. "\
+          "Policies must be a Puppet class saved to a project's or module's manifests directory.",
+          'bolt/unloadable-policy-error'
+        )
+      end
+
+      # Execute a single include statement with all the policies to apply them
+      # to the targets. Yay, reusable code!
+      apply(nil, targets, code: "include #{policies.join(', ')}", noop: noop)
+    end
+
+    # Add a new policy to the project.
+    #
+    # @param name [String] The name of the new policy.
+    # @return [Hash]
+    #
+    def new_policy(name)
+      # Validate the policy name
+      unless name =~ Bolt::Module::CONTENT_NAME_REGEX
+        message = <<~MESSAGE.chomp
+          Invalid policy name '#{name}'. Policy names are composed of one or more name segments
+          separated by double colons '::'.
+
+          Each name segment must begin with a lowercase letter, and can only include lowercase
+          letters, digits, and underscores.
+
+          Examples of valid policy names:
+              - #{@config.project.name}
+              - #{@config.project.name}::my_policy
+        MESSAGE
+
+        raise Bolt::ValidationError, message
+      end
+
+      # Validate that we're not running with the default project
+      if @config.project.name.nil?
+        command = Bolt::Util.powershell? ? 'New-BoltProject -Name <NAME>' : 'bolt project init <NAME>'
+        message = <<~MESSAGE.chomp
+          Can't create a policy for the default Bolt project because it doesn't
+          have a name. Run '#{command}' to create a new project.
+        MESSAGE
+        raise Bolt::ValidationError, message
+      end
+
+      prefix, *name_segments, basename = name.split('::')
+
+      # Error if name is not namespaced to project
+      unless prefix == @config.project.name
+        raise Bolt::ValidationError,
+              "Policy name '#{name}' must begin with project name '#{@config.project.name}'. Did "\
+              "you mean '#{@config.project.name}::#{name}'?"
+      end
+
+      # If the policy name is just the project name, use the special init.pp class
+      basename ||= 'init'
+
+      # Policies can be saved in subdirectories in the 'manifests/' directory
+      policy_dir = File.expand_path(File.join(name_segments), @config.project.manifests)
+      policy     = File.expand_path("#{basename}.pp", policy_dir)
+
+      # Ensure the policy does not already exist
+      if File.exist?(policy)
+        raise Bolt::Error.new(
+          "A policy with the name '#{name}' already exists at '#{policy}', nothing to do.",
+          'bolt/existing-policy-error'
+        )
+      end
+
+      # Create the policy directory structure in the current project
+      begin
+        FileUtils.mkdir_p(policy_dir)
+      rescue Errno::EEXIST => e
+        raise Bolt::Error.new(
+          "#{e.message}; unable to create manifests directory '#{policy_dir}'",
+          'bolt/existing-file-error'
+        )
+      end
+
+      # Create the new policy
+      begin
+        File.write(policy, <<~POLICY)
+          class #{name} {
+
+          }
+        POLICY
+      rescue Errno::EACCES => e
+        raise Bolt::FileError.new("#{e.message}; unable to create policy", policy)
+      end
+
+      # Update the project configuration to include the new policy
+      project_config = Bolt::Util.read_yaml_hash(@config.project.project_file, 'project config')
+
+      # Add the 'policies' key if it does not exist and de-dupiclate entries
+      project_config['policies'] ||= []
+      project_config['policies'] <<  name
+      project_config['policies'].uniq!
+
+      begin
+        File.write(@config.project.project_file, project_config.to_yaml)
+      rescue Errno::EACCES => e
+        raise Bolt::FileError.new(
+          "#{e.message}; unable to update project configuration",
+          @config.project.project_file
+        )
+      end
+
+      { name: name, path: policy }
+    end
+
+    # List policies available to the project.
+    #
+    # @return [Hash]
+    #
+    def list_policies
+      unless @config.policies
+        command = Bolt::Util.powershell? ? 'New-BoltPolicy -Name <NAME>' : 'bolt policy new <NAME>'
+
+        raise Bolt::Error.new(
+          "Project configuration file #{@config.project.project_file} does not "\
+          "specify any policies. You can add policies to the project by including "\
+          "a 'policies' key or creating a new policy using the '#{command}' "\
+          "command.",
+          'bolt/no-policies-error'
+        )
+      end
+
+      { policies: @config.policies.uniq, modulepath: pal.user_modulepath }
+    end
+
     # Initialize the current directory as a Bolt project.
     #
     # @param name [String] The name of the project.
@@ -575,11 +741,10 @@ module Bolt
       modulepath = Bolt::Config::Modulepath.new(config.modulepath)
       modules    = Bolt::Module.discover(modulepath.full_modulepath, config.project)
       mod, file  = path.split(File::SEPARATOR, 2)
-      future     = executor.future&.fetch('file_paths', false)
 
       if modules[mod]
         logger.debug("Did not find file at #{File.expand_path(path)}, checking in module '#{mod}'")
-        found = Bolt::Util.find_file_in_module(modules[mod].path, file || "", future)
+        found = Bolt::Util.find_file_in_module(modules[mod].path, file || "")
         path  = found.nil? ? File.join(modules[mod].path, 'files', file) : found
       end
 

data/lib/bolt/applicator.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 require 'base64'
-require 'bolt/apply_result'
-require 'bolt/apply_target'
-require 'bolt/config'
-require 'bolt/error'
-require 'bolt/task'
-require 'bolt/util/puppet_log_level'
+require_relative '../bolt/apply_result'
+require_relative '../bolt/apply_target'
+require_relative '../bolt/config'
+require_relative '../bolt/error'
+require_relative '../bolt/task'
+require_relative '../bolt/util/puppet_log_level'
 require 'find'
 require 'json'
 require 'logging'
@@ -239,6 +239,7 @@ module Bolt
           search_dirs << mod.plugins if mod.plugins?
           search_dirs << mod.pluginfacts if mod.pluginfacts?
           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)
           search_dirs

data/lib/bolt/apply_inventory.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'bolt/project'
-require 'bolt/config'
-require 'bolt/error'
+require_relative '../bolt/project'
+require_relative '../bolt/config'
+require_relative '../bolt/error'
 
 module Bolt
   class ApplyInventory

data/lib/bolt/apply_result.rb

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