chef-rewind 0.0.6 → 0.0.7

data/CHANGELOG

@@ -1,3 +1,4 @@
+Hugo Lopes Tavares: Allow unwinding resources
 Peter Fern: Allow rewinding recipe_name
 Peter Fern: Shef extensions have moved in 11.x, add compatible require
 Peter Fern: Change deprecated Gemfile source `:rubygems` to `https://rubygems.org`

data/README.md

@@ -1,12 +1,12 @@
 # Chef::Rewind
 
 This adds a simple function to the Chef library scope to
-rewind an existing resource. If the given resource does not exist, 
-a Chef::Exceptions::ResourceNotFound exception will be raised.
+rewind or unwind an existing resource. If the given resource does not exist, 
+a `Chef::Exceptions::ResourceNotFound` exception will be raised.
 
-This function is designed to assist the library cookbook pattern.
+These functions are designed to assist the library cookbook pattern.
 
-Effectively, the rewind resource allows you to monkeypatch a cookbook that you would rather not modify directly. It will modify some properties of a resource, during the complile phase, before chef-client actually starts the run phase.
+Effectively, rewind/unwind resource allows you to monkeypatch a cookbook that you would rather not modify directly. It will modify some properties of a resource, during the complile phase, before chef-client actually starts the run phase.
 
 ## Installation
 
@@ -24,6 +24,8 @@ Or install it yourself as:
 
 ## Usage
 
+### rewind
+
 ```Ruby
 # file postgresql/recipes/server.rb
 user "postgres" do
@@ -44,11 +46,73 @@ end
 
 ```
 
-The user "postgres" will act once with the home directory
-'/var/lib/pgsql/9.2 and the cookbook_name attribute is now
-"my-postgresql" instead of "postgresql". This last part is
+The user `postgres` will act once with the home directory
+`/var/lib/pgsql/9.2` and the `cookbook_name` attribute is now
+`my-postgresql` instead of `postgresql`. This last part is
 particularly important for templates and cookbook files.
 
+### unwind
+
+```Ruby
+# file postgresql/recipes/server.rb
+user "postgres" do
+  uid  26
+  home '/home/postgres'
+  supports  :manage_home => true
+end
+
+# file my-postgresql/recipes/server.rb
+chef_gem "chef-rewind"
+require 'chef/rewind'
+
+include_recipe "postgresql::server"
+
+unwind "user[postgres]"
+
+```
+
+This will completely remove the resource. It is useful
+for resources that are impossible to change correctly.
+Resource notifications, for example,
+can't be overwritten by `rewind`, only appended.
+
+So if you need to change notifications of a resource,
+you need to `unwind` and redefine the resource. Example:
+
+```Ruby
+# file cookbook-elasticsearch/recipes/default.rb
+template "logging.yml" do
+  path "#{node.elasticsearch[:path][:conf]}/logging.yml"
+  source "logging.yml.erb"
+  owner node.elasticsearch[:user] and group node.elasticsearch[:user] and mode 0755
+
+  notifies :restart, 'service[elasticsearch]'
+end
+
+# file my-elasticsearch/recipes/default.rb
+chef_gem "chef-rewind"
+require 'chef/rewind'
+
+unwind "template[logging.yml]"
+
+template "logging.yml" do
+  path  "#{node.elasticsearch[:path][:conf]}/logging.yml"
+  source "logging.yml.erb"
+  owner node.elasticsearch[:user] and group node.elasticsearch[:user] and mode 0755
+  cookbook_name "elasticsearch"
+
+  # this is the only change from original definition
+  notifies :run, 'execute[Custom ElasticSearch restarter]'
+end
+
+```
+
+This allows you to define your own ElasticSearch restart script.
+It's impossible to `rewind` notifications,
+thus you need to `unwind` and redefine it based on the original version.
+
+
+
 ## Gotchas *Important*
 
 The rewind method does not automatically change the cookbook_name

data/chef-rewind.gemspec

@@ -3,8 +3,8 @@ $:.unshift(File.dirname(__FILE__) + '/lib')
 Gem::Specification.new do |gem|
   gem.authors       = ["Bryan Berry"]
   gem.email         = ["bryan.berry@gmail.com"]
-  gem.description   = %q{Monkey patches Chef to allow rewinding of existing resources}
-  gem.summary       = %q{Monkey patches Chef to allow rewinding of existing resources}
+  gem.description   = %q{Monkey patches Chef to allow rewinding and unwinding of existing resources}
+  gem.summary       = %q{Monkey patches Chef to allow rewinding and unwinding of existing resources}
   gem.homepage      = ""
 
   gem.files         = `git ls-files`.split($\)
@@ -12,5 +12,5 @@ Gem::Specification.new do |gem|
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "chef-rewind"
   gem.require_paths = ["lib"]
-  gem.version       = "0.0.6"
+  gem.version       = "0.0.7"
 end

data/lib/chef/rewind.rb

@@ -28,6 +28,20 @@ class Chef
         raise e
       end
     end
+
+    #  unwinds an existing resource if it exists,
+    #  otherwise raises the Chef::Exceptions::ResourceNotFound exception
+    #  For example:
+    #      #  recipe postgresql::server defines user "postgres"  and
+    #      #  sets the home directory to /var/pgsql/9.2
+    #      include_recipe "postgresql::user"
+    #
+    #      unwind "user[postgres]"
+    # === Parameters
+    # resource<String>:: String identifier for resource
+    def unwind(resource_id)
+      run_context.resource_collection.delete_resource resource_id
+    end
   end
 end
 
@@ -49,3 +63,16 @@ class Chef
     end
   end
 end
+
+
+class Chef
+  class ResourceCollection
+    def delete_resource(resource_id)
+      lookup resource_id
+
+      # assumes `resource_id` is the same as `Chef::Resource#to_s`
+      @resources.delete_if {|r| r.to_s == resource_id }
+      @resources_by_name.delete resource_id
+    end
+  end
+end

data/spec/unwind_recipe_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+require 'chef/rewind'
+
+describe Chef::Recipe do
+  
+  before(:each) do
+    @cookbook_repo = File.expand_path(File.join(File.dirname(__FILE__), "..", "data", "cookbooks"))
+    cl = Chef::CookbookLoader.new(@cookbook_repo)
+    cl.load_cookbooks
+    @cookbook_collection = Chef::CookbookCollection.new(cl)
+    @node = Chef::Node.new
+    @node.normal[:tags] = Array.new
+    @events = Chef::EventDispatch::Dispatcher.new
+    @run_context = Chef::RunContext.new(@node, @cookbook_collection, @events)
+    @recipe = Chef::Recipe.new("hjk", "test", @run_context)
+  end
+
+
+  describe "unwind" do
+    it "should remove resource when unwind is called" do
+      @recipe.zen_master "foobar" do
+        peace false
+      end
+      
+      @recipe.unwind "zen_master[foobar]"
+
+      resources = @run_context.resource_collection.all_resources
+      resources.length.should == 0
+    end
+
+    it "should throw an error when unwinding a nonexistent resource" do
+      lambda do 
+        @recipe.unwind "zen_master[foobar]"
+      end.should raise_error(Chef::Exceptions::ResourceNotFound)
+    end
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chef-rewind
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
   prerelease: 
 platform: ruby
 authors:
@@ -9,9 +9,9 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-20 00:00:00.000000000 Z
+date: 2013-10-14 00:00:00.000000000 Z
 dependencies: []
-description: Monkey patches Chef to allow rewinding of existing resources
+description: Monkey patches Chef to allow rewinding and unwinding of existing resources
 email:
 - bryan.berry@gmail.com
 executables: []
@@ -73,6 +73,7 @@ files:
 - spec/support/shared/functional/securable_resource.rb
 - spec/support/shared/unit/api_error_inspector.rb
 - spec/support/shared/unit/platform_introspector.rb
+- spec/unwind_recipe_spec.rb
 homepage: ''
 licenses: []
 post_install_message: 
@@ -96,7 +97,7 @@ rubyforge_project:
 rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
-summary: Monkey patches Chef to allow rewinding of existing resources
+summary: Monkey patches Chef to allow rewinding and unwinding of existing resources
 test_files:
 - spec/data/cookbooks/angrybash/recipes/default.rb
 - spec/data/cookbooks/apache2/files/default/apache2_module_conf_generate.pl
@@ -145,4 +146,5 @@ test_files:
 - spec/support/shared/functional/securable_resource.rb
 - spec/support/shared/unit/api_error_inspector.rb
 - spec/support/shared/unit/platform_introspector.rb
+- spec/unwind_recipe_spec.rb
 has_rdoc: