bolt 2.31.0 → 2.35.0

data/lib/bolt/pal/yaml_plan.rb

@@ -45,6 +45,13 @@ module Bolt
         used_names = Set.new(@parameters.map(&:name))
 
         @steps = plan['steps'].each_with_index.map do |step, index|
+          unless step.is_a?(Hash)
+            raise Bolt::Error.new(
+              "Parse error in step number #{index + 1}: Plan step must be an object with valid step keys.",
+              'bolt/invalid-plan'
+            )
+          end
+
           # Step keys also aren't allowed to be code and neither is the value of "name"
           stringified_step = Bolt::Util.walk_keys(step) { |key| stringify(key) }
           stringified_step['name'] = stringify(stringified_step['name']) if stringified_step.key?('name')
@@ -98,10 +105,12 @@ module Bolt
       # subclasses this parent class in order to implement its own evaluation
       # logic.
       class EvaluableString
-        attr_reader :value
+        attr_reader :file, :line, :value
 
-        def initialize(value)
+        def initialize(value, file = nil, line = nil)
           @value = value
+          @file  = file
+          @line  = line
         end
 
         def ==(other)

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

@@ -191,7 +191,11 @@ module Bolt
               o[key] = evaluate_code_blocks(scope, v)
             end
           when EvaluableString
-            value.evaluate(scope, @evaluator)
+            begin
+              value.evaluate(scope, @evaluator)
+            rescue StandardError => e
+              raise format_evaluate_error(e, value)
+            end
           else
             value
           end
@@ -203,6 +207,24 @@ module Bolt
         def evaluate(value, _scope)
           value
         end
+
+        def format_evaluate_error(error, value)
+          # The Puppet::PreformattedError includes the line number of the
+          # evaluable string that caused the error, while the value includes the
+          # line number of the YAML plan that the string began on. To get the
+          # actual line number of the error, add these two numbers together.
+          line = error.line + value.line
+
+          # If the evaluable string is not a scalar literal, correct for it
+          # being on the same line as the step key.
+          line -= 1 if value.is_a?(BareString)
+
+          Bolt::PlanFailure.new(
+            error.basic_message,
+            'bolt/evaluation-error',
+            { file: value.file, line: line }
+          )
+        end
       end
     end
   end

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

@@ -9,10 +9,15 @@ module Bolt
     class YamlPlan
       class Loader
         class PuppetVisitor < Psych::Visitors::NoAliasRuby
-          def self.create_visitor
+          def initialize(scanner, class_loader, file)
+            super(scanner, class_loader)
+            @file = file
+          end
+
+          def self.create_visitor(source_ref)
             class_loader = Psych::ClassLoader::Restricted.new([], [])
             scanner = Psych::ScalarScanner.new(class_loader)
-            new(scanner, class_loader)
+            new(scanner, class_loader, source_ref)
           end
 
           def deserialize(node)
@@ -23,18 +28,18 @@ module Bolt
                 # @ss is a ScalarScanner, from the base ToRuby visitor class
                 node.value
               when Psych::Nodes::Scalar::DOUBLE_QUOTED
-                DoubleQuotedString.new(node.value)
-              # | style string or > style string
-              when Psych::Nodes::Scalar::LITERAL, Psych::Nodes::Scalar::FOLDED
-                CodeLiteral.new(node.value)
-              # This one shouldn't be possible
+                DoubleQuotedString.new(node.value, @file, node.start_line + 1)
+              # | style string
+              when Psych::Nodes::Scalar::LITERAL
+                CodeLiteral.new(node.value, @file, node.start_line + 1)
+              # > style string
               else
                 @ss.tokenize(node.value)
               end
             else
               value = @ss.tokenize(node.value)
               if value.is_a?(String)
-                BareString.new(value)
+                BareString.new(value, @file, node.start_line + 1)
               else
                 value
               end
@@ -50,7 +55,7 @@ module Bolt
                        else
                          Psych.parse(yaml_string, source_ref)
                        end
-          PuppetVisitor.create_visitor.accept(parse_tree)
+          PuppetVisitor.create_visitor(source_ref).accept(parse_tree)
         end
 
         def self.from_string(name, yaml_string, source_ref)

data/lib/bolt/plan_creator.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+require 'bolt/error'
+require 'bolt/logger'
+require 'bolt/module'
+require 'bolt/util'
+
+module Bolt
+  module PlanCreator
+    def self.validate_input(project, plan_name)
+      if project.name.nil?
+        raise Bolt::Error.new(
+          "Project directory '#{project.path}' is not a named project. Unable to create "\
+          "a project-level plan. To name a project, set the 'name' key in the 'bolt-project.yaml' "\
+          "configuration file.",
+          "bolt/unnamed-project-error"
+        )
+      end
+
+      if plan_name !~ Bolt::Module::CONTENT_NAME_REGEX
+        message = <<~MESSAGE.chomp
+          Invalid plan name '#{plan_name}'. Plan names are composed of one or more name segments
+          separated by double colons '::'.
+
+          Each name segment must begin with a lowercase letter, and may only include lowercase
+          letters, digits, and underscores.
+
+          Examples of valid plan names:
+              - #{project.name}
+              - #{project.name}::my_plan
+        MESSAGE
+
+        raise Bolt::ValidationError, message
+      end
+
+      prefix, _, basename = segment_plan_name(plan_name)
+
+      unless prefix == project.name
+        message = "First segment of plan name '#{plan_name}' must match project name '#{project.name}'. "\
+                  "Did you mean '#{project.name}::#{plan_name}'?"
+
+        raise Bolt::ValidationError, message
+      end
+
+      %w[pp yaml].each do |ext|
+        next unless (path = project.plans_path + "#{basename}.#{ext}").exist?
+        raise Bolt::Error.new(
+          "A plan with the name '#{plan_name}' already exists at '#{path}', nothing to do.",
+          'bolt/existing-plan-error'
+        )
+      end
+    end
+
+    def self.create_plan(plans_path, plan_name, outputter, is_puppet)
+      _, name_segments, basename = segment_plan_name(plan_name)
+      dir_path = plans_path.join(*name_segments)
+
+      begin
+        FileUtils.mkdir_p(dir_path)
+      rescue Errno::EEXIST => e
+        raise Bolt::Error.new(
+          "#{e.message}; unable to create plan directory '#{dir_path}'",
+          'bolt/existing-file-error'
+        )
+      end
+
+      type = is_puppet ? 'pp' : 'yaml'
+      plan_path = dir_path + "#{basename}.#{type}"
+      plan_template = is_puppet ? puppet_plan(plan_name) : yaml_plan(plan_name)
+
+      begin
+        File.write(plan_path, plan_template)
+      rescue Errno::EACCES => e
+        raise Bolt::FileError.new(
+          "#{e.message}; unable to create plan",
+          plan_path
+        )
+      end
+
+      if Bolt::Util.powershell?
+        show_command = 'Get-BoltPlan -Name '
+        run_command  = 'Invoke-BoltPlan -Name '
+      else
+        show_command = 'bolt plan show'
+        run_command  = 'bolt plan run'
+      end
+
+      output = <<~OUTPUT
+        Created plan '#{plan_name}' at '#{plan_path}'
+
+        Show this plan with:
+            #{show_command} #{plan_name}
+        Run this plan with:
+            #{run_command} #{plan_name}
+      OUTPUT
+
+      outputter.print_message(output)
+      0
+    end
+
+    def self.segment_plan_name(plan_name)
+      prefix, *name_segments, basename = plan_name.split('::')
+
+      # If the plan name is just the project name, then create an 'init' plan.
+      # Otherwise, use the last name segment for the plan's filename.
+      basename ||= 'init'
+
+      [prefix, name_segments, basename]
+    end
+
+    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
+
+        # 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
+            default: localhost
+
+        # The steps key defines the actions the plan will take in order.
+        steps:
+          - message: Hello from #{plan_name}
+          - name: command_step
+            command: whoami
+            targets: $targets
+
+        # The return key sets the return value of the plan.
+        return: $command_step
+      YAML
+    end
+
+    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
+
+        # 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 = "localhost"
+        ) {
+          out::message("Hello from #{plan_name}")
+          $command_result = run_command('whoami', $targets)
+          return $command_result
+        }
+      PUPPET
+    end
+  end
+end

data/lib/bolt/plugin.rb

@@ -290,7 +290,7 @@ module Bolt
       begin
         validate_proc = get_hook(plugin_name, :validate_resolve_reference)
       rescue PluginError
-        validate_proc = proc { |*args| }
+        validate_proc = proc { |*args| } # Nothing to do
       end
 
       validate_proc.call(reference)

data/lib/bolt/project.rb

@@ -11,9 +11,9 @@ module Bolt
     PROJECT_SETTINGS = {
       "name"  => "The name of the project",
       "plans" => "An array of plan names to show, if they exist in the project."\
-                 "These plans are included in `bolt plan show` output",
+                 "These plans are included in `bolt plan show` and `Get-BoltPlan` output",
       "tasks" => "An array of task names to show, if they exist in the project."\
-                 "These tasks are included in `bolt task show` output"
+                 "These tasks are included in `bolt task show` and `Get-BoltTask` output"
     }.freeze
 
     attr_reader :path, :data, :config_file, :inventory_file, :hiera_config,
@@ -210,14 +210,9 @@ module Bolt
           raise Bolt::ValidationError, "'modules' in bolt-project.yaml must be an array"
         end
 
-        @data['modules'].each do |mod|
-          next if (mod.is_a?(Hash) && mod.key?('name')) || mod.is_a?(String)
-          raise Bolt::ValidationError, "Module declaration #{mod.inspect} must be a hash with a name key"
-        end
-
-        unknown_keys = modules.flat_map(&:keys).uniq - %w[name version_requirement]
-        if unknown_keys.any?
-          @logs << { warn: "Ignoring unknown keys in module declarations: #{unknown_keys.join(', ')}." }
+        @data['modules'].each do |spec|
+          next if spec.is_a?(Hash) || spec.is_a?(String)
+          raise Bolt::ValidationError, "Module specification #{spec.inspect} must be a hash or string"
         end
       end
     end

data/lib/bolt/project_migrator/config.rb

@@ -54,10 +54,11 @@ module Bolt
         @outputter.print_action_step("Renaming bolt.yaml to bolt-project.yaml")
         FileUtils.mv(config_file, project_file)
 
+        command = Bolt::Util.powershell? ? 'Get-Help about_bolt_project' : 'bolt guide project'
         @outputter.print_action_step(
           "Successfully migrated config. Please add a 'name' key to bolt-project.yaml "\
           "to use project-level tasks and plans. Learn more about projects by running "\
-          "'bolt guide project'."
+          "'#{command}'."
         )
 
         true

data/lib/bolt/project_migrator/inventory.rb

@@ -6,12 +6,12 @@ module Bolt
   class ProjectMigrator
     class Inventory < Base
       def migrate(inventory_file, backup_dir)
-        inventory_1_to_2(inventory_file, backup_dir)
+        inventory1to2(inventory_file, backup_dir)
       end
 
       # Migrates an inventory v1 file to inventory v2.
       #
-      private def inventory_1_to_2(inventory_file, backup_dir)
+      private def inventory1to2(inventory_file, backup_dir)
         unless File.exist?(inventory_file)
           return true
         end

data/lib/bolt/project_migrator/modules.rb

@@ -42,12 +42,14 @@ module Bolt
       # to the new moduledir.
       #
       private def migrate_modules_from_puppetfile(config, puppetfile_path, managed_moduledir, modulepath)
-        require 'bolt/puppetfile'
-        require 'bolt/puppetfile/installer'
+        require 'bolt/module_installer/installer'
+        require 'bolt/module_installer/puppetfile'
+        require 'bolt/module_installer/resolver'
+        require 'bolt/module_installer/specs'
 
         begin
           @outputter.print_action_step("Parsing Puppetfile at #{puppetfile_path}")
-          puppetfile = Bolt::Puppetfile.parse(puppetfile_path, skip_unsupported_modules: true)
+          puppetfile = Bolt::ModuleInstaller::Puppetfile.parse(puppetfile_path, skip_unsupported_modules: true)
         rescue Bolt::Error => e
           @outputter.print_action_error("#{e.message}\nSkipping module migration.")
           return false
@@ -56,14 +58,14 @@ module Bolt
         # Prompt for direct dependencies
         modules = select_modules(puppetfile.modules)
 
-        # Create new Puppetfile object
-        puppetfile = Bolt::Puppetfile.new(modules)
+        # Create specs to resolve from
+        specs = Bolt::ModuleInstaller::Specs.new(modules.map(&:to_hash))
 
         # Attempt to resolve dependencies
         begin
           @outputter.print_message('')
           @outputter.print_action_step("Resolving module dependencies, this may take a moment")
-          puppetfile.resolve
+          puppetfile = Bolt::ModuleInstaller::Resolver.new.resolve(specs)
         rescue Bolt::Error => e
           @outputter.print_action_error("#{e.message}\nSkipping module migration.")
           return false
@@ -98,7 +100,7 @@ module Bolt
 
           # Install Puppetfile
           @outputter.print_action_step("Syncing modules from #{puppetfile_path} to #{managed_moduledir}")
-          Bolt::Puppetfile::Installer.new({}).install(puppetfile_path, managed_moduledir)
+          Bolt::ModuleInstaller::Installer.new.install(puppetfile_path, managed_moduledir)
         else
           @outputter.print_action_step(
             "Project does not include any managed modules, deleting Puppetfile "\
@@ -123,7 +125,7 @@ module Bolt
         return modules if all
 
         modules.select do |mod|
-          Bolt::Util.prompt_yes_no("Select #{mod.title}?", @outputter)
+          Bolt::Util.prompt_yes_no("Select #{mod.full_name}?", @outputter)
         end
       end
 

data/lib/bolt/puppetdb/client.rb

@@ -2,7 +2,6 @@
 
 require 'json'
 require 'logging'
-require 'uri'
 
 module Bolt
   module PuppetDB
@@ -108,13 +107,15 @@ module Bolt
       end
 
       def uri
+        require 'addressable/uri'
+
         @current_url ||= (@config.server_urls - @bad_urls).first
         unless @current_url
           msg = "Failed to connect to all PuppetDB server_urls: #{@config.server_urls.to_a.join(', ')}."
           raise Bolt::PuppetDBError, msg
         end
 
-        uri = URI.parse(@current_url)
+        uri = Addressable::URI.parse(@current_url)
         uri.port ||= 8081
         uri
       end

data/lib/bolt/puppetdb/config.rb

@@ -6,14 +6,14 @@ require 'bolt/util'
 module Bolt
   module PuppetDB
     class Config
-      if !ENV['HOME'].nil?
-        DEFAULT_TOKEN = File.expand_path('~/.puppetlabs/token')
-        DEFAULT_CONFIG = { user: File.expand_path('~/.puppetlabs/client-tools/puppetdb.conf'),
-                           global: '/etc/puppetlabs/client-tools/puppetdb.conf' }.freeze
-      else
+      if ENV['HOME'].nil?
         DEFAULT_TOKEN = Bolt::Util.windows? ? 'nul' : '/dev/null'
         DEFAULT_CONFIG = { user: '/etc/puppetlabs/puppet/puppetdb.conf',
                            global: '/etc/puppetlabs/puppet/puppetdb.conf' }.freeze
+      else
+        DEFAULT_TOKEN = File.expand_path('~/.puppetlabs/token')
+        DEFAULT_CONFIG = { user: File.expand_path('~/.puppetlabs/client-tools/puppetdb.conf'),
+                           global: '/etc/puppetlabs/client-tools/puppetdb.conf' }.freeze
 
       end
 
@@ -89,6 +89,8 @@ module Bolt
 
       def uri
         return @uri if @uri
+        require 'addressable/uri'
+
         uri = case @settings['server_urls']
               when String
                 @settings['server_urls']
@@ -100,7 +102,7 @@ module Bolt
                 raise Bolt::PuppetDBError, "server_urls must be a string or array"
               end
 
-        @uri = URI.parse(uri)
+        @uri = Addressable::URI.parse(uri)
         @uri.port ||= 8081
         @uri
       end