Class: Chef::CookbookSynchronizer

Inherits:
Object
  • Object
show all
Defined in:
lib/chef/cookbook/synchronizer.rb

Overview

Synchronizes the locally cached copies of cookbooks with the files on the server.

Defined Under Namespace

Classes: CookbookFile

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(cookbooks_by_name, events) ⇒ CookbookSynchronizer

Returns a new instance of CookbookSynchronizer.



69
70
71
72
73
74
75
76
 
# File 'lib/chef/cookbook/synchronizer.rb', line 69

def initialize(cookbooks_by_name, events)
  @cookbooks_by_name, @events = cookbooks_by_name, events

  @cookbook_full_file_paths = {}
  @remove_obsoleted_files = true

  @lazy_files = {}
end

Instance Attribute Details

#remove_obsoleted_files ⇒ Object

Returns the value of attribute remove_obsoleted_files.



67
68
69
 
# File 'lib/chef/cookbook/synchronizer.rb', line 67

def remove_obsoleted_files
  @remove_obsoleted_files
end

Instance Method Details

#cache ⇒ Object 



78
79
80
 
# File 'lib/chef/cookbook/synchronizer.rb', line 78

def cache
  Chef::FileCache
end

#cached_copy_up_to_date?(local_path, expected_checksum) ⇒ Boolean

Returns:

  • (Boolean) 


282
283
284
285
286
287
288
289
290
 
# File 'lib/chef/cookbook/synchronizer.rb', line 282

def cached_copy_up_to_date?(local_path, expected_checksum)
  return true if Chef::Config[:skip_cookbook_sync]
  if cache.has_key?(local_path)
    current_checksum = CookbookVersion.checksum_cookbook_file(cache.load(local_path, false))
    expected_checksum == current_checksum
  else
    false
  end
end

#clear_obsoleted_cookbooks ⇒ Object

Iterates over cached cookbooks’ files, removing files belonging to cookbooks that don’t appear in cookbook_hash



224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/chef/cookbook/synchronizer.rb', line 224

def clear_obsoleted_cookbooks
  @events.cookbook_clean_start

  if remove_obsoleted_files
    remove_old_cookbooks
  else
    Chef::Log.info("Skipping removal of obsoleted cookbooks from the cache")
    CookbookCacheCleaner.instance.skip_removal = true
  end

  remove_deleted_files

  @events.cookbook_clean_complete
end

#cookbook_count ⇒ Object 



90
91
92
 
# File 'lib/chef/cookbook/synchronizer.rb', line 90

def cookbook_count
  @cookbooks_by_name.size
end

#cookbook_names ⇒ Object 



82
83
84
 
# File 'lib/chef/cookbook/synchronizer.rb', line 82

def cookbook_names
  @cookbooks_by_name.keys
end

#cookbook_segment(cookbook_name, segment) ⇒ Object 



98
99
100
 
# File 'lib/chef/cookbook/synchronizer.rb', line 98

def cookbook_segment(cookbook_name, segment)
  @cookbooks_by_name[cookbook_name].files_for(segment)
end

#cookbooks ⇒ Object 



86
87
88
 
# File 'lib/chef/cookbook/synchronizer.rb', line 86

def cookbooks
  @cookbooks_by_name.values
end

#download_file(url, destination) ⇒ Object

Unconditionally download the file from the given URL. File will be downloaded to the path destination which is relative to the Chef file cache root.



295
296
297
298
299
300
 
# File 'lib/chef/cookbook/synchronizer.rb', line 295

def download_file(url, destination)
  raw_file = server_api.streaming_request(url)

  Chef::Log.info("Storing updated #{destination} in the cache.")
  cache.move_to(raw_file.path, destination)
end

#ensure_cookbook_paths ⇒ Object 



249
250
251
252
253
254
 
# File 'lib/chef/cookbook/synchronizer.rb', line 249

def ensure_cookbook_paths
  cookbooks.each do |cookbook|
    cb_dir = File.join(Chef::Config[:file_cache_path], "cookbooks", cookbook.name)
    cookbook.root_paths = Array(cb_dir)
  end
end

#files ⇒ Object 



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
 
# File 'lib/chef/cookbook/synchronizer.rb', line 102

def files
  lazy = unless Chef::Config[:no_lazy_load]
           %w{ files templates }
         else
           []
         end

  @files ||= cookbooks.inject([]) do |memo, cookbook|
    cookbook.each_file do |manifest_record|
      part = manifest_record[:name].split("/")[0]
      if lazy.include?(part)
        manifest_record[:lazy] = true
        @lazy_files[cookbook] ||= []
        @lazy_files[cookbook] << manifest_record
      else
        memo << CookbookFile.new(cookbook, manifest_record)
      end
    end
    memo
  end
end

#files_by_cookbook ⇒ Object 



124
125
126
 
# File 'lib/chef/cookbook/synchronizer.rb', line 124

def files_by_cookbook
  files.group_by { |file| file.cookbook }
end

#files_remaining_by_cookbook ⇒ Object 



128
129
130
131
132
133
134
135
 
# File 'lib/chef/cookbook/synchronizer.rb', line 128

def files_remaining_by_cookbook
  @files_remaining_by_cookbook ||= begin
    files_by_cookbook.inject({}) do |memo, (cookbook, files)|
      memo[cookbook] = files.size
      memo
    end
  end
end

#have_cookbook?(cookbook_name) ⇒ Boolean

Returns:

  • (Boolean) 


94
95
96
 
# File 'lib/chef/cookbook/synchronizer.rb', line 94

def have_cookbook?(cookbook_name)
  @cookbooks_by_name.key?(cookbook_name)
end

#mark_cached_file_valid(cache_filename) ⇒ Object

Marks the given file as valid (non-stale).



303
304
305
 
# File 'lib/chef/cookbook/synchronizer.rb', line 303

def mark_cached_file_valid(cache_filename)
  CookbookCacheCleaner.instance.mark_file_as_valid(cache_filename)
end

#mark_file_synced(file) ⇒ Object 



137
138
139
140
141
142
143
 
# File 'lib/chef/cookbook/synchronizer.rb', line 137

def mark_file_synced(file)
  files_remaining_by_cookbook[file.cookbook] -= 1

  if files_remaining_by_cookbook[file.cookbook] == 0
    @events.synchronized_cookbook(file.cookbook.name, file.cookbook)
  end
end

#remove_deleted_files ⇒ Object

remove deleted files in cookbooks that are being used on the node



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
 
# File 'lib/chef/cookbook/synchronizer.rb', line 206

def remove_deleted_files
  cache.find(File.join(%w{cookbooks ** {*,.*}})).each do |cache_file|
    md = cache_file.match(/^cookbooks\/([^\/]+)\/([^\/]+)\/(.*)/)
    next unless md
    ( cookbook_name, segment, file ) = md[1..3]
    if have_cookbook?(cookbook_name)
      manifest_segment = cookbook_segment(cookbook_name, segment)
      if manifest_segment.select { |manifest_record| manifest_record["path"] == "#{segment}/#{file}" }.empty?
        Chef::Log.info("Removing #{cache_file} from the cache; its is no longer in the cookbook manifest.")
        cache.delete(cache_file)
        @events.removed_cookbook_file(cache_file)
      end
    end
  end
end

#remove_old_cookbooks ⇒ Object

remove cookbooks that are not referenced in the expanded run_list at all (if we have an override run_list we may not want to do this)



194
195
196
197
198
199
200
201
202
203
 
# File 'lib/chef/cookbook/synchronizer.rb', line 194

def remove_old_cookbooks
  cache.find(File.join(%w{cookbooks ** {*,.*}})).each do |cache_file|
    cache_file =~ /^cookbooks\/([^\/]+)\//
    unless have_cookbook?($1)
      Chef::Log.info("Removing #{cache_file} from the cache; its cookbook is no longer needed on this client.")
      cache.delete(cache_file)
      @events.removed_cookbook_file(cache_file)
    end
  end
end

#save_full_file_path(file, full_path) ⇒ Object

Saves the full_path to the file of the cookbook to be updated in the manifest later



187
188
189
190
 
# File 'lib/chef/cookbook/synchronizer.rb', line 187

def save_full_file_path(file, full_path)
  @cookbook_full_file_paths[file.cookbook] ||= []
  @cookbook_full_file_paths[file.cookbook] << full_path
end

#server_api ⇒ Object 



307
308
309
 
# File 'lib/chef/cookbook/synchronizer.rb', line 307

def server_api
  Thread.current[:server_api] ||= Chef::ServerAPI.new(Chef::Config[:chef_server_url], keepalives: true)
end

#sync_cookbooks ⇒ Object

Synchronizes all the cookbooks from the chef-server. )

Returns

true

Always returns true



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
 
# File 'lib/chef/cookbook/synchronizer.rb', line 149

def sync_cookbooks
  Chef::Log.info("Loading cookbooks [#{cookbooks.map { |ckbk| ckbk.name + '@' + ckbk.version }.join(', ')}]")
  Chef::Log.trace("Cookbooks detail: #{cookbooks.inspect}")

  clear_obsoleted_cookbooks

  queue = Chef::Util::ThreadedJobQueue.new

  Chef::Log.warn("skipping cookbook synchronization! DO NOT LEAVE THIS ENABLED IN PRODUCTION!!!") if Chef::Config[:skip_cookbook_sync]
  files.each do |file|
    queue << lambda do |lock|
      full_file_path = sync_file(file)

      lock.synchronize do
        # Save the full_path of the downloaded file to be restored in the manifest later
        save_full_file_path(file, full_file_path)
        mark_file_synced(file)
      end
    end
  end

  @events.cookbook_sync_start(cookbook_count)
  queue.process(Chef::Config[:cookbook_sync_threads])
  # Ensure that cookbooks know where they're rooted at, for manifest purposes.
  ensure_cookbook_paths
  # Update the full file paths in the manifest
  update_cookbook_filenames

rescue Exception => e
  @events.cookbook_sync_failed(cookbooks, e)
  raise
else
  @events.cookbook_sync_complete
  true
end

#sync_file(file) ⇒ Object

Sync an individual file if needed. If there is an up to date copy locally, nothing is done. Updates file‘s manifest with the full path to the cached file.

Arguments

file<CookbookFile>

Returns

Full path to the cached file as a String



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/chef/cookbook/synchronizer.rb', line 264

def sync_file(file)
  cache_filename = File.join("cookbooks", file.cookbook.name, file.manifest_record["path"])
  mark_cached_file_valid(cache_filename)

  # If the checksums are different between on-disk (current) and on-server
  # (remote, per manifest), do the update. This will also execute if there
  # is no current checksum.
  if !cached_copy_up_to_date?(cache_filename, file.manifest_record["checksum"])
    download_file(file.manifest_record["url"], cache_filename)
    @events.updated_cookbook_file(file.cookbook.name, cache_filename)
  else
    Chef::Log.trace("Not storing #{cache_filename}, as the cache is up to date.")
  end

  # Load the file in the cache and return the full file path to the loaded file
  cache.load(cache_filename, false)
end

#update_cookbook_filenames ⇒ Object 



239
240
241
242
243
244
245
246
247
 
# File 'lib/chef/cookbook/synchronizer.rb', line 239

def update_cookbook_filenames
  @cookbook_full_file_paths.each do |cookbook, full_paths|
    cookbook.all_files = full_paths
  end

  @lazy_files.each do |cookbook, lazy_files|
    cookbook.cookbook_manifest.add_files_to_manifest(lazy_files)
  end
end