evented-spec 0.4.0

data/lib/evented-spec/util.rb

@@ -0,0 +1,32 @@
+module EventedSpec
+  # Miscellanous utility methods used throughout the code.
+  module Util
+    extend self
+
+    # Creates a deep clone of an object. Different from normal Object#clone
+    # method which is shallow clone (doesn't traverse hashes and arrays,
+    # cloning their contents).
+    #
+    # @param Object to clone
+    # @return Deep clone of the given object
+    def deep_clone(value)
+      case value
+      when Hash
+        value.inject({}) do |result, kv|
+          result[kv[0]] = deep_clone(kv[1])
+          result
+        end
+      when Array
+        value.inject([]) do |result, item|
+          result << deep_clone(item)
+        end
+      else
+        begin
+          value.clone
+        rescue TypeError
+          value
+        end
+      end
+    end # deep_clone
+  end # module Util
+end # module EventedSpec

data/lib/evented-spec/version.rb

@@ -0,0 +1,8 @@
+require 'pathname'
+
+module EventedSpec
+  # Path to version file
+  VERSION_FILE = Pathname.new(__FILE__).dirname + '/../../VERSION'
+  # Gem version
+  VERSION = VERSION_FILE.exist? ? VERSION_FILE.read.strip : nil
+end

data/spec/cool_io_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+
+describe EventedSpec::SpecHelper, "Cool.io bindings" do
+  include EventedSpec::SpecHelper
+  default_timeout 0.1
+  let(:event_loop) { Coolio::Loop.default }
+
+  after(:each) {
+    event_loop.instance_variable_get(:@running).should be_false
+  }
+
+  describe "#coolio" do
+    it "should execute given block in the right scope" do
+      coolio do
+        @variable = true
+        done
+      end
+      @variable.should be_true
+    end
+
+    it "should start default cool.io loop and give control" do
+      coolio do
+        event_loop.instance_variable_get(:@running).should be_true
+        done
+      end
+    end
+
+    it "should stop the event loop afterwards" do
+      coolio do
+        @do_something_useful = true
+        done
+      end
+      event_loop.instance_variable_get(:@running).should be_false
+    end
+
+    it "should raise SpecTimeoutExceededError when #done is not issued" do
+      expect {
+        coolio do
+        end
+      }.to raise_error(EventedSpec::SpecHelper::SpecTimeoutExceededError)
+    end
+
+    it "should propagate mismatched rspec expectations" do
+      expect {
+        coolio do
+          :fail.should == :win
+        end
+      }.to raise_error(RSPEC::Expectations::ExpectationNotMetError)
+    end
+  end
+
+
+  describe "#done" do
+    it "should execute given block" do
+      coolio do
+        done(0.05) do
+          @variable = true
+        end
+      end
+      @variable.should be_true
+    end
+
+    it "should cancel timeout" do
+      expect {
+        coolio do
+          done(0.2)
+        end
+      }.to_not raise_error
+    end
+  end
+end

data/spec/em_defaults_spec.rb

@@ -0,0 +1,132 @@
+require 'spec_helper'
+
+describe EventedSpec::SpecHelper, " .default_options" do
+  include EventedSpec::SpecHelper
+  root_default_options = {:root_key => 1}
+  default_options root_default_options
+
+  it 'subsequent and nested groups should not change root default options' do
+    root_default_options.should == {:root_key => 1}
+  end
+
+  it 'example has access to default options' do
+    default_options.should == root_default_options
+  end
+
+  it 'defaults can be changed inside example, diverging from example group defaults' do
+    default_options[:example_key] = :example_value
+    default_options.should have_key :example_key
+    default_options.should_not == root_default_options
+  end
+
+  it 'changing example defaults has no effect on subsequent examples' do
+    default_options.should_not have_key :example_key
+    default_options.should == root_default_options
+  end
+
+  context 'inside nested example group 1' do
+    nested_default_options = default_options
+
+    it 'nested group defaults start as a copy of enclosing group default_options' do
+      nested_default_options.should == root_default_options
+    end
+
+    it 'example has access to default options' do
+      default_options.should == nested_default_options
+    end
+
+    it 'can be changed, thus diverging from example group default_options' do
+      default_options[:example_key] = :example_value
+      default_options.should have_key :example_key
+      default_options.should_not == root_default_options
+    end
+
+    it 'changing example default_options has no effect on subsequent examples' do
+      default_options.should_not have_key :example_key
+      default_options.should == root_default_options
+    end
+
+    context 'inside deeply nested example group 1' do
+      nested_default_options = default_options
+
+      it 'nested group defaults start as a copy of enclosing group default_options' do
+        nested_default_options.should == root_default_options
+      end
+
+      it 'example has access to default options' do
+        default_options.should == nested_default_options
+      end
+
+      it 'can be changed in example, thus diverging from example group default_options' do
+        default_options[:example_key] = :example_value
+        default_options.should have_key :example_key
+        default_options.should_not == nested_default_options
+      end
+
+      it 'changing example default_options has no effect on subsequent examples' do
+        default_options.should_not have_key :example_key
+        default_options.should == nested_default_options
+      end
+    end # inside deeply nested example group 1
+  end # inside nested example group 1
+
+  context 'inside nested example group 2' do
+    default_options[:nested_key] = :nested_value
+    nested_default_options = default_options
+
+    it 'changing default options inside nested group works' do
+      nested_default_options.should have_key :nested_key
+    end
+
+    it 'changing default_options in nested group affects example default_options' do
+      default_options.should == nested_default_options
+      default_options.should_not == root_default_options
+    end
+
+    it 'can be changed in example, thus diverging from example group default_options' do
+      default_options[:example_key] = :example_value
+      default_options.should have_key :example_key
+      default_options.should have_key :nested_key
+      default_options.should_not == nested_default_options
+      default_options.should_not == root_default_options
+    end
+
+    it 'changing example default_options has no effect on subsequent examples' do
+      default_options.should == nested_default_options
+    end
+
+    context 'inside deeply nested example group 2' do
+      default_options[:deeply_nested_key] = :deeply_nested_value
+      deeply_nested_default_options = default_options
+
+      it 'inherits default options from enclosing group' do
+        deeply_nested_default_options.should have_key :nested_key
+      end
+
+      it 'changing default options inside deeply nested group works' do
+        deeply_nested_default_options.should have_key :deeply_nested_key
+      end
+
+      it 'changing default_options in nested group affects example group default_options' do
+        default_options.should == deeply_nested_default_options
+        default_options.should have_key :nested_key
+        default_options.should have_key :deeply_nested_key
+        default_options.should_not == nested_default_options
+        default_options.should_not == root_default_options
+      end
+
+      it 'can be changed in example, thus diverging from example group default_options' do
+        default_options[:example_key] = :example_value
+        default_options.should have_key :example_key
+        default_options.should have_key :nested_key
+        default_options.should have_key :deeply_nested_key
+        default_options.should_not == nested_default_options
+        default_options.should_not == root_default_options
+      end
+
+      it 'changing example default_options has no effect on subsequent examples' do
+        default_options.should == deeply_nested_default_options
+      end
+    end # inside deeply nested example group 2
+  end # inside nested example group 2
+end # describe AMQP, "default_options"

data/spec/em_hooks_spec.rb

@@ -0,0 +1,231 @@
+require 'spec_helper'
+
+# Registers specific hook type as being called,
+# sets expectations about EM reactor and AMQP connection state
+module HookHelper
+  def hook(type, reactor, connection)
+    @hooks_called << type.to_sym if type
+    if :reactor_running == reactor
+      EM.reactor_running?.should be_true
+    else
+      EM.reactor_running?.should be_false
+    end
+    if :amqp_connected == connection
+      AMQP.connection.should be_connected
+    else
+      if AMQP.connection
+        AMQP.connection.connected?.should be_false
+      end
+    end
+  end
+end
+
+shared_examples_for 'hooked em specs' do
+  it 'should execute em_before' do
+    em do
+      @hooks_called.should include :em_before
+      @hooks_called.should_not include :em_after
+      done
+    end
+  end
+
+  it 'should execute em_after if business exception is raised' do
+    # Expectation is set in after{} hook
+    em do
+      expect {
+        raise StandardError
+      }.to raise_error
+      done
+    end
+  end
+
+  it 'should execute em_after if RSpec expectation fails' do
+    # Expectation is set in after{} hook
+    em do
+      expect { :this.should == :fail
+      }.to raise_error RSPEC::Expectations::ExpectationNotMetError
+      done
+    end
+  end
+end
+
+shared_examples_for 'hooked amqp specs' do
+  it 'should execute em_before' do
+    amqp do
+      @hooks_called.should include :em_before
+      @hooks_called.should_not include :em_after
+      @hooks_called.should include :amqp_before
+      @hooks_called.should_not include :amqp_after
+      done
+    end
+  end
+
+  it 'should execute em_after if business exception is raised' do
+    # Expectation is set in after{} hook
+    amqp do
+      expect {
+        raise StandardError
+      }.to raise_error
+      done
+    end
+  end
+
+  it 'should execute em_after if RSpec expectation fails' do
+    # Expectation is set in after{} hook
+    amqp do
+      expect { :this.should == :fail
+      }.to raise_error RSPEC::Expectations::ExpectationNotMetError
+      done
+    end
+  end
+end
+
+describe EventedSpec::SpecHelper, ".em_before/.em_after" do
+  before { @hooks_called = [] }
+  include HookHelper
+  describe AMQP, " tested with EventedSpec::SpecHelper" do
+    include EventedSpec::SpecHelper
+    default_options AMQP_OPTS if defined? AMQP_OPTS
+
+    before { hook :before, :reactor_not_running, :amqp_not_connected }
+    em_before { hook :em_before, :reactor_running, :amqp_not_connected }
+    em_after { hook(:em_after, :reactor_running, :amqp_not_connected) }
+
+    context 'for non-evented specs' do
+      after {
+        @hooks_called.should == [:before]
+        hook :after, :reactor_not_running, :amqp_not_connected }
+
+      it 'should NOT execute em_before or em_after' do
+        @hooks_called.should_not include :em_before
+        @hooks_called.should_not include :em_after
+      end
+
+      it 'should NOT execute em_after if business exception is raised' do
+        expect { raise StandardError
+        }.to raise_error
+      end
+
+      it 'should execute em_after if RSpec expectation fails' do
+        expect { :this.should == :fail
+        }.to raise_error RSPEC::Expectations::ExpectationNotMetError
+      end
+    end # context 'for non-evented specs'
+
+    context 'for evented specs' do #, pending: true do
+      after do
+        @hooks_called.should include :before, :em_before, :em_after
+        hook :after, :reactor_not_running, :amqp_not_connected
+      end
+
+      context 'with em block' do
+
+        it_should_behave_like 'hooked em specs'
+
+        it 'should not run nested em hooks' do
+          em do
+            @hooks_called.should_not include :context_em_before, :context_before
+            done
+          end
+        end
+
+        it 'should not run hooks from unrelated group' do
+           em do
+             @hooks_called.should_not include :amqp_context_em_before,
+                                              :amqp_context_before,
+                                              :amqp_before,
+                                              :context_amqp_before
+             done
+           end
+        end
+
+        context 'inside nested example group' do
+          before { hook :context_before, :reactor_not_running, :amqp_not_connected }
+          em_before { hook :context_em_before, :reactor_running, :amqp_not_connected }
+          em_after { hook :context_em_after, :reactor_running, :amqp_not_connected }
+
+          after do
+            @hooks_called.should include :before,
+                                         :context_before,
+                                         :em_before,
+                                         :context_em_before,
+                                         :context_em_after,
+                                         :em_after
+            hook :after, :reactor_not_running, :amqp_not_connected
+          end
+
+          it_should_behave_like 'hooked em specs'
+
+          it 'should fire all nested :before hooks, but no :after hooks' do
+            em do
+              @hooks_called.should == [:before,
+                                       :context_before,
+                                       :em_before,
+                                       :context_em_before]
+              done
+            end
+          end
+
+        end # context 'inside nested example group'
+      end # context 'with em block'
+
+      context 'with amqp block' do
+        amqp_before { hook :amqp_before, :reactor_running, :amqp_connected }
+        amqp_after { hook :amqp_after, :reactor_running, :amqp_connected }
+
+        it_should_behave_like 'hooked amqp specs'
+
+        it 'should not run nested em hooks' do
+          amqp do
+            @hooks_called.should_not include :amqp_context_before,
+                                             :amqp_context_em_before,
+                                             :context_amqp_before
+            done
+          end
+        end
+
+        it 'should not run hooks from unrelated group' do
+          amqp do
+            @hooks_called.should_not include :context_em_before, :context_before
+            done
+          end
+        end
+
+        context 'inside nested example group' do
+          before { hook :amqp_context_before, :reactor_not_running, :amqp_not_connected }
+          em_before { hook :amqp_context_em_before, :reactor_running, :amqp_not_connected }
+          em_after { hook :amqp_context_em_after, :reactor_running, :amqp_not_connected }
+          amqp_before { hook :context_amqp_before, :reactor_running, :amqp_connected }
+          amqp_after { hook :context_amqp_after, :reactor_running, :amqp_connected }
+
+          after { @hooks_called.should == [:before,
+                                           :amqp_context_before,
+                                           :em_before,
+                                           :amqp_context_em_before,
+                                           :amqp_before,
+                                           :context_amqp_before,
+                                           :context_amqp_after,
+                                           :amqp_after,
+                                           :amqp_context_em_after,
+                                           :em_after]
+          hook :after, :reactor_not_running, :amqp_not_connected }
+
+          it_should_behave_like 'hooked amqp specs'
+
+          it 'should fire all :before hooks in correct order' do
+            amqp do
+              @hooks_called.should == [:before,
+                                       :amqp_context_before,
+                                       :em_before,
+                                       :amqp_context_em_before,
+                                       :amqp_before,
+                                       :context_amqp_before]
+              done
+            end
+          end
+
+        end # context 'inside nested example group'
+      end # context 'with amqp block'
+    end # context 'for evented specs'
+  end # describe EventedSpec, " tested with EventedSpec::SpecHelper"
+end # describe EventedSpec, " with em_before/em_after"