Puppet Function: ensure_packages

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

Summary

Takes a list of packages and only installs them if they don't already exist.

Overview

ensure_packages() ⇒ Any

It optionally takes a hash as a second parameter that will be passed as the third argument to the ensure_resource() function.

Returns:

  • (Any) —

    install the passed packages



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
 
# File 'lib/puppet/parser/functions/ensure_packages.rb', line 7

newfunction(:ensure_packages, type: :statement, doc: <<-DOC
  @summary
    Takes a list of packages and only installs them if they don't already exist.

  It optionally takes a hash as a second parameter that will be passed as the
  third argument to the ensure_resource() function.

  @return
    install the passed packages
DOC
) do |arguments|
  raise(Puppet::ParseError, "ensure_packages(): Wrong number of arguments given (#{arguments.size} for 1 or 2)") if arguments.size > 2 || arguments.empty?
  raise(Puppet::ParseError, 'ensure_packages(): Requires second argument to be a Hash') if arguments.size == 2 && !arguments[1].is_a?(Hash)

  if arguments[0].is_a?(Hash)
    if arguments[1]
      defaults = { 'ensure' => 'present' }.merge(arguments[1])
      if defaults['ensure'] == 'installed'
        defaults['ensure'] = 'present'
      end
    else
      defaults = { 'ensure' => 'present' }
    end

    Puppet::Parser::Functions.function(:ensure_resources)
    function_ensure_resources(['package', arguments[0].dup, defaults])
  else
    packages = Array(arguments[0])

    if arguments[1]
      defaults = { 'ensure' => 'present' }.merge(arguments[1])
      if defaults['ensure'] == 'installed'
        defaults['ensure'] = 'present'
      end
    else
      defaults = { 'ensure' => 'present' }
    end

    Puppet::Parser::Functions.function(:ensure_resource)
    packages.each do |package_name|
      raise(Puppet::ParseError, 'ensure_packages(): Empty String provided for package name') if package_name.empty?
      function_ensure_resource(['package', package_name, defaults])
    end
  end
end