Class: Puppet::Application::Lookup

Inherits:
Puppet::Application show all
Defined in:
lib/puppet/application/lookup.rb

Constant Summary collapse

RUN_HELP =
_("Run 'puppet lookup --help' for more details").freeze
DEEP_MERGE_OPTIONS =
'--knock-out-prefix, --sort-merged-arrays, and --merge-hash-arrays'.freeze

Constants inherited from Puppet::Application

DOCPATTERN

Constants included from Util

Util::AbsolutePathPosix, Util::AbsolutePathWindows, Util::DEFAULT_POSIX_MODE, Util::DEFAULT_WINDOWS_MODE, Util::RFC_3986_URI_REGEX

Constants included from Util::SymbolicFileMode

Util::SymbolicFileMode::SetGIDBit, Util::SymbolicFileMode::SetUIDBit, Util::SymbolicFileMode::StickyBit, Util::SymbolicFileMode::SymbolicMode, Util::SymbolicFileMode::SymbolicSpecialToBit

Constants included from Util::POSIX

Util::POSIX::LOCALE_ENV_VARS, Util::POSIX::USER_ENV_VARS

Instance Attribute Summary

Attributes inherited from Puppet::Application

#command_line, #options

Instance Method Summary collapse

Methods inherited from Puppet::Application

[], available_application_names, banner, clear!, clear?, clear_everything_for_tests, #configure_indirector_routes, controlled_run, #deprecate, #deprecated?, environment_mode, exit, find, get_environment_mode, #handle_logdest_arg, #handlearg, #initialize, #initialize_app_defaults, interrupted?, #log_runtime_environment, #name, option, option_parser_commands, #parse_options, #preinit, restart!, restart_requested?, #run, #run_command, run_mode, #set_log_level, stop!, stop_requested?, try_load_class

Methods included from Util

absolute_path?, benchmark, chuser, clear_environment, default_env, deterministic_rand, deterministic_rand_int, exit_on_fail, get_env, get_environment, logmethods, merge_environment, path_to_uri, pretty_backtrace, replace_file, safe_posix_fork, set_env, symbolizehash, thinmark, uri_encode, uri_query_encode, uri_to_path, which, withenv, withumask

Methods included from Util::SymbolicFileMode

#normalize_symbolic_mode, #symbolic_mode_to_int, #valid_symbolic_mode?

Methods included from Util::POSIX

#get_posix_field, #gid, groups_of, #idfield, #methodbyid, #methodbyname, #search_posix_field, #uid

Constructor Details

This class inherits a constructor from Puppet::Application

Instance Method Details

#app_defaultsObject


64
65
66
67
68
# File 'lib/puppet/application/lookup.rb', line 64

def app_defaults
  super.merge({
    :facts_terminus => 'yaml'
  })
end

#generate_scopeObject


327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
# File 'lib/puppet/application/lookup.rb', line 327

def generate_scope
  if options[:node]
    node = options[:node]
  else
    node = Puppet[:node_name_value]

    # If we want to lookup the node we are currently on
    # we must returning these settings to their default values
    Puppet.settings[:facts_terminus] = 'facter'
  end

  unless node.is_a?(Puppet::Node) # to allow unit tests to pass a node instance
    ni = Puppet::Node.indirection
    tc = ni.terminus_class
    if tc == :plain || options[:compile]
      node = ni.find(node)
    else
      ni.terminus_class = :plain
      node = ni.find(node)
      ni.terminus_class = tc
    end
  end

  fact_file = options[:fact_file]

  if fact_file
    if fact_file.end_with?("json")
      given_facts = Puppet::Util::Json.load(Puppet::FileSystem.read(fact_file, :encoding => 'utf-8'))
    else
      given_facts = Puppet::Util::Yaml.safe_load_file(fact_file)
    end

    unless given_facts.instance_of?(Hash)
      raise _("Incorrect formatted data in %{fact_file} given via the --facts flag") % { fact_file: fact_file }
    end
    node.add_extra_facts(given_facts)
  end

  Puppet[:code] = 'undef' unless options[:compile]
  compiler = Puppet::Parser::Compiler.new(node)
  compiler.compile { |catalog| yield(compiler.topscope); catalog }
end

#helpObject


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
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
# File 'lib/puppet/application/lookup.rb', line 102

def help
  "\npuppet lookup(8) -- \#{summary}\n========\n\nSYNOPSIS\n--------\nDoes Hiera lookups from the command line.\n\nSince this command needs access to your Hiera data, make sure to run it on a\nnode that has a copy of that data. This usually means logging into a Puppet\nServer node and running 'puppet lookup' with sudo.\n\nThe most common version of this command is:\n\n'puppet lookup <KEY> --node <NAME> --environment <ENV> --explain'\n\nUSAGE\n-----\npuppet lookup [--help] [--type <TYPESTRING>] [--merge first|unique|hash|deep]\n[--knock-out-prefix <PREFIX-STRING>] [--sort-merged-arrays]\n[--merge-hash-arrays] [--explain] [--environment <ENV>]\n[--default <VALUE>] [--node <NODE-NAME>] [--facts <FILE>]\n[--compile]\n[--render-as s|json|yaml|binary|msgpack] <keys>\n\nDESCRIPTION\n-----------\nThe lookup command is a CLI for Puppet's 'lookup()' function. It searches your\nHiera data and returns a value for the requested lookup key, so you can test and\nexplore your data. It is a modern replacement for the 'hiera' command.\n\nHiera usually relies on a node's facts to locate the relevant data sources. By\ndefault, 'puppet lookup' uses facts from the node you run the command on, but\nyou can get data for any other node with the '--node <NAME>' option. If\npossible, the lookup command will use the requested node's real stored facts\nfrom PuppetDB; if PuppetDB isn't configured or you want to provide arbitrary\nfact values, you can pass alternate facts as a JSON or YAML file with '--facts\n<FILE>'.\n\nIf you're debugging your Hiera data and want to see where values are coming\nfrom, use the '--explain' option.\n\nIf '--explain' isn't specified, lookup exits with 0 if a value was found and 1\notherwise. With '--explain', lookup always exits with 0 unless there is a major\nerror.\n\nYou can provide multiple lookup keys to this command, but it only returns a\nvalue for the first found key, omitting the rest.\n\nFor more details about how Hiera works, see the Hiera documentation:\nhttps://puppet.com/docs/puppet/latest/hiera_intro.html\n\nOPTIONS\n-------\n\n* --help:\nPrint this help message.\n\n* --explain\nExplain the details of how the lookup was performed and where the final value\ncame from (or the reason no value was found).\n\n* --node <NODE-NAME>\nSpecify which node to look up data for; defaults to the node where the command\nis run. Since Hiera's purpose is to provide different values for different\nnodes (usually based on their facts), you'll usually want to use some specific\nnode's facts to explore your data. If the node where you're running this\ncommand is configured to talk to PuppetDB, the command will use the requested\nnode's most recent facts. Otherwise, you can override facts with the '--facts'\noption.\n\n* --facts <FILE>\nSpecify a .json or .yaml file of key => value mappings to override the facts\nfor this lookup. Any facts not specified in this file maintain their\noriginal value.\n\n* --environment <ENV>\nLike with most Puppet commands, you can specify an environment on the command\nline. This is important for lookup because different environments can have\ndifferent Hiera data.\n\n* --merge first|unique|hash|deep:\nSpecify the merge behavior, overriding any merge behavior from the data's\nlookup_options. 'first' returns the first value found. 'unique' appends\neverything to a merged, deduplicated array. 'hash' performs a simple hash\nmerge by overwriting keys of lower lookup priority. 'deep' performs a deep\nmerge on values of Array and Hash type. There are additional options that can\nbe used with 'deep'.\n\n* --knock-out-prefix <PREFIX-STRING>\nCan be used with the 'deep' merge strategy. Specifies a prefix to indicate a\nvalue should be removed from the final result.\n\n* --sort-merged-arrays\nCan be used with the 'deep' merge strategy. When this flag is used, all\nmerged arrays are sorted.\n\n* --merge-hash-arrays\nCan be used with the 'deep' merge strategy. When this flag is used, hashes\nWITHIN arrays are deep-merged with their counterparts by position.\n\n* --explain-options\nExplain whether a lookup_options hash affects this lookup, and how that hash\nwas assembled. (lookup_options is how Hiera configures merge behavior in data.)\n\n* --default <VALUE>\nA value to return if Hiera can't find a value in data. For emulating calls to\nthe 'lookup()' function that include a default.\n\n* --type <TYPESTRING>:\nAssert that the value has the specified type. For emulating calls to the\n'lookup()' function that include a data type.\n\n* --compile\nPerform a full catalog compilation prior to the lookup. If your hierarchy and\ndata only use the $facts, $trusted, and $server_facts variables, you don't\nneed this option; however, if your Hiera configuration uses arbitrary\nvariables set by a Puppet manifest, you might need this option to get accurate\ndata. No catalog compilation takes place unless this flag is given.\n\n* --render-as s|json|yaml|binary|msgpack\nSpecify the output format of the results; \"s\" means plain text. The default\nwhen producing a value is yaml and the default when producing an explanation\nis s.\n\nEXAMPLE\n-------\nTo look up 'key_name' using the Puppet Server node's facts:\n$ puppet lookup key_name\n\nTo look up 'key_name' with agent.local's facts:\n$ puppet lookup --node agent.local key_name\n\nTo get the first value found for 'key_name_one' and 'key_name_two'\nwith agent.local's facts while merging values and knocking out\nthe prefix 'foo' while merging:\n$ puppet lookup --node agent.local --merge deep --knock-out-prefix foo key_name_one key_name_two\n\nTo lookup 'key_name' with agent.local's facts, and return a default value of\n'bar' if nothing was found:\n$ puppet lookup --node agent.local --default bar key_name\n\nTo see an explanation of how the value for 'key_name' would be found, using\nagent.local's facts:\n$ puppet lookup --node agent.local --explain key_name\n\nCOPYRIGHT\n---------\nCopyright (c) 2015 Puppet Inc., LLC Licensed under the Apache 2.0 License\n\n\n"
end

#mainObject


258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
# File 'lib/puppet/application/lookup.rb', line 258

def main
  keys = command_line.args

  #unless options[:node]
  #  raise "No node was given via the '--node' flag for the scope of the lookup.\n#{RUN_HELP}"
  #end

  if (options[:sort_merged_arrays] || options[:merge_hash_arrays] || options[:prefix]) && options[:merge] != 'deep'
    raise _("The options %{deep_merge_opts} are only available with '--merge deep'\n%{run_help}") % { deep_merge_opts: DEEP_MERGE_OPTIONS, run_help: RUN_HELP }
  end

  use_default_value = !options[:default_value].nil?
  merge_options = nil

  merge = options[:merge]
  unless merge.nil?
    strategies = Puppet::Pops::MergeStrategy.strategy_keys
    unless strategies.include?(merge.to_sym)
      strategies = strategies.map {|k| "'#{k}'"}
      raise _("The --merge option only accepts %{strategies}, or %{last_strategy}\n%{run_help}") % { strategies: strategies[0...-1].join(', '), last_strategy: strategies.last, run_help: RUN_HELP }
    end

    if merge == 'deep'
      merge_options = {'strategy' => 'deep',
        'sort_merged_arrays' => !options[:sort_merged_arrays].nil?,
        'merge_hash_arrays' => !options[:merge_hash_arrays].nil?}

      if options[:prefix]
        merge_options['knockout_prefix'] = options[:prefix]
      end

    else
      merge_options = {'strategy' => merge}
    end
  end

  explain_data = !!options[:explain]
  explain_options = !!options[:explain_options]
  only_explain_options = explain_options && !explain_data
  if keys.empty?
    if only_explain_options
      # Explain lookup_options for lookup of an unqualified value.
      keys = Puppet::Pops::Lookup::GLOBAL
    else
      raise _('No keys were given to lookup.')
    end
  end
  explain = explain_data || explain_options

  # Format defaults to text (:s) when producing an explanation and :yaml when producing the value
  format = options[:render_as] || (explain ? :s : :yaml)
  renderer = Puppet::Network::FormatHandler.format(format)
  raise _("Unknown rendering format '%{format}'") % { format: format } if renderer.nil?

  generate_scope do |scope|
    lookup_invocation = Puppet::Pops::Lookup::Invocation.new(scope, {}, {}, explain ? Puppet::Pops::Lookup::Explainer.new(explain_options, only_explain_options) : nil)
    begin
      type = options.include?(:type) ? Puppet::Pops::Types::TypeParser.singleton.parse(options[:type], scope) : nil
      result = Puppet::Pops::Lookup.lookup(keys, type, options[:default_value], use_default_value, merge_options, lookup_invocation)
      puts renderer.render(result) unless explain
    rescue Puppet::DataBinding::LookupError => e
      lookup_invocation.report_text { e.message }
      exit(1) unless explain
    end
    puts format == :s ? lookup_invocation.explainer.explain : renderer.render(lookup_invocation.explainer.to_hash) if explain
  end
  exit(0)
end

#setupObject


88
89
90
91
92
93
94
95
96
# File 'lib/puppet/application/lookup.rb', line 88

def setup
  setup_logs

  exit(Puppet.settings.print_configs ? 0 : 1) if Puppet.settings.print_configs?

  Puppet.settings.use :main, :master, :ssl, :metrics

  setup_terminuses
end

#setup_logsObject


70
71
72
73
74
75
76
# File 'lib/puppet/application/lookup.rb', line 70

def setup_logs
  # This sets up logging based on --debug or --verbose if they are set in `options`
  set_log_level

  # This uses console for everything that is not a compilation
  Puppet::Util::Log.newdestination(:console)
end

#setup_terminusesObject


78
79
80
81
82
83
84
85
86
# File 'lib/puppet/application/lookup.rb', line 78

def setup_terminuses
  require 'puppet/file_serving/content'
  require 'puppet/file_serving/metadata'

  Puppet::FileServing::Content.indirection.terminus_class = :file_server
  Puppet::FileServing::.indirection.terminus_class = :file_server

  Puppet::FileBucket::File.indirection.terminus_class = :file
end

#summaryObject


98
99
100
# File 'lib/puppet/application/lookup.rb', line 98

def summary
  _("Interactive Hiera lookup")
end