knife-sharp 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ca5eb5868e371ab216bf8009f49fc1341b0884dd
-  data.tar.gz: 4f2471fc8a99e9372dd459c9c0da29e7e5d9f862
+  metadata.gz: ddab4231fc3e426c9a71063a2a417b10b3cae947
+  data.tar.gz: eda6e7ed4b19017b5a386b2550b1cbaac6364a0e
 SHA512:
-  metadata.gz: bdf6f7d68cfc0806231fedec65d4e074ea97bddbef433ee8f58ec9f180200c7337f8accf8e530919275a3d12f0f8dbb13672756faa8c482aeff8b82373f74be2
-  data.tar.gz: 732dcc82d02814c8d7e4fba9d00b1aaa2dd2037fae214cbb5e36d1e91769369ecdad99ac512adbc96b005913bf9f9aa954b50b90cc805a9382512e282637104b
+  metadata.gz: 4070ebe2f93b5bbbef1fa1a28652b5988ab76d356cb6383bb20d9646dec145c13c6e8ceecdef8930e8b3581347f50ff66f3f435b7c449283e404f435e02f6a51
+  data.tar.gz: 53dd08f8ad6159fa06096a69f177e57d7da443df3ac607517be1ee6f495dab513eff969c573f114d72e3c351d04a77e0b1fafe55c4090876f8e101b2e1d2fe54

data/README.md

@@ -72,7 +72,7 @@ $ knife sharp align ldap production
 
 Cookbooks, data_bags and roles are uploaded, and cookbook versions updated in given environment.
 
-To use all of these features, your knife.rb(s) must provide paths for cookbooks, data bags and roles (see [configuration](#Configuration))
+To use all of these features, your knife.rb(s) must provide paths for cookbooks, data bags, roles and environments (see [configuration](#Configuration))
 
 ### Ignore list
 
@@ -188,6 +188,7 @@ Fully enabled Sharp needs:
 cookbook_path            '/home/jamiez/chef/cookbooks'
 data_bag_path            '/home/jamiez/chef/data_bags'
 role_path                '/home/jamiez/chef/roles'
+environment_path         '/home/jamiez/chef/environments'
 ```
 in knife.rb
 

data/ext/sharp-config.yml

@@ -8,11 +8,14 @@ global:
   # backup dir for knife sharp backup
   backupdir: "/home/nico/.chef/sharp/backups/"
 
-# Currently only hubot notifications supported
+# Currently only bot notifications supported
+# notification operation:
+# POST <url>/<channel>
+# with JSON payload {"message": <message>}
 notification:
-  hubot:
+  bot:
     enabled: true
-    url: "http://your.hubot.lan:18080/hubot/chef/bump/"
+    url: "http://bot.lan:18080/chef/bump/"
     channel: "foo"
     username: "Nicolas"
     # don't notify if updates are done on development chef

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

@@ -8,13 +8,29 @@ module KnifeSharp
 
     banner "knife sharp align BRANCH ENVIRONMENT [OPTS]"
 
-    [:cookbooks, :databags, :roles].each do |opt|
-      option opt,
-        :short => "-#{opt.to_s[0,1].upcase}",
-        :long => "--#{opt}-only",
-        :description => "sync #{opt} only",
-        :default => false
-    end
+    option :cookbooks,
+      :short => "-C",
+      :long => "--cookbooks-only",
+      :description => "sync cookbooks only",
+      :default => false
+
+    option :roles,
+      :short => "-R",
+      :long => "--roles-only",
+      :description => "sync roles only",
+      :default => false
+
+    option :databags,
+      :short => "-D",
+      :long => "--databags-only",
+      :description => "sync data bags only",
+      :default => false
+
+    option :environments,
+      :short => "-N",
+      :long => "--environments-only",
+      :description => "sync environments only",
+      :default => false
 
     option :force_align,
       :short => "-f",
@@ -36,10 +52,10 @@ module KnifeSharp
       ensure_correct_branch_provided!
 
       # check cli flags
-      if config[:cookbooks] or config[:databags] or config[:roles]
-        do_cookbooks, do_databags, do_roles = config[:cookbooks], config[:databags], config[:roles]
+      if config[:cookbooks] or config[:databags] or config[:roles] or config[:environments]
+        do_cookbooks, do_databags, do_roles, do_environments = config[:cookbooks], config[:databags], config[:roles], config[:environments]
       else
-        do_cookbooks, do_databags, do_roles = true, true, true
+        do_cookbooks, do_databags, do_roles, do_environments = true, true, true, true
       end
 
       ui.msg(ui.color("On server #{chef_server}", :bold)) if chef_server
@@ -53,9 +69,12 @@ module KnifeSharp
       SharpRoleAlign.load_deps
       sra = SharpRoleAlign.new
       roles_to_update = do_roles ? sra.check_roles : {}
+      SharpEnvironmentAlign.load_deps
+      sea = SharpEnvironmentAlign.new
+      environments_to_update = do_environments ? sea.check_environments : {}
 
       # All questions asked, can we proceed ?
-      if cookbooks_to_update.empty? and databags_to_update.empty? and roles_to_update.empty?
+      if cookbooks_to_update.empty? and databags_to_update.empty? and roles_to_update.empty? and environments_to_update.empty?
         ui.msg "Nothing else to do"
         exit 0
       end
@@ -64,6 +83,7 @@ module KnifeSharp
       sca.bump_cookbooks(environment, cookbooks_to_update) if do_cookbooks
       sda.update_databags(databags_to_update) if do_databags
       sra.update_roles(roles_to_update) if do_roles
+      sea.update_environments(environments_to_update) if do_environments
     end
   end
 end

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

@@ -0,0 +1,133 @@
+require 'chef/knife'
+require 'knife-sharp/common'
+
+module KnifeSharp
+  class SharpEnvironmentAlign < Chef::Knife
+    include KnifeSharp::Common
+
+    banner "knife sharp environment align BRANCH [OPTS]"
+
+    deps do
+      require "chef/environment"
+    end
+
+    def run
+      # Checking args
+      ensure_branch_provided!
+
+      # Checking repo branch
+      ensure_correct_branch_provided!
+
+      ui.msg(ui.color("On server #{chef_server}", :bold)) if chef_server
+
+      to_update = check_environments
+
+      if to_update.empty?
+        ui.msg "Nothing else to do"
+        exit 0
+      end
+
+      ui.confirm(ui.color("> Proceed ", :bold))
+
+      update_environments(to_update)
+    end
+
+    def check_environments
+      not_up_to_date = Array.new
+      to_update = Array.new
+
+      unless File.exists?(environment_path)
+        ui.warn("Bad environment path, skipping environment sync.")
+        return to_update
+      end
+
+      ui.msg(ui.color("== Environments ==", :bold))
+
+      local_envs = Dir.glob(File.join(environment_path, "*.json")).map {|file| File.basename(file, ".json")}
+      remote_envs = Chef::Environment.list.keys
+
+      if local_envs.empty?
+        ui.warn("No local environment found, is the environment path correct ? (#{environment_path})")
+        return to_update
+      end
+
+      # Create new environments on server
+      (local_envs - remote_envs).each do |env|
+        local_env = Chef::Environment.load_from_file(env)
+        message = "* #{local_env.name} environment is local only"
+        if ignore_list(:environments).include(local_env.name)
+          message += " (ignored)"
+        else
+          not_up_to_date << local_env
+        end
+        ui.msg(message)
+      end
+
+      # Compare envs common to local and remote
+      (remote_envs & local_envs).each do |env|
+        remote_env = Chef::Environment.load(env)
+        local_env = Chef::Environment.load_from_file(env)
+
+        diffs = relevant_env_keys.map do |method, display|
+          if remote_env.send(method) != local_env.send(method)
+            remote_env.send("#{method}=", local_env.send(method))
+            display
+          end
+        end.compact
+
+        unless diffs.empty?
+          message = "* #{remote_env.name} environment is not up-to-date (#{diffs.join(", ")})"
+          if ignore_list(:environments).include?(remote_env.name)
+            message += " (ignored)"
+          else
+            not_up_to_date << remote_env
+          end
+          ui.msg(message)
+        end
+      end
+
+      if !not_up_to_date.empty?
+        all = false
+        not_up_to_date.each do |env|
+          answer = all ? "Y" : ui.ask_question("> Update #{env.name} environment on server ? Y/N/(A)ll/(Q)uit ", :default => "N").upcase
+
+          if answer == "A"
+            all = true
+          elsif answer == "Q"
+            ui.msg "* Aborting environment alignment."
+            break
+          end
+
+          if all or answer == "Y"
+            to_update << env
+          else
+            ui.msg "* Skipping #{env.name} environment"
+          end
+        end
+      else
+        ui.msg "* Environments are up-to-date."
+      end
+
+      to_update
+    end
+
+    def update_environments(env_list)
+      env_list.each do |env|
+        begin
+          env.save
+          ui.msg("* Updating #{env.name} environment")
+        rescue Exception => e
+          ui.error("Unable to update #{env.name} environment (#{e.message})")
+        end
+      end
+    end
+
+    def relevant_env_keys
+      # env sections to compare (methods)
+      {
+        "default_attributes" => "default attributes",
+        "override_attributes" => "override attributes"
+      }
+    end
+  end
+end

data/lib/knife-sharp.rb

@@ -1,3 +1,3 @@
 module KnifeSharp
-  VERSION = "0.5.1"
+  VERSION = "0.6.0"
 end

data/lib/knife-sharp/common.rb

@@ -38,6 +38,13 @@ module KnifeSharp
         end
       end
 
+      def ensure_branch_provided!
+        if @name_args.size != 1
+          show_usage
+          exit 1
+        end
+      end
+
       def environment
         @environment ||= @name_args.last
       end
@@ -54,6 +61,10 @@ module KnifeSharp
         @role_path ||= [Chef::Config.send(:role_path)].flatten.first
       end
 
+      def environment_path
+        @environment_path ||= [Chef::Config.send(:environment_path)].flatten.first
+      end
+
       def logger
         return @logger unless @logger.nil?
 
@@ -91,7 +102,7 @@ module KnifeSharp
         end
       end
 
-      def hubot(message, config={})
+      def bot(message, config={})
         begin
           require "net/http"
           require "uri"
@@ -99,7 +110,15 @@ module KnifeSharp
           notif = "chef: #{message} by #{config["username"]}"
           Net::HTTP.post_form(uri, { "message" => notif })
         rescue
-          ui.error "Unable to notify via hubot."
+          ui.error "Unable to notify via bot."
+        end
+      end
+
+      def ignore_list(component)
+        if sharp_config[chef_server] and sharp_config[chef_server]["ignore_#{component}"]
+          sharp_config[chef_server]["ignore_#{component}"]
+        else
+          []
         end
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knife-sharp
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Nicolas Szalay
@@ -58,6 +58,7 @@ files:
 - lib/chef/knife/sharp-backup.rb
 - lib/chef/knife/sharp-cookbook-align.rb
 - lib/chef/knife/sharp-data_bag-align.rb
+- lib/chef/knife/sharp-environment-align.rb
 - lib/chef/knife/sharp-history.rb
 - lib/chef/knife/sharp-role-align.rb
 - lib/chef/knife/sharp-rollback.rb