spex 0.4.0 → 0.5.0

data/lib/spex/script.rb

@@ -1,34 +1,32 @@
 module Spex
   class Script
+    include Enumerable
 
     attr_accessor :command
 
     def self.evaluate_file(path)
-      evaluate(File.read(path), path)
+      evaluate(File.read(path), path, 1)
     end
 
-    def self.evaluate(text, path)
+    def self.evaluate(*args, &block)
       script = new
-      Builder.new(script).instance_eval(text, path, 1)
+      builder = Builder.new(script, &block)
+      unless block_given?
+        builder.instance_eval(*args)
+      end
       script
     end
 
     def <<(scenario)
-      scenarios[scenario.name.to_sym] = scenario
+      scenarios << scenario
     end
 
     def scenarios
-      @scenarios ||= {}
+      @scenarios ||= []
     end
 
-    def [](name)
-      scenarios[name.to_sym]
-    end
-
-    def validate!
-      unless @command
-        abort "ERROR: The command was not set.\n\nExample:\n\n  command 'cat %s'"
-      end
+    def each(&block)
+      scenarios.each(&block)
     end
 
     class Builder
@@ -38,13 +36,10 @@ module Spex
         instance_eval(&block) if block_given?
       end
       
-      def scenario(name, description = name.to_s, &block)
-        scenario = ::Spex::Scenario.new(name, description, &block)
+      def scenario(name, &block)
+        scenario = ::Spex::Scenario.new(name, &block)
         @script << scenario
       end
-      def command(line)
-        @script.command = line
-      end
 
     end
 

data/test/helper.rb

@@ -7,4 +7,11 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'spex'
 
 class Test::Unit::TestCase
+
+  private
+
+  def script(&block)
+    @script = Spex::Script.evaluate(&block)
+  end
+  
 end

data/test/test_assertion.rb

@@ -0,0 +1,58 @@
+require 'helper'
+
+class TestAssertion < Test::Unit::TestCase
+  context "Assertion" do
+    setup do
+      @klass = Class.new(Spex::Assertion)
+    end
+
+    context "instances" do
+      should "raise an exception if instantiated with an unknown option" do
+        assert_raises Spex::Assertion::UnknownOptionError do
+          @klass.new('/tmp/foo', :unknown => 'option')
+        end
+      end
+    end
+
+    context "classes" do
+      context "after being registered" do
+        setup do
+          @klass.as :something, "Something being added"
+        end
+        
+        should "be added to the list of assertions" do
+          assert_equal @klass, Spex::Assertion[:something]
+        end    
+      end
+      
+      context "setting an option" do
+        setup do
+          @klass.option :to, 'A desc'
+        end
+        
+        should "add one to the mapping" do
+          assert_kind_of Hash, @klass.options
+          assert_equal 1, @klass.options.size
+        end
+        
+        context "and the option" do
+          setup do
+            @option = @klass.options[:to]
+          end
+          
+          should "be of the correct class" do
+            assert_kind_of Spex::Assertion::Option, @option
+          end
+          
+          should "have a name" do
+            assert_equal :to, @option.name
+          end
+          
+          should "have a description if given" do
+            assert_equal 'A desc', @option.description
+          end
+        end
+      end
+    end
+  end
+end

data/test/test_script.rb

@@ -0,0 +1,54 @@
+require 'helper'
+
+class TestScript < Test::Unit::TestCase
+  context "evaluating" do
+    context "an empty scenario definition" do
+      setup do
+        script { scenario("name") { } }
+      end
+      
+      should "create an empty scenario" do
+        assert_equal 1, @script.scenarios.size
+        assert_equal "name", @script.scenarios.first.name
+      end
+    end
+    context "a scenario definition with an executing definition" do
+      setup do
+        script { scenario("name") { executing('foo') { } } }
+      end
+      
+      should "create an scenario" do
+        assert_equal 1, @script.scenarios.size
+        assert_equal "name", @script.scenarios.first.name
+      end
+
+      should "create an execution instance" do
+        assert_equal 1, @script.scenarios.first.executions.size
+        assert_equal 'foo', @script.scenarios.first.executions.first.command
+      end
+    end
+    
+    context "a scenario and execution definition with an assertion" do
+      setup do
+        script do
+          scenario("name") do
+            executing('foo') do
+              assert '/tmp/foo', :created => true
+            end
+          end
+        end
+      end
+      
+      should "create an assertion instance" do
+        execution = @script.scenarios.first.executions.first
+        assert_equal 1, execution.assertions.size
+        assertion = execution.assertions.first
+        assert_kind_of Spex::Assertion, assertion
+        assert_equal '/tmp/foo', assertion.target
+        assert assertion.active?
+        assert_equal({}, assertion.options)
+      end
+    end
+
+  end
+end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 4
+  - 5
   - 0
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors: 
 - Bruce Williams
@@ -14,11 +14,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-08 00:00:00 -07:00
+date: 2010-04-13 00:00:00 -07:00
 default_executable: spex
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: thor
+  name: colored
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
@@ -29,18 +29,6 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: shoulda
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 0
-        version: "0"
-  type: :runtime
-  version_requirements: *id002
 description: An easy-to-use test harness that runs assertions before and after and executable is run
 email: bruce@codefluency.com
 executables: 
@@ -49,41 +37,38 @@ extensions: []
 
 extra_rdoc_files: 
 - LICENSE
-- README.markdown
+- README.md
 files: 
 - .document
 - .gitignore
 - LICENSE
-- README.markdown
+- README.md
 - Rakefile
 - VERSION
 - bin/spex
-- examples/chgrp/run.sh
-- examples/chgrp/scenarios.rb
-- examples/chmod/run.sh
-- examples/chmod/scenarios.rb
-- examples/chown/run.sh
-- examples/chown/scenarios.rb
-- examples/puppet/manifest.pp
-- examples/puppet/run.sh
-- examples/puppet/scenarios.rb
-- examples/touch/run.sh
-- examples/touch/scenarios.rb
+- examples/chgrp.rb
+- examples/chmod.rb
+- examples/chown.rb
+- examples/puppet.rb
+- examples/touch.rb
+- examples/writing.rb
 - lib/spex.rb
 - lib/spex/assertion.rb
-- lib/spex/assertions/chgrps_file_assertion.rb
-- lib/spex/assertions/chmods_file_assertion.rb
-- lib/spex/assertions/chowns_file_assertion.rb
-- lib/spex/assertions/creates_file_assertion.rb
+- lib/spex/assertions/changed_group_assertion.rb
+- lib/spex/assertions/changed_mode_assertion.rb
+- lib/spex/assertions/changed_owner_assertion.rb
+- lib/spex/assertions/created_assertion.rb
 - lib/spex/assertions/file_assertion.rb
-- lib/spex/assertions/removes_file_assertion.rb
+- lib/spex/assertions/modified_assertion.rb
+- lib/spex/assertions/removed_assertion.rb
 - lib/spex/cli.rb
+- lib/spex/execution.rb
 - lib/spex/runner.rb
 - lib/spex/scenario.rb
 - lib/spex/script.rb
-- lib/spex/script/builder.rb
 - test/helper.rb
-- test/test_stringup.rb
+- test/test_assertion.rb
+- test/test_script.rb
 has_rdoc: true
 homepage: http://github.com/bruce/spex
 licenses: []
@@ -116,9 +101,11 @@ specification_version: 3
 summary: A test harness for executables
 test_files: 
 - test/helper.rb
-- test/test_stringup.rb
-- examples/chgrp/scenarios.rb
-- examples/chmod/scenarios.rb
-- examples/chown/scenarios.rb
-- examples/puppet/scenarios.rb
-- examples/touch/scenarios.rb
+- test/test_assertion.rb
+- test/test_script.rb
+- examples/chgrp.rb
+- examples/chmod.rb
+- examples/chown.rb
+- examples/puppet.rb
+- examples/touch.rb
+- examples/writing.rb

data/README.markdown

@@ -1,116 +0,0 @@
-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:
-
-    command 'touch /tmp/foo'
-
-    scenario :new, "Creates a file" do
-      assert_creates_file '/tmp/foo'
-    end
-
-If this was in `scenarios.rb`, you could run this with spex:
-
-    $ spex execute scenarios.rb --scenario new
-
-If you had named the scenario `default`, the `--scenario` option
-wouldn't have been necessary, ie:
-
-    scenario :default "Creates a file" do
-      assert_creates_file '/tmp/foo'
-    end
-
-    $ spex execute scenarios.rb
-
-You'll notice that this should pass the first time and fail on
-subsequent invocations -- because the `assert_creates` 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 info scenarios.rb
-
-Commands with arguments
------------------------
-
-Let's say you had an executable that reads in a configuration file and
-has some type of side-effect.  You'd like to test running the
-executable against multiple configuration files checking a scenario,
-without having to edit the spex file every time, changing the path
-to the configuration file.
-
-Luckily the command can be provided in `sprintf` style.  Assuming our
-executable is named `myexec` and you pass the configuration file to it
-via `-c`, the following would work:
-
-    command 'myexec -c %s'
-
-Now, you just pass more options to `spex execute`:
-
-    $ spex execute scenarios.rb /path/to/my/configuration.conf
-
-.. and it's just as if you ran:
-
-    $ myexec -c /path/to/my/configuration.conf
-
-Usage help
-----------
-
-See the commandline help documentation:
-
-    $ spex
-
-For more information on specific commands, you'll want to use `help`,
-eg:
-
-    $ spex help execute
-
-Examples
---------
-
-See the `examples/` directory.
-
-Assertions
-----------
-
-The list of assertions is very short at this point.
-
-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, make sure you let me know!
-
-### assert_creates_file
-
-Checks to see if a file was created.
-
-You can pass `:file => true` or `:directory => true` to ensure the
-file is a regular file or directory.
-
-### assert_removes_file
-
-Checks to see if a file was removed.
-
-You can pass `:file => true` or `:directory => true` to ensure the
-file was a regular file or directory before being removed.
-
-Copyright
----------
-
-Copyright (c) 2010 Bruce Williams. See LICENSE for details.

data/examples/chgrp/run.sh

@@ -1,3 +0,0 @@
-#!/usr/bin/env ruby
-
-spex execute scenarios.rb

data/examples/chgrp/scenarios.rb

@@ -1,5 +0,0 @@
-command "sudo chgrp everyone /tmp/foo"
-
-scenario :default, "Change group" do
-  assert_chgrps_file '/tmp/foo', :to => 'everyone', :changes => true
-end

data/examples/chmod/run.sh

@@ -1,3 +0,0 @@
-#!/usr/bin/env ruby
-
-spex execute scenarios.rb

data/examples/chmod/scenarios.rb

@@ -1,5 +0,0 @@
-command "chmod 700 /tmp/foo"
-
-scenario :default, "Change mode" do
-  assert_chmods_file '/tmp/foo', :to => 0700, :changes => true
-end