knife-tidy 2.0.1 → 2.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23b1bd5cd9472c351eddcf5722b5883529ab52ff7d2823cd1f71ffd050ea382e
-  data.tar.gz: 47d38da1aaea0f9ea819a3fdac00ed8736196d9429c0629a26f2d8562a4f6549
+  metadata.gz: 562e7dd8fc15d4b707b8b3d70c0bc54a3226f9d54d8bcc72ef4cf5436320fc1a
+  data.tar.gz: 61a42597e3340788e0f4040b5c251c5fce14622afadb077048886936e445815f
 SHA512:
-  metadata.gz: 564fbad7997899cc26a55b3c265edbd7a5e0be3aa518c86e4fb67b651e30a6e55311e0042ea2b0f7a009b1b1e0984894e54b6c23cd643d076097789c9a2e3c2a
-  data.tar.gz: 3ef4230e711258c422cf14b9a53b15bd9797e917afc79bf1dee2763f5ee748b84d4ee02190e20fe70ba27d65a8a448f0a243229090ef5ca4d8c710d1c521f82c
+  metadata.gz: 3c475ece3e2a94d08a521f4262820e88e5103d8e1cc3cc7273dbd6c1ce639d122e2c00904a46fe71ddec0eefee87aa567f7de574fd965764cebe70135f65d7d0
+  data.tar.gz: 33c2841cfc1d1c51db87a06c7a61ffd26c630096962e0ce70aac4df6d9ac234818e82c0b7ab2894a0a440fd804cb5a15a05fdbe9d691dc84ca0f1b762157d5b7

data/lib/chef/knife/tidy_backup_clean.rb

@@ -194,7 +194,7 @@ class Chef
         Dir[::File.join(tidy.backup_path, "organizations/*/cookbooks/chef-sugar*/metadata.rb")].each do |file|
           ui.stdout.puts "INFO: Searching for known chef-sugar problems when uploading."
           s = Chef::TidySubstitutions.new(nil, tidy)
-          version = s.cookbook_version_from_path(file)
+          version = tidy.cookbook_version_from_path(::File.dirname(file))
           patterns = [
             {
               search: "^require .*/lib/chef/sugar/version",
@@ -222,7 +222,8 @@ class Chef
           Chef::TidySubstitutions.new(nil, tidy).sub_in_file(
             ::File.join(cookbook_path, "metadata.rb"),
             Regexp.new("^depends +['\"]#{name}['\"]"),
-            "# depends '#{name}' # knife-tidy was here")
+            "# depends '#{name}' # knife-tidy was here"
+          )
         end
       end
 
@@ -279,9 +280,7 @@ class Chef
 
       def create_minimal_metadata(cookbook_path)
         name = tidy.cookbook_name_from_path(cookbook_path)
-        components = cookbook_path.split(File::SEPARATOR)
-        name_version = components[components.index("cookbooks") + 1]
-        version = name_version.match(/\d+\.\d+\.\d+/).to_s
+        version = tidy.cookbook_version_from_path(cookbook_path)
         metadata = {}
         metadata["name"] = name
         metadata["version"] = version
@@ -398,7 +397,7 @@ class Chef
         existing_group_data = FFI_Yajl::Parser.parse(::File.read(clients_group_path), symbolize_names: false)
         existing_group_data["clients"] = [] unless existing_group_data.key?("clients")
         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}"
+          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))

data/lib/chef/knife/tidy_notify.rb

@@ -11,42 +11,42 @@ class Chef
       banner "knife tidy notify (options)"
 
       option :smtp_server,
-             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)"
+        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)"
 
       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)"
+        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)"
 
       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)"
+        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)"
 
       option :smtp_username,
-             short: "-u SMTP_USERNAME",
-             long: "--smtp_username SMTP_USERNAME",
-             description: "SMTP Username to be used for emailling reports to organization admins"
+        short: "-u SMTP_USERNAME",
+        long: "--smtp_username SMTP_USERNAME",
+        description: "SMTP Username to be used for emailling reports to organization admins"
 
       option :smtp_password,
-             long: "--smtp_password SMTP_PASSWORD",
-             description: "SMTP Password to be used for emailling reports to organization admins"
+        long: "--smtp_password SMTP_PASSWORD",
+        description: "SMTP Password to be used for emailling 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"
+        long: "--smtp_from SMTP_FROM",
+        description: "SMTP From address to be used for emailling 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)"
+        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)"
 
       include Knife::TidyBase
 
@@ -54,13 +54,13 @@ class Chef
         reports_dir = tidy.reports_dir
         report_file_suffixes = ["_unused_cookbooks.json", "_cookbook_count.json", "_stale_nodes.json"]
         # Only grab the files matching the report_file_suffixes
-        report_files = Dir["#{reports_dir}/*{#{report_file_suffixes.join(',')}}"]
+        report_files = Dir["#{reports_dir}/*{#{report_file_suffixes.join(",")}}"]
 
         ui.info "Reading from #{tidy.reports_dir} directory"
 
         # Fetch list of organization names from reports directory
         begin
-          org_names = report_files.map { |r_file| r_file.match("#{reports_dir}\/(.*)(#{report_file_suffixes.join('|')})").captures.first }.uniq
+          org_names = report_files.map { |r_file| r_file.match("#{reports_dir}\/(.*)(#{report_file_suffixes.join("|")})").captures.first }.uniq
         rescue NoMethodError
           ui.stderr.puts "Failed to parse json reports files. Please ensure your reports are valid."
           return
@@ -120,7 +120,7 @@ class Chef
         mime_boundary = "==Multipart_Boundary_x#{srand}x"
         message = <<~MESSAGE_END
           From: Knife Tidy <#{config[:smtp_from]}>
-          To: #{recipients.map { |recipient| "#{recipient[:name]} <#{recipient[:email]}>" }.join(', ')}
+          To: #{recipients.map { |recipient| "#{recipient[:name]} <#{recipient[:email]}>" }.join(", ")}
           MIME-Version: 1.0
           Subject: Knife Tidy Cleanup Report for Organization "#{organization}"
           Content-Type: multipart/mixed; boundary="#{mime_boundary}";
@@ -172,13 +172,13 @@ class Chef
         table_body = if report_data[organization]["_unused_cookbooks.json"].empty?
                        "<tr><td colspan='2'>No unused cookbook versions</td></tr>"
                      else
-                       report_data[organization]["_unused_cookbooks.json"].map { |cookbook_name, cookbook_versions| "<tr><td>#{cookbook_name}</td><td>#{cookbook_versions.join('<br>')}</td></tr>" }.join("\n")
+                       report_data[organization]["_unused_cookbooks.json"].map { |cookbook_name, cookbook_versions| "<tr><td>#{cookbook_name}</td><td>#{cookbook_versions.join("<br>")}</td></tr>" }.join("\n")
                      end
         table_start + header_string + table_body + table_end
       end
 
       def generate_node_table(report_data, organization)
-        table_start = "<h2>Stale Nodes</h2><p>This table contains nodes that have not checked in to the Chef Server in #{report_data[organization]['_stale_nodes.json']['threshold_days']} days.<p><table border='1' cellpadding='1' cellspacing='0'>"
+        table_start = "<h2>Stale Nodes</h2><p>This table contains nodes that have not checked in to the Chef Server in #{report_data[organization]["_stale_nodes.json"]["threshold_days"]} days.<p><table border='1' cellpadding='1' cellspacing='0'>"
         table_end = "</table>"
         header_string = "<tr><th>Node Name</th></tr>"
         table_body = if report_data[organization]["_stale_nodes.json"].empty? || report_data[organization]["_stale_nodes.json"]["count"] == 0

data/lib/chef/knife/tidy_server_clean.rb

@@ -89,6 +89,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.stdout.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|
@@ -115,6 +116,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.stdout.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|

data/lib/chef/knife/tidy_server_report.rb

@@ -43,7 +43,7 @@ class Chef
           nodes = nodes_list(org)
           db_nodes = rest.get("/organizations/#{org}/nodes")
           unless nodes.length == db_nodes.length
-            ood_message = "Search index is out of date! No cleanup action will be taken for #{org}."
+            ood_message = "Search index is out of date (search returned #{nodes.length} nodes while the database indicates there are #{db_nodes.length} nodes! No action will be taken for #{org}. Perhaps a 'chef-server-ctl reindex' is in order?"
             ui.error(ood_message)
             action_needed(ood_message, server_warnings_file_path)
             next
@@ -51,7 +51,7 @@ class Chef
 
           nodes.each do |node|
             # If the node hasn't checked in.
-            if !node["chef_packages"]
+            unless node["chef_packages"]
               # If the node is under an hour old.
               if (Time.now.to_i - node["ohai_time"].to_i) < 3600
                 unconverged_recent_nodes << node["name"]
@@ -207,8 +207,9 @@ class Chef
             else
               versions_not_satisfied.push(v)
             end
+
             if v == cb_list[cb].last
-              ui.warn("Pin of #{cb} #{version} not satisfied by current versions of cookbook: [#{versions_not_satisfied.join(', ')}]")
+              ui.warn("Pin of #{cb} #{version} not satisfied by current versions of cookbook: [#{versions_not_satisfied.join(", ")}]")
             end
           end
         else
@@ -221,6 +222,7 @@ class Chef
         pins.each do |cb, versions|
           versions.each do |version|
             next if version == "<= 0.0.0"
+
             if used_cookbooks[cb]
               # This pinned cookbook is in the used list, now check for a matching version.
               used_cookbooks[cb].each do |v|

data/lib/chef/tidy_acls.rb

@@ -168,6 +168,7 @@ class Chef
         actors_groups = acl_actors_groups(acl)
         actors_groups[:actors].each do |actor|
           next if actor == "pivotal"
+
           if ambiguous_actor?(actor)
             fix_ambiguous_actor(actor)
           elsif missing_from_members?(actor)

data/lib/chef/tidy_common.rb

@@ -12,61 +12,130 @@ class Chef
       @backup_path = ::File.expand_path(backup_path)
     end
 
+    #
+    # @return [Chef::Knife::UI]
+    #
     def ui
       @ui ||= Chef::Knife::UI.new(STDOUT, STDERR, STDIN, {})
     end
 
+    # The path to the users directory in the backup
+    #
+    # @return [String]
+    #
     def users_path
       @users_path ||= ::File.expand_path(::File.join(@backup_path, "users"))
     end
 
+    # The path to the members.json file in the backup
+    #
+    # @param [String] org
+    #
+    # @return [String]
+    #
     def members_path(org)
       ::File.expand_path(::File.join(@backup_path, "organizations", org, "members.json"))
     end
 
+    # The path to the invitations.json file in the backup
+    #
+    # @param [String] org
+    #
+    # @return [String]
+    #
     def invitations_path(org)
       ::File.expand_path(::File.join(@backup_path, "organizations", org, "invitations.json"))
     end
 
+    # The path to the clients directory in the backup
+    #
+    # @param [String] org
+    #
+    # @return [String]
+    #
     def clients_path(org)
       ::File.expand_path(::File.join(@backup_path, "organizations", org, "clients"))
     end
 
+    # The paths to each of the client json files in the backup
+    #
+    # @param [String] org
+    #
+    # @return [Array]
+    #
     def client_names(org)
       Dir[::File.join(clients_path(org), "*")].map { |dir| ::File.basename(dir, ".json") }
     end
 
+    # The path to groups directory in the backup
+    #
+    # @param [String] org
+    #
+    # @return [String]
+    #
     def groups_path(org)
       ::File.expand_path(::File.join(@backup_path, "organizations", org, "groups"))
     end
 
+    # The path to acls directory in the backup
+    #
+    # @param [String] org
+    #
+    # @return [String]
+    #
     def org_acls_path(org)
       ::File.expand_path(::File.join(@backup_path, "organizations", org, "acls"))
     end
 
+    # The path to user_acls directory in the backup
+    #
+    # @return [String]
+    #
     def user_acls_path
       @user_acls_path ||= ::File.expand_path(::File.join(@backup_path, "user_acls"))
     end
 
+    # The path to cookbooks directory in the backup
+    #
+    # @param [String] org
+    #
+    # @return [String]
+    #
     def cookbooks_path(org)
       ::File.expand_path(::File.join(@backup_path, "organizations", org, "cookbooks"))
     end
 
+    # The path to roles directory in the backup
+    #
+    # @param [String] org
+    #
+    # @return [String]
+    #
     def roles_path(org)
       ::File.expand_path(::File.join(@backup_path, "organizations", org, "roles"))
     end
 
+    # The path to the org directory in the backup
+    #
+    # @param [String] org
+    #
+    # @return [String]
+    #
     def org_path(org)
       ::File.expand_path(::File.join(@backup_path, "organizations", org))
     end
 
+    # generate a bogus, but valid email
+    #
+    # @return [String]
+    #
     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(users_path, "#{user['username']}.json"), "w+") do |f|
+      ::File.open(::File.join(users_path, "#{user["username"]}.json"), "w+") do |f|
         f.write(FFI_Yajl::Encoder.encode(user, pretty: true))
       end
     end
@@ -80,10 +149,45 @@ class Chef
       end
     end
 
+    #
+    # Determine the cookbook name from path
+    #
+    # @param [String] path The path of the cookbook.
+    #
+    # @return [String] The cookbook's name
+    #
+    # @example
+    # cookbook_version_from_path('/data/chef_backup/snapshots/20191008040001/organizations/myorg/cookbooks/chef-sugar-5.0.4') => 'chef-sugar'
+    #
     def cookbook_name_from_path(path)
       ::File.basename(path, "-*")
     end
 
+    #
+    # Determine the cookbook version from a path.
+    #
+    # @param [String] path The path of the cookbook.
+    #
+    # @return [String] The version of the cookbook.
+    #
+    # @example
+    # cookbook_version_from_path('/data/chef_backup/snapshots/20191008040001/organizations/myorg/cookbooks/chef-sugar-5.0.4') => '5.0.4'
+    # cookbook_version_from_path('/data/chef_backup/snapshots/20191008040001/organizations/myorg/cookbooks/chef-sugar-5.0.4/recipe/default.rb') => '5.0.4'
+    # cookbook_version_from_path('/data/chef_backup/snapshots/20191008040001/organizations/myorg/cookbooks/chef-sugar-5.0.4/files/cookbooks/default.rb') => '5.0.4'
+    #
+    def cookbook_version_from_path(path)
+      dirs = path.split(File::SEPARATOR)
+
+      until dirs.empty?
+        version_match = dirs[-1].match(/\d+\.\d+\.\d+/)
+        if dirs[-2] == "cookbooks" && version_match # we found the cookbook version not something that looks like one inside a cookbook path
+          return version_match.to_s
+        else
+          dirs.pop
+        end
+      end
+    end
+
     def global_user_names
       @global_user_names ||= Dir[::File.join(@backup_path, "users", "*")].map { |dir| ::File.basename(dir, ".json") }
     end

data/lib/chef/tidy_server.rb

@@ -7,7 +7,7 @@ class Chef
     end
 
     def self.from_chef_server_url(url)
-      url = url.gsub(/\/organizations\/+[^\/]+\/*$/, "")
+      url = url.gsub(%r{/organizations/+[^/]+/*$}, "")
       Chef::Server.new(url)
     end
   end

data/lib/chef/tidy_substitutions.rb

@@ -28,14 +28,7 @@ class Chef
       FileUtils.cp(bp, ::File.join(Dir.pwd, "substitutions.json"))
     end
 
-    def cookbook_version_from_path(path)
-      components = path.split(File::SEPARATOR)
-      name_version = components[components.index("cookbooks") + 1]
-      name_version.match(/\d+\.\d+\.\d+/).to_s
-    end
-
-    def revert
-    end
+    def revert; end
 
     def sub_in_file(path, search, replace)
       temp_file = Tempfile.new("tidy")
@@ -68,7 +61,7 @@ class Chef
             @data[entry][glob].each do |substitution|
               search = Regexp.new(substitution["pattern"])
               replace = substitution["replace"].dup
-              replace.gsub!(/\!COOKBOOK_VERSION\!/) { |_m| "'" + cookbook_version_from_path(file) + "'" }
+              replace.gsub!(/\!COOKBOOK_VERSION\!/) { |_m| "'" + @tidy.cookbook_version_from_path(file) + "'" }
               sub_in_file(file, search, replace)
             end
           end

data/lib/knife-tidy/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knife-tidy
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.6
 platform: ruby
 authors:
 - Jeremy Miller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-02-07 00:00:00.000000000 Z
+date: 2019-12-04 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
@@ -48,8 +48,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Report on stale Chef Server nodes and cookbooks and clean up data integrity