Module: ResourceInspector
- Defined in:
- lib/chef/resource_inspector.rb
Class Method Summary collapse
- .extract_cookbook(path, complete) ⇒ Object
- .extract_resource(resource, complete = false) ⇒ Object
- .get_default(default) ⇒ Object
-
.inspect(arguments = [], complete: false) ⇒ String
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.
- .start ⇒ Object
Class Method Details
.extract_cookbook(path, complete) ⇒ Object
66 67 68 69 70 71 72 73 74 75 76 77 78 79 |
# File 'lib/chef/resource_inspector.rb', line 66 def self.extract_cookbook(path, complete) path = File.(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) ⇒ 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 64 |
# File 'lib/chef/resource_inspector.rb', line 38 def self.extract_resource(resource, complete = false) data = {} data[:description] = resource.description # data[:deprecated] = resource.deprecated || false data[:default_action] = resource.default_action data[:actions] = resource.allowed_actions data[:examples] = resource.examples data[:introduced] = resource.introduced data[:preview] = resource.preview_resource properties = unless complete resource.properties.reject { |_, k| k.[:declared_in] == Chef::Resource || k.[:skip_docs] } else resource.properties.reject { |_, k| k.[:skip_docs] } end data[:properties] = properties.each_with_object([]) do |(n, k), acc| opts = k. acc << { name: n, description: opts[:description], introduced: opts[:introduced], is: opts[:is], deprecated: opts[:deprecated] || false, required: opts[:required] || false, default: opts[:default_description] || get_default(opts[:default]), name_property: opts[:name_property] || false } end data end |
.get_default(default) ⇒ Object
27 28 29 30 31 32 33 34 35 36 |
# File 'lib/chef/resource_inspector.rb', line 27 def self.get_default(default) if default.is_a?(Chef::DelayedEvaluator) # ideally we'd get the block we pass to `lazy`, but the best we can do # is to get the source location, which then results in reparsing the source # code for the resource ourselves and just no "lazy default" else default.is_a?(Symbol) ? default.inspect : default # inspect properly returns symbols end end |
.inspect(arguments = [], complete: false) ⇒ String
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
87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 |
# File 'lib/chef/resource_inspector.rb', line 87 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 Chef::JSONCompat.to_json_pretty(output) end |
.start ⇒ Object
104 105 106 |
# File 'lib/chef/resource_inspector.rb', line 104 def self.start puts inspect(ARGV, complete: true) end |