rspec-puppet 0.0.1 → 0.0.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Tim Sharpe
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,126 @@
+# RSpec tests for your Puppet manifests
+
+## Installation
+
+    gem install rspec-puppet
+
+## Naming conventions
+
+For clarity and consistency, I recommend that you use the following directory
+structure and naming convention.
+
+    module
+      |
+      +-- manifests
+      |
+      +-- lib
+      |
+      +-- spec
+           |
+           +-- spec_helper.rb
+           |
+           +-- classes
+           |     |
+           |     +-- <class_name>_spec.rb
+           |
+           +-- defines
+                 |
+                 +-- <define_name>_spec.rb
+
+## Example groups
+
+If you use the above directory structure, your examples will automatically be
+placed in the correct groups and have access to the custom matchers.  If you
+choose not to, you can force the examples into the required groups as follows.
+
+    describe 'myclass', :type => :class do
+      ...
+    end
+
+    describe 'mydefine', :type => :define do
+      ...
+    end
+
+## Matchers
+
+### Checking if a class has been included
+
+You can test if a class has been included in the catalogue with the
+`include_class` matcher.  It takes the class name as a string as its only
+argument
+
+    it { should include_class('foo') }
+
+### Checking if a resources exists
+
+You can test if a resource exists in the catalogue with the generic
+`creates_<resource type>` matcher.  If your resource type includes :: (e.g.
+`foo::bar` simply replace the :: with -
+
+    it { should create_augeas('bleh') }
+    it { should create_foo-bar('baz') }
+
+You can further test the parameters that have been passed to the resources with
+the generic `with_<parameter>` chains.
+
+    it { should create_package('mysql-server').with_ensure('present') }
+
+## Writing tests
+
+### Basic test structure
+
+To test that
+
+    sysctl { 'baz'
+      value => 'foo',
+    }
+
+Will cause the following resource to be in included in catalogue for a host
+
+    exec { 'sysctl/reload':
+      command => '/sbin/sysctl -p /etc/sysctl.conf',
+    }
+
+We can write the following testcase
+
+    describe 'sysctl' do
+      let(:title) { 'baz' }
+      let(:params) { { :value => 'foo' } }
+
+      it { should create_exec('sysctl/reload').with_command("/sbin/sysctl -p /etc/sysctl.conf") }
+    end
+
+### Specifying the title of a resource
+
+    let(:title) { 'foo' }
+
+### Specifying the parameters to pass to a resources or parametised class
+
+    let(:params) { {:ensure => 'present', ...} }
+
+### Specifying the FQDN of the test node
+
+If the manifest you're testing expects to run on host with a particular name,
+you can specify this as follows
+
+    let(:node) { 'testhost.example.com' }
+
+### Specifying the facts that should be available to your manifest
+
+By default, the test environment contains no facts for your manifest to use.
+You can set them with a hash
+
+    let(:facts) { {:operatingsystem => 'Debian', :kernel => 'Linux', ...} }
+
+### Specifying the path to find your modules
+
+I recommend setting a default module path by adding the following code to your
+`spec_helper.rb`
+
+    RSpec.configure do |c|
+      c.module_path = '/path/to/your/module/dir'
+    end
+
+However, if you want to specify it in each example, you can do so
+
+    let(:module_path) { '/path/to/your/module/dir' }

data/Rakefile

@@ -0,0 +1,6 @@
+require 'rake'
+require 'rspec/core/rake_task'
+
+task :default => :test
+
+RSpec::Core::RakeTask.new(:test)

data/lib/rspec-puppet.rb

@@ -1,3 +1,7 @@
 require 'puppet'
 require 'rspec-puppet/matchers'
 require 'rspec-puppet/example'
+
+RSpec.configure do |c|
+  c.add_setting :module_path, :default => '/etc/puppet/modules'
+end

data/lib/rspec-puppet/example.rb

@@ -7,10 +7,10 @@ RSpec::configure do |c|
   end
 
   c.include RSpec::Puppet::DefineExampleGroup, :type => :define, :example_group => {
-    :file_path => c.escaped_path(%w[spec define])
+    :file_path => c.escaped_path(%w[spec defines])
   }
 
   c.include RSpec::Puppet::ClassExampleGroup, :type => :class, :example_group => {
-    :file_path => c.escaped_path(%w[spec class])
+    :file_path => c.escaped_path(%w[spec classes])
   }
 end

data/lib/rspec-puppet/example/class_example_group.rb

@@ -7,13 +7,23 @@ module RSpec::Puppet
     end
 
     def catalogue
-      Puppet[:modulepath] = module_path
+      Puppet[:modulepath] = self.respond_to?(:module_path) ? module_path : RSpec.configuration.module_path
 
       klass_name = self.class.top_level_description.downcase
+
+      # If we're testing a standalone module (i.e. one that's outside of a
+      # puppet tree), the autoloader won't work, so we need to fudge it a bit.
+      if File.exists?(File.join(Puppet[:modulepath], 'manifests', 'init.pp'))
+        path_to_manifest = File.join([Puppet[:modulepath], 'manifests', klass_name.split('::')[1..-1]].flatten)
+        import_str = "import '#{Puppet[:modulepath]}/manifests/init.pp'\nimport '#{path_to_manifest}.pp'\n"
+      else
+        import_str = ""
+      end
+
       if !self.respond_to?(:params) || params == {}
-        Puppet[:code] = "include #{klass_name}"
+        Puppet[:code] = import_str + "include #{klass_name}"
       else
-        Puppet[:code] = 'class' + " { " + klass_name + ": " + params.keys.map { |r| "#{r.to_s} => '#{params[r].to_s}'"
+        Puppet[:code] = import_str + 'class' + " { " + klass_name + ": " + params.keys.map { |r| "#{r.to_s} => '#{params[r].to_s}'"
       }.join(', ') + " }"
       end
 

data/lib/rspec-puppet/example/define_example_group.rb

@@ -9,7 +9,16 @@ module RSpec::Puppet
     def catalogue
       define_name = self.class.top_level_description.downcase
 
-      Puppet[:modulepath] = module_path
+      Puppet[:modulepath] = self.respond_to?(:module_path) ? module_path : RSpec.configuration.module_path
+
+      # If we're testing a standalone module (i.e. one that's outside of a
+      # puppet tree), the autoloader won't work, so we need to fudge it a bit.
+      if File.exists?(File.join(Puppet[:modulepath], 'manifests', 'init.pp'))
+        path_to_manifest = File.join([Puppet[:modulepath], 'manifests', define_name.split('::')[1..-1]].flatten)
+        import_str = "import '#{Puppet[:modulepath]}/manifests/init.pp'\nimport '#{path_to_manifest}.pp'\n"
+      else
+        import_str = ""
+      end
 
       if self.respond_to? :params
         param_str = params.keys.map { |r|
@@ -19,7 +28,7 @@ module RSpec::Puppet
         param_str = ""
       end
 
-      Puppet[:code] = define_name + " { \"" + title + "\": " + param_str + " }"
+      Puppet[:code] = import_str + define_name + " { \"" + title + "\": " + param_str + " }"
 
       nodename = self.respond_to?(:node) ? node : Puppet[:certname]
       facts_val = self.respond_to?(:facts) ? facts : {}

data/rspec-puppet.gemspec

@@ -1,20 +1,27 @@
 Gem::Specification.new do |s|
   s.name = 'rspec-puppet'
-  s.version = '0.0.1'
+  s.version = '0.0.2'
   s.homepage = 'https://github.com/rodjek/rspec-puppet/'
   s.summary = 'RSpec tests for your Puppet manifests'
   s.description = 'RSpec tests for your Puppet manifests'
 
   s.files = [
-    'rspec-puppet.gemspec',
-    'lib/rspec-puppet.rb',
-    'lib/rspec-puppet/matchers.rb',
+    'lib/rspec-puppet/example/class_example_group.rb',
+    'lib/rspec-puppet/example/define_example_group.rb',
+    'lib/rspec-puppet/example.rb',
     'lib/rspec-puppet/matchers/create_generic.rb',
     'lib/rspec-puppet/matchers/create_resource.rb',
     'lib/rspec-puppet/matchers/include_class.rb',
-    'lib/rspec-puppet/example.rb',
-    'lib/rspec-puppet/example/define_example_group.rb',
-    'lib/rspec-puppet/example/class_example_group.rb',
+    'lib/rspec-puppet/matchers.rb',
+    'lib/rspec-puppet.rb',
+    'LICENSE',
+    'Rakefile',
+    'README.md',
+    'rspec-puppet.gemspec',
+    'spec/classes/sysctl_common_spec.rb',
+    'spec/defines/sysctl_spec.rb',
+    'spec/fixtures/sysctl/manifests/init.pp',
+    'spec/spec_helper.rb',
   ]
 
   s.add_dependency 'rspec'

data/spec/classes/sysctl_common_spec.rb

@@ -0,0 +1,7 @@
+require 'spec_helper'
+
+describe 'sysctl::common' do
+  it { should create_exec('sysctl/reload') \
+    .with_command('/sbin/sysctl -p /etc/sysctl.conf').with_returns([0, 2]) }
+  it { should_not create_augeas('foo') }
+end

data/spec/defines/sysctl_spec.rb

@@ -0,0 +1,13 @@
+require 'spec_helper'
+
+describe 'sysctl' do
+  let(:title) { 'vm.swappiness' }
+  let(:params) { {:value => '60'} }
+
+  it { should include_class('sysctl::common') }
+  it { should create_augeas('sysctl/vm.swappiness') \
+    .with_context('/files/etc/sysctl.conf') \
+    .with_changes("set vm.swappiness '60'") \
+    .with_onlyif("match vm.swappiness[.='60'] size == 0") \
+    .with_notify('Exec[sysctl/reload]') }
+end

data/spec/fixtures/sysctl/manifests/init.pp

@@ -0,0 +1,18 @@
+class sysctl::common {
+  exec { 'sysctl/reload':
+    command     => '/sbin/sysctl -p /etc/sysctl.conf',
+    refreshonly => true,
+    returns     => [0, 2],
+  }
+}
+
+define sysctl($value) {
+  include sysctl::common
+
+  augeas { "sysctl/${name}":
+    context => '/files/etc/sysctl.conf',
+    changes => "set ${name} '${value}'",
+    onlyif  => "match ${name}[.='${value}'] size == 0",
+    notify  => Exec['sysctl/reload'],
+  }
+}

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rspec-puppet'
+
+RSpec.configure do |c|
+  c.module_path = File.join(File.dirname(File.expand_path(__FILE__)), 'fixtures')
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rspec-puppet
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Tim Sharpe
@@ -41,15 +41,22 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- rspec-puppet.gemspec
-- lib/rspec-puppet.rb
-- lib/rspec-puppet/matchers.rb
+- lib/rspec-puppet/example/class_example_group.rb
+- lib/rspec-puppet/example/define_example_group.rb
+- lib/rspec-puppet/example.rb
 - lib/rspec-puppet/matchers/create_generic.rb
 - lib/rspec-puppet/matchers/create_resource.rb
 - lib/rspec-puppet/matchers/include_class.rb
-- lib/rspec-puppet/example.rb
-- lib/rspec-puppet/example/define_example_group.rb
-- lib/rspec-puppet/example/class_example_group.rb
+- lib/rspec-puppet/matchers.rb
+- lib/rspec-puppet.rb
+- LICENSE
+- Rakefile
+- README.md
+- rspec-puppet.gemspec
+- spec/classes/sysctl_common_spec.rb
+- spec/defines/sysctl_spec.rb
+- spec/fixtures/sysctl/manifests/init.pp
+- spec/spec_helper.rb
 has_rdoc: true
 homepage: https://github.com/rodjek/rspec-puppet/
 licenses: []