spex 0.4.0 → 0.5.0

data/README.md

@@ -0,0 +1,66 @@
+Spex
+====
+
+A quick and dirty test harness for testing assertions before and after
+an executable is run.
+
+Synopsis
+--------
+
+Spex is a simple language used to define scenarios that model
+the correct behavior of an executable.
+
+The description file consists of exactly one `command` line and any
+number of `scenario` definitions; for example, the following file can
+be used to verify running `touch /tmp/foo` will create a new file:
+
+    scenario "Creates a file" do
+      executing 'touch /tmp/foo' do
+        assert '/tmp/foo', :created => true
+      end
+    end
+
+If this was in `run_touch.rb`, you could run this with spex:
+
+    $ spex run_touch.rb
+
+You'll notice that this should pass the first time and fail on
+subsequent invocations -- because the assertion added by `:created => true` fails in the
+event a file exists *before* the command is run.
+
+If you want to see what command and scenarios are defined in a file,
+use `spex info`, eg:
+
+    $ spex --describe run_touch.rb
+
+Usage help
+----------
+
+See the commandline help documentation:
+
+    $ spex --help
+
+Examples
+--------
+
+See the `examples/` directory.
+
+Assertions
+----------
+
+See the [wiki](http://wiki.github.com/bruce/spex/supported-assertions)
+for the list of supported assertions.
+
+To add an assertion, create a class that inherits from
+`Spex::Assertion` and implements all the neccessary methods.  See
+`Spex::Assertion` and the currently defined assertions for
+examples.
+
+Note: If you put your assertions in `~/.spex/assertions/*.rb`,
+they'll automatically be loaded.  If you create any interesting
+assertions, add them to the [wiki](http://wiki.github.com/bruce/spex/community-assertions)!
+
+Copyright
+---------
+
+Copyright (c) 2010 Bruce Williams. See LICENSE for details.

data/Rakefile

@@ -10,8 +10,7 @@ begin
     gem.email = "bruce@codefluency.com"
     gem.homepage = "http://github.com/bruce/spex"
     gem.authors = ["Bruce Williams"]
-    gem.add_dependency "thor"
-    gem.add_dependency "shoulda"
+    gem.add_dependency "colored"
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/VERSION

@@ -1 +1 @@
-0.4.0
+0.5.0

data/bin/spex

@@ -4,4 +4,4 @@ $LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
 
 require 'spex'
 
-Spex::CLI.start
+Spex::CLI.new(ARGV).run

data/examples/chgrp.rb

@@ -0,0 +1,5 @@
+scenario "Change group" do
+  executing "sudo chgrp everyone /tmp/foo" do 
+    assert '/tmp/foo', :changed_group => {:to => 'everyone'}
+  end
+end

data/examples/chmod.rb

@@ -0,0 +1,5 @@
+scenario "Change mode" do
+  executing "chmod 700 /tmp/foo" do
+    assert '/tmp/foo', :changed_mode => {:to => 0700}
+  end
+end

data/examples/chown.rb

@@ -0,0 +1,5 @@
+scenario "Change owner" do
+  executing "sudo chown root /tmp/foo" do
+    assert '/tmp/foo', :changed_owner => {:to => 'root'}
+  end
+end

data/examples/puppet.rb

@@ -0,0 +1,9 @@
+File.open('/tmp/spex-manifest.pp', 'w') do |f|
+  f.puts %(file { "/tmp/foo": ensure => present })
+end
+
+scenario "Creates a file" do
+  executing "puppet /tmp/spex-manifest.pp" do
+    assert '/tmp/foo', :created => true
+  end
+end

data/examples/touch.rb

@@ -0,0 +1,5 @@
+scenario "Creates a file" do
+  executing "touch /tmp/foo" do
+    assert '/tmp/foo', :created => true
+  end
+end

data/examples/writing.rb

@@ -0,0 +1,5 @@
+scenario "Modifies a file" do
+  executing "echo 'foo' >> /tmp/foo" do
+    assert '/tmp/foo', :modified => true
+  end
+end

data/lib/spex.rb

@@ -1,9 +1,9 @@
 module Spex
-  autoload :Scenario,      'spex/scenario'
-  autoload :Script,        'spex/script'
-  autoload :CLI,           'spex/cli'
-  autoload :DSL,           'spex/dsl'
   autoload :Assertion,     'spex/assertion'
+  autoload :CLI,           'spex/cli'
+  autoload :Execution,     'spex/execution'
   autoload :FileAssertion, 'spex/assertions/file_assertion'
   autoload :Runner,        'spex/runner'
+  autoload :Scenario,      'spex/scenario'
+  autoload :Script,        'spex/script'
 end

data/lib/spex/assertion.rb

@@ -1,6 +1,11 @@
+require 'test/unit/assertions'
+
 module Spex
   class Assertion
+    include Test::Unit::Assertions
     extend Enumerable
+
+    class UnknownOptionError < ::ArgumentError; end
     
     def self.each(&block)
       registry.each(&block)
@@ -13,30 +18,69 @@ module Spex
     def self.registry
       @registry ||= {}
     end
-    
-    def self.assertion(name)
+
+    def self.as(name, description)
+      self.name = name
+      self.description = description
       Assertion.registry[name.to_sym] = self
     end
 
-    def describe_should_at(event)
-      case event
-      when :before
-        raise NotImplementedError, "Assertion does not describe pre-puppet check"
-      when :after
-        raise NotImplementedError, "Assertion does not describe post-puppet check"
+    def self.options
+      @options ||= {}
+    end
+
+    def self.option(name, description = nil, &block)
+      options[name] = Option.new(name, description, &block)
+    end
+
+    class << self; attr_accessor :name, :description; end
+
+    attr_reader :target, :options
+    def initialize(target, options = {})
+      @target = target
+      if options.is_a?(Hash)
+        @options = options
+        @active = true
       else
-        raise ArgumentError, "Unknown event #{event.inspect}"
+        @options = {}
+        @active = options
+      end
+      validate!
+    end
+
+    def validate!
+      options.each do |key, value|
+        option = self.class.options[key]
+        unless option
+          raise UnknownOptionError, key.to_s
+        end
       end
     end
 
-    def before?
-      true
+    def active?
+      @active
+    end
+
+    def prepare
+    end
+
+    def before
+    end
+
+    def after
     end
 
-    def after?
-      true
+    def to_s
+      "#{self.class.description} of #{target}"
     end
 
+    class Option
+      attr_reader :name, :description
+      def initialize(name, description = nil, &block)
+        @name = name
+        @description = description
+      end
+    end
   end
 end
 

data/lib/spex/assertions/changed_group_assertion.rb

@@ -0,0 +1,61 @@
+require 'etc'
+
+module Spex
+  class ChangedGroupAssertion < FileAssertion
+    as :changed_group, 'file group change'
+    option :to, "To group name or gid"
+    option :from, "From group name or gid"
+    
+    def before
+      assert File.exist?(target), "File does not exist at #{target}"
+      if from_groupname
+        assert_equal from_groupname, current_groupname
+      elsif active?
+        assert_not_equal to_groupname, current_groupname, "Group will not be changed; already '#{to_groupname}'"
+      end
+      @before_groupname = current_groupname
+    end
+
+    def after
+      assert File.exist?(target), "File does not exist at #{target}"
+      current = current_groupname
+      if to_groupname
+        assert_equal to_groupname, current
+      elsif active?
+        assert_not_equal @before_groupname, current, "Group is still '#{@before_groupname}'"
+      elsif !active?
+        assert_equal @before_groupname, current, "Group changed from '#{@before_groupname}' to '#{current}'"
+      end
+    end
+
+    private
+
+    def current_groupname
+      normalize(File.stat(target).gid)
+    end
+
+    def from_groupname
+      if options[:from]
+        @from_groupname ||= normalize(options[:from])
+      end
+    end
+
+    def to_groupname
+      if options[:to]
+        @to_groupname ||= normalize(options[:to])
+      end
+    end
+
+    def normalize(gid_or_groupname)
+      case gid_or_groupname
+      when String, Symbol
+        gid_or_groupname.to_s
+      when Fixnum
+        Etc.getgrgid(gid_or_groupname).name
+      else
+        raise ArgumentError, "Does not appear to be a gid or group name: #{gid_or_groupname}"
+      end
+    end
+    
+  end
+end

data/lib/spex/assertions/changed_mode_assertion.rb

@@ -0,0 +1,48 @@
+module Spex
+  class ChangedModeAssertion < FileAssertion
+    as :changed_mode, "file mode change"
+    option :from, "Mode changed from (octal, eg 0600)"
+    option :to, "Mode changed to (octal, eg 0700)"
+
+    def before
+      assert File.exist?(target), "File does not exist at #{target}"
+      if options[:from]
+        assert_equal options[:from].to_s(8), current_mode.to_s(8)
+      elsif options[:to]
+        assert_not_equal options[:to].to_s(8), current_mode.to_s(8), "Mode will not be changed; already at mode #{options[:to].to_s(8)}"
+      end
+      @before_mode = current_mode
+    end
+
+    def after
+      assert File.exist?(target), "File does not exist at #{target}"
+      mode = current_mode.to_s(8)
+      if options[:to]
+        assert_equal options[:to].to_s(8), mode
+      elsif active?
+        assert_not_equal @before_mode.to_s(8), mode, "Mode is still #{@before_mode.to_s(8)}"
+      elsif !active?
+        assert_equal @before_mode.to_s(8), mode, "Mode was changed from #{@before_mode.to_s(8)} to #{mode}"
+      end
+    end
+
+    def to_s      
+      [super, detail].join(' ')
+    end
+
+    private
+
+    def detail
+      [:from, :to].map do |where|
+        if options[where]
+          "#{where} %o" % options[where]
+        end
+      end.compact.join(' ')
+    end
+
+    def current_mode
+      Integer(File.stat(target).mode.to_s(8)[1..-1])
+    end
+    
+  end
+end

data/lib/spex/assertions/changed_owner_assertion.rb

@@ -0,0 +1,73 @@
+require 'etc'
+
+module Spex
+  class ChangedOwnerAssertion < FileAssertion
+    as :changed_owner, 'file owner change'
+    option :from, "From username or uid"
+    option :to, "To username or uid"
+    
+    def before
+      assert File.exist?(target), "File does not exist at #{target}"
+      if from_username
+        assert_equal from_username, current_username, "File is not owned by '#{from_username}'"
+      elsif to_username
+        assert_not_equal to_username, current_username, "Owner will not be changed; already '#{to_username}'"
+      end
+      @before_username = current_username
+    end
+
+    def after
+      current = current_username
+      if to_username
+        assert File.exist?(target), "File does not exist at #{target}"
+        assert_equal to_username, current
+      elsif active?
+        assert_not_equal @before_username, current, "Owner is still '#{@before_username}'"
+      elsif !active?
+        assert_equal @before_username, current, "Owner was changed from '#{@before_username}' to '#{current}'"
+      end
+    end
+
+    def to_s
+      [super, detail].join(' ')
+    end
+
+    private
+
+    def detail
+      [:from, :to].map do |where|
+        if options[where]
+          "#{where} %s" % normalize(options[where])
+        end
+      end.compact.join(' ')
+    end
+    
+    def current_username
+      normalize(File.stat(target).uid)
+    end
+
+    def from_username
+      if options[:from]
+        @from_username ||= normalize(options[:from])
+      end
+    end
+
+    def to_username
+      if options[:to]
+        @to_username ||= normalize(options[:to])
+      end
+    end
+
+    def normalize(uid_or_username)
+      case uid_or_username
+      when String, Symbol
+        uid_or_username.to_s
+      when Fixnum
+        Etc.getpwuid(uid_or_username).name
+      else
+        raise ArgumentError, "Does not appear to be a uid or username: #{uid_or_username}"
+      end
+    end
+    
+  end
+end

data/lib/spex/assertions/created_assertion.rb

@@ -0,0 +1,26 @@
+module Spex
+  class CreatedAssertion < FileAssertion
+    as :created, 'file creation'
+    option :type, "Type ('file' or 'directory'), optional"
+
+    def before
+      assert !File.exist?(target), "File already exists at #{target}"
+    end
+
+    def after
+      assert File.exist?(target), "File was not created at #{target}"
+      check_type
+    end
+
+    private
+
+    def check_type
+      case kind
+      when :file
+        assert File.file?(target), "File created at #{target} is not a regular file"
+      when :directory
+        assert File.directory?(target), "File created at #{target} is not a directory"
+      end
+    end
+  end
+end