knife-tidy 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe2a778de3020252562b8788aca9ad4c2a84c50621b1659c867b7b5b5db89d5e
-  data.tar.gz: b305e31422e5cf415021bed9a0e3251550d6962b5ed0ba75a98c213741e2f077
+  metadata.gz: b559f18636e7cc22f399f44e5f3efd3e3c43d84c1fc5c34a1291ab6dcf8e1a6c
+  data.tar.gz: 067e18dcec7889510d0b95b443fa54d3f2e38577bdcffe71a01e1199ed956c03
 SHA512:
-  metadata.gz: e0edc9e58ccd32ba959e0cdc1f1200b937459f0daad9547f302f4878da2d889a626b0dcedd8b90e8515e0c425f298ad3daa2a0169ba62530865dd998a85a69a0
-  data.tar.gz: 980af3d17bb27eb7cf060e9e56c0f8419a9e3f557b78702ed3ef05106cf2dbf4323f025bbdf3cc76ae24bc50d71e98c51c45b9b99892ffd9c7adc7117ced2884
+  metadata.gz: d08512efe742bfe15cb2f52ed36e9f68d0e6aa26726cedd5649fb46917538e80bf8a9b1b264bb22d7e5c5706d2d7094c0d6ea320cbe39689605e30baa184be2e
+  data.tar.gz: 62b1d8f9465d6abe63e33996894f64f7db08eacf0cdff7801abb5751c0fcef3950458ed7ebbbc5f369b03e7e9855176a488ae737f7d4b50252011fe6525dfba6

data/lib/chef/knife/tidy_backup_clean.rb

@@ -1,35 +1,35 @@
-require 'chef/knife/tidy_base'
+require "chef/knife/tidy_base"
 
 class Chef
   class Knife
     class TidyBackupClean < Knife
       deps do
-        require 'chef/cookbook_loader'
-        require 'chef/cookbook/metadata'
-        require 'chef/role'
-        require 'chef/run_list'
-        require 'chef/tidy_substitutions'
-        require 'chef/tidy_acls'
-        require 'ffi_yajl'
-        require 'fileutils'
-        require 'securerandom'
+        require "chef/cookbook_loader"
+        require "chef/cookbook/metadata"
+        require "chef/role"
+        require "chef/run_list"
+        require "chef/tidy_substitutions"
+        require "chef/tidy_acls"
+        require "ffi_yajl"
+        require "fileutils"
+        require "securerandom"
       end
 
-      banner 'knife tidy backup clean (options)'
+      banner "knife tidy backup clean (options)"
 
       include Knife::TidyBase
 
       option :backup_path,
-        long: '--backup-path path/to/backup',
-        description: 'The path to the knife-ec-backup backup directory'
+        long: "--backup-path path/to/backup",
+        description: "The path to the knife-ec-backup backup directory"
 
       option :gsub_file,
-        long: '--gsub-file path/to/gsub/file',
-        description: 'The path to the file used for substitutions. If non-existant, a boiler plate one will be created.'
+        long: "--gsub-file path/to/gsub/file",
+        description: "The path to the file used for substitutions. If non-existant, a boiler plate one will be created."
 
       option :gen_gsub,
-        long: '--gen-gsub',
-        description: 'Generate a new boiler plate global substitutions file: \'substitutions.json\'.'
+        long: "--gen-gsub",
+        description: "Generate a new boiler plate global substitutions file: 'substitutions.json'."
 
       def run
         FileUtils.rm_f(action_needed_file_path)
@@ -40,7 +40,7 @@ class Chef
         end
 
         unless config[:backup_path] && ::File.directory?(config[:backup_path])
-          ui.error 'Must specify valid --backup-path'
+          ui.error "Must specify valid --backup-path"
           exit 1
         end
 
@@ -73,25 +73,25 @@ class Chef
       def validate_user_emails
         emails_seen = []
         tidy.global_user_names.each do |user|
-          email = ''
+          email = ""
           ui.stdout.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.key?('email') && the_user['email'].match(/\A[^@\s]+@[^@\s]+\z/)
-            if emails_seen.include?(the_user['email'])
+          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
+              new_user["email"] = email
               tidy.save_user(new_user)
               emails_seen.push(email)
             else
-              emails_seen.push(the_user['email'])
+              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
+            new_user["email"] = email
             tidy.save_user(new_user)
             emails_seen.push(email)
           end
@@ -108,9 +108,9 @@ class Chef
         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('-')
+          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)
@@ -118,14 +118,14 @@ class Chef
       end
 
       def load_org_object(org)
-        JSON.parse(File.read(File.join(tidy.org_path(org), 'org.json')))
+        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"
-        return { name: org, full_name: org, guid: SecureRandom.uuid.delete('-') }
+        { name: org, full_name: org, guid: SecureRandom.uuid.delete("-") }
       end
 
       def write_org_object(org, org_object)
-        File.write(File.join(tidy.org_path(org), 'org.json'), JSON.pretty_generate(org_object))
+        File.write(File.join(tidy.org_path(org), "org.json"), JSON.pretty_generate(org_object))
       end
 
       def add_cookbook_name_to_metadata(cookbook_name, rb_path)
@@ -133,13 +133,13 @@ class Chef
         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('')
+        IO.write rb_path, name_field + new_content.join("")
       end
 
       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')
+          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)
@@ -148,10 +148,10 @@ class Chef
           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
+              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|
+                ::File.open(json_path, "w") do |f|
                   f.write(Chef::JSONCompat.to_json_pretty(metadata))
                 end
               end
@@ -176,7 +176,7 @@ class Chef
       end
 
       def broken_cookooks_add(org, cookbook)
-        broken_path = ::File.join(tidy.org_path(org), 'cookbooks.broken')
+        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)
@@ -191,17 +191,17 @@ class Chef
       end
 
       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.'
+        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 = s.cookbook_version_from_path(file)
           patterns = [
             {
-              search: '^require .*/lib/chef/sugar/version',
+              search: "^require .*/lib/chef/sugar/version",
               replace: "# require          File.expand_path('../lib/chef/sugar/version', *__FILE__)",
             },
             {
-              search: '^version *Chef::Sugar::VERSION',
+              search: "^version *Chef::Sugar::VERSION",
               replace: "version '#{version}'",
             },
           ]
@@ -214,46 +214,46 @@ class Chef
       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')
+          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'),
+            ::File.join(cookbook_path, "metadata.rb"),
             Regexp.new("^depends +['\"]#{name}['\"]"),
             "# depends '#{name}' # knife-tidy was here")
         end
       end
 
       def fix_metadata_fields(cookbook_path)
-        json_path = ::File.join(cookbook_path, 'metadata.json')
+        json_path = ::File.join(cookbook_path, "metadata.json")
         metadata = FFI_Yajl::Parser.parse(::File.read(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'
+            md[key] = "default value"
           end
         end
-        if metadata.key?('platforms')
-          metadata['platforms'].each_pair do |key, value|
+        if metadata.key?("platforms")
+          metadata["platforms"].each_pair do |key, value|
             # platform key cannot contain comma delimited values
-            md['platforms'].delete(key) if key =~ /,/
+            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'
+              md["platforms"][key] = ">= 0.0.0"
             end
           end
         end
-        ::File.open(json_path, 'w') do |f|
+        ::File.open(json_path, "w") do |f|
           f.write(Chef::JSONCompat.to_json_pretty(md))
         end
       end
 
       def generate_metadata_from_file(cookbook, path)
-        md_path = ::File.join(path, 'metadata.rb')
-        json_path = ::File.join(path, 'metadata.json')
+        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
@@ -265,8 +265,8 @@ class Chef
         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|
+        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
@@ -280,18 +280,18 @@ class Chef
       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]
+        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')
+        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|
+        ::File.open(rb_file, "w") do |f|
           metadata.each_pair do |key, value|
             f.write("#{key} '#{value}'\n")
           end
@@ -306,15 +306,15 @@ class Chef
 
       def orgs
         @orgs ||= if config[:org_list]
-                    config[:org_list].split(',')
+                    config[:org_list].split(",")
                   else
-                    Dir[::File.join(tidy.backup_path, 'organizations', '*')].map { |dir| ::File.basename(dir) }
+                    Dir[::File.join(tidy.backup_path, "organizations", "*")].map { |dir| ::File.basename(dir) }
                   end
       end
 
       def for_each_cookbook_basename(org)
         cookbooks_seen = []
-        Dir[::File.join(tidy.cookbooks_path(org), '**-**')].each do |cookbook|
+        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)
@@ -324,29 +324,29 @@ class Chef
       end
 
       def for_each_cookbook_path(org)
-        Dir[::File.join(tidy.cookbooks_path(org), '**')].each do |cookbook|
+        Dir[::File.join(tidy.cookbooks_path(org), "**")].each do |cookbook|
           yield cookbook
         end
       end
 
       def action_needed_file_path
-        ::File.expand_path('knife-tidy-actions-needed.txt')
+        ::File.expand_path("knife-tidy-actions-needed.txt")
       end
 
       def action_needed(msg)
-        ::File.open(action_needed_file_path, 'a') do |f|
+        ::File.open(action_needed_file_path, "a") do |f|
           f.write(msg + "\n")
         end
       end
 
       def write_role(path, role)
-        ::File.open(path, 'w') do |f|
+        ::File.open(path, "w") do |f|
           f.write(Chef::JSONCompat.to_json_pretty(role))
         end
       end
 
       def for_each_role(org)
-        Dir[::File.join(tidy.roles_path(org), '*.json')].each do |role|
+        Dir[::File.join(tidy.roles_path(org), "*.json")].each do |role|
           yield role
         end
       end
@@ -355,22 +355,22 @@ class Chef
         the_role = FFI_Yajl::Parser.parse(::File.read(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|
+        new_role["run_list"] = []
+        the_role["run_list"].each do |item|
           begin
             rl << item
-            new_role['run_list'].push(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] = []
+        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)
+                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
@@ -394,13 +394,13 @@ class Chef
 
       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')
+        clients_group_path = ::File.join(tidy.groups_path(org), "clients.json")
         existing_group_data = FFI_Yajl::Parser.parse(::File.read(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
+        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
-          ::File.open(clients_group_path, 'w') do |f|
+          existing_group_data["clients"] = (existing_group_data["clients"] + tidy.client_names(org)).uniq
+          ::File.open(clients_group_path, "w") do |f|
             f.write(Chef::JSONCompat.to_json_pretty(existing_group_data))
           end
         end
@@ -412,16 +412,16 @@ class Chef
         invitations = FFI_Yajl::Parser.parse(::File.read(invite_file), symbolize_names: false)
         invitations_new = []
         invitations.each do |invite|
-          if invite['username'].nil?
+          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']
+            invite_hash["id"] = invite["id"]
+            invite_hash["username"] = invite["username"]
             invitations_new.push(invite_hash)
           end
         end
-        ::File.open(invite_file, 'w') do |f|
+        ::File.open(invite_file, "w") do |f|
           f.write(Chef::JSONCompat.to_json_pretty(invitations_new))
         end
       end

data/lib/chef/knife/tidy_base.rb

@@ -15,8 +15,8 @@
 # limitations under the License.
 #
 
-require 'chef/knife'
-require 'chef/server_api'
+require "chef/knife"
+require "chef/server_api"
 
 class Chef
   class Knife
@@ -24,19 +24,19 @@ class Chef
       def self.included(includer)
         includer.class_eval do
           deps do
-            require 'chef/tidy_server'
-            require 'chef/tidy_common'
+            require "chef/tidy_server"
+            require "chef/tidy_common"
           end
 
           option :org_list,
-            long: '--orgs ORG1,ORG2',
-            description: 'Only apply to objects in the named organizations'
+            long: "--orgs ORG1,ORG2",
+            description: "Only apply to objects in the named organizations"
         end
       end
 
       def server
         @server ||= if Chef::Config.chef_server_root.nil?
-                      ui.warn('chef_server_root not found in knife configuration; using chef_server_url')
+                      ui.warn("chef_server_root not found in knife configuration; using chef_server_url")
                       Chef::TidyServer.from_chef_server_url(Chef::Config.chef_server_url)
                     else
                       Chef::TidyServer.new(Chef::Config.chef_server_root)
@@ -56,19 +56,19 @@ class Chef
       end
 
       def completion_message
-        ui.stdout.puts ui.color('** Finished **', :magenta).to_s
+        ui.stdout.puts ui.color("** Finished **", :magenta).to_s
       end
 
       def action_needed_file_path
-        ::File.expand_path('knife-tidy-actions-needed.txt')
+        ::File.expand_path("knife-tidy-actions-needed.txt")
       end
 
       def server_warnings_file_path
-        ::File.expand_path('reports/knife-tidy-server-warnings.txt')
+        ::File.expand_path("reports/knife-tidy-server-warnings.txt")
       end
 
       def action_needed(msg, file_path = action_needed_file_path)
-        ::File.open(file_path, 'a') do |f|
+        ::File.open(file_path, "a") do |f|
           f.write(msg + "\n")
         end
       end