bolt 2.37.0 → 2.38.0

data/lib/bolt/version.rb

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

data/lib/bolt_server/transport_app.rb

@@ -51,8 +51,8 @@ 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
+    MISSING_VERSIONED_PROJECT_RESPONSE = [
+      400, Bolt::ValidationError.new('`versioned_project` is a required argument').to_json
     ].freeze
 
     def initialize(config)
@@ -268,16 +268,16 @@ module BoltServer
       end
     end
 
-    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)
+    def config_from_project(versioned_project)
+      project_dir = File.join(@config['projects-dir'], versioned_project)
+      raise Bolt::ValidationError, "`versioned_project`: #{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)
+    def in_bolt_project(versioned_project)
       @pal_mutex.synchronize do
-        bolt_config = config_from_project(project_ref)
+        bolt_config = config_from_project(versioned_project)
         modulepath_object = Bolt::Config::Modulepath.new(
           bolt_config.modulepath,
           boltlib_path: [PE_BOLTLIB_PATH, Bolt::Config::Modulepath::BOLTLIB_PATH]
@@ -514,10 +514,10 @@ module BoltServer
 
     # Fetches the metadata for a single plan
     #
-    # @param project_ref [String] the project to fetch the plan from
+    # @param versioned_project [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|
+      return MISSING_VERSIONED_PROJECT_RESPONSE if params['versioned_project'].nil?
+      in_bolt_project(params['versioned_project']) 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]
@@ -541,12 +541,12 @@ module BoltServer
 
     # Fetches the metadata for a single task
     #
-    # @param bolt_project_ref [String] the reference to the bolt-project directory to load task metadata from
+    # @param bolt_versioned_project [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|
+      return MISSING_VERSIONED_PROJECT_RESPONSE if params['versioned_project'].nil?
+      in_bolt_project(params['versioned_project']) do |context|
         ps_parameters = {
-          'versioned_project' => params['project_ref']
+          'versioned_project' => params['versioned_project']
         }
         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)
@@ -582,10 +582,10 @@ module BoltServer
 
     # Fetches the list of plans for a project
     #
-    # @param project_ref [String] the project to fetch the list of plans from
+    # @param versioned_project [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|
+      return MISSING_VERSIONED_PROJECT_RESPONSE if params['versioned_project'].nil?
+      in_bolt_project(params['versioned_project']) do |context|
         plans_response = plan_list(context[:pal])
 
         # Dig in context for the allowlist of plans from project object
@@ -618,10 +618,10 @@ module BoltServer
 
     # Fetches the list of tasks for a bolt-project
     #
-    # @param project_ref [String] the project to fetch the list of tasks from
+    # @param versioned_project [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|
+      return MISSING_VERSIONED_PROJECT_RESPONSE if params['versioned_project'].nil?
+      in_bolt_project(params['versioned_project']) do |context|
         tasks_response = task_list(context[:pal])
 
         # Dig in context for the allowlist of tasks from project object
@@ -639,10 +639,10 @@ module BoltServer
 
     # Implements puppetserver's file_metadatas endpoint for projects.
     #
-    # @param project_ref [String] the project_ref to fetch the file metadatas from
+    # @param versioned_project [String] the versioned_project 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|
+      return MISSING_VERSIONED_PROJECT_RESPONSE if params['versioned_project'].nil?
+      in_bolt_project(params['versioned_project']) do |context|
         file = params[:splat].first
         metadatas = file_metadatas(context[:pal], params[:module_name], file)
         [200, metadatas.to_json]
@@ -655,14 +655,14 @@ module BoltServer
 
     # Returns a list of targets parsed from a Project inventory
     #
-    # @param project_ref [String] the project_ref to compute the inventory from
+    # @param versioned_project [String] the versioned_project to compute the inventory from
     post '/project_inventory_targets' do
-      return MISSING_PROJECT_REF_RESPONSE if params['project_ref'].nil?
+      return MISSING_VERSIONED_PROJECT_RESPONSE if params['versioned_project'].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|
+      in_bolt_project(params['versioned_project']) do |context|
         if context[:config].inventoryfile &&
            context[:config].project.inventory_file.to_s !=
            context[:config].inventoryfile

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bolt
 version: !ruby/object:Gem::Version
-  version: 2.37.0
+  version: 2.38.0
 platform: ruby
 authors:
 - Puppet
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-12-07 00:00:00.000000000 Z
+date: 2020-12-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: addressable
@@ -311,6 +311,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.14'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -318,6 +321,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '1.14'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
 - !ruby/object:Gem::Dependency
   name: octokit
   requirement: !ruby/object:Gem::Requirement
@@ -458,12 +464,12 @@ 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
 - lib/bolt/inventory/group.rb
 - lib/bolt/inventory/inventory.rb
+- lib/bolt/inventory/options.rb
 - lib/bolt/inventory/target.rb
 - lib/bolt/logger.rb
 - lib/bolt/module.rb
@@ -551,6 +557,7 @@ files:
 - lib/bolt/transport/winrm/connection.rb
 - lib/bolt/util.rb
 - lib/bolt/util/puppet_log_level.rb
+- lib/bolt/validator.rb
 - lib/bolt/version.rb
 - lib/bolt/yarn.rb
 - lib/bolt_server/acl.rb

data/lib/bolt/config/validator.rb

@@ -1,231 +0,0 @@
-# frozen_string_literal: true
-
-require 'bolt/error'
-
-# This class validates config against a schema, raising an error that includes
-# details about any invalid configuration.
-#
-module Bolt
-  class Config
-    class Validator
-      attr_reader :deprecations, :warnings
-
-      def initialize
-        @errors       = []
-        @deprecations = []
-        @warnings     = []
-        @path         = []
-      end
-
-      # This is the entry method for validating data against the schema.
-      # It loops over each key-value pair in the data hash and validates
-      # the value against the relevant schema definition.
-      #
-      def validate(data, schema, location = nil)
-        @location = location
-
-        validate_keys(data.keys, schema.keys)
-
-        data.each_pair do |key, value|
-          next unless schema.key?(key)
-
-          @path.push(key)
-
-          check_deprecated(key, schema[key], location)
-          validate_value(value, schema[key])
-        ensure
-          @path.pop
-        end
-
-        raise_error
-      end
-
-      # Adds a warning if the given option is deprecated.
-      #
-      def check_deprecated(key, definition, location)
-        if definition.key?(:_deprecation)
-          message  = "Option '#{path}' "
-          message += "at #{location} " if location
-          message += "is deprecated. #{definition[:_deprecation]}"
-          @deprecations << { option: key, message: message }
-        end
-      end
-
-      # Raises a ValidationError if there are any errors. All error messages
-      # created during validation are concatenated into a single error
-      # message.
-      #
-      private def raise_error
-        return unless @errors.any?
-
-        message = "Invalid configuration"
-        message += " at #{@location}" if @location
-        message += ":\n"
-        message += @errors.map { |error| "\s\s#{error}" }.join("\n")
-
-        raise Bolt::ValidationError, message
-      end
-
-      # Validate an individual value. This performs validation that is
-      # common to all values, including type validation. After validating
-      # the value's type, the value is passed off to an individual
-      # validation method for the value's type.
-      #
-      private def validate_value(value, definition)
-        return if plugin_reference?(value, definition)
-        return unless valid_type?(value, definition)
-
-        case value
-        when Hash
-          validate_hash(value, definition)
-        when Array
-          validate_array(value, definition)
-        when String
-          validate_string(value, definition)
-        when Numeric
-          validate_number(value, definition)
-        end
-      end
-
-      # Validates a hash value, logging errors for any validations that fail.
-      # This will enumerate each key-value pair in the hash and validate each
-      # value individually.
-      #
-      private def validate_hash(value, definition)
-        properties = definition[:properties] ? definition[:properties].keys : []
-
-        if definition[:properties] && definition[:additionalProperties].nil?
-          validate_keys(value.keys, properties)
-        end
-
-        if definition[:required] && (definition[:required] - value.keys).any?
-          missing = definition[:required] - value.keys
-          @errors << "Value at '#{path}' is missing required keys #{missing.join(', ')}"
-        end
-
-        value.each_pair do |key, val|
-          @path.push(key)
-
-          if properties.include?(key)
-            validate_value(val, definition[:properties][key])
-          elsif definition[:additionalProperties]
-            validate_value(val, definition[:additionalProperties])
-          end
-        ensure
-          @path.pop
-        end
-      end
-
-      # Validates an array value, logging errors for any validations that fail.
-      # This will enumerate the items in the array and validate each item
-      # individually.
-      #
-      private def validate_array(value, definition)
-        if definition[:uniqueItems] && value.size != value.uniq.size
-          @errors << "Value at '#{path}' must not include duplicate elements"
-          return
-        end
-
-        return unless definition.key?(:items)
-
-        value.each_with_index do |item, index|
-          @path.push(index)
-          validate_value(item, definition[:items])
-        ensure
-          @path.pop
-        end
-      end
-
-      # Validates a string value, logging errors for any validations that fail.
-      #
-      private def validate_string(value, definition)
-        if definition.key?(:enum) && !definition[:enum].include?(value)
-          message  = "Value at '#{path}' must be "
-          message += "one of " if definition[:enum].count > 1
-          message += definition[:enum].join(', ')
-          multitype_error(message, value, definition)
-        end
-      end
-
-      # Validates a numeric value, logging errors for any validations that fail.
-      #
-      private def validate_number(value, definition)
-        if definition.key?(:minimum) && value < definition[:minimum]
-          @errors << "Value at '#{path}' must be a minimum of #{definition[:minimum]}"
-        end
-      end
-
-      # Adds warnings for unknown config options.
-      #
-      private def validate_keys(keys, known_keys)
-        (keys - known_keys).each do |key|
-          message  = "Unknown option '#{key}'"
-          message += " at '#{path}'" if @path.any?
-          message += " at #{@location}" if @location
-          message += "."
-          @warnings << message
-        end
-      end
-
-      # Returns true if a value is a plugin reference. This also validates whether
-      # a value can be a plugin reference in the first place. If the value is a
-      # plugin reference but cannot be one according to the schema, then this will
-      # log an error.
-      #
-      private def plugin_reference?(value, definition)
-        if value.is_a?(Hash) && value.key?('_plugin')
-          unless definition[:_plugin]
-            @errors << "Value at '#{path}' is a plugin reference, which is unsupported at "\
-                       "this location"
-          end
-
-          true
-        else
-          false
-        end
-      end
-
-      # Asserts the type for each option against the type specified in the schema
-      # definition. The schema definition can specify multiple valid types, so the
-      # value needs to only match one of the types to be valid. Returns early if
-      # there is no type in the definition (in practice this shouldn't happen, but
-      # this will safeguard against any dev mistakes).
-      #
-      private def valid_type?(value, definition)
-        return unless definition.key?(:type)
-
-        types = Array(definition[:type])
-
-        if types.include?(value.class)
-          true
-        else
-          if types.include?(TrueClass) || types.include?(FalseClass)
-            types = types - [TrueClass, FalseClass] + ['Boolean']
-          end
-
-          @errors << "Value at '#{path}' must be of type #{types.join(' or ')}"
-
-          false
-        end
-      end
-
-      # Adds an error that includes additional helpful information for values
-      # that accept multiple types.
-      #
-      private def multitype_error(message, value, definition)
-        if Array(definition[:type]).count > 1
-          types    = Array(definition[:type]) - [value.class]
-          message += " or must be of type #{types.join(' or ')}"
-        end
-
-        @errors << message
-      end
-
-      # Returns the formatted path for the key.
-      #
-      private def path
-        @path.join('.')
-      end
-    end
-  end
-end