rspec-puppet-augeas 0.2.0 → 0.2.1

data/.gitignore

@@ -1,3 +1,4 @@
+coverage/
 pkg/
 *.gem
 Gemfile.lock

data/Gemfile

@@ -7,4 +7,5 @@ gem 'ruby-augeas'
 group :test do
   gem 'puppet'
   gem 'rake'
+  gem 'simplecov'
 end

data/README.md

@@ -23,7 +23,7 @@ Extend your usual rspec-puppet class test, e.g. for the 'sshd' class:
       end
 
       # Expects Augeas['root login']
-      describe_augeas 'root login' do
+      describe_augeas 'root login', :lens => 'Sshd', :target => 'etc/ssh/sshd_config' do
         it 'should change PermitRootLogin' do
           # Run the resource against the fixtures, check it changed
           should execute.with_change
@@ -57,6 +57,9 @@ fixtures directory.
 
 ## Usage
 
+Read the spec file(s) at `spec/classes/*.rb` to see various real-life examples
+of the features below.
+
 ### describe\_augeas example group
 
 `describe_augeas` adds an example group, like describe/context, but that describes
@@ -69,13 +72,14 @@ It takes optional hash arguments:
   * a hash of fixtures to copy from the source (under augeas\_fixtures) to a
     destination path, e.g. `{ 'dest/file/location' => 'src/file/location' }`
   * a string of the source path, copied to the path given by the resource's
-    `incl` parameter (TODO: or `:target`)
+    `incl` parameter or `:target`
   * nil, by default copies all fixtures
 * `:target` is the path of the file that the resource should modify 
 * `:lens` is the lens to use when opening the target file (for `aug_*` etc.)
 
 It sets the following variables inside examples:
 
+* `resource` to the Puppet resource object
 * `subject` (used implicitly) to an object representing the resource
 * `output_root` to the path of the fixtures directory after one run
 
@@ -128,6 +132,11 @@ New RSpec configuration options:
 * `augeas_fixtures` is the path to the root of the fixtures directory
   containing source files
 
+## Background reading
+
+This module inherited code from the tests used in [augeasproviders](http://augeasproviders.com).
+The test methodology is described in [Testing techniques for Puppet providers using Augeas](http://augeasproviders.com/documentation/specs.html).
+
 ## Issues
 
 Please file any issues or suggestions [on GitHub](https://github.com/domcleal/rspec-puppet-augeas/issues).

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

@@ -22,17 +22,24 @@ module RSpec::Puppet::Augeas
           # to the augeas resource object
 
           # initialise arguments passed into the run_augeas block
-          # TODO: target can be initialised from incl if available
           target = options.delete(:target)
-          let(:target) { target }
+          let(:target) do
+            target || resource[:incl]
+          end
 
-          # TODO: ditto
           lens = options.delete(:lens)
-          let(:lens) { lens }
+          let(:lens) do
+            lens || resource[:lens]
+          end
 
           fixture = options.delete(:fixture)
-          fixture = { target => fixture } if fixture.is_a? String and target
-          let(:fixture) { fixture }
+          let(:fixture) do
+            if fixture and !fixture.is_a? Hash
+              raise ArgumentError, ":target must be supplied" unless self.target
+              fixture = { self.target => fixture.to_s }
+            end
+            fixture
+          end
 
           class_exec(&block)
         end
@@ -45,19 +52,23 @@ module RSpec::Puppet::Augeas
     end
 
     module InstanceMethods
-      # Initialises the implicit example group 'subject' to an Augeas resource
-      #
       # Requires that the title of this example group is the resource title and
       # that the parent example group subject is a catalog (use rspec-puppet)
-      def subject
+      def resource
         unless @resource
           title = self.class.description
           title = $1 if title =~ /^Augeas\[(.*)\]$/
-          @resource = Resource.new(catalogue.resource('Augeas', title), fixture)
+          @resource = catalogue.resource('Augeas', title)
         end
         @resource
       end
 
+      # Initialises the implicit example group 'subject' to a wrapped Augeas
+      # resource
+      def subject
+        @subject ||= Resource.new(self.resource, fixture)
+      end
+
       def output_root
         subject.root
       end

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

@@ -6,8 +6,6 @@ module RSpec::Puppet::Augeas
   module Fixtures
     # Copies test fixtures to a temporary directory
     # If file is nil, copies the entire augeas_fixtures directory
-    # If file is a string, it copies that file from augeas_fixtures
-    #   to the path being edited by the resource
     # If file is a hash, it copies the "value" from augeas_fixtures
     #   to each "key" path
     def load_fixtures(resource, file)
@@ -26,28 +24,15 @@ module RSpec::Puppet::Augeas
     def prepare_fixtures(dir, resource, file)
       if file.nil?
         FileUtils.cp_r File.join(RSpec.configuration.augeas_fixtures, "."), dir
-      elsif file.is_a? Hash
+      else
         file.each do |dest,src|
           FileUtils.mkdir_p File.join(dir, File.dirname(dest))
           src = File.join(RSpec.configuration.augeas_fixtures, src) unless src.start_with? File::SEPARATOR
           FileUtils.cp_r src, File.join(dir, dest)
         end
-      elsif file.respond_to? :to_s
-        target = get_resource_target(resource)
-        raise ArgumentError, "Unable to determine file being edited from #{resource.name}.  Supply :fixtures as a hash of { '/dest/path' => 'source/fixture/path' } instead." unless target
-        FileUtils.mkdir_p File.join(dir, File.dirname(target))
-        FileUtils.cp File.join(RSpec.configuration.augeas_fixtures, file.to_s), File.join(dir, target)
       end
     end
 
-    # Take a best guess at the file the user's editing
-    def get_resource_target(resource)
-      return resource[:incl] if resource[:incl]
-      # TODO: make reliable
-      #return $1 if resource[:context] and resource[:context] =~ %r{/files(/.*)}
-      nil
-    end
-
     # Runs a particular resource via a catalog
     def apply(resource)
       catalog = Puppet::Resource::Catalog.new

data/rspec-puppet-augeas.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'rspec-puppet-augeas'
-  s.version = '0.2.0'
+  s.version = '0.2.1'
   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'
@@ -29,6 +29,7 @@ Gem::Specification.new do |s|
   ]
 
   s.add_dependency 'rspec-puppet'
+  s.add_dependency 'puppetlabs_spec_helper'
 
   s.authors = ['Dominic Cleal']
   s.email = 'dcleal@redhat.com'

data/spec/classes/sshd_config_spec.rb

@@ -1,25 +1,50 @@
 require 'spec_helper'
 
+# Tests all features of rspec-puppet-augeas against the class under
+# spec/fixtures/module/sshd/manifests/init.pp
 describe 'sshd' do
+  # Basic rspec-puppet example
   it 'should have an augeas resource' do
     should contain_augeas('root login')
   end
 
+  # Basic rspec-puppet-example
+  #   uses all fixtures, lens + target are specified for aug_* functions to work
   describe 'specify target+lens upfront, use all fixtures' do
     describe_augeas 'root login', :lens => 'Sshd', :target => 'etc/ssh/sshd_config' do
       it 'should test resource' do
+        # Verify this is the right fixture, using Augeas and simple parsing
         aug_get('#comment[1]').should =~ /OpenBSD/
         open_target { |f| f.readline.should =~ /OpenBSD/ }
 
+        # Check it changes
         should execute.with_change
         aug_get('PermitRootLogin').should == 'yes'
         open_target { |f| f.read.should =~ /^PermitRootLogin\s+yes$/ }
 
+        # Idempotency test last, as a broken resource may cause false positives
         should execute.idempotently
       end
     end
   end
 
+  # Example of using a second fixture file to test a resource
+  describe 'specify target and non-standard fixture' do
+    describe_augeas 'root login', :lens => 'Sshd', :target => 'etc/ssh/sshd_config', :fixture => 'etc/ssh/sshd_config_2' do
+      it 'should test resource with second fixture' do
+        aug_get('#comment[1]').should == 'Fixture 2'
+        should execute.with_change
+        aug_get('PermitRootLogin').should == 'yes'
+        should execute.idempotently
+      end
+    end
+  end
+
+  # Fixtures can be a hash of destination path to source fixture path
+  # Note that all paths are relative to augeas_fixtures (in spec_helper.rb)
+  # and have no leading /
+  #
+  # Unusually, lens + target are specified on each aug_* function instead here.
   describe 'specify fixtures as a hash' do
     describe_augeas 'root login', :fixture => { 'etc/ssh/sshd_config' => 'etc/ssh/sshd_config_2' } do
       it 'should test resource with second fixture' do
@@ -31,9 +56,10 @@ describe 'sshd' do
     end
   end
 
-  describe 'specify target and non-standard fixture' do
-    describe_augeas 'root login', :lens => 'Sshd', :target => 'etc/ssh/sshd_config', :fixture => 'etc/ssh/sshd_config_2' do
-      it 'should test resource with second fixture' do
+  # When incl/lens are given on the resource, :target and :lens are resolved
+  describe 'target detection from resource' do
+    describe_augeas 'incl root login', :fixture => 'etc/ssh/sshd_config_2' do
+      it 'should test resource with second fixture at incl location' do
         aug_get('#comment[1]').should == 'Fixture 2'
         should execute.with_change
         aug_get('PermitRootLogin').should == 'yes'
@@ -42,20 +68,10 @@ describe 'sshd' do
     end
   end
 
-  describe_augeas 'fail to add root login' do
-    it 'should fail to run entirely' do
-      should_not execute
-    end
-  end
-
-  run_augeas 'add root login', :lens => 'Sshd', :target => 'etc/ssh/sshd_config' do
-    it 'should fail on idempotency' do
-      should execute.with_change
-      aug_match('PermitRootLogin').size.should == 2
-      should_not execute.idempotently
-    end
-  end
-
+  # Other test utilities:
+  # augparse compares the entire fixture file to the { "key" = "value" } tree.
+  # Call augparse with no argument initially and it will print out the tree
+  # representation of the fixture file for reference.
   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
@@ -68,6 +84,8 @@ describe 'sshd' do
     end
   end
 
+  # augparse_filter first runs a filter against the fixture file before running
+  # it through augparse.  Here, it filters out all non-comment entries.
   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
@@ -78,4 +96,20 @@ describe 'sshd' do
       end
     end
   end
+
+  # Testing for deliberate failure
+  describe_augeas 'fail to add root login' do
+    it 'should fail to run entirely' do
+      should_not execute
+    end
+  end
+
+  # Testing for deliberate idempotency failure
+  run_augeas 'add root login', :lens => 'Sshd', :target => 'etc/ssh/sshd_config' do
+    it 'should fail on idempotency' do
+      should execute.with_change
+      aug_match('PermitRootLogin').size.should == 2
+      should_not execute.idempotently
+    end
+  end
 end

data/spec/fixtures/modules/sshd/manifests/init.pp

@@ -4,6 +4,12 @@ class sshd {
     changes => 'set PermitRootLogin yes',
   }
 
+  augeas { "incl root login":
+    incl    => '/etc/ssh/sshd_config',
+    lens    => 'Sshd.lns',
+    changes => 'set PermitRootLogin yes',
+  }
+
   augeas { "add root login":
     context => '/files/etc/ssh/sshd_config',
     changes => [

data/spec/spec_helper.rb

@@ -1,3 +1,8 @@
+require 'simplecov'
+SimpleCov.start do
+  add_filter "/spec/"
+end
+
 require 'rspec-puppet-augeas'
 
 RSpec.configure do |c|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rspec-puppet-augeas
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-29 00:00:00.000000000 Z
+date: 2013-01-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-puppet
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: puppetlabs_spec_helper
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: RSpec tests for Augeas resources in Puppet manifests
 email: dcleal@redhat.com
 executables: []