puppet 4.0.0 → 4.10.0

data/lib/puppet/pops/loader/module_loaders.rb

@@ -1,4 +1,5 @@
-
+module Puppet::Pops
+module Loader
 # =ModuleLoaders
 # A ModuleLoader loads items from a single module.
 # The ModuleLoaders (ruby) module contains various such loaders. There is currently one concrete
@@ -14,12 +15,14 @@
 # internal layout etc.)
 #
 # A module loader is also not aware of the mapping of name to relative paths - this is performed by the
-# included module Puppet::Pops::Loader::PathBasedInstantatorConfig which knows about the map from type/name to
+# included module PathBasedInstantatorConfig which knows about the map from type/name to
 # relative path, and the logic that can instantiate what is expected to be found in the content of that path.
 #
 # @api private
 #
-module Puppet::Pops::Loader::ModuleLoaders
+module ModuleLoaders
+  ENVIRONMENT = 'environment'.freeze
+
   def self.system_loader_from(parent_loader, loaders)
     # Puppet system may be installed in a fixed location via RPM, installed as a Gem, via source etc.
     # The only way to find this across the different ways puppet can be installed is
@@ -27,22 +30,43 @@ module Puppet::Pops::Loader::ModuleLoaders
     # puppet.
     #
     puppet_lib = File.join(File.dirname(__FILE__), '../../..')
-    Puppet::Pops::Loader::ModuleLoaders::FileBased.new(parent_loader,
+    ModuleLoaders::FileBased.new(parent_loader,
                                                        loaders,
                                                        nil,
-                                                       puppet_lib,
-                                                       'puppet_system')
+                                                       puppet_lib,   # may or may not have a 'lib' above 'puppet'
+                                                       'puppet_system',
+                                                        [:func_4x]   # only load ruby functions from "puppet"
+                                                       )
+  end
+
+  def self.environment_loader_from(parent_loader, loaders, env_path)
+    ModuleLoaders::FileBased.new(parent_loader,
+      loaders,
+      ENVIRONMENT,
+      File.join(env_path, 'lib'),
+      ENVIRONMENT
+    )
   end
 
   def self.module_loader_from(parent_loader, loaders, module_name, module_path)
-    Puppet::Pops::Loader::ModuleLoaders::FileBased.new(parent_loader,
+    ModuleLoaders::FileBased.new(parent_loader,
                                                        loaders,
                                                        module_name,
                                                        File.join(module_path, 'lib'),
-                                                       module_name)
+                                                       module_name
+                                                       )
   end
 
-  class AbstractPathBasedModuleLoader < Puppet::Pops::Loader::BaseLoader
+  def self.pcore_resource_type_loader_from(parent_loader, loaders, environment_path)
+    ModuleLoaders::FileBased.new(parent_loader,
+      loaders,
+      nil,
+      environment_path,
+      'pcore_resource_types'
+    )
+  end
+
+  class AbstractPathBasedModuleLoader < BaseLoader
 
     # The name of the module, or nil, if this is a global "component"
     attr_reader :module_name
@@ -61,27 +85,39 @@ module Puppet::Pops::Loader::ModuleLoaders
     attr_accessor :private_loader
 
     # Initialize a kind of ModuleLoader for one module
-    # @param parent_loader [Puppet::Pops::Loader] loader with higher priority
+    # @param parent_loader [Loader] loader with higher priority
+    # @param loaders [Loaders] the container for this loader
     # @param module_name [String] the name of the module (non qualified name), may be nil for a global "component"
     # @param path [String] the path to the root of the module (semantics defined by subclass)
     # @param loader_name [String] a name that is used for human identification (useful when module_name is nil)
     #
-    def initialize(parent_loader, loaders, module_name, path, loader_name)
+    def initialize(parent_loader, loaders, module_name, path, loader_name, loadables)
       super parent_loader, loader_name
 
       @module_name = module_name
       @path = path
-      @smart_paths = Puppet::Pops::Loader::LoaderPaths::SmartPaths.new(self)
+      @smart_paths = LoaderPaths::SmartPaths.new(self)
       @loaders = loaders
+      @loadables = loadables
+      unless (loadables - LOADABLE_KINDS).empty?
+        raise ArgumentError, 'given loadables are not of supported loadable kind'
+      end
+      loaders.add_loader_by_name(self)
+    end
+
+    def loadables
+      @loadables
     end
 
     # Finds typed/named entity in this module
-    # @param typed_name [Puppet::Pops::Loader::TypedName] the type/name to find
-    # @return [Puppet::Pops::Loader::Loader::NamedEntry, nil found/created entry, or nil if not found
+    # @param typed_name [TypedName] the type/name to find
+    # @return [Loader::NamedEntry, nil found/created entry, or nil if not found
     #
     def find(typed_name)
+      # This loader is tailored to only find entries in the current runtime
+      return nil unless typed_name.name_authority == Pcore::RUNTIME_NAME_AUTHORITY
+
       # Assume it is a global name, and that all parts of the name should be used when looking up
-      name_part_index = 0
       name_parts = typed_name.name_parts
 
       # Certain types and names can be disqualified up front
@@ -93,10 +129,6 @@ module Puppet::Pops::Loader::ModuleLoaders
         # ok since such a "module" cannot have namespaced content).
         #
         return nil unless name_parts[0] == module_name
-
-        # Skip the first part of the name when computing the path since the path already contains the name of the
-        # module
-        name_part_index = 1
       else
         # The name is in the global name space.
 
@@ -104,6 +136,8 @@ module Puppet::Pops::Loader::ModuleLoaders
         case typed_name.type
         when :function
         when :resource_type
+        when :resource_type_pp
+        when :type
         else
           # anything else cannot possibly be in this module
           # TODO: should not be allowed anyway... may have to revisit this decision
@@ -116,7 +150,7 @@ module Puppet::Pops::Loader::ModuleLoaders
       # Find the file to instantiate, and instantiate the entity if file is found
       origin = nil
       if (smart_path = smart_paths.effective_paths(typed_name.type).find do |sp|
-          origin = sp.effective_path(typed_name, name_part_index)
+          origin = sp.effective_path(typed_name, global? ? 0 : 1)
           existing_path(origin)
         end)
         value = smart_path.instantiator.create(self, typed_name, origin, get_contents(origin))
@@ -172,12 +206,20 @@ module Puppet::Pops::Loader::ModuleLoaders
       raise NotImplementedError.new
     end
 
+    # Answers the question if this loader represents a global component (true for resource type loader and environment loader)
+    #
+    # @return [Boolean] `true` if this loader represents a global component
+    #
+    def global?
+      module_name.nil? || module_name == ENVIRONMENT
+    end
+
     # Produces the private loader for the module. If this module is not already resolved, this will trigger resolution
     #
     def private_loader
       # The system loader has a nil module_name and it does not have a private_loader as there are no functions
-      # that can only by called by puppet runtime - if so, it acts as the privuate loader directly.
-      @private_loader ||= ((module_name.nil? && self) || @loaders.private_loader_for_module(module_name))
+      # that can only by called by puppet runtime - if so, it acts as the private loader directly.
+      @private_loader ||= (global? ? self : @loaders.private_loader_for_module(module_name))
     end
   end
 
@@ -190,12 +232,12 @@ module Puppet::Pops::Loader::ModuleLoaders
 
     # Create a kind of ModuleLoader for one module (Puppet Module, or module like)
     #
-    # @param parent_loader [Puppet::Pops::Loader::Loader] typically the loader for the environment or root
+    # @param parent_loader [Loader] typically the loader for the environment or root
     # @param module_name [String] the name of the module (non qualified name), may be nil for "modules" only containing globals
     # @param path [String] the path to the root of the module (semantics defined by subclass)
     # @param loader_name [String] a name that identifies the loader
     #
-    def initialize(parent_loader, loaders, module_name, path, loader_name)
+    def initialize(parent_loader, loaders, module_name, path, loader_name, loadables = LOADABLE_KINDS)
       super
       @path_index = Set.new()
     end
@@ -220,7 +262,7 @@ module Puppet::Pops::Loader::ModuleLoaders
     end
 
     def get_contents(effective_path)
-      Puppet::FileSystem.read(effective_path)
+      Puppet::FileSystem.read(effective_path, :encoding => 'utf-8')
     end
   end
 
@@ -235,7 +277,7 @@ module Puppet::Pops::Loader::ModuleLoaders
   # @api private
   #
   class GemBased < FileBased
-    include Puppet::Pops::Loader::GemSupport
+    include GemSupport
 
     attr_reader :gem_ref
 
@@ -246,9 +288,9 @@ module Puppet::Pops::Loader::ModuleLoaders
     # * gem_ref - [URI, String] gem reference to the root of the module (URI, gem://gemname/optional/path/in/gem), or
     #     just the gem's name as a String.
     #
-    def initialize(parent_loader, loaders, module_name, gem_ref, loader_name)
+    def initialize(parent_loader, loaders, module_name, gem_ref, loader_name, loadables = LOADABLE_KINDS)
       @gem_ref = gem_ref
-      super parent_loader, loaders, module_name, gem_dir(gem_ref), loader_name
+      super parent_loader, loaders, module_name, gem_dir(gem_ref), loader_name, loadables
     end
 
     def to_s()
@@ -256,3 +298,5 @@ module Puppet::Pops::Loader::ModuleLoaders
     end
   end
 end
+end
+end

data/lib/puppet/pops/loader/null_loader.rb

@@ -6,7 +6,7 @@ class Puppet::Pops::Loader::NullLoader < Puppet::Pops::Loader::Loader
   # Construct a NullLoader, optionally with a parent loader
   #
   def initialize(parent_loader=nil, loader_name = "null-loader")
-    @loader_name = loader_name
+    super(loader_name)
     @parent = parent_loader
   end
 
@@ -15,6 +15,14 @@ class Puppet::Pops::Loader::NullLoader < Puppet::Pops::Loader::Loader
     @parent
   end
 
+  def find(typed_name)
+    if @parent.nil?
+      nil
+    else
+      @parent.find(typed_name)
+    end
+  end
+
   def load_typed(typed_name)
     if @parent.nil?
       nil
@@ -23,6 +31,14 @@ class Puppet::Pops::Loader::NullLoader < Puppet::Pops::Loader::Loader
     end
   end
 
+  def loaded_entry(typed_name, check_dependencies = false)
+    if @parent.nil?
+      nil
+    else
+      @parent.loaded_entry(typed_name, check_dependencies)
+    end
+  end
+
   # Has no entries on its own - always nil
   def get_entry(typed_name)
     nil

data/lib/puppet/pops/loader/predefined_loader.rb

@@ -0,0 +1,29 @@
+module Puppet::Pops::Loader
+
+# A PredefinedLoader is a loader that is manually populated with loaded elements
+# before being used. It never loads anything on its own.
+# When searching for a type, it must exist or an error is raised
+#
+class PredefinedLoader < BaseLoader
+  def find(typed_name)
+    if typed_name.type == :type
+      raise Puppet::Pops::Loaders::LoaderError, "Cannot load undefined type '#{typed_name.name.capitalize}'"
+    else
+      nil
+    end
+  end
+
+  def to_s()
+    "(PredefinedLoader '#{loader_name}')"
+  end
+
+  # Allows shadowing since this loader is used internally for things like function local types
+  # And they should win as there is otherwise a risk that the local types clash with built in types
+  # that were added after the function was written, or by resource types loaded by the 3x auto loader.
+  #
+  def allow_shadowing?
+    true
+  end
+end
+
+end

data/lib/puppet/pops/loader/puppet_function_instantiator.rb

@@ -0,0 +1,84 @@
+module Puppet::Pops
+module Loader
+# The PuppetFunctionInstantiator instantiates a Puppet::Functions::PuppetFunction given a Puppet Programming language
+# source that when called evaluates the Puppet logic it contains.
+#
+class PuppetFunctionInstantiator
+  # Produces an instance of the Function class with the given typed_name, or fails with an error if the
+  # given puppet source does not produce this instance when evaluated.
+  #
+  # @param loader [Loader] The loader the function is associated with
+  # @param typed_name [TypedName] the type / name of the function to load
+  # @param source_ref [URI, String] a reference to the source / origin of the puppet code to evaluate
+  # @param pp_code_string [String] puppet code in a string
+  #
+  # @return [Functions::Function] - an instantiated function with global scope closure associated with the given loader
+  #
+  def self.create(loader, typed_name, source_ref, pp_code_string)
+    parser = Parser::EvaluatingParser.new()
+
+    # parse and validate
+    result = parser.parse_string(pp_code_string, source_ref)
+    # Only one function is allowed (and no other definitions)
+    case result.model.definitions.size
+    when 0
+      raise ArgumentError, "The code loaded from #{source_ref} does not define the function '#{typed_name.name}' - it is empty."
+    when 1
+      # ok
+    else
+      raise ArgumentError, "The code loaded from #{source_ref} must contain only the function '#{typed_name.name}' - it has additional definitions."
+    end
+    the_function_definition = result.model.definitions[0]
+
+    unless the_function_definition.is_a?(Model::FunctionDefinition)
+      raise ArgumentError, "The code loaded from #{source_ref} does not define the function '#{typed_name.name}' - no function found."
+    end
+    unless the_function_definition.name == typed_name.name
+      expected = typed_name.name
+      actual = the_function_definition.name
+      raise ArgumentError, "The code loaded from #{source_ref} produced function with the wrong name, expected #{expected}, actual #{actual}"
+    end
+    unless result.model().body == the_function_definition
+      raise ArgumentError, "The code loaded from #{source_ref} contains additional logic - can only contain the function #{typed_name.name}"
+    end
+
+    # Adapt the function definition with loader - this is used from logic contained in it body to find the
+    # loader to use when making calls to the new function API. Such logic have a hard time finding the closure (where
+    # the loader is known - hence this mechanism
+    private_loader = loader.private_loader
+    Adapters::LoaderAdapter.adapt(the_function_definition).loader_name = private_loader.loader_name
+
+    # Cannot bind loaded functions to global scope, that must be done without binding that scope as
+    # loaders survive a compilation.
+    closure_scope = nil # Puppet.lookup(:global_scope) { {} }
+
+    created = create_function_class(the_function_definition)
+    # create the function instance - it needs closure (scope), and loader (i.e. where it should start searching for things
+    # when calling functions etc.
+    # It should be bound to global scope
+
+    created.new(closure_scope, private_loader)
+  end
+
+  # Creates Function class and instantiates it based on a FunctionDefinition model
+  # @return [Array<TypedName, Functions.Function>] - array of
+  #   typed name, and an instantiated function with global scope closure associated with the given loader
+  #
+  def self.create_from_model(function_definition, loader)
+    created = create_function_class(function_definition)
+    typed_name = TypedName.new(:function, function_definition.name)
+    [typed_name, created.new(nil, loader)]
+  end
+
+  def self.create_function_class(function_definition)
+    # Create a 4x function wrapper around a named closure
+    Puppet::Functions.create_function(function_definition.name, Puppet::Functions::PuppetFunction) do
+      # TODO: should not create a new evaluator per function
+      init_dispatch(Evaluator::Closure::Named.new(
+        function_definition.name,
+        Evaluator::EvaluatorImpl.new(), function_definition))
+    end
+  end
+end
+end
+end

data/lib/puppet/pops/loader/puppet_resource_type_impl_instantiator.rb

@@ -0,0 +1,80 @@
+module Puppet::Pops
+module Loader
+# The PuppetResourceTypeImplInstantiator instantiates a Puppet::Pops::ResourceTypeImpl object.
+# given a Puppet Programming language source that when called evaluates the Puppet logic it contains.
+#
+class PuppetResourceTypeImplInstantiator
+  # Produces an instance of Puppet::Pops::ResourceTypeImpl, or fails with an error if the
+  # given puppet source does not produce such an instance when evaluated.
+  #
+  # @param loader [Loader] The loader the function is associated with
+  # @param typed_name [TypedName] the type / name of the resoure type impl to load
+  # @param source_ref [URI, String] a reference to the source / origin of the puppet code to evaluate
+  # @param pp_code_string [String] puppet code in a string
+  #
+  # @return [Puppet::Pops::ResourceTypeImpl] - an instantiated ResourceTypeImpl
+  #
+  def self.create(loader, typed_name, source_ref, pp_code_string)
+    parser = Parser::EvaluatingParser.new()
+
+    # parse and validate
+    result = parser.parse_string(pp_code_string, source_ref)
+    model = result.model
+    statements = if model.is_a?(Model::Program)
+      if model.body.is_a?(Model::BlockExpression)
+        statements = model.body.statements
+      else
+        statements = [model.body]
+      end
+    else
+      statements = EMPTY_ARRAY
+    end
+    statements = statements.reject { |s| s.is_a?(Model::Nop) }
+    if statements.empty?
+      raise ArgumentError, "The code loaded from #{source_ref} does not create the resource type '#{typed_name.name}' - it is empty"
+    end
+
+    rname = Resource::ResourceTypeImpl._ptype.name
+    unless statements.find do |s|
+      if s.is_a?(Model::CallMethodExpression)
+        functor_expr = s.functor_expr
+        functor_expr.is_a?(Model::NamedAccessExpression) &&
+          functor_expr.left_expr.is_a?(Model::QualifiedReference) &&
+          functor_expr.left_expr.cased_value == rname &&
+          functor_expr.right_expr.is_a?(Model::QualifiedName) &&
+          functor_expr.right_expr.value == 'new'
+      else
+        false
+      end
+    end
+      raise ArgumentError, "The code loaded from #{source_ref} does not create the resource type '#{typed_name.name}' - no call to #{rname}.new found."
+    end
+
+    unless statements.size == 1
+      raise ArgumentError, "The code loaded from #{source_ref} must contain only the creation of resource type '#{typed_name.name}' - it has additional logic."
+    end
+
+    closure_scope = Puppet.lookup(:global_scope) { {} }
+    resource_type_impl = parser.evaluate(closure_scope, result)
+
+    unless resource_type_impl.is_a?(Puppet::Pops::Resource::ResourceTypeImpl)
+      got = resource_type.class
+      raise ArgumentError, "The code loaded from #{source_ref} does not define the resource type '#{typed_name.name}' - got '#{got}'."
+    end
+
+    unless resource_type_impl.name == typed_name.name
+      expected = typed_name.name
+      actual = resource_type_impl.name
+      raise ArgumentError, "The code loaded from #{source_ref} produced resource type with the wrong name, expected '#{expected}', actual '#{actual}'"
+    end
+
+    # Adapt the resource type definition with loader - this is used from logic contained in it body to find the
+    # loader to use when making calls to the new function API. Such logic have a hard time finding the closure (where
+    # the loader is known - hence this mechanism
+    Adapters::LoaderAdapter.adapt(resource_type_impl).loader_name = loader.loader_name
+    resource_type_impl
+  end
+
+end
+end
+end

data/lib/puppet/pops/loader/ruby_function_instantiator.rb

@@ -16,7 +16,10 @@ class Puppet::Pops::Loader::RubyFunctionInstantiator
     unless ruby_code_string.is_a?(String) && ruby_code_string =~ /Puppet\:\:Functions\.create_function/
       raise ArgumentError, "The code loaded from #{source_ref} does not seem to be a Puppet 4x API function - no create_function call."
     end
-    created = eval(ruby_code_string, nil, source_ref, 1)
+    # make the private loader available in a binding to allow it to be passed on
+    loader_for_function = loader.private_loader
+    here = get_binding(loader_for_function)
+    created = eval(ruby_code_string, here, source_ref, 1)
     unless created.is_a?(Class)
       raise ArgumentError, "The code loaded from #{source_ref} did not produce a Function class when evaluated. Got '#{created.class}'"
     end
@@ -27,8 +30,17 @@ class Puppet::Pops::Loader::RubyFunctionInstantiator
     # when calling functions etc.
     # It should be bound to global scope
 
-    # TODO: Cheating wrt. scope - assuming it is found in the context
-    closure_scope = Puppet.lookup(:global_scope) { {} }
-    created.new(closure_scope, loader.private_loader)
+    # Sets closure scope to nil, to let it be picked up at runtime from Puppet.lookup(:global_scope)
+    # If function definition used the loader from the binding to create a new loader, that loader wins
+    created.new(nil, loader_for_function)
+  end
+
+  private
+
+  # Produces a binding where the given loader is bound as a local variable (loader_injected_arg). This variable can be used in loaded
+  # ruby code - e.g. to call Puppet::Function.create_loaded_function(:name, loader,...)
+  #
+  def self.get_binding(loader_injected_arg)
+    binding
   end
 end

data/lib/puppet/pops/loader/runtime3_type_loader.rb

@@ -0,0 +1,96 @@
+module Puppet::Pops
+module Loader
+
+# Runtime3TypeLoader
+# ===
+# Loads a resource type using the 3.x type loader
+#
+# @api private
+class Runtime3TypeLoader < BaseLoader
+  def initialize(parent_loader, loaders, environment, env_path)
+    super(parent_loader, environment.name)
+    @environment = environment
+    @resource_3x_loader = env_path.nil? ? nil : ModuleLoaders.pcore_resource_type_loader_from(parent_loader, loaders, env_path)
+  end
+
+  def to_s()
+    "(Runtime3TypeLoader '#{loader_name()}')"
+  end
+
+  # Finds typed/named entity in this module
+  # @param typed_name [TypedName] the type/name to find
+  # @return [Loader::NamedEntry, nil found/created entry, or nil if not found
+  #
+  def find(typed_name)
+    return nil unless typed_name.name_authority == Pcore::RUNTIME_NAME_AUTHORITY
+    case typed_name.type
+    when :type
+      value = nil
+      name = typed_name.name
+      if @resource_3x_loader.nil?
+        value = Puppet::Type.type(name) unless typed_name.qualified?
+        if value.nil?
+          # Look for a user defined type
+          value = @environment.known_resource_types.find_definition(name)
+        end
+      else
+        impl_te = find_impl(TypedName.new(:resource_type_pp, name, typed_name.name_authority))
+        value = impl_te.value unless impl_te.nil?
+      end
+
+      if value.nil?
+        # Cache the fact that it wasn't found
+        set_entry(typed_name, nil)
+        return nil
+      end
+
+      # Loaded types doesn't have the same life cycle as this loader, so we must start by
+      # checking if the type was created. If it was, an entry will already be stored in
+      # this loader. If not, then it was created before this loader was instantiated and
+      # we must therefore add it.
+      te = get_entry(typed_name)
+      te = set_entry(typed_name, Types::TypeFactory.resource(value.name.to_s)) if te.nil? || te.value.nil?
+      te
+    when :resource_type_pp
+      @resource_3x_loader.nil? ? nil : find_impl(typed_name)
+    else
+      nil
+    end
+  end
+
+  # Find the implementation for the resource type by first consulting the internal loader for pp defined 'Puppet::Resource::ResourceType3'
+  # instances, then check for a Puppet::Type and lastly check for a defined type.
+  #
+  def find_impl(typed_name)
+    name = typed_name.name
+    te = StaticLoader::BUILTIN_TYPE_NAMES_LC.include?(name) ? nil : @resource_3x_loader.load_typed(typed_name)
+    if te.nil? || te.value.nil?
+      # Look for Puppet::Type
+      value = Puppet::Type.type(name) unless typed_name.qualified?
+      if value.nil?
+        # Look for a user defined type
+        value = @environment.known_resource_types.find_definition(name)
+        if value.nil?
+          # Cache the fact that it wasn't found
+          @resource_3x_loader.set_entry(typed_name, nil)
+          return nil
+        end
+      end
+      te = @resource_3x_loader.get_entry(typed_name)
+      te = @resource_3x_loader.set_entry(typed_name, value) if te.nil? || te.value.nil?
+    end
+    te
+  end
+  private :find_impl
+
+  # Allows shadowing since this loader is populalted with all loaded resource types at time
+  # of loading. This loading will, for built in types override the aliases configured in the static
+  # loader.
+  #
+  def allow_shadowing?
+    true
+  end
+
+end
+end
+end