Module: MCollective::Util

Defined in:
lib/mcollective/util.rb

Overview

Some basic utility helper methods useful to clients, agents, runner etc.

Class Method Summary collapse

Class Method Details

.absolute_path?(path, separator = File::SEPARATOR, alt_separator = File::ALT_SEPARATOR) ⇒ Boolean

we should really use Pathname#absolute? but it’s not in all the ruby versions we support and it comes down to roughly this

Returns:

  • (Boolean) 


473
474
475
476
477
478
479
480
481
 
# File 'lib/mcollective/util.rb', line 473

def self.absolute_path?(path, separator=File::SEPARATOR, alt_separator=File::ALT_SEPARATOR)
  if alt_separator
    path_matcher = /^([a-zA-Z]:){0,1}[#{Regexp.quote alt_separator}#{Regexp.quote separator}]/
  else
    path_matcher = /^#{Regexp.quote separator}/
  end

  !!path.match(path_matcher)
end

.align_text(text, console_cols = nil, preamble = 5) ⇒ Object

Returns an aligned_string of text relative to the size of the terminal window. If a line in the string exceeds the width of the terminal window the line will be chopped off at the whitespace chacter closest to the end of the line and prepended to the next line, keeping all indentation.

The terminal size is detected by default, but custom line widths can passed. All strings will also be left aligned with 5 whitespace characters by default.



319
320
321
322
323
324
325
326
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
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
 
# File 'lib/mcollective/util.rb', line 319

def self.align_text(text, console_cols = nil, preamble = 5)
  unless console_cols
    console_cols = terminal_dimensions[0]

    # if unknown size we default to the typical unix default
    console_cols = 80 if console_cols == 0
  end

  console_cols -= preamble

  # Return unaligned text if console window is too small
  return text if console_cols <= 0

  # If console is 0 this implies unknown so we assume the common
  # minimal unix configuration of 80 characters
  console_cols = 80 if console_cols <= 0

  text = text.split("\n")
  piece = ''
  whitespace = 0

  text.each_with_index do |line, i|
    whitespace = 0

    while whitespace < line.length && line[whitespace].chr == ' '
      whitespace += 1
    end

    # If the current line is empty, indent it so that a snippet
    # from the previous line is aligned correctly.
    if line == ""
      line = (" " * whitespace)
    end

    # If text was snipped from the previous line, prepend it to the
    # current line after any current indentation.
    if piece != ''
      # Reset whitespaces to 0 if there are more whitespaces than there are
      # console columns
      whitespace = 0 if whitespace >= console_cols

      # If the current line is empty and being prepended to, create a new
      # empty line in the text so that formatting is preserved.
      if text[i + 1] && line == (" " * whitespace)
        text.insert(i + 1, "")
      end

      # Add the snipped text to the current line
      line.insert(whitespace, "#{piece} ")
    end

    piece = ''

    # Compare the line length to the allowed line length.
    # If it exceeds it, snip the offending text from the line
    # and store it so that it can be prepended to the next line.
    if line.length > (console_cols + preamble)
      reverse = console_cols

      while line[reverse].chr != ' '
        reverse -= 1
      end

      piece = line.slice!(reverse, (line.length - 1)).lstrip
    end

    # If a snippet exists when all the columns in the text have been
    # updated, create a new line and append the snippet to it, using
    # the same left alignment as the last line in the text.
    if piece != '' && text[i+1].nil?
      text[i+1] = "#{' ' * (whitespace)}#{piece}"
      piece = ''
    end

    # Add the preamble to the line and add it to the text
    line = ((' ' * preamble) + line)
    text[i] = line
  end

  text.join("\n")
end

.color(code) ⇒ Object

Return color codes, if the config color= option is false just return a empty string



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/mcollective/util.rb', line 279

def self.color(code)
  colorize = Config.instance.color

  colors = {:red => "",
            :green => "",
            :yellow => "",
            :cyan => "",
            :bold => "",
            :reset => ""}

  if colorize
    return colors[code] || ""
  else
    return ""
  end
end

.colorize(code, msg) ⇒ Object

Helper to return a string in specific color



297
298
299
 
# File 'lib/mcollective/util.rb', line 297

def self.colorize(code, msg)
  "%s%s%s" % [ color(code), msg, color(:reset) ]
end

.command_in_path?(command) ⇒ Boolean

Checks in PATH returns true if the command is found

Returns:

  • (Boolean) 


426
427
428
429
430
431
432
 
# File 'lib/mcollective/util.rb', line 426

def self.command_in_path?(command)
  found = ENV["PATH"].split(File::PATH_SEPARATOR).map do |p|
    File.exist?(File.join(p, command))
  end

  found.include?(true)
end

.config_file_for_user ⇒ Object

Picks a config file defaults to ~/.mcollective else /etc/mcollective/client.cfg



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
 
# File 'lib/mcollective/util.rb', line 157

def self.config_file_for_user
  # the set of acceptable config files
  config_paths = []

  # user dotfile
  begin
    # File.expand_path will raise if HOME isn't set, catch it
    user_path = File.expand_path("~/.mcollective")
    config_paths << user_path
  rescue Exception
  end

  # standard locations
  if self.windows?
    config_paths << File.join(self.windows_prefix, 'etc', 'client.cfg')
  else
    config_paths << '/etc/puppetlabs/mcollective/client.cfg'
    config_paths << '/etc/mcollective/client.cfg'
  end

  # use the first readable config file, or if none are the first listed
  found = config_paths.find_index { |file| File.readable?(file) } || 0
  return config_paths[found]
end

.default_options ⇒ Object

Creates a standard options hash



183
184
185
186
187
188
189
190
191
192
 
# File 'lib/mcollective/util.rb', line 183

def self.default_options
  {:verbose           => false,
   :disctimeout       => nil,
   :timeout           => 5,
   :config            => config_file_for_user,
   :collective        => nil,
   :discovery_method  => nil,
   :discovery_options => Config.instance.default_discovery_options,
   :filter            => empty_filter}
end

.empty_filter ⇒ Object

Creates an empty filter



141
142
143
144
145
146
147
 
# File 'lib/mcollective/util.rb', line 141

def self.empty_filter
  {"fact"     => [],
   "cf_class" => [],
   "agent"    => [],
   "identity" => [],
   "compound" => []}
end

.empty_filter?(filter) ⇒ Boolean

Checks if the passed in filter is an empty one

Returns:

  • (Boolean) 


136
137
138
 
# File 'lib/mcollective/util.rb', line 136

def self.empty_filter?(filter)
  filter == empty_filter || filter == {}
end

.field_number(field_size, max_size = 90) ⇒ Object

Calculate number of fields for printing



519
520
521
522
 
# File 'lib/mcollective/util.rb', line 519

def self.field_number(field_size, max_size=90)
  number = (max_size/field_size).to_i
  (number == 0) ? 1 : number
end

.field_size(elements, min_size = 40) ⇒ Object

Get field size for printing



513
514
515
516
 
# File 'lib/mcollective/util.rb', line 513

def self.field_size(elements, min_size=40)
  max_length = elements.max_by { |e| e.length }.length
  max_length > min_size ? max_length : min_size
end

.get_fact(fact) ⇒ Object

Gets the value of a specific fact, mostly just a duplicate of MCollective::Facts.get_fact but it kind of goes with the other classes here



61
62
63
 
# File 'lib/mcollective/util.rb', line 61

def self.get_fact(fact)
  Facts.get_fact(fact)
end

.get_hidden_input(message = 'Please enter data: ') ⇒ Object 



560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
 
# File 'lib/mcollective/util.rb', line 560

def self.get_hidden_input(message='Please enter data: ')
  unless message.nil?
    print message
  end
  if versioncmp(ruby_version, '1.9.3') >= 0
    require 'io/console'
    input = $stdin.noecho(&:gets)
  else
    # Use hacks to get hidden input on Ruby <1.9.3
    if self.windows?
      input = self.get_hidden_input_on_windows()
    else
      input = self.get_hidden_input_on_unix()
    end
  end
  input.chomp! if input
  input
end

.get_hidden_input_on_unix ⇒ Object 



545
546
547
548
549
550
551
552
553
554
555
556
557
558
 
# File 'lib/mcollective/util.rb', line 545

def self.get_hidden_input_on_unix()
  unless $stdin.tty?
    raise 'Could not hook to stdin to hide input. If using SSH, try using -t flag while connecting to server.'
  end
  unless system 'stty -echo -icanon'
    raise 'Could not hide input using stty command.'
  end
  input = $stdin.gets
  ensure
    unless system 'stty echo icanon'
      raise 'Could not enable echoing of input. Try executing `stty echo icanon` to debug.'
    end
  input
end

.get_hidden_input_on_windows ⇒ Object 



524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/mcollective/util.rb', line 524

def self.get_hidden_input_on_windows()
  require 'Win32API'
  # Hook into getch from crtdll. Keep reading all keys till return
  # or newline is hit.
  # If key is backspace or delete, then delete the character and update
  # the buffer.
  input = ''
  while char = Win32API.new("crtdll", "_getch", [ ], "I").Call do
    break if char == 10 || char == 13 # return or newline
    if char == 127 || char == 8 # backspace and delete
      if input.length > 0
        input.slice!(-1, 1)
      end
    else
      input << char.chr
    end
  end
  char = ''
  input
end

.has_agent?(agent) ⇒ Boolean

Finds out if this MCollective has an agent by the name passed

If the passed name starts with a / it’s assumed to be regex and will use regex to match

Returns:

  • (Boolean) 


8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
 
# File 'lib/mcollective/util.rb', line 8

def self.has_agent?(agent)
  agent = Regexp.new(agent.gsub("\/", "")) if agent.match("^/")

  if agent.is_a?(Regexp)
    if Agents.agentlist.grep(agent).size > 0
      return true
    else
      return false
    end
  else
    return Agents.agentlist.include?(agent)
  end

  false
end

.has_cf_class?(klass) ⇒ Boolean

Checks if this node has a configuration management class by parsing the a text file with just a list of classes, recipes, roles etc. This is ala the classes.txt from puppet.

If the passed name starts with a / it’s assumed to be regex and will use regex to match

Returns:

  • (Boolean) 


38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/mcollective/util.rb', line 38

def self.has_cf_class?(klass)
  klass = Regexp.new(klass.gsub("\/", "")) if klass.match("^/")
  cfile = Config.instance.classesfile

  Log.debug("Looking for configuration management classes in #{cfile}")

  begin
    File.readlines(cfile).each do |k|
      if klass.is_a?(Regexp)
        return true if k.chomp.match(klass)
      else
        return true if k.chomp == klass
      end
    end
  rescue Exception => e
    Log.warn("Parsing classes file '#{cfile}' failed: #{e.class}: #{e}")
  end

  false
end

.has_fact?(fact, value, operator) ⇒ Boolean

Compares fact == value,

If the passed value starts with a / it’s assumed to be regex and will use regex to match

Returns:

  • (Boolean) 


69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/mcollective/util.rb', line 69

def self.has_fact?(fact, value, operator)

  Log.debug("Comparing #{fact} #{operator} #{value}")
  Log.debug("where :fact = '#{fact}', :operator = '#{operator}', :value = '#{value}'")

  fact = Facts[fact]
  return false if fact.nil?

  fact = fact.clone
  case fact
  when Array
    return fact.any? { |element| test_fact_value(element, value, operator)}
  when Hash
    return fact.keys.any? { |element| test_fact_value(element, value, operator)}
  else
    return test_fact_value(fact, value, operator)
  end
end

.has_identity?(identity) ⇒ Boolean

Checks if the configured identity matches the one supplied

If the passed name starts with a / it’s assumed to be regex and will use regex to match

Returns:

  • (Boolean) 


123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/mcollective/util.rb', line 123

def self.has_identity?(identity)
  identity = Regexp.new(identity.gsub("\/", "")) if identity.match("^/")

  if identity.is_a?(Regexp)
    return Config.instance.identity.match(identity)
  else
    return true if Config.instance.identity == identity
  end

  false
end

.loadclass(klass) ⇒ Object

Wrapper around PluginManager.loadclass



233
234
235
 
# File 'lib/mcollective/util.rb', line 233

def self.loadclass(klass)
  PluginManager.loadclass(klass)
end

.make_subscriptions(agent, type, collective = nil) ⇒ Object 



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/mcollective/util.rb', line 194

def self.make_subscriptions(agent, type, collective=nil)
  config = Config.instance

  raise("Unknown target type #{type}") unless [:broadcast, :directed, :reply].include?(type)

  if collective.nil?
    config.collectives.map do |c|
      {:agent => agent, :type => type, :collective => c}
    end
  else
    raise("Unknown collective '#{collective}' known collectives are '#{config.collectives.join ', '}'") unless config.collectives.include?(collective)

    [{:agent => agent, :type => type, :collective => collective}]
  end
end

.mcollective_version ⇒ Object 



307
308
309
 
# File 'lib/mcollective/util.rb', line 307

def self.mcollective_version
  MCollective::VERSION
end

.parse_fact_string(fact) ⇒ Object

Parse a fact filter string like foo=bar into the tuple hash thats needed



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/mcollective/util.rb', line 238

def self.parse_fact_string(fact)
  if fact =~ /^([^ ]+?)[ ]*=>[ ]*(.+)/
    return {:fact => $1, :value => $2, :operator => '>=' }
  elsif fact =~ /^([^ ]+?)[ ]*=<[ ]*(.+)/
    return {:fact => $1, :value => $2, :operator => '<=' }
  elsif fact =~ /^([^ ]+?)[ ]*(<=|>=|<|>|!=|==|=~)[ ]*(.+)/
    return {:fact => $1, :value => $3, :operator => $2 }
  elsif fact =~ /^(.+?)[ ]*=[ ]*\/(.+)\/$/
    return {:fact => $1, :value => "/#{$2}/", :operator => '=~' }
  elsif fact =~ /^([^= ]+?)[ ]*=[ ]*(.+)/
    return {:fact => $1, :value => $2, :operator => '==' }
  else
    raise "Could not parse fact #{fact} it does not appear to be in a valid format"
  end
end

.ruby_version ⇒ Object

Returns the current ruby version as per RUBY_VERSION, mostly doing this here to aid testing



303
304
305
 
# File 'lib/mcollective/util.rb', line 303

def self.ruby_version
  RUBY_VERSION
end

.setup_windows_sleeper ⇒ Object

On windows ^c can’t interrupt the VM if its blocking on IO, so this sets up a dummy thread that sleeps and this will have the end result of being interruptable at least once a second. This is a common pattern found in Rails etc



28
29
30
 
# File 'lib/mcollective/util.rb', line 28

def self.setup_windows_sleeper
  Thread.new { loop { sleep 1 } } if Util.windows?
end

.shellescape(str) ⇒ Object

Escapes a string so it’s safe to use in system() or backticks

Taken from Shellwords#shellescape since it’s only in a few ruby versions



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/mcollective/util.rb', line 257

def self.shellescape(str)
  return "''" if str.empty?

  str = str.dup

  # Process as a single byte sequence because not all shell
  # implementations are multibyte aware.
  str.gsub!(/([^A-Za-z0-9_\-.,:\/@\n])/n, "\\\\\\1")

  # A LF cannot be escaped with a backslash because a backslash + LF
  # combo is regarded as line continuation and simply ignored.
  str.gsub!(/\n/, "'\n'")

  return str
end

.str_to_bool(val) ⇒ Object

Converts a string into a boolean value Strings matching 1,y,yes,true or t will return TrueClass Any other value will return FalseClass



486
487
488
489
490
491
492
493
494
495
 
# File 'lib/mcollective/util.rb', line 486

def self.str_to_bool(val)
  clean_val = val.to_s.strip
  if clean_val =~ /^(1|yes|true|y|t)$/i
    return  true
  elsif clean_val =~ /^(0|no|false|n|f)$/i
    return false
  else
    raise("Cannot convert string value '#{clean_val}' into a boolean.")
  end
end

.subscribe(targets) ⇒ Object

Helper to subscribe to a topic on multiple collectives or just one



211
212
213
214
215
216
217
218
219
 
# File 'lib/mcollective/util.rb', line 211

def self.subscribe(targets)
  connection = PluginManager["connector_plugin"]

  targets = [targets].flatten

  targets.each do |target|
    connection.subscribe(target[:agent], target[:type], target[:collective])
  end
end

.subscribe_to_direct_addressing_queue ⇒ Object

subscribe to the direct addressing queue



508
509
510
 
# File 'lib/mcollective/util.rb', line 508

def self.subscribe_to_direct_addressing_queue
  subscribe(make_subscriptions("mcollective", :directed))
end

.templatepath(template_file) ⇒ Object

Looks up the template directory and returns its full path



498
499
500
501
502
503
504
505
 
# File 'lib/mcollective/util.rb', line 498

def self.templatepath(template_file)
  config_dir = File.dirname(Config.instance.configfile)
  template_path = File.join(config_dir, template_file)
  return template_path if File.exists?(template_path)

  template_path = File.join("/etc/mcollective", template_file)
  return template_path
end

.terminal_dimensions(stdout = STDOUT, environment = ENV) ⇒ Object

Figures out the columns and lines of the current tty

Returns [0, 0] if it can’t figure it out or if you’re not running on a tty



405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/mcollective/util.rb', line 405

def self.terminal_dimensions(stdout = STDOUT, environment = ENV)
  return [0, 0] unless stdout.tty?

  return [80, 40] if Util.windows?

  if environment["COLUMNS"] && environment["LINES"]
    return [environment["COLUMNS"].to_i, environment["LINES"].to_i]

  elsif environment["TERM"] && command_in_path?("tput")
    return [`tput cols`.to_i, `tput lines`.to_i]

  elsif command_in_path?('stty')
    return `stty size`.scan(/\d+/).map {|s| s.to_i }
  else
    return [0, 0]
  end
rescue
  [0, 0]
end

.unsubscribe(targets) ⇒ Object

Helper to unsubscribe to a topic on multiple collectives or just one



222
223
224
225
226
227
228
229
230
 
# File 'lib/mcollective/util.rb', line 222

def self.unsubscribe(targets)
  connection = PluginManager["connector_plugin"]

  targets = [targets].flatten

  targets.each do |target|
    connection.unsubscribe(target[:agent], target[:type], target[:collective])
  end
end

.versioncmp(version_a, version_b) ⇒ Object

compare two software versions as commonly found in package versions.

returns 0 if a == b returns -1 if a < b returns 1 if a > b

Code originally from Puppet



442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/mcollective/util.rb', line 442

def self.versioncmp(version_a, version_b)
  vre = /[-.]|\d+|[^-.\d]+/
  ax = version_a.scan(vre)
  bx = version_b.scan(vre)

  while (ax.length>0 && bx.length>0)
    a = ax.shift
    b = bx.shift

    if( a == b )                 then next
    elsif (a == '-' && b == '-') then next
    elsif (a == '-')             then return -1
    elsif (b == '-')             then return 1
    elsif (a == '.' && b == '.') then next
    elsif (a == '.' )            then return -1
    elsif (b == '.' )            then return 1
    elsif (a =~ /^\d+$/ && b =~ /^\d+$/) then
      if( a =~ /^0/ or b =~ /^0/ ) then
        return a.to_s.upcase <=> b.to_s.upcase
      end
      return a.to_i <=> b.to_i
    else
      return a.upcase <=> b.upcase
    end
  end

  version_a <=> version_b;
end

.windows? ⇒ Boolean

Returns:

  • (Boolean) 


273
274
275
 
# File 'lib/mcollective/util.rb', line 273

def self.windows?
  !!(RbConfig::CONFIG['host_os'] =~ /mswin|win32|dos|mingw|cygwin/i)
end

.windows_prefix ⇒ Object

Returns the PuppetLabs mcollective path for windows



150
151
152
153
 
# File 'lib/mcollective/util.rb', line 150

def self.windows_prefix
  require 'win32/dir'
  prefix = File.join(Dir::COMMON_APPDATA, "PuppetLabs", "mcollective")
end