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
|
#
# Author:: Adam Jacob (<adam@chef.io>)
# Author:: Christopher Walters (<cw@chef.io>)
# Author:: Daniel DeLeo (<dan@kallistec.com>)
# Copyright:: Copyright 2008-2018, Chef Software Inc.
# Copyright:: Copyright 2009-2016, Daniel DeLeo
# 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"
require "chef/exceptions"
require "chef/cookbook/cookbook_version_loader"
require "chef/cookbook_version"
require "chef/cookbook/chefignore"
require "chef/cookbook/metadata"
#
# CookbookLoader class loads the cookbooks lazily as read
#
class Chef
class CookbookLoader
attr_reader :cookbooks_by_name
attr_reader :merged_cookbooks
attr_reader :cookbook_paths
attr_reader :metadata
include Enumerable
def initialize(*repo_paths)
repo_paths = repo_paths.flatten
raise ArgumentError, "You must specify at least one cookbook repo path" if repo_paths.empty?
@cookbooks_by_name = Mash.new
@loaded_cookbooks = {}
@metadata = Mash.new
@cookbooks_paths = Hash.new { |h, k| h[k] = [] } # for deprecation warnings
@chefignores = {}
@repo_paths = repo_paths.map do |repo_path|
File.expand_path(repo_path)
end
@preloaded_cookbooks = false
@loaders_by_name = {}
# Used to track which cookbooks appear in multiple places in the cookbook repos
# and are merged in to a single cookbook by file shadowing. This behavior is
# deprecated, so users of this class may issue warnings to the user by checking
# this variable
@merged_cookbooks = []
end
def merged_cookbook_paths # for deprecation warnings
merged_cookbook_paths = {}
@merged_cookbooks.each { |c| merged_cookbook_paths[c] = @cookbooks_paths[c] }
merged_cookbook_paths
end
def warn_about_cookbook_shadowing
unless merged_cookbooks.empty?
Chef::Log.deprecation "The cookbook(s): #{merged_cookbooks.join(', ')} exist in multiple places in your cookbook_path. " +
"A composite version has been compiled. This has been deprecated since 0.10.4, in Chef 13 this behavior will be REMOVED."
end
end
# Will be removed when cookbook shadowing is removed, do NOT create new consumers of this API.
#
# @api private
def load_cookbooks_without_shadow_warning
preload_cookbooks
@loaders_by_name.each_key do |cookbook_name|
load_cookbook(cookbook_name)
end
@cookbooks_by_name
end
def load_cookbooks
ret = load_cookbooks_without_shadow_warning
warn_about_cookbook_shadowing
ret
end
def load_cookbook(cookbook_name)
preload_cookbooks
return @cookbooks_by_name[cookbook_name] if @cookbooks_by_name.key?(cookbook_name)
return nil unless @loaders_by_name.key?(cookbook_name.to_s)
cookbook_loaders_for(cookbook_name).each do |loader|
loader.load
next if loader.empty?
@cookbooks_paths[cookbook_name] << loader.cookbook_path # for deprecation warnings
if @loaded_cookbooks.key?(cookbook_name)
@merged_cookbooks << cookbook_name # for deprecation warnings
@loaded_cookbooks[cookbook_name].merge!(loader)
else
@loaded_cookbooks[cookbook_name] = loader
end
end
if @loaded_cookbooks.key?(cookbook_name)
cookbook_version = @loaded_cookbooks[cookbook_name].cookbook_version
@cookbooks_by_name[cookbook_name] = cookbook_version
@metadata[cookbook_name] = cookbook_version.metadata
end
@cookbooks_by_name[cookbook_name]
end
def [](cookbook)
if @cookbooks_by_name.key?(cookbook.to_sym) || load_cookbook(cookbook.to_sym)
@cookbooks_by_name[cookbook.to_sym]
else
raise Exceptions::CookbookNotFoundInRepo, "Cannot find a cookbook named #{cookbook}; did you forget to add metadata to a cookbook? (https://docs.chef.io/config_rb_metadata.html)"
end
end
alias :fetch :[]
def has_key?(cookbook_name)
not self[cookbook_name.to_sym].nil?
end
alias :cookbook_exists? :has_key?
alias :key? :has_key?
def each
@cookbooks_by_name.keys.sort_by(&:to_s).each do |cname|
yield(cname, @cookbooks_by_name[cname])
end
end
def each_key(&block)
cookbook_names.each(&block)
end
def each_value(&block)
values.each(&block)
end
def cookbook_names
@cookbooks_by_name.keys.sort
end
def values
@cookbooks_by_name.values
end
alias :cookbooks :values
private
def preload_cookbooks
return false if @preloaded_cookbooks
all_directories_in_repo_paths.each do |cookbook_path|
preload_cookbook(cookbook_path)
end
@preloaded_cookbooks = true
true
end
def preload_cookbook(cookbook_path)
repo_path = File.dirname(cookbook_path)
@chefignores[repo_path] ||= Cookbook::Chefignore.new(repo_path)
loader = Cookbook::CookbookVersionLoader.new(cookbook_path, @chefignores[repo_path])
add_cookbook_loader(loader)
end
def all_directories_in_repo_paths
@all_directories_in_repo_paths ||=
all_files_in_repo_paths.select { |path| File.directory?(path) }
end
def all_files_in_repo_paths
@all_files_in_repo_paths ||=
begin
@repo_paths.inject([]) do |all_children, repo_path|
all_children + Dir[File.join(Chef::Util::PathHelper.escape_glob_dir(repo_path), "*")]
end
end
end
def add_cookbook_loader(loader)
cookbook_name = loader.cookbook_name
@loaders_by_name[cookbook_name.to_s] ||= []
@loaders_by_name[cookbook_name.to_s] << loader
loader
end
def cookbook_loaders_for(cookbook_name)
@loaders_by_name[cookbook_name.to_s]
end
end
end
|
