arborist 0.0.1.pre20160829140603 → 0.0.1.pre20161005112841

data/lib/arborist/manager/tree_api.rb

@@ -19,7 +19,6 @@ class Arborist::Manager::TreeAPI < ZMQ::Handler
 	### Create the TreeAPI handler that will read requests from the specified +pollable+
 	### and call into the +manager+ to respond to them.
 	def initialize( pollable, manager )
-		self.log.debug "Setting up a %p" % [ self.class ]
 		@pollitem = pollable
 		@enabled  = true
 		@manager  = manager
@@ -41,8 +40,6 @@ class Arborist::Manager::TreeAPI < ZMQ::Handler
 
 	### Handle the specified +raw_request+ and return a response.
 	def handle_request( raw_request )
-		self.log.debug "Handling request: %p" % [ raw_request ]
-
 		raise "Manager is shutting down" unless self.enabled?
 
 		header, body = self.parse_request( raw_request )
@@ -68,13 +65,11 @@ class Arborist::Manager::TreeAPI < ZMQ::Handler
 	### Attempt to dispatch a request given its +header+ and +body+, and return the
 	### serialized response.
 	def dispatch_request( header, body )
-		self.log.debug "Dispatching request %p -> %p" % [ header, body ]
 		handler = self.lookup_request_action( header ) or
 			raise Arborist::RequestError, "No such action '%s'" % [ header['action'] ]
 
 		response = handler.call( header, body )
 
-		self.log.debug "Returning response: %p" % [ response ]
 		return response
 	end
 
@@ -96,7 +91,6 @@ class Arborist::Manager::TreeAPI < ZMQ::Handler
 		msg = [
 			{ category: category, reason: reason, success: false, version: 1 }
 		]
-		self.log.debug "Returning error response: %p" % [ msg ]
 		return MessagePack.pack( msg )
 	end
 
@@ -107,7 +101,6 @@ class Arborist::Manager::TreeAPI < ZMQ::Handler
 			{ success: true, version: 1 },
 			body
 		]
-		self.log.debug "Returning successful response: %p" % [ msg ]
 		return MessagePack.pack( msg )
 	end
 
@@ -120,8 +113,6 @@ class Arborist::Manager::TreeAPI < ZMQ::Handler
 			raise Arborist::RequestError, err.message
 		end
 
-		self.log.debug "Parsed request: %p" % [ tuple ]
-
 		raise Arborist::RequestError, 'not a tuple' unless tuple.is_a?( Array )
 		raise Arborist::RequestError, 'incorrect length' if tuple.length.zero? || tuple.length > 2
 
@@ -158,7 +149,13 @@ class Arborist::Manager::TreeAPI < ZMQ::Handler
 		self.log.debug "SUBSCRIBE: %p" % [ header ]
 		event_type      = header[ 'event_type' ]
 		node_identifier = header[ 'identifier' ]
-		subscription    = @manager.create_subscription( node_identifier, event_type, body )
+
+		body = [ body ] unless body.is_a?( Array )
+		positive = body.shift
+		negative = body.shift || {}
+
+		subscription = @manager.
+			create_subscription( node_identifier, event_type, positive, negative )
 
 		return successful_response([ subscription.id ])
 	end
@@ -225,6 +222,10 @@ class Arborist::Manager::TreeAPI < ZMQ::Handler
 	def handle_update_request( header, body )
 		self.log.debug "UPDATE: %p" % [ header ]
 
+		unless body.respond_to?( :each )
+			return error_response( 'client', 'Malformed update: body does not respond to #each' )
+		end
+
 		body.each do |identifier, properties|
 			@manager.update_node( identifier, properties )
 		end

data/lib/arborist/monitor.rb

@@ -301,14 +301,14 @@ class Arborist::Monitor
 	### Specify that the monitor should include the specified +criteria+ when searching
 	### for nodes it will run against.
 	def match( criteria )
-		@positive_criteria.merge!( criteria )
+		self.positive_criteria.merge!( criteria )
 	end
 
 
 	### Specify that the monitor should exclude nodes which match the specified
 	### +criteria+ when searching for nodes it will run against.
 	def exclude( criteria )
-		@negative_criteria.merge!( criteria )
+		self.negative_criteria.merge!( criteria )
 	end
 
 

data/lib/arborist/monitor/socket.rb

@@ -1,6 +1,7 @@
 # -*- ruby -*-
 #encoding: utf-8
 
+require 'time'
 require 'loggability'
 require 'timeout'
 require 'socket'
@@ -118,10 +119,9 @@ module Arborist::Monitor::Socket
 			# Now wait for connections to complete
 			wait_seconds = timeout_at - Time.now
 			until connections.empty? || wait_seconds <= 0
-				self.log.debug "Waiting on %d connections for %0.3ds..." %
+				self.log.debug "Waiting on %d connections for %0.3fs..." %
 					[ connections.values.length, wait_seconds ]
 
-				# :FIXME: Race condition: errors if timeout_at - Time.now is 0
 				_, ready, _ = IO.select( nil, connections.keys, nil, wait_seconds )
 
 				now = Time.now
@@ -129,14 +129,18 @@ module Arborist::Monitor::Socket
 					identifier, sockaddr = *connections.delete( sock )
 
 					begin
-						sock.connect_nonblock( sockaddr )
-					rescue Errno::EISCONN
+						res = sock.getpeername
+						self.log.debug "connected to %s" % [ identifier ]
 						results[ identifier ] = {
-							tcp_socket_connect: { time: now.to_s, duration: now - start }
+							tcp_socket_connect: { time: now.iso8601, duration: now - start }
 						}
 					rescue SocketError, SystemCallError => err
-						self.log.debug "%p during connection: %s" % [ err.class, err.message ]
-						results[ identifier ] = { error: err.message }
+						begin
+							sock.read( 1 )
+						rescue => err
+							self.log.debug "read: %p: %s" % [ err.class, err.message ]
+							results[ identifier ] = { error: err.message }
+						end
 					ensure
 						sock.close
 					end
@@ -257,7 +261,7 @@ module Arborist::Monitor::Socket
 					if ready.nil?
 						now = Time.now
 						results[ identifier ] = {
-							udp_socket_connect: { time: now.to_s, duration: now - start }
+							udp_socket_connect: { time: now.iso8601, duration: now - start }
 						}
 						self.log.debug "  connection successful"
 					else

data/lib/arborist/node.rb

@@ -33,6 +33,21 @@ class Arborist::Node
 	# Regex to match a valid identifier
 	VALID_IDENTIFIER = /^\w[\w\-]*$/
 
+	# The attributes of a node which are used in the operation of the system
+	OPERATIONAL_ATTRIBUTES = %i[
+		type
+		status
+		tags
+		parent
+		description
+		dependencies
+		status_changed
+		last_contacted
+		ack
+		error
+		quieted_reasons
+		config
+	]
 
 	autoload :Root, 'arborist/node/root'
 	autoload :Ack, 'arborist/node/ack'
@@ -98,15 +113,14 @@ class Arborist::Node
 			:quieted
 
 		event :update do
+			transition [:up, :unknown] => :disabled, if: :ack_set?
 			transition [:down, :unknown, :acked] => :up, if: :last_contact_successful?
 			transition [:up, :unknown] => :down, unless: :last_contact_successful?
 			transition :down => :acked, if: :ack_set?
-			transition [:unknown, :up] => :disabled, if: :ack_set?
 			transition :disabled => :unknown, unless: :ack_set?
 		end
 
 		event :handle_event do
-			transition :unknown => :acked, if: :ack_and_error_set?
 			transition any - [:disabled, :quieted, :acked] => :quieted, if: :has_quieted_reason?
 			transition :quieted => :unknown, unless: :has_quieted_reason?
 		end
@@ -541,7 +555,15 @@ class Arborist::Node
 
 
 	### Returns +true+ if the specified search +criteria+ all match this node.
-	def matches?( criteria )
+	def matches?( criteria, if_empty: true )
+
+		# Omit 'delta' criteria from matches; delta matching is done separately.
+		criteria = criteria.dup
+		criteria.delete( 'delta' )
+
+		self.log.debug "Node matching %p (%p if empty)" % [ criteria, if_empty ]
+		return if_empty if criteria.empty?
+
 		self.log.debug "Matching %p against criteria: %p" % [ self, criteria ]
 		return criteria.all? do |key, val|
 			self.match_criteria?( key, val )
@@ -552,8 +574,6 @@ class Arborist::Node
 	### Returns +true+ if the node matches the specified +key+ and +val+ criteria.
 	def match_criteria?( key, val )
 		return case key
-			when 'delta'
-				true
 			when 'status'
 				self.status == val
 			when 'type'
@@ -574,6 +594,7 @@ class Arborist::Node
 	def fetch_values( value_spec=nil )
 		state = self.properties.merge( self.operational_values )
 		state = stringify_keys( state )
+		state = make_serializable( state )
 
 		if value_spec
 			self.log.debug "Eliminating all values except: %p (from keys: %p)" %
@@ -588,12 +609,9 @@ class Arborist::Node
 	### Return a Hash of the operational values that are included with the node's
 	### monitor state.
 	def operational_values
-		values = {
-			type: self.type,
-			status: self.status,
-			tags: self.tags
-		}
-		values[:ack] = self.ack.to_h if self.ack
+		values = OPERATIONAL_ATTRIBUTES.each_with_object( {} ) do |key, hash|
+			hash[ key ] = self.send( key )
+		end
 
 		return values
 	end
@@ -644,11 +662,19 @@ class Arborist::Node
 	def handle_event( event )
 		self.log.debug "Handling %p" % [ event ]
 		handler_name = "handle_%s_event" % [ event.type.gsub('.', '_') ]
+
 		if self.respond_to?( handler_name )
 			self.log.debug "Handling a %s event." % [ event.type ]
 			self.method( handler_name ).call( event )
+		else
+			self.log.debug "No handler for a %s event!" % [ event.type ]
 		end
+
 		super # to state-machine
+
+		self.publish_events( event, *self.pending_update_events )
+	ensure
+		self.pending_update_events.clear
 	end
 
 
@@ -688,6 +714,21 @@ class Arborist::Node
 	end
 
 
+	def handle_node_disabled_event( event )
+		self.log.debug "Got a node.disabled event: %p" % [ event ]
+		self.dependencies.mark_down( event.node.identifier )
+
+		if self.dependencies_down?
+			self.quieted_reasons[ :secondary ] = "Secondary dependencies not met: %s" %
+				[ self.dependencies.down_reason ]
+		end
+
+		if event.node.identifier == self.parent
+			self.quieted_reasons[ :primary ] = "Parent disabled: %s" % [ self.parent ]
+		end
+	end
+
+
 	### Handle a 'node.quieted' event received via broadcast.
 	def handle_node_quieted_event( event )
 		self.log.debug "Got a node.quieted event: %p" % [ event ]
@@ -947,12 +988,6 @@ class Arborist::Node
 	end
 
 
-	### Returns +true+ if the node has been acked and also has an error set.
-	def ack_and_error_set?
-		return self.error && self.ack_set?
-	end
-
-
 	#
 	# :section: State Callbacks
 	#
@@ -1056,4 +1091,26 @@ class Arborist::Node
 	end
 
 
+	### Turn any non-msgpack-able objects in the values of a copy of +hash+ to
+	### values that can be serialized and return the copy.
+	def make_serializable( hash )
+		new_hash = hash.dup
+		new_hash.keys.each do |key|
+			val = new_hash[ key ]
+			case val
+			when Hash
+				new_hash[ key ] = make_serializable( val )
+
+			when Arborist::Dependency,
+			     Arborist::Node::Ack
+				 new_hash[ key ] = val.to_h
+
+			when Time
+				new_hash[ key ] = val.iso8601
+			end
+		end
+
+		return new_hash
+	end
+
 end # class Arborist::Node

data/lib/arborist/observer.rb

@@ -107,8 +107,8 @@ class Arborist::Observer
 	### on::
 	###   the identifier of the node to subscribe on, defaults to the root node
 	##    which receives all node events.
-	def subscribe( to: nil, where: {}, on: nil )
-		@subscriptions << { criteria: where, identifier: on, event_type: to }
+	def subscribe( to: nil, where: {}, exclude: {}, on: nil )
+		@subscriptions << { criteria: where, exclude: exclude, identifier: on, event_type: to }
 	end
 
 

data/lib/arborist/subscription.rb

@@ -20,11 +20,14 @@ class Arborist::Subscription
 
 	### Instantiate a new Subscription object given an +event+ pattern
 	### and event +criteria+.
-	def initialize( event_type=nil, criteria={}, &callback )
+	def initialize( event_type=nil, criteria={}, negative_criteria={}, &callback )
 		raise LocalJumpError, "requires a callback block" unless callback
+
 		@callback   = callback
 		@event_type = event_type
 		@criteria   = stringify_keys( criteria )
+		@negative_criteria = stringify_keys( negative_criteria )
+
 		@id         = self.generate_id
 	end
 
@@ -42,9 +45,19 @@ class Arborist::Subscription
 	# The Arborist event pattern that this subscription handles.
 	attr_reader :event_type
 
-	# Node selection attributes to match
+	# Node selection attributes to require
 	attr_reader :criteria
 
+	# Node selection attributes to exclude
+	attr_reader :negative_criteria
+
+
+	### Add the given +criteria+ hash to the #negative_criteria.
+	def exclude( criteria )
+		criteria = stringify_keys( criteria )
+		self.negative_criteria.merge!( criteria )
+	end
+
 
 	### Create an identifier for this subscription object.
 	def generate_id
@@ -65,21 +78,24 @@ class Arborist::Subscription
 
 	### Returns +true+ if the receiver is interested in publishing the specified +event+.
 	def interested_in?( event )
-		self.log.debug "Testing %p against type = %p and criteria = %p" %
-			[ event, self.event_type, self.criteria ]
-		return event.match( self )
+		self.log.debug "Testing %p against type = %p and criteria = %p but not %p" %
+			[ event, self.event_type, self.criteria, self.negative_criteria ]
+		rval = event.match( self )
+		self.log.debug "  event %s match." % [ rval ? "did" : "did NOT" ]
+		return rval
 	end
 	alias_method :is_interested_in?, :interested_in?
 
 
 	### Return a String representation of the object suitable for debugging.
 	def inspect
-		return "#<%p:%#x [%s] for %s events matching: %p -> %p>" % [
+		return "#<%p:%#x [%s] for %s events matching: %p %s-> %p>" % [
 			self.class,
 			self.object_id * 2,
 			self.id,
 			self.event_type,
 			self.criteria,
+			self.negative_criteria.empty? ? '' : "(but not #{self.negative_criteria.inspect}",
 			self.callback,
 		]
 	end

data/spec/arborist/dependency_spec.rb

@@ -321,7 +321,7 @@ describe Arborist::Dependency do
 
 		it "can describe the reason it's down" do
 			dep.mark_down( 'node2' )
-			expect( dep.down_reason ).to match( /node2 is down as of/i )
+			expect( dep.down_reason ).to match( /node2 is unavailable as of/i )
 		end
 
 
@@ -329,7 +329,7 @@ describe Arborist::Dependency do
 			dep.mark_down( 'node1' )
 			dep.mark_down( 'node2' )
 			# :FIXME: Does order matter in the 'all' case? This assumes no.
-			expect( dep.down_reason ).to match( /node(1|2) \(and 1 other\) are down as of/i )
+			expect( dep.down_reason ).to match( /node(1|2) \(and 1 other\) are unavailable as of/i )
 		end
 
 	end
@@ -364,7 +364,8 @@ describe Arborist::Dependency do
 			dep.mark_down( 'node2' )
 			dep.mark_down( 'node1' )
 
-			expect( dep.down_reason ).to match( /are all down as of/i ).and( include('node1', 'node2') )
+			expect( dep.down_reason ).to match( /are all unavailable as of/i ).
+				and( include('node1', 'node2') )
 		end
 
 	end

data/spec/arborist/event/node_delta_spec.rb

@@ -59,6 +59,14 @@ describe Arborist::Event::NodeDelta do
 		end
 
 
+		it "doesn't match a subscription with matching negative criteria" do
+			sub = Arborist::Subscription.new( 'node.delta', 'type' => node.type ) {}
+			sub.exclude( 'delta' => {status: ['up', 'down']} )
+			event = described_class.new( node, 'status' => ['up', 'down'] )
+
+			expect( event ).to_not match( sub )
+		end
+
 	end
 
 

data/spec/arborist/event/node_spec.rb

@@ -45,7 +45,6 @@ describe Arborist::Event::Node do
 
 
 	it "matches subscriptions which have non-matching negative criteria" do
-		pending "Adding negative criteria to subscriptions"
 		negative_criteria = {
 			tag: 'nope'
 		}

data/spec/arborist/manager/tree_api_spec.rb

@@ -393,17 +393,22 @@ describe Arborist::Manager::TreeAPI, :testing_manager do
 			expect( hdr ).to include( 'success' => true )
 		end
 
+		it "fails with a client error if the body is invalid" do
+			msg = pack_message( :update, nil )
+			sock.send( msg )
+			resmsg = sock.recv
+
+			hdr, body = unpack_message( resmsg )
+			expect( hdr ).to include( 'success' => false )
+			expect( hdr['reason'] ).to match( /respond to #each/ )
+		end
 	end
 
 
 	describe "subscribe" do
 
 		it "adds a subscription for all event types to the root node by default" do
-			criteria = {
-				type: 'host'
-			}
-
-			msg = pack_message( :subscribe, criteria )
+			msg = pack_message( :subscribe, [{}, {}] )
 
 			resmsg = nil
 			expect {
@@ -422,11 +427,7 @@ describe Arborist::Manager::TreeAPI, :testing_manager do
 
 
 		it "adds a subscription to the specified node if an identifier is specified" do
-			criteria = {
-				type: 'host'
-			}
-
-			msg = pack_message( :subscribe, {identifier: 'sidonie'}, criteria )
+			msg = pack_message( :subscribe, {identifier: 'sidonie'}, [{}, {}] )
 
 			resmsg = nil
 			expect {
@@ -444,12 +445,49 @@ describe Arborist::Manager::TreeAPI, :testing_manager do
 		end
 
 
-		it "adds a subscription for node types matching a pattern if one is specified" do
-			criteria = {
-				type: 'host'
-			}
+		it "adds a subscription for particular event types if one is specified" do
+			msg = pack_message( :subscribe, {event_type: 'node.acked'}, [{}, {}] )
+
+			resmsg = nil
+			expect {
+				sock.send( msg )
+				resmsg = sock.recv
+			}.to change { manager.subscriptions.length }.by( 1 ).and(
+				change { manager.root.subscriptions.length }.by( 1 )
+			)
+			hdr, body = unpack_message( resmsg )
+			node = manager.subscriptions[ body.first ]
+			sub = node.subscriptions[ body.first ]
+
+			expect( sub.event_type ).to eq( 'node.acked' )
+		end
+
+
+		it "adds a subscription for events which match a pattern if one is specified" do
+			criteria = { type: 'host' }
+
+			msg = pack_message( :subscribe, [criteria, {}] )
+
+			resmsg = nil
+			expect {
+				sock.send( msg )
+				resmsg = sock.recv
+			}.to change { manager.subscriptions.length }.by( 1 ).and(
+				change { manager.root.subscriptions.length }.by( 1 )
+			)
+			hdr, body = unpack_message( resmsg )
+			node = manager.subscriptions[ body.first ]
+			sub = node.subscriptions[ body.first ]
+
+			expect( sub.event_type ).to be_nil
+			expect( sub.criteria ).to eq({ 'type' => 'host' })
+		end
+
+
+		it "adds a subscription for events which don't match a pattern if an exclusion pattern is given" do
+			criteria = { type: 'host' }
 
-			msg = pack_message( :subscribe, {event_type: 'node.ack'}, criteria )
+			msg = pack_message( :subscribe, [{}, criteria] )
 
 			resmsg = nil
 			expect {
@@ -462,7 +500,8 @@ describe Arborist::Manager::TreeAPI, :testing_manager do
 			node = manager.subscriptions[ body.first ]
 			sub = node.subscriptions[ body.first ]
 
-			expect( sub.event_type ).to eq( 'node.ack' )
+			expect( sub.event_type ).to be_nil
+			expect( sub.negative_criteria ).to eq({ 'type' => 'host' })
 		end
 
 	end