rspec-puppet-augeas 0.2.3 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8f06061bfcf98a5fcbc5c74c34f24bbf6c6d0351
+  data.tar.gz: 4e3dbe939a0d3df172a1a830cb389e60e30af92e
+SHA512:
+  metadata.gz: 18c6661cab9a5458a711935a9245566c4441a1c73d2de328bc130a911f91f43aaaa9a481970389f92d0b309f31bcb41833a6e2f7d08b82612e882a4aa291fa2a
+  data.tar.gz: efd749b3d0333d63770aa8b0f09aa5bc2477ff59da6db9923d1f5f6628a226f08b3cb8b5767d961506b03e4ef0b167c594943d9eee9fab749c0688ba062a5ee0

data/.gitignore

@@ -1,4 +1,7 @@
 coverage/
 pkg/
 *.gem
+Gemfile.local
 Gemfile.lock
+.ruby-*
+.project

data/Gemfile

@@ -1,7 +1,7 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gem 'puppetlabs_spec_helper'
-gem 'rspec-puppet'
+gem 'rspec-puppet', '< 1.0.0'
 gem 'ruby-augeas'
 
 group :test do
@@ -9,3 +9,5 @@ group :test do
   gem 'rake'
   gem 'simplecov'
 end
+
+self.instance_eval(Bundler.read_file('Gemfile.local')) if File.exist? 'Gemfile.local'

data/README.md

@@ -13,6 +13,8 @@ Augeas-based tools to help verify the modification was made.
 Install the gem first:
 
     gem install rspec-puppet-augeas
+    
+**Note:** The `ruby-augeas` gem and the augeas tools and development libraries are also required.
 
 Extend your usual rspec-puppet class test, e.g. for the 'sshd' class:
 
@@ -55,6 +57,16 @@ fixtures directory.
       c.augeas_fixtures = File.join(File.dirname(File.expand_path(__FILE__)), 'fixtures', 'augeas')
     end
 
+If you have custom lenses in your module dir, puppetlabs_spec_helper will deal with the
+augeas libdir. You will however have to let the rspec-puppet-augeas module know they
+are not in your default augeas lens dir. You can do so by using configuring the augeas_lensdir.
+
+    require 'rspec-puppet-augeas'
+    RSpec.configure do |c|
+      c.augeas_fixtures = File.join(File.dirname(File.expand_path(__FILE__)), 'fixtures', 'augeas')
+      c.augeas_lensdir = File.join(File.dirname(File.expand_path(__FILE__)), '..', 'lib/augeas/lenses')
+    end
+
 ## Usage
 
 Read the spec file(s) at `spec/classes/*.rb` to see various real-life examples
@@ -97,7 +109,7 @@ The `execute` matcher is used to check how a resource has run, e.g.
 It has methods to add to the checks it performs:
 
 * `with_change` ensures the resource was "applied" and didn't no-op
-* `idempotently` runs the resource again to ensure it only applies once
+* `idempotently` runs the resource again to ensure it applies a maximum of once
 
 ### Test utilities
 
@@ -135,6 +147,43 @@ New RSpec configuration options:
 * `augeas_fixtures` is the path to the root of the fixtures directory
   containing source files
 
+## Travis configuration
+
+It is possible to add `rspec-puppet-augeas` to your [Travis](https://travis-ci.org) configuration. This requires the following additions to your Travis configuration files:
+
+### Changes to `.travis.yml`
+
+The augeas packages need to be installed in the `before_install` block:
+
+```yml
+before_install:
+  - sudo apt-get install -qq augeas-tools augeas-lenses libaugeas-dev
+```
+
+### Changes to `Gemfile`
+
+The `rspec-puppet-augeas` and `ruby-augeas` gems need to be added into the development and test group:
+
+```ruby
+group :development, :test do
+  gem 'puppetlabs_spec_helper', :require => false
+  gem 'ruby-augeas', :require => false
+  gem 'rspec-puppet-augeas', :require => false
+end
+```
+
+### Changes to `spec/spec_helper.rb`
+
+These changes bring the fixtures required for `rspec-puppet-augeas` to work:
+
+```ruby
+require 'puppetlabs_spec_helper/module_spec_helper'
+require 'rspec-puppet-augeas'
+RSpec.configure do |c|
+  c.augeas_fixtures = File.join(File.dirname(File.expand_path(__FILE__)), 'fixtures', 'augeas')
+end
+```
+
 ## Background reading
 
 This module inherited code from the tests used in [augeasproviders](http://augeasproviders.com).

data/lib/rspec-puppet-augeas.rb

@@ -11,5 +11,6 @@ require 'rspec-puppet-augeas/test_utils'
 
 RSpec.configure do |c|
   c.add_setting :augeas_fixtures, :default => nil
+  c.add_setting :augeas_lensdir, :default => nil
   c.include RSpec::Puppet::Augeas::TestUtils, :type => :augeas
 end

data/lib/rspec-puppet-augeas/matchers/execute.rb

@@ -25,20 +25,21 @@ module RSpec::Puppet::Augeas::Matchers
       self
     end
 
-    # verifies the resource only applies once
+    # verifies the resource only applies never or once at max
     def idempotently
-      @change = true
       @idempotent = true
       self
     end
 
     def description
-      if idempotent
-        "should change once only (idempotently)"
+      if idempotent && change
+        "change once only (idempotently)"
+      elsif idempotent
+        "change at most once (idempotently)"
       elsif change
-        "should change successfully at least once"
+        "change successfully at least once"
       else
-        "should execute without failure"
+        "execute without failure"
       end
     end
 

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

@@ -31,8 +31,9 @@ module RSpec::Puppet::Augeas
       lens = opts[:lens] || self.lens or raise ArgumentError, ":lens must be supplied"
       lens = "#{lens}.lns" unless lens.include? '.'
       root = opts[:root] || self.output_root
+      lensdir = RSpec.configuration.augeas_lensdir || nil
 
-      aug = Augeas.open(root, nil, Augeas::NO_MODL_AUTOLOAD)
+      aug = Augeas.open(root, lensdir, Augeas::NO_MODL_AUTOLOAD)
       begin
         aug.transform(
           :lens => lens,
@@ -86,7 +87,7 @@ module Test_Rspec_Puppet_Augeas =
 eos
         end
 
-        output = %x(augparse #{testaug} 2>&1)
+        output = %x(augparse --notypecheck #{testaug} 2>&1)
         raise RSpec::Puppet::Augeas::Error, "augparse failed:\n#{output}" unless $? == 0 && output.empty?
       end
     end

data/rspec-puppet-augeas.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'rspec-puppet-augeas'
-  s.version = '0.2.3'
+  s.version = '0.3.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'
@@ -28,7 +28,7 @@ Gem::Specification.new do |s|
     'spec/spec_helper.rb'
   ]
 
-  s.add_dependency 'rspec-puppet'
+  s.add_dependency 'rspec-puppet', '< 1.0.0'
   s.add_dependency 'puppetlabs_spec_helper'
 
   s.authors = ['Dominic Cleal']

data/spec/classes/sshd_config_spec.rb

@@ -111,7 +111,7 @@ describe 'sshd' do
       # Verify the matcher message contains logs
       e = execute
       e.matches? subject
-      e.description.should =~ /should execute/
+      e.description.should =~ /execute/
       e.failure_message_for_should.should =~ /^err:.*false/
       e.failure_message_for_should_not.should =~ /^err:.*false/
       # Check for debug logs
@@ -129,7 +129,22 @@ describe 'sshd' do
       # Verify the matcher message contains logs
       e = execute
       e.with_change.matches? subject
-      e.description.should =~ /should change successfully/
+      e.description.should =~ /change successfully/
+      e.failure_message_for_should.should =~ /doesn't change/
+      e.failure_message_for_should_not.should =~ /changes/
+    end
+
+    it 'should be considered idempotent' do
+      should execute.idempotently
+    end
+
+    it 'should fail with both with_change and idempotently' do
+      should_not execute.with_change.idempotently
+
+      # Verify the matcher message contains logs
+      e = execute
+      e.with_change.idempotently.matches? subject
+      e.description.should =~ /change once only/
       e.failure_message_for_should.should =~ /doesn't change/
       e.failure_message_for_should_not.should =~ /changes/
     end
@@ -145,7 +160,7 @@ describe 'sshd' do
       # Verify the matcher message contains logs
       e = execute
       e.idempotently.matches? subject
-      e.description.should =~ /should change once only/
+      e.description.should =~ /change at most once/
       e.failure_message_for_should.should =~ /^notice:.*success/
       e.failure_message_for_should_not.should =~ /^notice:.*success/
     end

metadata

@@ -1,46 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: rspec-puppet-augeas
 version: !ruby/object:Gem::Version
-  version: 0.2.3
-  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - Dominic Cleal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-21 00:00:00.000000000 Z
+date: 2013-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec-puppet
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - <
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - <
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.0.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
@@ -71,26 +66,25 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/domcleal/rspec-puppet-augeas/
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.0.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: RSpec tests for Augeas resources in Puppet manifests
 test_files: []