knife-pinnings 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fad73dc4dc80eb17bbc31b2cffb3647c3f084a9f
-  data.tar.gz: 37a0e9b6cc2d728d0079dc030cb1680368ecb349
+  metadata.gz: bf68c9548eb98813a8cb2fe8de5d266ffb86761e
+  data.tar.gz: f7bc67ff850f3cd9c2f6d1e22af2d2602253eb1e
 SHA512:
-  metadata.gz: 5ffca73f91c63a63211adec18ecbd07bfb39ba8cf9433bb7c9311b4d5c94d8cd7648c0fd1cc71764045cc6b6c3f9e150207c4e352e21d8c1a877fa74fb75a134
-  data.tar.gz: c388344c6e338e5a8d6024b3cc09f6df3656c8d5da640f50b9b0bff16712eeef6b0c8a8f1696d898cb887b192edb60359a05b8b4ed6cc1fcd79a4b2b13a9c918
+  metadata.gz: 9a1aea8c107c53e875a1c00c1ba44d8cd010b9cc474686b7dcd09032b5a1b7243b95d20143e8746abf2c187b30ff4c62e0a559b9e6d6212d5d24f62f181ab3e2
+  data.tar.gz: ee2b9a24077acc3683fab6e9a444fcb4eaccfe8b68ec293f938b08b5e929ad6831a70f1d47f033ae9f42ced597c1e41c74ed961429e7bf2deb4382c322d7b48d

data/.rubocop.yml

@@ -0,0 +1,9 @@
+# In these days of widescreen TV and big monitors
+# a line length of 80 sounds a bit unreasonable
+Metrics/LineLength:
+  Max: 120
+
+# Actually, I don't like hash rockets as they look untidy
+# If Rubocop doesn't use them in the config file, why should I ?
+Style/HashSyntax:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+## Change log for knife-pinnings
+
+This GEM is versioned according to "Semantic versioning".
+More information at <http://semver.org/>
+
+Given a version xx.yy.zz
+
+* A change in zz is a bug fix
+* A change in yy is a non-breaking change (usually a new feature)
+* A change in zz is a major change which likely breaks stuff that depends on us.
+
+## 1.1.0
+* Improved performance by using search instead of iteration to get environment detail.
+* Added support for comparing pinnings between environments with color highlighting
+* Added support for promoting pinnings between environments
+* Added support for regex based wiping pinnings in a single environment
+* Stop Rubocop whining about code formatting and complexity
+
+## 1.0.0
+* Initial release to view pinnings in different Chef environments
+* REGEX support for filtering lists of environments and cookbooks

data/Guardfile

@@ -0,0 +1,16 @@
+# rubocop:disable Style/RegexpLiteral
+
+guard :rubocop do
+  watch(%r{.+\.rb$})
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end
+
+guard :shell do
+  watch(/.*/) { `git add --all` }
+end
+
+guard 'rake', :task => 'install' do
+  watch(%r{^lib/.*\.rb})
+  watch(%r{^.*\.gemspec})
+  watch(%r{^Gemfile$})
+end

data/README.md

@@ -1,37 +1,38 @@
 # knife-pinnings
 
-This gem extends Chef's knife command to view cookbook pinnings in all your different chef environments
+[![Gem Version](https://badge.fury.io/rb/knife-pinnings.svg)](http://badge.fury.io/rb/knife-pinnings)
 
-## Installation
-
-Add this line to your application's Gemfile:
-
-
-    gem 'knife-pinnings'
-
-And then execute:
+This gem extends Chef's knife command to manage version pinnings in your Chef environments
 
-    $ bundle
+* Get a list of all pinnings in all environments
+* Compare pinnings across multiple environments
+* Promote pinnings between environments
+* Wipe pinnings from environments
 
-Or install it yourself as:
+## Installation
+Pretty standard stuff....
 
     $ gem install knife-pinnings
 
 ## Usage
 
-The knife-pinnings plugin uses ruby (PCRE) regex for environment and cookbook filtering
-
-    $ knife pinnings list ['cookbook_regex'] ['environment_regex']
+A lot of `knife pinning` commands use the power of ruby's REGEX matching for flexible matching of environment and cookbook names.
 
-Note: It can take a long time to get results if you have a lot of environments as `knife pinnings` has to make individual API requests to get details on each environment.
+* You can try out REGEX expressions in this editor <http://rubular.com>
+* You can learn about ruby REGEX here <http://www.tutorialspoint.com/ruby/ruby_regular_expressions.htm>
+* REGEX with wildcards may need to be wrapped in single quotes to hide them from the shell
 
+### Getting a list of pinnings in multiple environments
+In general you can use
+```bash
+$ knife pinnings list ['environment_regex'] ['cookbook_regex']
+```
 
-To find cookbooks begining with app_
-(Note the use of '' around wildcards to prevent interpretation by the shell)
+To find cookbooks begining with app_ in any environment
 
     $ knife pinnings '.*' '^app_.*'
 
-To find cookbooks in production with names beginning with app_
+To find cookbooks beginning with app_ but only in production
 
     $ knife pinnings list '^production$' '^app_.*$'
 
@@ -39,6 +40,33 @@ To find cookbooks in acceptance or production with names beginning with app_
 
     $ knife pinnings list '(^accept.*|^production$)' '^app_.*'
 
+### Comparing environments
+To get a color coded comparison grid showing whats not up to date and whats missing.
+
+    knife compare ENV1 ENV2
+
+
+### Promoting pinnings between environments
+Promote pinnings from one environment to another.
+
+    knife pinnings promote ENV1 ENV2
+
+NOTE: Pinnings which are missing in the source environment will NOT be deleted from the target.
+
+### Wiping pinnings in an environment
+
+To wipe pinnings in a single environment
+
+    knife pinnings wipe ENVIRONMENT ['cookbook_regex']
+
+To wipe the pinnings from development
+
+    knife pinnings wipe development
+
+To wipe my skunk app cookbooks from development
+
+    knife pinnings wipe development '^skunk_app.*'
+
 ## Contributing
 
 1. Fork it ( <https://github.com/trickyearlobe/knife-pinnings/fork> )

data/Rakefile

@@ -7,12 +7,14 @@ Bundler::GemHelper.install_tasks
 
 task :default => :spec
 
-desc "Run specs"
+desc 'Run specs'
 RSpec::Core::RakeTask.new(:spec) do |spec|
   spec.pattern = 'spec/**/*_spec.rb'
 end
 
-gem_spec = eval(File.read("knife-pinnings.gemspec"))
+# rubocop:disable Lint/Eval
+gem_spec = eval(File.read('knife-pinnings.gemspec'))
+# rubocop:enable Lint/Eval
 
 RDoc::Task.new do |rdoc|
   rdoc.rdoc_dir = 'rdoc'

data/knife-pinnings.gemspec

@@ -4,22 +4,28 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'knife-pinnings/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "knife-pinnings"
+  spec.name          = 'knife-pinnings'
   spec.version       = Knife::Pinnings::VERSION
-  spec.authors       = ["Richard Nixon"]
-  spec.email         = ["richard.nixon@btinternet.com"]
-  spec.summary       = %q{Extends Chef's knife command to view cookbook pinnings across multiple environments.}
-  spec.description   = %q{Extends Chef's knife command to view cookbook pinnings across multiple environments.}
-  spec.homepage      = "https://github.com/trickyearlobe/knife-pinnings"
-  spec.license       = "Apache 2.0"
+  spec.authors       = ['Richard Nixon']
+  spec.email         = ['richard.nixon@btinternet.com']
+  spec.summary       = 'Extend Chef\'s Knife command to list, compare, promote and wipe pinnings across environments'
+  spec.description   = 'List, compare, promote or wipe pinnings across chef environments. Some commands use REGEX matches to do bulk pinning work.'
+  spec.homepage      = 'https://github.com/trickyearlobe/knife-pinnings'
+  spec.license       = 'Apache 2.0'
 
   spec.files         = `git ls-files -z`.split("\x0")
+  spec.require_paths = ['lib']
+
+  # rubocop:disable Style/RegexpLiteral
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
 
-  spec.add_dependency "chef", ">=11.10.4"
-  spec.add_development_dependency "rspec"
-  spec.add_development_dependency "bundler", "~> 1.7"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_dependency 'chef', '>=11.10.4'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-rake'
+  spec.add_development_dependency 'guard-shell'
+  spec.add_development_dependency 'rubocop'
 end

data/lib/chef/knife/pinnings_compare.rb

@@ -0,0 +1,30 @@
+# Copyright 2015 Richard Nixon
+#
+# 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.
+
+class Chef
+  class Knife
+    # This class implements knife pinnings list ['environment_regex'] ['cookbook_regex']
+    class PinningsCompare < Chef::Knife
+      require 'chef/knife/pinnings_mixin'
+      banner "knife pinnings compare ['environment_regex'] ['cookbook_regex']"
+
+      def run
+        environment_regex = "#{name_args[0] || '.*'}"
+        cookbook_regex = "#{name_args[1] || '.*'}"
+        environments = filter_environments(Environment.list(true), environment_regex)
+        display_pinnings_table(environments, cookbook_regex)
+      end
+    end
+  end
+end

data/lib/chef/knife/pinnings_list.rb

@@ -14,38 +14,17 @@
 
 class Chef
   class Knife
+    # This class implements knife pinnings list ['environment_regex'] ['cookbook_regex']
     class PinningsList < Chef::Knife
-
-      banner "knife pinnings list [environment_regex] [cookbook_regex]"
+      require 'chef/knife/pinnings_mixin'
+      banner "knife pinnings list ['environment_regex'] ['cookbook_regex']"
 
       def run
-        rest = Chef::REST.new(Chef::Config[:chef_server_url])
         environment_regex = "#{name_args[0] || '.*'}"
         cookbook_regex = "#{name_args[1] || '.*'}"
-
-        # Grab a list of environments from Chef and iterate through them
-        environments = rest.get_rest("/environments").to_hash
-        environments.each do |env_name,env_url|
-          
-          # Did the user want to see this environment?
-          if (env_name =~ /#{environment_regex}/ )
-
-            # If so grab the environment detail and display it
-            env_detail = rest.get_rest("/environments/#{env_name}").to_hash
-            ui.msg(ui.color("Environment: #{env_name}", :yellow))
-
-            # Iterate through the pinnings in this environment
-            env_detail['cookbook_versions'].each do |cookbook_name,cookbook_version|
-
-              # Did the user want to see this cookbook pinning?
-              if (cookbook_name =~ /#{cookbook_regex}/)
-                ui.msg("  #{cookbook_name} #{cookbook_version}")
-              end
-            end
-            
-          end
-        end
+        environments = filter_environments(Environment.list(true), environment_regex)
+        display_environments(environments, cookbook_regex)
       end
     end
   end
-end
+end

data/lib/chef/knife/pinnings_mixin.rb

@@ -0,0 +1,104 @@
+# Copyright 2015 Richard Nixon
+#
+# 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.
+
+# This method strips the = off Chef "= xxx.yyy.zzz" versions numbers
+def version_strip(version_string)
+  version_string.match(/()[0-9]*\.[0-9]*\.[0-9]*/).to_s
+end
+
+# This method takes an array of environments and filters then using a REGEX
+def filter_environments(environments, environment_regex)
+  filtered_environments = []
+  environments.each do |name, environment|
+    filtered_environments << environment  if name =~ /#{environment_regex}/
+  end
+  filtered_environments
+end
+
+def filter_cookbooks(cookbooks, cookbook_regex)
+  filtered_cookbooks = []
+  cookbooks.each do |name, version|
+    filtered_cookbooks << [name, version] if name =~ /#{cookbook_regex}/
+  end
+  filtered_cookbooks
+end
+
+# This method generates a color coded table of cookbook versions across environments
+def display_pinnings_table(environments, cookbook_regex)
+  ui.msg(
+    ui.list(
+      build_pinnings_table(environments, cookbook_regex),
+      :columns_across,
+      environments.length + 1
+    )
+  )
+end
+
+def build_pinnings_table(environments, cookbook_regex)
+  cookbooks = {}
+
+  # Get the cookbooks into a sparse hash of hashes
+  environments.each do |environment|
+    environment.cookbook_versions.each do |name, version|
+      if name =~ /#{cookbook_regex}/
+        cookbooks[name] ||= {}
+        cookbooks[name][environment.name] = version_strip(version)
+      end
+    end
+  end
+
+  # Make a grid header
+  cookbooks_grid = ['']
+  environments.each do |environment|
+    cookbooks_grid << environment.name
+  end
+
+  cookbooks.each do |cookbook_name, versions|
+    row = [cookbook_name]
+    environments.each do |environment|
+      row << (versions[environment.name] || '---')
+    end
+    row = add_color(row)
+    cookbooks_grid += row
+  end
+  cookbooks_grid
+end
+
+def add_color(row)
+  # The first element in the row is the cookbook name so skip that
+  row[0] = ui.color(row[0], :white)
+  row_color = 'green'
+  row[2..row.size].each do |version|
+    row_color = 'red' unless version == row[1]
+  end
+  for i in 1..row.size - 1
+    row[i] = ui.color(row[i], row_color.to_sym)
+  end
+  row
+end
+
+def display_environments(environments, cookbook_regex)
+  environments.each do |environment|
+    ui.msg(ui.color(environment.name, :yellow))
+    display_cookbooks(environment.cookbook_versions, cookbook_regex)
+  end
+end
+
+def display_cookbooks(cookbooks, cookbook_regex)
+  rows = []
+  filter_cookbooks(cookbooks, cookbook_regex).each do |name, version|
+    rows << "  #{name}" << version_strip(version)
+  end
+  ui.msg(ui.list(rows, :columns_across, 2)) if rows.length > 0
+end

data/lib/chef/knife/pinnings_promote.rb

@@ -0,0 +1,48 @@
+# Copyright 2015 Richard Nixon
+#
+# 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.
+
+class Chef
+  class Knife
+    # This class copies cookbook pinnings between environments
+    class PinningsPromote < Chef::Knife
+      require 'chef/knife/pinnings_mixin'
+      banner 'knife pinnings promote <SOURCE_ENV> <TARGET_ENV>'
+
+      def run
+        unless name_args.length > 2
+          ui.fatal('You must specify a source and target environment.')
+          exit 255
+        end
+        source_env = Environment.load(name_args[0])
+        target_env = Environment.load(name_args[1])
+        cookbook_regex = name_args || '.*'
+        display_pinnings_table([source_env, target_env], '.*')
+        copy_pinnings(source_env, target_env)
+      end
+
+      def copy_pinnings(source_env, target_env)
+        ui.msg('')
+        ui.confirm("Do you want to write to #{target_env.name}")
+        ui.msg('')
+
+        source_env.cookbook_versions.each do |name, version|
+          target_env.cookbook_versions[name] = version if name =~ /#{cookbook_regex}/
+        end
+
+        target_env.save
+        ui.msg('Done!')
+      end
+    end
+  end
+end

data/lib/chef/knife/pinnings_wipe.rb

@@ -0,0 +1,47 @@
+# Copyright 2015 Richard Nixon
+#
+# 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.
+
+class Chef
+  class Knife
+    # This class implements knife pinnings list ['environment_regex'] ['cookbook_regex']
+    class PinningsWipe < Chef::Knife
+      require 'chef/knife/pinnings_mixin'
+      banner "knife pinnings wipe ENVIRONMENT ['cookbook_regex']"
+
+      def run
+        if name_args.length < 1
+          ui.fatal('You must specify an environment to wipe (and optionally a cookbook regex)')
+          exit 255
+        end
+        cookbook_regex = name_args[1] || '.*'
+
+        environment = Environment.load(name_args[0])
+        display_environments([environment], cookbook_regex)
+        ui.msg('')
+        ui.confirm("Do you want to wipe cookbooks in #{environment.name}")
+        ui.msg('')
+        wipe(environment,cookbook_regex)
+      end
+
+      def wipe(environment, cookbook_regex)
+        environment.cookbook_versions.delete_if do |name,version|
+          name =~ /#{cookbook_regex}/
+        end
+        environment.save
+        ui.msg('Done')
+      end
+
+    end
+  end
+end

data/lib/knife-pinnings/version.rb

@@ -12,9 +12,10 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# rubocop:disable Style/Documentation
 module Knife
   module Pinnings
-    VERSION = "1.0.0"
+    VERSION = '1.1.0'
     MAJOR, MINOR, TINY = VERSION.split('.')
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: knife-pinnings
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Richard Nixon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-19 00:00:00.000000000 Z
+date: 2015-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
@@ -66,8 +66,64 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: Extends Chef's knife command to view cookbook pinnings across multiple
-  environments.
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-shell
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: List, compare, promote or wipe pinnings across chef environments. Some
+  commands use REGEX matches to do bulk pinning work.
 email:
 - richard.nixon@btinternet.com
 executables: []
@@ -75,12 +131,19 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - knife-pinnings.gemspec
+- lib/chef/knife/pinnings_compare.rb
 - lib/chef/knife/pinnings_list.rb
+- lib/chef/knife/pinnings_mixin.rb
+- lib/chef/knife/pinnings_promote.rb
+- lib/chef/knife/pinnings_wipe.rb
 - lib/knife-pinnings/version.rb
 homepage: https://github.com/trickyearlobe/knife-pinnings
 licenses:
@@ -105,6 +168,7 @@ rubyforge_project:
 rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
-summary: Extends Chef's knife command to view cookbook pinnings across multiple environments.
+summary: Extend Chef's Knife command to list, compare, promote and wipe pinnings across
+  environments
 test_files: []
 has_rdoc: