knife-sharp 0.1.8 → 0.2.0

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

@@ -4,12 +4,20 @@ require 'grit'
 module KnifeSharp
   class SharpAlign < Chef::Knife
 
-    banner "knife sharp align BRANCH ENVIRONMENT [--debug]"
+    banner "knife sharp align BRANCH ENVIRONMENT [OPTS]"
+
+    [:cookbooks, :databags, :roles].each do |opt|
+      option opt,
+        :short => "-#{opt.to_s[0].upcase}",
+        :long => "--#{opt}-only",
+        :description => "sync #{opt} only",
+        :default => false
+    end
 
-    option :debug,
-      :short => '-d',
-      :long  => '--debug',
-      :description => "turn debug on",
+    option :dump_remote_only,
+      :short => "-B",
+      :long => "--dump-remote-only",
+      :description => "dump items not present locally (roles/databags)",
       :default => false
 
     deps do
@@ -20,22 +28,37 @@ module KnifeSharp
 
     def run
       setup()
-      ui.msg "On server #{@chef_server}" if @chef_server
-      ui.msg "Aligning cookbooks"
-      align_cookbooks()
-      ui.msg "Aligning data bags"
-      align_databags()
-      ui.msg "Aligning roles"
-      align_roles()
+      ui.msg(ui.color("On server #{@chef_server}", :bold)) if @chef_server
+      check_cookbooks if @do_cookbooks
+      check_databags if @do_databags
+      check_roles if @do_roles
+
+      # All questions asked, can we proceed ?
+      if @cookbooks.empty? and @databags.empty? and @roles.empty?
+        ui.msg "Nothing else to do"
+        exit 0
+      end
+
+      ui.confirm(ui.color("> Proceed ", :bold))
+      bump_cookbooks if @do_cookbooks
+      update_databags if @do_databags
+      update_roles if @do_roles
     end
 
     def setup
       # Checking args
       if name_args.count != 2
-        ui.error "Usage : knife align BRANCH ENVIRONMENT [--debug]"
+        show_usage
         exit 1
       end
 
+      # check cli flags
+      if config[:cookbooks] or config[:databags] or config[:roles]
+        @do_cookbooks, @do_databags, @do_roles = config[:cookbooks], config[:databags], config[:roles]
+      else
+        @do_cookbooks, @do_databags, @do_roles = true, true, true
+      end
+
       # Sharp config
       cfg_files = [ "/etc/sharp-config.yml", "~/.chef/sharp-config.yml" ]
       loaded = false
@@ -44,7 +67,7 @@ module KnifeSharp
           @cfg = YAML::load_file(File.expand_path(cfg_file))
           loaded = true
         rescue Exception => e
-          ui.error "Error on loading config : #{e.inspect}" if config[:debug]
+          ui.error "Error on loading config : #{e.inspect}" if config[:verbosity] > 0
         end
       end
       unless loaded == true
@@ -52,6 +75,17 @@ module KnifeSharp
         exit 1
       end
 
+      # Env setup
+      @branch, @environment = name_args
+      @chef_path = @cfg["global"]["git_cookbook_path"]
+
+      # Checking current branch
+      current_branch = Grit::Repo.new(@chef_path).head.name
+      if @branch != current_branch then
+        ui.error "Git repo is actually on branch #{current_branch} but you want to align using #{@branch}. Checkout to the desired one."
+        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"))
@@ -72,10 +106,6 @@ module KnifeSharp
         end
       end
 
-      # Env setup
-      @branch, @environment = name_args
-      @chef_path = @cfg["global"]["git_cookbook_path"]
-
       chefcfg = Chef::Config
       @cb_path = chefcfg.cookbook_path.is_a?(Array) ? chefcfg.cookbook_path.first : chefcfg.cookbook_path
       @db_path = chefcfg.data_bag_path.is_a?(Array) ? chefcfg.data_bag_path.first : chefcfg.data_bag_path
@@ -84,167 +114,203 @@ module KnifeSharp
       @chef_server = SharpServer.new.current_server
       @loader = Chef::CookbookLoader.new(@cb_path)
 
-      # Checking current branch
-      current_branch = Grit::Repo.new(@chef_path).head.name
-      if @branch != current_branch then
-        ui.error "Git repo is actually on branch #{current_branch} but you want to align using #{@branch}. Checkout to the desired one."
-        exit 1
-      end
+      @cookbooks = Array.new
+      @databags = Hash.new
+      @roles = Hash.new
     end
 
     ### Cookbook methods ###
 
-    def align_cookbooks
-      updated_versions = Hash.new()
+    def check_cookbooks
+      unless File.exists?(@cb_path)
+        ui.warn "Bad cookbook path, skipping cookbook sync."
+        return
+      end
+
+      ui.msg(ui.color("== Cookbooks ==", :bold))
+
+      updated_versions = Hash.new
       local_versions = Hash[Dir.glob("#{@cb_path}/*").map {|cb| [File.basename(cb), @loader[File.basename(cb)].version] }]
       remote_versions = Chef::Environment.load(@environment).cookbook_versions.each_value {|v| v.gsub!("= ", "")}
 
+      if local_versions.empty?
+        ui.warn "No local cookbooks found, is the cookbook path correct ? (#{@cb_path})"
+        return
+      end
+
+      # get local-only cookbooks
       (local_versions.keys - remote_versions.keys).each do |cb|
         updated_versions[cb] = local_versions[cb]
         ui.msg "* #{cb} is local only (version #{local_versions[cb]})"
       end
 
+      # get cookbooks not up-to-date
       (remote_versions.keys & local_versions.keys).each do |cb|
-        if remote_versions[cb] != local_versions[cb]
+        if Chef::VersionConstraint.new("> #{remote_versions[cb]}").include?(local_versions[cb])
           updated_versions[cb] = local_versions[cb]
           ui.msg "* #{cb} is not up-to-date (local: #{local_versions[cb]}/remote: #{remote_versions[cb]})"
         end
       end
 
+      if @cfg[@chef_server] and @cfg[@chef_server].has_key?("ignore_cookbooks")
+        (updated_versions.keys & @cfg[@chef_server]["ignore_cookbooks"]).each do |cb|
+          updated_versions.delete(cb)
+          ui.msg "* Skipping #{cb} cookbook (ignore list)"
+        end
+      end
+
       if !updated_versions.empty?
         all = false
-        bumped = Array.new
-        env = Chef::Environment.load(@environment)
         updated_versions.each_pair do |cb,version|
-          answer = nil
-
-          if @cfg[@chef_server]
-            if @cfg[@chef_server]["ignore_cookbooks"]
-              if @cfg[@chef_server]["ignore_cookbooks"].include?(cb)
-                answer = "N"
-              end
-            end
-          end
-
-          if answer.nil?
-            answer = ui.ask_question("Update #{cb} cookbook item on server ? Y/N/(A)ll/(Q)uit ", :default => "N").upcase unless all
-          end
+          answer = ui.ask_question("> Update #{cb} cookbook to #{version} on server ? Y/N/(A)ll/(Q)uit ", :default => "N").upcase unless all
 
           if answer == "A"
             all = true
           elsif answer == "Q"
-            ui.msg "> Skipping next cookbooks alignment."
+            ui.msg "* Skipping next cookbooks alignment."
             break
           end
 
           if all or answer == "Y"
-            # Force "= a.b.c" in cookbook version, as chef11 will not accept "a.b.c"
-            env.cookbook_versions[cb] = "= #{version}"
-            bumped << @loader[cb]
+            @cookbooks << cb
           else
             ui.msg "* Skipping #{cb} cookbook"
           end
         end
+      else
+        ui.msg "* Environment #{@environment} is up-to-date."
+      end
+    end
+
+
+    def bump_cookbooks
+      unless @cookbooks.empty?
+        env = Chef::Environment.load(@environment)
+        cbs = Array.new
+        @cookbooks.each do |cb_name|
+          cb = @loader[cb_name]
+          # Force "= a.b.c" in cookbook version, as chef11 will not accept "a.b.c"
+          env.cookbook_versions[cb_name] = "= #{cb.version}"
+          cbs << cb
+        end
 
-        unless bumped.empty?
-          ui.msg "* Uploading cookbook(s) #{bumped.map{|cb| cb.name.to_s}.join(",")}"
-          uploader = Chef::CookbookUploader.new(bumped, @cb_path)
-          uploader.upload_cookbooks
-          if env.save
-            bumped.each do |cb|
-              ui.msg "* Bumping #{cb.name.to_s} to #{cb.version} for environment #{@environment}"
-              log_action("bumping #{cb.name.to_s} to #{cb.version} for environment #{@environment}")
-            end
+        ui.msg "* Uploading cookbook(s) #{@cookbooks.join(", ")}"
+        uploader = Chef::CookbookUploader.new(cbs, @cb_path)
+        uploader.upload_cookbooks
+
+        if env.save
+          cbs.each do |cb|
+            ui.msg "* Bumping #{cb.name} to #{cb.version} for environment #{@environment}"
+            log_action("bumping #{cb.name} to #{cb.version} for environment #{@environment}")
           end
         end
-      else
-        ui.msg "> Environment #{@environment} is up-to-date."
       end
     end
 
     ### Databag methods ###
 
-    def align_databags
+    def check_databags
       unless File.exists?(@db_path)
         ui.warn "Bad data bag path, skipping data bag sync."
         return
       end
 
+      ui.msg(ui.color("== Data bags ==", :bold))
+
       updated_dbs = Hash.new
       local_dbs = Dir.glob(File.join(@db_path, "**/*.json")).map {|f| [File.dirname(f).split("/").last, File.basename(f, ".json")]}
       remote_dbs = Chef::DataBag.list.keys.map {|db| Chef::DataBag.load(db).keys.map{|dbi| [db, dbi]}}.flatten(1)
 
-      ui.warn "No local data bags found, is the role path correct ? (#{@role_path})" if local_dbs.empty?
+      if local_dbs.empty?
+        ui.warn "No local data bags found, is the data bag path correct ? (#{@db_path})"
+        return
+      end
+
+      # Dump missing data bags locally
+      (remote_dbs - local_dbs).each do |db|
+        ui.msg "* #{db.join("/")} data bag item is remote only"
+        if config[:dump_remote_only]
+          ui.msg "* Dumping to #{File.join(@db_path, "#{db.join("/")}.json")}"
+          begin
+            remote_db = Chef::DataBagItem.load(db.first, db.last).raw_data
+            Dir.mkdir(File.join(@db_path, db.first)) unless File.exists?(File.join(@db_path, db.first))
+            File.open(File.join(@db_path, "#{db.join("/")}.json"), "w") do |file|
+              file.puts JSON.pretty_generate(remote_db)
+            end
+          rescue Exception => e
+            ui.error "Unable to dump #{db.join("/")} data bag item (#{e.message})"
+          end
+        end
+      end
 
       # Create new data bags on server
       (local_dbs - remote_dbs).each do |db|
-        ui.msg "+ #{db.join("/")} data bag item is local only. Creating"
         begin
-          local_db = Chef::DataBagItem.new
-          local_db.data_bag(db.first)
-          local_db.raw_data = JSON::load(File.read(File.join(@db_path, "#{db.join("/")}.json")))
-          local_db.save
+          local_db = JSON::load(File.read(File.join(@db_path, "#{db.join("/")}.json")))
+          updated_dbs[db] = local_db
+          ui.msg "* #{db.join("/")} data bag item is local only"
         rescue Exception => e
-          ui.error "Unable to create #{db.join("/")} data bag item (#{e.message})"
+          ui.error "Unable to load #{db.join("/")} data bag item (#{e.message})"
         end
       end
 
-      # Dump missing data bags locally
-      (remote_dbs - local_dbs).each do |db|
-        ui.msg "- #{db.join("/")} data bag item is remote only. Dumping to #{File.join(@db_path, "#{db.join("/")}.json")}"
+      # Compare roles common to local and remote
+      (remote_dbs & local_dbs).each do |db|
         begin
           remote_db = Chef::DataBagItem.load(db.first, db.last).raw_data
-          Dir.mkdir(File.join(@db_path, db.first)) unless File.exists?(File.join(@db_path, db.first))
-          File.open(File.join(@db_path, "#{db.join("/")}.json"), "w") do |file|
-            file.puts JSON.pretty_generate(remote_db)
+          local_db = JSON::load(File.read(File.join(@db_path, "#{db.join("/")}.json")))
+          if remote_db != local_db
+            updated_dbs[db] = local_db
+            ui.msg("* #{db.join("/")} data bag item is not up-to-date")
           end
         rescue Exception => e
-          ui.error "Unable to dump #{db.join("/")} data bag item (#{e.message})"
-        end
-      end
-
-      # Compare roles common to local and remote
-      (remote_dbs & local_dbs).each do |db|
-        remote_db = Chef::DataBagItem.load(db.first, db.last).raw_data
-        local_db = JSON::load(File.read(File.join(@db_path, "#{db.join("/")}.json")))
-
-        if remote_db != local_db
-          updated_dbs[db] = local_db
-          ui.msg("* #{db.join("/")} data bag item is not up-to-date")
+          ui.error "Unable to load #{db.join("/")} data bag item (#{e.message})"
         end
       end
 
       if !updated_dbs.empty?
         all = false
         updated_dbs.each do |name, obj|
-          answer = ui.ask_question("Update #{name.join("/")} data bag item on server ? Y/N/(A)ll/(Q)uit ", :default => "N").upcase unless all
+          answer = ui.ask_question("> Update #{name.join("/")} data bag item on server ? Y/N/(A)ll/(Q)uit ", :default => "N").upcase unless all
 
           if answer == "A"
             all = true
           elsif answer == "Q"
-            ui.msg "> Aborting data bag alignment."
+            ui.msg "* Aborting data bag alignment."
             break
           end
 
           if all or answer == "Y"
-            ui.msg "* Updating #{name.join("/")} data bag item"
-            log_action("updating #{name.join("/")} data bag item")
+            @databags[name] = obj
+          else
+            ui.msg "* Skipping #{name.join("/")} data bag item"
+          end
+        end
+      else
+        ui.msg "* Data bags are up-to-date."
+      end
+    end
+
+    def update_databags
+      unless @databags.empty?
+        @databags.each do |name, obj|
+          begin
             db = Chef::DataBagItem.new
             db.data_bag(name.first)
             db.raw_data = obj
             db.save
-          else
-            ui.msg "* Skipping #{name.join("/")} data bag item"
+            ui.msg "* Updating #{name.join("/")} data bag item"
+            log_action("updating #{name.join("/")} data bag item")
+          rescue Exception => e
+            ui.error "Unable to update #{name.join("/")} data bag item"
           end
         end
-      else
-        ui.msg "> Data bags are up-to-date."
       end
     end
 
     ### Role methods ###
 
-    def align_roles
+    def check_roles
       # role sections to compare (methods)
       to_check = {
         "env_run_lists" => "run list",
@@ -257,33 +323,41 @@ module KnifeSharp
         return
       end
 
+      ui.msg(ui.color("== Roles ==", :bold))
+
       updated_roles = Hash.new
       local_roles = Dir.glob(File.join(@role_path, "*.json")).map {|file| File.basename(file, ".json")}
       remote_roles = Chef::Role.list.keys
 
-      ui.warn "No local roles found, is the role path correct ? (#{@role_path})" if local_roles.empty?
-
-      # Create new roles on server
-      (local_roles - remote_roles).each do |role|
-        ui.msg "+ #{role} role is local only. Creating"
-        begin
-          local_role = Chef::Role.from_disk(role)
-          local_role.save
-        rescue Exception => e
-          ui.error "Unable to create #{role} role (#{e.message})"
-        end
+      if local_roles.empty?
+        ui.warn "No local roles found, is the role path correct ? (#{@role_path})"
+        return
       end
 
       # Dump missing roles locally
       (remote_roles - local_roles).each do |role|
-        ui.msg "- #{role} role is remote only. Dumping to #{File.join(@role_path, "#{role}.json")}"
-        begin
-          remote_role = Chef::Role.load(role)
-          File.open(File.join(@role_path, "#{role}.json"), "w") do |file|
-            file.puts JSON.pretty_generate(remote_role)
+        ui.msg "* #{role} role is remote only"
+        if config[:dump_remote_only]
+          ui.msg "* Dumping to #{File.join(@role_path, "#{role}.json")}"
+          begin
+            remote_role = Chef::Role.load(role)
+            File.open(File.join(@role_path, "#{role}.json"), "w") do |file|
+              file.puts JSON.pretty_generate(remote_role)
+            end
+          rescue Exception => e
+            ui.error "Unable to dump #{role} role (#{e.message})"
           end
+        end
+      end
+
+      # Create new roles on server
+      (local_roles - remote_roles).each do |role|
+        begin
+          local_role = Chef::Role.from_disk(role)
+          updated_roles[role] = local_role
+          ui.msg "* #{role} role is local only"
         rescue Exception => e
-          ui.error "Unable to dump #{role} role (#{e.message})"
+          ui.error "Unable to load #{role} role (#{e.message})"
         end
       end
 
@@ -305,25 +379,37 @@ module KnifeSharp
       if !updated_roles.empty?
         all = false
         updated_roles.each do |name, obj|
-          answer = ui.ask_question("Update #{name} role on server ? Y/N/(A)ll/(Q)uit ", :default => "N").upcase unless all
+          answer = ui.ask_question("> Update #{name} role on server ? Y/N/(A)ll/(Q)uit ", :default => "N").upcase unless all
 
           if answer == "A"
             all = true
           elsif answer == "Q"
-            ui.msg "> Aborting role alignment."
+            ui.msg "* Aborting role alignment."
             break
           end
 
           if all or answer == "Y"
-            ui.msg "* Updating #{name} role"
-            log_action("updating #{name} role")
-            obj.save
+            @roles[name] = obj
           else
             ui.msg "* Skipping #{name} role"
           end
         end
       else
-        ui.msg "> Roles are up-to-date."
+        ui.msg "* Roles are up-to-date."
+      end
+    end
+
+    def update_roles
+      unless @roles.empty?
+        @roles.each do |name, obj|
+          begin
+            obj.save
+            ui.msg "* Updating #{name} role"
+            log_action("updating #{name} role")
+          rescue Exception => e
+            ui.error "Unable to update #{name} role"
+          end
+        end
       end
     end
 
@@ -359,6 +445,5 @@ module KnifeSharp
         ui.error "Unable to notify via hubot."
       end
     end
-
   end
 end

data/lib/knife-sharp.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knife-sharp
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-20 00:00:00.000000000 Z
+date: 2013-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef