knife-tidy 0.3.6 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eb1485dc35ad891eb9cfdeaf1d240c0bd1c6d1dd
-  data.tar.gz: 15f5aa2d783d766f3d8fe3dcfde722c0f2400637
+  metadata.gz: 5c88d6c7424cf8313b281efc0f68e2d635df4fae
+  data.tar.gz: 2fb450888ca5ca8d612b73efcb810806314246b8
 SHA512:
-  metadata.gz: ae78c38d8b4a2210793a6a40ec5d55692bb6b148bc14ecdcf7a700ccfc9b8417c6c2d617c416cd0e1df3e9f3bbd7044bab81645560a4c8203a8acbaaf44f9431
-  data.tar.gz: 4aa27248646d13d019dbca4c44a0b330a76784ee866815530e52050fdf8e192fa2c7bbe97a01763147b6fba6c4aefd2003d62b17c192a7d152e8a3e7f3e01e3d
+  metadata.gz: c63e4dd5f37b8a9cf028430455727243d944e01b13bca25b4562d00ea16b8fed5a86d47adcc727935197e95dfd60792d5cbcda7f6ca4f85a6ea580acdffefcd1
+  data.tar.gz: cbdeb1bca74cee204b16ec6bb89c6bab18263d73f98268a58197a2bd8b8d9107cfeac88298c522d543cadc63854ba1f1a4f08647bf2a735ae12332143e9a8804

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Change Log
 
+## [0.4.0](https://github.com/chef-customers/knife-tidy/tree/0.4.0) (2017-09-26)
+[Full Changelog](https://github.com/chef-customers/knife-tidy/compare/0.3.6...0.4.0)
+
+**Merged pull requests:**
+
+- fix NilClass on env\_run\_lists [\#35](https://github.com/chef-customers/knife-tidy/pull/35) ([jeremymv2](https://github.com/jeremymv2))
+- fix merge conflict from rebase [\#34](https://github.com/chef-customers/knife-tidy/pull/34) ([jeremymv2](https://github.com/jeremymv2))
+- Simple feature to clean up EC11 org objects which don't load into CS12 [\#33](https://github.com/chef-customers/knife-tidy/pull/33) ([irvingpop](https://github.com/irvingpop))
+- role run\_list clean up and metadata name regex simplification [\#32](https://github.com/chef-customers/knife-tidy/pull/32) ([jeremymv2](https://github.com/jeremymv2))
+- bump to 0.3.6 [\#30](https://github.com/chef-customers/knife-tidy/pull/30) ([jeremymv2](https://github.com/jeremymv2))
+
 ## [0.3.6](https://github.com/chef-customers/knife-tidy/tree/0.3.6) (2017-09-25)
 [Full Changelog](https://github.com/chef-customers/knife-tidy/compare/0.3.5...0.3.6)
 

data/Rakefile

@@ -42,29 +42,6 @@ rescue LoadError => e
   puts ">>> Gem load error: #{e}, omitting spec" unless ENV['CI']
 end
 
-# Integration tests. Kitchen.ci
-namespace :integration do
-  begin
-    require 'kitchen/rake_tasks'
-
-    desc 'Run kitchen integration tests'
-    Kitchen::RakeTasks.new
-  rescue StandardError => e
-    puts ">>> Kitchen error: #{e}, omitting #{task.name}" unless ENV['CI']
-  end
-end
-
-namespace :supermarket do
-  begin
-    require 'stove/rake_task'
-
-    desc 'Publish cookbook to Supermarket with Stove'
-    Stove::RakeTask.new
-  rescue LoadError => e
-    puts ">>> Gem load error: #{e}, omitting #{task.name}" unless ENV['CI']
-  end
-end
-
 # Changelog
 namespace :changelog do
   begin

data/lib/chef/knife/tidy_backup_clean.rb

@@ -7,10 +7,13 @@ class Chef
       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'
       end
 
       banner "knife tidy backup clean (options)"
@@ -47,6 +50,8 @@ class Chef
         validate_user_emails
 
         orgs.each do |org|
+          fix_org_object(org)
+          validate_roles(org)
           org_acls = Chef::TidyOrgAcls.new(tidy, org)
           org_acls.validate_acls
           org_acls.validate_user_acls
@@ -89,10 +94,40 @@ class Chef
         end
       end
 
+      # 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
+      def fix_org_object(org)
+        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?
+          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.gsub('-','')
+          fixed_org_object = { name: good_name, full_name: good_full_name, guid: good_guid }
+
+          write_org_object(org, fixed_org_object)
+        end
+      end
+
+      def load_org_object(org)
+        JSON.parse(File.read(File.join(tidy.org_path(org), 'org.json')))
+      rescue Errno::ENOENT, JSON::ParserError
+        puts "REPAIRING: org object for organization #{org} is missing or corrupt. Generating a new one"
+        return { name: org, full_name: org, guid: SecureRandom.uuid.gsub('-','') }
+      end
+
+      def write_org_object(org, 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)
         puts "REPAIRING: Correcting `name` in #{rb_path}"
         content = IO.readlines(rb_path)
-        new_content = content.select { |line| line !~ /^name.*['"]\S+['"]/ }
+        new_content = content.reject { |line| line =~ /^name .*/ }
         name_field = "name '#{cookbook_name}'\n"
         IO.write rb_path, name_field + new_content.join('')
       end
@@ -276,6 +311,60 @@ class Chef
           f.write(msg + "\n")
         end
       end
+
+      def write_role(path, role)
+        ::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|
+          yield role
+        end
+      end
+
+      def repair_role_run_lists(role_path)
+        # rubocop:disable MethodLength
+        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|
+          begin
+            rl << item
+            new_role['run_list'].push(item)
+          rescue ArgumentError
+            puts "REPAIRING: Invalid Recipe Item: #{item} in run_list from #{role_path}"
+          end
+        end
+        if the_role.has_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
+                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 MethodLength
+      end
+
+      def validate_roles(org)
+        for_each_role(org) do |role_path|
+          puts "INFO: Validating Role at #{role_path}"
+          begin
+            Chef::Role.from_hash(FFI_Yajl::Parser.parse(::File.read(role_path), symbolize_names: false))
+          rescue ArgumentError
+            repair_role_run_lists(role_path)
+          end
+        end
+      end
     end
   end
 end

data/lib/chef/tidy_common.rb

@@ -37,6 +37,10 @@ class Chef
       ::File.expand_path(::File.join(@backup_path, 'organizations', org, 'cookbooks'))
     end
 
+    def roles_path(org)
+      ::File.expand_path(::File.join(@backup_path, 'organizations', org, 'roles'))
+    end
+
     def org_path(org)
       ::File.expand_path(::File.join(@backup_path, 'organizations', org))
     end

data/lib/knife-tidy/version.rb

@@ -1,4 +1,4 @@
 module KnifeTidy
-  VERSION = '0.3.6'
+  VERSION = '0.4.0'
   MAJOR, MINOR, TINY = VERSION.split('.')
 end

data/spec/chef/knife/tidy_backup_clean_spec.rb

@@ -5,7 +5,6 @@ require 'chef/config'
 require 'stringio'
 
 class Tester < Chef::Knife
-  include Chef::Knife::TidyBackupClean
 end
 
 describe Chef::Knife::TidyBackupClean do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knife-tidy
 version: !ruby/object:Gem::Version
-  version: 0.3.6
+  version: 0.4.0
 platform: ruby
 authors:
 - Jeremy Miller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-25 00:00:00.000000000 Z
+date: 2017-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake