Puppet Function: pick

Defined in:
vendor_modules/stdlib/lib/puppet/parser/functions/pick.rb
Function type:
Ruby 3.x API

Summary

This function will return the first value in a list of values that is not undefined or an empty string.

Overview

pick() ⇒ Any

This function is similar to a coalesce function in SQL.

Typically, this function is used to check for a value in the Puppet Dashboard/Enterprise Console, and failover to a default value like the following:

“`$real_jenkins_version = pick($::jenkins_version, '1.449')“`

> Note:

The value of $real_jenkins_version will first look for a top-scope variable
called 'jenkins_version' (note that parameters set in the Puppet Dashboard/
Enterprise Console are brought into Puppet as top-scope variables), and,
failing that, will use a default value of 1.449.

Returns:

  • (Any) —

    the first value in a list of values that is not undefined or an empty string.



7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'vendor_modules/stdlib/lib/puppet/parser/functions/pick.rb', line 7

newfunction(:pick, type: :rvalue, doc: <<-EOS
  @summary
    This function will return
    the first value in a list of values that is not undefined or an empty string.

  This function is similar to a coalesce function in SQL.

  @return
    the first value in a list of values that is not undefined or an empty string.

  Typically, this function is used to check for a value in the Puppet
  Dashboard/Enterprise Console, and failover to a default value like the following:

  ```$real_jenkins_version = pick($::jenkins_version, '1.449')```

  > *Note:*
    The value of $real_jenkins_version will first look for a top-scope variable
    called 'jenkins_version' (note that parameters set in the Puppet Dashboard/
    Enterprise Console are brought into Puppet as top-scope variables), and,
    failing that, will use a default value of 1.449.
EOS
) do |args|
  args = args.compact
  args.delete(:undef)
  args.delete(:undefined)
  args.delete('')
  raise Puppet::ParseError, 'pick(): must receive at least one non empty value' if args[0].to_s.empty?
  return args[0]
end