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 => <<-DOC
   6     This function is similar to a coalesce function in SQL in that it will return
   7     the first value in a list of values that is not undefined or an empty string.
   8     Typically, this function is used to check for a value in the Puppet
   9     Dashboard/Enterprise Console, and failover to a default value like the following:
  10
  11       $real_jenkins_version = pick($::jenkins_version, '1.449')
  12
  13     The value of $real_jenkins_version will first look for a top-scope variable
  14     called 'jenkins_version' (note that parameters set in the Puppet Dashboard/
  15     Enterprise Console are brought into Puppet as top-scope variables), and,
  16     failing that, will use a default value of 1.449.
  17 DOC
  18              ) do |args|
  19     args = args.compact
  20     args.delete(:undef)
  21     args.delete(:undefined)
  22     args.delete('')
  23     raise Puppet::ParseError, 'pick(): must receive at least one non empty value' if args[0].to_s.empty?
  24     return args[0]
  25   end
  26 end