knife-tidy 0.2.4 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 13a4147cae7f0309f48d49dfc0e014b0afa8d62b
-  data.tar.gz: '009379a697f1930e43f149ef2c072eb75238afba'
+  metadata.gz: b7f8cd82c1128a57a08b0f4d566b6f4c0fab57e0
+  data.tar.gz: '00768c3e853bb6bdbde3d183f84094a933e6b08f'
 SHA512:
-  metadata.gz: dcbb69f54629feffb1d4709445f8dab998826898fbfaa2c6a4bd195deeb2ac39c88d341b49174feea4cb0fd15d394e481d5aa38e5905d3552dab91bfc9d54f3c
-  data.tar.gz: a1edef340c2bd84270101ff2f7359d3ad990ad9ff07142b42085df01fd11ab56d55de80df057f2cc66e6d2d1fea075293e4792dd779042d4ef3699175ed25fc8
+  metadata.gz: 10ae87a0e2bc3248cc63aa67817e61567ea631df7bb5e644947e97aae7f43db29c3bfec3ef7f78ab4e52aeaf5f690d2d03d1d51bd5e3d41646083eecd1895eb1
+  data.tar.gz: 9719b04e58c3c9227a6c2839bbb3e0b02e21487885fcb94f7c20a15d5279754c431cff97f4988fa369b4e42710cb6b004c7f4ea898f34db565170971283df5c2

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Change Log
 
+## [0.1.0](https://github.com/chef-customers/knife-tidy/tree/0.1.0) (2017-09-14)
+[Full Changelog](https://github.com/chef-customers/knife-tidy/compare/0.2.4...0.1.0)
+
+**Closed issues:**
+
+- FATAL: Cannot find subcommand for: 'tidy backup clean' [\#12](https://github.com/chef-customers/knife-tidy/issues/12)
+
+**Merged pull requests:**
+
+- bump to 0.3.0 [\#19](https://github.com/chef-customers/knife-tidy/pull/19) ([jeremymv2](https://github.com/jeremymv2))
+- added dry-run to server clean [\#18](https://github.com/chef-customers/knife-tidy/pull/18) ([jeremymv2](https://github.com/jeremymv2))
+
 ## [0.2.4](https://github.com/chef-customers/knife-tidy/tree/0.2.4) (2017-09-12)
 [Full Changelog](https://github.com/chef-customers/knife-tidy/compare/0.2.3...0.2.4)
 

data/conf/substitutions.json.example

@@ -3,12 +3,24 @@
     "organizations/*/cookbooks/chef-sugar*/metadata.rb":[
       {
         "pattern":"^require .*/lib/chef/sugar/version",
-        "replace":"# 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!"
       }
     ]
+  },
+  "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..\""
+      }
+    ]
   }
 }

data/lib/chef/knife/tidy_backup_clean.rb

@@ -10,6 +10,7 @@ class Chef
         require 'chef/tidy_substitutions'
         require 'chef/tidy_acls'
         require 'ffi_yajl'
+        require 'fileutils'
       end
 
       banner "knife tidy backup clean (OPTIONS)"
@@ -25,6 +26,7 @@ class Chef
         :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] && ::File.directory?(config[:backup_path])
           ui.error 'Must specify valid --backup-path'
           exit 1
@@ -47,8 +49,8 @@ class Chef
           org_acls.validate_user_acls
           fix_self_dependencies(org)
           fix_cookbook_names(org)
-          load_cookbooks(org)
           generate_new_metadata(org)
+          load_cookbooks(org)
         end
 
         completion_message
@@ -106,13 +108,12 @@ class Chef
           puts "INFO: Loading #{cookbook}"
           ret = cl.load_cookbook(cookbook)
           if ret.nil?
-            puts "ACTION NEEDED: Something's wrong with the #{cookbook} cookbook - cannot load it! Moving to cookbooks.broken folder."
+            action_needed("ACTION NEEDED: Something's wrong with the #{cookbook} cookbook - cannot load it! Moving to cookbooks.broken folder.")
             broken_cookooks_add(org, cookbook)
           end
         end
       rescue LoadError => e
         ui.error e
-        puts 'ACTION NEEDED: Look at the cookbook above and determine what in the metadata.rb is causing the exception and rectify manually'
         exit 1
       end
 
@@ -168,7 +169,9 @@ class Chef
       end
 
       def substitutions_file
-        @substitutions_file ||= ::File.expand_path(config[:gsub_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
 
       def orgs
@@ -195,6 +198,16 @@ class Chef
           yield cookbook
         end
       end
+
+      def action_needed_file_path
+        ::File.expand_path('knife-tidy-actions-needed.txt')
+      end
+
+      def action_needed(msg)
+        ::File.open(action_needed_file_path, 'a') do |f|
+          f.write(msg)
+        end
+      end
     end
   end
 end

data/lib/chef/knife/tidy_server_clean.rb

@@ -26,6 +26,10 @@ class Chef
         :long => '--only-nodes',
         :description => 'Only delete stale nodes from Chef Server.'
 
+      option :dry_run,
+        :long => '--dry-run',
+        :description => 'Do not perform any actual deletion, only report on what would have been deleted.'
+
       def run
         # not enabled
         ui.warn "This feature is not enabled"
@@ -34,9 +38,9 @@ class Chef
         STDOUT.sync = true
 
         ensure_reports_dir
-        ui.info "Reading from #{tidy.reports_dir} directory"
+        puts "INFO: Reading from #{tidy.reports_dir} directory"
 
-        ui.info "Using thread concurrency #{config[:concurrency]}"
+        puts "INFO: Using thread concurrency #{config[:concurrency]}"
         configure_chef
 
         if config[:only_cookbooks] && config[:only_nodes]
@@ -64,7 +68,7 @@ class Chef
         queue = Chef::Util::ThreadedJobQueue.new
         unused_cookbooks_file = ::File.join(tidy.reports_dir, "#{org}_unused_cookbooks.json")
         return unless ::File.exist?(unused_cookbooks_file)
-        ui.info "Cleaning cookbooks for Org: #{org}, using #{unused_cookbooks_file}"
+        puts "INFO: Cleaning cookbooks for Org: #{org}, using #{unused_cookbooks_file}"
         unused_cookbooks = FFI_Yajl::Parser.parse(::File.read(unused_cookbooks_file), symbolize_names: true)
         unused_cookbooks.keys.each do |cookbook|
           versions = unused_cookbooks[cookbook]
@@ -77,11 +81,16 @@ class Chef
 
       def delete_cookbook_job(org, cookbook, version)
         path = "/organizations/#{org}/cookbooks/#{cookbook}/#{version}"
+        if config[:dry_run]
+          printf("INFO: Would have executed `rest.delete(#{path})`\n")
+          return
+        end
         rest.delete(path)
         response = '200'
       rescue Net::HTTPServerException
         response = $!.response.code
       ensure
+        return if config[:dry_run]
         formatted = response == '200' ?
           ui.color(' Deleting  %-20s %-10s %10s', :green) :
           ui.color(' Deleting  %-20s %-10s %10s', :red)
@@ -92,7 +101,7 @@ class Chef
         queue = Chef::Util::ThreadedJobQueue.new
         stale_nodes_file = ::File.join(tidy.reports_dir, "#{org}_stale_nodes.json")
         return unless ::File.exist?(stale_nodes_file)
-        ui.info "Cleaning stale nodes for Org: #{org}, using #{stale_nodes_file}"
+        puts "INFO: Cleaning stale nodes for Org: #{org}, using #{stale_nodes_file}"
         stale_nodes = FFI_Yajl::Parser.parse(::File.read(stale_nodes_file), symbolize_names: true)
         stale_nodes[:list].each do |node|
           queue << lambda { delete_node_job(org, node) }
@@ -102,11 +111,16 @@ class Chef
 
       def delete_node_job(org, node)
         path = "/organizations/#{org}/nodes/#{node}"
+        if config[:dry_run]
+          printf("INFO: Would have executed `rest.delete(#{path})`\n")
+          return
+        end
         rest.delete(path)
         response = '200'
       rescue Net::HTTPServerException
         response = $!.response.code
       ensure
+        return if config[:dry_run]
         formatted = response == '200' ?
           ui.color(' Deleting  %-20s %10s', :green) :
           ui.color(' Deleting  %-20s %10s', :red)

data/lib/chef/tidy_substitutions.rb

@@ -15,7 +15,7 @@ class Chef
     end
 
     def load_data
-      Chef::Log.info "Loading substitutions from #{file_path}"
+      puts "INFO: Loading substitutions from #{file_path}"
       @data = FFI_Yajl::Parser.parse(::File.read(@file_path), symbolize_names: false)
     rescue Errno::ENOENT
       raise NoSubstitutionFile, file_path
@@ -42,7 +42,7 @@ class Chef
           file.each_line do |line|
             if line.match(search)
               temp_file.puts replace
-              Chef::Log.info "  ++ #{path}"
+              puts "INFO:  ++ #{path}"
             else
               temp_file.puts line
             end
@@ -61,7 +61,7 @@ class Chef
       load_data
       @data.keys.each do |entry|
         @data[entry].keys.each do |glob|
-          Chef::Log.info "Running substitutions for #{entry} -> #{glob}"
+          puts "INFO: Running substitutions for #{entry} -> #{glob}"
           Dir[::File.join(@backup_path, glob)].each do |file|
             @data[entry][glob].each do |substitution|
               search = Regexp.new(substitution['pattern'])

data/lib/knife-tidy/version.rb

@@ -1,4 +1,4 @@
 module KnifeTidy
-  VERSION = '0.2.4'
+  VERSION = '0.3.0'
   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.2.4
+  version: 0.3.0
 platform: ruby
 authors:
 - Jeremy Miller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-12 00:00:00.000000000 Z
+date: 2017-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake