Class: Chef::Knife::UI

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Defined in:
lib/chef/knife/core/ui.rb

Overview

The User Interaction class used by knife.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(stdout, stderr, stdin, config) ⇒ UI

Returns a new instance of UI.



45
46
47
48
 
# File 'lib/chef/knife/core/ui.rb', line 45

def initialize(stdout, stderr, stdin, config)
  @stdout, @stderr, @stdin, @config = stdout, stderr, stdin, config
  @presenter = Chef::Knife::Core::GenericPresenter.new(self, config)
end

Instance Attribute Details

#config ⇒ Object (readonly)

Returns the value of attribute config.



37
38
39
 
# File 'lib/chef/knife/core/ui.rb', line 37

def config
  @config
end

#presenter ⇒ Object (readonly)

Returns the value of attribute presenter.



39
40
41
 
# File 'lib/chef/knife/core/ui.rb', line 39

def presenter
  @presenter
end

#stderr ⇒ Object (readonly)

Returns the value of attribute stderr.



35
36
37
 
# File 'lib/chef/knife/core/ui.rb', line 35

def stderr
  @stderr
end

#stdin ⇒ Object (readonly)

Returns the value of attribute stdin.



36
37
38
 
# File 'lib/chef/knife/core/ui.rb', line 36

def stdin
  @stdin
end

#stdout ⇒ Object (readonly)

Returns the value of attribute stdout.



34
35
36
 
# File 'lib/chef/knife/core/ui.rb', line 34

def stdout
  @stdout
end

Instance Method Details

#ask(*args, &block) ⇒ Object 



150
151
152
 
# File 'lib/chef/knife/core/ui.rb', line 150

def ask(*args, &block)
  highline.ask(*args, &block)
end

#ask_question(question, opts = {}) ⇒ Object 



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/chef/knife/core/ui.rb', line 171

def ask_question(question, opts = {})
  question += "[#{opts[:default]}] " if opts[:default]

  if opts[:default] && config[:defaults]
    opts[:default]
  else
    stdout.print question
    a = stdin.readline.strip

    if opts[:default]
      a.empty? ? opts[:default] : a
    else
      a
    end
  end
end

#color(string, *colors) ⇒ Object 



135
136
137
138
139
140
141
 
# File 'lib/chef/knife/core/ui.rb', line 135

def color(string, *colors)
  if color?
    highline.color(string, *colors)
  else
    string
  end
end

#color? ⇒ Boolean

Should colored output be used? For output to a terminal, this is determined by the value of ‘config`. When output is not to a terminal, colored output is never used

Returns:

  • (Boolean) 


146
147
148
 
# File 'lib/chef/knife/core/ui.rb', line 146

def color?
  Chef::Config[:color] && stdout.tty?
end

#confirm(question, append_instructions = true, default_choice = nil) ⇒ Object

Not the ideal signature for a function but we need to stick with this for now until we get a chance to break our API in Chef 12.

question => Question to print before asking for confirmation append_instructions => Should print ‘? (Y/N)’ as instructions default_choice => Set to true for ‘Y’, and false for ‘N’ as default answer



304
305
306
307
308
309
 
# File 'lib/chef/knife/core/ui.rb', line 304

def confirm(question, append_instructions = true, default_choice = nil)
  unless confirm_without_exit(question, append_instructions, default_choice)
    exit 3
  end
  true
end

#confirm_without_exit(question, append_instructions = true, default_choice = nil) ⇒ Object

See confirm method for argument information



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
 
# File 'lib/chef/knife/core/ui.rb', line 266

def confirm_without_exit(question, append_instructions = true, default_choice = nil)
  return true if config[:yes]

  stdout.print question
  stdout.print confirmation_instructions(default_choice) if append_instructions

  answer = stdin.readline
  answer.chomp!

  case answer
  when "Y", "y"
    true
  when "N", "n"
    msg("You said no, so I'm done here.")
    false
  when ""
    unless default_choice.nil?
      default_choice
    else
      msg("I have no idea what to do with '#{answer}'")
      msg("Just say Y or N, please.")
      confirm_without_exit(question, append_instructions, default_choice)
    end
  else
    msg("I have no idea what to do with '#{answer}'")
    msg("Just say Y or N, please.")
    confirm_without_exit(question, append_instructions, default_choice)
  end
end

#confirmation_instructions(default_choice) ⇒ Object 



254
255
256
257
258
259
260
261
262
263
 
# File 'lib/chef/knife/core/ui.rb', line 254

def confirmation_instructions(default_choice)
  case default_choice
  when true
    "? (Y/n) "
  when false
    "? (y/N) "
  else
    "? (Y/N) "
  end
end

#debug(message) ⇒ Object

Print a Debug

Parameters:

  • message (String) —

    the text string



110
111
112
 
# File 'lib/chef/knife/core/ui.rb', line 110

def debug(message)
  log("#{color("DEBUG:", :blue, :bold)} #{message}")
end

#edit_data(data, parse_output = true, object_class: nil) ⇒ Object 



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/chef/knife/core/ui.rb', line 204

def edit_data(data, parse_output = true, object_class: nil)
  output = Chef::JSONCompat.to_json_pretty(data)
  unless config[:disable_editing]
    Tempfile.open([ "knife-edit-", ".json" ]) do |tf|
      tf.sync = true
      tf.puts output
      tf.close
      raise "Please set EDITOR environment variable. See https://docs.chef.io/knife_setup.html for details." unless system("#{config[:editor]} #{tf.path}")

      output = IO.read(tf.path)
    end
  end

  if parse_output
    if object_class.nil?
      raise ArgumentError, "Please pass in the object class to hydrate or use #edit_hash"
    else
      object_class.from_hash(Chef::JSONCompat.parse(output))
    end
  else
    output
  end
end

#edit_hash(hash) ⇒ Object

Hash -> Hash Works the same as edit_data but returns a hash rather than a JSON string/Fully inflated object



199
200
201
202
 
# File 'lib/chef/knife/core/ui.rb', line 199

def edit_hash(hash)
  raw = edit_data(hash, false)
  Chef::JSONCompat.parse(raw)
end

#edit_object(klass, name) ⇒ Object 



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
 
# File 'lib/chef/knife/core/ui.rb', line 228

def edit_object(klass, name)
  object = klass.load(name)

  output = edit_data(object, object_class: klass)

  # Only make the save if the user changed the object.
  #
  # Output JSON for the original (object) and edited (output), then parse
  # them without reconstituting the objects into real classes
  # (create_additions=false). Then, compare the resulting simple objects,
  # which will be Array/Hash/String/etc.
  #
  # We wouldn't have to do these shenanigans if all the editable objects
  # implemented to_hash, or if to_json against a hash returned a string
  # with stable key order.
  object_parsed_again = Chef::JSONCompat.parse(Chef::JSONCompat.to_json(object))
  output_parsed_again = Chef::JSONCompat.parse(Chef::JSONCompat.to_json(output))
  if object_parsed_again != output_parsed_again
    output.save
    msg("Saved #{output}")
  else
    msg("Object unchanged, not saving")
  end
  output(format_for_display(object)) if config[:print_after]
end

#error(message) ⇒ Object

Print an error message

Parameters:

  • message (String) —

    the text string



124
125
126
 
# File 'lib/chef/knife/core/ui.rb', line 124

def error(message)
  log("#{color("ERROR:", :red, :bold)} #{message}")
end

#fatal(message) ⇒ Object

Print a message describing a fatal error.

Parameters:

  • message (String) —

    the text string



131
132
133
 
# File 'lib/chef/knife/core/ui.rb', line 131

def fatal(message)
  log("#{color("FATAL:", :red, :bold)} #{message}")
end

#highline ⇒ Object 



57
58
59
60
61
62
 
# File 'lib/chef/knife/core/ui.rb', line 57

def highline
  @highline ||= begin
    require "highline"
    HighLine.new
  end
end

#interchange? ⇒ Boolean

Determines if the output format is a data interchange format, i.e., JSON or YAML

Returns:

  • (Boolean) 


167
168
169
 
# File 'lib/chef/knife/core/ui.rb', line 167

def interchange?
  @presenter.interchange?
end

#list(*args) ⇒ Object 



154
155
156
 
# File 'lib/chef/knife/core/ui.rb', line 154

def list(*args)
  highline.list(*args)
end

#log(message) ⇒ Object Also known as: info, err

Prints a msg to stderr. Used for info, warn, error, and fatal.

Parameters:

  • message (String) —

    the text string



79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
 
# File 'lib/chef/knife/core/ui.rb', line 79

def log(message)
  lines = message.split("\n")
  first_line = lines.shift
  stderr.puts first_line
  # If the message is multiple lines,
  # indent subsequent lines to align with the
  # log type prefix ("ERROR: ", etc)
  unless lines.empty?
    prefix, = first_line.split(":", 2)
    return if prefix.nil?

    prefix_len = prefix.length
    prefix_len -= 9 if color? # prefix includes 9 bytes of color escape sequences
    prefix_len += 2 # include room to align to the ": " following PREFIX
    padding = " " * prefix_len
    lines.each do |line|
      stderr.puts "#{padding}#{line}"
    end
  end
rescue Errno::EPIPE => e
  raise e if @config[:verbosity] >= 2

  exit 0
end

#msg(message) ⇒ Object

Prints a message to stdout. Aliased as info for compatibility with the logger API.

Parameters:

  • message (String) —

    the text string



68
69
70
71
72
73
74
 
# File 'lib/chef/knife/core/ui.rb', line 68

def msg(message)
  stdout.puts message
rescue Errno::EPIPE => e
  raise e if @config[:verbosity] >= 2

  exit 0
end

#output(data) ⇒ Object

Formats data using the configured presenter and outputs the result via msg. Formatting can be customized by configuring a different presenter. See use_presenter



161
162
163
 
# File 'lib/chef/knife/core/ui.rb', line 161

def output(data)
  msg @presenter.format(data)
end

#pretty_print(data) ⇒ Object 



188
189
190
191
192
193
194
 
# File 'lib/chef/knife/core/ui.rb', line 188

def pretty_print(data)
  stdout.puts data
rescue Errno::EPIPE => e
  raise e if @config[:verbosity] >= 2

  exit 0
end

#use_presenter(presenter_class) ⇒ Object

Creates a new presenter_class object and uses it to format structured data for display. By default, a Chef::Knife::Core::GenericPresenter object is used.



53
54
55
 
# File 'lib/chef/knife/core/ui.rb', line 53

def use_presenter(presenter_class)
  @presenter = presenter_class.new(self, config)
end

#warn(message) ⇒ Object

Print a warning message

Parameters:

  • message (String) —

    the text string



117
118
119
 
# File 'lib/chef/knife/core/ui.rb', line 117

def warn(message)
  log("#{color("WARNING:", :yellow, :bold)} #{message}")
end