bolt 2.27.0 → 2.32.0

data/lib/bolt_spec/bolt_context.rb

@@ -105,7 +105,7 @@ module BoltSpec
 
       # Set the things
       Puppet[:tasks] = true
-      RSpec.configuration.module_path = [modulepath, Bolt::PAL::BOLTLIB_PATH].join(File::PATH_SEPARATOR)
+      RSpec.configuration.module_path = [modulepath, Bolt::Config::Modulepath::BOLTLIB_PATH].join(File::PATH_SEPARATOR)
       opts = {
         bolt_executor: executor,
         bolt_inventory: inventory,
@@ -142,10 +142,10 @@ module BoltSpec
     # Override in your tests
     def config
       @config ||= begin
-                    conf = Bolt::Config.default
-                    conf.modulepath = [modulepath].flatten
-                    conf
-                  end
+        conf = Bolt::Config.default
+        conf.modulepath = [modulepath].flatten
+        conf
+      end
     end
 
     def plugins
@@ -153,7 +153,9 @@ module BoltSpec
     end
 
     def pal
-      @pal ||= Bolt::PAL.new(config.modulepath, config.hiera_config, config.project.resource_types)
+      @pal ||= Bolt::PAL.new(Bolt::Config::Modulepath.new(config.modulepath),
+                             config.hiera_config,
+                             config.project.resource_types)
     end
 
     BoltSpec::Plans::MOCKED_ACTIONS.each do |action|

data/lib/bolt_spec/plans.rb

@@ -224,7 +224,7 @@ module BoltSpec
 
     def run_plan(name, params)
       pal = Bolt::PAL.new(
-        config.modulepath,
+        Bolt::Config::Modulepath.new(config.modulepath),
         config.hiera_config,
         config.project.resource_types,
         config.compile_concurrency,

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))

data/lib/bolt_spec/run.rb

@@ -179,7 +179,7 @@ module BoltSpec
       end
 
       def pal
-        @pal ||= Bolt::PAL.new(config.modulepath,
+        @pal ||= Bolt::PAL.new(Bolt::Config::Modulepath.new(config.modulepath),
                                config.hiera_config,
                                config.project.resource_types,
                                config.compile_concurrency)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bolt
 version: !ruby/object:Gem::Version
-  version: 2.27.0
+  version: 2.32.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-09-08 00:00:00.000000000 Z
+date: 2020-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -182,30 +182,36 @@ dependencies:
   name: puppet
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 6.18.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '6.19'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 6.18.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '6.19'
 - !ruby/object:Gem::Dependency
   name: puppetfile-resolver
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0.4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: puppet-resource_api
   requirement: !ruby/object:Gem::Requirement
@@ -432,6 +438,8 @@ files:
 - bolt-modules/system/lib/puppet/functions/system/env.rb
 - exe/bolt
 - guides/inventory.txt
+- guides/module.txt
+- guides/modulepath.txt
 - guides/project.txt
 - lib/bolt.rb
 - lib/bolt/analytics.rb
@@ -444,6 +452,7 @@ files:
 - lib/bolt/catalog/logging.rb
 - lib/bolt/cli.rb
 - lib/bolt/config.rb
+- lib/bolt/config/modulepath.rb
 - lib/bolt/config/options.rb
 - lib/bolt/config/transport/base.rb
 - lib/bolt/config/transport/docker.rb
@@ -461,6 +470,16 @@ files:
 - lib/bolt/inventory/target.rb
 - lib/bolt/logger.rb
 - lib/bolt/module.rb
+- lib/bolt/module_installer.rb
+- lib/bolt/module_installer/installer.rb
+- lib/bolt/module_installer/puppetfile.rb
+- lib/bolt/module_installer/puppetfile/forge_module.rb
+- lib/bolt/module_installer/puppetfile/git_module.rb
+- lib/bolt/module_installer/puppetfile/module.rb
+- lib/bolt/module_installer/resolver.rb
+- lib/bolt/module_installer/specs.rb
+- lib/bolt/module_installer/specs/forge_spec.rb
+- lib/bolt/module_installer/specs/git_spec.rb
 - lib/bolt/node/errors.rb
 - lib/bolt/node/output.rb
 - lib/bolt/outputter.rb
@@ -494,13 +513,14 @@ 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
-- lib/bolt/puppetfile.rb
-- lib/bolt/puppetfile/installer.rb
-- lib/bolt/puppetfile/module.rb
 - lib/bolt/r10k_log_proxy.rb
 - lib/bolt/rerun.rb
 - lib/bolt/resource_instance.rb
@@ -537,7 +557,6 @@ files:
 - lib/bolt_server/base_config.rb
 - lib/bolt_server/config.rb
 - lib/bolt_server/file_cache.rb
-- lib/bolt_server/pe/pal.rb
 - lib/bolt_server/schemas/action-check_node_connections.json
 - lib/bolt_server/schemas/action-run_command.json
 - lib/bolt_server/schemas/action-run_script.json

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

data/lib/bolt/puppetfile.rb

@@ -1,160 +0,0 @@
-# frozen_string_literal: true
-
-require 'bolt/error'
-require 'bolt/puppetfile/module'
-
-# This class manages the logical contents of a Puppetfile. It includes methods
-# for parsing a Puppetfile and its modules, resolving module dependencies,
-# and writing a Puppetfile.
-#
-module Bolt
-  class Puppetfile
-    attr_reader :modules
-
-    def initialize(modules = [])
-      @modules = Set.new
-      add_modules(modules)
-    end
-
-    # Loads a Puppetfile and parses its module specifications, returning a
-    # Bolt::Puppetfile object with the modules set.
-    #
-    def self.parse(path)
-      require 'puppetfile-resolver'
-      require 'puppetfile-resolver/puppetfile/parser/r10k_eval'
-
-      begin
-        parsed = ::PuppetfileResolver::Puppetfile::Parser::R10KEval.parse(File.read(path))
-      rescue StandardError => e
-        raise Bolt::Error.new(
-          "Unable to parse Puppetfile #{path}: #{e.message}",
-          'bolt/puppetfile-parsing'
-        )
-      end
-
-      unless parsed.valid?
-        raise Bolt::ValidationError,
-              "Unable to parse Puppetfile #{path}"
-      end
-
-      modules = parsed.modules.map do |mod|
-        Bolt::Puppetfile::Module.new(mod.owner, mod.name, mod.version)
-      end
-
-      new(modules)
-    end
-
-    # 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
-
-      File.open(path, 'w') do |file|
-        file.puts '# This Puppetfile is managed by Bolt. Do not edit.'
-        modules.each { |mod| file.puts mod.to_spec }
-        file.puts
-      end
-    rescue SystemCallError => e
-      raise Bolt::FileError.new(
-        "#{e.message}: unable to write Puppetfile.",
-        path
-      )
-    end
-
-    # Resolves module dependencies using the puppetfile-resolver library. The
-    # resolver will return a document model including all module dependencies
-    # and the latest version that can be installed for each. The document model
-    # is parsed and turned into a Set of Bolt::Puppetfile::Module objects.
-    #
-    def resolve
-      require 'puppetfile-resolver'
-
-      # Build the document model from the modules.
-      model = PuppetfileResolver::Puppetfile::Document.new('')
-
-      @modules.each do |mod|
-        model.add_module(
-          PuppetfileResolver::Puppetfile::ForgeModule.new(mod.title).tap do |tap|
-            tap.version = :latest
-          end
-        )
-      end
-
-      # Make sure the Puppetfile model is valid.
-      unless model.valid?
-        raise Bolt::ValidationError,
-              "Unable to resolve dependencies for modules: #{@modules.map(&:title).join(', ')}"
-      end
-
-      # Create the resolver using the Puppetfile model. nil disables Puppet
-      # version restrictions.
-      resolver = PuppetfileResolver::Resolver.new(model, nil)
-
-      # Configure and resolve the dependency graph, catching any errors
-      # raised by puppetfile-resolver and re-raising them as Bolt errors.
-      begin
-        result = resolver.resolve(
-          cache:                 nil,
-          ui:                    nil,
-          module_paths:          [],
-          allow_missing_modules: true
-        )
-      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
-      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|
-        case mod
-        when Bolt::Puppetfile::Module
-          @modules << mod
-        when Hash
-          @modules << Bolt::Puppetfile::Module.from_hash(mod)
-        else
-          raise Bolt::ValidationError, "Module must be a Bolt::Puppetfile::Module or Hash."
-        end
-      end
-
-      @modules
-    end
-  end
-end