Please review pull request #733: (#14136) Emit debug/warnings when Augeas provider fails to load files opened by (domcleal)
Description:
The messages and information from /augeas//error are now printed to debug when
the provider opens Augeas, allowing file parse errors to be found.
The provider can also restrict the files that are loaded (from the default of
everything). In these cases, the provider now emits a warning and then prints
all the detailed information to debug. Since a few parse errors are common, no
warning is given when these optimisations aren't in use.
http://projects.puppetlabs.com/issues/14136
- Opened: Wed May 02 20:28:09 UTC 2012
- Based on: puppetlabs:master (ba80b0e9fad27f2171b7f5e5db4253b89c70dc85)
- Requested merge: domcleal:tickets/master/14136-augeas-warning (2ab8c3053769167b64bb7655636ef2ae2ef2c8aa)
Diff follows:
diff --git a/lib/puppet/provider/augeas/augeas.rb b/lib/puppet/provider/augeas/augeas.rb
index edb9eb3..81d6713 100644
--- a/lib/puppet/provider/augeas/augeas.rb
+++ b/lib/puppet/provider/augeas/augeas.rb
@@ -161,9 +161,11 @@ def open_augeas
glob_avail = !aug.match("/augeas/version/pathx/functions/glob").empty?
+ restricted = false
if resource[:incl]
aug.set("/augeas/load/Xfm/lens", resource[:lens])
aug.set("/augeas/load/Xfm/incl", resource[:incl])
+ restricted = true
elsif glob_avail and resource[:context] and resource[:context].match("^/files/")
# Optimize loading if the context is given, requires the glob function
# from Augeas 0.8.2 or up
@@ -172,12 +174,14 @@ def open_augeas
if aug.match(load_path).size < aug.match("/augeas/load/*").size
aug.rm(load_path)
+ restricted = true
else
# This will occur if the context is less specific than any glob
debug("Unable to optimize files loaded by context path, no glob matches")
end
end
aug.load
+ print_load_errors(:warning => restricted)
end
@aug
end
@@ -281,14 +285,29 @@ def set_augeas_save_mode(mode)
@aug.set("/augeas/save", mode)
end
+ def print_load_errors(args={})
+ errors = @aug.match("/augeas//error")
+ unless errors.empty?
+ if args[:warning]
+ warning("Loading failed for one or more files, see debug for /augeas//error output")
+ else
+ debug("Loading failed for one or more files, output from /augeas//error:")
+ end
+ end
+ print_errors(errors)
+ end
+
def print_put_errors
errors = @aug.match("/augeas//error[. = 'put_failed']")
debug("Put failed on one or more files, output from /augeas//error:") unless errors.empty?
+ print_errors(errors)
+ end
+
+ def print_errors(errors)
errors.each do |errnode|
@aug.match("#{errnode}/*").each do |subnode|
- sublabel = subnode.split("/")[-1]
subvalue = @aug.get(subnode)
- debug("#{sublabel} = #{subvalue}")
+ debug("#{subnode} = #{subvalue}")
end
end
end
diff --git a/spec/unit/provider/augeas/augeas_spec.rb b/spec/unit/provider/augeas/augeas_spec.rb
index 0909946..e498e84 100755
--- a/spec/unit/provider/augeas/augeas_spec.rb
+++ b/spec/unit/provider/augeas/augeas_spec.rb
@@ -608,14 +608,34 @@
end
end
- describe "save failure reporting" do
+ describe "load/save failure reporting" do
before do
@augeas = stub("augeas")
@augeas.stubs("close")
@provider.aug = @augeas
end
- it "should find errors and output to debug" do
+ describe "should find load errors" do
+ before do
+ @augeas.expects(:match).with("/augeas//error").returns(["/augeas/files/foo/error"])
+ @augeas.expects(:match).with("/augeas/files/foo/error/*").returns(["/augeas/files/foo/error/path", "/augeas/files/foo/error/message"])
+ @augeas.expects(:get).with("/augeas/files/foo/error/path").returns("/foo")
+ @augeas.expects(:get).with("/augeas/files/foo/error/message").returns("Failed to...")
+ end
+
+ it "and output to debug" do
+ @provider.expects(:debug).times(4)
+ @provider.print_load_errors
+ end
+
+ it "and output a warning and to debug" do
+ @provider.expects(:warning).once()
+ @provider.expects(:debug).times(3)
+ @provider.print_load_errors(:warning => true)
+ end
+ end
+
+ it "should find save errors and output to debug" do
@augeas.expects(:match).with("/augeas//error[. = 'put_failed']").returns(["/augeas/files/foo/error"])
@augeas.expects(:match).with("/augeas/files/foo/error/*").returns(["/augeas/files/foo/error/path", "/augeas/files/foo/error/message"])
@augeas.expects(:get).with("/augeas/files/foo/error/path").returns("/foo")
@@ -638,11 +658,18 @@
aug.match("/files/etc/test").should == []
end
+ it "should report load errors to debug only" do
+ @provider.expects(:print_load_errors).with(:warning => false)
+ aug = @provider.open_augeas
+ aug.should_not == nil
+ end
+
# Only the file specified should be loaded
it "should load one file if incl/lens used" do
@resource[:incl] = "/etc/hosts"
@resource[:lens] = "Hosts.lns"
+ @provider.expects(:print_load_errors).with(:warning => true)
aug = @provider.open_augeas
aug.should_not == nil
aug.match("/files/etc/fstab").should == []
@@ -665,6 +692,7 @@
it "should only load one file if relevant context given" do
@resource[:context] = "/files/etc/fstab"
+ @provider.expects(:print_load_errors).with(:warning => true)
aug = @provider.open_augeas
aug.should_not == nil
aug.match("/files/etc/fstab").should == ["/files/etc/fstab"]
-- You received this message because you are subscribed to the Google Groups "Puppet Developers" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to [email protected].
For more options, visit this group at http://groups.google.com/group/puppet-dev?hl=en.
