Class: KnifeAudit::Audit

Inherits:
Chef::Knife
  • Object
show all
Defined in:
lib/chef/knife/audit.rb

Instance Method Summary collapse

Instance Method Details

#format_cookbook_runlist_list_for_display(item) ⇒ Object 



199
200
201
202
203
204
205
206
207
208
209
210
211
 
# File 'lib/chef/knife/audit.rb', line 199

def format_cookbook_runlist_list_for_display(item)
  key_length = item.empty? ? 0 : item.keys.map {|name| name.size }.max + 2
  if config[:show_nodelist]
    item.sort.map do |name, cookbook|
      "#{name.ljust(key_length)} #{cookbook["count"]} [ #{cookbook["nodes"].join('  ')} ]"
    end
  else
    item.sort.map do |name, cookbook|
      "#{name.ljust(key_length)} #{cookbook["count"]}"
    end
  end
     
end

#format_cookbook_seenlist_list_for_display(item) ⇒ Object

format_cokbook_runlist… def end



213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/chef/knife/audit.rb', line 213

def format_cookbook_seenlist_list_for_display(item)
  key_length = item.empty? ? 0 : item.keys.map {|name| name.size }.max + 2
  if config[:show_nodelist]
    item.sort.map do |name, cookbook|
      "#{name.ljust(key_length)} #{cookbook["seen_recipe_count"]} [ #{cookbook["seen_recipe_nodes"].join('  ')} ]"
    end
  else
    item.sort.map do |name, cookbook|
      "#{name.ljust(key_length)} #{cookbook["seen_recipe_count"]}"
    end
  end
     
end

#format_cookbook_totallist_list_for_display(item) ⇒ Object

format_cokbook_seenlist… def end



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/chef/knife/audit.rb', line 227

def format_cookbook_totallist_list_for_display(item)
  key_length = item.empty? ? 0 : item.keys.map {|name| name.size }.max + 2
  if config[:show_nodelist]
    item.sort.map do |name, cookbook|
      cookbook_display = (cookbook["seen_recipe_nodes"] + cookbook["nodes"]).uniq
      cookbook_count = cookbook["seen_recipe_count"] + cookbook["count"]
      "#{name.ljust(key_length)} #{cookbook_count} [ #{cookbook_display.join('  ')} ]"
    end
  else
    item.sort.map do |name, cookbook|
      cookbook_count = cookbook["seen_recipe_count"] + cookbook["count"]
      "#{name.ljust(key_length)} #{cookbook_count}"
    end
  end
     
end

#run ⇒ Object 



54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
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
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/chef/knife/audit.rb', line 54

def run

  if @name_args.empty? 
    display_cookbooks = {}
  else
    display_cookbooks = @name_args 
  end

  self.config = Chef::Config.merge!(config)

  # If :install_cookbook flag is set, just install the cookbook and return (exit).
  if config[:install_cookbook]

    unless config[:cookbook_path]
      ui.msg("No cookbook path set in Chef config, cannot install cookbook.")
      return
    end
  
    source_path = File.dirname(__FILE__) + "/knife_audit_cookbook"
    dest_path = config[:cookbook_path].first + "/knife_audit"

    if File.exist?(dest_path)
      ui.msg("knife_audit cookbook already present in cookbook directory #{config[:cookbook_path].first} - aborting...")
    else
      FileUtils.copy_entry(source_path, dest_path)
      ui.msg("knife-audit cookbook copied to Chef cookbook directory #{config[:cookbook_path].first}")
    end

    return
  end
   
  # 1) Get a list (hash, actually, with key of 'name') of cookbooks available on the current server/org
  #    unless we've been given a cookbook/cookbooks on the command line
  env		= config[:environment]
  num_versions 	= config[:all_versions] ? "num_versions=all" : "num_versions=1"
  
  if display_cookbooks.empty?
    api_endpoint	= env ? "/environments/#{env}/cookbooks?#{num_versions}" : "/cookbooks?#{num_versions}"
    cookbook_list	= rest.get_rest(api_endpoint)
  else
    cookbook_list	= {}
    display_cookbooks.each do |cookbook_name|
      api_endpoint	= env ? "/environments/#{env}/cookbooks/#{cookbook_name}" : "cookbooks/#{cookbook_name}"
      begin
        cookbook_list.merge!(rest.get_rest(api_endpoint))
      rescue
        ui.error("Cookbook #{cookbook_name} could not be found on the server!")
        exit 1
      end 
    end 

  end


  # add count => 0 to each cookbook hash
  cookbook_list.each do |name,book|
    book["count"] = 0
    book["seen_recipe_count"] = 0
    book["nodes"] = []
    book["seen_recipe_nodes"] = []
  end


  # 2) Get an array of Chef::Nodes known to the current server/org

  query = "*:*"  # find all nodes

  Shef::Extensions.extend_context_object(self)
  node_list = nodes.find(query) 

  # 3) Iterate over each node

  node_list.each do |node|

    # 3a) Get node's runlist

    # Check to see if we need the seen_recipes total or not; if no, skip.  
    # If yes use seen_recipes if it's available. If it's not available, fall back 
    # to the node.recipes contents.
    if (config[:all_cookbooks] || config[:totals])
      recipes = (node["knife_audit"] && node["knife_audit"]["seen_recipes"].keys) || node.expand!.recipes.to_a
      if node["knife_audit"] && node["knife_audit"]["seen_recipes"] 
        node_seen_recipe_flag = true
      end
    else
      # If not, use node.recipes. Using expand!.recipes catches multi-level roles 
      # (roles with roles with recipes, etc.)
      recipes = node.expand!.recipes.to_a
    end

    node_cookbook_list = recipes.map{ |x| x.match(/[^\:]+/)[0] }.uniq

    # 3b) For each cookbook in the node runlist, if it's in our cookbook array increment its count and
    #     add the node to its running node array

    node_cookbook_list.each do |cookbook|
     if cookbook_list.has_key?(cookbook)
        # Up the appropriate ookbook count and add node to appropriate nodes array
        if node_seen_recipe_flag
          cookbook_list[cookbook]["seen_recipe_count"] += 1
          cookbook_list[cookbook]["seen_recipe_nodes"] << node.name
        else
          cookbook_list[cookbook]["count"] += 1
          cookbook_list[cookbook]["nodes"] << node.name
        end
      end
    end
  node_seen_recipe_flag = false

  end # step 3 iterate end

  # 4) Output

  unless config[:totals]
    ui.msg("Cookbook audit from node runlists:")

    format_cookbook_runlist_list_for_display(cookbook_list).each do |line|
      ui.msg(line)
    end
  end

  if config[:all_cookbooks]
    puts("\n")

    ui.msg("Cookbook audit from seen_recipes:")

    format_cookbook_seenlist_list_for_display(cookbook_list).each do |line|
      ui.msg(line)
    end
  end

  if config[:totals]
    puts("\n")

    ui.msg("Cookbook audit totals - runlist-only nodes + seen_recipes:")

    format_cookbook_totallist_list_for_display(cookbook_list).each do |line|
      ui.msg(line)
    end
  end


end