puppet 4.0.0 → 4.5.0

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

@@ -4,7 +4,7 @@
 # The central loader knowledge about paths, what they represent and how to instantiate from them.
 # Contains helpers (*smart paths*) to deal with lazy resolution of paths.
 #
-# TODO: Currently only supports loading of functions (3 kinds)
+# TODO: Currently only supports loading of functions (2 kinds)
 #
 module Puppet::Pops::Loader::LoaderPaths
   # Returns an array of SmartPath, each instantiated with a reference to the given loader (for root path resolution
@@ -12,10 +12,19 @@ module Puppet::Pops::Loader::LoaderPaths
   # mutated.
   #
   def self.relative_paths_for_type(type, loader)
-    result =
+    result = []
     case type
     when :function
-        [FunctionPath4x.new(loader)]
+        # Only include support for the loadable items the loader states it can contain
+        if loader.loadables.include?(:func_4x)
+          result << FunctionPath4x.new(loader)
+        end
+        if loader.loadables.include?(:func_4xpp)
+          result << FunctionPathPP.new(loader)
+        end
+        # When wanted also add FunctionPath3x to load 3x functions
+    when :type
+      result << TypePathPP.new(loader) if loader.loadables.include?(:type_pp)
     else
       # unknown types, simply produce an empty result; no paths to check, nothing to find... move along...
       []
@@ -44,8 +53,12 @@ module Puppet::Pops::Loader::LoaderPaths
     def generic_path()
       return @generic_path unless @generic_path.nil?
 
-      root_path = @loader.path
-      @generic_path = (root_path.nil? ? relative_path : File.join(root_path, relative_path))
+      the_root_path = root_path() # @loader.path
+      @generic_path = (the_root_path.nil? ? relative_path : File.join(the_root_path, relative_path))
+    end
+
+    def root_path
+      @loader.path
     end
 
     # Effective path is the generic path + the name part(s) + extension.
@@ -64,8 +77,10 @@ module Puppet::Pops::Loader::LoaderPaths
   end
 
   class RubySmartPath < SmartPath
+    EXTENSION = '.rb'.freeze
+
     def extension
-      ".rb"
+      EXTENSION
     end
 
     # Duplication of extension information, but avoids one call
@@ -74,6 +89,29 @@ module Puppet::Pops::Loader::LoaderPaths
     end
   end
 
+  # A PuppetSmartPath is rooted at the loader's directory one level up from what the loader specifies as it
+  # path (which is a reference to its 'lib' directory.
+  #
+  class PuppetSmartPath < SmartPath
+    EXTENSION = '.pp'.freeze
+
+    def extension
+      EXTENSION
+    end
+
+    def root_path
+      # Drop the lib part (it may not exist and cannot be navigated to in a relative way)
+      Puppet::FileSystem.dir_string(@loader.path)
+    end
+
+    # Duplication of extension information, but avoids one call
+    def effective_path(typed_name, start_index_in_name)
+      # Puppet name to path always skips the name-space as that is part of the generic path
+      # i.e. <module>/mymodule/functions/foo.pp is the function mymodule::foo
+      "#{File.join(generic_path, typed_name.name_parts[ 1..-1 ])}.pp"
+    end
+  end
+
   class FunctionPath4x < RubySmartPath
     FUNCTION_PATH_4X = File.join('puppet', 'functions')
 
@@ -86,6 +124,44 @@ module Puppet::Pops::Loader::LoaderPaths
     end
   end
 
+  class FunctionPath3x < RubySmartPath
+    FUNCTION_PATH_3X = File.join('puppet', 'parser', 'functions')
+
+    def relative_path
+      FUNCTION_PATH_3X
+    end
+
+    def instantiator()
+      Puppet::Pops::Loader::RubyLegacyFunctionInstantiator
+    end
+  end
+
+  class FunctionPathPP < PuppetSmartPath
+    # Navigate to directory where 'lib' is, then down again
+    FUNCTION_PATH_PP = File.join('functions')
+
+    def relative_path
+      FUNCTION_PATH_PP
+    end
+
+    def instantiator()
+      Puppet::Pops::Loader::PuppetFunctionInstantiator
+    end
+  end
+
+  class TypePathPP < PuppetSmartPath
+    # Navigate to directory where 'lib' is, then down again
+    TYPE_PATH_PP = File.join('types')
+
+    def relative_path
+      TYPE_PATH_PP
+    end
+
+    def instantiator()
+      Puppet::Pops::Loader::TypeDefinitionInstantiator
+    end
+  end
+
   # SmartPaths
   # ===
   # Holds effective SmartPath instances per type

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,12 @@
 # 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
   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 +28,25 @@ 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.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
+  class AbstractPathBasedModuleLoader < BaseLoader
 
     # The name of the module, or nil, if this is a global "component"
     attr_reader :module_name
@@ -61,23 +65,31 @@ 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 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
+    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)
       # Assume it is a global name, and that all parts of the name should be used when looking up
@@ -104,6 +116,7 @@ module Puppet::Pops::Loader::ModuleLoaders
         case typed_name.type
         when :function
         when :resource_type
+        when :type
         else
           # anything else cannot possibly be in this module
           # TODO: should not be allowed anyway... may have to revisit this decision
@@ -176,7 +189,7 @@ module Puppet::Pops::Loader::ModuleLoaders
     #
     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.
+      # that can only by called by puppet runtime - if so, it acts as the private loader directly.
       @private_loader ||= ((module_name.nil? && self) || @loaders.private_loader_for_module(module_name))
     end
   end
@@ -190,12 +203,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 +233,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 +248,7 @@ module Puppet::Pops::Loader::ModuleLoaders
   # @api private
   #
   class GemBased < FileBased
-    include Puppet::Pops::Loader::GemSupport
+    include GemSupport
 
     attr_reader :gem_ref
 
@@ -246,9 +259,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 +269,5 @@ module Puppet::Pops::Loader::ModuleLoaders
     end
   end
 end
+end
+end

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,83 @@
+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 = private_loader
+
+    # TODO: Cheating wrt. scope - assuming it is found in the context
+    closure_scope = Puppet.lookup(:global_scope) { {} }
+
+    created = create_function_class(the_function_definition, closure_scope)
+    # 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<Loader::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)
+    closure_scope = Puppet.lookup(:global_scope) { {} }
+    created = create_function_class(function_definition, closure_scope)
+    typed_name = Loader::TypedName.new(:function, function_definition.name)
+    [typed_name, created.new(closure_scope, loader)]
+  end
+
+  def self.create_function_class(function_definition, closure_scope)
+    # Create a 4x function wrapper around a named closure
+    Puppet::Functions.create_function(function_definition.name, Puppet::Functions::PuppetFunction) do
+      init_dispatch(Evaluator::Closure::Named.new(
+        function_definition.name,
+        Evaluator::EvaluatorImpl.new(), function_definition, closure_scope))
+    end
+  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,18 @@ 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
+    # Cheating wrt. scope - assuming it is found in the context (else an empty hash is used).
     closure_scope = Puppet.lookup(:global_scope) { {} }
-    created.new(closure_scope, loader.private_loader)
+    # If function definition used the loader from the binding to create a new loader, that loader wins
+    created.new(closure_scope, 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,57 @@
+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, environment)
+    super(parent_loader, environment.name)
+    @environment = environment
+  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.type == :type
+
+    name = typed_name.name
+    value = @environment.known_resource_types.find_definition(name)
+    if value.nil?
+      # Look for Puppet::Type
+      value = Puppet::Type.type(name)
+      if value.nil?
+        # Cache the fact that it wasn't found
+        set_entry(typed_name, nil)
+        return nil
+      end
+    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
+  end
+
+  # 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

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

@@ -1,12 +1,16 @@
   # Static Loader contains constants, basic data types and other types required for the system
   # to boot.
   #
-class Puppet::Pops::Loader::StaticLoader < Puppet::Pops::Loader::Loader
+module Puppet::Pops
+module Loader
+class StaticLoader < Loader
 
   attr_reader :loaded
   def initialize
     @loaded = {}
     create_logging_functions()
+    create_built_in_types()
+    create_resource_type_references()
   end
 
   def load_typed(typed_name)
@@ -29,14 +33,17 @@ class Puppet::Pops::Loader::StaticLoader < Puppet::Pops::Loader::Loader
   def to_s()
     "(StaticLoader)"
   end
-  private
 
-  def load_constant(typed_name)
+  def loaded_entry(typed_name, _)
     @loaded[typed_name]
   end
 
   private
 
+  def load_constant(typed_name)
+    @loaded[typed_name]
+  end
+
   # Creates a function for each of the specified log levels
   #
   def create_logging_functions()
@@ -70,10 +77,90 @@ class Puppet::Pops::Loader::StaticLoader < Puppet::Pops::Loader::Loader
         end
       end
 
-      typed_name = Puppet::Pops::Loader::Loader::TypedName.new(:function, level)
+      typed_name = TypedName.new(:function, level)
       # TODO:closure scope is fake (an empty hash) - waiting for new global scope to be available via lookup of :scopes
       func = fc.new({},self)
-      @loaded[ typed_name ] = Puppet::Pops::Loader::Loader::NamedEntry.new(typed_name, func, __FILE__)
+      @loaded[ typed_name ] = NamedEntry.new(typed_name, func, __FILE__)
+    end
+  end
+
+  def create_built_in_types
+    origin_uri = URI("puppet:Puppet-Type-System/Static-Loader")
+    type_map = Puppet::Pops::Types::TypeParser.type_map
+    type_map.each do |name, type|
+      typed_name = TypedName.new(:type, name)
+      @loaded[ typed_name ] = NamedEntry.new(typed_name, type, origin_uri)#__FILE__)
     end
   end
+
+  def create_resource_type_references()
+    # These needs to be done quickly and we do not want to scan the file system for these
+    # We are also not interested in their definition only that they exist.
+    # These types are in all environments.
+    #
+    %w{
+      Auegas
+      Component
+      Computer
+      Cron
+      Exec
+      File
+      Filebucket
+      Group
+      Host
+      Interface
+      K5login
+      Macauthorization
+      Mailalias
+      Maillist
+      Mcx
+      Mount
+      Nagios_command
+      Nagios_contact
+      Nagios_contactgroup
+      Nagios_host
+      Nagios_hostdependency
+      Nagios_hostescalation
+      Nagios_hostgroup
+      Nagios_hostextinfo
+      Nagios_service
+      Nagios_servicedependency
+      Nagios_serviceescalation
+      Nagios_serviceextinfo
+      Nagios_servicegroup
+      Nagios_timeperiod
+      Notify
+      Package
+      Resources
+      Router
+      Schedule
+      Scheduled_task
+      Selboolean
+      Selmodule
+      Service
+      Ssh_authorized_key
+      Sshkey
+      Stage
+      Tidy
+      User
+      Vlan
+      Whit
+      Yumrepo
+      Zfs
+      Zone
+      Zpool
+    }.each { |name| create_resource_type_reference(name) }
+
+    if Puppet[:app_management]
+      create_resource_type_reference('Node')
+    end
+  end
+
+  def create_resource_type_reference(name)
+    typed_name = TypedName.new(:type, name.downcase)
+    type = Puppet::Pops::Types::TypeFactory.resource(name)
+    @loaded[ typed_name ] = NamedEntry.new(typed_name, type, __FILE__)
+  end
+end
+end
 end