puppet 3.8.7 → 4.0.0.rc1

data/lib/puppet/parser/templatewrapper.rb

@@ -1,6 +1,5 @@
 require 'puppet/parser/files'
 require 'erb'
-require 'puppet/file_system'
 
 # A simple wrapper for templates, so they don't have full access to
 # the scope objects.
@@ -59,38 +58,11 @@ class Puppet::Parser::TemplateWrapper
     scope.catalog.tags
   end
 
-  # Ruby treats variables like methods, so we used to expose variables
-  # within scope to the ERB code via method_missing.  As per RedMine #1427,
-  # though, this means that conflicts between methods in our inheritance
-  # tree (Kernel#fork) and variable names (fork => "yes/no") could arise.
-  #
-  # Worse, /new/ conflicts could pop up when a new kernel or object method
-  # was added to Ruby, causing templates to suddenly fail mysteriously when
-  # Ruby was upgraded.
-  #
-  # To ensure that legacy templates using unqualified names work we retain
-  # the missing_method definition here until we declare the syntax finally
-  # dead.
-  def method_missing(name, *args)
-    line_number = script_line
-    if scope.include?(name.to_s)
-      Puppet.deprecation_warning("Variable access via '#{name}' is deprecated. Use '@#{name}' instead. #{to_s}:#{line_number}")
-      return scope[name.to_s, { :file => @__file__, :line => line_number }]
-    else
-      # Just throw an error immediately, instead of searching for
-      # other missingmethod things or whatever.
-      raise Puppet::ParseError.new("Could not find value for '#{name}'", @__file__, line_number)
-    end
-  end
-
   # @api private
   def file=(filename)
     unless @__file__ = Puppet::Parser::Files.find_template(filename, scope.compiler.environment)
       raise Puppet::ParseError, "Could not find template '#{filename}'"
     end
-
-    # We'll only ever not have a parser in testing, but, eh.
-    scope.known_resource_types.watch_file(@__file__)
   end
 
   # @api private
@@ -98,7 +70,7 @@ class Puppet::Parser::TemplateWrapper
     if string
       template_source = "inline template"
     else
-      string = Puppet::FileSystem.read_preserve_line_endings(@__file__)
+      string = File.read(@__file__)
       template_source = @__file__
     end
 

data/lib/puppet/parser/type_loader.rb

@@ -1,11 +1,12 @@
 require 'find'
 require 'forwardable'
-require 'puppet/node/environment'
 require 'puppet/parser/parser_factory'
 
 class Puppet::Parser::TypeLoader
   extend  Forwardable
 
+  class TypeLoaderError < StandardError; end
+
   # Import manifest files that match a given file glob pattern.
   #
   # @param pattern [String] the file glob to apply when determining which files
@@ -14,12 +15,10 @@ class Puppet::Parser::TypeLoader
   #   found in a module
   # @api private
   def import(pattern, dir)
-    return if Puppet[:ignoreimport]
-
     modname, files = Puppet::Parser::Files.find_manifests_in_modules(pattern, environment)
     if files.empty?
       abspat = File.expand_path(pattern, dir)
-      file_pattern = abspat + (File.extname(abspat).empty? ? '{.pp,.rb}' : '' )
+      file_pattern = abspat + (File.extname(abspat).empty? ? '.pp' : '' )
 
       files = Dir.glob(file_pattern).uniq.reject { |f| FileTest.directory?(f) }
       modname = nil
@@ -68,10 +67,10 @@ class Puppet::Parser::TypeLoader
       begin
         imported_types = import_from_modules(filename)
         if result = imported_types.find { |t| t.type == type and t.name == fqname }
-          Puppet.debug "Automatically imported #{fqname} from #{filename} into #{environment}"
+          Puppet.debug {"Automatically imported #{fqname} from #{filename} into #{environment}"}
           return result
         end
-      rescue Puppet::ImportError => detail
+      rescue TypeLoaderError => detail
         # I'm not convienced we should just drop these errors, but this
         # preserves existing behaviours.
       end
@@ -82,7 +81,7 @@ class Puppet::Parser::TypeLoader
 
   def parse_file(file)
     Puppet.debug("importing '#{file}' in environment #{environment}")
-    parser = Puppet::Parser::ParserFactory.parser(environment)
+    parser = Puppet::Parser::ParserFactory.parser
     parser.file = file
     return parser.parse
   end
@@ -99,24 +98,22 @@ class Puppet::Parser::TypeLoader
   end
 
   def raise_no_files_found(pattern)
-    raise Puppet::ImportError, "No file(s) found for import of '#{pattern}'"
+    raise TypeLoaderError, "No file(s) found for import of '#{pattern}'"
   end
 
   def load_files(modname, files)
     @loaded ||= {}
     loaded_asts = []
     files.reject { |file| @loaded[file] }.each do |file|
-      # NOTE: This ugly implementation will be replaced in Puppet 3.5.
-      # The implementation now makes use of a global variable because the context support is
-      # not available until Puppet 3.5.
-      # The use case is that parsing for the purpose of searching for information
-      # should not abort. There is currently one such use case in indirector/resourcetype/parser
-      #
+    # The squelch_parse_errors use case is for parsing for the purpose of searching
+    # for information and it should not abort.
+    # There is currently one user in indirector/resourcetype/parser
+    #
     if Puppet.lookup(:squelch_parse_errors) {|| false }
         begin
           loaded_asts << parse_file(file)
         rescue => e
-          # Resume from errors so that all parseable files would
+          # Resume from errors so that all parseable files may
           # still be parsed. Mark this file as loaded so that
           # it would not be parsed next time (handle it as if
           # it was successfully parsed).

data/lib/puppet/plugins.rb

@@ -0,0 +1,9 @@
+# The Puppet Plugins module defines extension points where plugins can be configured
+# to add or modify puppet's behavior. See the respective classes in this module for more
+# details.
+#
+# @api public
+# @since Puppet 4.0.0
+#
+module Puppet::Plugins
+end

data/lib/{puppetx/puppet/bindings_scheme_handler.rb → puppet/plugins/binding_schemes.rb}

@@ -1,4 +1,14 @@
-module Puppetx::Puppet
+require 'puppet/plugins'
+module Puppet::Plugins::BindingSchemes
+
+  # The lookup **key** for the multibind containing a map from scheme name to scheme handler class for bindings schemes.
+  # @api public
+  BINDINGS_SCHEMES_KEY  = 'puppet::binding::schemes'
+
+  # The lookup **type** for the multibind containing a map from scheme name to scheme handler class for bindings schemes.
+  # @api public
+  BINDINGS_SCHEMES_TYPE = 'Puppet::Plugins::BindingSchemes::BindingsSchemeHandler'
+
   # BindingsSchemeHandler is a Puppet Extension Point for the purpose of extending Puppet with a
   # handler of a URI scheme used in the Puppet Bindings / Injector system.
   # The intended use is to create a class derived from this class and then register it with the
@@ -9,7 +19,7 @@ module Puppetx::Puppet
   # As an example, a class for getting LDAP data and transforming into bindings based on an LDAP URI scheme (such as RFC 2255, 4516)
   # may be authored in say a puppet module called 'exampleorg/ldap'. The name of the class should start with `Puppetx::<user>::<module>`,
   # e.g. 'Puppetx::Exampleorg::Ldap::LdapBindingsSchemeHandler" and
-  # be located in `lib/puppetx/exampleorg/Ldap/LdapBindingsSchemeHandler.rb`. (These rules are not enforced, but it make the class
+  # be located in `lib/puppetx/exampleorg/Ldap/LdapBindingsSchemeHandler.rb`. (These rules are not enforced, but it makes the class
   # both auto-loadable, and guaranteed to not have a name that clashes with some other LdapBindingsSchemeHandler from some other
   # author/organization.
   #
@@ -29,7 +39,7 @@ module Puppetx::Puppet
   #
   # The expand_included method
   # --------------------------
-  # This method is given a URI (as entred by a user in a bindings configuration) and the handler's first task is to
+  # This method is given a URI (as entered by a user in a bindings configuration) and the handler's first task is to
   # perform checking, transformation, and possible expansion into multiple URIs for loading. The result is always an array
   # of URIs. This method allows users to enter wild-cards, or to represent something symbolic that is transformed into one or
   # more "real URIs" to load. (It is allowed to change scheme!).
@@ -71,7 +81,6 @@ module Puppetx::Puppet
   # @api public
   #
   class BindingsSchemeHandler
-
     # Produces the bindings contributed to the binding system based on the given URI.
     # @param uri [URI] the URI to load bindings from
     # @param scope [Puppet::Pops::Parser::Scope] access to scope and the rest of the environment
@@ -127,4 +136,5 @@ module Puppetx::Puppet
       (query = uri.query) && query == '' || query == 'optional'
     end
   end
+
 end

data/lib/puppet/plugins/configuration.rb

@@ -0,0 +1,68 @@
+# Configures the Puppet Plugins, by registering extension points
+# and default implementations.
+#
+# See the respective configured services for more information.
+#
+# @api private
+#
+require 'puppet/plugins'
+
+module Puppet::Plugins::Configuration
+    require 'puppet/plugins/binding_schemes'
+    require 'puppet/plugins/syntax_checkers'
+    require 'puppet/plugins/data_providers'
+
+    # Extension-points are registered here:
+    #
+    # - If in a Ruby submodule it is best to create it here
+    # - The class does not have to be required; it will be auto required when the binder
+    #   needs it.
+    # - If the extension is a multibind, it can be registered here; either with a required
+    #   class or a class reference in string form.
+
+    checkers_name = Puppet::Plugins::SyntaxCheckers::SYNTAX_CHECKERS_KEY
+    checkers_type = Puppet::Plugins::SyntaxCheckers::SYNTAX_CHECKERS_TYPE
+
+    schemes_name = Puppet::Plugins::BindingSchemes::BINDINGS_SCHEMES_KEY
+    schemes_type = Puppet::Plugins::BindingSchemes::BINDINGS_SCHEMES_TYPE
+
+    # Register extension points
+    # -------------------------
+    system_bindings = ::Puppet::Pops::Binder::SystemBindings
+    extensions = system_bindings.extensions()
+
+    extensions.multibind(checkers_name).name(checkers_name).hash_of(checkers_type)
+    extensions.multibind(schemes_name).name(schemes_name).hash_of(schemes_type)
+    Puppet::Plugins::DataProviders::register_extensions(extensions)
+
+    # Register injector boot bindings
+    # -------------------------------
+    boot_bindings = system_bindings.injector_boot_bindings()
+
+    # Register the default bindings scheme handlers
+    { 'module'        => 'ModuleScheme', 
+      'confdir'       => 'ConfdirScheme',
+    }.each do |scheme, class_name|
+      boot_bindings \
+        .bind.name(scheme) \
+        .instance_of(schemes_type) \
+        .in_multibind(schemes_name) \
+        .to_instance("Puppet::Pops::Binder::SchemeHandler::#{class_name}")
+    end
+
+    # Default extensions delivered in Puppet Core are included here
+    # -------------------------------------------------------------
+    # Classes in this name-space are lazily loaded as they may be overridden and/or never used
+    # (Lazy loading is done by binding to the name of a class instead of a Class instance).
+
+    # Register extensions
+    # -------------------
+    bindings = system_bindings.default_bindings()
+    bindings.bind do
+      name('json')
+      instance_of(checkers_type)
+      in_multibind(checkers_name)
+      to_instance('Puppet::SyntaxCheckers::Json')
+    end
+    Puppet::Plugins::DataProviders::register_defaults(bindings)
+end

data/lib/puppet/plugins/data_providers.rb

@@ -0,0 +1,90 @@
+module Puppet::Plugins; end
+
+class Puppet::Plugins::DataProviders
+
+  # The lookup **key** for the multibind containing data provider name per module
+  # @api public
+  PER_MODULE_DATA_PROVIDER_KEY       = 'puppet::module_data'
+
+  # The lookup **type** for the name of the per module data provider.
+  # @api public
+  PER_MODULE_DATA_PROVIDER_TYPE      = String
+
+  # The lookup **key** for the multibind containing map of provider name to env data provider implementation.
+  # @api public
+  ENV_DATA_PROVIDERS_KEY             = 'puppet::environment_data_providers'
+
+  # The lookup **type** for the multibind containing map of provider name to env data provider implementation.
+  # @api public
+  ENV_DATA_PROVIDERS_TYPE            = 'Puppet::Plugins::DataProviders::EnvironmentDataProvider'
+
+  # The lookup **key** for the multibind containing map of provider name to module data provider implementation.
+  # @api public
+  MODULE_DATA_PROVIDERS_KEY          = 'puppet::module_data_providers'
+
+  # The lookup **type** for the multibind containing map of provider name to module data provider implementation.
+  # @api public
+  MODULE_DATA_PROVIDERS_TYPE         = 'Puppet::Plugins::DataProviders::ModuleDataProvider'
+
+  def self.register_extensions(extensions)
+    extensions.multibind(PER_MODULE_DATA_PROVIDER_KEY).name(PER_MODULE_DATA_PROVIDER_KEY).hash_of(PER_MODULE_DATA_PROVIDER_TYPE)
+    extensions.multibind(ENV_DATA_PROVIDERS_KEY).name(ENV_DATA_PROVIDERS_KEY).hash_of(ENV_DATA_PROVIDERS_TYPE)
+    extensions.multibind(MODULE_DATA_PROVIDERS_KEY).name(MODULE_DATA_PROVIDERS_KEY).hash_of(MODULE_DATA_PROVIDERS_TYPE)
+  end
+
+  def self.hash_of_per_module_data_provider
+    @@HASH_OF_PER_MODULE_DATA_PROVIDERS ||= Puppet::Pops::Types::TypeFactory.hash_of(PER_MODULE_DATA_PROVIDER_TYPE)
+  end
+
+  def self.hash_of_module_data_providers
+    @@HASH_OF_MODULE_DATA_PROVIDERS ||= Puppet::Pops::Types::TypeFactory.hash_of(
+      Puppet::Pops::Types::TypeFactory.type_of(MODULE_DATA_PROVIDERS_TYPE))
+  end
+
+  def self.hash_of_environment_data_providers
+    @@HASH_OF_ENV_DATA_PROVIDERS ||= Puppet::Pops::Types::TypeFactory.hash_of(
+      Puppet::Pops::Types::TypeFactory.type_of(ENV_DATA_PROVIDERS_TYPE))
+  end
+
+  # Registers a 'none' environment data provider, and a 'none' module data provider as the defaults.
+  # This is only done to allow that something binds to 'none' rather than removing the entire binding (which
+  # has the same effect).
+  #
+  def self.register_defaults(default_bindings)
+    default_bindings.bind do
+      name('none')
+      in_multibind(ENV_DATA_PROVIDERS_KEY)
+      to_instance(ENV_DATA_PROVIDERS_TYPE)
+    end
+
+    default_bindings.bind do
+      name('function')
+      in_multibind(ENV_DATA_PROVIDERS_KEY)
+      to_instance('Puppet::DataProviders::FunctionEnvDataProvider')
+    end
+
+    default_bindings.bind do
+      name('none')
+      in_multibind(MODULE_DATA_PROVIDERS_KEY)
+      to_instance(MODULE_DATA_PROVIDERS_TYPE)
+    end
+
+    default_bindings.bind do
+      name('function')
+      in_multibind(MODULE_DATA_PROVIDERS_KEY)
+      to_instance('Puppet::DataProviders::FunctionModuleDataProvider')
+    end
+  end
+
+  class ModuleDataProvider
+    def lookup(name, scope, merge)
+      throw :no_such_key
+    end
+  end
+
+  class EnvironmentDataProvider
+    def lookup(name, scope, merge)
+      throw :no_such_key
+    end
+  end
+end

data/lib/{puppetx/puppet/syntax_checker.rb → puppet/plugins/syntax_checkers.rb}

@@ -1,4 +1,15 @@
-module Puppetx::Puppet
+require 'puppet/plugins'
+module Puppet::Plugins::SyntaxCheckers
+  # The lookup **key** for the multibind containing syntax checkers used to syntax check embedded string in non
+  # puppet DSL syntax.
+  # @api public
+  SYNTAX_CHECKERS_KEY       = 'puppet::syntaxcheckers'
+
+  # The lookup **type** for the multibind containing syntax checkers used to syntax check embedded string in non
+  # puppet DSL syntax.
+  # @api public
+  SYNTAX_CHECKERS_TYPE  = 'Puppet::Plugins::SyntaxCheckers::SyntaxChecker'
+
   # SyntaxChecker is a Puppet Extension Point for the purpose of extending Puppet with syntax checkers.
   # The intended use is to create a class derived from this class and then register it with the
   # Puppet Binder.
@@ -65,7 +76,7 @@ module Puppetx::Puppet
   #
   # Use in Puppet DSL
   # -----------------
-  # The Puppet DSL Heredoc support and Puppet Templates makes use of the syntax checker extension. A user of a
+  # The Puppet DSL Heredoc support makes use of the syntax checker extension. A user of a
   # heredoc can specify the syntax in the heredoc tag, e.g.`@(END:userdata+json)`.
   #
   #
@@ -88,4 +99,5 @@ module Puppetx::Puppet
       raise NotImplementedError, "The class #{self.class.name} should have implemented the method check()"
     end
   end
+
 end

data/lib/puppet/pops.rb

@@ -26,22 +26,25 @@ module Puppet
     require 'puppet/pops/label_provider'
     require 'puppet/pops/validation'
     require 'puppet/pops/issue_reporter'
+    require 'puppet/pops/lookup'
 
     require 'puppet/pops/model/model'
 
     # (the Types module initializes itself)
     require 'puppet/pops/types/types'
+    require 'puppet/pops/types/type_asserter'
+    require 'puppet/pops/types/type_assertion_error'
     require 'puppet/pops/types/type_calculator'
     require 'puppet/pops/types/type_factory'
     require 'puppet/pops/types/type_parser'
     require 'puppet/pops/types/class_loader'
     require 'puppet/pops/types/enumeration'
 
+    require 'puppet/pops/merge_strategy'
 
     module Model
       require 'puppet/pops/model/tree_dumper'
       require 'puppet/pops/model/ast_transformer'
-      require 'puppet/pops/model/ast_tree_dumper'
       require 'puppet/pops/model/factory'
       require 'puppet/pops/model/model_tree_dumper'
       require 'puppet/pops/model/model_label_provider'
@@ -69,7 +72,6 @@ module Puppet
       require 'puppet/pops/binder/bindings_model_dumper'
       require 'puppet/pops/binder/system_bindings'
       require 'puppet/pops/binder/bindings_loader'
-      require 'puppet/pops/binder/lookup'
 
       module Config
         require 'puppet/pops/binder/config/binder_config'
@@ -87,6 +89,7 @@ module Puppet
       require 'puppet/pops/parser/lexer2'
       require 'puppet/pops/parser/evaluating_parser'
       require 'puppet/pops/parser/epp_parser'
+      require 'puppet/pops/parser/code_merger'
     end
 
     module Validation
@@ -119,14 +122,10 @@ module Puppet
       require 'puppet/pops/functions/dispatch'
       require 'puppet/pops/functions/dispatcher'
     end
-
-    module Migration
-      require 'puppet/pops/migration/migration_checker'
-    end
   end
 
   require 'puppet/parser/ast/pops_bridge'
   require 'puppet/bindings'
   require 'puppet/functions'
-  require 'puppet/loaders'
 end
+require 'puppet/plugins/data_providers'

data/lib/puppet/pops/adaptable.rb

@@ -67,7 +67,7 @@ module Puppet::Pops::Adaptable
     # @raise [ArgumentError] if the object is not adaptable
     #
     def self.get(o)
-      attr_name = :"@#{instance_var_name(self.name)}"
+      attr_name = self_attr_name
       if o.instance_variable_defined?(attr_name)
         o.instance_variable_get(attr_name)
       else
@@ -92,7 +92,7 @@ module Puppet::Pops::Adaptable
     # @raise [ArgumentError] if the given object o is not adaptable
     #
     def self.adapt(o, &block)
-      attr_name = :"@#{instance_var_name(self.name)}"
+      attr_name = self_attr_name
       adapter = if o.instance_variable_defined?(attr_name) && value = o.instance_variable_get(attr_name)
         value
       else
@@ -145,7 +145,7 @@ module Puppet::Pops::Adaptable
     # @return [nil] if the adapter has not been set
     #
     def self.clear(o)
-      attr_name = :"@#{instance_var_name(self.name)}"
+      attr_name = self_attr_name
       if o.instance_variable_defined?(attr_name)
         o.send(:remove_instance_variable, attr_name)
       else
@@ -175,16 +175,27 @@ module Puppet::Pops::Adaptable
       adapter
     end
 
+    DOUBLE_COLON = '::'
+    USCORE = '_'
+
     # Returns a suitable instance variable name given a class name.
     # The returned string is the fully qualified name of a class with '::' replaced by '_' since
     # '::' is not allowed in an instance variable name.
     # @param name [String] the fully qualified name of a class
     # @return [String] the name with all '::' replaced by '_'
     # @api private
-    # @private
     #
     def self.instance_var_name(name)
-      name.split("::").join('_')
+      name.split(DOUBLE_COLON).join(USCORE)
+    end
+
+    # Returns a suitable instance variable name for the _name_ of this instance. The name is created by calling
+    # Adapter#instance_var_name and then cached.
+    # @return [String] the instance variable name for _name_
+    # @api private
+    #
+    def self.self_attr_name
+      @attr_name_sym ||= :"@#{instance_var_name(self.name)}"
     end
   end
 end