knife-tidy 0.5.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 574027ab3af26d4383f69f812b5d4eb29c6ab51a
-  data.tar.gz: 1b94365fec7c20cd8428873fc30cebc9e3e3fc3d
+  metadata.gz: 4e939b5f2365a5bc785f96d981cb13689a2d2fe8
+  data.tar.gz: 173c5171a7aa7370076f9ffa62d5b5aa0ad57f93
 SHA512:
-  metadata.gz: 422a2d9b1d01215eff25ce18d261a144dd05dac39b1097baae5ba1c685135b1555449fd92b970adec770b72535d8c6c8405adfad35e0c60ea221e51326aba158
-  data.tar.gz: 691b7f8399fb3cd3f6edb0ebd9c77a6c3b5a7685b19110200e94b568f4340f04bf075a2e59f1b18e28fb71227c00c2951e5a03651a1162be9b32f26983e0381e
+  metadata.gz: 63f3d78e8a54eaf7ebebbc68a60d3dc929abac189631e1d08d47cc856d6a51e366c1cf3b0e24223430ca9883bfb50cc6a2aff8325e84ff8c016189d34c25e268
+  data.tar.gz: 2c9fdce8962ee8e7dcbebc780733d40e3dc4297dfc6542b2367b4718f01837543e9cbff6566be7c5f89af7a93c5c1299243a68072a55a1391e236a561767dcb5

data/.travis.yml

@@ -11,9 +11,8 @@ before_install:
   - rm -f .bundle/config
 
 rvm:
-  - 2.2.7
-  - 2.3.4
-  - 2.4.1
+  - 2.3.5
+  - 2.4.2
   - ruby-head
 
 matrix:

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Change Log
 
+## [0.6.0](https://github.com/chef-customers/knife-tidy/tree/0.6.0) (2017-10-23)
+[Full Changelog](https://github.com/chef-customers/knife-tidy/compare/0.5.2...0.6.0)
+
+**Merged pull requests:**
+
+- fix travis [\#51](https://github.com/chef-customers/knife-tidy/pull/51) ([jeremymv2](https://github.com/jeremymv2))
+- Add knife tidy notify command [\#50](https://github.com/chef-customers/knife-tidy/pull/50) ([jonlives](https://github.com/jonlives))
+- bump to 0.5.2 [\#49](https://github.com/chef-customers/knife-tidy/pull/49) ([jeremymv2](https://github.com/jeremymv2))
+
 ## [0.5.2](https://github.com/chef-customers/knife-tidy/tree/0.5.2) (2017-10-20)
 [Full Changelog](https://github.com/chef-customers/knife-tidy/compare/0.5.1...0.5.2)
 

data/README.md

@@ -111,6 +111,46 @@ knife tidy backup clean --backup-path backups/ --gsub-file substitutions.json
 }
 ```
 
+## $ knife tidy notify
+
+The ```knife tidy notify```command is used to send a summary of the reports generated by ```knife tidy server report``` to your organisation admins.
+
+When run from the directory containing your reports, it will iterate through the reports for each organisation in turn, and query the Chef server specified in your ```knife.rb``` for all admins of that organisation.
+
+It will then generate a summary email from your knife tidy reports, and email it to all admins for that organisation.
+
+This command assumes you have access to an SMTP server you can use for sending outgoing emails.
+
+## Options
+
+  * `--smtp_server `:
+    The SMTP Server to use (defaults to localhost)
+  * `--smtp_port `:
+       The SMTP Port to be used (defaults to 25)  
+  * `--smtp_username `:
+       The SMTP Username to be used
+  * `--smtp_password `:
+       The SMTP Password to be used
+  * `--smtp_from `:
+       The From email address to be used when sending email reports
+  * `--smtp_enable_tls `:
+       Whether or not to enable TLS when sending reports via SMTP (defaults to false)            
+  * `--smtp_helo `:
+     The SMTP HELO to be used (defaults to localhost)
+
+Run the following example before attempting the `knife ec backup restore` operation:
+```bash
+$> knife tidy notify --smtp_server smtp.myserver.com --smtp_port 587  --smtp_from myuser@myserver.com --smtp_username myuser --smtp_password mypassword --smtp_use_tls
+
+Reading from /home/myuser/knife_tidy/reports directory
+Fetching report data for organisation mytestorg
+  Parsing file /home/myuser/knife_tidy/reports/mytestorg_unused_cookbooks.json
+  Parsing file /home/myuser/knife_tidy/reports/mytestorg_cookbook_count.json
+  Parsing file /home/myuser/knife_tidy/reports/mytestorg_stale_nodes.json
+Fetching admins users for organisation mytestorg
+Sending email reports for organisation mytestorg
+```
+
 ## Summary and Credits
 
   * Server Report was ported from Nolan Davidson's [chef-cleanup](https://github.com/nsdavidson/chef-cleanup)

data/lib/chef/knife/tidy_notify.rb

@@ -0,0 +1,171 @@
+require 'chef/knife/tidy_base'
+
+class Chef
+  class Knife
+    class TidyNotify < Knife
+
+      deps do
+        require 'ffi_yajl'
+        require 'net/smtp'
+      end
+
+      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 organisation 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 organisation 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 organisation 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 organisation admins'
+
+      option :smtp_password,
+             :long => '--smtp_password SMTP_PASSWORD',
+             :description => 'SMTP Password to be used for emailling reports to organisation admins'
+
+      option :smtp_from,
+             :long => '--smtp_from SMTP_FROM',
+             :description => 'SMTP From address to be used for emailling reports to organisation 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 organisation admins (defaults to false if omitted)'
+
+
+      include Knife::TidyBase
+
+      def run
+
+        reports_dir = tidy.reports_dir
+
+        reports_files = Dir["#{reports_dir}/*"]
+
+
+        ui.info "Reading from #{tidy.reports_dir} directory"
+
+        report_file_suffixes = ["_unused_cookbooks.json", "_cookbook_count.json", "_stale_nodes.json"]
+
+        # Fetch list of organisation names from reports directory
+        org_names = reports_files.map{|r_file|r_file.split("/").last.split("_").first}.sort.uniq
+
+        reports = {}
+
+        # Iterate through list of collected organisations and parse any report files into JSON objects
+
+        org_names.each do |org|
+          ui.info("Fetching report data for organisation #{org}")
+          reports[org] = {}
+          report_file_suffixes.each do |report|
+            begin
+              file_name = "#{reports_dir}/#{org}#{report}"
+              ui.info("  Parsing file #{file_name}")
+              json_string = File.read(file_name)
+              reports[org][report] = FFI_Yajl::Parser.parse( json_string)
+            rescue Errno::ENOENT
+              ui.info("    Skipping file #{file_name} - not found for organisation #{org}")
+              reports[org][report] = {}
+            end
+          end
+
+          # Fetch a list of admin users for the current organisation
+          ui.info("Fetching admins users for organisation #{org}")
+          begin
+            admins = org_admins(org)
+            reports[org]['admins'] = admins.map{|name,data| org_user(org,name) unless name == "pivotal"}
+          rescue Net::HTTPServerException
+            ui.info("  Cannot fetch admin users for organisation #{org} as it does not exist on the server")
+          end
+
+          # Build list of email recipients from the collected admin users (display name and email address of each)
+          email_recipients = reports[org]['admins'].map{|admin|{name: admin['display_name'], email: admin['email']} unless admin.nil?}.compact
+
+          # Send a report email to all admin users of the organisation
+          ui.info "Sending email reports for organisation #{org}"
+          email_content = generate_email(reports,org, email_recipients)
+          send_email(email_content,email_recipients)
+        end
+
+
+
+      end
+
+      private
+
+      def generate_email(report_data,organisation, recipients)
+        message = <<MESSAGE_END
+From: Knife Tidy <#{config[:smtp_from]}>
+To: #{recipients.map{|recipient|"#{recipient[:name]} <#{recipient[:email]}>"}.join(", ")}
+Content-type: text/html
+Subject: Knife Tidy Cleanup Report for Organisation "#{organisation}"
+
+The following report was generated by <a href="https://github.com/chef-customers/knife-tidy">knife-tidy</a>, and contains a list of unused cookbooks and stale nodes for the Chef server organisation "#{organisation}"
+#{generate_cookbook_table(report_data,organisation)}
+<br>
+#{generate_node_table(report_data,organisation)}
+MESSAGE_END
+
+        message
+      end
+
+      def generate_cookbook_table(report_data, organisation)
+
+        table_start = "<h2>Unused Cookbooks</h2><p>This table contains cookbook names and versions that are not currently in the runlists of any nodes.<p><table border='1' cellpadding='1' cellspacing='0'>"
+        table_end = "</table>"
+        if !report_data[organisation]['_unused_cookbooks.json'].empty?
+          header_string = "<tr><th>Cookbook Name</th><th>Unused Versions</th></tr>"
+          table_body = report_data[organisation]['_unused_cookbooks.json'].map{|cookbook_name,cookbook_versions|"<tr><td>#{cookbook_name}</td><td>#{cookbook_versions.join("<br>")}</td></tr>"}.join("\n")
+        else
+          header_string = "<tr><th>Cookbook Name</th><th>Unused Version Count</th></tr>"
+          table_body = report_data[organisation]['_cookbook_count.json'].map{|cookbook_name,cookbook_count|"<tr><td>#{cookbook_name}</td><td>#{cookbook_count}</td></tr>"}.join("\n")
+        end
+        table_start + header_string + table_body + table_end
+      end
+
+      def generate_node_table(report_data,organisation)
+        table_start = "<h2>Stale Nodes</h2><p>This table contains nodes that have not checked in to the Chef Server in #{report_data[organisation]['_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 = report_data[organisation]['_stale_nodes.json']['list'].map{|node_name|"<tr><td>#{node_name}</td></tr>"}.join("\n")
+        table_start + header_string + table_body + table_end
+      end
+
+      def send_email(mail_content,recipients)
+        smtp = Net::SMTP.new(config[:smtp_server],config[:smtp_port])
+        smtp.enable_starttls if config[:smtp_use_tls]
+        smtp.start(config[:smtp_helo],config[:smtp_username],config[:smtp_password],:login) do |server|
+          server.send_message(mail_content, config[:smtp_from], recipients.map{|recipient|recipient[:email]})
+        end
+      end
+
+      def org_admins(org)
+        admins = {}
+        rest.get("/organizations/#{org}/groups/admins")["users"].each do |name|
+          admins[name] = {}
+        end
+        admins
+      end
+
+      def org_user(org,username)
+        rest.get("/organizations/#{org}/users/#{username}")
+      end
+    end
+  end
+end

data/lib/knife-tidy/version.rb

@@ -1,4 +1,4 @@
 module KnifeTidy
-  VERSION = '0.5.2'
+  VERSION = '0.6.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.5.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Jeremy Miller
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-10-20 00:00:00.000000000 Z
+date: 2017-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -114,6 +114,7 @@ files:
 - knife-tidy.gemspec
 - lib/chef/knife/tidy_backup_clean.rb
 - lib/chef/knife/tidy_base.rb
+- lib/chef/knife/tidy_notify.rb
 - lib/chef/knife/tidy_server_clean.rb
 - lib/chef/knife/tidy_server_report.rb
 - lib/chef/tidy_acls.rb