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
217
218
219
220
221
222
223
224
225
226
227
228
229
|
#
# Author:: Daniel DeLeo (<dan@chef.io>)
# Copyright:: Copyright 2014-2016, 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 "chef-config/config"
require "chef-config/exceptions"
require "chef-config/logger"
require "chef-config/path_helper"
require "chef-config/windows"
require "chef-config/mixin/dot_d"
require "chef-config/mixin/credentials"
module ChefConfig
class WorkstationConfigLoader
include ChefConfig::Mixin::DotD
include ChefConfig::Mixin::Credentials
# Path to a config file requested by user, (e.g., via command line option). Can be nil
attr_accessor :explicit_config_file
# The name of a credentials profile. Can be nil
attr_accessor :profile
attr_reader :credentials_found
# TODO: initialize this with a logger for Chef and Knife
def initialize(explicit_config_file, logger = nil, profile: nil)
@explicit_config_file = explicit_config_file
@chef_config_dir = nil
@config_location = nil
@profile = profile
@logger = logger || NullLogger.new
@credentials_found = false
end
def no_config_found?
config_location.nil? && !credentials_found
end
def config_location
@config_location ||= (explicit_config_file || locate_local_config)
end
def chef_config_dir
if @chef_config_dir.nil?
@chef_config_dir = false
full_path = working_directory.split(File::SEPARATOR)
(full_path.length - 1).downto(0) do |i|
candidate_directory = File.join(full_path[0..i] + [".chef"])
if File.exist?(candidate_directory) && File.directory?(candidate_directory)
@chef_config_dir = candidate_directory
break
end
end
end
@chef_config_dir
end
def load
load_credentials(profile)
# Ignore it if there's no explicit_config_file and can't find one at a
# default path.
unless config_location.nil?
if explicit_config_file && !path_exists?(config_location)
raise ChefConfig::ConfigurationError, "Specified config file #{config_location} does not exist"
end
# Have to set Config.config_file b/c other config is derived from it.
Config.config_file = config_location
apply_config(IO.read(config_location), config_location)
end
load_dot_d(Config[:config_d_dir]) if Config[:config_d_dir]
end
# (Private API, public for test purposes)
def env
ENV
end
# (Private API, public for test purposes)
def path_exists?(path)
Pathname.new(path).expand_path.exist?
end
private
def have_config?(path)
if path_exists?(path)
logger.info("Using config at #{path}")
true
else
logger.debug("Config not found at #{path}, trying next option")
false
end
end
def locate_local_config
candidate_configs = []
# Look for $KNIFE_HOME/knife.rb (allow multiple knives config on same machine)
if env["KNIFE_HOME"]
candidate_configs << File.join(env["KNIFE_HOME"], "config.rb")
candidate_configs << File.join(env["KNIFE_HOME"], "knife.rb")
end
# Look for $PWD/knife.rb
if Dir.pwd
candidate_configs << File.join(Dir.pwd, "config.rb")
candidate_configs << File.join(Dir.pwd, "knife.rb")
end
# Look for $UPWARD/.chef/knife.rb
if chef_config_dir
candidate_configs << File.join(chef_config_dir, "config.rb")
candidate_configs << File.join(chef_config_dir, "knife.rb")
end
# Look for $HOME/.chef/knife.rb
PathHelper.home(".chef") do |dot_chef_dir|
candidate_configs << File.join(dot_chef_dir, "config.rb")
candidate_configs << File.join(dot_chef_dir, "knife.rb")
end
candidate_configs.find do |candidate_config|
have_config?(candidate_config)
end
end
def working_directory
a = if ChefConfig.windows?
env["CD"]
else
env["PWD"]
end || Dir.pwd
a
end
def apply_credentials(creds, profile)
Config.profile ||= profile
if creds.key?("node_name") && creds.key?("client_name")
raise ChefConfig::ConfigurationError, "Do not specify both node_name and client_name. You should prefer client_name."
end
Config.node_name = creds.fetch("node_name") if creds.key?("node_name")
Config.node_name = creds.fetch("client_name") if creds.key?("client_name")
Config.chef_server_url = creds.fetch("chef_server_url") if creds.key?("chef_server_url")
Config.validation_client_name = creds.fetch("validation_client_name") if creds.key?("validation_client_name")
creds.each do |cred|
knife_setting = /knife\[:(\w+)\]/.match(cred[0])
if knife_setting
Config.knife[knife_setting[1].to_sym] = cred[1]
end
end
extract_key(creds, "validation_key", :validation_key, :validation_key_contents)
extract_key(creds, "validator_key", :validation_key, :validation_key_contents)
extract_key(creds, "client_key", :client_key, :client_key_contents)
@credentials_found = true
end
def extract_key(creds, name, config_path, config_contents)
return unless creds.has_key?(name)
val = creds.fetch(name)
if val.start_with?("-----BEGIN RSA PRIVATE KEY-----")
Config.send(config_contents, val)
else
abs_path = Pathname.new(val).expand_path(home_chef_dir)
Config.send(config_path, abs_path)
end
end
def home_chef_dir
@home_chef_dir ||= PathHelper.home(".chef")
end
def apply_config(config_content, config_file_path)
Config.from_string(config_content, config_file_path)
rescue SignalException
raise
rescue SyntaxError => e
message = ""
message << "You have invalid ruby syntax in your config file #{config_file_path}\n\n"
message << "#{e.class.name}: #{e.message}\n"
if file_line = e.message[/#{Regexp.escape(config_file_path)}:[\d]+/]
line = file_line[/:([\d]+)$/, 1].to_i
message << highlight_config_error(config_file_path, line)
end
raise ChefConfig::ConfigurationError, message
rescue Exception => e
message = "You have an error in your config file #{config_file_path}\n\n"
message << "#{e.class.name}: #{e.message}\n"
filtered_trace = e.backtrace.grep(/#{Regexp.escape(config_file_path)}/)
filtered_trace.each { |bt_line| message << " " << bt_line << "\n" }
unless filtered_trace.empty?
line_nr = filtered_trace.first[/#{Regexp.escape(config_file_path)}:([\d]+)/, 1]
message << highlight_config_error(config_file_path, line_nr.to_i)
end
raise ChefConfig::ConfigurationError, message
end
def highlight_config_error(file, line)
config_file_lines = []
IO.readlines(file).each_with_index { |l, i| config_file_lines << "#{(i + 1).to_s.rjust(3)}: #{l.chomp}" }
if line == 1
lines = config_file_lines[0..3]
else
lines = config_file_lines[Range.new(line - 2, line)]
end
"Relevant file content:\n" + lines.join("\n") + "\n"
end
def logger
@logger
end
end
end
|
