Module: Bolt::Util

Defined in:
lib/bolt/util.rb,
lib/bolt/util/puppet_log_level.rb

Defined Under Namespace

Modules: PuppetLogLevel

Class Method Summary collapse

Class Method Details

.class_name_to_file_name(cls_name) ⇒ Object 



276
277
278
279
280
 
# File 'lib/bolt/util.rb', line 276

def class_name_to_file_name(cls_name)
  # Note this turns Bolt::CLI -> 'bolt/cli' not 'bolt/c_l_i'
  # this won't handle Bolt::Inventory2Foo
  cls_name.gsub(/([a-z])([A-Z])/, '\1_\2').gsub('::', '/').downcase
end

.deep_clone(obj, cloned = {}) ⇒ Object

Performs a deep_clone, using an identical copy if the cloned structure contains multiple references to the same object and prevents endless recursion. Credit to Jan Molic via github.com/rubyworks/facets/blob/master/LICENSE.txt



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
257
258
259
260
261
262
263
264
265
 
# File 'lib/bolt/util.rb', line 208

def deep_clone(obj, cloned = {})
  return cloned[obj.object_id] if cloned.include?(obj.object_id)

  # The `defined?` method will not reliably find the Java::JavaLang::CloneNotSupportedException constant
  # presumably due to some sort of optimization that short-cuts doing a bunch of Java introspection.
  # Java::JavaLang::<...> IS defining the constant (via const_missing or const_get magic perhaps) so
  # it is safe to reference it in the error_types array when a JRuby interpreter is evaluating the code
  # (detected by RUBY_PLATFORM == `java`). SO instead of conditionally adding the CloneNotSupportedException
  # constant to the error_types array based on `defined?` detecting the Java::JavaLang constant it is added
  # based on detecting a JRuby interpreter.
  # TypeError handles unclonable Ruby ojbects (TrueClass, Fixnum, ...)
  # CloneNotSupportedException handles uncloneable Java objects (JRuby only)
  error_types = [TypeError]
  error_types << Java::JavaLang::CloneNotSupportedException if RUBY_PLATFORM == 'java'

  begin
    # We can't recurse on frozen objects to populate them with cloned
    # data. Instead we store the freeze-state of the original object,
    # deep_clone, then set the cloned object to frozen if the original
    # object was frozen
    frozen = obj.frozen?
    cl = begin
      obj.clone(freeze: false)
    # Some datatypes, such as FalseClass, can't be unfrozen. These
    # aren't the types we recurse on, so we can leave them frozen
    rescue ArgumentError => e
      if e.message =~ /can't unfreeze/
        obj.clone
      else
        raise e
      end
    end
  rescue *error_types
    cloned[obj.object_id] = obj
    obj
  else
    cloned[obj.object_id] = cl
    cloned[cl.object_id] = cl

    case cl
    when Hash
      obj.each { |k, v| cl[k] = deep_clone(v, cloned) }
    when Array
      cl.collect! { |v| deep_clone(v, cloned) }
    when Struct
      obj.each_pair { |k, v| cl[k] = deep_clone(v, cloned) }
    end

    cl.instance_variables.each do |var|
      v = cl.instance_variable_get(var)
      v_cl = deep_clone(v, cloned)
      cl.instance_variable_set(var, v_cl)
    end

    cl.freeze if frozen
    cl
  end
end

.deep_merge(hash1, hash2) ⇒ Object 



144
145
146
147
148
149
150
151
152
153
 
# File 'lib/bolt/util.rb', line 144

def deep_merge(hash1, hash2)
  recursive_merge = proc do |_key, h1, h2|
    if h1.is_a?(Hash) && h2.is_a?(Hash)
      h1.merge(h2, &recursive_merge)
    else
      h2
    end
  end
  hash1.merge(hash2, &recursive_merge)
end

.file_stat(path) ⇒ Object

This is stubbed for testing validate_file



268
269
270
 
# File 'lib/bolt/util.rb', line 268

def file_stat(path)
  File.stat(File.expand_path(path))
end

.get_arg_input(value) ⇒ Object

Gets input for an argument.



7
8
9
10
11
12
13
14
15
16
 
# File 'lib/bolt/util.rb', line 7

def get_arg_input(value)
  if value.start_with?('@')
    file = value.sub(/^@/, '')
    read_arg_file(file)
  elsif value == '-'
    $stdin.read
  else
    value
  end
end

.module_name(path) ⇒ Object

Accepts a path with either ‘plans’ or ‘tasks’ in it and determines the name of the module



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
 
# File 'lib/bolt/util.rb', line 82

def module_name(path)
  # Remove extra dots and slashes
  path = Pathname.new(path).cleanpath.to_s
  fs = File::SEPARATOR
  regex = Regexp.new("#{fs}plans#{fs}|#{fs}tasks#{fs}")

  # Only accept paths with '/plans/' or '/tasks/'
  unless path.match?(regex)
    msg = "Could not determine module from #{path}. "\
      "The path must include 'plans' or 'tasks' directory"
    raise Bolt::Error.new(msg, 'bolt/modulepath-error')
  end

  # Split the path on the first instance of /plans/ or /tasks/
  parts = path.split(regex, 2)
  # Module name is the last entry before 'plans' or 'tasks'
  modulename = parts[0].split(fs)[-1]
  filename = File.basename(path).split('.')[0]
  # Remove "/init.*" if filename is init or just remove the file
  # extension
  if filename == 'init'
    parts[1].chomp!(File.basename(path))
  else
    parts[1].chomp!(File.extname(path))
  end

  # The plan or task name is the rest of the path
  [modulename, parts[1].split(fs)].flatten.join('::')
end

.postwalk_vals(data, skip_top = false, &block) ⇒ Object

Accepts a Data object and returns a copy with all hash and array values modified by the given block. Descendants are modified before their parents.



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/bolt/util.rb', line 189

def postwalk_vals(data, skip_top = false, &block)
  new_data = case data
             when Hash
               data.transform_values { |v| postwalk_vals(v, &block) }
             when Array
               data.map { |v| postwalk_vals(v, &block) }
             else
               data
             end
  if skip_top
    new_data
  else
    yield(new_data)
  end
end

.powershell? ⇒ Boolean

Returns true if running in PowerShell.

Returns:

  • (Boolean) 


306
307
308
 
# File 'lib/bolt/util.rb', line 306

def powershell?
  !!ENV['PSModulePath']
end

.prompt_yes_no(prompt, outputter) ⇒ Object

Prompts yes or no, returning true for yes and false for no.



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
 
# File 'lib/bolt/util.rb', line 339

def prompt_yes_no(prompt, outputter)
  choices = {
    'y'   => true,
    'yes' => true,
    'n'   => false,
    'no'  => false
  }

  loop do
    outputter.print_prompt("#{prompt} ([y]es/[n]o) ")
    response = $stdin.gets.to_s.downcase.chomp

    if choices.key?(response)
      return choices[response]
    else
      outputter.print_prompt_error("Invalid response, must pick [y]es or [n]o")
    end
  end
end

.read_arg_file(file) ⇒ Object

Reads a file passed as an argument to a command.



19
20
21
22
23
 
# File 'lib/bolt/util.rb', line 19

def read_arg_file(file)
  File.read(File.expand_path(file))
rescue StandardError => e
  raise Bolt::FileError.new("Error attempting to read #{file}: #{e}", file)
end

.read_json_file(path, filename) ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/bolt/util.rb', line 25

def read_json_file(path, filename)
  require 'json'

  logger = Bolt::Logger.logger(self)
  path = File.expand_path(path)
  content = JSON.parse(File.read(path))
  logger.trace("Loaded #{filename} from #{path}")
  content
rescue Errno::ENOENT
  raise Bolt::FileError.new("Could not read #{filename} file at #{path}", path)
rescue JSON::ParserError => e
  msg = "Unable to parse #{filename} file at #{path} as JSON: #{e.message}"
  raise Bolt::FileError.new(msg, path)
rescue IOError, SystemCallError => e
  raise Bolt::FileError.new("Could not read #{filename} file at #{path}\n#{e.message}",
                            path)
end

.read_optional_json_file(path, file_name) ⇒ Object 



43
44
45
 
# File 'lib/bolt/util.rb', line 43

def read_optional_json_file(path, file_name)
  File.exist?(path) && !File.zero?(path) ? read_yaml_hash(path, file_name) : {}
end

.read_optional_yaml_hash(path, file_name) ⇒ Object 



76
77
78
 
# File 'lib/bolt/util.rb', line 76

def read_optional_yaml_hash(path, file_name)
  File.exist?(path) ? read_yaml_hash(path, file_name) : {}
end

.read_yaml_hash(path, file_name) ⇒ Object 



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
 
# File 'lib/bolt/util.rb', line 47

def read_yaml_hash(path, file_name)
  require 'yaml'

  logger = Bolt::Logger.logger(self)
  path = File.expand_path(path)
  content = File.open(path, "r:UTF-8") { |f| YAML.safe_load(f.read) } || {}
  unless content.is_a?(Hash)
    raise Bolt::FileError.new(
      "Invalid content for #{file_name} file at #{path}\nContent should be a Hash or empty, "\
      "not #{content.class}",
      path
    )
  end
  logger.trace("Loaded #{file_name} from #{path}")
  content
rescue Errno::ENOENT
  raise Bolt::FileError.new("Could not read #{file_name} file at #{path}", path)
rescue Psych::SyntaxError => e
  raise Bolt::FileError.new("Could not parse #{file_name} file at #{path}, line #{e.line}, "\
                            "column #{e.column}\n#{e.problem}",
                            path)
rescue Psych::Exception => e
  raise Bolt::FileError.new("Could not parse #{file_name} file at #{path}\n#{e.message}",
                            path)
rescue IOError, SystemCallError => e
  raise Bolt::FileError.new("Could not read #{file_name} file at #{path}\n#{e.message}",
                            path)
end

.references?(input) ⇒ Boolean

Recursively searches a data structure for plugin references

Returns:

  • (Boolean) 


316
317
318
319
320
321
322
323
324
325
 
# File 'lib/bolt/util.rb', line 316

def references?(input)
  case input
  when Hash
    input.key?('_plugin') || input.values.any? { |v| references?(v) }
  when Array
    input.any? { |v| references?(v) }
  else
    false
  end
end

.snake_name_to_class_name(snake_name) ⇒ Object 



272
273
274
 
# File 'lib/bolt/util.rb', line 272

def snake_name_to_class_name(snake_name)
  snake_name.split('_').map(&:capitalize).join
end

.symbolize_top_level_keys(hsh) ⇒ Object

Accept hash and return hash with top level keys of type “String” converted to symbols.



311
312
313
 
# File 'lib/bolt/util.rb', line 311

def symbolize_top_level_keys(hsh)
  hsh.each_with_object({}) { |(k, v), h| k.is_a?(String) ? h[k.to_sym] = v : h[k] = v }
end

.to_code(string) ⇒ Object 



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
 
# File 'lib/bolt/util.rb', line 112

def to_code(string)
  case string
  when Bolt::PAL::YamlPlan::DoubleQuotedString
    string.value.inspect
  when Bolt::PAL::YamlPlan::BareString
    if string.value.start_with?('$')
      string.value.to_s
    else
      "'#{string.value}'"
    end
  when Bolt::PAL::YamlPlan::EvaluableString, Bolt::PAL::YamlPlan::CodeLiteral
    string.value.to_s
  when String
    "'#{string}'"
  when Hash
    formatted = String.new("{")
    string.each do |k, v|
      formatted << "#{to_code(k)} => #{to_code(v)}, "
    end
    formatted.chomp!(", ")
    formatted << "}"
    formatted
  when Array
    formatted = String.new("[")
    formatted << string.map { |str| to_code(str) }.join(', ')
    formatted << "]"
    formatted
  else
    string
  end
end

.unix_basename(path) ⇒ Object

Raises:



327
328
329
330
 
# File 'lib/bolt/util.rb', line 327

def unix_basename(path)
  raise Bolt::ValidationError, "path must be a String, received #{path.class} #{path}" unless path.is_a?(String)
  path.split('/').last
end

.validate_file(type, path, allow_dir = false) ⇒ Object 



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/bolt/util.rb', line 282

def validate_file(type, path, allow_dir = false)
  stat = file_stat(path)

  if !stat.readable?
    raise Bolt::FileError.new("The #{type} '#{path}' is unreadable", path)
  elsif !stat.file? && (!allow_dir || !stat.directory?)
    expected = allow_dir ? 'file or directory' : 'file'
    raise Bolt::FileError.new("The #{type} '#{path}' is not a #{expected}", path)
  elsif stat.directory?
    Dir.foreach(path) do |file|
      next if %w[. ..].include?(file)
      validate_file(type, File.join(path, file), allow_dir)
    end
  end
rescue Errno::ENOENT
  raise Bolt::FileError.new("The #{type} '#{path}' does not exist", path)
end

.walk_keys(data, &block) ⇒ Object

Accepts a Data object and returns a copy with all hash keys modified by block. use &:to_s to stringify keys or &:to_sym to symbolize them



157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/bolt/util.rb', line 157

def walk_keys(data, &block)
  case data
  when Hash
    data.each_with_object({}) do |(k, v), acc|
      v = walk_keys(v, &block)
      acc[yield(k)] = v
    end
  when Array
    data.map { |v| walk_keys(v, &block) }
  else
    data
  end
end

.walk_vals(data, skip_top = false, &block) ⇒ Object

Accepts a Data object and returns a copy with all hash and array values Arrays and hashes including the initial object are modified before their descendants are.



174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/bolt/util.rb', line 174

def walk_vals(data, skip_top = false, &block)
  data = yield(data) unless skip_top
  case data
  when Hash
    data.transform_values { |v| walk_vals(v, &block) }
  when Array
    data.map { |v| walk_vals(v, &block) }
  else
    data
  end
end

.windows? ⇒ Boolean

Returns true if windows false if not.

Returns:

  • (Boolean) 


301
302
303
 
# File 'lib/bolt/util.rb', line 301

def windows?
  !!File::ALT_SEPARATOR
end

.windows_basename(path) ⇒ Object

Raises:



332
333
334
335
 
# File 'lib/bolt/util.rb', line 332

def windows_basename(path)
  raise Bolt::ValidationError, "path must be a String, received #{path.class} #{path}" unless path.is_a?(String)
  path.split(%r{[/\\]}).last
end