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
208
209
210
211
212
213
214
215
216
|
# 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'
class Chef
class Knife
class SubcommandLoader
MATCHES_CHEF_GEM = %r{/chef-[\d]+\.[\d]+\.[\d]+}.freeze
MATCHES_THIS_CHEF_GEM = %r{/chef-#{Chef::VERSION}/}.freeze
attr_reader :chef_config_dir
attr_reader :env
def initialize(chef_config_dir)
@chef_config_dir = chef_config_dir
@forced_activate = {}
end
# Load all the sub-commands
def load_commands
subcommand_files.each { |subcommand| Kernel.load subcommand }
true
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
# Returns a Hash of paths to knife commands built-in to chef, or installed via gem.
# If rubygems is not installed, falls back to globbing the knife directory.
# The Hash is of the form {"relative/path" => "/absolute/path"}
#--
# Note: the "right" way to load the plugins is to require the relative path, i.e.,
# require 'chef/knife/command'
# but we're getting frustrated by bugs at every turn, and it's slow besides. So
# subcommand loader has been modified to load the plugins by using Kernel.load
# with the absolute path.
def gem_and_builtin_subcommands
if have_plugin_manifest?
find_subcommands_via_manifest
else
# search all gems for chef/knife/*.rb
require 'rubygems'
find_subcommands_via_rubygems
end
rescue LoadError
find_subcommands_via_dirglob
end
def subcommand_files
@subcommand_files ||= (gem_and_builtin_subcommands.values + site_subcommands).flatten.uniq
end
# If the user has created a ~/.chef/plugin_manifest.json file, we'll use
# that instead of inspecting the on-system gems to find the plugins. The
# file format is expected to look like:
#
# { "plugins": {
# "knife-ec2": {
# "paths": [
# "/home/alice/.rubymanagerthing/gems/knife-ec2-x.y.z/lib/chef/knife/ec2_server_create.rb",
# "/home/alice/.rubymanagerthing/gems/knife-ec2-x.y.z/lib/chef/knife/ec2_server_delete.rb"
# ]
# }
# }
# }
#
# Extraneous content in this file is ignored. This intentional so that we
# can adapt the file format for potential behavior changes to knife in
# the future.
def find_subcommands_via_manifest
# Format of subcommand_files is "relative_path" (something you can
# Kernel.require()) => full_path. The relative path isn't used
# currently, so we just map full_path => full_path.
subcommand_files = {}
plugin_manifest["plugins"].each do |plugin_name, plugin_manifest|
plugin_manifest["paths"].each do |cmd_path|
subcommand_files[cmd_path] = cmd_path
end
end
subcommand_files.merge(find_subcommands_via_dirglob)
end
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
def find_subcommands_via_rubygems
files = find_files_latest_gems 'chef/knife/*.rb'
subcommand_files = {}
files.each do |file|
rel_path = file[/(#{Regexp.escape File.join('chef', 'knife', '')}.*)\.rb/, 1]
# When not installed as a gem (ChefDK/appbundler in particular), AND
# a different version of Chef is installed via gems, `files` will
# include some files from the 'other' Chef install. If this contains
# a knife command that doesn't exist in this version of Chef, we will
# get a LoadError later when we try to require it.
next if from_different_chef_version?(file)
subcommand_files[rel_path] = file
end
subcommand_files.merge(find_subcommands_via_dirglob)
end
def have_plugin_manifest?
plugin_manifest_path && File.exist?(plugin_manifest_path)
end
def plugin_manifest
Chef::JSONCompat.from_json(File.read(plugin_manifest_path))
end
def plugin_manifest_path
Chef::Util::PathHelper.home('.chef', 'plugin_manifest.json')
end
private
def find_files_latest_gems(glob, check_load_path=true)
files = []
if check_load_path
files = $LOAD_PATH.map { |load_path|
Dir["#{File.expand_path glob, Chef::Util::PathHelper.escape_glob(load_path)}#{Gem.suffix_pattern}"]
}.flatten.select { |file| File.file? file.untaint }
end
gem_files = latest_gem_specs.map do |spec|
# Gem::Specification#matches_for_glob wasn't added until RubyGems 1.8
if spec.respond_to? :matches_for_glob
spec.matches_for_glob("#{glob}#{Gem.suffix_pattern}")
else
check_spec_for_glob(spec, glob)
end
end.flatten
files.concat gem_files
files.uniq! if check_load_path
return files
end
def latest_gem_specs
@latest_gem_specs ||= if Gem::Specification.respond_to? :latest_specs
Gem::Specification.latest_specs(true) # find prerelease gems
else
Gem.source_index.latest_specs(true)
end
end
def check_spec_for_glob(spec, glob)
dirs = if spec.require_paths.size > 1 then
"{#{spec.require_paths.join(',')}}"
else
spec.require_paths.first
end
glob = File.join(Chef::Util::PathHelper.escape_glob(spec.full_gem_path, dirs), glob)
Dir[glob].map { |f| f.untaint }
end
def from_different_chef_version?(path)
matches_any_chef_gem?(path) && !matches_this_chef_gem?(path)
end
def matches_any_chef_gem?(path)
path =~ MATCHES_CHEF_GEM
end
def matches_this_chef_gem?(path)
path =~ MATCHES_THIS_CHEF_GEM
end
end
end
end
|
