knife-chef-retention 0.0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a25a99e3516a9ef83aa7115955068b1d0af9d5b8
-  data.tar.gz: b6fd711e7a1517add25d82c0e636a3f23711c1be
+  metadata.gz: 2ff54c639881e87fffe4a593253d850625f5e642
+  data.tar.gz: aaee45b42f3fa620baaa97e2577e612a9fc8f283
 SHA512:
-  metadata.gz: 03ac3a582771b93ad9176fbae82f4f50812b802a736e6e2bb805fe8240ca0fdc603192ab86966f3c32e64ec58a60d89c480eabd923a59263782631f4e081b501
-  data.tar.gz: 69b451dd760fd50c14f2fab297808216b47c54a0e433c39fb9a55b691f92f8523ab60b7a49b98911b44d74e879e0a8bf5044aec680cebd0b868f4f6d2e562e59
+  metadata.gz: a57915b45f7229c37813a8d63425f844354f2421da19db823889885e171369f66d72405501c732b89363d8e38b41fff90c87002a6425f6cb6cab0c37f294ec70
+  data.tar.gz: 07ffeaddb0a8396269e83ecc9120ea4f1b35b930bfad2c491e67dacc3e60cd12e114203fdcaed0c01fa7909e6b8a80a4c6a24b07d693ce594cc66be3da61c37c

data/.rubocop.yml

@@ -8,3 +8,5 @@ Metrics/LineLength:
   AllowURI: true
 Documentation:
   Enabled: false
+Metrics/AbcSize:
+  Max: 18

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+# Change Log
+
+## [v0.2.0](https://github.com/cvent/knife-chef-retention/tree/v0.2.0) (2016-10-03)
+[Full Changelog](https://github.com/cvent/knife-chef-retention/compare/v0.0.1...v0.2.0)
+
+**Merged pull requests:**
+
+- Fix regression when very few cookbook versions exist [\#5](https://github.com/cvent/knife-chef-retention/pull/5) ([brentm5](https://github.com/brentm5))
+- Adds a way to keep old unused versions [\#4](https://github.com/cvent/knife-chef-retention/pull/4) ([brentm5](https://github.com/brentm5))
+- Move the retention command to be under the resource it modifies [\#3](https://github.com/cvent/knife-chef-retention/pull/3) ([brentm5](https://github.com/brentm5))
+- Add the initial destruction of cookbooks out of basic retention [\#1](https://github.com/cvent/knife-chef-retention/pull/1) ([brentm5](https://github.com/brentm5))
+
+## [v0.0.1](https://github.com/cvent/knife-chef-retention/tree/v0.0.1) (2016-09-28)
+
+
+\* *This Change Log was automatically generated by [github_changelog_generator](https://github.com/skywinder/Github-Changelog-Generator)*

data/Gemfile

@@ -2,3 +2,10 @@
 source "https://rubygems.org"
 
 gemspec
+
+group :development do
+  gem "bundler", "~> 1.6"
+  gem "rake", "~> 11.1"
+  gem "rubocop", "~> 0.38"
+  gem "github_changelog_generator", "~> 1.13"
+end

data/README.md

@@ -23,16 +23,36 @@ gem install knife-chef-retention
 ## Usage
 
 Everything suppose to be organized in an easy to navigate way.  Everything is
-nested under `knife inventory` and the commands should be self documenting.
+nested under its corresponding resource.  For example cookbook retentions are
+under `knife cookbook` and the commands should be self documenting.
+
 Below are some simple examples
 
 ```bash
-knife retention
+knife cookbook
+
+** COOKBOOK COMMANDS **
+...
+knife cookbook retention [COOKBOOK] (options)
+...
+
 
-** RETENTION COMMANDS **
-knife retention cookbooks
+knife cookbook retention windows
+Running in Evaluation Mode no cookbooks will be deleted
+Latest Version: 2.0.2
+Unused Version: 1.34.8
+Unused Version: 1.36.0
+...
+Unused Version: 1.38.3
 ```
 
+### Options
+
+ - `--clobber` - This will actually delete cookbooks while prompting
+ - `-y` - This will not ask when deleting cookbooks
+ - `--extra-versions` - Specifies the total number of extra unused versions to keep around (Default 1)
+
+
 License and Author
 ==================
 

data/knife-chef-retention.gemspec

@@ -20,9 +20,4 @@ Gem::Specification.new do |s|
   s.required_ruby_version = "~> 2.3"
 
   s.add_dependency "chef", "~> 12.11"
-
-  s.add_development_dependency "bundler", "~> 1.6"
-  s.add_development_dependency "rake", "~> 11.1"
-  s.add_development_dependency "rubocop", "~> 0.38"
-  s.add_development_dependency "github_changelog_generator", "~> 1.13"
 end

data/lib/chef/knife/retention_cookbook.rb

@@ -3,11 +3,123 @@ require "chef/knife"
 
 class Chef
   class Knife
-    class RetentionCookbook < Knife
-      banner "knife retention cookbook [COOKBOOK] (options)"
+    class CookbookRetention < Knife
+      banner "knife cookbook retention [COOKBOOK] (options)"
+
+      deps do
+        require "chef/search/query"
+        require "chef/knife/search"
+        require "chef/cookbook_version"
+      end
+
+      option :clobber,
+             long: "--clobber",
+             description: "Actually delete cookbooks from the Chef Server forever",
+             boolean: true,
+             default: false
+
+      option :extra_versions,
+             short: "-e VALUE",
+             long: "--extra-versions VALUE",
+             description: "The number of extra versions to keep (Default: 1)",
+             default: 1
 
       def run
-        ui.info "TODO: Implement this"
+        cookbook_name = name_args[0] if name_args.length.positive?
+        clobber = config[:clobber]
+        extra_versions = config[:extra_versions].to_i
+
+        ui.info "Running in Evaluation Mode no cookbooks will be deleted" unless clobber
+        ui.info "Keeping the top #{extra_versions} unused versions" if extra_versions.positive?
+
+        if cookbook_name
+          cleanup_cookbook(cookbook_name, extra_versions, clobber)
+        else
+          cleanup_all_cookbooks(extra_versions, clobber)
+        end
+      end
+
+      private
+
+      def cleanup_all_cookbooks(extra_versions, clobber)
+        Chef::CookbookVersion.list.keys.each do |cookbook_name|
+          ui.info "Evaluating #{cookbook_name}"
+          cleanup_cookbook(cookbook_name, extra_versions, clobber)
+          ui.info ""
+        end
+      end
+
+      def cleanup_cookbook(cookbook, extra_versions, clobber)
+        latest_version = Chef::CookbookVersion.load(cookbook)
+        ui.info "Latest Version: #{latest_version.version}"
+
+        # Lets get all the cookbook versions that we could care less about
+        out_of_retention_cookbooks(cookbook, extra_versions).each do |version|
+          destroy_cookbook_version(cookbook, version[:version], clobber)
+        end
+      end
+
+      def destroy_cookbook_version(cookbook, version, clobber)
+        if clobber
+          delete_object(Chef::CookbookVersion, "#{cookbook} version #{version}", "cookbook") do
+            rest.delete("cookbooks/#{cookbook}/#{version}")
+          end
+        else
+          ui.info "Unused Version: #{version}"
+        end
+      end
+
+      def max_results
+        Chef::Node.list.count || 1000
+      end
+
+      def search_args
+        {
+          rows: max_results,
+          filter_result: {
+            name: ["name"],
+            cookbooks: ["cookbooks"],
+            ohai_time: ["ohai_time"]
+          }
+        }
+      end
+
+      def out_of_retention_cookbooks(cookbook, extra_versions)
+        # get all the version information for the cookbook
+        unused_versions = cookbook_versions(cookbook).take_while do |version|
+          # These are package that are not used and are considered old as they
+          # are after the first used version still
+          version unless version[:used]
+        end
+
+        save_some_versions(unused_versions, extra_versions)
+      end
+
+      def save_some_versions(versions, extra_versions)
+        # Just removes the top X which since we sort is the top X newest versions
+        Array(versions.slice(0, versions.length - extra_versions))
+      end
+
+      def cookbook_versions(cookbook_name)
+        nodes = all_nodes_for_cookbook(cookbook_name)
+        versions = Chef::CookbookVersion.available_versions(cookbook_name).map do |version|
+          used_by_node = nodes.any? { |n| n["cookbooks"][cookbook_name]["version"] == version }
+
+          {
+            version: Chef::Version.new(version),
+            used: used_by_node
+          }
+        end
+
+        versions.sort_by { |v| v[:version] }
+      end
+
+      def search_nodes(query)
+        Chef::Search::Query.new.search(:node, query, search_args).first
+      end
+
+      def all_nodes_for_cookbook(cookbook_name)
+        search_nodes("cookbooks_#{cookbook_name}:*")
       end
     end
   end

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 module Knife
   module ChefRetention
-    VERSION = "0.0.1"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knife-chef-retention
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Brent Montague
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-28 00:00:00.000000000 Z
+date: 2016-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
@@ -24,62 +24,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '12.11'
-- !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'
-- !ruby/object:Gem::Dependency
-  name: github_changelog_generator
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.13'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.13'
 description: A knife plugin to handle deleting of items in a safe manor
 email: bmontague@cvent.com
 executables: []
@@ -91,6 +35,7 @@ files:
 - ".rubocop.yml"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE
 - README.md