3rdparty/modules/stdlib/lib/puppet/parser/functions/pick.rb

   1 #
   2 # pick.rb
   3 #
   4 module Puppet::Parser::Functions
   5   newfunction(:pick, :type => :rvalue, :doc => <<-EOS
   6     @summary
   7       This function is similar to a coalesce function in SQL in that it will return
   8       the first value in a list of values that is not undefined or an empty string.
   9
  10     @return
  11       the first value in a list of values that is not undefined or an empty string.
  12
  13     Typically, this function is used to check for a value in the Puppet
  14     Dashboard/Enterprise Console, and failover to a default value like the following:
  15
  16     ```$real_jenkins_version = pick($::jenkins_version, '1.449')```
  17
  18     > *Note:*
  19       The value of $real_jenkins_version will first look for a top-scope variable
  20       called 'jenkins_version' (note that parameters set in the Puppet Dashboard/
  21       Enterprise Console are brought into Puppet as top-scope variables), and,
  22       failing that, will use a default value of 1.449.
  23   EOS
  24              ) do |args|
  25     args = args.compact
  26     args.delete(:undef)
  27     args.delete(:undefined)
  28     args.delete('')
  29     raise Puppet::ParseError, 'pick(): must receive at least one non empty value' if args[0].to_s.empty?
  30     return args[0]
  31   end
  32 end