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, #tidy

Instance Method Details

#action_needed(msg) ⇒ Object 



245
246
247
248
249
 
# File 'lib/chef/knife/tidy_backup_clean.rb', line 245

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

#action_needed_file_path ⇒ Object 



241
242
243
 
# File 'lib/chef/knife/tidy_backup_clean.rb', line 241

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

#add_cookbook_name_to_metadata(cookbook_name, rb_path) ⇒ Object 



87
88
89
90
91
92
93
 
# File 'lib/chef/knife/tidy_backup_clean.rb', line 87

def add_cookbook_name_to_metadata(cookbook_name, rb_path)
  puts "REPAIRING: Correcting `name` in #{rb_path}"
  content = IO.readlines(rb_path)
  new_content = content.select { |line| line !~ /^name.*['"]\S+['"]/ }
  name_field = "name '#{cookbook_name}'\n"
  IO.write rb_path, name_field + new_content.join('')
end

#broken_cookooks_add(org, cookbook) ⇒ Object 



134
135
136
137
138
139
140
 
# File 'lib/chef/knife/tidy_backup_clean.rb', line 134

def broken_cookooks_add(org, cookbook)
  broken_path = ::File.join(tidy.org_path(org), 'cookbooks.broken')
  FileUtils.mkdir(broken_path) unless ::File.directory?(broken_path)
  Dir[::File.join(tidy.cookbooks_path(org), "#{cookbook}*")].each do |cb|
    FileUtils.mv(cb, broken_path, :verbose => true, :force => true)
  end
end

#create_minimal_metadata(cookbook_path) ⇒ Object 



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

def create_minimal_metadata(cookbook_path)
  name = tidy.cookbook_name_from_path(cookbook_path)
  components = cookbook_path.split(File::SEPARATOR)
  name_version = components[components.index('cookbooks')+1]
  version = name_version.match(/\d+\.\d+\.\d+/).to_s
  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')
  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_cookbook_names(org) ⇒ Object 



95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/chef/knife/tidy_backup_clean.rb', line 95

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 = FFI_Yajl::Parser.parse(::File.read(json_path), symbolize_names: false)
        if metadata['name'] != cookbook_name
          metadata['name'] = cookbook_name
          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_self_dependencies(org) ⇒ Object 



148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/chef/knife/tidy_backup_clean.rb', line 148

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)
      puts "INFO: No metadata.rb in #{cookbook_path} - skipping"
      next
    end
    Chef::TidySubstitutions.new.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 



224
225
226
227
228
229
230
231
232
233
 
# File 'lib/chef/knife/tidy_backup_clean.rb', line 224

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 



235
236
237
238
239
 
# File 'lib/chef/knife/tidy_backup_clean.rb', line 235

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

#generate_metadata_from_file(cookbook, path) ⇒ Object 



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

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)
    puts "INFO: No metadata.rb in #{path} - skipping"
    return
  end
  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 



142
143
144
145
146
 
# File 'lib/chef/knife/tidy_backup_clean.rb', line 142

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)
  end
end

#load_cookbooks(org) ⇒ Object 



119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/chef/knife/tidy_backup_clean.rb', line 119

def load_cookbooks(org)
  cl = Chef::CookbookLoader.new(tidy.cookbooks_path(org))
  for_each_cookbook_basename(org) do |cookbook|
    puts "INFO: Loading #{cookbook}"
    ret = cl.load_cookbook(cookbook)
    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_cookooks_add(org, cookbook)
    end
  end
rescue LoadError => e
  ui.error e
  exit 1
end

#orgs ⇒ Object 



216
217
218
219
220
221
222
 
# File 'lib/chef/knife/tidy_backup_clean.rb', line 216

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

#run ⇒ Object 



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

def run

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

  validate_user_emails

  if config[:gsub_file]
    unless ::File.exist?(config[:gsub_file])
      Chef::TidySubstitutions.new(substitutions_file).boiler_plate
      exit
    else
      Chef::TidySubstitutions.new(substitutions_file, tidy).run_substitutions
    end
  end

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

  completion_message
end

#substitutions_file ⇒ Object 



210
211
212
213
214
 
# File 'lib/chef/knife/tidy_backup_clean.rb', line 210

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

#validate_user_emails ⇒ Object 



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

def validate_user_emails
  emails_seen = []
  tidy.global_user_names.each do |user|
    email = ''
    puts "INFO: Validating #{user}"
    the_user = FFI_Yajl::Parser.parse(::File.read(::File.join(tidy.users_path, "#{user}.json")), symbolize_names: false)
    if the_user['email'].match(/\A[^@\s]+@[^@\s]+\z/)
      if emails_seen.include?(the_user['email'])
        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
      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