-
Notifications
You must be signed in to change notification settings - Fork 17
/
static_facts.rb
186 lines (159 loc) · 5.67 KB
/
static_facts.rb
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
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
#
# static_facts.rb
#
# Allows to expose any statically defined key-value pair as a Facter fact
# with the ability to include other files ...
#
# For example:
#
# Given the following content of /etc/facts.conf:
#
# foo=bar
# answer=42
#
# Then upon execution both "foo" and "answer" will be available as facts
# to use directly from within Facter.
#
# Another example concerns usage of the "include" directive which allows
# for including single file as well as group of files when a wild card
# pattern was introduced. Any additional files which may act as a source
# of static facts should be preferably stored under /etc/facts.d/
# directory purely to maintain order and simplify management ...
#
# Given the following content of /etc/facts.conf:
#
# foo=bar
# include /etc/facts.d/answer.fact
#
# Where the content of /etc/facts.d/answer.fact is:
#
# answer=42
#
# Then upon execution both "foo" and "answer" will be available as facts
# to use directly from within Facter. In this case the "answer" fact
# was loaded from file "answer.fact" which was given as a parameter
# to the "include" directive.
#
# The "include" directive will accept wild cards in the file names
# therefore the following would also be valid:
#
# include /etc/facts.d/*.fact
# include ~/.facts.d/*.fact
#
# Each include file can have "include" directive in it but there
# is a limit to the level of recursion in order to stop infinite
# and/or circular recursion from happening ...
#
# Worth noting is that we allow for single space before and after
# the equals sign i.e. "abc = def" to aid readability. But this
# is not recommended and should be rather avoided ...
#
# Compatibility note:
#
# Currently in order to maintain compatibility with legacy systems that
# define their static facts in the "/etc/facts.txt" file we also attempt
# to process facts definitions from it when this file is present ...
#
require 'thread'
require 'facter'
class StaticFact
# Sane default? Hope so ...
@@maximum_recursion_level = 8
@@current_recursion_level = 0
# We store all the static facts here ...
@@facts = {}
class << self
def load_facts(file)
# Just a fail-safe ...
return unless File.exists?(file)
# Parse and load facts from the origin file ...
parse_file(file)
@@facts
end
private
def parse_file(file)
file = File.expand_path(file)
directory = File.dirname(file)
# We cannot allow for endless recursion ...
return if @@current_recursion_level > @@maximum_recursion_level
# Since we include different files we check whether they still exist ...
return unless File.exists?(directory) or File.exists?(file)
# Look for wild card pattern ...
files = Dir.glob(file)
# Got files? Process each one of them as a separate case ...
files.each do |file|
file = File.expand_path(file)
# Skip non-existent file ...
next unless File.exists?(file)
File.readlines(file).each do |line|
# Skip new lines, empty lines and comment lines ...
next if line.match(/^(\r\n|\n|\s*|#.*)$|^$/)
# Remove bloat ...
line.strip!
if match = line.match(/^include\s+(.+)$/)
file = File.expand_path(match[1].strip)
# Look for wild card pattern ...
files = Dir.glob(file)
# There are no files to include ... so skip ...
next if files.empty?
if files.size > 1
#
# When simple pattern was used to include more files then
# we parse each and one of them but do not change current
# recursion level. We consider this a "flat include".
#
files.each { |f| parse_file(f) }
else
@@current_recursion_level += 1
# Parse and load facts from an include file ...
parse_file(file)
end
elsif match = line.match(/^(.+)\s?=\s?(.+)$/)
# Since we allow spaces we have to clean it up a little ...
name = match[1].strip
value = match[2].strip
#
# A single Facter fact name cannot be a number. This is
# because Puppet will turn every fact in a proper class
# property and in Ruby a property name cannot be a number
# not cannot start with a number.
#
if name.match(/^\d+/)
Facter.warn "A fact name cannot start with a number: #{name} = #{value}"
# Skip on the spot ...
next
end
# Both Facter.debug and Facter.warn work only when debugging is on.
Facter.warn "An attempt to re-define already defined " +
"fact: #{name} = #{value}" if @@facts.keys.include?(name)
@@facts.update(name => value)
end
end
end
end
end
end
#
# We attempt to process "/etc/facts.conf" file first and then move onto
# the "/etc/facts.txt" file purely to make legacy systems still work.
#
# As a side effect we might accidentally re-define already defined fact when
# any subsequent file (or an included file that it will pull into) re-defines
# it again. Facter will discard any attempt to re-define any fact that has
# been already defined. Said that, this might not be the most desirable
# behaviour in some use-cases ...
#
%w(facts.conf facts.txt).each do |file|
file = File.join('/etc/', file)
# Attempt to process facts from a given file ...
facts = StaticFact.load_facts(file)
if facts and not facts.empty?
facts.each do |name, value|
Facter.add(name) do
setcode { value }
end
end
end
end
# vim: set ts=2 sw=2 et :
# encoding: utf-8