bolt 2.33.1 → 2.37.0

data/lib/bolt_server/schemas/connect-data.json

@@ -0,0 +1,22 @@
+{
+  "$schema": "http://json-schema.org/draft-04/schema#",
+  "title": "project_inventory_targets connect plugin data",
+  "description": "POST project_inventory_targets connect plugin data",
+  "type": "object",
+  "properties": {
+    "puppet_connect_data": {
+      "type": "object",
+      "patternProperties": {
+        ".*": {
+          "type": "object",
+          "properties": {
+            "value": {}
+          },
+          "required": ["value"]
+        }
+      },
+      "additionalProperties": false
+    }
+  },
+  "required": ["puppet_connect_data"]
+}

data/lib/bolt_server/schemas/partials/task.json

@@ -64,7 +64,7 @@
                     "description": "Environment the task is in",
                     "type": "string"
                   },
-                  "project": {
+                  "versioned_project": {
                     "description": "Project the task is in",
                     "type": "string"
                   }
@@ -77,7 +77,7 @@
                   },
                   {
                     "required": [
-                      "project"
+                      "versioned_project"
                     ]
                   }
                 ],              

data/lib/bolt_server/transport_app.rb

@@ -8,6 +8,8 @@ require 'bolt/inventory'
 require 'bolt/project'
 require 'bolt/target'
 require 'bolt_server/file_cache'
+require 'bolt_server/plugin'
+require 'bolt_server/plugin/puppet_connect_data'
 require 'bolt/task/puppet_server'
 require 'json'
 require 'json-schema'
@@ -35,6 +37,7 @@ module BoltServer
       action-upload_file
       transport-ssh
       transport-winrm
+      connect-data
     ].freeze
 
     # PE_BOLTLIB_PATH is intended to function exactly like the BOLTLIB_PATH used
@@ -48,6 +51,10 @@ module BoltServer
     # See the `orchestrator.bolt.codedir` tk config setting.
     DEFAULT_BOLT_CODEDIR = '/opt/puppetlabs/server/data/orchestration-services/code'
 
+    MISSING_PROJECT_REF_RESPONSE = [
+      400, Bolt::ValidationError.new('`project_ref` is a required argument').to_json
+    ].freeze
+
     def initialize(config)
       @config = config
       @schemas = Hash[REQUEST_SCHEMAS.map do |basename|
@@ -231,9 +238,9 @@ module BoltServer
     #
     # WARNING: THIS FUNCTION SHOULD ONLY BE CALLED INSIDE A SYNCHRONIZED PAL MUTEX
     def modulepath_from_environment(environment_name)
-      codedir = DEFAULT_BOLT_CODEDIR
-      environmentpath = "#{codedir}/environments"
-      basemodulepath = "#{codedir}/modules:/opt/puppetlabs/puppet/modules"
+      codedir = @config['environments-codedir'] || DEFAULT_BOLT_CODEDIR
+      environmentpath = @config['environmentpath'] || "#{codedir}/environments"
+      basemodulepath = @config['basemodulepath'] || "#{codedir}/modules:/opt/puppetlabs/puppet/modules"
       modulepath_dirs = nil
       with_pe_pal_init_settings(codedir, environmentpath, basemodulepath) do
         environment = Puppet.lookup(:environments).get!(environment_name)
@@ -261,13 +268,16 @@ module BoltServer
       end
     end
 
-    def in_bolt_project(bolt_project)
-      return [400, '`project_ref` is a required argument'] if bolt_project.nil?
-      project_dir = File.join(@config['projects-dir'], bolt_project)
-      return [400, "`project_ref`: #{project_dir} does not exist"] unless Dir.exist?(project_dir)
+    def config_from_project(project_ref)
+      project_dir = File.join(@config['projects-dir'], project_ref)
+      raise Bolt::ValidationError, "`project_ref`: #{project_dir} does not exist" unless Dir.exist?(project_dir)
+      project = Bolt::Project.create_project(project_dir)
+      Bolt::Config.from_project(project, { log: { 'bolt-debug.log' => 'disable' } })
+    end
+
+    def in_bolt_project(project_ref)
       @pal_mutex.synchronize do
-        project = Bolt::Project.create_project(project_dir)
-        bolt_config = Bolt::Config.from_project(project, { log: { 'bolt-debug.log' => 'disable' } })
+        bolt_config = config_from_project(project_ref)
         modulepath_object = Bolt::Config::Modulepath.new(
           bolt_config.modulepath,
           boltlib_path: [PE_BOLTLIB_PATH, Bolt::Config::Modulepath::BOLTLIB_PATH]
@@ -278,8 +288,6 @@ module BoltServer
           config: bolt_config
         }
         yield context
-      rescue Bolt::Error => e
-        [400, e.to_json]
       end
     end
 
@@ -508,11 +516,14 @@ module BoltServer
     #
     # @param project_ref [String] the project to fetch the plan from
     get '/project_plans/:module_name/:plan_name' do
+      return MISSING_PROJECT_REF_RESPONSE if params['project_ref'].nil?
       in_bolt_project(params['project_ref']) do |context|
         plan_info = pe_plan_info(context[:pal], params[:module_name], params[:plan_name])
         plan_info = allowed_helper(plan_info, context[:config].project.plans)
         [200, plan_info.to_json]
       end
+    rescue Bolt::Error => e
+      [400, e.to_json]
     end
 
     # Fetches the metadata for a single task
@@ -532,14 +543,17 @@ module BoltServer
     #
     # @param bolt_project_ref [String] the reference to the bolt-project directory to load task metadata from
     get '/project_tasks/:module_name/:task_name' do
+      return MISSING_PROJECT_REF_RESPONSE if params['project_ref'].nil?
       in_bolt_project(params['project_ref']) do |context|
         ps_parameters = {
-          'project' => params['project_ref']
+          'versioned_project' => params['project_ref']
         }
         task_info = pe_task_info(context[:pal], params[:module_name], params[:task_name], ps_parameters)
         task_info = allowed_helper(task_info, context[:config].project.tasks)
         [200, task_info.to_json]
       end
+    rescue Bolt::Error => e
+      [400, e.to_json]
     end
 
     # Fetches the list of plans for an environment, optionally fetching all metadata for each plan
@@ -570,6 +584,7 @@ module BoltServer
     #
     # @param project_ref [String] the project to fetch the list of plans from
     get '/project_plans' do
+      return MISSING_PROJECT_REF_RESPONSE if params['project_ref'].nil?
       in_bolt_project(params['project_ref']) do |context|
         plans_response = plan_list(context[:pal])
 
@@ -582,6 +597,8 @@ module BoltServer
         # to bolt-server smaller/simpler.
         [200, plans_response.to_json]
       end
+    rescue Bolt::Error => e
+      [400, e.to_json]
     end
 
     # Fetches the list of tasks for an environment
@@ -603,6 +620,7 @@ module BoltServer
     #
     # @param project_ref [String] the project to fetch the list of tasks from
     get '/project_tasks' do
+      return MISSING_PROJECT_REF_RESPONSE if params['project_ref'].nil?
       in_bolt_project(params['project_ref']) do |context|
         tasks_response = task_list(context[:pal])
 
@@ -615,28 +633,69 @@ module BoltServer
         # to bolt-server smaller/simpler.
         [200, tasks_response.to_json]
       end
+    rescue Bolt::Error => e
+      [400, e.to_json]
     end
 
     # Implements puppetserver's file_metadatas endpoint for projects.
     #
     # @param project_ref [String] the project_ref to fetch the file metadatas from
     get '/project_file_metadatas/:module_name/*' do
+      return MISSING_PROJECT_REF_RESPONSE if params['project_ref'].nil?
       in_bolt_project(params['project_ref']) do |context|
         file = params[:splat].first
         metadatas = file_metadatas(context[:pal], params[:module_name], file)
         [200, metadatas.to_json]
       end
+    rescue Bolt::Error => e
+      [400, e.to_json]
     rescue ArgumentError => e
       [400, e.message]
     end
 
+    # Returns a list of targets parsed from a Project inventory
+    #
+    # @param project_ref [String] the project_ref to compute the inventory from
+    post '/project_inventory_targets' do
+      return MISSING_PROJECT_REF_RESPONSE if params['project_ref'].nil?
+      content_type :json
+      body = JSON.parse(request.body.read)
+      error = validate_schema(@schemas["connect-data"], body)
+      return [400, error_result(error).to_json] unless error.nil?
+      in_bolt_project(params['project_ref']) do |context|
+        if context[:config].inventoryfile &&
+           context[:config].project.inventory_file.to_s !=
+           context[:config].inventoryfile
+          raise Bolt::ValidationError, "Project inventory must be defined in the " \
+            "inventory.yaml file at the root of the project directory"
+        end
+
+        Bolt::Util.validate_file('inventory file', context[:config].project.inventory_file)
+
+        begin
+          connect_plugin = BoltServer::Plugin::PuppetConnectData.new(body['puppet_connect_data'])
+          plugins = Bolt::Plugin.setup(context[:config], context[:pal], load_plugins: false)
+          plugins.add_plugin(connect_plugin)
+          inventory = Bolt::Inventory.from_config(context[:config], plugins)
+          target_list = inventory.get_targets('all').map { |targ| targ.to_h.merge({ 'transport' => targ.transport }) }
+        rescue Bolt::Plugin::PluginError::LoadingDisabled => e
+          msg = "Cannot load plugin #{e.details['plugin_name']}: plugin not supported"
+          raise BoltServer::Plugin::PluginNotSupported.new(msg, e.details['plugin_name'])
+        end
+
+        [200, target_list.to_json]
+      end
+    rescue Bolt::Error => e
+      [500, e.to_json]
+    end
+
     error 404 do
       err = Bolt::Error.new("Could not find route #{request.path}",
                             'boltserver/not-found')
       [404, err.to_json]
     end
 
-    error 500 do
+    error StandardError do
       e = env['sinatra.error']
       err = Bolt::Error.new("500: Unknown error: #{e.message}",
                             'boltserver/server-error')

data/lib/bolt_spec/plans/mock_executor.rb

@@ -17,12 +17,13 @@ module BoltSpec
 
     # Nothing on the executor is 'public'
     class MockExecutor
-      attr_reader :noop, :error_message
+      attr_reader :noop, :error_message, :in_parallel
       attr_accessor :run_as, :transport_features, :execute_any_plan
 
       def initialize(modulepath)
         @noop = false
         @run_as = nil
+        @in_parallel = false
         @error_message = nil
         @allow_apply = false
         @modulepath = [modulepath].flatten.map { |path| File.absolute_path(path) }
@@ -133,6 +134,7 @@ module BoltSpec
         # through to another conditional statement
         doub = @plan_doubles[plan_name] || @plan_doubles[:default]
 
+        # rubocop:disable Lint/DuplicateBranch
         # High level:
         #  - If we've explicitly allowed execution of the plan (normally the main plan
         #    passed into BoltSpec::Plan::run_plan()), then execute it
@@ -165,6 +167,7 @@ module BoltSpec
           @error_message = "Unexpected call to 'run_plan(#{plan_name}, #{params_str})'"
           raise UnexpectedInvocation, @error_message
         end
+        # rubocop:enable Lint/DuplicateBranch
         result
       end
 

data/libexec/apply_catalog.rb

@@ -74,7 +74,7 @@ begin
     Puppet::ResourceApi::Transport.inject_device(type, transport)
 
     Puppet[:facts_terminus] = :network_device
-    Puppet[:certname] = conn_info['uri']
+    Puppet[:certname] = conn_info['name']
   end
 
   # Ensure custom facts are available for provider suitability tests

data/libexec/custom_facts.rb

@@ -51,7 +51,7 @@ Dir.mktmpdir do |puppet_root|
     Puppet::ResourceApi::Transport.inject_device(type, transport)
 
     Puppet[:facts_terminus] = :network_device
-    Puppet[:certname] = conn_info['uri']
+    Puppet[:certname] = conn_info['name']
   end
 
   facts = Puppet::Node::Facts.indirection.find(SecureRandom.uuid, environment: env)

data/libexec/query_resources.rb

@@ -59,7 +59,7 @@ Dir.mktmpdir do |puppet_root|
     Puppet::ResourceApi::Transport.inject_device(type, transport)
 
     Puppet[:facts_terminus] = :network_device
-    Puppet[:certname] = conn_info['uri']
+    Puppet[:certname] = conn_info['name']
   end
 
   resources = args['resources'].flat_map do |resource_desc|

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bolt
 version: !ruby/object:Gem::Version
-  version: 2.33.1
+  version: 2.37.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-11-02 00:00:00.000000000 Z
+date: 2020-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -185,9 +185,6 @@ dependencies:
     - - ">="
       - !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
@@ -195,9 +192,6 @@ dependencies:
     - - ">="
       - !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
@@ -404,6 +398,7 @@ files:
 - bolt-modules/boltlib/lib/puppet/functions/get_resources.rb
 - bolt-modules/boltlib/lib/puppet/functions/get_target.rb
 - bolt-modules/boltlib/lib/puppet/functions/get_targets.rb
+- bolt-modules/boltlib/lib/puppet/functions/parallelize.rb
 - bolt-modules/boltlib/lib/puppet/functions/puppetdb_fact.rb
 - bolt-modules/boltlib/lib/puppet/functions/puppetdb_query.rb
 - bolt-modules/boltlib/lib/puppet/functions/remove_from_group.rb
@@ -463,6 +458,7 @@ files:
 - lib/bolt/config/transport/remote.rb
 - lib/bolt/config/transport/ssh.rb
 - lib/bolt/config/transport/winrm.rb
+- lib/bolt/config/validator.rb
 - lib/bolt/error.rb
 - lib/bolt/executor.rb
 - lib/bolt/inventory.rb
@@ -506,19 +502,21 @@ files:
 - lib/bolt/pal/yaml_plan/step/task.rb
 - lib/bolt/pal/yaml_plan/step/upload.rb
 - lib/bolt/pal/yaml_plan/transpiler.rb
+- lib/bolt/plan_creator.rb
 - lib/bolt/plan_result.rb
 - lib/bolt/plugin.rb
+- lib/bolt/plugin/cache.rb
 - lib/bolt/plugin/env_var.rb
 - lib/bolt/plugin/module.rb
 - lib/bolt/plugin/prompt.rb
 - lib/bolt/plugin/puppetdb.rb
 - lib/bolt/plugin/task.rb
 - lib/bolt/project.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/project_manager.rb
+- lib/bolt/project_manager/config_migrator.rb
+- lib/bolt/project_manager/inventory_migrator.rb
+- lib/bolt/project_manager/migrator.rb
+- lib/bolt/project_manager/module_migrator.rb
 - lib/bolt/puppetdb.rb
 - lib/bolt/puppetdb/client.rb
 - lib/bolt/puppetdb/config.rb
@@ -554,15 +552,19 @@ files:
 - lib/bolt/util.rb
 - lib/bolt/util/puppet_log_level.rb
 - lib/bolt/version.rb
+- lib/bolt/yarn.rb
 - lib/bolt_server/acl.rb
 - lib/bolt_server/base_config.rb
 - lib/bolt_server/config.rb
 - lib/bolt_server/file_cache.rb
+- lib/bolt_server/plugin.rb
+- lib/bolt_server/plugin/puppet_connect_data.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
 - lib/bolt_server/schemas/action-run_task.json
 - lib/bolt_server/schemas/action-upload_file.json
+- lib/bolt_server/schemas/connect-data.json
 - lib/bolt_server/schemas/partials/target-any.json
 - lib/bolt_server/schemas/partials/target-ssh.json
 - lib/bolt_server/schemas/partials/target-winrm.json

data/lib/bolt/project_migrator.rb

@@ -1,80 +0,0 @@
-# frozen_string_literal: true
-
-require 'bolt/project_migrator/config'
-require 'bolt/project_migrator/inventory'
-require 'bolt/project_migrator/modules'
-
-module Bolt
-  class ProjectMigrator
-    def initialize(config, outputter)
-      @config    = config
-      @outputter = outputter
-    end
-
-    def migrate
-      unless $stdin.tty?
-        raise Bolt::Error.new(
-          "stdin is not a tty, unable to migrate project",
-          'bolt/stdin-not-a-tty-error'
-        )
-      end
-
-      @outputter.print_message("Migrating project #{@config.project.path}\n\n")
-
-      @outputter.print_action_step(
-        "Migrating a Bolt project may make irreversible changes to the project's "\
-        "configuration and inventory files. Before continuing, make sure the "\
-        "project has a backup or uses a version control system."
-      )
-
-      return 0 unless Bolt::Util.prompt_yes_no("Continue with project migration?", @outputter)
-
-      @outputter.print_message('')
-
-      ok = migrate_inventory && migrate_config && migrate_modules
-
-      if ok
-        @outputter.print_message("Project successfully migrated")
-      else
-        @outputter.print_error("Project could not be migrated completely")
-      end
-
-      ok ? 0 : 1
-    end
-
-    # Migrates the project-level configuration file to the latest version.
-    #
-    private def migrate_config
-      migrator = Bolt::ProjectMigrator::Config.new(@outputter)
-
-      migrator.migrate(
-        @config.project.config_file,
-        @config.project.project_file,
-        @config.inventoryfile || @config.project.inventory_file,
-        @config.project.backup_dir
-      )
-    end
-
-    # Migrates the inventory file to the latest version.
-    #
-    private def migrate_inventory
-      migrator = Bolt::ProjectMigrator::Inventory.new(@outputter)
-
-      migrator.migrate(
-        @config.inventoryfile || @config.project.inventory_file,
-        @config.project.backup_dir
-      )
-    end
-
-    # Migrates the project's modules to use current best practices.
-    #
-    private def migrate_modules
-      migrator = Bolt::ProjectMigrator::Modules.new(@outputter)
-
-      migrator.migrate(
-        @config.project,
-        @config.modulepath
-      )
-    end
-  end
-end