cucumber-puppet 0.0.5 → 0.0.6

data/VERSION.yml

@@ -1,5 +1,5 @@
 ---
 :build:
-:patch: 5
+:patch: 6
 :minor: 0
 :major: 0

data/bin/cucumber-puppet

@@ -78,8 +78,7 @@ end
 command = []
 command << "cucumber --strict"
 
-cwd = Dir.getwd
-root = find_root(cwd)
+root = find_root
 command << "--require #{root}/features"
 command << options
 

data/lib/cucumber-puppet/helper.rb

@@ -1,12 +1,18 @@
 require 'cucumber-puppet'
 
+# Private helper methods.
 module CucumberPuppet::Helper
-  # Finds the root of the puppet directory tree according to puppet's
+  private
+
+  # Finds the root of the puppet directory tree according to Puppet's
   # directory naming convention. Relevant sub-trees are:
+  #
   # - <puppetdir>/features/modules/$module
   # - <puppetdir>/modules/$module/features
+  #
   # In case no tree is identified, assumes cwd is <puppetdir>.
-  def find_root(cwd)
+  def find_root
+    cwd = Dir.getwd
     path = cwd.split('/')
 
     if cwd.match('features$') and not cwd.match("modules/")
@@ -14,19 +20,19 @@ module CucumberPuppet::Helper
       path.pop
     elsif cwd.match('features/modules$')
       # <puppetdir>/features/modules
-      path.pop(2)
+      2.times { path.pop }
     elsif cwd.match('features/modules/[^/]*$')
       # <puppetdir>/features/modules/$module
-      path.pop(3)
+      3.times { path.pop }
     elsif cwd.match('modules$')
       # <puppetdir>/modules
       path.pop
     elsif cwd.match('/modules/[^/]*$')
       # <puppetdir>/modules/$module
-      path.pop(2)
+      2.times { path.pop }
     elsif cwd.match('/modules/[^/]*/features$')
       # <puppetdir>/modules/$module/features
-      path.pop(3)
+      3.times { path.pop }
     end
 
     path.join('/')

data/lib/cucumber-puppet/puppet.rb

@@ -1,7 +1,10 @@
 require 'puppet'
 require 'puppet/network/client'
 
+# A class for accessing Puppet's internal state regarding a certain node or
+# class.
 class CucumberPuppet
+  # Returns a new CucumberPuppet object.
   def initialize
     @confdir = "/etc/puppet"
     @manifest = @confdir + "/manifest/site.pp"
@@ -21,21 +24,31 @@ class CucumberPuppet
     Puppet::Util::Log.level = :notice
   end
 
+  # Set Puppet's log level to 'debug'.
   def debug
     Puppet::Util::Log.level = :debug
   end
 
+  # Define Puppet classes to include in a feature's testnode.
   def klass=(klass)
+    # XXX sth like klass.split(/,/) and remove whitespace
     @klass = klass.to_a
   end
 
-  def compile_catalog
+  # Compile catalog for configured testnode.
+  #
+  #   @confdir defaults to '/etc/puppet'
+  #   @manifest defaults to @confdir + '/manifests/site.pp'
+  #
+  def compile_catalog( node = nil )
     Puppet[:confdir] = @confdir
     Puppet[:manifest] = @manifest
     Puppet.parse_config
 
-    node = Puppet::Node.new(@facts['hostname'], :classes => @klass)
-    node.merge(@facts)
+    unless node.is_a?(Puppet::Node)
+      node = Puppet::Node.new(@facts['hostname'], :classes => @klass)
+      node.merge(@facts)
+    end
 
     begin
       # Compile our catalog
@@ -57,7 +70,13 @@ class CucumberPuppet
     end
   end
 
-  def resource(title)
+  # Returns an Object with the given title from catalog.
+  def get_resource(title)
     @catalog.resource(title)
   end
+  # XXX add deprecation warning for resource()
+  def resource(title)
+    get_resource(title)
+  end
+
 end

data/lib/cucumber-puppet/rake/task.rb

@@ -5,7 +5,7 @@
 #   CucumberPuppetRakeTask.new
 #
 # This defines a task 'cucumber_puppet' that will run features in 'features'
-# and 'modules/**/features'.
+# and 'modules/*/features'.
 #
 # To further configure the task, you can pass a block:
 #
@@ -14,16 +14,16 @@
 #   end
 
 class CucumberPuppetRakeTask
-  # extra options to pass to cucumber
   attr_accessor :cucumber_opts
 
-  # an Array is preferred, so convert if String
+  # Extra options to pass to cucumber via cucumber-puppet.
+  # An Array is preferred, so convert if String.
   def cucumber_opts=(opts)
     @cucumber_opts = String === opts ? opts.split(' ') : opts
   end
 
 
-  # define CucumberPuppet Rake task
+  # Define CucumberPuppet Rake task.
   def initialize(task_name = 'cucumber_puppet',
                  desc = 'Run cucumber-puppet features')
     @task_name = task_name
@@ -34,6 +34,7 @@ class CucumberPuppetRakeTask
     define_task
   end
 
+  private
   def define_task
     desc @desc
     task @task_name do

data/lib/generators/world/steps/catalog_specs.rb

@@ -0,0 +1,67 @@
+Given /^a node specified by "([^\"]*)"$/ do |file|
+  # file: yaml node file, usually from /var/lib/puppet/yaml/node
+  fail("Cannot find node facts #{file}.") unless File.exist?(file)
+  @node = YAML.load_file(file)
+  file("Invalid node file #{file}, this should come from " +
+    "/var/lib/puppet/yaml/node.") unless @node.is_a?(Puppet::Node)
+end
+
+When /^I compile its catalog$/ do
+  compile_catalog(@node)
+end
+
+Then /^all "([^\"]*)" should resolve$/ do |parameter|
+  # paramter: before, notify, require, or subscribe
+  @catalog.resources.each do |name|
+    resource = get_resource(name)
+
+    dependency = resource[parameter]
+    next unless dependency
+    if dependency.is_a?(Array)
+      dependency.each do |dep|
+        fail("#{resource} cannot #{parameter} #{dep}, not in catalog.") \
+          unless get_resource(dep.to_s)
+      end
+    elsif dependency.is_a?(Puppet::Resource::Reference)
+      fail("#{resource} cannot #{parameter} #{dependency}, not in catalog.") \
+        unless get_resource(dependency.to_s)
+    else
+      fail("#{resource} #{parameter} #{dependency} of unknown class.")
+    end
+  end
+end
+
+Then /^all file sources should exist in git repository$/ do
+  @catalog.resources.each do |name|
+    next unless name.match(/^File/)
+    file = get_resource(name)
+
+    next unless file['source']
+    source = file['source']
+
+    filepath = source.gsub(%r{^puppet:///([^/]*)/(.*)$}, 'modules/\1/files/\2')
+    fail("#{name}: source #{filepath} not in git repository.") unless
+      system("git cat-file -e :#{filepath} > /dev/null 2>&1")
+  end
+end
+
+Then /^all file templates should exist in git repository$/ do
+  Dir.glob('modules/*/templates/**.erb').each do |template|
+    fail("#{template} not in git.") unless
+      system("git cat-file -e :#{template} > /dev/null 2>&1")
+  end
+end
+
+Then /^all resource dependencies should resolve$/ do
+  steps %Q{
+    Then all "before" should resolve
+    And all "notify" should resolve
+    And all "require" should resolve
+    And all "subscribe" should resolve
+  }
+end
+
+Then /^compilation should succeed$/ do
+  fail("Catalog compilation failed.") unless
+    @catalog.is_a?(Puppet::Resource::Catalog)
+end

data/lib/generators/world/steps/file.rb

@@ -1,3 +1,13 @@
+Then /^following directories should be created:$/ do |directories|
+  directories.hashes.each do |dir|
+    steps %Q{
+      Then there should be a resource "File[#{dir['name']}]"
+      And the state should be "directory"
+      And the directory should have standard permissions
+    }
+  end
+end
+
 Then /^the file should be a symlink to "([^\"]*)"$/ do |target|
   fail unless @resource["ensure"] == target
 end
@@ -6,11 +16,16 @@ Then /^the file should contain "([^\"]*)"$/ do |text|
   fail unless @resource["content"].include?(text)
 end
 
-Then /^the (file|script) should have standard permissions$/ do |type|
-  if type == "file"
+Then /^the (directory|file|script) should have standard permissions$/ do |type|
+  case type
+  when "directory"
+    mode = "0755"
+  when "file"
     mode = "0444"
-  elsif type == "script"
+  when "script"
     mode = "0555"
+  else
+    fail
   end
 
   steps %Q{

data/lib/generators/world/steps/package.rb

@@ -1,13 +1,14 @@
-Then /^package "([^\"]*)" should be "([^\"]*)"$/ do  |package, state|
-  steps %Q{
-    Then there should be a resource "Package[#{package}]"
-    And the state should be "#{state}"
-  }
+Then /^following packages should be dealt with:$/ do |packages|
+  packages.hashes.each do |package|
+    steps %Q{
+      Then package "#{package['name']}" should be "#{package['state']}"
+    }
+  end
 end
 
-
-Then /^package "([^\"]*)" should not be installed$/ do  |package|
+Then /^package "([^\"]*)" should be "([^\"]*)"$/ do |package, state|
   steps %Q{
-    Then there should be no resource "Package[#{package}]"
+    Then there should be a resource "Package[#{package}]"
+    And the state should be "#{state}"
   }
 end

data/lib/generators/world/steps/puppet.rb

@@ -32,22 +32,32 @@ end
 
 Then /^the [a-z]* should notify "([^\"]*)"$/ do |res|
   fail unless @resource["notify"].to_s == res
+  steps %Q{
+    Then the catalog should contain "#{res}"
+  }
 end
 
-Then /^the [a-z]* should require "([^\"]*)"$/ do |resource|
+Then /^the [a-z]* should require "([^\"]*)"$/ do |res|
   req = @resource["require"]
   if req.is_a?(Array)
     found = false
     req.each do |r|
-      if r.to_s == resource
+      if r.to_s == res
         found = true
         break
       end
     end
     fail unless found
   else
-    fail unless req.to_s == resource
+    fail unless req.to_s == res
   end
+  steps %Q{
+    Then the catalog should contain "#{res}"
+  }
+end
+
+Then /^the catalog should contain "([^\"]*)"$/ do |res|
+  fail unless resource(res)
 end
 
 Then /^the state should be "([^\"]*)"$/ do |state|
@@ -58,8 +68,3 @@ Then /^there should be a resource "([^\"]*)"$/ do |res|
   @resource = resource(res)
   fail unless @resource
 end
-
-Then /^there should be no resource "([^\"]*)"$/ do |res|
-  @resource = resource(res)
-  fail if @resource
-end

data/lib/generators/world/steps/user.rb

@@ -1,3 +1,15 @@
+Then /^"([^\"]*)" should be in groups? "([^\"]*)"$/ do |user, groups|
+  steps %Q{
+    Then there should be a resource "User[#{user}]"
+    And the user should be in groups "#{groups}"
+  }
+end
+
 Then /^the user should be in groups "([^\"]*)"$/ do |groups|
-  fail unless @resource["groups"] == groups
+  g = @resource["groups"]
+  g_s = g
+  if g.is_a?(Array)
+    g_s = g.join(' ')
+  end
+  fail unless g_s == groups
 end

data/man/cucumber-puppet-gen.1

@@ -0,0 +1,78 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "CUCUMBER\-PUPPET\-GEN" "1" "August 2010" "" ""
+.
+.SH "NAME"
+\fBcucumber\-puppet\-gen\fR \- Generator script for cucumber\-puppet
+.
+.SH "SYNOPSIS"
+\fBcucumber\-puppet\-gen\fR feature MODULE FEATURE
+.
+.P
+\fBcucumber\-puppet\-gen\fR world
+.
+.SH "DESCRIPTION"
+\fBcucumber\-puppet\-gen\fR generates feature files and initializes a Puppet tree for use with \fBcucumber\-puppet\fR\.
+.
+.TP
+\fBcucumber\-puppet\-gen\fR feature MODULE FEATURE
+Generate a feature file from template for feature FEATURE and module MODULE\. Depending on the current working directory, the feature is either placed in \fBfeatures/modules/MODULE/FEATURE\.feature\fR or, if called from the \fBmodules/\fR subdirectory tree, \fBmodules/MODULE/features/FEATURE\.feature\fR\.
+.
+.TP
+\fBcucumber\-puppet\-gen\fR world
+Initialize Puppet tree for use with \fBcucumber\-puppet\fR, to be run from the Puppet tree\'s root\.
+.
+.SH "EXAMPLES"
+Initialize the Puppet tree:
+.
+.IP "" 4
+.
+.nf
+
+$ cd puppet
+$ cucumber\-puppet\-gen world
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Generated files are to be found in \fBfeatures/steps/\fR and \fBfeatures/support/\fR\.
+.
+.P
+Create a feature file for module \fIfoo\fR\'s \fIbar\fR feature:
+.
+.IP "" 4
+.
+.nf
+
+$ cd puppet
+$ cucumber\-puppet\-gen feature foo bar
+.
+.fi
+.
+.IP "" 0
+.
+.P
+Create the same feature file to be bundled with the module:
+.
+.IP "" 4
+.
+.nf
+
+$ cd puppet/modules
+$ cucumber\-puppet\-gen feature foo bar
+.
+.fi
+.
+.IP "" 0
+.
+.SH "REPORTING BUGS"
+Report bugs to \fIcucumber\-puppet@erisiandiscord\.de\fR or go to http://github\.com/nistude/cucumber\-puppet/issues
+.
+.SH "COPYRIGHT"
+\fBcucumber\-puppet\fR is Copyright (c) 2010 Nikolay Sturm \fIsturm@nistu\.de\fR
+.
+.SH "SEE ALSO"
+cucumber\-puppet(1)

data/man/cucumber-puppet.1

@@ -0,0 +1,137 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "CUCUMBER\-PUPPET" "1" "August 2010" "" ""
+.
+.SH "NAME"
+\fBcucumber\-puppet\fR \- Puppet manifest testing with Cucumber
+.
+.SH "SYNOPSIS"
+\fBcucumber\-puppet\fR [ OPTIONS ] FILE | DIR \.\.\.
+.
+.SH "DESCRIPTION"
+\fBcucumber\-puppet\fR is a tool for behavioral testing of Puppet manifests\. It provides the glue necessary to access Puppet\'s data structures from Cucumber\'s step definitions\.
+.
+.P
+\fBcucumber\-puppet\fR takes a list of feature files or directories, containing feature files, as argument\. These will then be run through \fBcucumber\fR\. It needs to be started from somewhere inside the Puppet directory tree\.
+.
+.TP
+\fB\-h\fR, \fB\-\-help\fR
+Show help message\.
+.
+.TP
+\fB\-\-version\fR
+Show version number\.
+.
+.P
+The following options are passed on to \fBcucumber\fR\. See \fBcucumber \-\-help\fR for further details\.
+.
+.TP
+\fB\-b\fR, \fB\-\-backtrace\fR
+Show full backtrace for all errors\.
+.
+.TP
+\fB\-e\fR, \fB\-\-exclude\fR \fIPATTERN\fR
+Don\'t run feature files or require ruby files matching \fIPATTERN\fR\.
+.
+.TP
+\fB\-f\fR, \fB\-\-format\fR \fIFORMAT\fR
+How to format features (Default: pretty)\.
+.
+.TP
+\fB\-n\fR, \fB\-\-name\fR \fINAME\fR
+Only run matching feature elements\.
+.
+.TP
+\fB\-o\fR, \fB\-\-out\fR \fIFILE\fR|\fIDIR\fR
+Write output to \fIFILE\fR|\fIDIR\fR\.
+.
+.TP
+\fB\-t\fR, \fB\-\-tags\fR \fITAG\-EXPRESSION\fR
+Only run features/scenarios matching \fITAG\-EXPRESSION\fR\.
+.
+.TP
+\fB\-v\fR, \fB\-\-verbose\fR
+Show files and features loaded\.
+.
+.TP
+\fB\-x\fR, \fB\-\-expand\fR
+Expand Scenario Outline Tables in output\.
+.
+.SH "FILES"
+\fBcucumber\-puppet\fR assumes a certain directory structure to magically find necessary support files\. Relative to the Puppet directory\'s root, the structure looks like this:
+.
+.TP
+\fBfeatures/\fR
+The generic place to store Cucumber files\.
+.
+.TP
+\fBfeatures/modules/foo/\fR
+Feature files for module \fIfoo\fR go here\.
+.
+.TP
+\fBfeatures/modules/foo/bar\.feature\fR
+File containing scenarios for the \fIbar\fR feature\.
+.
+.TP
+\fBfeatures/steps/\fR
+Step definitions go here\. To distinguish local extensions, it is suggested putting these into files named \fBmodule_foo\.rb\fR or \fBdefine_bar\.rb\fR\. Although names don\'t really matter to cucumber, as long as files have the proper suffix\.
+.
+.TP
+\fBfeatures/support/\fR
+Cucumber support files go here\.
+.
+.P
+\fBcucumber\-puppet\fR also supports bundling features with modules\. In this case it looks for features, step definitions and support files in \fBmodules/foo/features/\fR like so:
+.
+.TP
+\fBmodules/foo/features/bar\.feature\fR
+Bundled feature file\.
+.
+.TP
+\fBmodules/foo/features/steps/bar\.rb\fR
+Bundled step definition file\.
+.
+.SH "EXAMPLES"
+To run all features found in a directory:
+.
+.IP "" 4
+.
+.nf
+
+$ cucumber\-puppet features
+.
+.fi
+.
+.IP "" 0
+.
+.P
+To run a single feature:
+.
+.IP "" 4
+.
+.nf
+
+$ cucumber\-puppet features/modules/foo/bar\.feature
+.
+.fi
+.
+.IP "" 0
+.
+.SH "REPORTING BUGS"
+Report bugs to \fIcucumber\-puppet@erisiandiscord\.de\fR or go to http://github\.com/nistude/cucumber\-puppet/issues
+.
+.SH "COPYRIGHT"
+\fBcucumber\-puppet\fR is Copyright (c) 2010 Nikolay Sturm \fIsturm@nistu\.de\fR
+.
+.SH "SEE ALSO"
+cucumber\-puppet\-gen(1)
+.
+.P
+Behavior Driven Development: http://behaviour\-driven\.org/ http://en\.wikipedia\.org/wiki/Behavior_driven_development
+.
+.P
+Cucumber: http://cukes\.info/
+.
+.P
+Puppet: http://www\.puppetlabs\.com/puppet/introduction/

metadata

@@ -1,12 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cucumber-puppet
 version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 0
-  - 5
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors: 
 - Nikolay Sturm
@@ -14,37 +9,40 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-25 00:00:00 +02:00
+date: 2010-08-23 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: cucumber
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        - 6
-        - 4
         version: 0.6.4
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: gem-man
   type: :runtime
-  version_requirements: *id001
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.0
+    version: 
 - !ruby/object:Gem::Dependency 
   name: templater
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 0
         version: "1.0"
-  type: :runtime
-  version_requirements: *id002
-description: cucumber-puppet supports writing behavioural tests for Puppet manifests
+    version: 
+description: cucumber-puppet is a tool for behavioral testing of Puppet manifests
 email: cucumber-puppet@erisiandiscord.de
 executables: 
 - cucumber-puppet
@@ -61,16 +59,19 @@ files:
 - lib/cucumber-puppet/puppet.rb
 - lib/cucumber-puppet/rake/task.rb
 - lib/generators/feature/%feature_name%.feature
+- man/cucumber-puppet.1
+- man/cucumber-puppet-gen.1
 - VERSION.yml
-- lib/generators/world/support/world.rb
-- lib/generators/world/support/hooks.rb
-- lib/generators/world/steps/user.rb
-- lib/generators/world/steps/puppet.rb
-- lib/generators/world/steps/cron.rb
-- lib/generators/world/steps/service.rb
 - lib/generators/world/steps/package.rb
+- lib/generators/world/steps/catalog_specs.rb
 - lib/generators/world/steps/exec.rb
+- lib/generators/world/steps/user.rb
 - lib/generators/world/steps/file.rb
+- lib/generators/world/steps/cron.rb
+- lib/generators/world/steps/puppet.rb
+- lib/generators/world/steps/service.rb
+- lib/generators/world/support/hooks.rb
+- lib/generators/world/support/world.rb
 has_rdoc: true
 homepage: http://github.com/nistude/cucumber-puppet/
 licenses: []
@@ -84,20 +85,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
+  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      segments: 
-      - 0
       version: "0"
+  version: 
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: Puppet manifest testing with Cucumber