knife-chef-inventory 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 821a3a3d6b510e3a2292ca574a4972a5a8e9af95
+  data.tar.gz: 255a4a617f603efac37fbc73a91d03adf5bef53f
+SHA512:
+  metadata.gz: 632d621835f7c68c5da9a30452a24cfdb13dce823b2cd051efa06cfef0d8fec50d08b8c164732775e518a8f7bfb5c6e2424ae8cd0197d57f83f909d61c0921bd
+  data.tar.gz: d4936c0476f9f7c923a4b9bf650d701440de1a44dc8ca04acb51729f3fe279bfbbc927e005a89b134bcf1af0839846bfc38e723214e5848053a2170f56b5d1fe

data/.codeclimate.yml

@@ -0,0 +1,22 @@
+---
+engines:
+  rubocop:
+    enabled: true
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+  fixme:
+    enabled: true
+  markdownlint:
+    enabled: true
+ratings:
+  paths:
+  - "lib/**"
+  - "**.rb"
+  - "*.md"
+  - "Rakefile"
+exclude_paths:
+- "Gemfile"
+- "*.gemspec"

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+pkg/
+*.gem

data/.rubocop.yml

@@ -0,0 +1,10 @@
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+Metrics/MethodLength:
+  Max: 12
+Metrics/LineLength:
+  Max: 100
+  AllowHeredoc: true
+  AllowURI: true
+Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,12 @@
+sudo: false
+branches:
+  only:
+    - master
+cache: bundler
+language: ruby
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+script:
+  - bundle exec rake travis

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2016 Brent Montague
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,9 @@
+[![Travis branch](https://img.shields.io/travis/bigbam505/knife-chef-inventory/master.svg?style=flat-square)](https://travis-ci.org/bigbam505/knife-chef-inventory)
+[![Code Climate](https://img.shields.io/codeclimate/github/bigbam505/knife-chef-inventory.svg?style=flat-square)](https://codeclimate.com/github/bigbam505/knife-chef-inventory)
+[![Gemnasium](https://img.shields.io/gemnasium/bigbam505/knife-chef-inventory.svg?style=flat-square)](https://gemnasium.com/github.com/bigbam505/knife-chef-inventory)
+
+Knife Chef Inventory
+=======================
+
+The main purpose of this knife plugin is to find objects that are not being used
+on the chef server so they can be cleaned up

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task travis: [:rubocop]
+
+task default: [:rubocop]

data/knife-chef-inventory.gemspec

@@ -0,0 +1,24 @@
+$LOAD_PATH.push File.expand_path("../lib", __FILE__)
+require "knife-chef-inventory/version"
+
+Gem::Specification.new do |s|
+  s.name        = "knife-chef-inventory"
+  s.version     = Knife::ChefInventory::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = "Brent Montague"
+  s.email       = "brent@bmontague.com"
+  s.homepage    = "https://github.com/bigbam505/knife-chef-inventory"
+  s.summary     = "Chef Knife plugin to help cleanup outdated cookbooks"
+  s.description = "A knife plugin to see cookbooks that can be deleted"
+
+  s.license     = "Apache License, v2.0"
+
+  s.files         = `git ls-files`.split("\n")
+  s.require_paths = ["lib"]
+
+  s.add_dependency "chef", "~> 12.0"
+
+  s.add_development_dependency "bundler", "~> 1.6"
+  s.add_development_dependency "rake", "~> 11.1"
+  s.add_development_dependency "rubocop", "~> 0.38"
+end

data/lib/chef/knife/inventory_chef_client.rb

@@ -0,0 +1,81 @@
+require "chef/knife"
+
+class Chef
+  class Knife
+    class InventoryChefClient < Knife
+      banner "knife inventory chef_client"
+
+      deps do
+        require "chef/search/query"
+        require "chef/knife/search"
+      end
+
+      def run
+        @client_version = name_args[0]
+
+        if @client_version
+          output_version_analysis
+        else
+          output_analysis
+        end
+      end
+
+      attr_reader :client_version
+
+      private
+
+      attr_writer :client_version
+
+      def all_nodes
+        @all_nodes ||= search_nodes("chef_packages_chef_version:*")
+      end
+
+      def client_version_nodes
+        @client_version_nodes ||= search_nodes("chef_packages_chef_version:#{@client_version}")
+      end
+
+      def search_nodes(query)
+        Chef::Search::Query.new.search(:node, query).first
+      end
+
+      def client_usage_per_version
+        version_map = Hash.new(0)
+        all_nodes.each do |node|
+          version = node.chef_packages.chef.version
+
+          version_map[version] += 1
+        end
+
+        version_map
+      end
+
+      def all_versions
+        @all_versions ||= client_usage_per_version.keys.uniq.sort
+      end
+
+      def analyze_version(version)
+        client_usage = client_usage_per_version[version]
+        return unless  client_usage
+
+        ui.info "#{version} is used by #{client_usage} hosts" if client_usage > 0
+      end
+
+      def time_since(timestamp)
+        (Time.now - Time.at(timestamp)).to_i / 60
+      end
+
+      def output_version_analysis
+        ui.info "Client Versions being used"
+        client_version_nodes.sort_by(&:ohai_time).each do |node|
+          ui.info "#{node.name} - #{time_since(node.ohai_time)} Minutes"
+        end
+      end
+
+      def output_analysis
+        all_versions.each do |version|
+          analyze_version(version)
+        end
+      end
+    end
+  end
+end

data/lib/chef/knife/inventory_cookbook.rb

@@ -0,0 +1,127 @@
+require "chef/knife"
+
+class Chef
+  class Knife
+    class InventoryCookbook < Knife
+      banner "knife inventory cookbook"
+
+      deps do
+        require "chef/search/query"
+        require "chef/knife/search"
+        require "chef/cookbook_version"
+        require "chef/environment"
+      end
+
+      option :env_constraints, short: "-c",
+                               long: "--env-constraints",
+                               description: "Show any environment constraints",
+                               boolean: true,
+                               default: false
+
+      def run
+        @cookbook_name = name_args[0]
+        @cookbook_version = name_args[1]
+        @show_env_constraints = config[:env_constraints]
+
+        unless @cookbook_name
+          ui.error "You need to specify a cookbook"
+          exit 1
+        end
+
+        if @cookbook_version
+          output_version_analysis
+        else
+          output_analysis
+        end
+      end
+
+      attr_reader :cookbook_name
+      attr_reader :cookbook_version
+
+      private
+
+      attr_writer :cookbook_name
+      attr_writer :cookbook_version
+
+      def cookbook_nodes
+        @cookbook_nodes ||= search_nodes("cookbooks_#{@cookbook_name}:*")
+      end
+
+      def cookbook_version_nodes
+        @cookbook_version_nodes ||=
+          search_nodes("cookbooks_#{@cookbook_name}_version:#{@cookbook_version}")
+      end
+
+      def environment_versions
+        unless @environment_versions
+          @environment_versions = {}
+          Chef::Environment.list.each do |env_name, _url|
+            env = Chef::Environment.load(env_name)
+            if env.cookbook_versions[@cookbook_name]
+              @environment_versions[env.name] = env.cookbook_versions[@cookbook_name]
+            end
+          end
+        end
+
+        @environment_versions
+      end
+
+      def search_nodes(query)
+        Chef::Search::Query.new.search(:node, query).first
+      end
+
+      def all_cookbook_versions
+        @all_cookbook_versions ||= Chef::CookbookVersion.available_versions(@cookbook_name).sort
+      end
+
+      def cookbook_usage_per_version
+        version_map = Hash.new(0)
+        cookbook_nodes.each do |node|
+          version = node.cookbooks[@cookbook_name].version
+
+          version_map[version] += 1
+        end
+
+        version_map
+      end
+
+      def total_cookbook_usage
+        cookbook_nodes.length
+      end
+
+      def analyze_version(version)
+        cookbook_usage = cookbook_usage_per_version[version]
+        if cookbook_usage
+          ui.info "#{version} is used by #{cookbook_usage} hosts" if cookbook_usage > 0
+        end
+      end
+
+      def analyze_environments
+        ui.info "Environment Version Constraints for #{@cookbook_name}"
+        environment_versions.each do |env, constraint|
+          ui.info "#{env} - #{constraint}"
+        end
+      end
+
+      def time_since(timestamp)
+        (Time.now - Time.at(timestamp)).to_i / 60
+      end
+
+      def output_version_analysis
+        ui.info "Cookbook Versions being used for #{@cookbook_name}"
+        cookbook_version_nodes.sort_by(&:ohai_time).each do |node|
+          ui.info "#{node.name} - #{time_since(node.ohai_time)} Minutes"
+        end
+      end
+
+      def output_analysis
+        ui.info "Total Nodes using Cookbook: #{total_cookbook_usage}"
+        all_cookbook_versions.each do |version|
+          analyze_version(version)
+        end
+
+        analyze_environments if @show_env_constraints && environment_versions.any?
+      end
+    end
+  end
+end

data/lib/knife-chef-inventory/version.rb

@@ -0,0 +1,5 @@
+module Knife
+  module ChefInventory
+    VERSION = "0.0.1".freeze
+  end
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: knife-chef-inventory
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brent Montague
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.38'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.38'
+description: A knife plugin to see cookbooks that can be deleted
+email: brent@bmontague.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- knife-chef-inventory.gemspec
+- lib/chef/knife/inventory_chef_client.rb
+- lib/chef/knife/inventory_cookbook.rb
+- lib/knife-chef-inventory/version.rb
+homepage: https://github.com/bigbam505/knife-chef-inventory
+licenses:
+- Apache License, v2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Chef Knife plugin to help cleanup outdated cookbooks
+test_files: []