command-unit 0.0.0 → 0.0.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Njk2YmM5MjE0MTgzYjlhMGZlZDdhOTNlZWMzMWZlN2I2YjdhNzk4ZA==
+    N2YxZTJjNGQzMGNlMWU5ODdjN2U4MTMyYmQ1NWQ4YTQ3ZDQ1N2MzOQ==
   data.tar.gz: !binary |-
-    YjdiNzVmYzE3MzFiYmQyMzIwNWQ3ZmZlYzk3M2ZkODE5NTE0MjVmNA==
+    M2RhYjRmMTM3ZDQyNmViNWY3N2RjMTY0Y2EyMTdhMTRhYjUyZjI4Ng==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MDQ4ZTIzZjQ5MjdjMTdlYmU1MjUwYjIwZWFlZTBjNmM1MjUzYjc3Mjk0MTQ2
-    MmZjMzg4YTA3MTYyNDg0N2NiNzZhOGI5N2IxZTQ1OTI0NjNmMzBjODU1OTY1
-    ODM5MTFiZjBlYjZhMDZiZWJkNjgwMWE2ZDdmYzdkZDIwMDE2MWU=
+    M2FhYWYzZDE3OGE3OTFjMmFkZWMxYmE0NTRmMTZhMWMzZGYxYjVmOWE5YjM4
+    N2ExYmI2NWEyOTNkZWUyNzdiMmU3MDU2ZDU2NzY2NDE1YmZhMzdlZWFlNzdh
+    OTZhNTZkOGVjNDY5NzBmOWNlMTc2OWIxY2U1MDVjMDU0NzY2ZTg=
   data.tar.gz: !binary |-
-    YWM5ZjU5OGEyZTA3NDQxZTE0YmE1YmQxMTliODhlNmRmOTlkMzdkOWY4NThl
-    NWI5OWUwMjU1M2NlN2IxN2M3Y2Q5Mzc2N2U4YzRiMTUyNmM5ZWIzOTA5YWZk
-    YjY2ZDljZTRlMGYwNGNkNzgwMDkxNDViNTg0YmZmMjE4Y2ZjYmY=
+    NjlmYjUyZTk3NTc5ZjA0MzU2Y2IyYmYwNmUwYmU3ODY1MmZkOGE1ZWE2ZjQ1
+    NmYzNTkzMjk2Y2Y0OWEyMzNiOTFlNWIxNjViOTI5YTVjZGI0ZWRmNmIxZGJm
+    MGE2MTU2MGJjNDgxOTg4MTc4MWNiZmI2Nzc2ZDM2YjhjODUwN2Q=

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+.idea
+*.iml

data/README.md

@@ -1,2 +1,23 @@
 # Command Unit
-A very simple test runner, primarily written to support development of [Righteous Git Hooks](http://github.com/samsalisbury/righteous-git-hooks).
+Lightweight test runner, primarily written to support development of [Righteous Git Hooks](http://github.com/samsalisbury/righteous-git-hooks).
+
+Written in Ruby, designed to test command line apps, whether they're written in Ruby, Shell, Bash, C#, Java, whatever ;)
+
+## Design goals:
+* As few dependencies as possible
+* Should be self-testing
+* Suitable for testing command line tools
+
+Tests are written in Command Unit itself, so no need for any external dependencies yet. I might make this a fundamental requirement of future development, but I'll see how far the project can go on basic Ruby first.
+
+## This is alpha software
+So far I've only tested this on Ruby 1.9.3, others may work but I'm not considering support on any other platforms until I've got a stable/useful release out.
+
+## Installation
+`gem install command-unit`
+
+## Development
+Unpack the gem with `gem unpack command-unit`
+Run tests:
+    $ cd command-unit-0.0.1
+    $ ruby test/test.rb

data/command-unit.gemspec

@@ -1,11 +1,11 @@
 Gem::Specification.new do |s|
   s.name              = "command-unit"
-  s.version           = "0.0.0"
+  s.version           = "0.0.1"
   s.platform          = Gem::Platform::RUBY
   s.author           = "Samuel R. Salisbury"
   s.email             = "samsalisbury@gmail.com"
   s.homepage          = "http://github.com/samsalisbury/command-unit"
-  s.summary           = "ALPHA: Simple test runner for command line tools."
+  s.summary           = "ALPHA: Lightweight test runner for command line tools."
   s.description       = "ALPHA: Test runner for one-shot command line tools. This was built to support writing git hooks over at http://github.com/samsalisbury/righteous-git-hooks"
   
   s.rubyforge_project = s.name

data/lib/command-unit.rb

@@ -1,60 +1,154 @@
 module CommandUnit
 
+  @@scenario_count = 0
+
   @@scenarios = []
   @@current_scenario = nil
   attr_reader :current_scenario
 
-  def scenario(description, &block)
-    @@scenarios.push Scenario.new(description, &block)
+  def scenario(namespace_or_description, description_or_nil=nil, &block)
+    raise "You must provide a description (String) for each scenario." if namespace_or_description.nil? or description_or_nil.is_a? Symbol
+    raise "namespace must be a symbol, if you meant it as a description, use a string instead." if description_or_nil.is_a? String and not namespace_or_description.is_a? Symbol
+
+    if description_or_nil.nil?
+      description = namespace_or_description
+      namespace = nil
+    else
+      description = description_or_nil
+      namespace = namespace_or_description
+    end
+
+    @@scenarios.push Scenario.new(namespace, description, &block)
+    return @@scenarios.last
   end
 
-  def run
-    @@scenarios.each do |scenario|
-      scenario.run
+  def run(namespace_or_scenario_or_nowt = nil)
+    if namespace_or_scenario_or_nowt.nil?
+      # Run the lot...
+      @@scenarios.each do |scenario|
+        scenario.run
+      end
+    else
+      if namespace_or_scenario_or_nowt.is_a? Symbol
+        @@scenarios.each do |scenario|
+          next unless scenario.namespace == namespace_or_scenario_or_nowt
+          scenario.run
+        end
+      elsif namespace_or_scenario.is_a? Scenario
+        namespace_or_scenario_or_nowt.run
+      else
+        raise "You must pass either a Scenario, a Symbol (namespace), or nil into run. You passed a #{namespace_or_scenario_or_nowt.class}"
+      end
     end
   end
 
+  require 'stringio'
+
+  def capture_stdout
+    out = StringIO.new
+    $stdout = out
+    yield
+    r = out.string
+    return r
+  ensure
+    $stdout = STDOUT
+  end
+
+  def ensure_inside_scenario
+    raise "#{caller[0]} must be called from inside a scenario block" if @@current_scenario == nil
+  end
+
+  def scenario_set_up(&scenario_set_up_block)
+    ensure_inside_scenario
+    @@current_scenario.scenario_set_up_block = scenario_set_up_block
+  end
+
+  def scenario_tear_down(&scenario_tear_down_block)
+    ensure_inside_scenario
+    @@current_scenario.scenario_tear_down_block = scenario_tear_down_block
+  end
+
+  def tear_down(&tear_down_block)
+    ensure_inside_scenario
+    @@current_scenario.tear_down_block = tear_down_block
+  end
+
   def set_up(&set_up_block)
-    raise 'set_up must be called from inside a scenario block' if @@current_scenario == nil
+    ensure_inside_scenario
     @@current_scenario.set_up_block = set_up_block
   end
 
   def when_i(desc, &when_i_block)
-    raise 'when_i must be called from inside a scenario block' if @@current_scenario == nil
+    ensure_inside_scenario
     @@current_scenario.add_test Test.new(desc, &when_i_block)
   end
 
   def i_expect(desc, &i_expect_block)
-    raise 'i_expect must be called from inside a scenario block' if @@current_scenario == nil
+    ensure_inside_scenario
     @@current_scenario.current_test.add_expectation Expectation.new(desc, &i_expect_block)
   end
 
+  def success(desc = '')
+    ExpectationResult.new(desc, true)
+  end
+
+  def failure(desc = '')
+    ExpectationResult.new(desc, false)
+  end
+
   class Scenario
-    def initialize(desc, &block)
+    def initialize(namespace, desc, &block)
+      @namespace = namespace
+      @id = @@scenario_count += 1
       @desc = desc
       @block = block
       @set_up_block = nil
       @tests = []
       @current_test = nil
       @tear_down_block = nil
+      @scenario_set_up_block = nil
+      @scenario_tear_down_block = nil
+      @tests_run = 0
+      @expectations_run = 0
+      @expectations_met = 0
+      @expectations_not_met = 0
+      @inconclusive_expectations = 0
     end
 
     def run
-      puts "Running scenario: #{@desc}"
+      puts "\nRunning scenario #{@id}: #{@desc}"
       @@current_scenario = self
       @block.call
+      context = {}
+      @scenario_set_up_block.call(context) unless @scenario_set_up_block.nil?
       @tests.each do |test|
-        puts "When I #{test.when_i_text}"
-        context = {}
+        puts "\tWhen I #{test.when_i_text}"
+        @tests_run += 1
         @set_up_block.call(context) unless @set_up_block.nil?
         test.when_i_block.call(context) unless test.when_i_block.nil?
-        print 'I expect '
         test.expectations.each do |expectation|
-          puts expectation.desc
-          expectation.block.call(context) unless expectation.block.nil?
+          print "\t\tI expect #{expectation.desc}..."
+          result = expectation.block.call(context)
+          @expectations_run += 1
+          if result.respond_to? :success?
+            if result.success?
+              @expectations_met +=1
+              puts "Success! #{result.message}"
+            else
+              @expectations_not_met +=1
+              puts "Failure! #{result.message}"
+            end
+          else
+            @inconclusive_expectations += 1
+            puts "Inconclusive! #{result}"
+          end
         end
+        @tear_down_block.call(context) unless @tear_down_block.nil?
       end
+      @scenario_tear_down_block.call(context) unless @scenario_tear_down_block.nil?
       @@current_scenario = nil
+
+      puts "Scenario #{@id} finished, #{@tests_run} tests, #{@expectations_run} expectations with #{@expectations_met} successful and #{@expectations_not_met} failures."
     end
 
     def add_test(test)
@@ -62,7 +156,8 @@ module CommandUnit
       @current_test = test
     end
 
-    attr_accessor :desc, :block, :set_up_block, :tests, :tear_down_block, :current_test
+    attr_accessor :desc, :block, :set_up_block, :tests, :tear_down_block, :current_test,
+                  :scenario_set_up_block, :scenario_tear_down_block, :namespace
   end
 
   class Test
@@ -85,4 +180,15 @@ module CommandUnit
     attr_accessor :desc, :block
   end
 
-end
+  class ExpectationResult
+    def initialize(description, expectation_met)
+      @message = description
+      @success = expectation_met
+    end
+    attr_reader :message
+    def success?
+      @success
+    end
+
+  end
+end

data/test/quick-test.rb

@@ -1,12 +1,26 @@
+require_relative '../lib/command-unit'
+
 include CommandUnit
 
 scenario 'When blahblahs are whatnots' do
 
+  scenario_set_up do |context|
+    puts 'scenario_set_up called!'
+  end
+
+  scenario_tear_down do |context|
+    puts 'scenario_tear_down called!'
+  end
+
   set_up do |context|
     puts 'set_up called!'
     context[:thing] = 'some property set in set_up'
   end
 
+  tear_down do |context|
+    puts 'tear_down called!'
+  end
+
   when_i "don't do anything" do |context|
     # Doing nothing
     puts 'when_i called!'
@@ -18,6 +32,33 @@ scenario 'When blahblahs are whatnots' do
     context[:thing3] = 'thang'
   end
 
+  when_i "create another test" do |context|
+    # Doing nothing
+    puts 'when_i called!'
+    context[:thing2] = 'thing'
+  end
+
+  i_expect 'that the second test is also run' do |context|
+    puts 'i_expect called!'
+    context[:thing3] = 'thang'
+  end
+
+  when_i "create a third test with 2 expectations" do |context|
+    # Doing nothing
+    puts 'when_i called!'
+    context[:thing2] = 'thing'
+  end
+
+  i_expect 'that both expectations are called' do |context|
+    puts 'i_expect called!'
+    context[:thing3] = 'thang'
+  end
+
+  i_expect 'that this second expectation will also be called!' do |context|
+    puts 'i_expect called!'
+    context[:thing3] = 'thang'
+  end
+
 end
 
 run

data/test/test.rb

@@ -0,0 +1,59 @@
+require_relative '../lib/command-unit'
+
+include CommandUnit
+
+scenario :command_unit, 'Running a scenario with no tests or assertions' do
+
+  when_i 'execute the scenario' do |context|
+    context[:scenario] = scenario 'This is an empty scenario' do
+
+    end
+    context[:out] = capture_stdout { context[:scenario].run }
+  end
+
+  i_expect 'to see the scenario title' do |context|
+    if context[:out].include? 'This is an empty scenario'
+      success
+    else
+      failure "Output was: '#{context[:out]}'"
+    end
+  end
+
+end
+
+scenario :command_unit, 'Running a scenario with 1 test and 1 passing assertion' do
+
+  set_up do |context|
+    context[:scenario] = scenario 'This scenario has 1 test with 1 assertion' do
+      when_i 'have 1 test in the scenario' do
+        # Empty test test ;)
+      end
+      i_expect 'that this should pass' do
+        success
+      end
+    end
+  end
+
+  when_i 'run the scenario' do |context|
+    context[:out] = capture_stdout do context[:scenario].run end
+  end
+
+  i_expect 'to see the when_i text and the i_expect text' do |context|
+    if context[:out].include? 'have 1 test in the scenario' and context[:out].include? 'that this should pass'
+      success
+    else 
+      failure
+    end
+  end
+
+  i_expect 'to see the correct number of tests and expectations reported' do |context|
+    if context[:out].include? '1 tests, 1 expectations with 1 successful and 0 failures'
+      success
+    else
+      failure
+    end
+
+  end
+end
+
+run :command_unit

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: command-unit
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Samuel R. Salisbury
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-16 00:00:00.000000000 Z
+date: 2013-08-17 00:00:00.000000000 Z
 dependencies: []
 description: ! 'ALPHA: Test runner for one-shot command line tools. This was built
   to support writing git hooks over at http://github.com/samsalisbury/righteous-git-hooks'
@@ -17,11 +17,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
 - .ruby-version
 - README.md
 - command-unit.gemspec
 - lib/command-unit.rb
 - test/quick-test.rb
+- test/test.rb
 homepage: http://github.com/samsalisbury/command-unit
 licenses: []
 metadata: {}
@@ -44,5 +46,5 @@ rubyforge_project: command-unit
 rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
-summary: ! 'ALPHA: Simple test runner for command line tools.'
+summary: ! 'ALPHA: Lightweight test runner for command line tools.'
 test_files: []