evented-spec 0.4.0

data/spec/em_metadata_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe "Example Groups", ".evented_spec_metadata" do
+  context "when EventedSpec::SpecHelper is included" do
+    include EventedSpec::SpecHelper
+    it "should assign some hash by default" do
+      self.class.evented_spec_metadata.should == {}
+    end
+
+    context "in nested group" do
+      evented_spec_metadata[:nested] = {}
+      evented_spec_metadata[:other] = :value
+      it "should merge metadata" do
+        self.class.evented_spec_metadata.should == {:nested => {}, :other => :value}
+      end
+
+      context "in deeply nested group" do
+        evented_spec_metadata[:nested][:deeply] = {}
+        evented_spec_metadata[:other] = "hello"
+        it "should merge metadata" do
+          self.class.evented_spec_metadata[:nested][:deeply].should == {}
+        end
+
+        it "should allow to override merged metadata" do
+          self.class.evented_spec_metadata[:other].should == "hello"
+        end
+      end
+
+      context "in other deeply nested group" do
+        evented_spec_metadata[:nested][:other] = {}
+        it "should diverge without being tainted by neighbouring example groups" do
+          self.class.evented_spec_metadata.should == {:nested => {:other => {}}, :other => :value}
+        end
+      end
+    end
+  end
+
+  context "when EventedSpec::SpecHelper is not included" do
+    it "should not be defined" do
+      self.class.should_not respond_to(:evented_spec_metadata)
+    end
+  end
+end

data/spec/failing_rspec_spec.rb

@@ -0,0 +1,63 @@
+require 'spec_helper'
+
+describe 'Following 9 examples should all be failing:' do
+  describe EventMachine, " when running failing examples" do
+    include EventedSpec::EMSpec
+
+    it "should not bubble failures beyond rspec" do
+      EM.add_timer(0.1) do
+        :should_not_bubble.should == :failures
+        done
+      end
+    end
+
+    it "should not block on failure" do
+      1.should == 2
+    end
+  end
+
+  describe EventMachine, " when testing with EventedSpec::EMSpec with a maximum execution time per test" do
+    include EventedSpec::EMSpec
+
+    default_timeout 1
+
+    it 'should timeout before reaching done' do
+      EM.add_timer(2) { done }
+    end
+
+    it 'should timeout before reaching done' do
+      timeout(0.3)
+      EM.add_timer(0.6) { done }
+    end
+  end
+
+  describe AMQP, " when testing with EventedSpec::AMQPSpec with a maximum execution time per test" do
+
+    include EventedSpec::AMQPSpec
+
+    default_timeout 1
+
+    it 'should timeout before reaching done' do
+      EM.add_timer(2) { done }
+    end
+
+    it 'should timeout before reaching done' do
+      timeout(0.2)
+      EM.add_timer(0.5) { done }
+    end
+
+    it 'should fail due to timeout, not hang up' do
+      timeout(0.2)
+    end
+
+    it 'should fail due to default timeout, not hang up' do
+    end
+  end
+
+  describe AMQP, "when default timeout is not set" do
+    include EventedSpec::AMQPSpec
+    it "should fail by timeout anyway" do
+      1.should == 1
+    end
+  end
+end

data/spec/rspec_amqp_spec.rb

@@ -0,0 +1,116 @@
+require 'spec_helper'
+
+def publish_and_consume_once(queue_name="test_sink", data="data")
+  amqp(:spec_timeout => 0.5) do
+    AMQP::Channel.new do |channel, _|
+      exchange = channel.direct(queue_name)
+      queue = channel.queue(queue_name).bind(exchange)
+      queue.subscribe do |hdr, msg|
+        hdr.should be_an AMQP::Header
+        msg.should == data
+        done { queue.unsubscribe; queue.delete }
+      end
+      EM.add_timer(0.2) do
+        exchange.publish data
+      end
+    end
+  end
+end
+
+describe RSPEC do
+  it 'should work as normal without AMQP-Spec' do
+    1.should == 1
+  end
+end
+
+describe 'Evented AMQP specs' do
+  describe AMQP, " when testing with EventedSpec::SpecHelper" do
+    include EventedSpec::SpecHelper
+
+    default_options AMQP_OPTS if defined? AMQP_OPTS
+    default_timeout 1
+
+    puts "Default timeout: #{default_timeout}"
+    puts "Default options :#{default_options}"
+
+    it_should_behave_like 'SpecHelper examples'
+
+    context 'inside embedded context / example group' do
+      it_should_behave_like 'SpecHelper examples'
+    end
+  end
+
+  describe AMQP, " when testing with EventedSpec::AMQPSpec" do
+    include EventedSpec::AMQPSpec
+
+    default_options AMQP_OPTS if defined? AMQP_OPTS
+    default_timeout 1
+
+    it_should_behave_like 'Spec examples'
+
+    context 'inside embedded context / example group' do
+      it 'should inherit default_options/metadata from enclosing example group' do
+        # This is a guard against regression on dev box without notice
+        AMQP.connection.instance_variable_get(:@settings)[:host].should == AMQP_OPTS[:host]
+        self.class.default_options[:host].should == AMQP_OPTS[:host]
+        self.class.default_timeout.should == 1
+        done
+      end
+
+      it_should_behave_like 'Spec examples'
+    end
+  end
+
+  describe AMQP, " tested with EventedSpec::SpecHelper when Rspec failures occur" do
+    include EventedSpec::SpecHelper
+
+    default_options AMQP_OPTS if defined? AMQP_OPTS
+
+    it "bubbles failing expectations up to Rspec" do
+      expect {
+        amqp do
+          :this.should == :fail
+        end
+      }.to raise_error RSPEC::Expectations::ExpectationNotMetError
+      AMQP.connection.should == nil
+    end
+
+    it "should NOT ignore failing expectations after 'done'" do
+      expect {
+        amqp do
+          done
+          :this.should == :fail
+        end
+      }.to raise_error RSPEC::Expectations::ExpectationNotMetError
+      AMQP.connection.should == nil
+    end
+
+    it "should properly close AMQP connection after Rspec failures" do
+      AMQP.connection.should == nil
+    end
+  end
+
+  describe 'MQ', " when AMQP.queue/fanout/topic tries to access Thread.current[:mq] across examples" do
+    include EventedSpec::SpecHelper
+
+    default_options AMQP_OPTS if defined? AMQP_OPTS
+
+    it 'sends data to the queue' do
+      publish_and_consume_once
+    end
+
+    it 'does not hang sending data to the same queue, again' do
+      publish_and_consume_once
+    end
+
+    it 'cleans Thread.current[:mq] after pubsub examples' do
+      Thread.current[:mq].should be_nil
+    end
+  end
+end
+
+describe RSPEC, " when running an example group after another group that uses AMQP-Spec " do
+  it "should work normally" do
+    :does_not_hang.should_not be_false
+  end
+end

data/spec/rspec_em_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe 'Plain EM, no AMQP' do
+  describe EventMachine, " when testing with EventedSpec::SpecHelper" do
+    include EventedSpec::SpecHelper
+
+    it "should not require a call to done when #em is not used" do
+      1.should == 1
+    end
+
+    it "should have timers" do
+      start = Time.now
+      em do
+        EM.add_timer(0.5) {
+          (Time.now-start).should be_within(0.1).of(0.5)
+          done
+        }
+      end
+    end
+
+    it "should be possible to set spec timeouts as a number of seconds" do
+      start = Time.now
+      expect {
+        em(0.5) do
+          EM.add_timer(1) { done }
+        end
+      }.to raise_error EventedSpec::SpecHelper::SpecTimeoutExceededError
+      (Time.now-start).should be_within(0.1).of(0.5)
+    end
+
+    it "should be possible to set spec timeout as an option (amqp interface compatibility)" do
+      start = Time.now
+      expect {
+        em(0.5) do
+          EM.add_timer(1) { done }
+        end
+      }.to raise_error EventedSpec::SpecHelper::SpecTimeoutExceededError
+      (Time.now-start).should be_within(0.1).of(0.5)
+    end
+  end
+
+  describe EventMachine, " when testing with EventedSpec::EMSpec" do
+    include EventedSpec::EMSpec
+
+    it_should_behave_like 'Spec examples'
+  end
+end
+
+describe RSPEC, " when running an example group after groups that uses EM specs " do
+  it "should work normally" do
+    :does_not_hang.should_not be_false
+  end
+end

data/spec/shared_examples.rb

@@ -0,0 +1,194 @@
+shared_examples_for 'SpecHelper examples' do
+  after do
+    EM.reactor_running?.should == false
+    AMQP.connection.should be_nil
+  end
+
+  it "should not require a call to done when #em/#amqp is not used" do
+    1.should == 1
+  end
+
+  it "should properly work" do
+    amqp { done }
+  end
+
+  it "should have timers" do
+    start = Time.now
+    amqp do
+      EM.add_timer(0.5) {
+        (Time.now-start).should be_within(0.1).of(0.5)
+        done
+      }
+    end
+  end
+
+  it 'should have deferrables' do
+    amqp do
+      defr = EM::DefaultDeferrable.new
+      defr.timeout(0.5)
+      defr.errback {
+        done
+      }
+    end
+  end
+
+  it "should run AMQP.start loop with options given to #amqp" do
+    amqp(:vhost => '/', :user => 'guest') do
+      AMQP.connection.should be_connected
+      done
+    end
+  end
+
+  it "should properly close AMQP connection if block completes normally" do
+    amqp do
+      AMQP.connection.should be_connected
+      done
+    end
+    AMQP.connection.should be_nil
+  end
+
+  # TODO: remove dependency on (possibly long) DNS lookup
+  it "should gracefully exit if no AMQP connection was made" do
+    expect {
+      amqp(:host => '192.168.0.256') do
+        AMQP.connection.should be_nil
+        done
+      end
+    }.to raise_error EventMachine::ConnectionError
+    AMQP.connection.should be_nil
+  end
+
+  it_should_behave_like 'done examples'
+
+  it_should_behave_like 'timeout examples'
+end
+
+shared_examples_for 'done examples' do
+
+  it 'should yield to block given to done (when amqp is used)' do
+    amqp do
+      done { @block_called = true; EM.reactor_running?.should == true }
+    end
+    @block_called.should == true
+  end
+
+  it 'should yield to block given to done (when em is used)' do
+    em do
+      done { @block_called = true; EM.reactor_running?.should == true }
+    end
+    @block_called.should == true
+  end
+
+  it 'should have delayed done (when amqp is used)' do
+    start = Time.now
+    amqp do
+      done(0.2) { @block_called = true; EM.reactor_running?.should == true }
+    end
+    @block_called.should == true
+    (Time.now-start).should be_within(0.1).of(0.2)
+  end
+
+  it 'should have delayed done (when em is used)' do
+    start = Time.now
+    em do
+      done(0.2) { @block_called = true; EM.reactor_running?.should == true }
+    end
+    @block_called.should == true
+    (Time.now-start).should be_within(0.1).of(0.2)
+  end
+end
+
+shared_examples_for 'timeout examples' do
+  before { @start = Time.now }
+
+  it 'should timeout before reaching done because of default spec timeout' do
+    expect { amqp { EM.add_timer(2) { done } } }.
+        to raise_error EventedSpec::SpecHelper::SpecTimeoutExceededError
+    (Time.now-@start).should be_within(0.1).of(1.0)
+  end
+
+  it 'should timeout before reaching done because of explicit in-loop timeout' do
+    expect {
+      amqp do
+        timeout(0.2)
+        EM.add_timer(0.5) { done }
+      end
+    }.to raise_error EventedSpec::SpecHelper::SpecTimeoutExceededError
+    (Time.now-@start).should be_within(0.1).of(0.2)
+  end
+
+  specify "spec timeout given in amqp options has higher priority than default" do
+    expect { amqp(:spec_timeout => 0.2) {} }.
+        to raise_error EventedSpec::SpecHelper::SpecTimeoutExceededError
+    (Time.now-@start).should be_within(0.1).of(0.2)
+  end
+
+  specify "but timeout call inside amqp loop has even higher priority" do
+    expect { amqp(:spec_timeout => 0.5) { timeout(0.2) } }.
+        to raise_error EventedSpec::SpecHelper::SpecTimeoutExceededError
+    (Time.now-@start).should be_within(0.1).of(0.2)
+  end
+
+  specify "AMQP connection should not leak between examples" do
+    AMQP.connection.should be_nil
+  end
+
+  context 'embedded context can set up separate defaults' do
+    default_timeout 0.2 # Can be used to set default :spec_timeout for all evented specs
+
+    specify 'default timeout should be 0.2' do
+      expect { em { EM.add_timer(2) { done } } }.to raise_error EventedSpec::SpecHelper::SpecTimeoutExceededError
+      (Time.now-@start).should be_within(0.1).of(0.2)
+    end
+
+    context 'deeply embedded context can set up separate defaults' do
+      default_timeout 0.5
+
+      specify 'default timeout should be 0.5' do
+        expect { amqp { EM.add_timer(2) { done } } }.to raise_error EventedSpec::SpecHelper::SpecTimeoutExceededError
+        (Time.now-@start).should be_within(0.1).of(0.5)
+      end
+    end
+  end
+end
+
+shared_examples_for 'Spec examples' do
+  after(:each) do
+    # By this time, EM loop is stopped, either by timeout, or by exception
+    EM.reactor_running?.should == false
+  end
+
+  it 'should work' do
+    done
+  end
+
+  it 'should have timers' do
+    start = Time.now
+
+    EM.add_timer(0.2) {
+      (Time.now-start).should be_within(0.1).of(0.2)
+      done
+    }
+  end
+
+  it 'should have periodic timers' do
+    num = 0
+    start = Time.now
+
+    timer = EM.add_periodic_timer(0.2) {
+      if (num += 1) == 2
+        (Time.now-start).should be_within(0.1).of(0.5)
+        EM.cancel_timer timer
+        done
+      end
+    }
+  end
+
+  it 'should have deferrables' do
+    defr = EM::DefaultDeferrable.new
+    defr.timeout(0.2)
+    defr.errback {
+      done
+    }
+  end
+end