knife-flip 0.1.6 → 0.1.7

data/README.md

@@ -16,10 +16,12 @@ gem install knife-flip
 ## What it does
 
 ````
-knife node flip mynode.foo.com myenv
+knife node flip mynode.foo.com myenv [--preview]
 ````
 
-will move the node mynode.foo.com into the environment myenv
+will move the node mynode.foo.com into the environment myenv. Passing in the --preview option
+it will dry-run the flip and show you what cookbooks and versions would be applied if it were actually
+flipped.
 
 
 ````

data/knife-flip.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-flip'
-  s.version           = '0.1.6'
-  s.date              = '2013-03-22'
+  s.version           = '0.1.7'
+  s.date              = '2013-06-06'
   s.rubyforge_project = 'knife-flip'
 
   ## Make sure your summary is short. The description may be as long
@@ -41,6 +41,7 @@ Gem::Specification.new do |s|
   ## List your runtime dependencies here. Runtime dependencies are those
   ## that are needed for an end user to actually USE your code.
   s.add_dependency('chef', [">= 0.10.4"])
+	s.add_dependency('colorize', [">= 0.5.8"])
 
   ## 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/nodeflip.rb

@@ -2,6 +2,7 @@
 
 
 require 'chef/knife'
+require 'colorize'
 
 module KnifeFlip
   class NodeFlip < Chef::Knife
@@ -12,7 +13,13 @@ module KnifeFlip
       require 'chef/knife/core/object_loader'
     end
 
-    banner "knife node flip NODE ENVIRONMENT"
+    banner "knife node flip NODE ENVIRONMENT (options)"
+
+    option :preview,
+      :long => '--preview',
+      :boolean => true,
+      :on => :tail,
+      :description => 'Preview the target environment to see affected cookbooks'
 
     def run
       unless @node_name = name_args[0]
@@ -25,42 +32,150 @@ module KnifeFlip
         exit 1
       end
 
-      puts "Looking for an fqdn of #{@node_name} or name of #{@node_name}"
+      if config[:preview] then
+        show_environmental_differences
+      else
+        puts "Looking for an fqdn of #{@node_name} or name of #{@node_name}"
+
+        searcher = Chef::Search::Query.new
+        result = searcher.search(:node, "fqdn:#{@node_name} OR name:#{@node_name}")
+
+        knife_search = Chef::Knife::Search.new
+        node = result.first.first
+        if node.nil?
+          puts "Could not find a node with the fqdn of #{@node_name} or name of #{@node_name}"
+          exit 1
+        end
+
+        begin
+          e = Chef::Environment.load(@environment)
+        rescue Net::HTTPServerException => e
+          if e.response.code.to_s == "404"
+            ui.error "The environment #{@environment} does not exist on the server, aborting."
+            Chef::Log.debug(e)
+            exit 1
+          else
+             raise
+          end
+        end
+    
+        puts "Setting environment to #{@environment}"
+        node.chef_environment(@environment)
+        node.save
+
+        knife_search = Chef::Knife::Search.new
+        # ensure that 'start' and 'rows' are set since we don't seem to properly inherit the +config+ hash and therefore don't get sane defaults
+        config[:start] = 0
+        config[:rows] = 1000
+        knife_search.config = config  # without this, the +config+ hash is empty
+        knife_search.name_args = ['node', "fqdn:#{@node_name} OR name:#{@node_name}"]
+        knife_search.run
+      end
+    end
+
+    private
+
+    # Compare the two environments
+    def show_environmental_differences
+      # Re-iterate to the user that this won't flip you
+      remind_user_about_preview
+
+      # Load up the node information
+      load_node_object
+
+      # Get the source environment
+      get_source_environment
+
+      # Pull down the cookbooks for this node
+      cookbooks = get_cookbooks_for_node
+
+      # Get cookbooks for the environments we are checking
+      source_cookbooks = cookbooks_for_environment(@source_environment)
+      target_cookbooks = cookbooks_for_environment(@environment)
+
+      # Transform the uploaded cookbooks into a name => latest version hash
+      source_hash = get_cookbook_version_hash(source_cookbooks)
 
+      # Transform the production cookbooks into a name => latest version hash
+      target_hash = get_cookbook_version_hash(target_cookbooks)
+
+      # Intersect the production cookbook collection and ours
+      common_cookbooks = target_cookbooks.keys & cookbooks
+      changed_cookbooks = common_cookbooks.keep_if { |cookbook_key| 
+        target_hash[cookbook_key] != source_hash[cookbook_key] 
+      }
+      
+      # Lets show what is different
+      show_cookbook_differences(changed_cookbooks, source_hash, target_hash)
+    end
+
+    # Load up the node in question into a instance variable
+    def load_node_object
       searcher = Chef::Search::Query.new
       result = searcher.search(:node, "fqdn:#{@node_name} OR name:#{@node_name}")
 
-      knife_search = Chef::Knife::Search.new
-      node = result.first.first
-      if node.nil?
+      @node = result.first.first
+      if @node.nil?
         puts "Could not find a node with the fqdn of #{@node_name} or name of #{@node_name}"
         exit 1
-      end
+      end      
+    end
 
-      begin
-        e = Chef::Environment.load(@environment)
-      rescue Net::HTTPServerException => e
-        if e.response.code.to_s == "404"
-          ui.error "The environment #{@environment} does not exist on the server, aborting."
-          Chef::Log.debug(e)
-          exit 1
-        else
-           raise
+    # Extract the source environment from the node object
+    def get_source_environment
+      @source_environment = @node.chef_environment
+    end
+
+    # For the node being passed in, find and return an array of cookboock names
+    def get_cookbooks_for_node
+      cookbooks = @node.recipes.map {|recipe| recipe.match('^[^:]+')[0] }.uniq
+
+      return cookbooks
+    end
+
+    # For an environment, get all the cookbooks associated with it (in API object array form)
+    def cookbooks_for_environment(environment=nil, num_versions=1)
+      api_endpoint = environment ? "/environments/#{environment}/cookbooks?#{num_versions}" : "/cookbooks?#{num_versions}"
+      cookbooks = rest.get_rest(api_endpoint)
+      
+      return cookbooks        
+    end
+
+    # Given a cookbook array returned from the API, create a Hash of its name and the latest version
+    def get_cookbook_version_hash(cookbooks)
+      Hash[cookbooks.collect { |k, v| [k, v['versions'].first['version']] }]  
+    end
+
+    # Takes in an array of modified cookbook names, the hash of uploaded cookbooks, and the hash of cookbooks
+    # from the environment being checked
+    def show_cookbook_differences(changed_cookbook_names, source_hash, target_hash)
+      changed_cookbook_count = changed_cookbook_names.size
+      (1..110).each { print "=".colorize(:cyan) }
+      puts ""
+      if changed_cookbook_count != 0 then
+        puts "#{changed_cookbook_count} difference(s) between environments"
+        changed_cookbook_names.each do |cookbook_name|
+          puts "#{cookbook_name}".colorize(:yellow) + ": " + "#{@source_environment}".colorize(:magenta) +
+               " version: " + "#{source_hash[cookbook_name]} ".colorize(:red) +
+               "will be changed to " + "#{target_hash[cookbook_name]}".colorize(:green) + " in " +
+               "#{@environment}".colorize(:magenta)
         end
+      elsif (@source_environment == @environment) and (changed_cookbook_names.size == 0) then
+        puts "The environment the node is on and the one you are flipping to are identical, and thus "
+        puts "there are " + "NO".colorize(:red) +" cookbook differences"
+      else
+        puts "No differences".colorize(:red) +
+              " between the cookbook versions in the " + "#{@source_environment}".colorize(:magenta) + " and the " +
+              "#{@environment}".colorize(:magenta) + " environment for this node"
       end
-  
-      puts "Setting environment to #{@environment}"
-      node.chef_environment(@environment)
-      node.save
-
-      knife_search = Chef::Knife::Search.new
-      # ensure that 'start' and 'rows' are set since we don't seem to properly inherit the +config+ hash and therefore don't get sane defaults
-      config[:start] = 0
-      config[:rows] = 1000
-      knife_search.config = config  # without this, the +config+ hash is empty
-      knife_search.name_args = ['node', "fqdn:#{@node_name} OR name:#{@node_name}"]
-      knife_search.run
+      (1..110).each { print "=".colorize(:cyan) }
+      puts ""
+    end
 
+    # Print out warning for users so they know that preview is a dry run
+    def remind_user_about_preview
+      puts "NOTE NOTE NOTE".colorize(:red) + " Running with --preview " + "WILL NOT".colorize(:red) +
+           " flip your node\n"
     end
   end
 end

data/lib/knife-flip.rb

@@ -1,3 +1,3 @@
 module KnifeFlip
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: knife-flip
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-22 00:00:00.000000000 Z
+date: 2013-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.10.4
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.8
 description: A knife plugin to move a node, or all nodes in a role, to a specific
   environment
 email: jonlives@gmail.com