knife-sharp 0.2.0 → 0.3.0

data/README.md

@@ -94,6 +94,38 @@ Available servers:
    dev (/home/jamiez/.chef/knife-dev.rb)
 </pre>
 
+## Rollback
+
+Sometimes you need to be able to rollback a change quickly, because failure happens. So knife sharp now creates rollback points of environment constraints.
+
+A picture says a thousand words :
+
+<pre>
+$ knife sharp rollback --list
+Available rollback points :
+  * 1370414322 (Wed Jun 05 08:38:42 +0200 2013)
+  * 1370418655 (Wed Jun 05 09:50:55 +0200 2013)
+  * 1370419966 (Wed Jun 05 10:12:46 +0200 2013)
+  * 1370421569 (Wed Jun 05 10:39:29 +0200 2013)
+$ knife sharp rollback --show 1370421569
+Rollback point has the following informations :
+  environment : production
+  cookbooks versions :
+   * tests => = 0.0.2
+   * varnish => = 0.0.10
+$ knife sharp rollback --to 1370421569
+Rollback point has the following informations :
+  environment : production
+  cookbooks versions :
+   * varnish => = 0.0.10
+   * tests => = 0.0.2
+Continue rollback ? Y/(N) [N] y
+Setting varnish to version = 0.0.10
+Setting tests to version = 0.0.2
+</pre>
+
+The activation of this rollback feature and its storage dir can be configured in your sharp-config.yml file.
+
 # Configuration
 
 Dependencies :
@@ -127,6 +159,17 @@ logging:
 
 It will log uploads, bumps and databags to the standard logger format.
 
+# ZSH completion
+
+want a completion on changing servers ?
+
+<pre>
+alias kss="knife sharp server"
+
+function knife_servers { reply=($(ls .chef/knife-*.rb | sed -r 's/.*knife-([a-zA-Z0-9]+)\.rb/\1/' )); }
+compctl -K knife_servers kss
+</pre>
+
 # Credits
 
 The damn good knife spork plugin from the etsy folks : https://github.com/jonlives/knife-spork
@@ -139,5 +182,5 @@ License
 
 Authors
 ======
-Nicolas Szalay | https://github.com/rottenbytes
-Jonathan Amiez | https://github.com/josqu4red
+* Nicolas Szalay | https://github.com/rottenbytes
+* Jonathan Amiez | https://github.com/josqu4red

data/ext/sharp-config.yml

@@ -14,3 +14,6 @@ notification:
 # key is the name of your server (in a knife sharp server sense)
 sandboxnico:
   ignore_cookbooks: [ "tests" ]
+rollback:
+  enabled: true
+  destination: "/home/nico/.chef/sharp/rollbacks/"

data/lib/chef/knife/sharp-align.rb

@@ -8,7 +8,7 @@ module KnifeSharp
 
     [:cookbooks, :databags, :roles].each do |opt|
       option opt,
-        :short => "-#{opt.to_s[0].upcase}",
+        :short => "-#{opt.to_s[0,1].upcase}",
         :long => "--#{opt}-only",
         :description => "sync #{opt} only",
         :default => false
@@ -187,8 +187,14 @@ module KnifeSharp
       unless @cookbooks.empty?
         env = Chef::Environment.load(@environment)
         cbs = Array.new
+        backup_data = Hash.new
+        backup_data["environment"] = @environment
+        backup_data["cookbook_versions"] = Hash.new
         @cookbooks.each do |cb_name|
           cb = @loader[cb_name]
+          if @cfg["rollback"]["enabled"] == true
+            backup_data["cookbook_versions"][cb_name] = env.cookbook_versions[cb_name]
+          end
           # Force "= a.b.c" in cookbook version, as chef11 will not accept "a.b.c"
           env.cookbook_versions[cb_name] = "= #{cb.version}"
           cbs << cb
@@ -204,6 +210,14 @@ module KnifeSharp
             log_action("bumping #{cb.name} to #{cb.version} for environment #{@environment}")
           end
         end
+
+        if @cfg["rollback"]["enabled"] == true
+          identifier = Time.now.to_i
+          Dir.mkdir(@cfg["rollback"]["destination"]) unless File.exists?(@cfg["rollback"]["destination"])
+          fp = open(File.join(@cfg["rollback"]["destination"], "#{identifier}.json"), "w")
+          fp.write(JSON.pretty_generate(backup_data))
+          fp.close()
+        end
       end
     end
 

data/lib/chef/knife/sharp-rollback.rb

@@ -0,0 +1,144 @@
+module KnifeSharp
+  class SharpRollback < Chef::Knife
+
+    banner "knife sharp rollback [--list] [--to <identifier>] [--show <identifier>]"
+
+    option :list,
+      :short => '-l',
+      :long  => '--list',
+      :description => "lists rollback points",
+      :default => false
+
+    option :to,
+      :short => "-t",
+      :long  => "--to",
+      :description => "the rollback point identifier",
+      :default => nil
+
+    option :show,
+      :short => "-s",
+      :long => "--show",
+      :description => "show what the rollback point contains",
+      :default => false
+
+    deps do
+      require 'chef/cookbook/metadata'
+      require 'chef/cookbook_loader'
+      require 'chef/cookbook_uploader'
+    end
+
+    def run()
+      setup()
+
+      if config[:list]
+        list_rollback_points()
+        exit 0
+      end
+
+      if config[:show]
+        identifier = name_args
+        show_rollback_point(identifier)
+        exit 0
+      end
+
+      if config[:to]
+        identifier = name_args
+        rollback_to(identifier)
+        exit 0
+      end
+    end
+
+    def setup()
+      actions = 0
+      [:to, :list, :show].each do |action|
+        if config[action]
+          actions+=1
+        end
+      end
+
+      if actions > 1
+        ui.error("please specify only one action")
+        exit 1
+      end
+
+
+      # Sharp config
+      cfg_files = [ "/etc/sharp-config.yml", "~/.chef/sharp-config.yml" ]
+      loaded = false
+      cfg_files.each do |cfg_file|
+        begin
+          @cfg = YAML::load_file(File.expand_path(cfg_file))
+          loaded = true
+        rescue Exception => e
+          ui.error "Error on loading config : #{e.inspect}" if config[:verbosity] > 0
+        end
+      end
+      unless loaded == true
+        ui.error "config could not be loaded ! Tried the following files : #{cfg_files.join(", ")}"
+        exit 1
+      end
+
+      # Knife config
+      if Chef::Knife.chef_config_dir && File.exists?(File.join(Chef::Knife.chef_config_dir, "knife.rb"))
+        Chef::Config.from_file(File.join(Chef::Knife.chef_config_dir, "knife.rb"))
+      else
+        ui.error "Cannot find knife.rb config file"
+        exit 1
+      end
+
+      chefcfg = Chef::Config
+      @cb_path = chefcfg.cookbook_path.is_a?(Array) ? chefcfg.cookbook_path.first : chefcfg.cookbook_path
+      @loader = Chef::CookbookLoader.new(@cb_path)
+    end
+
+    def list_rollback_points()
+      ui.msg("Available rollback points :")
+      Dir.glob(File.join(@cfg["rollback"]["destination"], "*.json")).each do |f|
+        ts = File.basename(f, ".json")
+        ui.msg("  * #{ts} (#{Time.at(ts.to_i).to_s})")
+      end
+      exit 0
+    end
+
+    def rollback_to(identifier)
+      show_rollback_point(identifier)
+      answer = ui.ask_question("Continue rollback ? Y/(N) ", :default => "N").upcase
+      if answer != "Y"
+        ui.msg("Aborting !")
+        exit 0
+      end
+
+      begin
+        fp = File.open(File.join(@cfg["rollback"]["destination"],"#{identifier}.json"),"r")
+        infos = JSON.load(fp)
+      rescue
+        ui.error("could not load rollback point #{identifier}")
+        exit 1
+      end
+
+      env = Chef::Environment.load(infos["environment"])
+      infos["cookbook_versions"].each do |cb, version|
+          env.cookbook_versions[cb] = version
+          ui.msg("Setting #{cb} to version #{version}")
+      end
+      env.save
+    end
+
+    def show_rollback_point(identifier)
+      begin
+        fp = File.open(File.join(@cfg["rollback"]["destination"],"#{identifier}.json"),"r")
+      rescue
+        ui.error("could not load rollback point #{identifier}")
+        exit 1
+      end
+      infos = JSON.load(fp)
+      ui.msg("Rollback point has the following informations :")
+      ui.msg("  environment : #{infos["environment"]}")
+      ui.msg("  cookbooks versions :")
+      infos["cookbook_versions"].each do |cb, version|
+        ui.msg("   * #{cb} => #{version}")
+      end
+    end
+
+  end
+end

data/lib/knife-sharp.rb

@@ -1,3 +1,3 @@
 module KnifeSharp
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,57 +1,66 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: knife-sharp
-version: !ruby/object:Gem::Version
-  version: 0.2.0
+version: !ruby/object:Gem::Version 
+  hash: 19
   prerelease: 
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
 platform: ruby
-authors:
+authors: 
 - Nicolas Szalay
 - Jonathan Amiez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-23 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2013-06-05 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: chef
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 10.14.0
-  type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 119
+        segments: 
+        - 10
+        - 14
+        - 0
         version: 10.14.0
-- !ruby/object:Gem::Dependency
-  name: grit
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.5.0
   type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: grit
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 2
+        - 5
+        - 0
         version: 2.5.0
+  type: :runtime
+  version_requirements: *id002
 description: Sharpen your knife
-email:
+email: 
 - nico@rottenbytes.info
 - jonathan.amiez@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - README.md
 - ext/sharp-config.yml
 - lib/knife-sharp.rb
@@ -59,28 +68,39 @@ files:
 - lib/chef/knife/sharp-backup.rb
 - lib/chef/knife/sharp-history.rb
 - lib/chef/knife/sharp-server.rb
+- lib/chef/knife/sharp-rollback.rb
 homepage: https://github.com/Fotolia/knife-sharp
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-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 
+      hash: 3
+      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 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Knife sharp plugin
 test_files: []
+