Class: Chef::Knife::TidyBackupClean

Inherits:
Chef::Knife show all
Includes:
TidyBase
Defined in:
lib/chef/knife/tidy_backup_clean.rb

Instance Method Summary collapse

Methods included from TidyBase

#completion_message, included, #rest, #server, #server_warnings_file_path, #tidy

Instance Method Details

#action_needed(msg) ⇒ Object 



333
334
335
336
337
 
# File 'lib/chef/knife/tidy_backup_clean.rb', line 333

def action_needed(msg)
  ::File.open(action_needed_file_path, "a") do |f|
    f.write(msg + "\n")
  end
end

#action_needed_file_path ⇒ Object 



329
330
331
 
# File 'lib/chef/knife/tidy_backup_clean.rb', line 329

def action_needed_file_path
  ::File.expand_path("knife-tidy-actions-needed.txt")
end

#add_cookbook_name_to_metadata(cookbook_name, rb_path) ⇒ Object 



131
132
133
134
135
136
137
 
# File 'lib/chef/knife/tidy_backup_clean.rb', line 131

def add_cookbook_name_to_metadata(cookbook_name, rb_path)
  ui.stdout.puts "REPAIRING: Correcting `name` in #{rb_path}"
  content = IO.readlines(rb_path)
  new_content = content.reject { |line| line =~ /^name\s+/ }
  name_field = "name '#{cookbook_name}'\n"
  IO.write rb_path, name_field + new_content.join("")
end

#broken_cookbooks_add(org, cookbook_path) ⇒ Object 



178
179
180
181
182
 
# File 'lib/chef/knife/tidy_backup_clean.rb', line 178

def broken_cookbooks_add(org, cookbook_path)
  broken_path = ::File.join(tidy.org_path(org), "cookbooks.broken")
  FileUtils.mkdir(broken_path) unless ::File.directory?(broken_path)
  FileUtils.mv(cookbook_path, broken_path, verbose: true, force: true)
end

#create_minimal_metadata(cookbook_path) ⇒ Object 



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/chef/knife/tidy_backup_clean.rb', line 279

def create_minimal_metadata(cookbook_path)
  name = tidy.cookbook_name_from_path(cookbook_path)
  version = tidy.cookbook_version_from_path(cookbook_path)
  metadata = {}
  metadata["name"] = name
  metadata["version"] = version
  metadata["description"] = "the description"
  metadata["long_description"] = "the long description"
  metadata["maintainer"] = "the maintainer"
  metadata["maintainer_email"] = "the maintainer email"
  rb_file = ::File.join(cookbook_path, "metadata.rb")
  ui.stdout.puts "REPAIRING: no metadata files exist for #{cookbook_path}, creating #{rb_file}"
  ::File.open(rb_file, "w") do |f|
    metadata.each_pair do |key, value|
      f.write("#{key} '#{value}'\n")
    end
  end
end

#fix_chef_sugar_metadata ⇒ Object 



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/chef/knife/tidy_backup_clean.rb', line 191

def fix_chef_sugar_metadata
  Dir[::File.join(tidy.backup_path, "organizations/*/cookbooks/chef-sugar*/metadata.rb")].each do |file|
    ui.stdout.puts "INFO: Searching for known chef-sugar problems when uploading."
    s = Chef::TidySubstitutions.new(nil, tidy)
    version = tidy.cookbook_version_from_path(::File.dirname(file))
    patterns = [
      {
        search: "^require .*/lib/chef/sugar/version",
        replace: "# require          File.expand_path('../lib/chef/sugar/version', *__FILE__)",
      },
      {
        search: "^version *Chef::Sugar::VERSION",
        replace: "version '#{version}'",
      },
    ]
    patterns.each do |p|
      s.sub_in_file(file, Regexp.new(p[:search]), p[:replace])
    end
  end
end

#fix_cookbook_names(org) ⇒ Object 



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/chef/knife/tidy_backup_clean.rb', line 139

def fix_cookbook_names(org)
  for_each_cookbook_path(org) do |cookbook_path|
    rb_path = ::File.join(cookbook_path, "metadata.rb")
    json_path = ::File.join(cookbook_path, "metadata.json")
    # next unless ::File.exist?(rb_path)
    cookbook_name = tidy.cookbook_name_from_path(cookbook_path)
    if ::File.exist?(rb_path)
      lines = ::File.readlines(rb_path).select { |line| line =~ /^name.*['"]#{cookbook_name}['"]/ }
      add_cookbook_name_to_metadata(cookbook_name, rb_path) if lines.empty?
    else
      if ::File.exist?(json_path)
        metadata = tidy.json_file_to_hash(json_path, symbolize_names: false)
        if metadata["name"] != cookbook_name
          metadata["name"] = cookbook_name
          ui.stdout.puts "REPAIRING: Correcting `name` in #{json_path}`"
          ::File.open(json_path, "w") do |f|
            f.write(Chef::JSONCompat.to_json_pretty(metadata))
          end
        end
      end
    end
  end
end

#fix_metadata_fields(cookbook_path) ⇒ Object 



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/chef/knife/tidy_backup_clean.rb', line 228

def fix_metadata_fields(cookbook_path)
  json_path = ::File.join(cookbook_path, "metadata.json")
  metadata = tidy.json_file_to_hash(json_path, symbolize_names: false)
  md = metadata.dup
  metadata.each_pair do |key, value|
    if value.nil?
      ui.stdout.puts "REPAIRING: Fixing null value for key #{key} in #{json_path}"
      md[key] = "default value"
    end
  end
  if metadata.key?("platforms")
    metadata["platforms"].each_pair do |key, value|
      # platform key cannot contain comma delimited values
      md["platforms"].delete(key) if key =~ /,/
      if value.is_a?(Array) && value.empty?
        ui.stdout.puts "REPAIRING: Fixing empty platform key for for key #{key} in #{json_path}"
        md["platforms"][key] = ">= 0.0.0"
      end
    end
  end
  ::File.open(json_path, "w") do |f|
    f.write(Chef::JSONCompat.to_json_pretty(md))
  end
end

#fix_org_object(org) ⇒ Object

In Chef Server 12 an org object should have exactly 3 keys: name, full_name and guid The existence of anything else will cause a restore to fail EC11 backups will contain org objects with 6 extra fields including org_type, billing_plan, assigned_at, etc



104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/chef/knife/tidy_backup_clean.rb', line 104

def fix_org_object(org)
  ui.stdout.puts "INFO: Validating org object for #{org}"
  org_object = load_org_object(org)

  unless org_object.keys.count == 3 # cheapo, maybe expect the exact names?
    ui.stdout.puts "REPAIRING: org object for #{org} contains extra/missing fields. Fixing that for you"
    # quick/dirty attempt at fixing any of the required fields in case they're nil
    good_name = org_object["name"] || org
    good_full_name = org_object["full_name"] || org
    good_guid = org_object["guid"] || SecureRandom.uuid.delete("-")
    fixed_org_object = { name: good_name, full_name: good_full_name, guid: good_guid }

    write_org_object(org, fixed_org_object)
  end
end

#fix_self_dependencies(org) ⇒ Object 



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/chef/knife/tidy_backup_clean.rb', line 212

def fix_self_dependencies(org)
  for_each_cookbook_path(org) do |cookbook_path|
    name = tidy.cookbook_name_from_path(cookbook_path)
    md_path = ::File.join(cookbook_path, "metadata.rb")
    unless ::File.exist?(md_path)
      ui.stdout.puts "INFO: No metadata.rb in #{cookbook_path} - skipping"
      next
    end
    Chef::TidySubstitutions.new(nil, tidy).sub_in_file(
      ::File.join(cookbook_path, "metadata.rb"),
      Regexp.new("^depends +['\"]#{name}['\"]"),
      "# depends '#{name}' # knife-tidy was here"
    )
  end
end

#for_each_cookbook_basename(org) ⇒ Object 



312
313
314
315
316
317
318
319
320
321
 
# File 'lib/chef/knife/tidy_backup_clean.rb', line 312

def for_each_cookbook_basename(org)
  cookbooks_seen = []
  Dir[::File.join(tidy.cookbooks_path(org), "**-**")].each do |cookbook|
    name = tidy.cookbook_name_from_path(cookbook)
    unless cookbooks_seen.include?(name)
      cookbooks_seen.push(name)
      yield name
    end
  end
end

#for_each_cookbook_path(org) ⇒ Object 



323
324
325
326
327
 
# File 'lib/chef/knife/tidy_backup_clean.rb', line 323

def for_each_cookbook_path(org)
  Dir[::File.join(tidy.cookbooks_path(org), "**")].each do |cookbook|
    yield cookbook
  end
end

#for_each_role(org) ⇒ Object 



345
346
347
348
349
 
# File 'lib/chef/knife/tidy_backup_clean.rb', line 345

def for_each_role(org)
  Dir[::File.join(tidy.roles_path(org), "*.json")].each do |role|
    yield role
  end
end

#generate_metadata_from_file(cookbook, path) ⇒ Object 



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
 
# File 'lib/chef/knife/tidy_backup_clean.rb', line 253

def generate_metadata_from_file(cookbook, path)
  md_path = ::File.join(path, "metadata.rb")
  json_path = ::File.join(path, "metadata.json")
  if !::File.exist?(md_path) && !::File.exist?(json_path)
    create_minimal_metadata(path)
  end
  unless ::File.exist?(md_path)
    ui.stdout.puts "INFO: No metadata.rb in #{path} - skipping"
    return
  end
  ui.stdout.puts "INFO: Generating new metadata.json for #{path}"
  md = Chef::Cookbook::Metadata.new
  md.name(cookbook)
  md.from_file(md_path)
  json_file = ::File.join(path, "metadata.json")
  ::File.open(json_file, "w") do |f|
    f.write(Chef::JSONCompat.to_json_pretty(md))
  end
rescue Exceptions::ObsoleteDependencySyntax, Exceptions::InvalidVersionConstraint => e
  ui.stderr.puts "ERROR: The cookbook '#{cookbook}' contains invalid or obsolete metadata syntax."
  ui.stderr.puts "in #{file}:"
  ui.stderr.puts
  ui.stderr.puts e.message
  exit 1
end

#generate_new_metadata(org) ⇒ Object 



184
185
186
187
188
189
 
# File 'lib/chef/knife/tidy_backup_clean.rb', line 184

def generate_new_metadata(org)
  for_each_cookbook_path(org) do |cookbook_path|
    generate_metadata_from_file(tidy.cookbook_name_from_path(cookbook_path), cookbook_path)
    fix_metadata_fields(cookbook_path)
  end
end

#load_cookbooks(org) ⇒ Object 



163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/chef/knife/tidy_backup_clean.rb', line 163

def load_cookbooks(org)
  for_each_cookbook_path(org) do |cookbook|
    cl = Chef::Cookbook::CookbookVersionLoader.new(cookbook)
    ui.stdout.puts "INFO: Loading #{cookbook}"
    ret = cl.load!
    if ret.nil?
      action_needed("ACTION NEEDED: Something's wrong with the #{cookbook} cookbook in org #{org} - cannot load it! Moving to cookbooks.broken folder.")
      broken_cookbooks_add(org, cookbook)
    end
  end
rescue LoadError, Exceptions::MetadataNotValid => e
  ui.error e
  exit 1
end

#load_org_object(org) ⇒ Object 



120
121
122
123
124
125
 
# File 'lib/chef/knife/tidy_backup_clean.rb', line 120

def load_org_object(org)
  JSON.parse(File.read(File.join(tidy.org_path(org), "org.json")))
rescue Errno::ENOENT, JSON::ParserError
  ui.stdout.puts "REPAIRING: org object for organization #{org} is missing or corrupt. Generating a new one"
  { name: org, full_name: org, guid: SecureRandom.uuid.delete("-") }
end

#orgs ⇒ Object 



304
305
306
307
308
309
310
 
# File 'lib/chef/knife/tidy_backup_clean.rb', line 304

def orgs
  @orgs ||= if config[:org_list]
              config[:org_list].split(",")
            else
              Dir[::File.join(tidy.backup_path, "organizations", "*")].map { |dir| ::File.basename(dir) }
            end
end

#repair_role_run_lists(role_path) ⇒ Object 



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
 
# File 'lib/chef/knife/tidy_backup_clean.rb', line 351

def repair_role_run_lists(role_path)
  the_role = tidy.json_file_to_hash(role_path, symbolize_names: false)
  new_role = the_role.clone
  rl = Chef::RunList.new
  new_role["run_list"] = []
  the_role["run_list"].each do |item|
    begin
      rl << item
      new_role["run_list"].push(item)
    rescue ArgumentError
      ui.stdout.puts "REPAIRING: Invalid Recipe Item: #{item} in run_list from #{role_path}"
    end
  end
  if the_role.key?("env_run_lists")
    the_role["env_run_lists"].each_pair do |key, value|
      new_role["env_run_lists"][key] = []
      value.each do |item|
        begin
          rl << item
          new_role["env_run_lists"][key].push(item)
        rescue ArgumentError
          ui.stdout.puts "REPAIRING: Invalid Recipe Item: #{item} in env_run_lists #{key} from #{role_path}"
        end
      end
    end
  end
  write_role(role_path, new_role)
  # rubocop:enable Metrics/MethodLength
end

#run ⇒ Object 



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
 
# File 'lib/chef/knife/tidy_backup_clean.rb', line 34

def run
  FileUtils.rm_f(action_needed_file_path)

  if config[:gen_gsub]
    Chef::TidySubstitutions.new(nil, tidy).boiler_plate
    exit
  end

  unless config[:backup_path] && ::File.directory?(config[:backup_path])
    ui.error "Must specify valid --backup-path"
    exit 1
  end

  fix_chef_sugar_metadata

  Chef::TidySubstitutions.new(substitutions_file, tidy).run_substitutions if config[:gsub_file]

  validate_user_emails

  orgs.each do |org|
    fix_org_object(org)
    validate_invitations(org)
    validate_clients_group(org)
    validate_roles(org)
    org_acls = Chef::TidyOrgAcls.new(tidy, org)
    org_acls.validate_acls
    org_acls.validate_user_acls
    org_acls.validate_client_acls
    fix_self_dependencies(org)
    fix_cookbook_names(org)
    generate_new_metadata(org)
    load_cookbooks(org)
  end

  completion_message

  ui.stdout.puts "\nWARNING: ** Unrepairable Items **\nPlease see #{action_needed_file_path}\n" if ::File.exist?(action_needed_file_path)
end

#substitutions_file ⇒ Object 



298
299
300
301
302
 
# File 'lib/chef/knife/tidy_backup_clean.rb', line 298

def substitutions_file
  sub_file_path = ::File.expand_path(config[:gsub_file])
  ui.error "Substitutions file #{sub_file_path} does not exist!" unless ::File.exist?(sub_file_path)
  @substitutions_file ||= sub_file_path
end

#validate_clients_group(org) ⇒ Object 



392
393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/chef/knife/tidy_backup_clean.rb', line 392

def validate_clients_group(org)
  ui.stdout.puts "INFO: validating all clients for org #{org} exist in clients group"
  clients_group_path = ::File.join(tidy.groups_path(org), "clients.json")
  existing_group_data = tidy.json_file_to_hash(clients_group_path, symbolize_names: false)
  existing_group_data["clients"] = [] unless existing_group_data.key?("clients")
  if existing_group_data["clients"].length != tidy.client_names(org).length
    ui.stdout.puts "REPAIRING: Adding #{(existing_group_data["clients"].length - tidy.client_names(org).length).abs} missing clients into #{org}'s client group file #{clients_group_path}"
    existing_group_data["clients"] = (existing_group_data["clients"] + tidy.client_names(org)).uniq
  end
  existing_group_data["clients"] = existing_group_data["clients"].sort
  ::File.open(clients_group_path, "w") do |f|
    f.write(Chef::JSONCompat.to_json_pretty(existing_group_data))
  end
end

#validate_invitations(org) ⇒ Object 



407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/chef/knife/tidy_backup_clean.rb', line 407

def validate_invitations(org)
  invite_file = tidy.invitations_path(org)
  ui.stdout.puts "INFO: validating org #{org} invites in #{invite_file}"
  invitations = tidy.json_file_to_hash(invite_file, symbolize_names: false)
  invitations_new = []
  invitations.each do |invite|
    if invite["username"].nil?
      ui.stdout.puts "REPAIRING: Dropping corrupt invitations for #{org} in file #{invite_file}"
    else
      invite_hash = {}
      invite_hash["id"] = invite["id"]
      invite_hash["username"] = invite["username"]
      invitations_new.push(invite_hash)
    end
  end
  ::File.open(invite_file, "w") do |f|
    f.write(Chef::JSONCompat.to_json_pretty(invitations_new))
  end
end

#validate_roles(org) ⇒ Object 



381
382
383
384
385
386
387
388
389
390
 
# File 'lib/chef/knife/tidy_backup_clean.rb', line 381

def validate_roles(org)
  for_each_role(org) do |role_path|
    ui.stdout.puts "INFO: Validating Role at #{role_path}"
    begin
      Chef::Role.from_hash(tidy.json_file_to_hash(role_path, symbolize_names: false))
    rescue ArgumentError
      repair_role_run_lists(role_path)
    end
  end
end

#validate_user_emails ⇒ Object 



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
 
# File 'lib/chef/knife/tidy_backup_clean.rb', line 73

def validate_user_emails
  emails_seen = []
  tidy.global_user_names.each do |user|
    email = ""
    ui.stdout.puts "INFO: Validating #{user}"
    the_user = tidy.json_file_to_hash(File.join(tidy.users_path, "#{user}.json"), symbolize_names: false)
    if the_user.key?("email") && the_user["email"].match(/\A[^@\s]+@[^@\s]+\z/)
      if emails_seen.include?(the_user["email"])
        ui.stdout.puts "REPAIRING: Already saw #{user}'s email, creating a unique one."
        email = tidy.unique_email
        new_user = the_user.dup
        new_user["email"] = email
        tidy.save_user(new_user)
        emails_seen.push(email)
      else
        emails_seen.push(the_user["email"])
      end
    else
      ui.stdout.puts "REPAIRING: User #{user} does not have a valid email, creating a unique one."
      email = tidy.unique_email
      new_user = the_user.dup
      new_user["email"] = email
      tidy.save_user(new_user)
      emails_seen.push(email)
    end
  end
end

#write_org_object(org, org_object) ⇒ Object 



127
128
129
 
# File 'lib/chef/knife/tidy_backup_clean.rb', line 127

def write_org_object(org, org_object)
  File.write(File.join(tidy.org_path(org), "org.json"), JSON.pretty_generate(org_object))
end

#write_role(path, role) ⇒ Object 



339
340
341
342
343
 
# File 'lib/chef/knife/tidy_backup_clean.rb', line 339

def write_role(path, role)
  ::File.open(path, "w") do |f|
    f.write(Chef::JSONCompat.to_json_pretty(role))
  end
end