X-Git-Url: https://git.adam-barratt.org.uk/?a=blobdiff_plain;f=3rdparty%2Fmodules%2Fstdlib%2Flib%2Fpuppet%2Fparser%2Ffunctions%2Fvalidate_cmd.rb;h=592d0ee327349aea320fb285e81769bcac8a929f;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hp=5df3c6094cb5958346c4944d4fb3a85133d26498;hpb=ad88f67c13ae0f1a08936dad643f1e3509ab5f40;p=mirror%2Fdsa-puppet.git

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/validate_cmd.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/validate_cmd.rb
index 5df3c6094..592d0ee32 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/validate_cmd.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/validate_cmd.rb
@@ -1,31 +1,39 @@
 require 'puppet/util/execution'
 require 'tempfile'
 
+#
+# validate_cmd.rb
+#
 module Puppet::Parser::Functions
-  newfunction(:validate_cmd, :doc => <<-'ENDHEREDOC') do |args|
-    Perform validation of a string with an external command.
+  newfunction(:validate_cmd, :doc => <<-DOC
+    @summary
+      Perform validation of a string with an external command.
+
     The first argument of this function should be a string to
     test, and the second argument should be a path to a test command
     taking a % as a placeholder for the file path (will default to the end).
     If the command, launched against a tempfile containing the passed string,
     returns a non-null value, compilation will abort with a parse error.
-
     If a third argument is specified, this will be the error message raised and
     seen by the user.
 
+    @return
+      validate of a string with an external command
+
     A helpful error message can be returned like this:
 
-    Example:
+    @example **Usage**
 
-        # Defaults to end of path
+      Defaults to end of path
         validate_cmd($sudoerscontent, '/usr/sbin/visudo -c -f', 'Visudo failed to validate sudoers content')
 
-        # % as file location
+      % as file location
         validate_cmd($haproxycontent, '/usr/sbin/haproxy -f % -c', 'Haproxy failed to validate config content')
 
-    ENDHEREDOC
-    if (args.length < 2) or (args.length > 3) then
-      raise Puppet::ParseError, ("validate_cmd(): wrong number of arguments (#{args.length}; must be 2 or 3)")
+    DOC
+             ) do |args|
+    if (args.length < 2) || (args.length > 3)
+      raise Puppet::ParseError, "validate_cmd(): wrong number of arguments (#{args.length}; must be 2 or 3)"
     end
 
     msg = args[2] || "validate_cmd(): failed to validate content with command #{args[1].inspect}"
@@ -34,16 +42,16 @@ module Puppet::Parser::Functions
     checkscript = args[1]
 
     # Test content in a temporary file
-    tmpfile = Tempfile.new("validate_cmd")
+    tmpfile = Tempfile.new('validate_cmd')
     begin
       tmpfile.write(content)
       tmpfile.close
 
-      if checkscript =~ /\s%(\s|$)/
-        check_with_correct_location = checkscript.gsub(/%/,tmpfile.path)
-      else
-        check_with_correct_location = "#{checkscript} #{tmpfile.path}"
-      end
+      check_with_correct_location = if checkscript =~ %r{\s%(\s|$)}
+                                      checkscript.gsub(%r{%}, tmpfile.path)
+                                    else
+                                      "#{checkscript} #{tmpfile.path}"
+                                    end
 
       if Puppet::Util::Execution.respond_to?('execute')
         Puppet::Util::Execution.execute(check_with_correct_location)
@@ -53,7 +61,7 @@ module Puppet::Parser::Functions
     rescue Puppet::ExecutionFailure => detail
       msg += "\n#{detail}"
       raise Puppet::ParseError, msg
-    rescue Exception => detail
+    rescue StandardError => detail
       msg += "\n#{detail.class.name} #{detail}"
       raise Puppet::ParseError, msg
     ensure