Puppet Function: format_state

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

Overview

format_state() ⇒ Any

format_state( state )

Given an array or comma separated list of states, generates the partial iptables rule to facilitate matching on specific states.

If no state is specified, an empty string is returned.

If multiple states are specified any invalid states will be skipped, and a warning will be logged.

If all passed states are invalid, a ParseError is thrown

Examples:

# returns '-m state --state NEW,REL'
format_state('NEW,RELATED')

# returns '-m state --state NEW'
format_state(['NEW','NET'])

# throws parse error
format_state('NET')
format_state([ 'NEXT', 'NET' ])

Returns:

  • (Any) 


2
3
4
5
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
60
61
 
# File 'lib/puppet/parser/functions/format_state.rb', line 2

newfunction(:format_state, :type => :rvalue,:doc => <<-EOS
format_state( state )

Given an array or comma separated list of states, generates the partial iptables
rule to facilitate matching on specific states.

If no state is specified, an empty string is returned.

If multiple states are specified any invalid states will be skipped, and a
warning will be logged.

If all passed states are invalid, a ParseError is thrown

Examples:

# returns '-m state --state NEW,REL'
format_state('NEW,RELATED')

# returns '-m state --state NEW'
format_state(['NEW','NET'])

# throws parse error
format_state('NET')
format_state([ 'NEXT', 'NET' ])
EOS
) do |args|
  Puppet::Parser::Functions.function('warning')

  states = ""
  states = args[0].dup unless args[0] == nil or args[0] == :undef
  valid = [ 'NEW', 'REL', 'EST', 'INV' ]

  states = states.split(',') unless states.kind_of?(Array)

  # handle if we were not passed any states
  return '' if states.size == 0

  # limit each state to the first 3 letters since we just need to provide
  # enough information for iptables such that the state is not ambigous
  states.map! { |s| s=s[0,3] }
  states.uniq!

  # remove invalid states
  to_delete = [ ]
  states.each { |s| to_delete.push(s) unless valid.include?(s) }

  if to_delete.size > 0 and states.size > 0
    function_warning(["skipping invalid states -- #{to_delete.join(',')}"])
    to_delete.each { |s| states.delete(s) }
  elsif to_delete.size > 0 and states.size == 0
    raise Puppet::ParseError, "no valid states were passed"
  end

  states.compact!

  state = ""
  state = "-m state --state #{states.join(',')}" if states.size > 0

  return state
end