rspec-puppet-augeas 0.1.0 → 0.2.0

data/Gemfile

@@ -1,3 +1,10 @@
 source :rubygems
 
+gem 'puppetlabs_spec_helper'
 gem 'rspec-puppet'
+gem 'ruby-augeas'
+
+group :test do
+  gem 'puppet'
+  gem 'rake'
+end

data/README.md

@@ -1,7 +1,5 @@
 # RSpec tests for Augeas resources inside Puppet manifests
 
-## Summary
-
 rspec-puppet-augeas is an extension of rodjek's popular rspec-puppet tool.  It
 adds to your RSpec tests for a single class or define (or anything resulting in
 a catalog) and allows you to run and test individual Augeas resources within it.
@@ -109,6 +107,19 @@ the resource.  Some require certain options, which can be supplied in the
   `:target` and `:lens`), returns the value of the node
 * `aug_match(path)` runs `Augeas#match(path)` against the target file (expects
   `:target` and `:lens`), returns an array of matches
+* `augparse(result)` runs the augparse utility against the target file (expects
+  `:target` and `:lens`) and verifies the file matches the `{ "key" = "value"
+  }` augparse tree notation.  Call without an argument to get the current tree
+  back.
+  * `augparse()` raises error containing `{ "key" = "value" }` tree for the
+    whole file
+  * `augparse('{ "key" = "value" }')` verifies the target matches supplied tree
+* `augparse_filter(filter, result)` takes the target file and all nodes matching
+  the given filter, then runs the resulting file through augparse as above.
+  * `augparse_filter('*[label()!="#comment"]')` raises error containing tree for
+    the filtered file (all non-comment entries)
+  * `augparse_filter('*[label()!="#comment"]', '{ "key" = "value" }')` verifies
+    the filtered file (all non-comment entries) matches supplied tree
 
 ### RSpec configuration
 

data/lib/rspec-puppet-augeas/example/run_augeas_example_group.rb

@@ -14,9 +14,10 @@ module RSpec::Puppet::Augeas
       #     :lens    => lens used for opening target
       def run_augeas(*args, &block)
         options = args.last.is_a?(::Hash) ? args.pop : {}
+        args << { :type => :augeas }
 
         title = "Augeas[#{args.shift}]"
-        describe(title, *args, :type => :augeas) do
+        describe(title, *args) do
           # inside here (the type augeas block), subject will be initialised
           # to the augeas resource object
 

data/lib/rspec-puppet-augeas/test_utils.rb

@@ -30,8 +30,9 @@ module RSpec::Puppet::Augeas
       file = "/#{file}" unless file.start_with? '/'
       lens = opts[:lens] || self.lens or raise ArgumentError, ":lens must be supplied"
       lens = "#{lens}.lns" unless lens.include? '.'
+      root = opts[:root] || self.output_root
 
-      aug = Augeas.open(self.output_root, nil, Augeas::NO_MODL_AUTOLOAD)
+      aug = Augeas.open(root, nil, Augeas::NO_MODL_AUTOLOAD)
       begin
         aug.transform(
           :lens => lens,
@@ -57,15 +58,14 @@ module RSpec::Puppet::Augeas
     end
 
     # Creates a simple test file, reads in a fixture (that's been modified by
-    # the provider) and runs augparse against the expected tree.
-    def augparse(opts = {})
+    # the resource) and runs augparse against the expected tree.
+    def augparse(result = "?", opts = {})
       file = opts[:target] || self.target or raise ArgumentError, ":target must be supplied"
-      file = File.join(self.output_path, file) unless file.start_with? '/'
+      file = File.join(self.output_root, file) unless file.start_with? '/'
       lens = opts[:lens] || self.lens or raise ArgumentError, ":lens must be supplied"
       lens = "#{lens}.lns" unless lens.include? '.'
-      result = opts[:result] || "?"
 
-      Dir.mktmpdir { |dir|
+      Dir.mktmpdir("rpa-augparse") do |dir|
         # Augeas always starts with a blank line when creating new files, so
         # reprocess file and remove it to make writing tests easier
         File.open("#{dir}/input", "w") do |finput|
@@ -77,18 +77,18 @@ module RSpec::Puppet::Augeas
         end
 
         # Test module, Augeas reads back in the input file
-        testaug = "#{dir}/test_augeasproviders.aug"
-        File.open(testaug, "w") { |tf|
+        testaug = "#{dir}/test_rspec_puppet_augeas.aug"
+        File.open(testaug, "w") do |tf|
           tf.write(<<eos)
-module Test_Augeasproviders =
+module Test_Rspec_Puppet_Augeas =
   test #{lens} get Sys.read_file "#{dir}/input" =
     #{result}
 eos
-        }
+        end
 
         output = %x(augparse #{testaug} 2>&1)
         raise RSpec::Puppet::Augeas::Error, "augparse failed:\n#{output}" unless $? == 0 && output.empty?
-      }
+      end
     end
 
     # Takes a full fixture file, loads it in Augeas, uses the relative path
@@ -98,23 +98,21 @@ eos
     #
     # Because the filtered fragment is saved in a new file, seq labels will reset
     # too, so it'll be "1" rather than what it was in the original fixture.
-    def augparse_filter(opts = {})
+    def augparse_filter(filter = "*[label()!='#comment']", result = "?", opts = {})
       file = opts[:target] || self.target or raise ArgumentError, ":target must be supplied"
-      file = File.join(self.output_path, file) unless file.start_with? '/'
+      file = File.join(self.output_root, file) unless file.start_with? '/'
       lens = opts[:lens] || self.lens or raise ArgumentError, ":lens must be supplied"
       lens = "#{lens}.lns" unless lens.include? '.'
-      filter = opts[:filter] or raise ArgumentError, ":filter must be supplied"
-      result = opts[:result] || "?"
 
       # duplicate the original since we use aug.mv
-      tmpin = Tempfile.new("original")
+      tmpin = Tempfile.new("rpa-original")
       tmpin.write(File.read(file))
       tmpin.close
 
-      tmpout = Tempfile.new("filtered")
+      tmpout = Tempfile.new("rpa-filtered")
       tmpout.close
 
-      aug_open(tmpin.path, lens) do |aug|
+      aug_open(opts.merge(:root => '/', :target => tmpin.path)) do |aug|
         # Load a transform of the target, so Augeas can write into it
         aug.transform(
           :lens => lens,
@@ -139,10 +137,10 @@ eos
         aug.save!
       end
 
-      augparse(tmpout.path, lens, result)
+      augparse(result, opts.merge(:root => '/', :target => tmpout.path))
     ensure
-      tmpin.unlink
-      tmpout.unlink
+      tmpin.unlink if tmpin
+      tmpout.unlink if tmpout
     end
   end
 end

data/rspec-puppet-augeas.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'rspec-puppet-augeas'
-  s.version = '0.1.0'
+  s.version = '0.2.0'
   s.homepage = 'https://github.com/domcleal/rspec-puppet-augeas/'
   s.summary = 'RSpec tests for Augeas resources in Puppet manifests'
   s.description = 'RSpec tests for Augeas resources in Puppet manifests'

data/spec/classes/sshd_config_spec.rb

@@ -55,4 +55,27 @@ describe 'sshd' do
       should_not execute.idempotently
     end
   end
+
+  describe 'augparse' do
+    describe_augeas 'root login', :lens => 'Sshd', :target => 'etc/ssh/sshd_config', :fixture => 'etc/ssh/sshd_config_2' do
+      it 'should run augparse against the whole file' do
+        should execute.with_change
+        augparse('
+          { "#comment" = "Fixture 2" }
+          { "PermitRootLogin" = "yes" }
+        ')
+      end
+    end
+  end
+
+  describe 'augparse_filter' do
+    describe_augeas 'root login', :lens => 'Sshd', :target => 'etc/ssh/sshd_config', :fixture => 'etc/ssh/sshd_config_2' do
+      it 'should filter non-comments' do
+        should execute.with_change
+        augparse_filter('*[label() != "#comment"]', '
+          { "PermitRootLogin" = "yes" }
+        ')
+      end
+    end
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-puppet-augeas
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-28 00:00:00.000000000 Z
+date: 2013-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-puppet