kitchen-scribe 0.2.0 → 0.3.0

data/README.md

@@ -10,9 +10,10 @@ It performs two main functions.
 
 1.  _Documenting changes_. It pulls the configuration of all your environements, roles, and nodes then saves them into json files in the place of your choosing and commits the changes to a local git repository. It can also pull/push them to a remote repostory for safekeeping.
 
-2.  _Making precise changes_. It can perform precise updates on your environments, roles and nodes by using json data structure describing the change. *[This feature is still being tested and it's not available through rubygems yet. If you would like to try it please install it driectly from the github repo]* 
+2.  _Making precise changes_. It can perform precise updates on your environments, roles and nodes by using json data structure describing the change.
 
-The philosophy behind using scribe to update your environments, roles an nodes is that you may want to make prepare some changes in advance, be able to test them and then have them applied to the final setup. Also it might be important to isolate those changes in a clear way so people who are not familiar with chef don't have to edit a huge json object to get them in. Lastly you can now automate applying your changes as well, and automation is what Chef is all about in the end:). 
+
+The philosophy behind using scribe to update your environments, roles an nodes is that you may want to prepare some changes in advance, be able to test them and then have them applied to the final setup. Also it might be important to isolate those changes in a clear way so people who are not familiar with chef don't have to edit a huge json object to get them in. Lastly, you can now automate applying your changes as well, and automation is what Chef is all about in the end:). 
 
 The plugin is still in the beta stage, I've tested it manualy to some extent, but I'm sure there are things I missed. Please submit any bugs you find through the github issue system and I promiss to take care of them as soon as possible.
 

data/lib/chef/knife/scribe_adjust.rb

@@ -38,6 +38,9 @@ class Chef
       }
 
       ENVIRONMENT_ADJUSTMENT_TEMPLATE = {
+        "action" => "merge",
+        "type" => "environment",
+        "search" => "name:my_environment_name",
         "adjustment" => { "default_attributes" => { },
           "override_attributes" => { },
           "cookbook_versions" => { }
@@ -45,6 +48,9 @@ class Chef
       }
 
       ROLE_ADJUSTMENT_TEMPLATE = {
+        "action" => "merge",
+        "type" => "role",
+        "search" => "name:my_role_name",
         "adjustment" => { "default_attributes" => { },
           "override_attributes" => { },
           "run_list" => [ ]
@@ -52,8 +58,11 @@ class Chef
       }
 
       NODE_ADJUSTMENT_TEMPLATE = {
-        "adjustment" => { "attributes" => { },
-          "run_list" => [ ]
+        "action" => "merge",
+        "type" => "node",
+        "search" => "name:my_node_name",
+        "adjustment" => { "normal" => { },
+          "run_list" => [ ],
         }
       }
 
@@ -192,15 +201,29 @@ class Chef
       def apply_adjustment(adjustment)
         query = adjustment["search"].include?(":") ? adjustment["search"] : "name:" + adjustment["search"]
         Chef::Search::Query.new.search(adjustment["type"], query ) do |result|
-          result_hash = result.to_hash
-          key = result_hash["chef_type"] + ":" + result_hash["name"]
-          if changes.has_key? key
-            result_hash = changes[key]["adjusted"]
-          else
-            changes.store(key, { "original" => result_hash })
-          end
-          changes[key].store("adjusted", send(("action_" + adjustment["action"]).to_sym, result_hash, adjustment["adjustment"]))
+          key = result.class.name.downcase + ":" + result.name
+          prepared_hash = prepare_adjustment_subject(key, result)
+          changes[key].store("adjusted", send(("action_" + adjustment["action"]).to_sym, prepared_hash, adjustment["adjustment"]))
+        end
+      end
+
+      def prepare_adjustment_subject(key, chef_object)
+        prepared_hash = prepare_object_hash(chef_object)
+        if changes.has_key? key
+          prepared_hash = changes[key]["adjusted"]
+        else
+          changes.store(key, { "original" => prepared_hash })
+        end
+        prepared_hash
+      end
+
+      def prepare_object_hash(chef_object)
+        prepared_hash = chef_object.to_hash
+        if prepared_hash["chef_type"] == "node"
+          prepared_hash.keep_if { |key, value| ["name","chef_type","chef_environment","run_list"].include? key }
+          prepared_hash.merge!({ "normal" => chef_object.normal_attrs })
         end
+        prepared_hash
       end
 
       def write_adjustments

data/lib/chef/knife/scribe_copy.rb

@@ -132,7 +132,7 @@ class Chef
 
       def fetch_nodes
         Chef::Node.list(true).each do |name, n|
-          node_hash = {"name" => name, "env" => n.chef_environment, "attribiutes" => n.normal_attrs, "run_list" => n.run_list}
+          node_hash = {"name" => name, "env" => n.chef_environment, "normal" => n.normal_attrs, "run_list" => n.run_list}
           save_to_file("nodes",name, node_hash)
         end
       end

data/lib/kitchen-scribe/version.rb

@@ -1,4 +1,4 @@
 module KitchenScribe
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
   MAJOR, MINOR, TINY = VERSION.split('.')
 end

data/spec/chef/knife/scribe_adjust_spec.rb

@@ -28,10 +28,6 @@ describe Chef::Knife::ScribeAdjust do
     @scribe.should respond_to(:action_merge)
   end
 
-  it "responds to #action_hash_only_merge" do
-    @scribe.should respond_to(:action_hash_only_merge)
-  end
-
   it "responds to #action_overwrite" do
     @scribe.should respond_to(:action_overwrite)
   end
@@ -614,11 +610,7 @@ describe Chef::Knife::ScribeAdjust do
       Chef::Search::Query.stub(:new).and_return(@query)
       @chef_obj = double("chef_object")
       @chef_obj.stub(:to_hash).and_return( { "name" => "test_name", "chef_type" => "test_type", "a" => 3, "c" => 3 } )
-      chef_obj_class = double("chef_object_class")
-      json_create_return_obj = double("final_chef_object")
-      json_create_return_obj.stub(:save)
-      chef_obj_class.stub(:json_create).and_return(json_create_return_obj)
-      @chef_obj.stub(:class).and_return(chef_obj_class)
+      @chef_obj.stub(:name).and_return("test_name")
       @query.stub(:search).and_yield(@chef_obj)
     end
 
@@ -644,35 +636,90 @@ describe Chef::Knife::ScribeAdjust do
       end
     end
 
-    it "checks if the a change to a given object is already pending" do
-      @scribe.changes.should_receive(:has_key?).with(@chef_obj.to_hash["chef_type"] + ":" + @chef_obj.to_hash["name"])
+    it "saves the changed version in the changes hash" do
+      adjusted_hash = @chef_obj.to_hash.dup.merge({ "a" => "b" })
+      changes_hash = { "original" => @chef_obj.to_hash, "adjusted" => adjusted_hash }
+      @scribe.changes[@chef_obj.class.name.downcase + ":" + @chef_obj.name] = changes_hash
+      adjusted_hash = @scribe.send(("action_" + @adjustment["action"]).to_sym, adjusted_hash, @adjustment["adjustment"])
+      changes_hash.should_receive(:store).with("adjusted", adjusted_hash).and_call_original
       @scribe.apply_adjustment(@adjustment)
     end
+  end
+
+  describe "#prepare_adjustment_subject" do
+    before(:each) do
+      @chef_obj = double("chef_object")
+      @chef_obj.stub(:to_hash).and_return( { "name" => "test_name", "chef_type" => "test_type", "a" => 3, "c" => 3 } )
+      @key = "test_type:test_name"
+    end
+
+    it "checks if the a change to a given object is already pending" do
+      @scribe.changes.should_receive(:has_key?).with(@key)
+      @scribe.prepare_adjustment_subject(@key, @chef_obj)
+    end
 
     describe "if the key doesn't exist" do
       it "saves the original in the changes hash" do
-        @scribe.changes.should_receive(:store).with(@chef_obj.to_hash["chef_type"] + ":" + @chef_obj.to_hash["name"],
+        @scribe.changes.should_receive(:store).with(@key,
                                                     { "original" => @chef_obj.to_hash }
                                                     ).and_call_original
-        @scribe.apply_adjustment(@adjustment)
+        @scribe.prepare_adjustment_subject(@key, @chef_obj)
+      end
+
+      it "prepares the object hash" do
+        @scribe.should_receive(:prepare_object_hash).with(@chef_obj)
+        @scribe.prepare_adjustment_subject(@key, @chef_obj)
+      end
+
+      it "returns the prepared object hash" do
+        @scribe.prepare_adjustment_subject(@key, @chef_obj).should == @chef_obj.to_hash
       end
     end
 
-    it "applies each subsequent adjustment to the already adjusted version" do
-      adjusted_hash = @chef_obj.to_hash.dup.merge({"a" => "b"})
-      changes_hash = { "original" => @chef_obj.to_hash, "adjusted" => adjusted_hash }
-      @scribe.changes[@chef_obj.to_hash["chef_type"] + ":" + @chef_obj.to_hash["name"]] = changes_hash
-      @scribe.should_receive(("action_" + @adjustment["action"]).to_sym).with(adjusted_hash, @adjustment["adjustment"])
-      @scribe.apply_adjustment(@adjustment)
+    describe "if the key already exists" do
+      before(:each) do
+        @adjusted_hash = @chef_obj.to_hash.dup.merge({"a" => "b"})
+        changes_hash = { "original" => @chef_obj.to_hash, "adjusted" => @adjusted_hash }
+        @scribe.changes[@key] = changes_hash
+      end
+
+      it "it returns the previously adjusted version" do
+        @scribe.prepare_adjustment_subject(@key, @chef_obj).should == @adjusted_hash
+      end
     end
+  end
 
-    it "saves the changed version in the changes hash" do
-      adjusted_hash = @chef_obj.to_hash.dup.merge({ "a" => "b" })
-      changes_hash = { "original" => @chef_obj.to_hash, "adjusted" => adjusted_hash }
-      @scribe.changes[@chef_obj.to_hash["chef_type"] + ":" + @chef_obj.to_hash["name"]] = changes_hash
-      adjusted_hash = @scribe.send(("action_" + @adjustment["action"]).to_sym, adjusted_hash, @adjustment["adjustment"])
-      changes_hash.should_receive(:store).with("adjusted", adjusted_hash).and_call_original
-      @scribe.apply_adjustment(@adjustment)
+  describe "#prepare_object_hash" do
+    describe "if object isn't a node" do
+      before(:each) do
+        @chef_obj = double("chef_object")
+        @chef_obj.stub(:to_hash).and_return( { "name" => "test_name", "chef_type" => "test_type", "a" => 3, "c" => 3 } )
+      end
+
+      it "returns the object converted to hash" do
+        @scribe.prepare_object_hash(@chef_obj).should == @chef_obj.to_hash
+      end
+    end
+
+    describe "if object is a node" do
+      before(:each) do
+        @chef_obj = double("chef_object")
+        @node_data = { "name" => "test_name",
+          "chef_type" => "node",
+          "a" => 3,
+          "c" => 3,
+          "chef_environment" => "test_env",
+          "run_list" => "blah"
+        }
+        @chef_obj.stub(:to_hash).and_return( @node_data)
+        @chef_obj.stub(:normal_attrs).and_return({"nx" => "ny"})
+        @prepared_data = @node_data.select { |key, value| ["name","chef_type","chef_environment","run_list"].include? key }
+        @prepared_data.merge!({"normal" => {"nx" => "ny"}})
+      end
+
+      it "keeps only the relevant information" do
+        @scribe.prepare_object_hash(@chef_obj).should == @prepared_data
+      end
     end
   end
 

data/spec/chef/knife/scribe_copy_spec.rb

@@ -398,13 +398,13 @@ describe Chef::Knife::ScribeCopy do
       @node1.stub(:chef_environment) { "chef_environment1" }
       @node1.stub(:normal_attrs) { { :attr1 => "val1" } }
       @node1.stub(:run_list) { ["cookbook1", "cookbook2"] }
-      @serialized_node1 = {"name" => @node1.name, "env" => @node1.chef_environment, "attribiutes" => @node1.normal_attrs, "run_list" => @node1.run_list}
+      @serialized_node1 = {"name" => @node1.name, "env" => @node1.chef_environment, "normal" => @node1.normal_attrs, "run_list" => @node1.run_list}
       @node2 = { :test2 => :value2 }
       @node2.stub(:name) { "node_name2" }
       @node2.stub(:chef_environment) { "chef_environment2" }
       @node2.stub(:normal_attrs) { { :attrA => "valA" } }
       @node2.stub(:run_list) { ["cookbookA", "cookbookB"] }
-      @serialized_node2 = {"name" => @node2.name, "env" => @node2.chef_environment, "attribiutes" => @node2.normal_attrs, "run_list" => @node2.run_list}
+      @serialized_node2 = {"name" => @node2.name, "env" => @node2.chef_environment, "normal" => @node2.normal_attrs, "run_list" => @node2.run_list}
       Chef::Node.stub(:list) { { @node1.name => @node1, @node2.name => @node2 } }
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-scribe
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-14 00:00:00.000000000 Z
+date: 2013-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef