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
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
|
#
# Author:: John Keiser (<jkeiser@opscode.com>)
# Copyright:: Copyright (c) 2012 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/cookbook_manifest'
require 'chef_zero/data_store/memory_store'
require 'chef_zero/data_store/data_already_exists_error'
require 'chef_zero/data_store/data_not_found_error'
require 'chef/chef_fs/file_pattern'
require 'chef/chef_fs/file_system'
require 'chef/chef_fs/file_system/not_found_error'
require 'chef/chef_fs/file_system/memory_root'
require 'fileutils'
class Chef
module ChefFS
#
# Translation layer between chef-zero's DataStore (a place where it expects
# files to be stored) and ChefFS (the user's repository directory layout).
#
# chef-zero expects the data store to store files *its* way--for example, it
# expects get("nodes/blah") to return the JSON text for the blah node, and
# it expects get("cookbooks/blah/1.0.0") to return the JSON definition of
# the blah cookbook version 1.0.0.
#
# The repository is defined the way the *user* wants their layout. These
# two things are very similar in layout (for example, nodes are stored under
# the nodes/ directory and their filename is the name of the node).
#
# However, there are a few differences that make this more than just a raw
# file store:
#
# 1. Cookbooks are stored much differently.
# - chef-zero places JSON text with the checksums for the cookbook at
# /cookbooks/NAME/VERSION, and expects the JSON to contain URLs to the
# actual files, which are stored elsewhere.
# - The repository contains an actual directory with just the cookbook
# files and a metadata.rb containing a version #. There is no JSON to
# be found.
# - Further, if versioned_cookbooks is false, that directory is named
# /cookbooks/NAME and only one version exists. If versioned_cookbooks
# is true, the directory is named /cookbooks/NAME-VERSION.
# - Therefore, ChefFSDataStore calculates the cookbook JSON by looking at
# the files in the cookbook and checksumming them, and reading metadata.rb
# for the version and dependency information.
# - ChefFSDataStore also modifies the cookbook file URLs so that they point
# to /file_store/repo/<filename> (the path to the actual file under the
# repository root). For example, /file_store/repo/apache2/metadata.rb or
# /file_store/repo/cookbooks/apache2/recipes/default.rb).
#
# 2. Sandboxes don't exist in the repository.
# - ChefFSDataStore lets cookbooks be uploaded into a temporary memory
# storage, and when the cookbook is committed, copies the files onto the
# disk in the correct place (/cookbooks/apache2/recipes/default.rb).
# 3. Data bags:
# - The Chef server expects data bags in /data/BAG/ITEM
# - The repository stores data bags in /data_bags/BAG/ITEM
#
# 4. JSON filenames are generally NAME.json in the repository (e.g. /nodes/foo.json).
#
class ChefFSDataStore
#
# Create a new ChefFSDataStore
#
# ==== Arguments
#
# [chef_fs]
# A +ChefFS::FileSystem+ object representing the repository root.
# Generally will be a +ChefFS::FileSystem::ChefRepositoryFileSystemRoot+
# object, created from +ChefFS::Config.local_fs+.
#
def initialize(chef_fs)
@chef_fs = chef_fs
@memory_store = ChefZero::DataStore::MemoryStore.new
end
def publish_description
"Reading and writing data to #{chef_fs.fs_description}"
end
attr_reader :chef_fs
def create_dir(path, name, *options)
if use_memory_store?(path)
@memory_store.create_dir(path, name, *options)
else
with_dir(path) do |parent|
begin
parent.create_child(chef_fs_filename(path + [name]), nil)
rescue Chef::ChefFS::FileSystem::AlreadyExistsError => e
raise ChefZero::DataStore::DataAlreadyExistsError.new(to_zero_path(e.entry), e)
end
end
end
end
def create(path, name, data, *options)
if use_memory_store?(path)
@memory_store.create(path, name, data, *options)
elsif path[0] == 'cookbooks' && path.length == 2
# Do nothing. The entry gets created when the cookbook is created.
else
if !data.is_a?(String)
raise "set only works with strings"
end
with_dir(path) do |parent|
begin
parent.create_child(chef_fs_filename(path + [name]), data)
rescue Chef::ChefFS::FileSystem::AlreadyExistsError => e
raise ChefZero::DataStore::DataAlreadyExistsError.new(to_zero_path(e.entry), e)
end
end
end
end
def get(path, request=nil)
if use_memory_store?(path)
@memory_store.get(path)
elsif path[0] == 'file_store' && path[1] == 'repo'
entry = Chef::ChefFS::FileSystem.resolve_path(chef_fs, path[2..-1].join('/'))
begin
entry.read
rescue Chef::ChefFS::FileSystem::NotFoundError => e
raise ChefZero::DataStore::DataNotFoundError.new(to_zero_path(e.entry), e)
end
else
with_entry(path) do |entry|
if path[0] == 'cookbooks' && path.length == 3
# get /cookbooks/NAME/version
result = nil
begin
result = Chef::CookbookManifest.new(entry.chef_object).to_hash
rescue Chef::ChefFS::FileSystem::NotFoundError => e
raise ChefZero::DataStore::DataNotFoundError.new(to_zero_path(e.entry), e)
end
result.each_pair do |key, value|
if value.is_a?(Array)
value.each do |file|
if file.is_a?(Hash) && file.has_key?('checksum')
relative = ['file_store', 'repo', 'cookbooks']
if chef_fs.versioned_cookbooks
relative << "#{path[1]}-#{path[2]}"
else
relative << path[1]
end
relative = relative + file[:path].split('/')
file['url'] = ChefZero::RestBase::build_uri(request.base_uri, relative)
end
end
end
end
Chef::JSONCompat.to_json_pretty(result)
else
begin
entry.read
rescue Chef::ChefFS::FileSystem::NotFoundError => e
raise ChefZero::DataStore::DataNotFoundError.new(to_zero_path(e.entry), e)
end
end
end
end
end
def set(path, data, *options)
if use_memory_store?(path)
@memory_store.set(path, data, *options)
else
if !data.is_a?(String)
raise "set only works with strings: #{path} = #{data.inspect}"
end
# Write out the files!
if path[0] == 'cookbooks' && path.length == 3
write_cookbook(path, data, *options)
else
with_dir(path[0..-2]) do |parent|
child = parent.child(chef_fs_filename(path))
if child.exists?
child.write(data)
else
parent.create_child(chef_fs_filename(path), data)
end
end
end
end
end
def delete(path)
if use_memory_store?(path)
@memory_store.delete(path)
else
with_entry(path) do |entry|
begin
if path[0] == 'cookbooks' && path.length >= 3
entry.delete(true)
else
entry.delete(false)
end
rescue Chef::ChefFS::FileSystem::NotFoundError => e
raise ChefZero::DataStore::DataNotFoundError.new(to_zero_path(e.entry), e)
end
end
end
end
def delete_dir(path, *options)
if use_memory_store?(path)
@memory_store.delete_dir(path, *options)
else
with_entry(path) do |entry|
begin
entry.delete(options.include?(:recursive))
rescue Chef::ChefFS::FileSystem::NotFoundError => e
raise ChefZero::DataStore::DataNotFoundError.new(to_zero_path(e.entry), e)
end
end
end
end
def list(path)
if use_memory_store?(path)
@memory_store.list(path)
elsif path[0] == 'cookbooks' && path.length == 1
with_entry(path) do |entry|
begin
if chef_fs.versioned_cookbooks
# /cookbooks/name-version -> /cookbooks/name
entry.children.map { |child| split_name_version(child.name)[0] }.uniq
else
entry.children.map { |child| child.name }
end
rescue Chef::ChefFS::FileSystem::NotFoundError
# If the cookbooks dir doesn't exist, we have no cookbooks (not 404)
[]
end
end
elsif path[0] == 'cookbooks' && path.length == 2
if chef_fs.versioned_cookbooks
result = with_entry([ 'cookbooks' ]) do |entry|
# list /cookbooks/name = filter /cookbooks/name-version down to name
entry.children.map { |child| split_name_version(child.name) }.
select { |name, version| name == path[1] }.
map { |name, version| version }
end
if result.empty?
raise ChefZero::DataStore::DataNotFoundError.new(path)
end
result
else
# list /cookbooks/name = <single version>
version = get_single_cookbook_version(path)
[version]
end
else
with_entry(path) do |entry|
begin
entry.children.map { |c| zero_filename(c) }.sort
rescue Chef::ChefFS::FileSystem::NotFoundError => e
# /cookbooks, /data, etc. never return 404
if path_always_exists?(path)
[]
else
raise ChefZero::DataStore::DataNotFoundError.new(to_zero_path(e.entry), e)
end
end
end
end
end
def exists?(path)
if use_memory_store?(path)
@memory_store.exists?(path)
else
path_always_exists?(path) || Chef::ChefFS::FileSystem.resolve_path(chef_fs, to_chef_fs_path(path)).exists?
end
end
def exists_dir?(path)
if use_memory_store?(path)
@memory_store.exists_dir?(path)
elsif path[0] == 'cookbooks' && path.length == 2
list([ path[0] ]).include?(path[1])
else
Chef::ChefFS::FileSystem.resolve_path(chef_fs, to_chef_fs_path(path)).exists?
end
end
private
def use_memory_store?(path)
return path[0] == 'sandboxes' || path[0] == 'file_store' && path[1] == 'checksums' || path == [ 'environments', '_default' ]
end
def write_cookbook(path, data, *options)
if chef_fs.versioned_cookbooks
cookbook_path = File.join('cookbooks', "#{path[1]}-#{path[2]}")
else
cookbook_path = File.join('cookbooks', path[1])
end
# Create a little Chef::ChefFS memory filesystem with the data
cookbook_fs = Chef::ChefFS::FileSystem::MemoryRoot.new('uploading')
cookbook = Chef::JSONCompat.parse(data)
cookbook.each_pair do |key, value|
if value.is_a?(Array)
value.each do |file|
if file.is_a?(Hash) && file.has_key?('checksum')
file_data = @memory_store.get(['file_store', 'checksums', file['checksum']])
cookbook_fs.add_file(File.join(cookbook_path, file['path']), file_data)
end
end
end
end
# Create the .uploaded-cookbook-version.json
cookbooks = chef_fs.child('cookbooks')
if !cookbooks.exists?
cookbooks = chef_fs.create_child('cookbooks')
end
# We are calling a cookbooks-specific API, so get multiplexed_dirs out of the way if it is there
if cookbooks.respond_to?(:multiplexed_dirs)
cookbooks = cookbooks.write_dir
end
cookbooks.write_cookbook(cookbook_path, data, cookbook_fs)
end
def split_name_version(entry_name)
name_version = entry_name.split('-')
name = name_version[0..-2].join('-')
version = name_version[-1]
[name,version]
end
def to_chef_fs_path(path)
_to_chef_fs_path(path).join('/')
end
def chef_fs_filename(path)
_to_chef_fs_path(path)[-1]
end
def _to_chef_fs_path(path)
if path[0] == 'data'
path = path.dup
path[0] = 'data_bags'
if path.length >= 3
path[2] = "#{path[2]}.json"
end
elsif path[0] == 'policies'
path = path.dup
if path.length >= 3
path[2] = "#{path[2]}.json"
end
elsif path[0] == 'cookbooks'
if path.length == 2
raise ChefZero::DataStore::DataNotFoundError.new(path)
elsif chef_fs.versioned_cookbooks
if path.length >= 3
# cookbooks/name/version -> cookbooks/name-version
path = [ path[0], "#{path[1]}-#{path[2]}" ] + path[3..-1]
end
else
if path.length >= 3
# cookbooks/name/version/... -> /cookbooks/name/... iff metadata says so
version = get_single_cookbook_version(path)
if path[2] == version
path = path[0..1] + path[3..-1]
else
raise ChefZero::DataStore::DataNotFoundError.new(path)
end
end
end
elsif path.length == 2
path = path.dup
path[1] = "#{path[1]}.json"
end
path
end
def to_zero_path(entry)
path = entry.path.split('/')[1..-1]
if path[0] == 'data_bags'
path = path.dup
path[0] = 'data'
if path.length >= 3
path[2] = path[2][0..-6]
end
elsif path[0] == 'cookbooks'
if chef_fs.versioned_cookbooks
# cookbooks/name-version/... -> cookbooks/name/version/...
if path.length >= 2
name, version = split_name_version(path[1])
path = [ path[0], name, version ] + path[2..-1]
end
else
if path.length >= 2
# cookbooks/name/... -> cookbooks/name/version/...
version = get_single_cookbook_version(path)
path = path[0..1] + [version] + path[2..-1]
end
end
elsif path.length == 2 && path[0] != 'cookbooks'
path = path.dup
path[1] = path[1][0..-6]
end
path
end
def zero_filename(entry)
to_zero_path(entry)[-1]
end
def path_always_exists?(path)
return path.length == 1 && %w(clients cookbooks data environments nodes roles users).include?(path[0])
end
def with_entry(path)
begin
yield Chef::ChefFS::FileSystem.resolve_path(chef_fs, to_chef_fs_path(path))
rescue Chef::ChefFS::FileSystem::NotFoundError => e
raise ChefZero::DataStore::DataNotFoundError.new(to_zero_path(e.entry), e)
end
end
def with_dir(path)
# Do not automatically create data bags
create = !(path[0] == 'data' && path.size >= 2)
begin
yield get_dir(_to_chef_fs_path(path), create)
rescue Chef::ChefFS::FileSystem::NotFoundError => e
err = ChefZero::DataStore::DataNotFoundError.new(to_zero_path(e.entry), e)
err.set_backtrace(e.backtrace)
raise err
end
end
def get_dir(path, create=false)
result = Chef::ChefFS::FileSystem.resolve_path(chef_fs, path.join('/'))
if result.exists?
result
elsif create
get_dir(path[0..-2], create).create_child(result.name, nil)
else
raise ChefZero::DataStore::DataNotFoundError.new(path)
end
end
def get_single_cookbook_version(path)
dir = Chef::ChefFS::FileSystem.resolve_path(chef_fs, path[0..1].join('/'))
metadata = ChefZero::CookbookData.metadata_from(dir, path[1], nil, [])
metadata[:version] || '0.0.0'
end
end
end
end
|