bolt 2.26.0 → 2.31.0

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.26.0
+  version: 2.31.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-08-31 00:00:00.000000000 Z
+date: 2020-10-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -198,14 +198,14 @@ dependencies:
     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
@@ -444,6 +444,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 +462,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,10 +496,17 @@ 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
@@ -534,7 +543,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_server/pe/pal.rb

@@ -1,67 +0,0 @@
-# frozen_string_literal: true
-
-require 'bolt/pal'
-require 'bolt/util'
-
-module BoltServer
-  module PE
-    class PAL < Bolt::PAL
-      # PE_BOLTLIB_PATH is intended to function exactly like the BOLTLIB_PATH used
-      # in Bolt::PAL. Paths and variable names are similar to what exists in
-      # Bolt::PAL, but with a 'PE' prefix.
-      PE_BOLTLIB_PATH = '/opt/puppetlabs/server/apps/bolt-server/pe-bolt-modules'
-
-      # For now at least, we maintain an entirely separate codedir from
-      # puppetserver by default, so that filesync can work properly. If filesync
-      # is not used, this can instead match the usual puppetserver codedir.
-      # See the `orchestrator.bolt.codedir` tk config setting.
-      DEFAULT_BOLT_CODEDIR = '/opt/puppetlabs/server/data/orchestration-services/code'
-
-      # This function is nearly identical to Bolt::Pal's `with_puppet_settings` with the
-      # one difference that we set the codedir to point to actual code, rather than the
-      # tmpdir. We only use this funtion inside the PEBolt::PAL initializer so that Puppet
-      # is correctly configured to pull environment configuration correctly. If we don't
-      # set codedir in this way: when we try to load and interpolate the modulepath it
-      # won't correctly load.
-      def with_pe_pal_init_settings(codedir, environmentpath, basemodulepath)
-        Dir.mktmpdir('pe-bolt') do |dir|
-          cli = []
-          Puppet::Settings::REQUIRED_APP_SETTINGS.each do |setting|
-            dir = setting == :codedir ? codedir : dir
-            cli << "--#{setting}" << dir
-          end
-          cli << "--environmentpath" << environmentpath
-          cli << "--basemodulepath" << basemodulepath
-          Puppet.settings.send(:clear_everything_for_tests)
-          Puppet.initialize_settings(cli)
-          yield
-          # Ensure the puppet settings go back to what bolt expects after
-          # we finish with the settings we need for PEBolt::PAL init.
-          with_puppet_settings { |_| nil }
-        end
-      end
-
-      def initialize(plan_executor_config, environment_name, hiera_config = nil, max_compiles = nil)
-        # Bolt::PAL#initialize takes the modulepath as its first argument, but we
-        # want to customize it later, so we pass an empty value:
-        super([], hiera_config, max_compiles)
-
-        codedir = plan_executor_config['codedir'] || DEFAULT_BOLT_CODEDIR
-        environmentpath = plan_executor_config['environmentpath'] || "#{codedir}/environments"
-        basemodulepath = plan_executor_config['basemodulepath'] || "#{codedir}/modules:/opt/puppetlabs/puppet/modules"
-
-        with_pe_pal_init_settings(codedir, environmentpath, basemodulepath) do
-          environment = Puppet.lookup(:environments).get!(environment_name)
-          # A new modulepath is created from scratch (rather than using super's @modulepath)
-          # so that we can have full control over all the entries in modulepath. In the future
-          # it's likely we will need to preceed _both_ Bolt::PAL::BOLTLIB_PATH _and_
-          # Bolt::PAL::MODULES_PATH which would be more complex if we tried to use @modulepath since
-          # we need to append our modulepaths and exclude modules shiped in bolt gem code
-          modulepath_dirs = environment.modulepath
-          @user_modulepath = modulepath_dirs
-          @modulepath = [PE_BOLTLIB_PATH, Bolt::PAL::BOLTLIB_PATH, *modulepath_dirs]
-        end
-      end
-    end
-  end
-end