puppet 4.2.3 → 4.3.0

data/lib/puppet/functions/filter.rb

@@ -1,35 +1,70 @@
-# Applies a parameterized block to each element in a sequence of entries from the first
-# argument and returns an array or hash (same type as left operand for array/hash, and array for
-# other enumerable types) with the entries for which the block evaluates to `true`.
+# Applies a [lambda](http://docs.puppetlabs.com/puppet/latest/reference/lang_lambdas.html)
+# to every value in a data structure and returns an array or hash containing any elements
+# for which the lambda evaluates to `true`.
 #
-# This function takes two mandatory arguments: the first should be an Array, a Hash, or an
-# Enumerable object (integer, Integer range, or String),
-# and the second a parameterized block as produced by the puppet syntax:
+# This function takes two mandatory arguments, in this order:
 #
-#       $a.filter |$x| { ... }
-#       filter($a) |$x| { ... }
+# 1. An array or hash the function will iterate over.
+# 2. A lambda, which the function calls for each element in the first argument. It can
+# request one or two parameters.
 #
-# When the first argument is something other than a Hash, the block is called with each entry in turn.
-# When the first argument is a Hash the entry is an array with `[key, value]`.
+# @example Using the `filter` function
 #
-# @example Using filter with one parameter
+# `$filtered_data = $data.filter |$parameter| { <PUPPET CODE BLOCK> }`
 #
-#       # selects all that end with berry
-#       $a = ["raspberry", "blueberry", "orange"]
-#       $a.filter |$x| { $x =~ /berry$/ }          # rasberry, blueberry
+# or
 #
-# If the block defines two parameters, they will be set to `index, value` (with index starting at 0) for all
-# enumerables except Hash, and to `key, value` for a Hash.
+# `$filtered_data = filter($data) |$parameter| { <PUPPET CODE BLOCK> }`
 #
-# @example Using filter with two parameters
+# When the first argument (`$data` in the above example) is an array, Puppet passes each
+# value in turn to the lambda and returns an array containing the results.
 #
-#      # selects all that end with 'berry' at an even numbered index
-#      $a = ["raspberry", "blueberry", "orange"]
-#      $a.filter |$index, $x| { $index % 2 == 0 and $x =~ /berry$/ } # raspberry
+# @example Using the `filter` function with an array and a one-parameter lambda
 #
-#      # selects all that end with 'berry' and value >= 1
-#      $a = {"raspberry"=>0, "blueberry"=>1, "orange"=>1}
-#      $a.filter |$key, $x| { $x =~ /berry$/ and $x >= 1 } # blueberry
+# ~~~ puppet
+# # For the array $data, return an array containing the values that end with "berry"
+# $data = ["orange", "blueberry", "raspberry"]
+# $filtered_data = $data.filter |$items| { $items =~ /berry$/ }
+# # $filtered_data = [blueberry, raspberry]
+# ~~~
+#
+# When the first argument is a hash, Puppet passes each key and value pair to the lambda
+# as an array in the form `[key, value]` and returns a hash containing the results.
+#
+# @example Using the `filter` function with a hash and a one-parameter lambda
+#
+# ~~~ puppet
+# # For the hash $data, return a hash containing all values of keys that end with "berry"
+# $data = { "orange" => 0, "blueberry" => 1, "raspberry" => 2 }
+# $filtered_data = $data.filter |$items| { $items[0] =~ /berry$/ }
+# # $filtered_data = {blueberry => 1, raspberry => 2}
+#
+# When the first argument is an array and the lambda has two parameters, Puppet passes the
+# array's indexes (enumerated from 0) in the first parameter and its values in the second
+# parameter.
+#
+# @example Using the `filter` function with an array and a two-parameter lambda
+#
+# ~~~ puppet
+# # For the array $data, return an array of all keys that both end with "berry" and have
+# # an even-numbered index
+# $data = ["orange", "blueberry", "raspberry"]
+# $filtered_data = $data.filter |$indexes, $values| { $indexes % 2 == 0 and $values =~ /berry$/ }
+# # $filtered_data = [raspberry]
+# ~~~
+#
+# When the first argument is a hash, Puppet passes its keys to the first parameter and its
+# values to the second parameter.
+#
+# @example Using the `filter` function with a hash and a two-parameter lambda
+#
+# ~~~ puppet
+# # For the hash $data, return a hash of all keys that both end with "berry" and have 
+# # values less than or equal to 1
+# $data = { "orange" => 0, "blueberry" => 1, "raspberry" => 2 }
+# $filtered_data = $data.filter |$keys, $values| { $keys =~ /berry$/ and $values <= 1 }
+# # $filtered_data = {blueberry => 1}
+# ~~~
 #
 # @since 4.0.0
 #

data/lib/puppet/functions/hiera.rb

@@ -1,7 +1,80 @@
 require 'hiera/puppet_function'
-
-# @see lib/puppet/parser/functions/hiera.rb for documentation
-# TODO: Move docs here when the format has been determined.
+# Performs a standard priority lookup of the hierarchy and returns the most specific value
+# for a given key. The returned value can be any type of data.
+#
+# The function takes up to three arguments, in this order:
+#
+# 1. A string key that Hiera searches for in the hierarchy. **Required**.
+# 2. An optional default value to return if Hiera doesn't find anything matching the key.
+#     * If this argument isn't provided and this function results in a lookup failure, Puppet
+#     fails with a compilation error.
+# 3. The optional name of an arbitrary
+# [hierarchy level](https://docs.puppetlabs.com/hiera/latest/hierarchy.html) to insert at the
+# top of the hierarchy. This lets you temporarily modify the hierarchy for a single lookup.
+#     * If Hiera doesn't find a matching key in the overriding hierarchy level, it continues
+#     searching the rest of the hierarchy.
+#
+# The `hiera` function does **not** find all matches throughout a hierarchy, instead
+# returining the first specific value starting at the top of the hierarchy. To search
+# throughout a hierarchy, use the `hiera_array` or `hiera_hash` functions.
+#
+# @example Using `hiera`
+#
+# ~~~ yaml
+# # Assuming hiera.yaml
+# # :hierarchy:
+# #   - web01.example.com
+# #   - common
+#
+# # Assuming web01.example.com.yaml:
+# # users:
+# #   - "Amy Barry"
+# #   - "Carrie Douglas"
+#
+# # Assuming common.yaml:
+# users:
+#   admins:
+#     - "Edith Franklin"
+#     - "Ginny Hamilton"
+#   regular:
+#     - "Iris Jackson"
+#     - "Kelly Lambert"
+# ~~~
+#
+# ~~~ puppet
+# # Assuming we are not web01.example.com:
+#
+# $users = hiera('users', undef)
+#
+# # $users contains {admins  => ["Edith Franklin", "Ginny Hamilton"],
+# #                  regular => ["Iris Jackson", "Kelly Lambert"]}
+# ~~~
+#
+# You can optionally generate the default value with a
+# [lambda](https://docs.puppetlabs.com/puppet/latest/reference/lang_lambdas.html) that
+# takes one parameter.
+#
+# @example Using `hiera` with a lambda
+#
+# ~~~ puppet
+# # Assuming the same Hiera data as the previous example:
+#
+# $users = hiera('users') | $key | { "Key \'${key}\' not found" }
+#
+# # $users contains {admins  => ["Edith Franklin", "Ginny Hamilton"],
+# #                  regular => ["Iris Jackson", "Kelly Lambert"]}
+# # If hiera couldn't match its key, it would return the lambda result,
+# # "Key 'users' not found".
+# ~~~
+#
+# The returned value's data type depends on the types of the results. In the example 
+# above, Hiera matches the 'users' key and returns it as a hash.
+#
+# See
+# [the documentation](https://docs.puppetlabs.com/hiera/latest/puppet.html#hiera-lookup-functions)
+# for more information about Hiera lookup functions.
+#
+# @since 4.0.0
 #
 Puppet::Functions.create_function(:hiera, Hiera::PuppetFunction) do
   init_dispatch

data/lib/puppet/functions/hiera_array.rb

@@ -1,7 +1,69 @@
 require 'hiera/puppet_function'
 
-# @see lib/puppet/parser/functions/hiera_array.rb for documentation
-# TODO: Move docs here when the format has been determined.
+# Finds all matches of a key throughout the hierarchy and returns them as a single flattened
+# array of unique values. If any of the matched values are arrays, they're flattened and
+# included in the results. This is called an
+# [array merge lookup](https://docs.puppetlabs.com/hiera/latest/lookup_types.html#array-merge).
+#
+# The `hiera_array` function takes up to three arguments, in this order:
+#
+# 1. A string key that Hiera searches for in the hierarchy. **Required**.
+# 2. An optional default value to return if Hiera doesn't find anything matching the key.
+#     * If this argument isn't provided and this function results in a lookup failure, Puppet
+#     fails with a compilation error.
+# 3. The optional name of an arbitrary
+# [hierarchy level](https://docs.puppetlabs.com/hiera/latest/hierarchy.html) to insert at the
+# top of the hierarchy. This lets you temporarily modify the hierarchy for a single lookup.
+#     * If Hiera doesn't find a matching key in the overriding hierarchy level, it continues
+#     searching the rest of the hierarchy.
+#
+# @example Using `hiera_array`
+#
+# ~~~ yaml
+# # Assuming hiera.yaml
+# # :hierarchy:
+# #   - web01.example.com
+# #   - common
+#
+# # Assuming common.yaml:
+# # users:
+# #   - 'cdouglas = regular'
+# #   - 'efranklin = regular'
+#
+# # Assuming web01.example.com.yaml:
+# # users: 'abarry = admin'
+# ~~~
+#
+# ~~~ puppet
+# $allusers = hiera_array('users', undef)
+#
+# # $allusers contains ["cdouglas = regular", "efranklin = regular", "abarry = admin"].
+# ~~~
+#
+# You can optionally generate the default value with a
+# [lambda](https://docs.puppetlabs.com/puppet/latest/reference/lang_lambdas.html) that
+# takes one parameter.
+#
+# @example Using `hiera_array` with a lambda
+#
+# ~~~ puppet
+# # Assuming the same Hiera data as the previous example:
+#
+# $allusers = hiera_array('users') | $key | { "Key \'${key}\' not found" }
+#
+# # $allusers contains ["cdouglas = regular", "efranklin = regular", "abarry = admin"].
+# # If hiera_array couldn't match its key, it would return the lambda result,
+# # "Key 'users' not found".
+# ~~~
+#
+# `hiera_array` expects that all values returned will be strings or arrays. If any matched
+# value is a hash, Puppet raises a type mismatch error.
+#
+# See
+# [the documentation](https://docs.puppetlabs.com/hiera/latest/puppet.html#hiera-lookup-functions)
+# for more information about Hiera lookup functions.
+#
+# @since 4.0.0
 #
 Puppet::Functions.create_function(:hiera_array, Hiera::PuppetFunction) do
   init_dispatch
@@ -9,4 +71,4 @@ Puppet::Functions.create_function(:hiera_array, Hiera::PuppetFunction) do
   def merge_type
     :array
   end
-end
+end

data/lib/puppet/functions/hiera_hash.rb

@@ -1,7 +1,79 @@
 require 'hiera/puppet_function'
 
-# @see lib/puppet/parser/functions/hiera_hash.rb for documentation
-# TODO: Move docs here when the format has been determined.
+# Finds all matches of a key throughout the hierarchy and returns them in a merged hash.
+# If any of the matched hashes share keys, the final hash uses the value from the
+# highest priority match. This is called a
+# [hash merge lookup](https://docs.puppetlabs.com/hiera/latest/lookup_types.html#hash-merge).
+#
+# The merge strategy is determined by Hiera's
+# [`:merge_behavior`](https://docs.puppetlabs.com/hiera/latest/configuring.html#mergebehavior)
+# setting.
+#
+# The `hiera_hash` function takes up to three arguments, in this order:
+#
+# 1. A string key that Hiera searches for in the hierarchy. **Required**.
+# 2. An optional default value to return if Hiera doesn't find anything matching the key.
+#     * If this argument isn't provided and this function results in a lookup failure, Puppet
+#     fails with a compilation error.
+# 3. The optional name of an arbitrary
+# [hierarchy level](https://docs.puppetlabs.com/hiera/latest/hierarchy.html) to insert at the
+# top of the hierarchy. This lets you temporarily modify the hierarchy for a single lookup.
+#     * If Hiera doesn't find a matching key in the overriding hierarchy level, it continues
+#     searching the rest of the hierarchy.
+#
+# @example Using `hiera_hash`
+#
+# ~~~ yaml
+# # Assuming hiera.yaml
+# # :hierarchy:
+# #   - web01.example.com
+# #   - common
+#
+# # Assuming common.yaml:
+# # users:
+# #   regular:
+# #     'cdouglas': 'Carrie Douglas'
+#
+# # Assuming web01.example.com.yaml:
+# # users:
+# #   administrators:
+# #     'aberry': 'Amy Berry'
+# ~~~
+#
+# ~~~ puppet
+# # Assuming we are not web01.example.com:
+#
+# $allusers = hiera_hash('users', undef)
+#
+# # $allusers contains {regular => {"cdouglas" => "Carrie Douglas"},
+# #                     administrators => {"aberry" => "Amy Berry"}}
+# ~~~
+#
+# You can optionally generate the default value with a
+# [lambda](https://docs.puppetlabs.com/puppet/latest/reference/lang_lambdas.html) that
+# takes one parameter.
+#
+# @example Using `hiera_hash` with a lambda
+#
+# ~~~ puppet
+# # Assuming the same Hiera data as the previous example:
+#
+# $allusers = hiera_hash('users') | $key | { "Key \'${key}\' not found" }
+#
+# # $allusers contains {regular => {"cdouglas" => "Carrie Douglas"},
+# #                     administrators => {"aberry" => "Amy Berry"}}
+# # If hiera_hash couldn't match its key, it would return the lambda result,
+# # "Key 'users' not found".
+# ~~~
+#
+# `hiera_hash` expects that all values returned will be hashes. If any of the values
+# found in the data sources are strings or arrays, Puppet raises a type mismatch error.
+#
+# See
+# [the documentation](https://docs.puppetlabs.com/hiera/latest/puppet.html#hiera-lookup-functions)
+# for more information about Hiera lookup functions.
+#
+# @since 4.0.0
 #
 Puppet::Functions.create_function(:hiera_hash, Hiera::PuppetFunction) do
   init_dispatch

data/lib/puppet/functions/hiera_include.rb

@@ -1,7 +1,80 @@
 require 'hiera/puppet_function'
 
-# @see lib/puppet/parser/functions/hiera_include.rb for documentation
-# TODO: Move docs here when the format has been determined.
+# Assigns classes to a node using an
+# [array merge lookup](https://docs.puppetlabs.com/hiera/latest/lookup_types.htmlarray-merge)
+# that retrieves the value for a user-specified key from Hiera's data.
+#
+# The `hiera_include` function requires:
+#
+# - A string key name to use for classes.
+# - A call to this function (i.e. `hiera_include('classes')`) in your environment's
+# `sites.pp` manifest, outside of any node definitions and below any top-scope variables
+# that Hiera uses in lookups.
+# - `classes` keys in the appropriate Hiera data sources, with an array for each
+# `classes` key and each value of the array containing the name of a class.
+#
+# The function takes up to three arguments, in this order:
+#
+# 1. A string key that Hiera searches for in the hierarchy. **Required**.
+# 2. An optional default value to return if Hiera doesn't find anything matching the key.
+#     * If this argument isn't provided and this function results in a lookup failure, Puppet
+#     fails with a compilation error.
+# 3. The optional name of an arbitrary
+# [hierarchy level](https://docs.puppetlabs.com/hiera/latest/hierarchy.html) to insert at the
+# top of the hierarchy. This lets you temporarily modify the hierarchy for a single lookup.
+#     * If Hiera doesn't find a matching key in the overriding hierarchy level, it continues
+#     searching the rest of the hierarchy.
+#
+# The function uses an
+# [array merge lookup](https://docs.puppetlabs.com/hiera/latest/lookup_types.htmlarray-merge)
+# to retrieve the `classes` array, so every node gets every class from the hierarchy.
+#
+# @example Using `hiera_include`
+#
+# ~~~ yaml
+# # Assuming hiera.yaml
+# # :hierarchy:
+# #   - web01.example.com
+# #   - common
+#
+# # Assuming web01.example.com.yaml:
+# # classes:
+# #   - apache::mod::php
+#
+# # Assuming common.yaml:
+# # classes:
+# #   - apache
+# ~~~
+#
+# ~~~ puppet
+# # In site.pp, outside of any node definitions and below any top-scope variables:
+# hiera_include('classes', undef)
+#
+# # Puppet assigns the apache and apache::mod::php classes to the web01.example.com node.
+# ~~~
+#
+# You can optionally generate the default value with a
+# [lambda](https://docs.puppetlabs.com/puppet/latest/reference/lang_lambdas.html) that
+# takes one parameter.
+#
+# @example Using `hiera_include` with a lambda
+#
+# ~~~ puppet
+# # Assuming the same Hiera data as the previous example:
+#
+# # In site.pp, outside of any node definitions and below any top-scope variables:
+# hiera_include('classes') | $key | {"Key \'${key}\' not found" }
+#
+# # Puppet assigns the apache and apache::mod::php classes to the web01.example.com node.
+# # If hiera_include couldn't match its key, it would return the lambda result,
+# # "Key 'classes' not found".
+# ~~~
+#
+# See [the documentation](http://links.puppetlabs.com/hierainclude) for more information
+# and a more detailed example of how `hiera_include` uses array merge lookups to classify
+# nodes.
+#
+# @since 4.0.0
 #
 Puppet::Functions.create_function(:hiera_include, Hiera::PuppetFunction) do
   init_dispatch

data/lib/puppet/functions/lookup.rb

@@ -150,18 +150,16 @@
 # - Since 4.0.0
 Puppet::Functions.create_function(:lookup, Puppet::Functions::InternalFunction) do
   name_t = 'Variant[String,Array[String]]'
-  value_type_t = 'Optional[Type]'
+  value_type_t = 'Type'
   default_value_t = 'Any'
-  override_t = 'Optional[Hash[String,Any]]'
-  default_values_hash_t = 'Optional[Hash[String,Any]]'
-  merge_t = 'Optional[Variant[String[1],Hash[String,Scalar]]]'
+  merge_t = 'Variant[String[1],Hash[String,Scalar]]'
   block_t = "Callable[#{name_t}]"
   option_pairs =
-      "value_type=>#{value_type_t},"\
+      "value_type=>Optional[#{value_type_t}],"\
       "default_value=>Optional[#{default_value_t}],"\
-      "override=>#{override_t},"\
-      "default_values_hash=>#{default_values_hash_t},"\
-      "merge=>#{merge_t}"\
+      "override=>Optional[Hash[String,Any]],"\
+      "default_values_hash=>Optional[Hash[String,Any]],"\
+      "merge=>Optional[#{merge_t}]"
 
   dispatch :lookup_1 do
     scope_param
@@ -172,10 +170,10 @@ Puppet::Functions.create_function(:lookup, Puppet::Functions::InternalFunction)
 
   dispatch :lookup_2 do
     scope_param
-    param  name_t,         :name
-    param  value_type_t,   :value_type
-    param  merge_t,        :merge
-    param default_value_t, :default_value
+    param name_t,                     :name
+    param "Optional[#{value_type_t}]", :value_type
+    param "Optional[#{merge_t}]",      :merge
+    param default_value_t,            :default_value
   end
 
   dispatch :lookup_3 do
@@ -202,23 +200,27 @@ Puppet::Functions.create_function(:lookup, Puppet::Functions::InternalFunction)
   end
 
   def lookup_1(scope, name, value_type=nil, merge=nil)
-    Puppet::Pops::Lookup.lookup(scope, name, value_type, nil, false, {}, {}, merge)
+    do_lookup(scope, name, value_type, nil, false, {}, {}, merge)
   end
 
   def lookup_2(scope, name, value_type, merge, default_value)
-    Puppet::Pops::Lookup.lookup(scope, name, value_type, default_value, true, {}, {}, merge)
+    do_lookup(scope, name, value_type, default_value, true, {}, {}, merge)
   end
 
   def lookup_3(scope, name, value_type=nil, merge=nil, &block)
-    Puppet::Pops::Lookup.lookup(scope, name, value_type, nil, false, {}, {}, merge, &block)
+    do_lookup(scope, name, value_type, nil, false, {}, {}, merge, &block)
   end
 
   def lookup_4(scope, options_hash, &block)
-    Puppet::Pops::Lookup.lookup(scope, options_hash['name'], *hash_args(options_hash), &block)
+    do_lookup(scope, options_hash['name'], *hash_args(options_hash), &block)
   end
 
   def lookup_5(scope, name, options_hash, &block)
-    Puppet::Pops::Lookup.lookup(scope, name, *hash_args(options_hash), &block)
+    do_lookup(scope, name, *hash_args(options_hash), &block)
+  end
+
+  def do_lookup(scope, name, value_type, default_value, has_default, override, default_values_hash, merge, &block)
+    Puppet::Pops::Lookup.lookup(name, value_type, default_value, has_default, merge, Puppet::Pops::Lookup::Invocation.new(scope, override, default_values_hash), &block)
   end
 
   def hash_args(options_hash)