From 4c93090e1aad8dfdaa39b4f304d3c87704408b13 Mon Sep 17 00:00:00 2001 From: Jeff McCune Date: Thu, 4 Aug 2011 19:17:48 -0700 Subject: (#8792) Rename whole_line type to file_line Without this patch the resource whole_line would be included in the stable stdlib module shipping in PE 1.2. Ideally the name will be stable and unchanging in the future. There was quite a bit of concern over whole_line being an unwise name. file_line appears to be the most suitable name and least likely to need another rename in the future. --- lib/puppet/provider/file_line/ruby.rb | 15 ++++++++ lib/puppet/provider/whole_line/ruby.rb | 15 -------- lib/puppet/type/file_line.rb | 44 +++++++++++++++++++++++ lib/puppet/type/whole_line.rb | 44 ----------------------- spec/unit/puppet/provider/file_line/ruby_spec.rb | 30 ++++++++++++++++ spec/unit/puppet/provider/whole_line/ruby_spec.rb | 30 ---------------- spec/unit/puppet/type/file_line_spec.rb | 24 +++++++++++++ spec/unit/puppet/type/whole_line_spec.rb | 24 ------------- 8 files changed, 113 insertions(+), 113 deletions(-) create mode 100644 lib/puppet/provider/file_line/ruby.rb delete mode 100644 lib/puppet/provider/whole_line/ruby.rb create mode 100644 lib/puppet/type/file_line.rb delete mode 100644 lib/puppet/type/whole_line.rb create mode 100644 spec/unit/puppet/provider/file_line/ruby_spec.rb delete mode 100644 spec/unit/puppet/provider/whole_line/ruby_spec.rb create mode 100644 spec/unit/puppet/type/file_line_spec.rb delete mode 100644 spec/unit/puppet/type/whole_line_spec.rb diff --git a/lib/puppet/provider/file_line/ruby.rb b/lib/puppet/provider/file_line/ruby.rb new file mode 100644 index 0000000..63bbd8e --- /dev/null +++ b/lib/puppet/provider/file_line/ruby.rb @@ -0,0 +1,15 @@ +Puppet::Type.type(:file_line).provide(:ruby) do + + def exists? + File.readlines(resource[:path]).find do |line| + line.chomp == resource[:line].chomp + end + end + + def create + File.open(resource[:path], 'a') do |fh| + fh.puts resource[:line] + end + end + +end diff --git a/lib/puppet/provider/whole_line/ruby.rb b/lib/puppet/provider/whole_line/ruby.rb deleted file mode 100644 index 156f255..0000000 --- a/lib/puppet/provider/whole_line/ruby.rb +++ /dev/null @@ -1,15 +0,0 @@ -Puppet::Type.type(:whole_line).provide(:ruby) do - - def exists? - File.readlines(resource[:path]).find do |line| - line.chomp == resource[:line].chomp - end - end - - def create - 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 new file mode 100644 index 0000000..aacd6d9 --- /dev/null +++ b/lib/puppet/type/file_line.rb @@ -0,0 +1,44 @@ +Puppet::Type.newtype(:file_line) do + + desc <<-EOT + Type that can append whole a line to a file if it does not already contain it. + + Example: + + file_line { 'sudo_rule': + path => '/etc/sudoers', + line => '%admin ALL=(ALL) ALL', + } + + EOT + + ensurable do + defaultto :present + newvalue(:present) do + provider.create + end + end + + newparam(:name, :namevar => true) do + desc 'arbitrary name used as identity' + end + + newparam(:line) do + desc 'The line to be appended to the path.' + end + + newparam(:path) do + desc 'File to possibly append a line to.' + validate do |value| + unless (Puppet.features.posix? and value =~ /^\//) or (Puppet.features.microsoft_windows? and (value =~ /^.:\// or value =~ /^\/\/[^\/]+\/[^\/]+/)) + raise(Puppet::Error, "File paths must be fully qualified, not '#{value}'") + end + end + end + + validate do + unless self[:line] and self[:path] + raise(Puppet::Error, "Both line and path are required attributes") + end + end +end diff --git a/lib/puppet/type/whole_line.rb b/lib/puppet/type/whole_line.rb deleted file mode 100644 index f231602..0000000 --- a/lib/puppet/type/whole_line.rb +++ /dev/null @@ -1,44 +0,0 @@ -Puppet::Type.newtype(:whole_line) do - - desc <<-EOT - Type that can append whole a line to a file if it does not already contain it. - - Example: - - whole_line { 'sudo_rule': - path => '/etc/sudoers', - line => '%admin ALL=(ALL) ALL', - } - - EOT - - ensurable do - defaultto :present - newvalue(:present) do - provider.create - end - end - - newparam(:name, :namevar => true) do - desc 'arbitrary name used as identity' - end - - newparam(:line) do - desc 'The line to be appended to the path.' - end - - newparam(:path) do - desc 'File to possibly append a line to.' - validate do |value| - unless (Puppet.features.posix? and value =~ /^\//) or (Puppet.features.microsoft_windows? and (value =~ /^.:\// or value =~ /^\/\/[^\/]+\/[^\/]+/)) - raise(Puppet::Error, "File paths must be fully qualified, not '#{value}'") - end - end - end - - validate do - unless self[:line] and self[:path] - raise(Puppet::Error, "Both line and path are required attributes") - end - end -end diff --git a/spec/unit/puppet/provider/file_line/ruby_spec.rb b/spec/unit/puppet/provider/file_line/ruby_spec.rb new file mode 100644 index 0000000..b03fc0e --- /dev/null +++ b/spec/unit/puppet/provider/file_line/ruby_spec.rb @@ -0,0 +1,30 @@ +require 'puppet' +require 'tempfile' +provider_class = Puppet::Type.type(:file_line).provider(:ruby) +describe provider_class do + before :each do + tmp = Tempfile.new('tmp') + @tmpfile = tmp.path + tmp.close! + @resource = Puppet::Type::File_line.new( + {:name => 'foo', :path => @tmpfile, :line => 'foo'} + ) + @provider = provider_class.new(@resource) + end + it 'should detect if the line exists in the file' do + File.open(@tmpfile, 'w') do |fh| + fh.write('foo') + end + @provider.exists?.should be_true + end + it 'should detect if the line does not exist in the file' do + File.open(@tmpfile, 'w') do |fh| + fh.write('foo1') + end + @provider.exists?.should be_nil + end + it 'should append to an existing file when creating' do + @provider.create + File.read(@tmpfile).chomp.should == 'foo' + end +end diff --git a/spec/unit/puppet/provider/whole_line/ruby_spec.rb b/spec/unit/puppet/provider/whole_line/ruby_spec.rb deleted file mode 100644 index 9faff2c..0000000 --- a/spec/unit/puppet/provider/whole_line/ruby_spec.rb +++ /dev/null @@ -1,30 +0,0 @@ -require 'puppet' -require 'tempfile' -provider_class = Puppet::Type.type(:whole_line).provider(:ruby) -describe provider_class do - before :each do - tmp = Tempfile.new('tmp') - @tmpfile = tmp.path - tmp.close! - @resource = Puppet::Type::Whole_line.new( - {:name => 'foo', :path => @tmpfile, :line => 'foo'} - ) - @provider = provider_class.new(@resource) - end - it 'should detect if the line exists in the file' do - File.open(@tmpfile, 'w') do |fh| - fh.write('foo') - end - @provider.exists?.should be_true - end - it 'should detect if the line does not exist in the file' do - File.open(@tmpfile, 'w') do |fh| - fh.write('foo1') - end - @provider.exists?.should be_nil - end - it 'should append to an existing file when creating' do - @provider.create - File.read(@tmpfile).chomp.should == 'foo' - end -end diff --git a/spec/unit/puppet/type/file_line_spec.rb b/spec/unit/puppet/type/file_line_spec.rb new file mode 100644 index 0000000..7e07c06 --- /dev/null +++ b/spec/unit/puppet/type/file_line_spec.rb @@ -0,0 +1,24 @@ +require 'puppet' +require 'tempfile' +describe Puppet::Type.type(:file_line) do + before :each do + @file_line = Puppet::Type.type(:file_line).new(:name => 'foo', :line => 'line', :path => '/tmp/path') + end + it 'should accept a line and path' do + @file_line[:line] = 'my_line' + @file_line[:line].should == 'my_line' + end + it 'should accept posix filenames' do + @file_line[:path] = '/tmp/path' + @file_line[:path].should == '/tmp/path' + end + it 'should not accept unqualified path' do + expect { @file_line[:path] = 'file' }.should raise_error(Puppet::Error, /File paths must be fully qualified/) + end + it 'should require that a line is specified' do + expect { Puppet::Type.type(:file_line).new(:name => 'foo', :path => '/tmp/file') }.should raise_error(Puppet::Error, /Both line and path are required attributes/) + end + it 'should require that a file is specified' do + expect { Puppet::Type.type(:file_line).new(:name => 'foo', :line => 'path') }.should raise_error(Puppet::Error, /Both line and path are required attributes/) + end +end diff --git a/spec/unit/puppet/type/whole_line_spec.rb b/spec/unit/puppet/type/whole_line_spec.rb deleted file mode 100644 index f273baa..0000000 --- a/spec/unit/puppet/type/whole_line_spec.rb +++ /dev/null @@ -1,24 +0,0 @@ -require 'puppet' -require 'tempfile' -describe Puppet::Type.type(:whole_line) do - before :each do - @whole_line = Puppet::Type.type(:whole_line).new(:name => 'foo', :line => 'line', :path => '/tmp/path') - end - it 'should accept a line and path' do - @whole_line[:line] = 'my_line' - @whole_line[:line].should == 'my_line' - end - it 'should accept posix filenames' do - @whole_line[:path] = '/tmp/path' - @whole_line[:path].should == '/tmp/path' - end - it 'should not accept unqualified path' do - expect { @whole_line[:path] = 'file' }.should raise_error(Puppet::Error, /File paths must be fully qualified/) - end - it 'should require that a line is specified' do - expect { Puppet::Type.type(:whole_line).new(:name => 'foo', :path => '/tmp/file') }.should raise_error(Puppet::Error, /Both line and path are required attributes/) - end - it 'should require that a file is specified' do - expect { Puppet::Type.type(:whole_line).new(:name => 'foo', :line => 'path') }.should raise_error(Puppet::Error, /Both line and path are required attributes/) - end -end -- cgit v1.2.3