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
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
197
198
199
200
201
202
203
204
205
206
207
|
# Author:: Christopher Brown (<cb@opscode.com>)
# Author:: Daniel DeLeo (<dan@opscode.com>)
# Copyright:: Copyright (c) 2009, 2011 Opscode, 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 "chef/version"
require "chef/util/path_helper"
require "chef/knife/core/gem_glob_loader"
require "chef/knife/core/hashed_command_loader"
require "chef/knife/core/custom_manifest_loader"
class Chef
class Knife
#
# Public Methods of a Subcommand Loader
#
# load_commands - loads all available subcommands
# load_command(args) - loads subcommands for the given args
# list_commands(args) - lists all available subcommands,
# optionally filtering by category
# subcommand_files - returns an array of all subcommand files
# that could be loaded
# commnad_class_from(args) - returns the subcommand class for the
# user-requested command
#
class SubcommandLoader
attr_reader :chef_config_dir
attr_reader :env
# A small factory method. Eventually, this is the only place
# where SubcommandLoader should know about its subclasses, but
# to maintain backwards compatibility many of the instance
# methods in this base class contain default implementations
# of the functions sub classes should otherwise provide
# or directly instantiate the appropriate subclass
def self.for_config(chef_config_dir)
if autogenerated_manifest?
Chef::Log.debug("Using autogenerated hashed command manifest #{plugin_manifest_path}")
Knife::SubcommandLoader::HashedCommandLoader.new(chef_config_dir, plugin_manifest)
elsif custom_manifest?
Chef.log_deprecation("Using custom manifest #{plugin_manifest_path} is deprecated. Please use a `knife rehash` autogenerated manifest instead.")
Knife::SubcommandLoader::CustomManifestLoader.new(chef_config_dir, plugin_manifest)
else
Knife::SubcommandLoader::GemGlobLoader.new(chef_config_dir)
end
end
def self.plugin_manifest?
plugin_manifest_path && File.exist?(plugin_manifest_path)
end
def self.autogenerated_manifest?
plugin_manifest? && plugin_manifest.key?(HashedCommandLoader::KEY)
end
def self.custom_manifest?
plugin_manifest? && plugin_manifest.key?("plugins")
end
def self.plugin_manifest
Chef::JSONCompat.from_json(File.read(plugin_manifest_path))
end
def self.plugin_manifest_path
Chef::Util::PathHelper.home(".chef", "plugin_manifest.json")
end
def initialize(chef_config_dir, env = nil)
@chef_config_dir = chef_config_dir
# Deprecated and un-used instance variable.
@env = env
unless env.nil?
Chef.log_deprecation("The env argument to Chef::Knife::SubcommandLoader is deprecated. If you are using env to inject/mock HOME, consider mocking Chef::Util::PathHelper.home instead.")
end
end
# Load all the sub-commands
def load_commands
return true if @loaded
subcommand_files.each { |subcommand| Kernel.load subcommand }
@loaded = true
end
def force_load
@loaded=false
load_commands
end
def load_command(_command_args)
load_commands
end
def list_commands(pref_cat = nil)
load_commands
if pref_cat && Chef::Knife.subcommands_by_category.key?(pref_cat)
{ pref_cat => Chef::Knife.subcommands_by_category[pref_cat] }
else
Chef::Knife.subcommands_by_category
end
end
def command_class_from(args)
cmd_words = positional_arguments(args)
load_command(cmd_words)
result = Chef::Knife.subcommands[find_longest_key(Chef::Knife.subcommands,
cmd_words, "_")]
result || Chef::Knife.subcommands[args.first.gsub("-", "_")]
end
def guess_category(args)
category_words = positional_arguments(args)
category_words.map! { |w| w.split("-") }.flatten!
find_longest_key(Chef::Knife.subcommands_by_category,
category_words, " ")
end
#
# This is shared between the custom_manifest_loader and the gem_glob_loader
#
def find_subcommands_via_dirglob
# The "require paths" of the core knife subcommands bundled with chef
files = Dir[File.join(Chef::Util::PathHelper.escape_glob(File.expand_path("../../../knife", __FILE__)), "*.rb")]
subcommand_files = {}
files.each do |knife_file|
rel_path = knife_file[/#{CHEF_ROOT}#{Regexp.escape(File::SEPARATOR)}(.*)\.rb/,1]
subcommand_files[rel_path] = knife_file
end
subcommand_files
end
#
# Subclassses should define this themselves. Eventually, this will raise a
# NotImplemented error, but for now, we mimic the behavior the user was likely
# to get in the past.
#
def subcommand_files
Chef.log_deprecation "Using Chef::Knife::SubcommandLoader directly is deprecated.
Please use Chef::Knife::SubcommandLoader.for_config(chef_config_dir, env)"
@subcommand_files ||= if Chef::Knife::SubcommandLoader.plugin_manifest?
Chef::Knife::SubcommandLoader::CustomManifestLoader.new(chef_config_dir, env).subcommand_files
else
Chef::Knife::SubcommandLoader::GemGlobLoader.new(chef_config_dir, env).subcommand_files
end
end
#
# Utility function for finding an element in a hash given an array
# of words and a separator. We find the the longest key in the
# hash composed of the given words joined by the separator.
#
def find_longest_key(hash, words, sep = "_")
match = nil
until match || words.empty?
candidate = words.join(sep)
if hash.key?(candidate)
match = candidate
else
words.pop
end
end
match
end
#
# The positional arguments from the argument list provided by the
# users. Used to search for subcommands and categories.
#
# @return [Array<String>]
#
def positional_arguments(args)
args.select { |arg| arg =~ /^(([[:alnum:]])[[:alnum:]\_\-]+)$/ }
end
# Returns an Array of paths to knife commands located in
# chef_config_dir/plugins/knife/ and ~/.chef/plugins/knife/
def site_subcommands
user_specific_files = []
if chef_config_dir
user_specific_files.concat Dir.glob(File.expand_path("plugins/knife/*.rb", Chef::Util::PathHelper.escape_glob(chef_config_dir)))
end
# finally search ~/.chef/plugins/knife/*.rb
Chef::Util::PathHelper.home(".chef", "plugins", "knife") do |p|
user_specific_files.concat Dir.glob(File.join(Chef::Util::PathHelper.escape_glob(p), "*.rb"))
end
user_specific_files
end
end
end
end
|
