module ResourceInspector
Public Class Methods
extract_cookbook(path, complete)
click to toggle source
# File lib/chef/resource_inspector.rb, line 48 def self.extract_cookbook(path, complete) path = File.expand_path(path) dir, name = File.split(path) Chef::Cookbook::FileVendor.fetch_from_disk(path) loader = Chef::CookbookLoader.new(dir) cookbooks = loader.load_cookbooks resources = cookbooks[name].files_for(:resources) resources.each_with_object({}) do |r, res| pth = r["full_path"] cur = Chef::Resource::LWRPBase.build_from_file(name, pth, Chef::RunContext.new(Chef::Node.new, nil, nil)) res[cur.resource_name] = extract_resource(cur, complete) end end
extract_resource(resource, complete = false)
click to toggle source
# File lib/chef/resource_inspector.rb, line 27 def self.extract_resource(resource, complete = false) data = {} data[:description] = resource.description # data[:deprecated] = resource.deprecated || false data[:actions] = resource.allowed_actions data[:examples] = resource.examples data[:introduced] = resource.introduced properties = unless complete resource.properties.reject { |_, k| k.options[:declared_in] == Chef::Resource } else resource.properties end data[:properties] = properties.each_with_object([]) do |(n, k), acc| opts = k.options acc << { name: n, description: opts[:description], introduced: opts[:introduced], is: opts[:is], deprecated: opts[:deprecated] || false } end data end
inspect(arguments = [], complete: false)
click to toggle source
If we're given no resources, dump all of Chef's built ins otherwise, if we have a path then extract all the resources from the cookbook or else do a list of built in resources
@param complete [TrueClass, FalseClass] Whether to show properties defined in the base Resource class
# File lib/chef/resource_inspector.rb, line 68 def self.inspect(arguments = [], complete: false) output = if arguments.empty? ObjectSpace.each_object(Class).select { |k| k < Chef::Resource }.each_with_object({}) { |klass, acc| acc[klass.resource_name] = extract_resource(klass) } else arguments.each_with_object({}) do |arg, acc| if File.directory?(arg) extract_cookbook(arg, complete).each { |k, v| acc[k] = v } else r = Chef::ResourceResolver.resolve(arg.to_sym, canonical: nil) acc[r.resource_name] = extract_resource(r, complete) end end end puts Chef::JSONCompat.to_json_pretty(output) end
start()
click to toggle source
# File lib/chef/resource_inspector.rb, line 85 def self.start inspect(ARGV, complete: true) end