knife-tidy 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a70a4795b84f11eff9639e474e9517b260137d11
-  data.tar.gz: 98fbf0c01305a8813471f5524400f973db06be34
+  metadata.gz: 430581b6c4b852bc0b345ce4159519c325be6841
+  data.tar.gz: 4a4578f085705c816c1d5c011fc7772e37779401
 SHA512:
-  metadata.gz: 84caa9803916b69388488d6f101aa41379d8ad30714a8c5275c42e3af1ac279d2ab7b68868fdd33647ff914b898b7097086711def57e378b2dafae15e79bd40f
-  data.tar.gz: 37262614ee1db11e62eb29039fd84963e5f70cd4bb695cfb2adc1630bda1712721588e1e92a36110119b2bacde777ea04a0c54e027076e06367ab7f312458740
+  metadata.gz: cc2cb8e6fd15cfe1ffe174b6416e2c886f79ee79399547bd9bad27e91c6a53dabe2f3328dd47c6f69f91689d1626429e54e50c62aebdf2605669688d023b67d2
+  data.tar.gz: 5bff332dbfc245637da73d60a022ebabbd1e25ec2042e184d1b1db7e21f98b67621a6dbd81c69e1a6d754af9546b964bf5c21c76b6cc064fda38ce7bb610c52b

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Change Log
 
+## [0.3.3](https://github.com/chef-customers/knife-tidy/tree/0.3.3) (2017-09-15)
+[Full Changelog](https://github.com/chef-customers/knife-tidy/compare/0.3.2...0.3.3)
+
+**Merged pull requests:**
+
+- boiler plate gsub file now works [\#25](https://github.com/chef-customers/knife-tidy/pull/25) ([jeremymv2](https://github.com/jeremymv2))
+- fixing null values and emtpy arrays in metadata.json [\#24](https://github.com/chef-customers/knife-tidy/pull/24) ([jeremymv2](https://github.com/jeremymv2))
+- Jeremyv2/action needed notification [\#23](https://github.com/chef-customers/knife-tidy/pull/23) ([jeremymv2](https://github.com/jeremymv2))
+
 ## [0.3.2](https://github.com/chef-customers/knife-tidy/tree/0.3.2) (2017-09-14)
 [Full Changelog](https://github.com/chef-customers/knife-tidy/compare/0.3.1...0.3.2)
 

data/README.md

@@ -4,7 +4,7 @@
 
 This Chef Knife plugin has two primary purposes:
  * Report on the state of Chef Server objects that can be tidied up (Future: clean up objects)
- * Clean up data integrity issues from a object backup created by [knife-ec-backup](https://github.com/chef/knife-ec-backup)
+ * A companion tool to [knife-ec-backup](https://github.com/chef/knife-ec-backup) that will clean up data integrity issues in an object backup
 
 # Requirements
 
@@ -12,7 +12,7 @@ A current Chef Client. Can easily be installed via [Chef DK](https://github.com/
 
 # Installation
 
-Via Gem
+Via Rubygems
 ```bash
 gem install knife-tidy
 ```
@@ -31,19 +31,24 @@ The following options are supported across all subcommands:
   * `--orgs ORG1,ORG2`:
     Only apply to objects in the named organizations (default: all orgs)
 
-## $ knife tidy server report (options)
+## $ knife tidy server report --help
 
 Cookbooks and nodes account for the largest objects in your Chef Server.
 If you want to keep it lean and mean and easy to port the object data, you must
-clean any of these unused objects up!
+tidy these unused objects up!
 
 ## Options
 
   * `--node-threshold NUM_DAYS`
     Maximum number of days since last checkin before node is considered stale (default: 30)
 
+Example:
+```bash
+knife tidy server report --orgs brewinc,acmeinc --node-threshold 50
+```
+
 ## Notes
-  Generates json reports as such:
+  `server report` generates json reports as such:
 
 File Name | Contents
 --- | ---
@@ -51,7 +56,7 @@ org_threshold_numdays_stale_nodes.json | Nodes in that org that have not checked
 org_cookbook_count.json | Number of cookbook versions for each cookbook that that org.
 org_unused_cookbooks.json | List of cookbooks and versions that do not appear to be in-use for that org. This is determined by checking the versioned run list of each of the nodes in the org.
 
-## $ knife tidy backup clean (options)
+## $ knife tidy backup clean --help
 
 ## Options
 
@@ -61,39 +66,47 @@ org_unused_cookbooks.json | List of cookbooks and versions that do not appear to
   * `--gsub-file /path/to/gsub/file`:
     The path to the file used for substitutions. If non-existant, a boiler plate one will be created.
 
+Run the following example before attempting the `knife ec backup restore` operation:
+```bash
+knife tidy backup clean --gen-gsub
+NFO: Creating boiler plate gsub file: 'substitutions.json'
+knife tidy backup clean --backup-path backups/ --gsub-file substitutions.json
+```
+
 ## Notes
 
   Global file substitutions can be performed when `--gsub-file` option is used. Several known issues are corrected
-  and others can be added with search/replace pairings:
-
-  * DONE: global glob'd file gsub definitions
+  and others can be added with search/replace pairings. The following boiler plate file is created for you when `--gen-gsub` is used:
 
 ```json
 {
   "chef-sugar":{
     "organizations/*/cookbooks/chef-sugar*/metadata.rb":[
       {
-        "pattern":"require +File.expand_path('../lib/chef/sugar/version', __FILE__)",
-        "replace":"# require          File.expand_path('../lib/chef/sugar/version', __FILE__)"
+        "pattern":"^require .*/lib/chef/sugar/version",
+        "replace":"# require          File.expand_path('../lib/chef/sugar/version', *__FILE__)"
       },
       {
         "pattern":"version *Chef::Sugar::VERSION",
         "replace":"version          !COOKBOOK_VERSION!"
       }
     ]
+  },
+  "io-read-version-and-readme.md":{
+    "organizations/*/cookbooks/*/metadata.rb":[
+      {
+        "pattern":"^version +IO.read.* 'VERSION'.*",
+        "replace":"version !COOKBOOK_VERSION!"
+      },
+      {
+        "pattern":"^long_description +IO.read.* 'README.md'.*",
+        "replace":"#long_description \"A Long Description..\""
+      }
+    ]
   }
 }
 ```
 
-  * DONE: metadata validation with `Chef::CookbookLoader`
-  * DONE: metadata.rb and metadata.json inconsistencies correction
-  * DONE: metadata self-dependency correction
-  * DONE: user email validation
-  * DONE: ensure user emails do not cause primary key violation
-  * DONE: ambiguous actors (acl actor exists as client and user)
-  * DONE: users/clients referenced as actors in acls that do not exist in users/clients
-  * DONE: nonexistent groups referenced in acls
-
 ## Summary and Credits
 
   * Server Report was ported from Nolan Davidson's [chef-cleanup](https://github.com/nsdavidson/chef-cleanup)

data/lib/chef/knife/tidy_backup_clean.rb

@@ -25,23 +25,26 @@ class Chef
         :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\'.'
+
       def run
+        FileUtils.rm_f(action_needed_file_path)
+
+        if config[:gen_gsub]
+          Chef::TidySubstitutions.new().boiler_plate
+          exit
+        end
 
         unless config[:backup_path] && ::File.directory?(config[:backup_path])
           ui.error 'Must specify valid --backup-path'
           exit 1
         end
 
-        validate_user_emails
+        Chef::TidySubstitutions.new(substitutions_file, tidy).run_substitutions if config[:gsub_file]
 
-        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
+        validate_user_emails
 
         orgs.each do |org|
           org_acls = Chef::TidyOrgAcls.new(tidy, org)
@@ -54,6 +57,8 @@ class Chef
         end
 
         completion_message
+
+        puts "\nWARNING: ** Unrepairable Items **\nPlease see #{action_needed_file_path}\n" if ::File.exist?(action_needed_file_path)
       end
 
       def validate_user_emails
@@ -142,6 +147,7 @@ class Chef
       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
 
@@ -160,6 +166,27 @@ class Chef
         end
       end
 
+      def fix_metadata_fields(cookbook_path)
+        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?
+            puts "REPAIRING: Fixing null value for key #{key} in #{json_path}"
+            md[key] = 'default value'
+          end
+        end
+        metadata['platforms'].each_pair do |key, value|
+          if value.kind_of?(Array) && value.empty?
+            puts "REPAIRING: Fixing empty platform key for for key #{key} in #{json_path}"
+            md['platforms'][key] = '>= 0.0.0'
+          end
+        end
+        ::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')

data/lib/chef/tidy_common.rb

@@ -10,7 +10,7 @@ class Chef
     end
 
     def users_path
-      @users_path ||= File.expand_path(::File.join(@backup_path, 'users'))
+      @users_path ||= ::File.expand_path(::File.join(@backup_path, 'users'))
     end
 
     def members_path(org)

data/lib/chef/tidy_substitutions.rb

@@ -22,7 +22,9 @@ class Chef
     end
 
     def boiler_plate
-
+      bp = ::File.join(File.dirname(__FILE__), '../../conf/substitutions.json.example')
+      puts "INFO: Creating boiler plate gsub file: 'substitutions.json'"
+      FileUtils.cp(bp, ::File.join(Dir.pwd, 'substitutions.json'))
     end
 
     def cookbook_version_from_path(path)

data/lib/knife-tidy/version.rb

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

metadata

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