knife-spork 0.1.0 → 0.1.4

data/README.md

@@ -2,6 +2,78 @@
 
 A workflow plugin for Chef::Knife which helps multiple devs work on the same chef server and repo without treading on eachothers toes. This plugin was designed around the workflow we have here at Etsy, where several people are working on the chef repo and chef server at the same time. It contains several functions, documented below:
 
+# Installation
+
+## SCRIPT INSTALL
+
+Copy spork-* script from lib/chef/knife/spork-*.rb to your ~/.chef/plugins/knife directory.
+
+## GEM INSTALL
+knife-spork is available on rubygems.org - if you have that source in your gemrc, you can simply use:
+
+````
+gem install knife-spork
+````
+
+# Spork Configuration
+
+Out of the box, knife spork will work with no configuration. However, you can optionally enable several features to enhance it's functionality.
+
+Knife Spork will look for it's config file in the following locations, in ascending order of precedence.
+
+* <chef-repo>/config/spork-config.yml
+* /etc/spork-config.yml
+* ~/.chef/spork-config.yml
+
+Anything set in the config file in your home directory for example, will override options set in your chef repo or /etc.
+
+Below is a sample config file with all supported options enabled below, followed by an explanation of each section.
+
+````
+git:
+  enabled: true
+irccat:
+  enabled: true
+  server: irccat.mycompany.com
+  port: 12345
+  channel: "#chef"
+graphite:
+  enabled: true
+  server: graphite.mycompany.com
+  port: 2003
+gist:
+  enabled: true
+  in_chef: true
+  chef_path: cookbooks/gist/files/default/gist
+  path: /usr/bin/gist
+default_environments: [ production, development ]
+````
+## Git
+
+This section enables a couple of git commands which will run as part of your spork workflow, namely:
+
+* When you bump a cookbook's version, the relevant metadata.rb file will be git added
+* When you promote an environment, git pull will be run before your changes are made.
+
+## Irccat
+
+If you're using the irccat (https://github.com/RJ/irccat) irc bot, this lets you post notifications to the channel of your choice. It currently notifies on
+
+* When a cookbook is uploaded using spork upload
+* When  an environment is promoted to the server using promote --remote
+
+## Graphite
+
+This lets you send to a graphite metric when promote --remote is performed. It send to the metric deploys.chef.<environment>
+	
+## Gist
+
+This allows you to generate an optional gist of environment changes which will be added to irccat notifications on promote --remote. It supports the https://rubygems.org/gems/gist, and contains two parameters to use a version in your chef repo, or a version installed somewhere else locally.
+
+## Default Environments
+
+This allows you to specify a default list of environments you want to promote changes to. If this option is configured and you *ommit* the environment parameter when promoting, ie knife spork promote <cookbook>, then it will promote to all environments in this list.
+
 # Spork Check
 
 This function is designed to help you avoid trampling on other people's cookbook versions, and to make sure that when you come to version your own work it's easy to see what version numbers have already been used and if the one you're using will overwrite anything.
@@ -9,9 +81,11 @@ This function is designed to help you avoid trampling on other people's cookbook
 ## Usage 
 
 ````
-knife spork check COOKBOOK
+knife spork check COOKBOOK ( --all)
 ````
 
+By default, spork check only shows the 5 most recent remote cookbook versions. Add the --all option if you want to see everything.
+
 ## Example (Checking an Unfrozen Cookbook with version clash)
 
 ````
@@ -20,7 +94,7 @@ Checking versions for cookbook apache...
  
 Current local version: 0.1.0
  
-Remote versions:
+Remote versions (Max. 5 most recent only):
 *0.1.0, unfrozen
 0.0.0, unfrozen
  
@@ -37,7 +111,7 @@ Checking versions for cookbook apache2...
  
 Current local version: 1.0.6
  
-Remote versions:
+Remote versions (Max. 5 most recent only):
 *1.0.6, frozen
 1.0.5, frozen
 1.0.4, frozen
@@ -59,7 +133,7 @@ Checking versions for cookbook apache2...
  
 Current local version: 1.0.7
  
-Remote versions:
+Remote versions (Max. 5 most recent only):
 1.0.6, frozen
 1.0.5, frozen
 1.0.4, frozen

data/knife-spork.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'knife-spork'
-  s.version           = '0.1.0'
-  s.date              = '2012-01-28'
+  s.version           = '0.1.4'
+  s.date              = '2012-02-03'
   s.rubyforge_project = 'knife-spork'
 
   ## Make sure your summary is short. The description may be as long
@@ -42,6 +42,7 @@ Gem::Specification.new do |s|
   ## that are needed for an end user to actually USE your code.
   s.add_dependency('chef', [">= 0.10.4"])
   s.add_dependency('git', [">= 1.2.5"])
+  s.add_dependency('app_conf', [">= 0.3.0"])
 
   ## Leave this section as-is. It will be automatically generated from the
   ## contents of your Git repository via the gemspec task. DO NOT REMOVE

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

@@ -6,6 +6,7 @@
 # Based on the knife-cookbook-bump plugin by:
 # Alalanta (no license specified)
 
+require 'app_conf'
 require 'chef/knife'
 require 'chef/cookbook_loader'
 require 'chef/cookbook_uploader'
@@ -28,9 +29,30 @@ module KnifeSpork
 
     def run
 
-      bump_type=""
-
+      if RUBY_VERSION.to_f < 1.9
+        ui.fatal "Sorry, knife-spork requires ruby 1.9 or newer."
+        exit 1
+      end
+      
       self.config = Chef::Config.merge!(config)
+
+      if File.exists?("#{config[:cookbook_path].first.gsub("cookbooks","")}config/spork-config.yml")
+        AppConf.load("#{config[:cookbook_path].first.gsub("cookbooks","")}config/spork-config.yml")
+        ui.msg "Loaded config file #{config[:cookbook_path].first.gsub("cookbooks","")}config/spork-config.yml...\n\n"
+      end
+      
+      if File.exists?("/etc/spork-config.yml")
+        AppConf.load("/etc/spork-config.yml")
+        ui.msg "Loaded config file /etc/spork-config.yml...\n\n"
+      end
+    
+      if File.exists?(File.expand_path("~/.chef/spork-config.yml"))
+        AppConf.load(File.expand_path("~/.chef/spork-config.yml"))
+        ui.msg "Loaded config file #{File.expand_path("~/.chef/spork-config.yml")}...\n\n"
+      end
+        
+      bump_type=""
+      
       if config.has_key?(:cookbook_path)
         cookbook_path = config["cookbook_path"]
       else
@@ -73,12 +95,13 @@ module KnifeSpork
           patch(cookbook_path, cookbook, patch_type)
       end
 
-      if !@@gitavail
-          ui.msg "Git gem not available, skipping git add.\n\n"
-      else
-          git_add(cookbook)
+      if !AppConf.git.nil? && AppConf.git.enabled
+        if !@@gitavail
+            ui.msg "Git gem not available, skipping git add.\n\n"
+        else
+            git_add(cookbook)
+        end
       end
-
     end
 
 
@@ -145,13 +168,13 @@ module KnifeSpork
           ui.msg "Git add'ing #{path}cookbooks/#{cookbook}/metadata.rb\n\n"
           g.add("#{path}cookbooks/#{cookbook}/metadata.rb")
         rescue ArgumentError => e
-          puts "Git Error: The root of your chef repo doesn't look like it's a git repo. Skipping git add...\n\n"
+          ui.warn "Git: The root of your chef repo doesn't look like it's a git repo. Skipping git add...\n\n"
         rescue
-          puts "Git Error: Something went wrong, Dumping log info..."
-          puts "#{strio.string}"
+          ui.warn "Git: Cookbook uploaded, but something went wrong with git add metadata.rb, Dumping log info..."
+          ui.warn "#{strio.string}"
         end
       end
-     end
+    end
   end
 
 end

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

@@ -4,6 +4,7 @@
 # License:: GPL
 
 
+require 'app_conf'
 require 'json'
 require 'chef/knife'
 require 'chef/cookbook_loader'
@@ -17,11 +18,36 @@ module KnifeSpork
          require 'chef/cookbook_version'
     end
     banner "knife spork check COOKBOOK"
-
+    
+    option :all,
+      :short => "--a",
+      :long => "--all",
+      :description => "Show all uploaded versions of the cookbook"
+    
     def run
 
+      if RUBY_VERSION.to_f < 1.9
+        ui.fatal "Sorry, knife-spork requires ruby 1.9 or newer."
+        exit 1
+      end
+      
       self.config = Chef::Config.merge!(config)
 
+      if File.exists?("#{config[:cookbook_path].first.gsub("cookbooks","")}config/spork-config.yml")
+        AppConf.load("#{config[:cookbook_path].first.gsub("cookbooks","")}config/spork-config.yml")
+        ui.msg "Loaded config file #{config[:cookbook_path].first.gsub("cookbooks","")}config/spork-config.yml...\n\n"
+      end
+      
+      if File.exists?("/etc/spork-config.yml")
+        AppConf.load("/etc/spork-config.yml")
+        ui.msg "Loaded config file /etc/spork-config.yml...\n\n"
+      end
+    
+      if File.exists?(File.expand_path("~/.chef/spork-config.yml"))
+        AppConf.load(File.expand_path("~/.chef/spork-config.yml"))
+        ui.msg "Loaded config file #{File.expand_path("~/.chef/spork-config.yml")}...\n\n"
+      end
+
       if config.has_key?(:cookbook_path)
         cookbook_path = config["cookbook_path"]
       else
@@ -63,7 +89,11 @@ module KnifeSpork
       api_endpoint  = env ? "environments/#{env}/cookbooks/#{cookbook}" : "cookbooks/#{cookbook}"
       cookbooks = rest.get_rest(api_endpoint)
       versions = cookbooks[cookbook]["versions"]
-      return versions
+      if config[:all]
+        return versions
+      else
+        return versions[0..4]
+      end
     end
 
     def check_versions(cookbook, local_version, remote_versions)
@@ -74,7 +104,11 @@ module KnifeSpork
       ui.msg ""
       ui.msg "Current local version: #{local_version}"
       ui.msg ""
-      ui.msg "Remote versions:"
+      if config[:all]
+        ui.msg "Remote versions:"
+      else
+        ui.msg "Remote versions (Max. 5 most recent only):"
+      end
       remote_versions.each do |v|
 
         version_frozen = check_frozen(cookbook,v["version"])

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

@@ -25,8 +25,10 @@
 # limitations under the License.
 #
 
+require 'app_conf'
 require 'chef/knife'
 require 'json'
+require 'socket'
 
 module KnifeSpork
   class SporkPromote < Chef::Knife
@@ -57,49 +59,91 @@ module KnifeSpork
         :default => nil
 
       def run
+        
+        if RUBY_VERSION.to_f < 1.9
+          ui.fatal "Sorry, knife-spork requires ruby 1.9 or newer."
+          exit 1
+        end
+        
+        self.config = Chef::Config.merge!(config)
+
+        if File.exists?("#{config[:cookbook_path].first.gsub("cookbooks","")}config/spork-config.yml")
+          AppConf.load("#{config[:cookbook_path].first.gsub("cookbooks","")}config/spork-config.yml")
+          ui.msg "Loaded config file #{config[:cookbook_path].first.gsub("cookbooks","")}config/spork-config.yml...\n\n"
+        end
+      
+        if File.exists?("/etc/spork-config.yml")
+          AppConf.load("/etc/spork-config.yml")
+          ui.msg "Loaded config file /etc/spork-config.yml...\n\n"
+        end
+      
+        if File.exists?(File.expand_path("~/.chef/spork-config.yml"))
+          AppConf.load(File.expand_path("~/.chef/spork-config.yml"))
+          ui.msg "Loaded config file #{File.expand_path("~/.chef/spork-config.yml")}...\n\n"
+        end
+        
         config[:cookbook_path] ||= Chef::Config[:cookbook_path]
 
-        if @name_args.empty?
+        if @name_args.empty? && AppConf.default_environments.nil?
           show_usage
           ui.error("You must specify a cookbook name and an environment")
           exit 1
-        elsif @name_args.size != 2
+        elsif @name_args.empty? && !AppConf.default_environments.nil?
+          show_usage
+          ui.error("Default environments loaded from config, but you must specify a cookbook name")
+          exit 1
+        elsif @name_args.size != 2 && AppConf.default_environments.nil?
           show_usage
           ui.error("You must specify a cookbook name and an environment")
           exit 1
         end
-
-        if !@@gitavail
-            ui.msg "Git gem not available, skipping git pull.\n\n"
-        else
-            git_pull_if_repo
-        end
-
-        @cookbook = @name_args[1]
-        @environment = loader.load_from("environments", @name_args[0] + ".json")
-
-        if @cookbook == "all"
-          ui.msg "Promoting ALL cookbooks to environment #{@environment}\n\n"
-          cookbook_names = get_all_cookbooks
-          cookbook_names.each do |c|
-            @environment = promote(@environment, c)
+        
+        if !AppConf.git.nil? && AppConf.git.enabled
+          if !@@gitavail
+              ui.msg "Git gem not available, skipping git pull.\n\n"
+          else
+              git_pull_if_repo
           end
+        end
+        
+        if AppConf.default_environments.nil?
+            environments = [ @name_args[0] ]
+            @cookbook = @name_args[1]
+        elsif !AppConf.default_environments.nil? && @name_args.size == 2
+            environments = [ @name_args[0] ]
+            @cookbook = @name_args[1]
         else
-          @environment = promote(@environment, @cookbook)
+            environments = AppConf.default_environments
+            @cookbook = @name_args[0]
         end
+        
+        environments.each do |e|
+              ui.msg ""
+              ui.msg "Environment: #{e}"
+              @environment = loader.load_from("environments", "#{e}.json")
 
-        ui.msg "\nSaving changes into #{@name_args[0]}.json"
-        new_environment_json = pretty_print(@environment)
-        save_environment_changes(@name_args[0],new_environment_json)
+              if @cookbook == "all"
+                ui.msg "Promoting ALL cookbooks to environment #{@environment}"
+                cookbook_names = get_all_cookbooks
+                cookbook_names.each do |c|
+                  @environment = promote(@environment, c)
+                end
+              else
+                @environment = promote(@environment, @cookbook)
+              end
 
-        if config[:remote]
-          ui.msg "\nUploading #{@name_args[0]} to server"
-          save_environment_changes_remote(@name_args[0] + ".json")
-          ui.info "\nPromotion complete, and environment uploaded."
-        else
-          ui.info "\nPromotion complete! Please remember to upload your changed Environment file to the Chef Server."
-        end
+              ui.msg "Saving changes into #{e}.json"
+              new_environment_json = pretty_print(@environment)
+              save_environment_changes(e,new_environment_json)
 
+              if config[:remote]
+                ui.msg "Uploading #{e} to server"
+                save_environment_changes_remote("#{e}.json")
+                ui.info "\nPromotion complete, and environment uploaded."
+              else
+                ui.info "\nPromotion complete! Please remember to upload your changed #{e}.json to the Chef Server."
+              end
+        end
       end
 
       def update_version_constraints(environment,cookbook,version_constraint)
@@ -147,7 +191,39 @@ module KnifeSpork
       def save_environment_changes_remote(environment)
           @loader ||= Knife::Core::ObjectLoader.new(Chef::Environment, ui)
           updated = loader.load_from("environments", environment)
+          
+          env_server = Chef::Environment.load(environment.gsub(".json","")).to_hash["cookbook_versions"]
+          env_local = updated.to_hash["cookbook_versions"]
+          env_diff = env_server.diff(env_local)
+            
           updated.save
+
+          if !AppConf.gist.nil? && AppConf.gist.enabled
+            if AppConf.gist.in_chef
+              gist_path = AppConf.gist.chef_path
+            else
+              gist_path = AppConf.gist.path
+            end
+            
+            msg = "Environment #{environment.gsub(".json","")} uploaded at #{Time.now.getutc} by #{ENV['USER']}\n\nConstraints updated on server in this version:\n\n#{env_diff.collect { |k, v| "#{k}: #{v}\n" }.join}"
+            @gist = %x[ echo "#{msg}" | #{gist_path}]
+          end
+          
+          if !AppConf.irccat.nil? && AppConf.irccat.enabled
+            message = "#{AppConf.irccat.channel} CHEF: #{ENV['USER']} uploaded environment #{environment.gsub(".json","")} #{@gist}"
+            s = TCPSocket.open(AppConf.irccat.server,AppConf.irccat.port)
+            s.write(message)
+            s.close
+          end
+            
+            
+          if !AppConf.graphite.nil? && AppConf.graphite.enabled
+            time = Time.now
+            message = "deploys.chef.#{environment.gsub(".json","")} 1 #{time.to_i}\n"
+            s = TCPSocket.open(AppConf.graphite.server,AppConf.graphite.port)
+            s.write(message)
+            s.close
+          end
       end
 
       def save_environment_changes(environment,envjson)
@@ -211,10 +287,10 @@ module KnifeSpork
             ui.msg "Pulling latest changes from git\n\n"
             g.pull
           rescue ArgumentError => e
-            puts "Git Error: The root of your chef repo doesn't look like it's a git repo. Skipping git pull...\n\n"
+            ui.warn "Git: The root of your chef repo doesn't look like it's a git repo. Skipping git pull...\n\n"
           rescue
-            puts "Git Error: Something went wrong, Dumping log info..."
-            puts "#{strio.string}"
+            ui.warn "Git: Something went wrong with git pull, Dumping log info..."
+            ui.warn "#{strio.string}"
           end
         end
      end
@@ -226,3 +302,14 @@ module KnifeSpork
          !!(self =~ /^[-+]?[0-9]+$/)
       end
   end
+  
+class Hash
+  def diff(other)
+    self.keys.inject({}) do |memo, key|
+      unless self[key] == other[key]
+        memo[key] = "#{self[key]} changed to #{other[key]}"
+      end
+      memo
+    end
+  end
+end

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

@@ -25,7 +25,9 @@
 # limitations under the License.
 #
 
+require 'app_conf'
 require 'chef/knife'
+require 'socket'
 
 module KnifeSpork
   class SporkUpload < Chef::Knife
@@ -64,6 +66,29 @@ module KnifeSpork
         :description => "Also upload cookbook dependencies"
 
       def run
+        
+        if RUBY_VERSION.to_f < 1.9
+          ui.fatal "Sorry, knife-spork requires ruby 1.9 or newer."
+          exit 1
+        end
+      
+        self.config = Chef::Config.merge!(config)
+
+        if File.exists?("#{config[:cookbook_path].first.gsub("cookbooks","")}config/spork-config.yml")
+          AppConf.load("#{config[:cookbook_path].first.gsub("cookbooks","")}config/spork-config.yml")
+          ui.msg "Loaded config file #{config[:cookbook_path].first.gsub("cookbooks","")}config/spork-config.yml...\n\n"
+        end
+      
+        if File.exists?("/etc/spork-config.yml")
+          AppConf.load("/etc/spork-config.yml")
+          ui.msg "Loaded config file /etc/spork-config.yml...\n\n"
+        end
+      
+        if File.exists?(File.expand_path("~/.chef/spork-config.yml"))
+          AppConf.load(File.expand_path("~/.chef/spork-config.yml"))
+          ui.msg "Loaded config file #{File.expand_path("~/.chef/spork-config.yml")}...\n\n"
+        end
+      
         config[:cookbook_path] ||= Chef::Config[:cookbook_path]
 
         assert_environment_valid!
@@ -88,10 +113,19 @@ module KnifeSpork
               end
             end
             ui.info("Uploading and freezing #{cookbook.name.to_s.ljust(justify_width + 10)} [#{cookbook.version}]")
+            
             upload(cookbook, justify_width)
             cookbook.freeze_version
             upload(cookbook, justify_width)
             version_constraints_to_update[cookbook_name] = cookbook.version
+                    
+            if !AppConf.irccat.nil? && AppConf.irccat.enabled
+              message = "#{AppConf.irccat.channel} CHEF: #{ENV['USER']} uploaded and froze cookbook #{cookbook_name} version #{cookbook.version}"
+              s = TCPSocket.open(AppConf.irccat.server,AppConf.irccat.port)
+              s.write(message)
+              s.close
+            end
+
           rescue Chef::Exceptions::CookbookNotFoundInRepo => e
             ui.error("Could not find cookbook #{cookbook_name} in your cookbook path, skipping it")
             Chef::Log.debug(e)

data/lib/knife-spork.rb

@@ -1,3 +1,3 @@
 module KnifeSpork
-  VERSION = "0.1.0"
+  VERSION = "0.1.4"
 end

metadata

@@ -1,45 +1,76 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: knife-spork
-version: !ruby/object:Gem::Version
-  version: 0.1.0
-  prerelease: 
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 4
+  version: 0.1.4
 platform: ruby
-authors:
+authors: 
 - Jon Cowie
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-28 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-02-03 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: chef
-  requirement: &70176180960680 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 10
+        - 4
         version: 0.10.4
   type: :runtime
-  prerelease: false
-  version_requirements: *70176180960680
-- !ruby/object:Gem::Dependency
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: git
-  requirement: &70176180960200 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 5
         version: 1.2.5
   type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: app_conf
   prerelease: false
-  version_requirements: *70176180960200
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 0
+        version: 0.3.0
+  type: :runtime
+  version_requirements: *id003
 description: A workflow plugin to help many devs work with the same chef repo/server
 email: jonlives@gmail.com
 executables: []
+
 extensions: []
-extra_rdoc_files:
+
+extra_rdoc_files: 
 - README.md
-files:
+files: 
 - README.md
 - Rakefile
 - knife-spork.gemspec
@@ -48,29 +79,37 @@ files:
 - lib/chef/knife/spork-promote.rb
 - lib/chef/knife/spork-upload.rb
 - lib/knife-spork.rb
+has_rdoc: true
 homepage: https://github.com/jonlives/knife-spork
 licenses: []
+
 post_install_message: 
-rdoc_options:
+rdoc_options: 
 - --charset=UTF-8
-require_paths:
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: knife-spork
-rubygems_version: 1.8.15
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 2
 summary: A workflow plugin to help many devs work with the same chef repo/server
 test_files: []
+