bolt 2.29.0 → 2.30.0

data/lib/bolt/puppetfile.rb

@@ -19,7 +19,7 @@ module Bolt
     # Loads a Puppetfile and parses its module specifications, returning a
     # Bolt::Puppetfile object with the modules set.
     #
-    def self.parse(path)
+    def self.parse(path, skip_unsupported_modules: false)
       require 'puppetfile-resolver'
       require 'puppetfile-resolver/puppetfile/parser/r10k_eval'
 
@@ -33,12 +33,24 @@ module Bolt
       end
 
       unless parsed.valid?
-        raise Bolt::ValidationError,
-              "Unable to parse Puppetfile #{path}"
+        # valid? Just checks if validation_errors is empty, so if we get here we know it's not.
+        raise Bolt::ValidationError, <<~MSG
+        Unable to parse Puppetfile #{path}:
+        #{parsed.validation_errors.join("\n\n")}.
+        This may not be a Puppetfile managed by Bolt.
+        MSG
       end
 
-      modules = parsed.modules.map do |mod|
-        Bolt::Puppetfile::Module.new(mod.owner, mod.name, mod.version)
+      modules = parsed.modules.each_with_object([]) do |mod, acc|
+        unless mod.instance_of? PuppetfileResolver::Puppetfile::ForgeModule
+          next if skip_unsupported_modules
+
+          raise Bolt::ValidationError,
+                "Module '#{mod.title}' is not a Puppet Forge module. Unable to "\
+                "parse Puppetfile #{path}."
+        end
+
+        acc << Bolt::Puppetfile::Module.new(mod.owner, mod.name, mod.version)
       end
 
       new(modules)
@@ -47,19 +59,11 @@ module Bolt
     # Writes a Puppetfile that includes specifications for each of the
     # modules.
     #
-    def write(path, force: false)
-      if File.exist?(path) && !force
-        raise Bolt::FileError.new(
-          "Cannot overwrite existing Puppetfile at #{path}. To forcibly overwrite, "\
-          "run with the '--force' option.",
-          path
-        )
-      end
-
+    def write(path, moduledir = nil)
       File.open(path, 'w') do |file|
         file.puts '# This Puppetfile is managed by Bolt. Do not edit.'
+        file.puts "moduledir '#{moduledir.basename}'" if moduledir
         modules.each { |mod| file.puts mod.to_spec }
-        file.puts
       end
     rescue SystemCallError => e
       raise Bolt::FileError.new(
@@ -104,46 +108,24 @@ module Bolt
           cache:                 nil,
           ui:                    nil,
           module_paths:          [],
-          allow_missing_modules: true
+          allow_missing_modules: false
         )
       rescue StandardError => e
         raise Bolt::Error.new(e.message, 'bolt/puppetfile-resolver-error')
       end
 
-      # Validate that the modules exist.
-      missing_graph = result.specifications.select do |_name, spec|
-        spec.instance_of? PuppetfileResolver::Models::MissingModuleSpecification
+      # Turn specifications into module objects. This will skip over anything that is not
+      # a module specification (i.e. a Puppet version specification).
+      @modules = result.specifications.each_with_object(Set.new) do |(_name, spec), acc|
+        next unless spec.instance_of? PuppetfileResolver::Models::ModuleSpecification
+        acc << Bolt::Puppetfile::Module.new(spec.owner, spec.name, spec.version.to_s)
       end
-
-      if missing_graph.any?
-        titles = model.modules.each_with_object({}) do |mod, acc|
-          acc[mod.name] = mod.title
-        end
-
-        names = titles.values_at(*missing_graph.keys)
-        plural = names.count == 1 ? '' : 's'
-
-        raise Bolt::Error.new(
-          "Unknown module name#{plural} #{names.join(', ')}",
-          'bolt/unknown-modules'
-        )
-      end
-
-      # Filter the dependency graph to only include module specifications. This
-      # will only remove the Puppet version specification, which is not needed.
-      specs = result.specifications.select do |_name, spec|
-        spec.instance_of? PuppetfileResolver::Models::ModuleSpecification
-      end
-
-      @modules = specs.map do |_name, spec|
-        Bolt::Puppetfile::Module.new(spec.owner, spec.name, spec.version.to_s)
-      end.to_set
     end
 
     # Adds to the set of modules.
     #
     def add_modules(modules)
-      modules.each do |mod|
+      Array(modules).each do |mod|
         case mod
         when Bolt::Puppetfile::Module
           @modules << mod

data/lib/bolt/puppetfile/module.rb

@@ -13,7 +13,7 @@ module Bolt
       def initialize(owner, name, version = nil)
         @owner   = owner
         @name    = name
-        @version = version
+        @version = version unless version == :latest
       end
 
       # Creates a new module from a hash.
@@ -38,6 +38,7 @@ module Bolt
       def title
         "#{@owner}-#{@name}"
       end
+      alias to_s title
 
       # Checks two modules for equality.
       #

data/lib/bolt/shell/bash.rb

@@ -143,7 +143,7 @@ module Bolt
 
             execute_options[:stdin] = stdin
             execute_options[:sudoable] = true if run_as
-            output = execute(remote_task_path, execute_options)
+            output = execute(remote_task_path, **execute_options)
           end
           Bolt::Result.for_task(target, output.stdout.string,
                                 output.stderr.string,

data/lib/bolt/util.rb

@@ -299,6 +299,28 @@ module Bolt
         raise Bolt::ValidationError, "path must be a String, received #{path.class} #{path}" unless path.is_a?(String)
         path.split(%r{[/\\]}).last
       end
+
+      # Prompts yes or no, returning true for yes and false for no.
+      #
+      def prompt_yes_no(prompt, outputter)
+        choices = {
+          'y'   => true,
+          'yes' => true,
+          'n'   => false,
+          'no'  => false
+        }
+
+        loop do
+          outputter.print_prompt("#{prompt} ([y]es/[n]o) ")
+          response = $stdin.gets.to_s.downcase.chomp
+
+          if choices.key?(response)
+            return choices[response]
+          else
+            outputter.print_prompt_error("Invalid response, must pick [y]es or [n]o")
+          end
+        end
+      end
     end
   end
 end

data/lib/bolt/version.rb

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

data/lib/bolt_server/acl.rb

@@ -16,9 +16,9 @@ module BoltServer
       end
     end
 
-    def initialize(app, whitelist)
+    def initialize(app, allowlist)
       acls = []
-      whitelist.each do |entry|
+      allowlist.each do |entry|
         acls << {
           'resources' => [
             {

data/lib/bolt_server/base_config.rb

@@ -7,7 +7,7 @@ module BoltServer
   class BaseConfig
     def config_keys
       %w[host port ssl-cert ssl-key ssl-ca-cert
-         ssl-cipher-suites loglevel logfile whitelist projects-dir]
+         ssl-cipher-suites loglevel logfile allowlist projects-dir]
     end
 
     def env_keys
@@ -98,8 +98,8 @@ module BoltServer
         raise Bolt::ValidationError, "Configured 'ssl-cipher-suites' must be an array of cipher suite names"
       end
 
-      unless @data['whitelist'].nil? || @data['whitelist'].is_a?(Array)
-        raise Bolt::ValidationError, "Configured 'whitelist' must be an array of names"
+      unless @data['allowlist'].nil? || @data['allowlist'].is_a?(Array)
+        raise Bolt::ValidationError, "Configured 'allowlist' must be an array of names"
       end
     end
 

data/lib/bolt_spec/plans/mock_executor.rb

@@ -40,7 +40,7 @@ module BoltSpec
 
       def module_file_id(file)
         modpath = @modulepath.select { |path| file =~ /^#{path}/ }
-        raise "Could not identify module path containing #{file}: #{modpath}" unless modpath.size == 1
+        raise "Could not identify modulepath containing #{file}: #{modpath}" unless modpath.size == 1
 
         path = Pathname.new(file)
         relative = path.relative_path_from(Pathname.new(modpath.first))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bolt
 version: !ruby/object:Gem::Version
-  version: 2.29.0
+  version: 2.30.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-21 00:00:00.000000000 Z
+date: 2020-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -461,6 +461,7 @@ files:
 - lib/bolt/inventory/target.rb
 - lib/bolt/logger.rb
 - lib/bolt/module.rb
+- lib/bolt/module_installer.rb
 - lib/bolt/node/errors.rb
 - lib/bolt/node/output.rb
 - lib/bolt/outputter.rb
@@ -494,7 +495,11 @@ files:
 - lib/bolt/plugin/puppetdb.rb
 - lib/bolt/plugin/task.rb
 - lib/bolt/project.rb
-- lib/bolt/project_migrate.rb
+- lib/bolt/project_migrator.rb
+- lib/bolt/project_migrator/base.rb
+- lib/bolt/project_migrator/config.rb
+- lib/bolt/project_migrator/inventory.rb
+- lib/bolt/project_migrator/modules.rb
 - lib/bolt/puppetdb.rb
 - lib/bolt/puppetdb/client.rb
 - lib/bolt/puppetdb/config.rb

data/lib/bolt/project_migrate.rb

@@ -1,138 +0,0 @@
-# frozen_string_literal: true
-
-module Bolt
-  class ProjectMigrate
-    attr_reader :path, :project_file, :backup_dir, :outputter, :inventory_file, :config_file
-
-    # This init mostly makes testing easier
-    def initialize(path, outputter, configured_inventory = nil)
-      @path = Pathname.new(path).expand_path
-      @project_file = @path + 'bolt-project.yaml'
-      @config_file = @path + 'bolt.yaml'
-      @backup_dir = @path + '.bolt-bak'
-      @inventory_file = configured_inventory || @path + 'inventory.yaml'
-      @outputter = outputter
-    end
-
-    def migrate_project
-      inv_ok = inventory_1_to_2(inventory_file, outputter) if inventory_file.file?
-      config_ok = bolt_yaml_to_bolt_project(inventory_file, outputter)
-      inv_ok && config_ok ? 0 : 1
-    end
-
-    # This could be made public and used elsewhere if the need arises
-    private def backup_file(origin_path)
-      unless File.exist?(origin_path)
-        outputter.print_message "Could not find file #{origin_path}, skipping backup."
-        return
-      end
-
-      date = Time.new.strftime("%Y%m%d_%H%M%S%L")
-      FileUtils.mkdir_p(backup_dir)
-
-      filename = File.basename(origin_path)
-      backup_path = File.join(backup_dir, "#{filename}.#{date}.bak")
-
-      outputter.print_message "Backing up #{filename} from #{origin_path} to #{backup_path}"
-
-      begin
-        FileUtils.cp(origin_path, backup_path)
-      rescue StandardError => e
-        raise Bolt::FileError.new("#{e.message}; unable to create backup of #{filename}.", origin_path)
-      end
-    end
-
-    private def bolt_yaml_to_bolt_project(inventory_file, outputter)
-      # If bolt-project.yaml already exists
-      if project_file.file?
-        outputter.print_message "bolt-project.yaml already exists in Bolt "\
-          "project at #{path}. Skipping project file update."
-
-      # If bolt.yaml doesn't exist
-      elsif !config_file.file?
-        outputter.print_message "Could not find bolt.yaml in project at "\
-          "#{path}. Skipping project file update."
-
-      else
-        config_data = Bolt::Util.read_optional_yaml_hash(config_file, 'config')
-        transport_data, project_data = config_data.partition do |k, _|
-          Bolt::Config::INVENTORY_OPTIONS.keys.include?(k)
-        end.map(&:to_h)
-
-        if transport_data.any?
-          if File.exist?(inventory_file)
-            inventory_data = Bolt::Util.read_yaml_hash(inventory_file, 'inventory')
-            merged = Bolt::Util.deep_merge(transport_data, inventory_data['config'] || {})
-            inventory_data['config'] = merged
-            backup_file(inventory_file)
-          else
-            FileUtils.touch(inventory_file)
-            inventory_data = { 'config' => transport_data }
-          end
-
-          backup_file(config_file)
-
-          begin
-            outputter.print_message "Moving transportation configuration options "\
-              "'#{transport_data.keys.join(', ')}' from bolt.yaml to inventory.yaml"
-            File.write(inventory_file, inventory_data.to_yaml)
-            File.write(config_file, project_data.to_yaml)
-          rescue StandardError => e
-            raise Bolt::FileError.new("#{e.message}; unable to write inventory.", inventory_file)
-          end
-        end
-
-        outputter.print_message "Renaming bolt.yaml to bolt-project.yaml"
-        FileUtils.mv(config_file, project_file)
-        outputter.print_message "Successfully updated project. 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'."
-        # If nothing errored, this succeeded
-        true
-      end
-    end
-
-    private def inventory_1_to_2(inventory_file, outputter)
-      data = Bolt::Util.read_yaml_hash(inventory_file, 'inventory')
-      data.delete('version') if data['version'] != 2
-      migrated = migrate_group(data)
-
-      ok = if migrated
-             backup_file(inventory_file)
-             File.write(inventory_file, data.to_yaml)
-           end
-
-      result = if migrated && ok
-                 "Successfully migrated Bolt inventory to the latest version."
-               elsif !migrated
-                 "Bolt inventory is already on the latest version. Skipping inventory update."
-               else
-                 "Could not migrate Bolt inventory to the latest version. See "\
-                 "https://puppet.com/docs/bolt/latest/inventory_file_v2.html to manually update."
-               end
-      outputter.print_message(result)
-      ok
-    end
-
-    # Walks an inventory hash and replaces all 'nodes' keys with 'targets' keys
-    # and all 'name' keys nested in a 'targets' hash with 'uri' keys. Data is
-    # modified in place.
-    private def migrate_group(group)
-      migrated = false
-      if group.key?('nodes')
-        migrated = true
-        targets = group['nodes'].map do |target|
-          target['uri'] = target.delete('name') if target.is_a?(Hash)
-          target
-        end
-        group.delete('nodes')
-        group['targets'] = targets
-      end
-      (group['groups'] || []).each do |subgroup|
-        migrated_group = migrate_group(subgroup)
-        migrated ||= migrated_group
-      end
-      migrated
-    end
-  end
-end