puppet 4.0.0 → 4.9.1

data/lib/puppet/pops/evaluator/closure.rb

@@ -1,3 +1,44 @@
+module Puppet::Pops
+module Evaluator
+  class Jumper < Exception
+    attr_reader :value
+    attr_reader :file
+    attr_reader :line
+    def initialize(value, file, line)
+      @value = value
+      @file = file
+      @line = line
+    end
+  end
+
+  class Next < Jumper
+    def initialize(value, file, line)
+      super
+    end
+  end
+
+  class Return < Jumper
+    def initialize(value, file, line)
+      super
+    end
+  end
+
+  class PuppetStopIteration < StopIteration
+    attr_reader :file
+    attr_reader :line
+    attr_reader :pos
+
+    def initialize(file, line, pos = nil)
+      @file = file
+      @line = line
+      @pos = pos
+    end
+
+    def message
+      "break() from context where this is illegal"
+    end
+  end
+
 # A Closure represents logic bound to a particular scope.
 # As long as the runtime (basically the scope implementation) has the behavior of Puppet 3x it is not
 # safe to return and later use this closure.
@@ -11,75 +52,65 @@
 # Note that this class is a CallableSignature, and the methods defined there should be used
 # as the API for obtaining information in a callable-implementation agnostic way.
 #
-class Puppet::Pops::Evaluator::Closure < Puppet::Pops::Evaluator::CallableSignature
+class Closure < CallableSignature
   attr_reader :evaluator
   attr_reader :model
   attr_reader :enclosing_scope
 
-  def initialize(evaluator, model, scope)
+  def initialize(evaluator, model)
     @evaluator = evaluator
     @model = model
-    @enclosing_scope = scope
   end
 
   # Evaluates a closure in its enclosing scope after having matched given arguments with parameters (from left to right)
   # @api public
   def call(*args)
-    variable_bindings = combine_values_with_parameters(args)
-
-    tc = Puppet::Pops::Types::TypeCalculator
-    final_args = tc.infer_set(parameters.inject([]) do |tmp_args, param|
-      if param.captures_rest
-        tmp_args.concat(variable_bindings[param.name])
-      else
-        tmp_args << variable_bindings[param.name]
-      end
-    end)
+    call_with_scope(enclosing_scope, args)
+  end
 
-    if tc.callable?(type, final_args)
-      @evaluator.evaluate_block_with_bindings(@enclosing_scope, variable_bindings, @model.body)
-    else
-      raise ArgumentError, "lambda called with mis-matched arguments\n#{Puppet::Pops::Evaluator::CallableMismatchDescriber.diff_string('lambda', final_args, [self])}"
+  # This method makes a Closure compatible with a Dispatch. This is used when the closure is wrapped in a Function
+  # and the function is called. (Saves an extra Dispatch that just delegates to a Closure and avoids having two
+  # checks of the argument type/arity validity).
+  # @api private
+  def invoke(instance, calling_scope, args, &block)
+    enclosing_scope.with_global_scope do |global_scope|
+      call_with_scope(global_scope, args, &block)
     end
   end
 
   # Call closure with argument assignment by name
   def call_by_name(args_hash, enforce_parameters)
+    closure_scope = enclosing_scope
     if enforce_parameters
-      if args_hash.size > parameters.size
-        raise ArgumentError, "Too many arguments: #{args_hash.size} for #{parameters.size}"
-      end
-
-      # associate values with parameters
-      scope_hash = {}
-      parameters.each do |p|
-        name = p.name
-        if (arg_value = args_hash[name]).nil?
-          # only set result of default expr if it is defined (it is otherwise not possible to differentiate
-          # between explicit undef and no default expression
-          unless p.value.nil?
-            scope_hash[name] = @evaluator.evaluate(p.value, @enclosing_scope)
+      # Push a temporary parameter scope used while resolving the parameter defaults
+      closure_scope.with_parameter_scope(closure_name, parameter_names) do |param_scope|
+        # Assign all non-nil values, even those that represent non-existent paramaters.
+        args_hash.each { |k, v| param_scope[k] = v unless v.nil? }
+        parameters.each do |p|
+          name = p.name
+          arg = args_hash[name]
+          if arg.nil?
+            # Arg either wasn't given, or it was undef
+            if p.value.nil?
+              # No default. Assign nil if the args_hash included it
+              param_scope[name] = nil if args_hash.include?(name)
+            else
+              param_scope[name] = param_scope.evaluate(name, p.value, closure_scope, @evaluator)
+            end
           end
-        else
-          scope_hash[name] = arg_value
         end
+        args_hash = param_scope.to_hash
       end
-
-      missing = parameters.select { |p| !scope_hash.include?(p.name) }
-      if missing.any?
-        raise ArgumentError, "Too few arguments; no value given for required parameters #{missing.collect(&:name).join(" ,")}"
+      Types::TypeMismatchDescriber.validate_parameters(closure_name, params_struct, args_hash)
+      result = catch(:next) do
+        @evaluator.evaluate_block_with_bindings(closure_scope, args_hash, @model.body)
       end
-
-      tc = Puppet::Pops::Types::TypeCalculator
-      final_args = tc.infer_set(parameter_names.collect { |param| scope_hash[param] })
-      if !tc.callable?(type, final_args)
-        raise ArgumentError, "lambda called with mis-matched arguments\n#{Puppet::Pops::Evaluator::CallableMismatchDescriber.diff_string('lambda', final_args, [self])}"
+      Types::TypeAsserter.assert_instance_of(nil, return_type, result) do
+        "value returned from #{closure_name}"
       end
     else
-      scope_hash = args_hash
+      @evaluator.evaluate_block_with_bindings(closure_scope, args_hash, @model.body)
     end
-
-    @evaluator.evaluate_block_with_bindings(@enclosing_scope, scope_hash, @model.body)
   end
 
   def parameters
@@ -98,11 +129,20 @@ class Puppet::Pops::Evaluator::Closure < Puppet::Pops::Evaluator::CallableSignat
     @model.parameters.collect(&:name)
   end
 
+  def return_type
+    @return_type ||= create_return_type
+  end
+
   # @api public
   def type
     @callable ||= create_callable_type
   end
 
+  # @api public
+  def params_struct
+    @params_struct ||= create_params_struct
+  end
+
   # @api public
   def last_captures_rest?
     last = @model.parameters[-1]
@@ -115,101 +155,201 @@ class Puppet::Pops::Evaluator::Closure < Puppet::Pops::Evaluator::CallableSignat
     'unsupported_block'
   end
 
+  CLOSURE_NAME = 'lambda'.freeze
+
+  # @api public
+  def closure_name()
+    CLOSURE_NAME
+  end
+
+  class Dynamic < Closure
+    def initialize(evaluator, model, scope)
+      @enclosing_scope = scope
+      super(evaluator, model)
+    end
+
+    def enclosing_scope
+      @enclosing_scope
+    end
+
+    def call(*args)
+      # A return from an unnamed closure is treated as a return from the context evaluating
+      # calling this closure - that is, as if it was the return call itself.
+      #
+      jumper = catch(:return) do
+        return call_with_scope(enclosing_scope, args)
+      end
+      raise jumper
+    end
+  end
+
+  class Named < Closure
+    def initialize(name, evaluator, model)
+      @name = name
+      super(evaluator, model)
+    end
+
+    def closure_name
+      @name
+    end
+
+    # The assigned enclosing scope, or global scope if enclosing scope was initialized to nil
+    #
+    def enclosing_scope
+      # Named closures are typically used for puppet functions and they cannot be defined
+      # in an enclosing scope as they are cashed and reused. They need to bind to the
+      # global scope at time of use rather at time of definition.
+      # Unnamed closures are always a runtime construct, they are never bound by a loader
+      # and are thus garbage collected at end of a compilation.
+      #
+      Puppet.lookup(:global_scope) { {} }
+    end
+  end
+
   private
 
-  def combine_values_with_parameters(args)
-    variable_bindings = {}
+  def call_with_scope(scope, args)
+    variable_bindings = combine_values_with_parameters(scope, args)
 
-    parameters.each_with_index do |parameter, index|
-      param_captures     = parameter.captures_rest
-      default_expression = parameter.value
+    tc = Types::TypeCalculator.singleton
+    final_args = tc.infer_set(parameters.reduce([]) do |tmp_args, param|
+      if param.captures_rest
+        tmp_args.concat(variable_bindings[param.name])
+      else
+        tmp_args << variable_bindings[param.name]
+      end
+    end)
 
-      if index >= args.size
-        if default_expression
-          # not given, has default
-          value = @evaluator.evaluate(default_expression, @enclosing_scope)
-          if param_captures && !value.is_a?(Array)
-            # correct non array default value
-            value = [value]
+    if type.callable?(final_args)
+      result = catch(:next) do
+        @evaluator.evaluate_block_with_bindings(scope, variable_bindings, @model.body)
+      end
+      Types::TypeAsserter.assert_instance_of(nil, return_type, result) do
+        "value returned from #{closure_name}"
+      end
+    else
+      raise ArgumentError, Types::TypeMismatchDescriber.describe_signatures(closure_name, [self], final_args)
+    end
+  end
+
+  def combine_values_with_parameters(scope, args)
+    scope.with_parameter_scope(closure_name, parameter_names) do |param_scope|
+      parameters.each_with_index do |parameter, index|
+        param_captures     = parameter.captures_rest
+        default_expression = parameter.value
+
+        if index >= args.size
+          if default_expression
+            # not given, has default
+            value = param_scope.evaluate(parameter.name, default_expression, scope, @evaluator)
+
+            if param_captures && !value.is_a?(Array)
+              # correct non array default value
+              value = [value]
+            end
+          else
+            # not given, does not have default
+            if param_captures
+              # default for captures rest is an empty array
+              value = []
+            else
+              @evaluator.fail(Issues::MISSING_REQUIRED_PARAMETER, parameter, { :param_name => parameter.name })
+            end
           end
         else
-          # not given, does not have default
+          given_argument = args[index]
           if param_captures
-            # default for captures rest is an empty array
-            value = []
+            # get excess arguments
+            value = args[(parameter_count-1)..-1]
+            # If the input was a single nil, or undef, and there is a default, use the default
+            # This supports :undef in case it was used in a 3x data structure and it is passed as an arg
+            #
+            if value.size == 1 && (given_argument.nil? || given_argument == :undef) && default_expression
+              value = param_scope.evaluate(parameter.name, default_expression, scope, @evaluator)
+              # and ensure it is an array
+              value = [value] unless value.is_a?(Array)
+            end
           else
-            @evaluator.fail(Puppet::Pops::Issues::MISSING_REQUIRED_PARAMETER, parameter, { :param_name => parameter.name })
+            value = given_argument
           end
         end
-      else
-        given_argument = args[index]
-        if param_captures
-          # get excess arguments
-          value = args[(parameter_count-1)..-1]
-          # If the input was a single nil, or undef, and there is a default, use the default
-          # This supports :undef in case it was used in a 3x data structure and it is passed as an arg
-          #
-          if value.size == 1 && (given_argument.nil? || given_argument == :undef) && default_expression
-            value = @evaluator.evaluate(default_expression, @enclosing_scope)
-            # and ensure it is an array
-            value = [value] unless value.is_a?(Array)
-          end
-        else
-          value = given_argument
-        end
+        param_scope[parameter.name] = value
       end
-
-      variable_bindings[parameter.name] = value
+      param_scope.to_hash
     end
-
-    variable_bindings
   end
 
   def create_callable_type()
     types = []
-    range = [0, 0]
+    from = 0
+    to = 0
     in_optional_parameters = false
+    closure_scope = enclosing_scope
+
     parameters.each do |param|
-      type = if param.type_expr
-               @evaluator.evaluate(param.type_expr, @enclosing_scope)
-             else
-               Puppet::Pops::Types::TypeFactory.any()
-             end
-
-      if param.captures_rest && type.is_a?(Puppet::Pops::Types::PArrayType)
-        # An array on a slurp parameter is how a size range is defined for a
-        # slurp (Array[Integer, 1, 3] *$param). However, the callable that is
-        # created can't have the array in that position or else type checking
-        # will require the parameters to be arrays, which isn't what is
-        # intended. The array type contains the intended information and needs
-        # to be unpacked.
-        param_range = type.size_range
-        type = type.element_type
-      elsif param.captures_rest && !type.is_a?(Puppet::Pops::Types::PArrayType)
-        param_range = ANY_NUMBER_RANGE
-      elsif param.value
-        param_range = OPTIONAL_SINGLE_RANGE
-      else
-        param_range = REQUIRED_SINGLE_RANGE
-      end
+      type, param_range = create_param_type(param, closure_scope)
 
       types << type
 
       if param_range[0] == 0
         in_optional_parameters = true
       elsif param_range[0] != 0 && in_optional_parameters
-        @evaluator.fail(Puppet::Pops::Issues::REQUIRED_PARAMETER_AFTER_OPTIONAL, param, { :param_name => param.name })
+        @evaluator.fail(Issues::REQUIRED_PARAMETER_AFTER_OPTIONAL, param, { :param_name => param.name })
       end
 
-      range[0] += param_range[0]
-      range[1] += param_range[1]
+      from += param_range[0]
+      to += param_range[1]
+    end
+    param_types = Types::PTupleType.new(types, Types::PIntegerType.new(from, to))
+    Types::PCallableType.new(param_types, nil, return_type)
+  end
+
+  def create_params_struct
+    type_factory = Types::TypeFactory
+    members = {}
+    closure_scope = enclosing_scope
+
+    parameters.each do |param|
+      arg_type, param_range = create_param_type(param, closure_scope)
+      key_type = type_factory.string(param.name.to_s)
+      key_type = type_factory.optional(key_type) unless param.value.nil?
+      members[key_type] = arg_type
     end
+    type_factory.struct(members)
+  end
 
-    if range[1] == Float::INFINITY
-      range[1] = :default
+  def create_return_type
+    if @model.return_type
+      @evaluator.evaluate(@model.return_type, @enclosing_scope)
+    else
+      Types::PAnyType::DEFAULT
     end
+  end
 
-    Puppet::Pops::Types::TypeFactory.callable(*(types + range))
+  def create_param_type(param, closure_scope)
+    type = if param.type_expr
+             @evaluator.evaluate(param.type_expr, closure_scope)
+           else
+             Types::PAnyType::DEFAULT
+           end
+
+    if param.captures_rest && type.is_a?(Types::PArrayType)
+      # An array on a slurp parameter is how a size range is defined for a
+      # slurp (Array[Integer, 1, 3] *$param). However, the callable that is
+      # created can't have the array in that position or else type checking
+      # will require the parameters to be arrays, which isn't what is
+      # intended. The array type contains the intended information and needs
+      # to be unpacked.
+      param_range = type.size_range
+      type = type.element_type
+    elsif param.captures_rest && !type.is_a?(Types::PArrayType)
+      param_range = ANY_NUMBER_RANGE
+    elsif param.value
+      param_range = OPTIONAL_SINGLE_RANGE
+    else
+      param_range = REQUIRED_SINGLE_RANGE
+    end
+    [type, param_range]
   end
 
   # Produces information about parameters compatible with a 4x Function (which can have multiple signatures)
@@ -221,3 +361,5 @@ class Puppet::Pops::Evaluator::Closure < Puppet::Pops::Evaluator::CallableSignat
   OPTIONAL_SINGLE_RANGE = [0, 1]
   REQUIRED_SINGLE_RANGE = [1, 1]
 end
+end
+end

data/lib/puppet/pops/evaluator/collector_transformer.rb

@@ -1,33 +1,36 @@
-class Puppet::Pops::Evaluator::CollectorTransformer
+module Puppet::Pops
+module Evaluator
+class CollectorTransformer
 
   def initialize
-    @@query_visitor    ||= Puppet::Pops::Visitor.new(nil, "query", 1, 1)
-    @@match_visitor    ||= Puppet::Pops::Visitor.new(nil, "match", 1, 1)
-    @@evaluator        ||= Puppet::Pops::Evaluator::EvaluatorImpl.new
-    @@compare_operator ||= Puppet::Pops::Evaluator::CompareOperator.new()
+    @@query_visitor    ||= Visitor.new(nil, "query", 1, 1)
+    @@match_visitor    ||= Visitor.new(nil, "match", 1, 1)
+    @@evaluator        ||= EvaluatorImpl.new
+    @@compare_operator ||= CompareOperator.new()
   end
 
   def transform(o, scope)
-    raise ArgumentError, "Expected CollectExpression" unless o.is_a? Puppet::Pops::Model::CollectExpression
+    raise ArgumentError, "Expected CollectExpression" unless o.is_a? Model::CollectExpression
 
-    raise "LHS is not a type" unless o.type_expr.is_a? Puppet::Pops::Model::QualifiedReference
+    raise "LHS is not a type" unless o.type_expr.is_a? Model::QualifiedReference
     type = o.type_expr.value().downcase()
 
     if type == 'class'
       fail "Classes cannot be collected"
     end
 
-    resource_type = scope.find_resource_type(type)
+    resource_type = Runtime3ResourceSupport.find_resource_type(scope, type)
+
     fail "Resource type #{type} doesn't exist" unless resource_type
 
-    adapter = Puppet::Pops::Adapters::SourcePosAdapter.adapt(o)
+    adapter = Adapters::SourcePosAdapter.adapt(o)
     line_num = adapter.line
     position = adapter.pos
     file_path = adapter.locator.file
 
     if !o.operations.empty?
       overrides = {
-        :parameters => o.operations.map{ |x| to_3x_param(x).evaluate(scope)},
+        :parameters => o.operations.map{ |x| @@evaluator.evaluate(x, scope)}.flatten,
         :file       => file_path,
         :line       => [line_num, position],
         :source     => scope.source,
@@ -38,11 +41,11 @@ class Puppet::Pops::Evaluator::CollectorTransformer
     code = query_unless_nop(o.query, scope)
 
     case o.query
-    when Puppet::Pops::Model::VirtualQuery
-      newcoll = Puppet::Pops::Evaluator::Collectors::CatalogCollector.new(scope, resource_type.name, code, overrides)
-    when Puppet::Pops::Model::ExportedQuery
+    when Model::VirtualQuery
+      newcoll = Collectors::CatalogCollector.new(scope, resource_type.name, code, overrides)
+    when Model::ExportedQuery
       match = match_unless_nop(o.query, scope)
-      newcoll = Puppet::Pops::Evaluator::Collectors::ExportedCollector.new(scope, resource_type.name, match, code, overrides)
+      newcoll = Collectors::ExportedCollector.new(scope, resource_type.name, match, code, overrides)
     end
 
     scope.compiler.add_collection(newcoll)
@@ -61,13 +64,13 @@ protected
   end
 
   def query_unless_nop(query, scope)
-    unless query.expr.nil? || query.expr.is_a?(Puppet::Pops::Model::Nop)
+    unless query.expr.nil? || query.expr.is_a?(Model::Nop)
       query(query.expr, scope)
     end
   end
 
   def match_unless_nop(query, scope)
-    unless query.expr.nil? || query.expr.is_a?(Puppet::Pops::Model::Nop)
+    unless query.expr.nil? || query.expr.is_a?(Model::Nop)
       match(query.expr, scope)
     end
   end
@@ -125,6 +128,14 @@ protected
     end
   end
 
+ def query_AccessExpression(o, scope)
+    pops_object = @@evaluator.evaluate(o, scope)
+
+    # Convert to Puppet 3 style objects since that is how they are represented
+    # in the catalog.
+    @@evaluator.convert(pops_object, scope, nil)
+  end
+
   def query_VariableExpression(o, scope)
     @@evaluator.evaluate(o, scope)
   end
@@ -145,6 +156,10 @@ protected
     @@evaluator.evaluate(o, scope)
   end
 
+  def query_LiteralUndef(o, scope)
+    nil
+  end
+
   def query_QualifiedName(o, scope)
     @@evaluator.evaluate(o, scope)
   end
@@ -157,6 +172,14 @@ protected
     raise ArgumentError, "Cannot transform object of class #{o.class}"
   end
 
+  def match_AccessExpression(o, scope)
+    pops_object = @@evaluator.evaluate(o, scope)
+
+    # Convert to Puppet 3 style objects since that is how they are represented
+    # in the catalog.
+    @@evaluator.convert(pops_object, scope, nil)
+  end
+
   def match_AndExpression(o, scope)
     left_match = match(o.left_expr, scope)
     right_match = match(o.right_expr, scope)
@@ -187,6 +210,10 @@ protected
     @@evaluator.evaluate(o, scope)
   end
 
+  def match_LiteralUndef(o, scope)
+    nil
+  end
+
   def match_ConcatenatedString(o, scope)
     @@evaluator.evaluate(o, scope)
   end
@@ -206,14 +233,6 @@ protected
   def match_Object(o, scope)
     raise ArgumentError, "Cannot transform object of class #{o.class}"
   end
-
-  # Produces (name => expr) or (name +> expr)
-  def to_3x_param(o)
-    bridge = Puppet::Parser::AST::PopsBridge::Expression.new(:value => o.value_expr)
-    args = { :value => bridge }
-    args[:add] = true if o.operator == :'+>'
-    args[:param] = o.attribute_name
-    args= Puppet::Pops::Model::AstTransformer.new().merge_location(args, o)
-    Puppet::Parser::AST::ResourceParam.new(args)
-  end
+end
+end
 end

data/lib/puppet/pops/evaluator/collectors/abstract_collector.rb

@@ -61,7 +61,7 @@ class Puppet::Pops::Evaluator::Collectors::AbstractCollector
 
     return false if objects.empty?
 
-    objects.inject(@collected) { |c,o| c[o.ref]=o; c }
+    objects.reduce(@collected) { |c,o| c[o.ref]=o; c }
 
     objects
   end

data/lib/puppet/pops/evaluator/collectors/catalog_collector.rb

@@ -22,4 +22,8 @@ class Puppet::Pops::Evaluator::Collectors::CatalogCollector < Puppet::Pops::Eval
       resource.type == t && (q ?  q.call(resource) : true)
     end
   end
+
+  def to_s
+    "Catalog-Collector[#{@type.to_s}]"
+  end
 end

data/lib/puppet/pops/evaluator/collectors/exported_collector.rb

@@ -19,7 +19,6 @@ class Puppet::Pops::Evaluator::Collectors::ExportedCollector < Puppet::Pops::Eva
   # evaluate method
   def evaluate
     if Puppet[:storeconfigs] != true
-      Puppet.warning "Not collecting exported resources without storeconfigs"
       return false
     end
 
@@ -45,7 +44,7 @@ class Puppet::Pops::Evaluator::Collectors::ExportedCollector < Puppet::Pops::Eva
       found_resources = found.map {|x| x.is_a?(Puppet::Parser::Resource) ? x : x.to_resource(@scope)}
 
       found_resources.each do |item|
-        if existing = @scope.findresource(item.type, item.title)
+        if existing = @scope.findresource(item.resource_type, item.title)
           unless existing.collector_id == item.collector_id
             raise Puppet::ParseError,
               "A duplicate resource was found while collecting exported resources, with the type and title #{item.ref}"
@@ -63,4 +62,8 @@ class Puppet::Pops::Evaluator::Collectors::ExportedCollector < Puppet::Pops::Eva
 
     resources
   end
+
+  def to_s
+    "Exported-Collector[#{@type.to_s}]"
+  end
 end