Class: Chef::Knife::Core::StatusPresenter

Inherits:
GenericPresenter show all
Defined in:
lib/chef/knife/core/status_presenter.rb

Overview

A customized presenter for Chef::Node objects. Supports variable-length output formats for displaying node data

Instance Attribute Summary

Attributes inherited from GenericPresenter

#config, #ui

Instance Method Summary collapse

Methods inherited from GenericPresenter

#attribute_field_separator, #extract_nested_value, #format_cookbook_list_for_display, #format_data_subset_for_display, #format_for_display, #format_list_for_display, #formatting_subset_of_data?, #initialize, #interchange?, #name_or_id_for, #parse_format_option, #text_format

Constructor Details

This class inherits a constructor from Chef::Knife::Core::GenericPresenter

Instance Method Details

#format(data) ⇒ Object 



30
31
32
33
34
35
36
 
# File 'lib/chef/knife/core/status_presenter.rb', line 30

def format(data)
  if parse_format_option == :json
    summarize_json(data)
  else
    super
  end
end

#key(key_text) ⇒ Object 



128
129
130
 
# File 'lib/chef/knife/core/status_presenter.rb', line 128

def key(key_text)
  ui.color(key_text, :cyan)
end

#summarize(list) ⇒ Object

Converts a Chef::Node object to a string suitable for output to a terminal. If config or config are set the volume of output is adjusted accordingly. Uses colors if enabled in the ui object.



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

def summarize(list)
  summarized = ""
  list.each do |data|
    node = data
    # special case clouds with their split horizon thing.
    ip = (node[:cloud] && node[:cloud][:public_ipv4_addrs] && node[:cloud][:public_ipv4_addrs].first) || node[:ipaddress]
    fqdn = (node[:cloud] && node[:cloud][:public_hostname]) || node[:fqdn]
    name = node["name"] || node.name

    if config[:run_list]
      if config[:long_output]
        run_list = node.run_list.map { |rl| "#{rl.type}[#{rl.name}]" }
      else
        run_list = node["run_list"]
      end
    end

    line_parts = []

    if node["ohai_time"]
      hours, minutes, seconds = time_difference_in_hms(node["ohai_time"])
      hours_text = "#{hours} hour#{hours == 1 ? " " : "s"}"
      minutes_text = "#{minutes} minute#{minutes == 1 ? " " : "s"}"
      seconds_text = "#{seconds} second#{seconds == 1 ? " " : "s"}"
      if hours > 24
        color = :red
        text = hours_text
      elsif hours >= 1
        color = :yellow
        text = hours_text
      elsif minutes >= 1
        color = :green
        text = minutes_text
      else
        color = :green
        text = seconds_text
      end
      line_parts << @ui.color(text, color) + " ago" << name
    else
      line_parts << "Node #{name} has not yet converged"
    end

    line_parts << fqdn if fqdn
    line_parts << ip if ip
    line_parts << run_list.to_s if run_list

    if node["platform"]
      platform = node["platform"].dup
      if node["platform_version"]
        platform << " #{node["platform_version"]}"
      end
      line_parts << platform
    end

    summarized = summarized + line_parts.join(", ") + ".\n"
  end
  summarized
end

#summarize_json(list) ⇒ Object 



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

def summarize_json(list)
  result_list = []
  list.each do |node|
    result = {}

    result["name"] = node["name"] || node.name
    result["chef_environment"] = node["chef_environment"]
    ip = (node["cloud"] && node["cloud"]["public_ipv4_addrs"]&.first) || node["ipaddress"]
    fqdn = (node["cloud"] && node["cloud"]["public_hostname"]) || node["fqdn"]
    result["ip"] = ip if ip
    result["fqdn"] = fqdn if fqdn
    result["run_list"] = node.run_list if config["run_list"]
    result["ohai_time"] = node["ohai_time"]
    result["platform"] = node["platform"] if node["platform"]
    result["platform_version"] = node["platform_version"] if node["platform_version"]

    if config[:long_output]
      result["default"]   = node.default_attrs
      result["override"]  = node.override_attrs
      result["automatic"] = node.automatic_attrs
    end
    result_list << result
  end

  Chef::JSONCompat.to_json_pretty(result_list)
end

#time_difference_in_hms(unix_time) ⇒ Object

TODO:

this is duplicated from StatusHelper in the Webui. dedup.



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

def time_difference_in_hms(unix_time)
  now = Time.now.to_i
  difference = now - unix_time.to_i
  hours = (difference / 3600).to_i
  difference = difference % 3600
  minutes = (difference / 60).to_i
  seconds = (difference % 60)
  [hours, minutes, seconds]
end