1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
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
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
|
# Copyright:: Copyright 2018-2020, Chef Software, Inc
# License:: Apache License, Version 2.0
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#
require_relative "cookbook_loader"
require_relative "cookbook/file_vendor"
require_relative "cookbook/file_system_file_vendor"
require_relative "resource/lwrp_base"
require_relative "run_context"
require_relative "node"
require_relative "resources"
require_relative "json_compat"
module ResourceInspector
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
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.options[:declared_in] == Chef::Resource || k.options[:skip_docs] }
else
resource.properties.reject { |_, k| k.options[:skip_docs] }
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,
required: opts[:required] || false,
default: opts[:default_description] || get_default(opts[:default]),
name_property: opts[:name_property] || false,
equal_to: opts[:equal_to] || [] }
end
data
end
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
# 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
# @return [String] JSON formatting of all resources
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)
acc[r.resource_name] = extract_resource(r, complete)
end
end
end
Chef::JSONCompat.to_json_pretty(output)
end
def self.start
puts inspect(ARGV, complete: true)
end
end
|
