knife-tidy 2.0.15 → 2.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7aaf34102e27291f03892bfb4eddb450aaed46c5e615818e48a59c174c91e42
-  data.tar.gz: f482bbfb1182b581532ef643900c6f4814dc800ff42e02ff0a29b8936faed77b
+  metadata.gz: 6df7a5c7edcbf10d78ed4f4702b68e231b3f016308280b979bdd84928af0362e
+  data.tar.gz: ae670780d34592914ddf4eba0ba67e3a4fd5a54fe49a0d8a4a9425e5c92aa1c0
 SHA512:
-  metadata.gz: a5192215cbd8341aef601e71bf6c42bb2eb5d19f652570734ac192151941d7b954da8d0fe5c504ea67b599772d09ea12da77d6d782f54e2c967c6c12fc9cef0d
-  data.tar.gz: 75b37b5663f0558791ad1a52b5281d84197e1def8ed2c15103896165a781b4a07f1ac4556f5d266e35fb662d76218e6be0ccf413d569e0b7b776075e5a5aca27
+  metadata.gz: 41fc026a4bb68574ee10ddceb69414868ae4b031f995b6a0e11b86574f579215576b7763c906739c63132d2bf62f886a645dc0b2791bd71683f3ed441d4f7932
+  data.tar.gz: 5e3e481f0e98d4bc141773ef92e6bf0c457678790fac6b7e36acf20e5d2da6365c8d0f8f23ce734fc118b217a73a6b994d7c3bfa79837b4540d8816e02d58227

data/lib/chef/knife/tidy_backup_clean.rb

@@ -10,9 +10,9 @@ class Chef
         require "chef/run_list"
         require_relative "../tidy_substitutions"
         require_relative "../tidy_acls"
-        require "ffi_yajl"
-        require "fileutils"
-        require "securerandom"
+        require "ffi_yajl" unless defined?(FFI_Yajl)
+        require "fileutils" unless defined?(FileUtils)
+        require "securerandom" unless defined?(SecureRandom)
       end
 
       banner "knife tidy backup clean (options)"
@@ -25,7 +25,7 @@ class Chef
 
       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."
+        description: "The path to the file used for substitutions. If non-existent, a boiler plate one will be created."
 
       option :gen_gsub,
         long: "--gen-gsub",
@@ -167,7 +167,7 @@ class Chef
           ret = cl.load!
           if ret.nil?
             action_needed("ACTION NEEDED: Something's wrong with the #{cookbook} cookbook in org #{org} - cannot load it! Moving to cookbooks.broken folder.")
-            broken_cookooks_add(org, cookbook)
+            broken_cookbooks_add(org, cookbook)
           end
         end
       rescue LoadError, Exceptions::MetadataNotValid => e
@@ -175,7 +175,7 @@ class Chef
         exit 1
       end
 
-      def broken_cookooks_add(org, cookbook_path)
+      def broken_cookbooks_add(org, cookbook_path)
         broken_path = ::File.join(tidy.org_path(org), "cookbooks.broken")
         FileUtils.mkdir(broken_path) unless ::File.directory?(broken_path)
         FileUtils.mv(cookbook_path, broken_path, verbose: true, force: true)
@@ -297,7 +297,7 @@ class Chef
 
       def substitutions_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)
+        ui.error "Substitutions file #{sub_file_path} does not exist!" unless ::File.exist?(sub_file_path)
         @substitutions_file ||= sub_file_path
       end
 
@@ -397,9 +397,10 @@ class Chef
         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|
-            f.write(Chef::JSONCompat.to_json_pretty(existing_group_data))
-          end
+        end
+        existing_group_data["clients"] = existing_group_data["clients"].sort
+        ::File.open(clients_group_path, "w") do |f|
+          f.write(Chef::JSONCompat.to_json_pretty(existing_group_data))
         end
       end
 

data/lib/chef/knife/tidy_notify.rb

@@ -4,7 +4,7 @@ class Chef
   class Knife
     class TidyNotify < Knife
       deps do
-        require "ffi_yajl"
+        require "ffi_yajl" unless defined?(FFI_Yajl)
         require "net/smtp"
       end
 
@@ -14,39 +14,39 @@ class Chef
         short: "-s SERVER_NAME",
         long: "--smtp_server SERVER_NAME",
         default: "localhost",
-        description: "SMTP Server to be used for emailling reports to organization admins (defaults to localhost)"
+        description: "SMTP Server to be used for emailing reports to organization admins (defaults to localhost)"
 
       option :smtp_port,
         short: "-p SMTP_PORT",
         long: "--smtp_port SMTP_PORT",
         default: 25,
-        description: "SMTP port to be used for emailling reports to organization admins (defaults to 25)"
+        description: "SMTP port to be used for emailing reports to organization admins (defaults to 25)"
 
       option :smtp_helo,
         short: "-h SMTP_HELO",
         long: "--smtp_helo SMTP_HELO",
         default: "localhost",
-        description: "SMTP HELO to be used for emailling reports to organization admins (defaults to localhost)"
+        description: "SMTP HELO to be used for emailing reports to organization admins (defaults to localhost)"
 
       option :smtp_username,
         short: "-u SMTP_USERNAME",
         long: "--smtp_username SMTP_USERNAME",
-        description: "SMTP Username to be used for emailling reports to organization admins"
+        description: "SMTP Username to be used for emailing reports to organization admins"
 
       option :smtp_password,
         long: "--smtp_password SMTP_PASSWORD",
-        description: "SMTP Password to be used for emailling reports to organization admins"
+        description: "SMTP Password to be used for emailing reports to organization admins"
 
       option :smtp_from,
         long: "--smtp_from SMTP_FROM",
-        description: "SMTP From address to be used for emailling reports to organization admins"
+        description: "SMTP From address to be used for emailing reports to organization admins"
 
       option :smtp_use_tls,
         long: "--smtp_use_tls",
         short: "-t",
         default: false,
         boolean: true | false,
-        description: "Whether TLS should be used for emailling reports to organization admins (defaults to false if omitted)"
+        description: "Whether TLS should be used for emailing reports to organization admins (defaults to false if omitted)"
 
       include Knife::TidyBase
 

data/lib/chef/knife/tidy_server_clean.rb

@@ -6,7 +6,7 @@ class Chef
       include Knife::TidyBase
 
       deps do
-        require "ffi_yajl"
+        require "ffi_yajl" unless defined?(FFI_Yajl)
         require "chef/util/threaded_job_queue"
       end
 

data/lib/chef/knife/tidy_server_report.rb

@@ -7,7 +7,7 @@ class Chef
       include Knife::TidyBase
 
       deps do
-        require "ffi_yajl"
+        require "ffi_yajl" unless defined?(FFI_Yajl)
       end
 
       banner "knife tidy server report (options)"
@@ -19,8 +19,8 @@ class Chef
 
       option :keep_versions,
         long: "--keep-versions MIN",
-        default: 0,
-        description: "Keep a minimum of this many versions of each cookbook (default: 0)"
+        default: 1,
+        description: "Keep a minimum of this many versions of each cookbook (default: 1)"
 
       def run
         ensure_reports_dir!
@@ -82,8 +82,6 @@ class Chef
             end
           end
 
-          used_cookbooks = keep_cookbook_versions(cb_list, keep_versions)
-
           Chef::Log.debug("Used cookbook list before checking environments: #{used_cookbooks}")
           pins = environment_constraints(org)
           used_cookbooks = check_environment_pins(used_cookbooks, pins, cb_list)
@@ -98,7 +96,7 @@ class Chef
           stale_nodes_hash = { 'threshold_days': node_threshold, 'org_total_node_count': nodes.count, 'count': stale_nodes.count, 'list': stale_nodes }
           stale_orgs.push(org) if stale_nodes.count == nodes.count
 
-          tidy.write_new_file(unused_cookbooks(used_cookbooks, cb_list), ::File.join(tidy.reports_dir, "#{org}_unused_cookbooks.json"), backup = false)
+          tidy.write_new_file(unused_cookbooks(used_cookbooks, cb_list, keep_versions), ::File.join(tidy.reports_dir, "#{org}_unused_cookbooks.json"), backup = false)
           tidy.write_new_file(version_count, ::File.join(tidy.reports_dir, "#{org}_cookbook_count.json"), backup = false)
           tidy.write_new_file(stale_nodes_hash, ::File.join(tidy.reports_dir, "#{org}_stale_nodes.json"), backup = false)
 
@@ -108,7 +106,7 @@ class Chef
             action_needed(pre_12_3_message, server_warnings_file_path)
           end
           if unconverged_recent_nodes.length > 0
-            unconverged_recent_message = "#{unconverged_recent_nodes.length} nodes have been created in the last hour that have yet to converge in organization #{org}. These nodes WILL NOT be factored in the stale cookbook verisons report. Continuing with the server cleanup will delete cookbooks in-use by these nodes."
+            unconverged_recent_message = "#{unconverged_recent_nodes.length} nodes have been created in the last hour that have yet to converge in organization #{org}. These nodes WILL NOT be factored in the stale cookbook versions report. Continuing with the server cleanup will delete cookbooks in-use by these nodes."
             ui.warn(unconverged_recent_message)
             action_needed(unconverged_recent_message, server_warnings_file_path)
           end
@@ -162,15 +160,6 @@ class Chef
         cb_list
       end
 
-      def keep_cookbook_versions(cb_list, min)
-        retain = {}
-        cb_list.each do |name, versions|
-          keep = versions.sort { |a, b| Gem::Version.new(a) <=> Gem::Version.new(b) }.last(min)
-          retain[name] = keep
-        end
-        retain
-      end
-
       def cookbook_count(cb_list)
         cb_count_list = {}
         cb_list.each do |name, versions|
@@ -179,14 +168,14 @@ class Chef
         cb_count_list
       end
 
-      def unused_cookbooks(used_list, cb_list)
+      def unused_cookbooks(used_list, cb_list, keep_versions)
         unused_list = {}
         cb_list.each do |name, versions|
           versions.sort! { |a, b| Gem::Version.new(a) <=> Gem::Version.new(b) }
           if used_list[name].nil? # Not in the used list at all (Remove all versions)
             unused_list[name] = versions
           elsif used_list[name].sort != versions # Is in the used cookbook list, but version arrays do not match (Find unused versions)
-            unused = versions - used_list[name] - [versions.last] # Don't delete the most recent version as it might not be in a run_list yet.
+            unused = versions - used_list[name] - versions.last(keep_versions) # Don't delete the X most recent version as it might not be in a run_list yet.
             unused_list[name] = unused unless unused.empty?
           end
         end

data/lib/chef/tidy_acls.rb

@@ -1,5 +1,5 @@
-require "ffi_yajl"
-require "fileutils"
+require "ffi_yajl" unless defined?(FFI_Yajl)
+require "fileutils" unless defined?(FileUtils)
 require "chef/log"
 
 class Chef
@@ -111,7 +111,7 @@ class Chef
 
     def add_client_to_org(actor)
       # TODO
-      @tidy.ui.stdout.puts "ACTION NEEDED: Client referenced in acl non-existant: #{actor}"
+      @tidy.ui.stdout.puts "ACTION NEEDED: Client referenced in acl non-existent: #{actor}"
     end
 
     def add_actor_to_members(actor)

data/lib/chef/tidy_common.rb

@@ -1,5 +1,5 @@
-require "ffi_yajl"
-require "fileutils"
+require "ffi_yajl" unless defined?(FFI_Yajl)
+require "fileutils" unless defined?(FileUtils)
 require "chef/knife/core/ui"
 
 class Chef

data/lib/chef/tidy_substitutions.rb

@@ -1,6 +1,6 @@
-require "ffi_yajl"
-require "tempfile"
-require "fileutils"
+require "ffi_yajl" unless defined?(FFI_Yajl)
+require "tempfile" unless defined?(Tempfile)
+require "fileutils" unless defined?(FileUtils)
 require "chef/log"
 
 class Chef

data/lib/knife-tidy/version.rb

@@ -1,4 +1,4 @@
 module KnifeTidy
-  VERSION = "2.0.15".freeze
+  VERSION = "2.1.6".freeze
   MAJOR, MINOR, TINY = VERSION.split(".")
 end

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: knife-tidy
 version: !ruby/object:Gem::Version
-  version: 2.0.15
+  version: 2.1.6
 platform: ruby
 authors:
-- Jeremy Miller
+- Chef Software, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-11 00:00:00.000000000 Z
+date: 2022-03-18 00:00:00.000000000 Z
 dependencies: []
-description: Report on stale Chef Server nodes and cookbooks and clean up data integrity
-  issues in a knife-ec-backup object based backup
+description: Report on stale Chef Infra Server nodes and cookbooks and clean up data
+  integrity issues in a knife-ec-backup object based backup
 email:
-- jmiller@chef.io
+- oss@chef.io
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -30,7 +30,7 @@ files:
 - lib/chef/tidy_server.rb
 - lib/chef/tidy_substitutions.rb
 - lib/knife-tidy/version.rb
-homepage: https://github.com/chef-customers/knife-tidy
+homepage: https://github.com/chef/knife-tidy
 licenses:
 - Apache-2.0
 metadata: {}
@@ -49,9 +49,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.4
 signing_key: 
 specification_version: 4
-summary: Report on stale Chef Server nodes and cookbooks and clean up data integrity
+summary: Report on stale Chef Infra Server nodes and cookbooks and clean up data integrity
   issues in a knife-ec-backup object based backup
 test_files: []