knife-pinnings 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a0b94a3ccd1734401c8be4e7c0c03cff2b2402d2
-  data.tar.gz: 2901f932dcc37602e9755a336b742368f2fc552c
+  metadata.gz: 6a2699df0d80bdc794dd6fa4dd7ab5cd68b348b2
+  data.tar.gz: 028a425d3c3a9b10636d3e2b05a2f15d7869044e
 SHA512:
-  metadata.gz: 2457459da364e27ee43226b151d2fb7dea2957e355c82695b21453e7bc5cc9724cac747d9cd32eddc1d0842ce8202a2a5a0f10495aeaddc506039a0d0c5c3bc4
-  data.tar.gz: 75fc85d6d67f0d7caee9dcd5bc7f21abd0a62b26958239adc0cd0a1edccadcce07b2602aa033b157a5f3bb0c92697e72eafaf32c4c1ff0c8934aeb206e9352b1
+  metadata.gz: 480d615869421a930ffd2d62dbb467004ec02964f2603d748733c27c990b7fe55440ed055413b141d8c81f549b550ec634047356b66671bf837e6b2a5793bd59
+  data.tar.gz: 87642ab2bddcc41a0d010a69b31adbcaf6ca26ec7f210e04077c4aac2db6505023ecfc13d6131d935c6c7cea3ead5b93a5351965447856e020997ab313df24e6

data/.rubocop.yml

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

data/CHANGELOG.md

@@ -9,6 +9,14 @@ Given a version xx.yy.zz
 * 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.2
+* Use variable column spacing in grid (reduces width of grid)
+
+## 1.1.1
+* Fix documentation to show regex options
+* Fix regex processing for display in pinnings wipe
+* Fix banner text to display regex options
+
 ## 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

data/README.md

@@ -1,9 +1,8 @@
 # knife-pinnings
 
-[![Gem Version](https://badge.fury.io/rb/knife-pinnings.svg)](http://badge.fury.io/rb/knife-pinnings)
-
 This gem extends Chef's knife command to manage version pinnings in your Chef environments
 
+* Set a cookbook pinning explicitly or by using metadata.rb
 * Get a list of all pinnings in all environments
 * Compare pinnings across multiple environments
 * Promote pinnings between environments
@@ -16,17 +15,26 @@ Pretty standard stuff....
 
 ## Usage
 
-A lot of `knife pinning` commands use the power of ruby's REGEX matching for flexible matching of environment and cookbook names.
+A lot of knife-pinnings commands use ruby's regular expressions flexible filtering.
+
+* You can learn about regular expressions here <http://www.tutorialspoint.com/ruby/ruby_regular_expressions.htm>
+* You can try out regular expressions in this editor <http://rubular.com>
+* Wildcards in regular expressions may need to be wrapped in single quotes to hide them from shell globbing.
+
+### Set pinnings
+To explicitly specify the cookbook name and version
+
+	$ knife pinnings set <environment> <cookbook> <version>
 
-* 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
+To take the name and version from the metadata.rb in the current directory use
 
-### Getting a list of pinnings in multiple environments
+	$ knife pinnings set <environment>
+
+
+### List pinnings
 In general you can use
-```bash
-$ knife pinnings list ['environment_regex'] ['cookbook_regex']
-```
+
+	$ knife pinnings list ['environment_regex'] ['cookbook_regex']
 
 To find cookbooks begining with app_ in any environment
 
@@ -40,8 +48,8 @@ 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.
+### Compare pinnings
+To get a color coded comparison grid showing what's pinned in different environments
 
     knife pinnings compare ['environmnet_regex'] ['cookbook_regex']
 
@@ -49,14 +57,14 @@ To compare the versions of skunk app cookbooks in dev, acceptance and production
 
     knife pinnings compare '(^dev$|^acceptance$|^production$)' '^skunk_app.*'
 
-### Promoting pinnings between environments
-Promote pinnings from one environment to another.
+### Promote pinnings
+Promote pinnings from one environment to another (eg. from acceptance to pre-prod).
 
     knife pinnings promote ENV1 ENV2 ['cookbook_regex']
 
 NOTE: Pinnings which are missing in the source environment will NOT be deleted from the target.
 
-### Wiping pinnings in an environment
+### Wipe pinnings
 
 To wipe pinnings in a single environment
 

data/knife-pinnings.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Knife::Pinnings::VERSION
   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.summary       = 'Chef knife plugin to set, list, compare, copy and delete cookbook pinnings across environments'
+  spec.description   = 'Chef knife plugin to set, list, compare, copy and delete cookbook pinnings across environments'
   spec.homepage      = 'https://github.com/trickyearlobe/knife-pinnings'
   spec.license       = 'Apache 2.0'
 
@@ -24,8 +24,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'bundler', '~> 1.7'
   spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop'
   spec.add_development_dependency 'guard'
   spec.add_development_dependency 'guard-rake'
   spec.add_development_dependency 'guard-shell'
-  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'guard-rubocop'
 end

data/lib/chef/knife/pinnings_compare.rb

@@ -17,7 +17,7 @@ class Chef
     # 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']"
+      banner 'knife pinnings compare [ENV_REGEX] [COOKBOOK_REGEX]'
 
       def run
         environment_regex = "#{name_args[0] || '.*'}"

data/lib/chef/knife/pinnings_list.rb

@@ -17,7 +17,7 @@ class Chef
     # This class implements knife pinnings list ['environment_regex'] ['cookbook_regex']
     class PinningsList < Chef::Knife
       require 'chef/knife/pinnings_mixin'
-      banner "knife pinnings list ['environment_regex'] ['cookbook_regex']"
+      banner 'knife pinnings list [ENVIRONMENT_REGEX] [COOKBOOK_REGEX]'
 
       def run
         environment_regex = "#{name_args[0] || '.*'}"

data/lib/chef/knife/pinnings_mixin.rb

@@ -17,7 +17,7 @@ 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
+# This method takes an array of environments and filters them using a REGEX
 def filter_environments(environments, environment_regex)
   filtered_environments = []
   environments.each do |name, environment|
@@ -39,7 +39,7 @@ def display_pinnings_table(environments, cookbook_regex)
   ui.msg(
     ui.list(
       build_pinnings_table(environments, cookbook_regex),
-      :columns_across,
+      :uneven_columns_across,
       environments.length + 1
     )
   )
@@ -100,5 +100,5 @@ def display_cookbooks(cookbooks, cookbook_regex)
   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
+  ui.msg(ui.list(rows, :uneven_columns_across, 2)) if rows.length > 0
 end

data/lib/chef/knife/pinnings_promote.rb

@@ -17,7 +17,7 @@ class Chef
     # This class copies cookbook pinnings between environments
     class PinningsPromote < Chef::Knife
       require 'chef/knife/pinnings_mixin'
-      banner "knife pinnings promote <SOURCE_ENV> <TARGET_ENV> ['cookbook_regex']"
+      banner 'knife pinnings promote SOURCE_ENV TARGET_ENV [COOKBOOK_REGEX]'
 
       def run
         unless name_args.length > 1

data/lib/chef/knife/pinnings_set.rb

@@ -0,0 +1,59 @@
+# 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 PinningsSet < Chef::Knife
+      banner 'knife pinnings set ENVIRONMENT [COOKBOOK VERSION]'
+
+      def run
+        case name_args.length
+        when 1 # Just environment was specified so get name/version from metadata
+          @metadata = Chef::Cookbook::Metadata.new
+          @metadata.from_file(File.join(Dir.pwd,'metadata.rb'))
+          @cookbook_name    = @metadata.name
+          @cookbook_version = @metadata.version
+        when 3 # Environment, Cookbook and Version explicitly specified so use those
+          @cookbook_name    = name_args[1]
+          @cookbook_version = name_args[2]
+        else
+          ui.fatal('You must specify ENVIRONMENT (to take COOKBOOK/VERSION from matadata.rb) or ENVIRONMENT COOKBOOK VERSION')
+          exit 255
+        end
+        @environment_name   = name_args[0]
+        @environment = Environment.load(@environment_name)
+
+        cookbook_data = rest.get_rest("/cookbooks/#{@cookbook_name}").to_hash
+        cookbook_version_exists = false
+        cookbook_data[@cookbook_name]['versions'].each do |item|
+          cookbook_version_exists = true if item['version'] == @cookbook_version
+        end
+
+        unless cookbook_version_exists
+          ui.fatal("Cookbook #{@cookbook_name} version #{@cookbook_version} is not on Chef server. Cannot pin in #{@environment_name}")
+          exit 127
+        end
+
+        if @environment.cookbook_versions[@cookbook_name]
+          ui.info("Existing pinning for #{@cookbook_name} in #{@environment_name } #{@environment.cookbook_versions[@cookbook_name]}")
+        end
+
+        ui.info("Pinning #{@cookbook_name} to version #{@cookbook_version} in #{@environment_name}")
+        @environment.cookbook_versions[@cookbook_name] = "= #{@cookbook_version}"
+        @environment.save
+      end
+    end
+  end
+end

data/lib/chef/knife/pinnings_wipe.rb

@@ -17,7 +17,7 @@ class Chef
     # 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']"
+      banner 'knife pinnings wipe ENVIRONMENT [COOKBOOK_REGEX]'
 
       def run
         if name_args.length < 1
@@ -31,17 +31,16 @@ class Chef
         ui.msg('')
         ui.confirm("Do you want to wipe cookbooks in #{environment.name}")
         ui.msg('')
-        wipe(environment,cookbook_regex)
+        wipe(environment, cookbook_regex)
       end
 
       def wipe(environment, cookbook_regex)
-        environment.cookbook_versions.delete_if do |name,version|
+        environment.cookbook_versions.delete_if do |name, _|
           name =~ /#{cookbook_regex}/
         end
         environment.save
         ui.msg('Done')
       end
-
     end
   end
 end

data/lib/knife-pinnings/version.rb

@@ -15,7 +15,7 @@
 # rubocop:disable Style/Documentation
 module Knife
   module Pinnings
-    VERSION = '1.1.1'
+    VERSION = '1.2.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.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Richard Nixon
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-23 00:00:00.000000000 Z
+date: 2015-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.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'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -109,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: guard-rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -122,8 +136,8 @@ dependencies:
     - - ">="
       - !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.
+description: Chef knife plugin to set, list, compare, copy and delete cookbook pinnings
+  across environments
 email:
 - richard.nixon@btinternet.com
 executables: []
@@ -143,6 +157,7 @@ files:
 - lib/chef/knife/pinnings_list.rb
 - lib/chef/knife/pinnings_mixin.rb
 - lib/chef/knife/pinnings_promote.rb
+- lib/chef/knife/pinnings_set.rb
 - lib/chef/knife/pinnings_wipe.rb
 - lib/knife-pinnings/version.rb
 homepage: https://github.com/trickyearlobe/knife-pinnings
@@ -165,10 +180,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.1
+rubygems_version: 2.4.4
 signing_key: 
 specification_version: 4
-summary: Extend Chef's Knife command to list, compare, promote and wipe pinnings across
-  environments
+summary: Chef knife plugin to set, list, compare, copy and delete cookbook pinnings
+  across environments
 test_files: []
 has_rdoc: