1
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
|
# frozen_string_literal: true
# Declares one or more classes, causing the resources in them to be
# evaluated and added to the catalog. Accepts a class name, an array of class
# names, or a comma-separated list of class names.
#
# The `include` function can be used multiple times on the same class and will
# only declare a given class once. If a class declared with `include` has any
# parameters, Puppet will automatically look up values for them in Hiera, using
# `<class name>::<parameter name>` as the lookup key.
#
# Contrast this behavior with resource-like class declarations
# (`class {'name': parameter => 'value',}`), which must be used in only one place
# per class and can directly set parameters. You should avoid using both `include`
# and resource-like declarations with the same class.
#
# The `include` function does not cause classes to be contained in the class
# where they are declared. For that, see the `contain` function. It also
# does not create a dependency relationship between the declared class and the
# surrounding class; for that, see the `require` function.
#
# You must use the class's full name;
# relative names are not allowed. In addition to names in string form,
# you may also directly use `Class` and `Resource` `Type`-values that are produced by
# the resource and relationship expressions.
#
# - Since < 3.0.0
# - Since 4.0.0 support for class and resource type values, absolute names
# - Since 4.7.0 returns an `Array[Type[Class]]` of all included classes
#
Puppet::Functions.create_function(:include, Puppet::Functions::InternalFunction) do
dispatch :include do
scope_param
# The function supports what the type system sees as Ruby runtime objects, and
# they cannot be parameterized to find what is actually valid instances.
# The validation is instead done in the function body itself via a call to
# `transform_and_assert_classnames` on the calling scope.
required_repeated_param 'Any', :names
end
def include(scope, *classes)
if Puppet[:tasks]
raise Puppet::ParseErrorWithIssue.from_issue_and_stack(
Puppet::Pops::Issues::CATALOG_OPERATION_NOT_SUPPORTED_WHEN_SCRIPTING,
{ :operation => 'include' }
)
end
classes = scope.transform_and_assert_classnames(classes.flatten)
result = classes.map { |name| Puppet::Pops::Types::TypeFactory.host_class(name) }
scope.compiler.evaluate_classes(classes, scope, false)
# Result is an Array[Class, 1, n] which allows chaining other operations
result
end
end
|
