From 9e0256aabfd58dfce8cff65147722a844f56e006 Mon Sep 17 00:00:00 2001 From: Chris Price Date: Thu, 7 Jun 2012 09:09:14 -0700 Subject: Add support for a 'match' parameter to file_line This commit adds a new parameter called "match" to the file_line resource type, and support for this new parameter to the corresponding ruby provider. This parameter is optional; file_line should work just as before if you do not specify this parameter... so this change should be backwards-compatible. If you do specify the parameter, it is treated as a regular expression that should be used when looking through the file for a line. This allows you to do things like find a line that begins with a certain prefix (e.g., "foo=.*"), and *replace* the existing line with the line you specify in your "line" parameter. Without this capability, if you already had a line "foo=bar" in your file and your "line" parameter was set to "foo=baz", you'd end up with *both* lines in the final file. In many cases this is undesirable. --- lib/puppet/provider/file_line/ruby.rb | 36 +++++++++++++++++++++++++++++++++-- lib/puppet/type/file_line.rb | 12 ++++++++++++ 2 files changed, 46 insertions(+), 2 deletions(-) (limited to 'lib/puppet') diff --git a/lib/puppet/provider/file_line/ruby.rb b/lib/puppet/provider/file_line/ruby.rb index f5d3a32..e21eaa8 100644 --- a/lib/puppet/provider/file_line/ruby.rb +++ b/lib/puppet/provider/file_line/ruby.rb @@ -1,3 +1,4 @@ + Puppet::Type.type(:file_line).provide(:ruby) do def exists? @@ -7,8 +8,10 @@ Puppet::Type.type(:file_line).provide(:ruby) do end def create - File.open(resource[:path], 'a') do |fh| - fh.puts resource[:line] + if resource[:match] + handle_create_with_match() + else + handle_create_without_match() end end @@ -21,7 +24,36 @@ Puppet::Type.type(:file_line).provide(:ruby) do private def lines + # If this type is ever used with very large files, we should + # write this in a different way, using a temp + # file; for now assuming that this type is only used on + # small-ish config files that can fit into memory without + # too much trouble. @lines ||= File.readlines(resource[:path]) end + def handle_create_with_match() + regex = resource[:match] ? Regexp.new(resource[:match]) : nil + match_count = lines.select { |l| regex.match(l) }.count + if match_count > 1 + raise Puppet::Error, "More than one line in file '#{resource[:path]}' matches pattern '#{resource[:match]}'" + end + File.open(resource[:path], 'w') do |fh| + lines.each do |l| + fh.puts(regex.match(l) ? resource[:line] : l) + end + + if (match_count == 0) + fh.puts(resource[:line]) + end + end + end + + def handle_create_without_match + File.open(resource[:path], 'a') do |fh| + fh.puts resource[:line] + end + end + + end diff --git a/lib/puppet/type/file_line.rb b/lib/puppet/type/file_line.rb index f6fe1d0..6b35902 100644 --- a/lib/puppet/type/file_line.rb +++ b/lib/puppet/type/file_line.rb @@ -32,6 +32,11 @@ Puppet::Type.newtype(:file_line) do desc 'An arbitrary name used as the identity of the resource.' end + newparam(:match) do + desc 'An optional regular expression to run against existing lines in the file;\n' + + 'if a match is found, we replace that line rather than adding a new line.' + end + newparam(:line) do desc 'The line to be appended to the file located by the path parameter.' end @@ -49,5 +54,12 @@ Puppet::Type.newtype(:file_line) do unless self[:line] and self[:path] raise(Puppet::Error, "Both line and path are required attributes") end + + if (self[:match]) + unless Regexp.new(self[:match]).match(self[:line]) + raise(Puppet::Error, "When providing a 'match' parameter, the value must be a regex that matches against the value of your 'line' parameter") + end + end + end end -- cgit v1.2.3