knife-tidy 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4617020ad74d1acc6de5f6c5e65c7f3506455689
-  data.tar.gz: be95ccdc41759a9949aa6ee3aa6afe221486c995
+  metadata.gz: d41634bad35e623a19ebe00e33d890aa31c6e4e9
+  data.tar.gz: dc4576d52dc94ea7c5dce5e72d6045dc4ddbb634
 SHA512:
-  metadata.gz: 4170963ff8992beec932a57db8715fa0edba110edee1c643c3f277d4d9b2568edb7ea846cee7033bfa397c4bcd699f5dc0a6aff1494b808c519c461c6269e810
-  data.tar.gz: acc9b53c4944f77bc0879805142be99b7143a891a2feb320a80767f2c89879c651d606f9fd56234ddc1801c13b59c17b61a86b3fc12e65140baa36bbc67ec212
+  metadata.gz: 309ce63b1bd9eb385a901efdc4cc185cc04a2953bf88064a5aad88a28d7beb7109eee64956f0e7f3956eac9a549e954e2b957753d0059f3f55893d48f0feca0d
+  data.tar.gz: c7d6e786d7f4ece31e628d3dd3976cf0f723e4bb2db0815851fa68ecf448f5976461897fac525702761997d1f8b380d4e0a99d88eb490656e40d7198685063fe

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+# Change Log
+
+## [0.1.1](https://github.com/jeremymv2/knife-tidy/tree/0.1.1) (2017-08-11)
+[Full Changelog](https://github.com/jeremymv2/knife-tidy/compare/0.1.1...0.1.1)
+
+**Merged pull requests:**
+
+- bump version to 0.1.1 [\#2](https://github.com/jeremymv2/knife-tidy/pull/2) ([jeremymv2](https://github.com/jeremymv2))
+
+
+
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/README.md

@@ -33,6 +33,10 @@ The following options are supported across all subcommands:
 
 # knife tidy server report (options)
 
+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!
+
 ## Options
 
   * `--node-threshold NUM_DAYS`
@@ -43,23 +47,53 @@ The following options are supported across all subcommands:
 
 File Name | Contents
 --- | ---
-<org>_<threshold_num>d_stale_nodes.json | Nodes in that org that have not checked in for the number of days specified.
-<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.
+org_threshold_numdays_stale_nodes.json | Nodes in that org that have not checked in for the number of days specified.
+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)
 
 ## Options
 
   * `--repo-path /path/to/chef-repo`:
-    The Chef Repo to report on or change (such as one created from a
-    [knife-ec-backup](https://github.com/chef/knife-ec-backup)
+    The Chef Repo to tidy up (such as one created from a [knife-ec-backup](https://github.com/chef/knife-ec-backup)
+
+  * `--gsub-file path/to/gsub/file`:
+    The path to the file used for substitutions. If non-existant, a boiler plate one will be created.
 
 ## Notes
 
-  * Items [Addressed](ITEMS_CLEANED.md)
-  * [To Do](TODO_LIST.md)
+  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
+
+```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":"version *Chef::Sugar::VERSION",
+        "replace":"# version          !COOKBOOK_VERSION!"
+      }
+    ]
+  }
+}
+```
+
+  * 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
+  * TODO: ambiguous actors (acl actor exists as client and user)
+  * TODO: users/clients referenced as actors in acls that do not exist in users/clients
+  * TODO: nonexistent groups referenced in acls
 
-# Credits
+## Summary and Credits
 
   * Server Report was ported from Nolan Davidson's [chef-cleanup](https://github.com/nsdavidson/chef-cleanup)

data/Rakefile

@@ -1,6 +1,6 @@
 #!/usr/bin/env rake
 
-require_relative 'tasks/maintainers'
+# require_relative 'tasks/maintainers'
 
 # Style tests. cookstyle (rubocop) and Foodcritic
 namespace :style do
@@ -65,5 +65,17 @@ namespace :supermarket do
   end
 end
 
+# Changelog
+namespace :changelog do
+  begin
+    require 'github_changelog_generator/task'
+
+    GitHubChangelogGenerator::RakeTask.new :changelog do |config|
+      config.since_tag = '0.1.1'
+      config.future_release = '0.1.1'
+    end
+  end
+end
+
 # Default
 task default: %w(style spec)

data/lib/chef/knife/tidy_backup_clean.rb

@@ -10,6 +10,7 @@ class Chef
         require 'chef/cookbook_loader'
         require 'chef/cookbook/metadata'
         require 'chef/tidy_substitutions'
+        require 'ffi_yajl'
       end
 
       option :backup_path,
@@ -18,7 +19,7 @@ class Chef
 
       option :gsub_file,
         :long => '--gsub-file path/to/gsub/file',
-        :description => 'The path to the file used for substitutions'
+        :description => 'The path to the file used for substitutions. If non-existant, a boiler plate one will be created.'
 
       def run
         unless config[:backup_path]
@@ -26,13 +27,12 @@ class Chef
           exit 1
         end
 
-        global_users.each do |user|
-          validate_user(user)
-        end
+        validate_user_emails!
 
         if config[:gsub_file]
-          if config[:gen_gsub_template]
+          unless ::File.exist?(config[:gsub_file])
             Chef::TidySubstitutions.new(substitutions_file).boiler_plate
+            exit
           else
             Chef::TidySubstitutions.new(substitutions_file, backup_path_expanded).run_substitutions
           end
@@ -45,6 +45,45 @@ class Chef
         end
       end
 
+      def validate_user_emails!
+        emails_seen = []
+        global_users.each do |user|
+          email = ''
+          ui.info "Validating #{user}"
+          the_user = FFI_Yajl::Parser.parse(::File.read(::File.join(global_users_path_expanded, "#{user}.json")), symbolize_names: false)
+          if the_user['email'].match(/\A[^@\s]+@[^@\s]+\z/)
+            if emails_seen.include?(the_user['email'])
+              ui.info "Already saw #{user}'s email, creating a unique one."
+              email = unique_email
+              new_user = the_user.dup
+              new_user['email'] = email
+              save_user(new_user)
+              emails_seen.push(email)
+            else
+              emails_seen.push(the_user['email'])
+            end
+          else
+            ui.info "User #{user} does not have a valid email, creating a unique one."
+            email = unique_email
+            new_user = the_user.dup
+            new_user['email'] = email
+            save_user(new_user)
+            emails_seen.push(email)
+          end
+        end
+      end
+
+      def unique_email
+        (0...8).map { (65 + rand(26)).chr }.join.downcase +
+        '@' + (0...8).map { (65 + rand(26)).chr }.join.downcase + '.com'
+      end
+
+      def save_user(user)
+        ::File.open(::File.join(global_users_path_expanded, "#{user['username']}.json"), 'w+') do |f|
+          f.write(FFI_Yajl::Encoder.encode(user, pretty: true))
+        end
+      end
+
       def load_cookbooks(org)
         cl = Chef::CookbookLoader.new(cookbooks_path_expanded(org))
         for_each_cookbook_basename(org) do |cookbook|
@@ -87,7 +126,7 @@ class Chef
           ui.warn "No metadata.rb in #{path} - skipping"
           return
         end
-        ui.info "   Generating new metadata.json for #{path}"
+        ui.info "Generating new metadata.json for #{path}"
         md = Chef::Cookbook::Metadata.new
         md.name(cookbook)
         md.from_file(md_path)

data/lib/chef/knife/tidy_base.rb

@@ -60,6 +60,10 @@ class Chef
         ::File.expand_path(::File.join(backup_path_expanded, 'organizations', org, 'cookbooks'))
       end
 
+      def global_users_path_expanded
+        ::File.expand_path(::File.join(backup_path_expanded, 'users'))
+      end
+
       def substitutions_file
         ::File.expand_path(config[:gsub_file])
       end

data/lib/knife-tidy/version.rb

@@ -1,4 +1,4 @@
 module KnifeTidy
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
   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.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Jeremy Miller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-11 00:00:00.000000000 Z
+date: 2017-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -103,6 +103,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md