diff options
| -rw-r--r-- | lib/puppet/provider/augeas/augeas.rb | 59 | ||||
| -rwxr-xr-x | spec/unit/provider/augeas/augeas_spec.rb | 107 |
2 files changed, 148 insertions, 18 deletions
diff --git a/lib/puppet/provider/augeas/augeas.rb b/lib/puppet/provider/augeas/augeas.rb index a16f54bd7..95142568e 100644 --- a/lib/puppet/provider/augeas/augeas.rb +++ b/lib/puppet/provider/augeas/augeas.rb @@ -15,9 +15,12 @@ require 'augeas' if Puppet.features.augeas? require 'strscan' +require 'puppet/util' +require 'puppet/util/diff' Puppet::Type.type(:augeas).provide(:augeas) do include Puppet::Util + include Puppet::Util::Diff confine :true => Puppet.features.augeas? @@ -25,6 +28,8 @@ Puppet::Type.type(:augeas).provide(:augeas) do SAVE_NOOP = "noop" SAVE_OVERWRITE = "overwrite" + SAVE_NEWFILE = "newfile" + SAVE_BACKUP = "backup" COMMANDS = { "set" => [ :path, :string ], @@ -254,11 +259,6 @@ Puppet::Type.type(:augeas).provide(:augeas) do @aug.set("/augeas/save", mode) end - def files_changed? - saved_files = @aug.match("/augeas/events/saved") - saved_files.size > 0 - end - # Determines if augeas acutally needs to run. def need_to_run? force = resource[:force] @@ -287,20 +287,33 @@ Puppet::Type.type(:augeas).provide(:augeas) do # actually do the save. if return_value and get_augeas_version >= "0.3.6" debug("Will attempt to save and only run if files changed") - set_augeas_save_mode(SAVE_NOOP) + set_augeas_save_mode(SAVE_NEWFILE) do_execute_changes save_result = @aug.save saved_files = @aug.match("/augeas/events/saved") - if save_result and not files_changed? - debug("Skipping because no files were changed") - return_value = false - else + if save_result and saved_files.size > 0 + root = resource[:root].sub(/^\/$/, "") + saved_files.each do |key| + saved_file = @aug.get(key).to_s.sub(/^\/files/, root) + if Puppet[:show_diff] + print diff(saved_file, saved_file + ".augnew") + end + if resource.noop? + File.delete(saved_file + ".augnew") + end + end debug("Files changed, should execute") + return_value = true + else + debug("Skipping because no files were changed or save failed") + return_value = false end end end ensure - close_augeas + if not return_value or resource.noop? + close_augeas + end end return_value end @@ -309,12 +322,24 @@ Puppet::Type.type(:augeas).provide(:augeas) do # Re-connect to augeas, and re-execute the changes begin open_augeas - set_augeas_save_mode(SAVE_OVERWRITE) if get_augeas_version >= "0.3.6" - - do_execute_changes - - success = @aug.save - fail("Save failed with return code #{success}") if success != true + saved_files = @aug.match("/augeas/events/saved") + if saved_files + saved_files.each do |key| + root = resource[:root].sub(/^\/$/, "") + saved_file = @aug.get(key).to_s.sub(/^\/files/, root) + if File.exists?(saved_file + ".augnew") + success = File.rename(saved_file + ".augnew", saved_file) + debug(saved_file + ".augnew moved to " + saved_file) + fail("Rename failed with return code #{success}") if success != 0 + end + end + else + debug("No saved files, re-executing augeas") + set_augeas_save_mode(SAVE_OVERWRITE) if get_augeas_version >= "0.3.6" + do_execute_changes + success = @aug.save + fail("Save failed with return code #{success}") if success != true + end ensure close_augeas end diff --git a/spec/unit/provider/augeas/augeas_spec.rb b/spec/unit/provider/augeas/augeas_spec.rb index 5bb98eadf..687043b31 100755 --- a/spec/unit/provider/augeas/augeas_spec.rb +++ b/spec/unit/provider/augeas/augeas_spec.rb @@ -4,7 +4,6 @@ require 'spec_helper' provider_class = Puppet::Type.type(:augeas).provider(:augeas) describe provider_class do - describe "command parsing" do before do @resource = stub("resource") @@ -252,6 +251,7 @@ describe provider_class do it "should handle no filters" do resource = stub("resource") resource.stubs(:[]).returns(false).then.returns("").then.returns("") + resource.stubs(:noop?).returns(false) augeas_stub = stub("augeas", :match => ["set", "of", "values"]) augeas_stub.stubs("close") provider = provider_class.new(resource) @@ -263,6 +263,7 @@ describe provider_class do it "should return true when a get filter matches" do resource = stub("resource") resource.stubs(:[]).returns(false).then.returns("get path == value").then.returns("") + resource.stubs(:noop?).returns(false) provider = provider_class.new(resource) augeas_stub = stub("augeas", :get => "value") augeas_stub.stubs("close") @@ -285,6 +286,7 @@ describe provider_class do it "should return true when a match filter matches" do resource = stub("resource") resource.stubs(:[]).returns(false).then.returns("match path size == 3").then.returns("") + resource.stubs(:noop?).returns(false) provider = provider_class.new(resource) augeas_stub = stub("augeas", :match => ["set", "of", "values"]) augeas_stub.stubs("close") @@ -320,6 +322,7 @@ describe provider_class do it "should return true when a size != the provided value" do resource = stub("resource") resource.stubs(:[]).returns(false).then.returns("match path size != 17").then.returns("") + resource.stubs(:noop?).returns(false) provider = provider_class.new(resource) augeas_stub = stub("augeas", :match => ["set", "of", "values"]) augeas_stub.stubs("close") @@ -339,6 +342,107 @@ describe provider_class do provider.stubs(:get_augeas_version).returns("0.3.5") provider.need_to_run?.should == false end + + # Ticket 2728 (diff files) + describe "and Puppet[:show_diff] is set" do + before do + Puppet[:show_diff] = true + + @resource = Puppet::Type.type(:augeas).new(:name => "test") + @provider = provider_class.new(@resource) + @augeas_stub = stub("augeas") + @provider.aug = @augeas_stub + + @augeas_stub.stubs("get").with("/augeas/version").returns("0.7.2") + @augeas_stub.stubs(:set).returns(true) + @augeas_stub.stubs(:save).returns(true) + end + + it "should call diff when a file is shown to have been changed" do + file = "/etc/hosts" + + @resource[:context] = "/files" + @resource[:changes] = ["set #{file}/foo bar"] + + @augeas_stub.stubs(:match).with("/augeas/events/saved").returns(["/augeas/events/saved"]) + @augeas_stub.stubs(:get).with("/augeas/events/saved").returns(["/files#{file}"]) + @augeas_stub.expects(:set).with("/augeas/save", "newfile") + @augeas_stub.expects(:close).never() + + @provider.expects("diff").with("#{file}", "#{file}.augnew").returns("") + @provider.should be_need_to_run + end + + it "should call diff for each file thats changed" do + file1 = "/etc/hosts" + file2 = "/etc/resolv.conf" + + @resource[:context] = "/files" + @resource[:changes] = ["set #{file1}/foo bar", "set #{file2}/baz biz"] + + @augeas_stub.stubs(:match).with("/augeas/events/saved").returns(["/augeas/events/saved[1]", "/augeas/events/saved[2]"]) + @augeas_stub.stubs(:get).with("/augeas/events/saved[1]").returns(["/files#{file1}"]) + @augeas_stub.stubs(:get).with("/augeas/events/saved[2]").returns(["/files#{file2}"]) + @augeas_stub.expects(:set).with("/augeas/save", "newfile") + @augeas_stub.expects(:close).never() + + @provider.expects(:diff).with("#{file1}", "#{file1}.augnew").returns("") + @provider.expects(:diff).with("#{file2}", "#{file2}.augnew").returns("") + @provider.should be_need_to_run + end + + describe "and resource[:root] is set" do + it "should call diff when a file is shown to have been changed" do + root = "/tmp/foo" + file = "/etc/hosts" + + @resource[:context] = "/files" + @resource[:changes] = ["set #{file}/foo bar"] + @resource[:root] = root + + @augeas_stub.stubs(:match).with("/augeas/events/saved").returns(["/augeas/events/saved"]) + @augeas_stub.stubs(:get).with("/augeas/events/saved").returns(["/files#{file}"]) + @augeas_stub.expects(:set).with("/augeas/save", "newfile") + @augeas_stub.expects(:close).never() + + @provider.expects(:diff).with("#{root}#{file}", "#{root}#{file}.augnew").returns("") + @provider.should be_need_to_run + end + end + + it "should not call diff if no files change" do + file = "/etc/hosts" + + @resource[:context] = "/files" + @resource[:changes] = ["set #{file}/foo bar"] + + @augeas_stub.stubs(:match).with("/augeas/events/saved").returns([]) + @augeas_stub.expects(:set).with("/augeas/save", "newfile") + @augeas_stub.expects(:get).with("/augeas/events/saved").never() + @augeas_stub.expects(:close) + + @provider.expects(:diff).never() + @provider.should_not be_need_to_run + end + + it "should cleanup when in noop mode" do + file = "/etc/hosts" + + @resource[:noop] = true + @resource[:context] = "/files" + @resource[:changes] = ["set #{file}/foo bar"] + + @augeas_stub.stubs(:match).with("/augeas/events/saved").returns(["/augeas/events/saved"]) + @augeas_stub.stubs(:get).with("/augeas/events/saved").returns(["/files#{file}"]) + @augeas_stub.expects(:set).with("/augeas/save", "newfile") + @augeas_stub.expects(:close) + + File.expects(:delete).with(file + ".augnew") + + @provider.expects(:diff).with("#{file}", "#{file}.augnew").returns("") + @provider.should be_need_to_run + end + end end describe "augeas execution integration" do @@ -349,6 +453,7 @@ describe provider_class do @augeas = stub("augeas") @provider.aug= @augeas @provider.stubs(:get_augeas_version).returns("0.3.5") + @augeas.stubs(:match).with("/augeas/events/saved") end it "should handle set commands" do |