Puppet Function: fqdn_rotate

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

Summary

Rotates an array or string a random number of times, combining the `$fqdn` fact and an optional seed for repeatable randomness.

Overview

fqdn_rotate() ⇒ Any

Examples:

Example Usage:

fqdn_rotate(['a', 'b', 'c', 'd'])
fqdn_rotate('abcd')
fqdn_rotate([1, 2, 3], 'custom seed')

Returns:

  • (Any) —

    rotated array or string



6
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
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'vendor_modules/stdlib/lib/puppet/parser/functions/fqdn_rotate.rb', line 6

Puppet::Parser::Functions.newfunction(:fqdn_rotate, type: :rvalue, doc: <<-DOC
  @summary
    Rotates an array or string a random number of times, combining the `$fqdn` fact
    and an optional seed for repeatable randomness.

  @return
    rotated array or string

  @example Example Usage:
    fqdn_rotate(['a', 'b', 'c', 'd'])
    fqdn_rotate('abcd')
    fqdn_rotate([1, 2, 3], 'custom seed')
  DOC
) do |args|
  raise(Puppet::ParseError, "fqdn_rotate(): Wrong number of arguments given (#{args.size} for 1)") if args.empty?

  value = args.shift
  require 'digest/md5'

  unless value.is_a?(Array) || value.is_a?(String)
    raise(Puppet::ParseError, 'fqdn_rotate(): Requires either array or string to work with')
  end

  result = value.clone

  string = value.is_a?(String) ? true : false

  # Check whether it makes sense to rotate ...
  return result if result.size <= 1

  # We turn any string value into an array to be able to rotate ...
  result = string ? result.split('') : result

  elements = result.size

  seed = Digest::MD5.hexdigest([lookupvar('::fqdn'), args].join(':')).hex
  # deterministic_rand() was added in Puppet 3.2.0; reimplement if necessary
  if Puppet::Util.respond_to?(:deterministic_rand)
    offset = Puppet::Util.deterministic_rand(seed, elements).to_i
  else
    return offset = Random.new(seed).rand(elements) if defined?(Random) == 'constant' && Random.class == Class

    old_seed = srand(seed)
    offset = rand(elements)
    srand(old_seed)
  end
  offset.times do
    result.push result.shift
  end

  result = string ? result.join : result

  return result
end