puppet 4.2.0 → 4.3.0

data/lib/puppet/parser/functions/defined.rb

@@ -1,71 +1,108 @@
-# Test whether a given class or definition is defined
-Puppet::Parser::Functions::newfunction(:defined, :type => :rvalue, :arity => -2,
-  :doc => "Determine whether
-  a given class or resource type is defined. This function can also determine whether a
-  specific resource has been defined, or whether a variable has been assigned a value
-  (including `undef` - as opposed to never having been assigned anything). Returns `true`
-  or `false`. Accepts class names, type names, resource references, and variable
-  reference strings of the form `'$name'`. When more than one argument is
-  supplied, `defined()` returns `true` if any are defined.
-
-  The `defined` function checks both native and defined types, including types
-  provided as plugins via modules. Types and classes are both checked using their names:
-
-      defined(\"file\")
-      defined(\"customtype\")
-      defined(\"foo\")
-      defined(\"foo::bar\")
-      defined(\'$name\')
-
-  Resource declarations are checked using resource references, e.g.
-  `defined( File['/tmp/myfile'] )`. Checking whether a given resource
-  has been declared is, unfortunately, dependent on the evaluation order of
-  the configuration, and the following code will not work:
-
-      if defined(File['/tmp/foo']) {
-          notify { \"This configuration includes the /tmp/foo file.\":}
-      }
-      file { \"/tmp/foo\":
-          ensure => present,
-      }
-
-  However, this order requirement refers to evaluation order only, and ordering of
-  resources in the configuration graph (e.g. with `before` or `require`) does not
-  affect the behavior of `defined`.
-
-  You may also search using types:
-
-      defined(Resource[\'file\',\'/some/file\'])
-      defined(File[\'/some/file\'])
-      defined(Class[\'foo\'])
-
-  The `defined` function does not answer if 4.x data types (e.g. `Integer`) are defined. If
-  given the string 'integer' the result is false, and if given a non CatalogEntry type,
-  an error is raised.
-
-  The rules for asking for undef, empty strings, and the main class are different from 3.x
-  (non future parser) and 4.x (with future parser or in Puppet 4.0.0 and later):
-
-      defined('')     # 3.x => true, 4.x => false
-      defined(undef)  # 3.x => true, 4.x => error
-      defined('main') # 3.x => false, 4.x => true
-
-  With the future parser, it is also possible to ask specifically if a name is
-  a resource type (built in or defined), or a class, by giving its type:
-
-      defined(Type[Class['foo']])
-      defined(Type[Resource['foo']])
-
-  Which is different from asking:
-
-      defined('foo')
-
-  Since the later returns true if 'foo' is either a class, a built-in resource type, or a user defined
-  resource type, and a specific request like `Type[Class['foo']]` only returns true if `'foo'` is a class.
-
- - Since 2.7.0
- - Since 3.6.0 variable reference and future parser types
- - Since 3.8.1 type specific requests with future parser") do |vals|
+Puppet::Parser::Functions::newfunction(
+  :defined,
+  :type => :rvalue,
+  :arity => -2,
+  :doc => <<DOC
+Determines whether a given class or resource type is defined and returns a Boolean
+value. You can also use `defined` to determine whether a specific resource is defined,
+or whether a variable has a value (including `undef`, as opposed to the variable never
+being declared or assigned).
+
+This function takes at least one string argument, which can be a class name, type name,
+resource reference, or variable reference of the form `'$name'`.
+
+The `defined` function checks both native and defined types, including types
+provided by modules. Types and classes are matched by their names. The function matches 
+resource declarations by using resource references.
+
+**Examples**: Different types of `defined` function matches
+
+~~~ puppet
+# Matching resource types
+defined("file")
+defined("customtype")
+
+# Matching defines and classes
+defined("foo")
+defined("foo::bar")
+
+# Matching variables
+defined('$name')
+
+# Matching declared resources
+defined(File['/tmp/file'])
+~~~
+
+Puppet depends on the configuration's evaluation order when checking whether a resource
+is declared.
+
+**Example**: Importance of evaluation order when using `defined`
+
+~~~ puppet
+# Assign values to $is_defined_before and $is_defined_after using identical `defined`
+# functions.
+
+$is_defined_before = defined(File['/tmp/file'])
+
+file { "/tmp/file":
+  ensure => present,
+}
+
+$is_defined_after = defined(File['/tmp/file'])
+
+# $is_defined_before returns false, but $is_defined_after returns true.
+~~~
+
+This order requirement only refers to evaluation order. The order of resources in the
+configuration graph (e.g. with `before` or `require`) does not affect the `defined`
+function's behavior.
+
+> **Warning:** Avoid relying on the result of the `defined` function in modules, as you
+> might not be able to guarantee the evaluation order well enough to produce consistent
+> results. This can cause other code that relies on the function's result to behave
+> inconsistently or fail.
+
+If you pass more than one argument to `defined`, the function returns `true` if _any_
+of the arguments are defined. You can also match resources by type, allowing you to
+match conditions of different levels of specificity, such as whether a specific resource
+is of a specific data type.
+
+**Example**: Matching multiple resources and resources by different types with `defined`
+
+~~~ puppet
+file { "/tmp/file1":
+  ensure => file,
+}
+
+$tmp_file = file { "/tmp/file2":
+  ensure => file,
+}
+
+# Each of these statements return `true` ...
+defined(File['/tmp/file1'])
+defined(File['/tmp/file1'],File['/tmp/file2'])
+defined(File['/tmp/file1'],File['/tmp/file2'],File['/tmp/file3'])
+# ... but this returns `false`.
+defined(File['/tmp/file3'])
+
+# Each of these statements returns `true` ...
+defined(Type[Resource['file','/tmp/file2']])
+defined(Resource['file','/tmp/file2'])
+defined(File['/tmp/file2'])
+defined('$tmp_file')
+# ... but each of these returns `false`.
+defined(Type[Resource['exec','/tmp/file2']])
+defined(Resource['exec','/tmp/file2'])
+defined(File['/tmp/file3'])
+defined('$tmp_file2')
+~~~
+
+- Since 2.7.0
+- Since 3.6.0 variable reference and future parser types
+- Since 3.8.1 type specific requests with future parser
+- Since 4.0.0
+DOC
+) do |vals|
   vals = [vals] unless vals.is_a?(Array)
   vals.any? do |val|
     case val

data/lib/puppet/parser/functions/each.rb

@@ -3,41 +3,99 @@ Puppet::Parser::Functions::newfunction(
   :type => :rvalue,
   :arity => -3,
   :doc => <<-DOC
-Applies a parameterized block to each element in a sequence of selected entries from the first
-argument and returns the first argument.
+Runs a [lambda](http://docs.puppetlabs.com/puppet/latest/reference/lang_lambdas.html)
+repeatedly using each value in a data structure, then returns the values unchanged.
 
-This function takes two mandatory arguments: the first should be an Array or a Hash or something that is
-of enumerable type (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.each |$x| { ... }
-      each($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 an Array (or of enumerable type other than Hash), the parameterized block
-should define one or two block parameters.
-For each application of the block, the next element from the array is selected, and it is passed to
-the block if the block has one parameter. If the block has two parameters, the first is the elements
-index, and the second the value. The index starts from 0.
+**Example**: Using the `each` function
 
-      $a.each |$index, $value| { ... }
-      each($a) |$index, $value| { ... }
+`$data.each |$parameter| { <PUPPET CODE BLOCK> }`
 
-When the first argument is a Hash, the parameterized block should define one or two parameters.
-When one parameter is defined, the iteration is performed with each entry as an array of `[key, value]`,
-and when two parameters are defined the iteration is performed with key and value.
+or
 
-      $a.each |$entry|       { ..."key ${$entry[0]}, value ${$entry[1]}" }
-      $a.each |$key, $value| { ..."key ${key}, value ${value}" }
+`each($data) |$parameter| { <PUPPET CODE BLOCK> }`
 
-Example using each:
+When the first argument (`$data` in the above example) is an array, Puppet passes each
+value in turn to the lambda, then returns the original values.
 
-      [1,2,3].each |$val| { ... }                       # 1, 2, 3
-      [5,6,7].each |$index, $val| { ... }               # (0, 5), (1, 6), (2, 7)
-      {a=>1, b=>2, c=>3}].each |$val| { ... }           # ['a', 1], ['b', 2], ['c', 3]
-      {a=>1, b=>2, c=>3}.each |$key, $val| { ... }      # ('a', 1), ('b', 2), ('c', 3)
-      Integer[ 10, 20 ].each |$index, $value| { ... }   # (0, 10), (1, 11) ...
-      "hello".each |$char| { ... }                      # 'h', 'e', 'l', 'l', 'o'
-      3.each |$number| { ... }                          # 0, 1, 2
+**Example**: Using the `each` function with an array and a one-parameter lambda
+
+~~~ puppet
+# For the array $data, run a lambda that creates a resource for each item.
+$data = ["routers", "servers", "workstations"]
+$data.each |$item| {
+ notify { $item:
+   message => $item
+ }
+}
+# Puppet creates one resource for each of the three items in $data. Each resource is
+# named after the item's value and uses the item's value in a parameter.
+~~~
+
+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 the original hash.
+
+**Example**: Using the `each` function with a hash and a one-parameter lambda
+
+~~~ puppet
+# For the hash $data, run a lambda using each item as a key-value array that creates a
+# resource for each item.
+$data = {"rtr" => "Router", "svr" => "Server", "wks" => "Workstation"}
+$data.each |$items| {
+ notify { $items[0]:
+   message => $items[1]
+ }
+}
+# Puppet creates one resource for each of the three items in $data, each named after the
+# item's key and containing a parameter using the item's value.
+~~~
+
+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 `each` function with an array and a two-parameter lambda
+
+~~~ puppet
+# For the array $data, run a lambda using each item's index and value that creates a
+# resource for each item.
+$data = ["routers", "servers", "workstations"]
+$data.each |$index, $value| {
+ notify { $value:
+   message => $index
+ }
+}
+# Puppet creates one resource for each of the three items in $data, each named after the
+# item's value and containing a parameter using the item's index.
+~~~
+
+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 `each` function with a hash and a two-parameter lambda
+
+~~~ puppet
+# For the hash $data, run a lambda using each item's key and value to create a resource
+# for each item.
+$data = {"rtr" => "Router", "svr" => "Server", "wks" => "Workstation"}
+$data.each |$key, $value| {
+ notify { $key:
+   message => $value
+ }
+}
+# Puppet creates one resource for each of the three items in $data, each named after the
+# item's key and containing a parameter using the item's value.
+~~~
+
+For an example that demonstrates how to create multiple `file` resources using `each`,
+see the Puppet
+[iteration](https://docs.puppetlabs.com/puppet/latest/reference/lang_iteration.html)
+documentation.
 
 - Since 4.0.0
 DOC

data/lib/puppet/parser/functions/epp.rb

@@ -1,43 +1,35 @@
 Puppet::Parser::Functions::newfunction(:epp, :type => :rvalue, :arity => -2, :doc =>
-"Evaluates an Embedded Puppet Template (EPP) file and returns the rendered text result as a String.
+"Evaluates an Embedded Puppet (EPP) template file and returns the rendered text
+result as a String.
+
+`epp('<MODULE NAME>/<TEMPLATE FILE>', <PARAMETER HASH>)`
 
 The first argument to this function should be a `<MODULE NAME>/<TEMPLATE FILE>`
-reference, which will load `<TEMPLATE FILE>` from a module's `templates`
-directory. (For example, the reference `apache/vhost.conf.epp` will load the
-file `<MODULES DIRECTORY>/apache/templates/vhost.conf.epp`.)
-
-The second argument is optional; if present, it should be a hash containing parameters for the
-template. (See below.)
-
-EPP supports the following tags:
-
-* `<%= puppet expression %>` - This tag renders the value of the expression it contains.
-* `<% puppet expression(s) %>` - This tag will execute the expression(s) it contains, but renders nothing.
-* `<%# comment %>` - The tag and its content renders nothing.
-* `<%%` or `%%>` - Renders a literal `<%` or `%>` respectively.
-* `<%-` - Same as `<%` but suppresses any leading whitespace.
-* `-%>` - Same as `%>` but suppresses any trailing whitespace on the same line (including line break).
-* `<%- |parameters| -%>` - When placed as the first tag declares the template's parameters.
-
-File based EPP supports the following visibilities of variables in scope:
-
-* Global scope (i.e. top + node scopes) - global scope is always visible
-* Global + all given arguments - if the EPP template does not declare parameters, and arguments are given
-* Global + declared parameters - if the EPP declares parameters, given argument names must match
-
-EPP supports parameters by placing an optional parameter list as the very first element in the EPP. As an example,
-`<%- |$x, $y, $z = 'unicorn'| -%>` when placed first in the EPP text declares that the parameters `x` and `y` must be
-given as template arguments when calling `inline_epp`, and that `z` if not given as a template argument
-defaults to `'unicorn'`. Template parameters are available as variables, e.g.arguments `$x`, `$y` and `$z` in the example.
-Note that `<%-` must be used or any leading whitespace will be interpreted as text
-
-Arguments are passed to the template by calling `epp` with a Hash as the last argument, where parameters
-are bound to values, e.g. `epp('...', {'x'=>10, 'y'=>20})`. Excess arguments may be given
-(i.e. undeclared parameters) only if the EPP templates does not declare any parameters at all.
-Template parameters shadow variables in outer scopes. File based epp does never have access to variables in the
-scope where the `epp` function is called from.
-
-- See function inline_epp for examples of EPP
+reference, which loads `<TEMPLATE FILE>` from `<MODULE NAME>`'s `templates`
+directory. In most cases, the last argument is optional; if used, it should be a
+[hash](/puppet/latest/reference/lang_data_hash.html) that contains parameters to
+pass to the template.
+
+- See the [template](/puppet/latest/reference/lang_template.html) documentation
+for general template usage information.
+- See the [EPP syntax](/puppet/latest/reference/lang_template_epp.html)
+documentation for examples of EPP.
+
+For example, to call the apache module's `templates/vhost/_docroot.epp`
+template and pass the `docroot` and `virtual_docroot` parameters, call the `epp`
+function like this:
+
+`epp('apache/templates/vhost/_docroot.epp', { 'docroot' => '/var/www/html',
+'virtual_docroot' => '/var/www/example' })`
+
+Puppet produces a syntax error if you pass more parameters than are declared in
+the template's parameter tag. When passing parameters to a template that
+contains a parameter tag, use the same names as the tag's declared parameters.
+
+Parameters are required only if they are declared in the called template's
+parameter tag without default values. Puppet produces an error if the `epp`
+function fails to pass any required parameter.
+
 - Since 4.0.0") do |args|
 
   function_fail(["epp() is only available when parser/evaluator future is in effect"])

data/lib/puppet/parser/functions/filter.rb

@@ -1,39 +1,75 @@
 Puppet::Parser::Functions::newfunction(
   :filter,
+  :type => :rvalue,
   :arity => -3,
   :doc => <<-DOC
- 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
 DOC

data/lib/puppet/parser/functions/hiera.rb

@@ -1,33 +1,89 @@
 require 'hiera_puppet'
 
 module Puppet::Parser::Functions
-  newfunction(:hiera, :type => :rvalue, :arity => -2, :doc => "Performs a
-  standard priority lookup and returns the most specific value for a given key.
-  The returned value can be data of any type (strings, arrays, or hashes). 
-
-  The function can be called in one of three ways:
-  1. Using 1 to 3 arguments where the arguments are:
-     'key'      [String] Required
-           The key to lookup.
-     'default`  [Any] Optional
-           A value to return when there's no match for `key`. Optional
-     `override` [Any] Optional
-           An argument in the third position, providing a data source
-           to consult for matching values, even if it would not ordinarily be
-           part of the matched hierarchy. If Hiera doesn't find a matching key
-           in the named override data source, it will continue to search through the
-           rest of the hierarchy.
-
-  2. Using a 'key' and an optional 'override' parameter like in #1 but with a block to
-     provide the default value. The block is called with one parameter (the key) and
-     should return the value.
-
-  3. Like #1 but with all arguments passed in an array.
-
-  More thorough examples of `hiera` are available at:  
-  <http://docs.puppetlabs.com/hiera/1/puppet.html#hiera-lookup-functions>
-  ") do |*args|
+  newfunction(
+    :hiera,
+    :type => :rvalue,
+    :arity => -2,
+    :doc => <<DOC
+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
+DOC
+  ) do |*args|
     function_fail(["hiera() has been converted to 4x API"])
   end
 end
-