Class: Chef::Knife::Core::NodePresenter

Inherits:
GenericPresenter show all
Defined in:
lib/chef/knife/core/node_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/node_presenter.rb', line 30

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

#key(key_text) ⇒ Object 



126
127
128
 
# File 'lib/chef/knife/core/node_presenter.rb', line 126

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

#summarize(data) ⇒ 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
 
# File 'lib/chef/knife/core/node_presenter.rb', line 69

def summarize(data)
  if data.is_a?(Chef::Node)
    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]

    summarized = <<~SUMMARY
      #{ui.color("Node Name:", :bold)}   #{ui.color(node.name, :bold)}
    SUMMARY
    show_policy = !(node.policy_name.nil? && node.policy_group.nil?)
    if show_policy
      summarized << <<~POLICY
        #{key("Policy Name:")}  #{node.policy_name}
        #{key("Policy Group:")} #{node.policy_group}
      POLICY
    else
      summarized << <<~ENV
        #{key("Environment:")} #{node.chef_environment}
      ENV
    end
    summarized << <<~SUMMARY
      #{key("FQDN:")}        #{node[:fqdn]}
      #{key("IP:")}          #{ip}
      #{key("Run List:")}    #{node.run_list}
    SUMMARY
    unless show_policy
      summarized << <<~ROLES
        #{key("Roles:")}       #{Array(node[:roles]).join(", ")}
      ROLES
    end
    summarized << <<~SUMMARY
      #{key("Recipes:")}     #{Array(node[:recipes]).join(", ")}
      #{key("Platform:")}    #{node[:platform]} #{node[:platform_version]}
      #{key("Tags:")}        #{node.tags.join(", ")}
    SUMMARY
    if config[:medium_output] || config[:long_output]
      summarized += <<~MORE
        #{key("Attributes:")}
        #{text_format(node.normal_attrs)}
      MORE
    end
    if config[:long_output]
      summarized += <<~MOST
        #{key("Default Attributes:")}
        #{text_format(node.default_attrs)}
        #{key("Override Attributes:")}
        #{text_format(node.override_attrs)}
        #{key("Automatic Attributes (Ohai Data):")}
        #{text_format(node.automatic_attrs)}
      MOST
    end
    summarized
  else
    super
  end
end

#summarize_json(data) ⇒ 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/node_presenter.rb', line 38

def summarize_json(data)
  if data.is_a?(Chef::Node)
    node = data
    result = {}

    result["name"] = node.name
    if node.policy_name.nil? && node.policy_group.nil?
      result["chef_environment"] = node.chef_environment
    else
      result["policy_name"] = node.policy_name
      result["policy_group"] = node.policy_group
    end
    result["run_list"] = node.run_list
    result["normal"] = node.normal_attrs

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

    Chef::JSONCompat.to_json_pretty(result)
  else
    Chef::JSONCompat.to_json_pretty(data)
  end
end