knife-spork 1.0.17 → 1.2.0

data/CHANGELOG.md

@@ -1,3 +1,30 @@
+## 1.2.0 (26th June, 2013)
+
+Features:
+
+    - StatusNet plugin (Thanks to Tomasz Napierala - https://github.com/zen)
+    - GroveIO plugin (Thanks to Greg Karékinian - https://github.com/gkarekinian)
+    - Configurable irccat message templates (Thanks to Tobias Schmidt - https://github.com/grobie)
+    - Environment Groups - Spork Promote can update multitiple environments at once by specifying the environment group name. (Thanks to Pivotal Casebook - https://github.com/pivotal-casebook)
+
+Bugfixes:
+
+    - Fix spork bump to not change quote style or whitespace (Thanks to Tobias Schmidt - https://github.com/grobie)
+    - Correct Markdown formatting error (Thanks to Jeff Blaine - https://github.com/jblaine)
+    - Fix pretty printing of environments (Thanks to Peter Schultz - https://github.com/pschultz)
+
+## 1.0.17 (15th February, 2013)
+
+Bugfixes:
+
+    - Fix git plugin to work nicely with Cygwin and its unpredictable exit codes
+
+## 1.0.16 (13th February, 2013)
+
+Bugfixes:
+
+    - Reverted broken foodcritic plugin to that in 1.0.14
+
 ## 1.0.15 (12th February, 2013)
 
 Bugfixes:

data/README.md

@@ -38,6 +38,13 @@ Below is a sample config file with all supported options and all shipped plugins
 default_environments:
   - development
   - production
+environment_groups:
+  qa_group:
+    - quality_assurance
+    - staging
+  test_group:
+    - user_testing
+    - acceptance_testing
 version_change_threshold: 2
 environment_path: "/home/me/environments"
 plugins:
@@ -77,6 +84,9 @@ plugins:
 #### Default Environments
 The `default_environments` directive allows you to specify a default list of environments you want to promote changes to. If this option is configured and you *omit* the environment parameter when promoting KnifeSpork will promote to all environments in this list.
 
+#### Environment Groups
+The `environment_groups` directive allows you to specify a list of environments referenced by group names that you want to promote changes to.
+
 #### Version Change Threshold
 The `version_change_threshold` directive allows you to customise the threshold used by a safety check in spork promote which will prompt for confirmation if you're promoting a cookbook by more than version_change_threshold versions. This defaults to 2 if not set, ie promoting a cookbook from v1.0.1 to v 1.0.2 will not trip this check, wheras promoting from v1.0.1 to v1.0.3 will.
 
@@ -195,12 +205,13 @@ knife spork bump COOKBOOK [MAJOR | MINOR | PATCH | MANUAL x.x.x]
 ```text
 $ knife spork bump apache2
 Successfully bumped apache2 to v2.0.4!
+```
 
 #### Example (Bumping patch level)
 ```text
 $ knife spork bump apache2 patch
 Successfully bumped apache2 to v2.0.4!
-````
+```
 
 #### Example (Manually setting version)
 ```text
@@ -225,14 +236,14 @@ Successfully uploaded apache2@1.0.13!
 
 Spork Promote
 -------------
-This function lets you easily set a version constraint in an environment for a particular cookbook. By default it will set the version constraint to whatever the local version of the specified cookbook is. Optionally, you can include a `--version` option which will set the version constraint for the specified cookbook to whatever version number you provide. You might want to use this if, for example, you pushed a version constraint for a cookbook version you don't want your nodes to use anymore, so you want to "roll back" the environment to a previous version. You can also specify the `--remote` option if you'd like to automatically upload your changed local environment file to the server.
+This function lets you easily set a version constraint in an environment or group of environments for a particular cookbook. By default it will set the version constraint to whatever the local version of the specified cookbook is. Optionally, you can include a `--version` option which will set the version constraint for the specified cookbook to whatever version number you provide. You might want to use this if, for example, you pushed a version constraint for a cookbook version you don't want your nodes to use anymore, so you want to "roll back" the environment to a previous version. You can also specify the `--remote` option if you'd like to automatically upload your changed local environment file to the server.
 
-If you don't specify an environment, the default_environments config directive will be used if set.
+If you don't specify an environment or environment group, the default_environments config directive will be used if set.
 
 #### Usage
 
 ```bash
-knife spork promote [ENVIRONMENT] COOKBOOK [--version, --remote]
+knife spork promote [ENVIRONMENT OR ENVIRONMENT GROUP NAME] COOKBOOK [--version, --remote]
 ```
 
 #### Example (Using local cookbook version number)

data/knife-spork.gemspec

@@ -2,7 +2,7 @@ $:.push File.expand_path('../lib', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.name          = 'knife-spork'
-  gem.version       = '1.0.17'
+  gem.version       = '1.2.0'
   gem.authors       = ["Jon Cowie"]
   gem.email         = 'jonlives@gmail.com'
   gem.homepage      = 'https://github.com/jonlives/knife-spork'

data/lib/chef/knife/spork-bump.rb

@@ -11,7 +11,7 @@ module KnifeSpork
 
     def run
       self.config = Chef::Config.merge!(config)
-      
+
       if @name_args.empty?
         show_usage
         ui.error("You must specify at least a cookbook name")
@@ -46,7 +46,7 @@ module KnifeSpork
       new_version = version_array.join('.')
 
       metadata_file = "#{@cookbook.root_dir}/metadata.rb"
-      new_contents = File.read(metadata_file).gsub(/version\s+['"][0-9\.]+['"]/, "version \"#{new_version}\"")
+      new_contents = File.read(metadata_file).gsub(/(version\s+['"])[0-9\.]+(['"])/, "\\1#{new_version}\\2")
       File.open(metadata_file, 'w'){ |f| f.write(new_contents) }
 
       ui.info "Successfully bumped #{@cookbook.name} to v#{new_version}!"

data/lib/chef/knife/spork-promote.rb

@@ -62,7 +62,7 @@ module KnifeSpork
 
         ui.msg "Saving changes to #{e}.json"
 
-        new_environment_json = pretty_print_json(environment)
+        new_environment_json = pretty_print_json(environment.to_hash)
         save_environment_changes(e, new_environment_json)
 
         if config[:remote]

data/lib/knife-spork/plugins/grove.rb

@@ -0,0 +1,41 @@
+require 'knife-spork/plugins/plugin'
+
+module KnifeSpork
+  module Plugins
+    class Grove < Plugin
+      name :grove
+
+      def perform; end
+
+      def after_upload
+        grove <<-EOH
+#{current_user} froze the following cookbooks on Chef Server: #{cookbooks.collect{|c| "#{c.name}@#{c.version}"}.join(', ')}
+        EOH
+      end
+
+      def after_promote_remote
+        grove <<-EOH
+#{current_user} promoted #{cookbooks.collect{|c| "#{c.name}@#{c.version}"}.join(', ')} on #{environments.collect{|e| "#{e.name}"}.join(', ')}
+        EOH
+      end
+
+      private
+      def grove(message)
+        safe_require 'rest_client'
+
+        config.tokens.each do |token|
+          # Grove can't handle multi-line messages, so let's split by line
+          message.split("\n").flatten.delete_if(&:empty?).each do |line|
+            RestClient.post "https://grove.io/api/notice/#{token}/",
+                            :message => line,
+                            :service => 'knife-spork'
+          end
+        end
+      end
+
+      def tokens
+        Array(config.token || config.tokens)
+      end
+    end
+  end
+end

data/lib/knife-spork/plugins/irccat.rb

@@ -5,17 +5,32 @@ module KnifeSpork
     class Irccat < Plugin
       name :irccat
 
+      TEMPLATES = {
+        :upload  => '#BOLD#PURPLECHEF:#NORMAL %{organization}%{current_user} uploaded #TEAL%{cookbooks}#NORMAL',
+        :promote => '#BOLD#PURPLECHEF:#NORMAL %{organization}%{current_user} promoted #TEAL%{cookbooks}#NORMAL to %{environment} %{gist}'
+      }
+
       def perform; end
 
       def after_upload
-        irccat("#BOLD#PURPLECHEF:#NORMAL #{organization}#{current_user} uploaded #TEAL#{cookbooks.collect{ |c| "#{c.name}@#{c.version}" }.join(", ")}#NORMAL")
+        irccat(template(:upload) % {
+          :organization => organization,
+          :current_user => current_user,
+          :cookbooks    => cookbooks.collect { |c| "#{c.name}@#{c.version}" }.join(", ")
+        })
       end
 
       def after_promote_remote
         environments.each do |environment|
           diff = environment_diffs[environment.name]
           env_gist = gist(environment, diff) if config.gist
-          irccat("#BOLD#PURPLECHEF:#NORMAL #{organization}#{current_user} promoted #TEAL#{cookbooks.collect{ |c| "#{c.name}@#{c.version}" }.join(", ")}#NORMAL to #{environment.name} #{env_gist}")
+          irccat(template(:promote) % {
+            :organization => organization,
+            :current_user => current_user,
+            :cookbooks    => cookbooks.collect{ |c| "#{c.name}@#{c.version}" }.join(", "),
+            :environment  => environment.name,
+            :gist         => env_gist
+          })
         end
       end
 
@@ -43,6 +58,10 @@ module KnifeSpork
       def channels
         [ config.channel || config.channels ].flatten
       end
+
+      def template(name)
+        (config.template && config.template[name]) || TEMPLATES[name]
+      end
     end
   end
 end

data/lib/knife-spork/plugins/statusnet.rb

@@ -0,0 +1,38 @@
+require 'knife-spork/plugins/plugin'
+
+module KnifeSpork
+  module Plugins
+    class StatusNet < Plugin
+      name :statusnet
+
+      def perform; end
+
+      def after_upload
+        statusnet "#{organization}#{current_user} uploaded the following cookbooks:\n#{cookbooks.collect{ |c| "  #{c.name}@#{c.version}" }.join("\n")}"
+      end
+
+      def after_promote_remote
+        statusnet "#{organization}#{current_user} promoted the following cookbooks:\n#{cookbooks.collect{ |c| "  #{c.name}@#{c.version}" }.join("\n")} to #{environments.collect{ |e| "#{e.name}" }.join(", ")}"
+      end
+
+      private
+
+      def statusnet(message)
+        safe_require 'curb'
+
+        begin
+          c = Curl::Easy.new(config.url)
+          c.http_auth_types = :basic
+          c.username = config.username
+          c.password = config.password
+          c.post_body = message
+          c.perform
+        rescue Exception => e
+          ui.error 'Something went wrong sending to StatusNet.'
+          ui.error e.to_s
+        end
+      end
+
+    end
+  end
+end

data/lib/knife-spork/runner.rb

@@ -45,15 +45,20 @@ module KnifeSpork
         ensure_environment_provided!
 
         if @name_args.size == 2
-          [ [@name_args[0]].flatten, @name_args[1] ]
+          environments = load_specified_environment_group(@name_args[0])
+          [ environments, @name_args[1] ]
         elsif @name_args.size == 1
           [ [default_environments].flatten, @name_args[0] ]
         end
       end
 
+      def load_specified_environment_group(name)
+        spork_config.environment_groups[name] || [name]
+      end
+
       def ensure_environment_provided!
         if default_environments.empty? && @name_args.size < 2
-          ui.error('You must specify a cookbook name and an environment')
+          ui.error('You must specify an environment or environment group and a cookbook name')
           exit(1)
         end
       end

data/plugins/Grove.md

@@ -0,0 +1,31 @@
+Campfire
+========
+Automatically posts informational messages to Grove.io
+
+Gem Requirements
+----------------
+This plugin requires the following gems:
+
+```ruby
+gem 'rest_client'
+```
+
+Hooks
+-----
+- `after_promote`
+- `after_upload`
+
+Configuration
+-------------
+```yaml
+plugins:
+  grove:
+    tokens:
+      - ABC
+      - XYZ
+```
+
+#### Tokens
+This is an array of tokens (channels) to post messages to.
+
+- Type: `String`

data/plugins/Irccat.md

@@ -21,6 +21,8 @@ plugins:
       - #chef
       - #knife
     gist: "/usr/bin/gist"
+    template:
+          upload: "foo bar! #REDCHEF:#NORMAL %{organization}%{current_user} uploaded #GREEN%{cookbooks}#NORMAL"
 ```
 
 #### server
@@ -41,4 +43,8 @@ The channels to post to.
 #### gist
 Optional path to gist binary installed by https://rubygems.org/gems/gist
 
-- Type: `String`
+- Type: `String`
+
+
+### template
+Optional irccat message template if you want to change the formatting of irccat alerts. Supports overriding alerts for upload and promote

data/plugins/StatusNet.md

@@ -0,0 +1,41 @@
+StatusNet
+=======
+StatusNet posts messages to a your StatusNet instance
+
+Gem Requirements
+----------------
+This plugin requires the following gems:
+
+```ruby
+gem 'curb'
+```
+
+Hooks
+-----
+- `after_upload`
+- `after_promote`
+
+Configuration
+-------------
+```yaml
+plugins:
+  statusnet:
+    url: YOUR INSTANCE API URL
+    username: YOURUSER
+    password: YOURPASSWORD
+```
+
+#### url
+Your StatusNet instance API url, usually server url + /api/statuses/update.xml
+
+- Type: `Srtring`
+
+#### username
+Your StatusNet username.
+
+- Type: `String`
+
+#### password
+Your StatusNet password.
+
+- Type: `String`

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knife-spork
 version: !ruby/object:Gem::Version
-  version: 1.0.17
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-02-15 00:00:00.000000000 Z
+date: 2013-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
@@ -85,20 +85,24 @@ files:
 - lib/knife-spork/plugins/foodcritic.rb
 - lib/knife-spork/plugins/git.rb
 - lib/knife-spork/plugins/graphite.rb
+- lib/knife-spork/plugins/grove.rb
 - lib/knife-spork/plugins/hipchat.rb
 - lib/knife-spork/plugins/irccat.rb
 - lib/knife-spork/plugins/jabber.rb
 - lib/knife-spork/plugins/plugin.rb
+- lib/knife-spork/plugins/statusnet.rb
 - lib/knife-spork/runner.rb
 - plugins/Campfire.md
 - plugins/Eventinator.md
 - plugins/Foodcritic.md
 - plugins/Git.md
 - plugins/Graphite.md
+- plugins/Grove.md
 - plugins/HipChat.md
 - plugins/Irccat.md
 - plugins/Jabber.md
 - plugins/README.md
+- plugins/StatusNet.md
 - plugins/Template.md
 homepage: https://github.com/jonlives/knife-spork
 licenses: []