zyre 0.1.0

data/spec/zyre/node_spec.rb

@@ -0,0 +1,356 @@
+#!/usr/bin/env rspec -cfd
+
+require_relative '../spec_helper'
+
+require 'zyre/node'
+
+
+RSpec.describe( Zyre::Node ) do
+
+	TEST_WHISPER = <<~END_WHISPER
+	I hear you whispering there, O stars of heaven;
+	O suns! O grass of graves! O perpetual transfers and promotions!
+	END_WHISPER
+
+	TEST_SHOUT = <<~END_SHOUT
+	I too am not a bit tamed—I too am untranslatable;
+	I sound my barbaric yawp over the roofs of the world.
+	END_SHOUT
+
+
+	it "can be created anonymously" do
+		node = described_class.new
+
+		expect( node ).to be_a( described_class )
+		expect( node.name ).to eq( node.uuid[0,6] )
+	end
+
+
+	it "can be create with a name" do
+		node = described_class.new( 'raptor1' )
+
+		expect( node ).to be_a( described_class )
+		expect( node.name ).to eq( 'raptor1' )
+		expect( node.name ).to be_frozen
+	end
+
+
+	it "can set headers" do
+		node1 = started_node do |n|
+			n.set_header( 'Protocol-version', '2' )
+		end
+		node2 = started_node
+
+		event = node2.wait_for( :ENTER )
+
+		expect( event.headers ).to eq({ 'Protocol-version' => '2' })
+	end
+
+
+	it "can set headers from a hash" do
+		node1 = started_node do |n|
+			n.headers = {
+				protocol_version: 2,
+				content_type: 'application/messagepack'
+			}
+		end
+		node2 = started_node
+
+		event = node2.wait_for( :ENTER )
+
+		expect( event.headers ).to eq({
+			'Protocol-version' => '2',
+			'Content-type' => 'application/messagepack'
+		})
+	end
+
+
+	it "can have a custom evasive timeout" do
+		node = described_class.new
+		expect {
+			node.evasive_timeout = 225
+		}.to_not raise_error
+	end
+
+
+	it "can have a custom silent timeout" do
+		skip "Not implemented on this platform" unless
+			described_class.instance_methods.include?( :silent_timeout= )
+
+		node = described_class.new
+		expect {
+			node.silent_timeout = 10000
+		}.to_not raise_error
+	end
+
+
+	it "can have a custom expired timeout" do
+		node = described_class.new
+		expect {
+			node.expired_timeout = 7500
+		}.to_not raise_error
+	end
+
+
+	it "can have a custom beacon discovery interval" do
+		node = described_class.new
+		expect {
+			node.interval = 250
+		}.to_not raise_error
+	end
+
+
+	it "can be set to communicate on a particular network interface" do
+		node = described_class.new
+		expect {
+			node.interface = 'lo0'
+		}.to_not raise_error
+	end
+
+
+	it "knows what its own groups are" do
+		node = started_node()
+		node.join( 'GLOBAL' )
+		node.join( 'SPECIAL' )
+
+		expect( node.own_groups ).to contain_exactly( 'GLOBAL', 'SPECIAL' )
+	end
+
+
+	it "knows what groups are known via its connected peers" do
+		node1 = started_node()
+		node1.join( 'GLOBAL' )
+		node1.join( 'SPECIAL' )
+
+		node2 = started_node()
+
+		node1.wait_for( :ENTER, peer_uuid: node2.uuid )
+
+		expect( node2.peer_groups ).to contain_exactly( 'GLOBAL', 'SPECIAL' )
+	end
+
+
+	it "returns an empty array for known groups with no peers" do
+		node1 = started_node()
+
+		expect( node1.peer_groups ).to be_empty
+	end
+
+
+	it "knows what one of its peers' address is" do
+		node1 = started_node()
+		node2 = started_node()
+
+		enter_event = node1.wait_for( :ENTER, peer_uuid: node2.uuid )
+
+		expect( node1.peer_address(node2.uuid) ).to eq( enter_event.peer_addr )
+	end
+
+
+	it "returns nil for the address of non-existent peers" do
+		node1 = started_node()
+		node2 = Zyre::Node.new
+
+		expect( node1.peer_address(node2.uuid) ).to be_nil
+	end
+
+
+	it "can whisper to another node" do
+		node1 = started_node()
+		node2 = started_node()
+
+		node1.wait_for( :ENTER, peer_uuid: node2.uuid )
+		node1.whisper( node2.uuid, TEST_WHISPER )
+
+		ev = node2.recv
+		expect( ev.type ).to eq( :ENTER )
+
+		ev = node2.recv
+		expect( ev.type ).to eq( :WHISPER )
+		expect( ev.msg.encoding ).to eq( Encoding::UTF_8 )
+		expect( ev.msg ).to eq( TEST_WHISPER )
+	end
+
+
+	it "can shout to a group of nodes" do
+		node1 = started_node()
+		node2 = started_node()
+
+		node1.join( 'ROOFTOP' )
+		node2.join( 'ROOFTOP' )
+
+		node1.wait_for( :JOIN, group: 'ROOFTOP', peer_uuid: node2.uuid )
+		node1.shout( 'ROOFTOP', TEST_SHOUT )
+
+		ev = node2.recv
+		expect( ev ).to be_a( Zyre::Event::Enter )
+
+		ev = node2.recv
+		expect( ev ).to be_a( Zyre::Event::Join )
+
+		ev = node2.recv
+		expect( ev ).to be_a( Zyre::Event::Shout )
+		expect( ev.msg.encoding ).to eq( Encoding::UTF_8 )
+		expect( ev.msg ).to eq( TEST_SHOUT )
+	end
+
+
+	it "knows who all of its peers are" do
+		node1 = started_node()
+		node2 = started_node()
+		node3 = started_node()
+		node4 = started_node()
+
+		3.times do
+			node1.wait_for( :ENTER )
+		end
+
+		expect( node1.peers ).to contain_exactly( node2.uuid, node3.uuid, node4.uuid )
+	end
+
+
+	it "returns an empty array for its peers if it has none" do
+		node1 = started_node()
+
+		expect( node1.peers ).to be_empty
+	end
+
+
+	it "knows who its peers for a certain group are" do
+		node1 = started_node()
+		node1.join( 'CHANNEL1' )
+		node1.join( 'CHANNEL2' )
+		node2 = started_node()
+		node2.join( 'CHANNEL1' )
+		node3 = started_node()
+		node3.join( 'CHANNEL1' )
+		node4 = started_node()
+		node4.join( 'CHANNEL2' )
+
+		2.times do
+			node1.wait_for( :JOIN, group: 'CHANNEL1' )
+		end
+
+		expect( node1.peers_by_group('CHANNEL1') ).
+			to contain_exactly( node2.uuid, node3.uuid )
+	end
+
+
+	it "has a blocking iterator" do
+		node = described_class.new
+
+		expect( node.each_event ).to be_an( Enumerator )
+	end
+
+
+	it "yields events from its iterator" do
+		node1 = started_node()
+		node1.join( 'CHANNEL1' )
+
+		node2 = started_node()
+		node2.join( 'CHANNEL1' )
+		node2.shout( 'CHANNEL1', "A broadcast message" )
+
+		node2.wait_for( :ENTER )
+
+		events = node1.each_event.take( 2 )
+		expect( events ).to all( be_a Zyre::Event )
+	end
+
+
+	it "can wait for a specified event type" do
+		node1 = started_node()
+		node1.join( 'wait-test' )
+
+		node2 = started_node()
+		node2.join( 'wait-test' )
+
+		node1.wait_for( :JOIN )
+
+		node2.shout( 'wait-test', "A broadcast message" )
+
+		result = node1.wait_for( :SHOUT )
+
+		expect( result ).to be_a( Zyre::Event::Shout ).
+			and( have_attributes(message: 'A broadcast message') )
+	end
+
+
+	it "can wait for a specified event to arrive within a time limit" do
+		node1 = started_node()
+		node1.join( 'wait-timeout-test' )
+
+		wait( 3 ).for {
+			node1.wait_for( :JOIN, timeout: 2 )
+		}.to be_nil
+
+		node2 = started_node()
+		node2.join( 'wait-timeout-test' )
+
+		wait( 3 ).for {
+			node1.wait_for( :JOIN, timeout: 2 )
+		}.to be_a( Zyre::Event::Join ).and( have_attributes(peer_uuid: node2.uuid) )
+	end
+
+
+	it "can wait for a specified event with specific attributes" do
+		node1 = started_node()
+		node1.join( 'wait-test' )
+
+		node2 = started_node()
+		node2.join( 'wait-test' )
+
+		node1.wait_for( :JOIN, peer_uuid: node2.uuid )
+
+		node2.shout( 'wait-test', "A broadcast message" )
+		node2.shout( 'wait-test', "Another broadcast message" )
+
+		skipped_events = []
+		result = node1.wait_for( :SHOUT, message: "Another broadcast message" ) do |event|
+			skipped_events << event
+		end
+
+		expect( result ).to be_a( Zyre::Event::Shout ).
+			and( have_attributes(message: 'Another broadcast message') )
+		expect( skipped_events.size ).to eq( 1 )
+		expect( skipped_events.first ).to be_a( Zyre::Event::Shout ).
+			and( have_attributes(message: "A broadcast message") )
+	end
+
+
+	it "can wait for a specified event with specific attributes to arrive within a time limit" do
+		node1 = started_node()
+		node1.join( 'wait-test' )
+
+		node2 = started_node()
+		node2.join( 'wait-test' )
+
+		node1.wait_for( :JOIN, timeout: 0.5, peer_uuid: node2.uuid )
+
+		node2.shout( 'wait-test', "A broadcast message" )
+
+		skipped_events = []
+		result = node1.wait_for( :SHOUT, timeout: 0.5, message: "Another broadcast message" ) do |event|
+			skipped_events << event
+		end
+
+		expect( result ).to be_nil
+		expect( skipped_events.size ).to eq( 1 )
+		expect( skipped_events.first ).to be_a( Zyre::Event::Shout ).
+			and( have_attributes(message: "A broadcast message") )
+
+		node2.shout( 'wait-test', "Another broadcast message" )
+
+		skipped_events.clear
+		result = node1.wait_for( :SHOUT, timeout: 0.5, message: "Another broadcast message" ) do |event|
+			skipped_events << event
+		end
+
+		expect( result ).to be_a( Zyre::Event::Shout ).
+			and( have_attributes(message: 'Another broadcast message') )
+		expect( skipped_events ).to be_empty
+	end
+
+
+end
+

data/spec/zyre/poller_spec.rb

@@ -0,0 +1,44 @@
+#!/usr/bin/env rspec -cfd
+
+require_relative '../spec_helper'
+
+require 'zyre/poller'
+
+
+RSpec.describe Zyre::Poller do
+
+	it "can be constructed with no nodes" do
+		instance = described_class.new
+
+		expect( instance ).to be_a( described_class )
+		expect( instance.nodes ).to be_empty
+	end
+
+
+	it "can be constructed with the nodes to wait on" do
+		n1 = Zyre::Node.new
+		n2 = Zyre::Node.new
+
+		instance = described_class.new( n1, n2 )
+
+		expect( instance ).to be_a( described_class )
+		expect( instance.nodes ).to eq({
+			n1.endpoint => n1,
+			n2.endpoint => n2
+		})
+	end
+
+
+	it "returns nil if no input arrives before the timeout" do
+		n1 = Zyre::Node.new
+		n2 = Zyre::Node.new
+
+		instance = described_class.new( n1, n2 )
+
+		rval = instance.wait( 0.25 )
+
+		expect( rval ).to be_nil
+	end
+
+end
+

data/spec/zyre/testing_spec.rb

@@ -0,0 +1,260 @@
+#!/usr/bin/env rspec -cfd
+
+require_relative '../spec_helper'
+
+require 'securerandom'
+require 'zyre/testing'
+
+
+RSpec.describe( Zyre::Testing ) do
+
+
+	UUID_PATTERN = /^(\h{32}|\h{8}-\h{4}-\h{4}-\h{4}-\h{12})$/
+
+	ZEROMQ_EPHEMERAL_ADDR = %r|^tcp://\d+(\.\d+){3}:\d+|
+
+
+	describe "EventFactory" do
+
+		let( :described_class ) { Zyre::Testing::EventFactory }
+
+		let( :factory ) do
+			instance = described_class.new( peer_name: 'lancer-6' )
+			instance.headers = { protocol_version: 2, content_type: 'application/messagepack' }
+			instance.peer_addr = 'tcp://10.4.11.18:18559'
+
+			return instance
+		end
+
+
+		it "can be created with reasonable defaults" do
+			factory = described_class.new
+
+			expect( factory ).to be_a( described_class )
+			expect( factory.peer_addr ).to match( ZEROMQ_EPHEMERAL_ADDR )
+			expect( factory.msg ).to eq( described_class.default_config[:msg] )
+
+			expect( factory.peer_uuid ).to match( UUID_PATTERN )
+			expect( factory.peer_name ).to match( 'S-' + factory.peer_uuid[0, 6] )
+
+			expect( factory.headers ).to eq( described_class.default_headers )
+		end
+
+
+		it "can be created with overridden config values" do
+			factory = described_class.new( peer_name: 'lancer-6' )
+
+			expect( factory.peer_name ).to eq( 'lancer-6' )
+			expect( factory.peer_addr ).to match( // )
+			expect( factory.msg ).to eq( described_class.default_config[:msg] )
+
+			expect( factory.headers ).to eq( described_class.default_headers )
+		end
+
+
+		it "can create a valid ENTER event" do
+			event = factory.enter
+
+			expect( event ).to be_a( Zyre::Event::Enter )
+			expect( event.peer_uuid ).to eq( factory.peer_uuid )
+			expect( event.peer_name ).to eq( 'lancer-6' )
+			expect( event.headers ).to eq({
+				'Protocol-version' => '2',
+				'Content-type' => 'application/messagepack'
+			})
+			expect( event.msg ).to be_nil
+			expect( event.group ).to be_nil
+		end
+
+
+		it "can create a valid ENTER event with overridden config" do
+			overridden_headers = factory.headers.merge( protocol_version: 3 )
+			event = factory.enter( peer_name: 'lancer-6a', headers: overridden_headers )
+
+			expect( event ).to be_a( Zyre::Event::Enter )
+			expect( event.peer_uuid ).to eq( factory.peer_uuid )
+			expect( event.peer_name ).to eq( 'lancer-6a' )
+			expect( event.headers ).to eq({
+				'Protocol-version' => '3',
+				'Content-type' => 'application/messagepack'
+			})
+			expect( event.msg ).to be_nil
+			expect( event.group ).to be_nil
+		end
+
+
+		it "can create a valid JOIN event" do
+			event = factory.join
+
+			expect( event ).to be_a( Zyre::Event::Join )
+			expect( event.peer_uuid ).to eq( factory.peer_uuid )
+			expect( event.peer_name ).to eq( 'lancer-6' )
+			expect( event.headers ).to be_empty
+			expect( event.msg ).to be_nil
+			expect( event.group ).to eq( 'default' )
+		end
+
+
+		it "can create a valid JOIN event with overridden config" do
+			event = factory.join( group: 'control' )
+
+			expect( event ).to be_a( Zyre::Event::Join )
+			expect( event.peer_uuid ).to eq( factory.peer_uuid )
+			expect( event.peer_name ).to eq( 'lancer-6' )
+			expect( event.headers ).to be_empty
+			expect( event.msg ).to be_nil
+			expect( event.group ).to eq( 'control' )
+		end
+
+
+		it "can create a valid EVASIVE event" do
+			event = factory.evasive
+
+			expect( event ).to be_a( Zyre::Event::Evasive )
+			expect( event.peer_uuid ).to eq( factory.peer_uuid )
+			expect( event.peer_name ).to eq( 'lancer-6' )
+			expect( event.headers ).to be_empty
+			expect( event.msg ).to be_nil
+			expect( event.group ).to be_nil
+		end
+
+
+		it "can create a valid EVASIVE event with overridden config" do
+			uuid = SecureRandom.uuid.tr( '-', '' )
+			event = factory.evasive( peer_uuid: uuid )
+
+			expect( event ).to be_a( Zyre::Event::Evasive )
+			expect( event.peer_uuid ).to eq( uuid )
+			expect( event.peer_name ).to eq( 'lancer-6' )
+			expect( event.headers ).to be_empty
+			expect( event.msg ).to be_nil
+			expect( event.group ).to be_nil
+		end
+
+
+		it "can create a valid SILENT event" do
+			event = factory.silent
+
+			expect( event ).to be_a( Zyre::Event::Silent )
+			expect( event.peer_uuid ).to eq( factory.peer_uuid )
+			expect( event.peer_name ).to eq( 'lancer-6' )
+			expect( event.headers ).to be_empty
+			expect( event.msg ).to be_nil
+			expect( event.group ).to be_nil
+		end
+
+
+		it "can create a valid SILENT event with overridden config" do
+			uuid = SecureRandom.uuid.tr( '-', '' )
+			event = factory.silent( peer_uuid: uuid )
+
+			expect( event ).to be_a( Zyre::Event::Silent )
+			expect( event.peer_uuid ).to eq( uuid )
+			expect( event.peer_name ).to eq( 'lancer-6' )
+			expect( event.headers ).to be_empty
+			expect( event.msg ).to be_nil
+			expect( event.group ).to be_nil
+		end
+
+
+		it "can create a valid SHOUT event" do
+			event = factory.shout
+
+			expect( event ).to be_a( Zyre::Event::Shout )
+			expect( event.peer_uuid ).to eq( factory.peer_uuid )
+			expect( event.peer_name ).to eq( 'lancer-6' )
+			expect( event.headers ).to be_empty
+			expect( event.msg ).to eq( 'A message.' )
+			expect( event.group ).to eq( 'default' )
+		end
+
+
+		it "can create a valid SHOUT event with overridden config" do
+			event = factory.shout( group: 'control', msg: 'stop' )
+
+			expect( event ).to be_a( Zyre::Event::Shout )
+			expect( event.peer_uuid ).to eq( factory.peer_uuid )
+			expect( event.peer_name ).to eq( 'lancer-6' )
+			expect( event.headers ).to be_empty
+			expect( event.msg ).to eq( 'stop' )
+			expect( event.group ).to eq( 'control' )
+		end
+
+
+		it "can create a valid WHISPER event" do
+			event = factory.whisper
+
+			expect( event ).to be_a( Zyre::Event::Whisper )
+			expect( event.peer_uuid ).to eq( factory.peer_uuid )
+			expect( event.peer_name ).to eq( 'lancer-6' )
+			expect( event.headers ).to be_empty
+			expect( event.msg ).to eq( 'A message.' )
+			expect( event.group ).to be_nil
+		end
+
+
+		it "can create a valid WHISPER event with overridden config" do
+			uuid = SecureRandom.uuid.tr( '-', '' )
+			event = factory.whisper( peer_uuid: uuid, msg: 'stop' )
+
+			expect( event ).to be_a( Zyre::Event::Whisper )
+			expect( event.peer_uuid ).to eq( uuid )
+			expect( event.peer_name ).to eq( 'lancer-6' )
+			expect( event.headers ).to be_empty
+			expect( event.msg ).to eq( 'stop' )
+			expect( event.group ).to be_nil
+		end
+
+
+		it "can create a valid LEAVE event" do
+			event = factory.leave
+
+			expect( event ).to be_a( Zyre::Event::Leave )
+			expect( event.peer_uuid ).to eq( factory.peer_uuid )
+			expect( event.peer_name ).to eq( 'lancer-6' )
+			expect( event.headers ).to be_empty
+			expect( event.msg ).to be_nil
+			expect( event.group ).to eq( 'default' )
+		end
+
+
+		it "can create a valid LEAVE event with overridden config" do
+			event = factory.leave( group: 'control' )
+
+			expect( event ).to be_a( Zyre::Event::Leave )
+			expect( event.peer_uuid ).to eq( factory.peer_uuid )
+			expect( event.peer_name ).to eq( 'lancer-6' )
+			expect( event.headers ).to be_empty
+			expect( event.msg ).to be_nil
+			expect( event.group ).to eq( 'control' )
+		end
+
+
+		it "can create a valid EXIT event" do
+			event = factory.exit
+
+			expect( event ).to be_a( Zyre::Event::Exit )
+			expect( event.peer_uuid ).to eq( factory.peer_uuid )
+			expect( event.peer_name ).to eq( 'lancer-6' )
+			expect( event.headers ).to be_empty
+			expect( event.msg ).to be_nil
+			expect( event.group ).to be_nil
+		end
+
+
+		it "can create a valid EXIT event with overridden config" do
+			event = factory.exit( peer_name: 'lancer-2' )
+
+			expect( event ).to be_a( Zyre::Event::Exit )
+			expect( event.peer_uuid ).to eq( factory.peer_uuid )
+			expect( event.peer_name ).to eq( 'lancer-2' )
+			expect( event.headers ).to be_empty
+			expect( event.msg ).to be_nil
+			expect( event.group ).to be_nil
+		end
+
+	end
+
+
+end
+