arborist 0.0.1.pre20160606141735 → 0.0.1.pre20160829140603

data/lib/arborist/manager/event_publisher.rb

@@ -25,6 +25,7 @@ class Arborist::Manager::EventPublisher < ZMQ::Handler
 		@manager     = manager
 		@reactor     = reactor
 		@registered  = true
+		@enabled     = true
 		@event_queue = []
 	end
 
@@ -38,9 +39,18 @@ class Arborist::Manager::EventPublisher < ZMQ::Handler
 	# to write published events).
 	attr_predicate :registered
 
+	##
+	# The Queue of pending events to publish
+	attr_reader :event_queue
+
+	##
+	# A on/off toggle for publishing events
+	attr_predicate :enabled
+
 
 	### Publish the specified +event+.
 	def publish( identifier, event )
+		return self unless self.enabled?
 		@event_queue << [ identifier, MessagePack.pack(event.to_h) ]
 		self.register
 		return self
@@ -62,6 +72,24 @@ class Arborist::Manager::EventPublisher < ZMQ::Handler
 	end
 
 
+	### Stop accepting events to be published
+	def shutdown
+		@enabled = false
+		return if @event_queue.empty?
+
+		start   = Time.now
+		timeout = start + (@manager.linger.to_f / 2000)
+
+		self.log.warn "Waiting to empty the event queue..."
+		until @event_queue.empty?
+			sleep 0.1
+			break if Time.now > timeout
+		end
+		self.log.warn "  ... waited %0.1f seconds" % [ Time.now - start ]
+	end
+
+
+
 	#########
 	protected
 	#########
@@ -70,6 +98,7 @@ class Arborist::Manager::EventPublisher < ZMQ::Handler
 	def register
 		count ||= 0
 		@reactor.register( self.pollitem ) unless @registered
+		# self.log.info "Publisher socket is now registered!"
 		@registered = true
 	rescue => err
 		# :TODO:

data/lib/arborist/manager/tree_api.rb

@@ -8,7 +8,8 @@ require 'arborist/manager' unless defined?( Arborist::Manager )
 
 
 class Arborist::Manager::TreeAPI < ZMQ::Handler
-	extend Loggability
+	extend Loggability,
+	       Arborist::MethodUtilities
 
 
 	# Loggability API -- log to the arborist logger
@@ -20,10 +21,16 @@ class Arborist::Manager::TreeAPI < ZMQ::Handler
 	def initialize( pollable, manager )
 		self.log.debug "Setting up a %p" % [ self.class ]
 		@pollitem = pollable
+		@enabled  = true
 		@manager  = manager
 	end
 
 
+	##
+	# True if the Tree API is accepting commands
+	attr_predicate :enabled
+
+
 	### ZMQ::Handler API -- Read and handle an incoming request.
 	def on_readable
 		request = self.recv
@@ -36,6 +43,8 @@ class Arborist::Manager::TreeAPI < ZMQ::Handler
 	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 )
 		return self.dispatch_request( header, body )
 
@@ -282,5 +291,11 @@ class Arborist::Manager::TreeAPI < ZMQ::Handler
 		return successful_response( nil )
 	end
 
+
+	### Disable the API, returning errors for any future requests.
+	def shutdown
+		@enabled = false
+	end
+
 end # class Arborist::Manager::TreeAPI
 

data/lib/arborist/mixins.rb

@@ -1,6 +1,8 @@
 # -*- ruby -*-
 #encoding: utf-8
 
+require 'ipaddr'
+
 # A collection of generically-useful mixins
 module Arborist
 
@@ -280,7 +282,7 @@ module Arborist
 	end # module TimeRefinements
 
 
-	### A collection of utilities for working with Hashes.
+	# A collection of utilities for working with Hashes.
 	module HashUtilities
 
 		###############
@@ -377,4 +379,37 @@ module Arborist
 
 	end # HashUtilities
 
+
+	# A collection of utilities for working with network addresses, names, etc.
+	module NetworkUtilities
+
+		# A union of IPv4 and IPv6 regular expressions.
+		IPADDR_RE = Regexp.union(
+			IPAddr::RE_IPV4ADDRLIKE,
+			IPAddr::RE_IPV6ADDRLIKE_COMPRESSED,
+			IPAddr::RE_IPV6ADDRLIKE_FULL
+		)
+
+
+		### Return the specified +address+ as one or more IPAddr objects.
+		def normalize_address( address )
+			addresses = []
+			case address
+			when IPAddr
+				addresses << address
+			when IPADDR_RE
+				addresses << IPAddr.new( address )
+			when String
+				ip_addr = TCPSocket.gethostbyname( address )
+				addresses = ip_addr[3..-1].map{|ip| IPAddr.new(ip) }
+			else
+				raise "I don't know how to parse a %p host address (%p)" %
+					[ address.class, address ]
+			end
+
+			return addresses
+		end
+
+	end # module NetworkUtilities
+
 end # module Arborist

data/lib/arborist/monitor.rb

@@ -214,6 +214,18 @@ class Arborist::Monitor
 	attr_accessor :source
 
 
+	### Return a string representation of the object suitable for debugging.
+	def inspect
+		return "#<%p:%#x %s (every %ds ±%ds)>" % [
+			self.class,
+			self.object_id * 2,
+			self.description || "(no description)",
+			@interval,
+			@splay,
+		]
+	end
+
+
 	### Run the monitor
 	def run( nodes )
 		if self.exec_block

data/lib/arborist/monitor/socket.rb

@@ -116,26 +116,23 @@ module Arborist::Monitor::Socket
 			end
 
 			# Now wait for connections to complete
-			until connections.empty? || timeout_at.past?
+			wait_seconds = timeout_at - Time.now
+			until connections.empty? || wait_seconds <= 0
 				self.log.debug "Waiting on %d connections for %0.3ds..." %
-					[ connections.values.length, timeout_at - Time.now ]
+					[ connections.values.length, wait_seconds ]
 
 				# :FIXME: Race condition: errors if timeout_at - Time.now is 0
-				_, ready, _ = IO.select( nil, connections.keys, nil, timeout_at - Time.now )
+				_, ready, _ = IO.select( nil, connections.keys, nil, wait_seconds )
 
-				self.log.debug "  select returned: %p" % [ ready ]
+				now = Time.now
 				ready.each do |sock|
-					self.log.debug "  %p is ready" % [ sock ]
 					identifier, sockaddr = *connections.delete( sock )
-					self.log.debug "%p became writable: testing connection state" % [ sock ]
 
 					begin
-						self.log.debug "  trying another connection to %p" % [ sockaddr ]
 						sock.connect_nonblock( sockaddr )
 					rescue Errno::EISCONN
-						self.log.debug "  connection successful"
 						results[ identifier ] = {
-							tcp_socket_connect: { time: Time.now.to_s, duration: Time.now - start }
+							tcp_socket_connect: { time: now.to_s, duration: now - start }
 						}
 					rescue SocketError, SystemCallError => err
 						self.log.debug "%p during connection: %s" % [ err.class, err.message ]
@@ -143,8 +140,10 @@ module Arborist::Monitor::Socket
 					ensure
 						sock.close
 					end
+
 				end if ready
 
+				wait_seconds = timeout_at - Time.now
 			end
 
 			# Anything left is a timeout

data/lib/arborist/monitor_runner.rb

@@ -194,7 +194,7 @@ class Arborist::MonitorRunner
 	### Create a repeating ZMQ::Timer that will run the specified monitor on its interval.
 	def interval_timer_for( monitor )
 		interval = monitor.interval
-		self.log.info "Creating timer for %s monitor to run every %ds" % [ monitor, interval ]
+		self.log.info "Creating timer for %p" % [ monitor ]
 
 		return ZMQ::Timer.new( interval, 0 ) do
 			self.handler.run_monitor( monitor )
@@ -206,7 +206,7 @@ class Arborist::MonitorRunner
 	### +monitor+ after a random number of seconds no greater than its splay.
 	def splay_timer_for( monitor )
 		delay = rand( monitor.splay )
-		self.log.info "Splaying registration of %s monitor for %ds" % [ monitor, delay ]
+		self.log.debug "Splaying registration of %p for %ds" % [ monitor, delay ]
 
 		return ZMQ::Timer.new( delay, 1 ) do
 			interval_timer = self.interval_timer_for( monitor )

data/lib/arborist/node.rb

@@ -250,6 +250,7 @@ class Arborist::Node
 		@description     = nil
 		@tags            = Set.new
 		@properties      = {}
+		@config          = {}
 		@source          = nil
 		@children        = {}
 		@dependencies    = Arborist::Dependency.new( :all )
@@ -421,6 +422,13 @@ class Arborist::Node
 	end
 
 
+	### Get or set the node's configuration hash. This can be used to pass per-node
+	### information to systems using the tree (e.g., monitors, subscribers).
+	def config( new_config=nil )
+		@config = stringify_keys( new_config ) if new_config
+		return @config
+	end
+
 
 	#
 	# :section: Manager API
@@ -554,6 +562,8 @@ class Arborist::Node
 			when 'tag' then @tags.include?( val.to_s )
 			when 'tags' then Array(val).all? {|tag| @tags.include?(tag) }
 			when 'identifier' then @identifier == val
+			when 'config'
+				val.all? {|ikey, ival| hash_matches(@config, ikey, ival) }
 			else
 				hash_matches( @properties, key, val )
 			end
@@ -638,7 +648,7 @@ class Arborist::Node
 			self.log.debug "Handling a %s event." % [ event.type ]
 			self.method( handler_name ).call( event )
 		end
-		super
+		super # to state-machine
 	end
 
 
@@ -840,6 +850,7 @@ class Arborist::Node
 			parent: self.parent,
 			description: self.description,
 			tags: self.tags,
+			config: self.config,
 			status: self.status,
 			properties: self.properties.dup,
 			ack: self.ack ? self.ack.to_h : nil,
@@ -861,16 +872,19 @@ class Arborist::Node
 	### Marshal API -- set up the object's state using the +hash+ from a
 	### previously-marshalled node.
 	def marshal_load( hash )
+		self.log.debug "Restoring from serialized hash: %p" % [ hash ]
 		@identifier      = hash[:identifier]
 		@properties      = hash[:properties]
 
 		@parent          = hash[:parent]
 		@description     = hash[:description]
 		@tags            = Set.new( hash[:tags] )
+		@config          = hash[:config]
 		@children        = {}
 
-		@status          = 'unknown'
+		@status          = hash[:status]
 		@status_changed  = Time.parse( hash[:status_changed] )
+		@ack             = Arborist::Node::Ack.from_hash( hash[:ack] ) if hash[:ack]
 
 		@error           = hash[:error]
 		@properties      = hash[:properties] || {}
@@ -886,7 +900,6 @@ class Arborist::Node
 		@pending_update_events = []
 		@subscriptions         = {}
 
-		self.ack = hash[:ack]
 	end
 
 

data/lib/arborist/node/host.rb

@@ -2,21 +2,36 @@
 #encoding: utf-8
 
 require 'etc'
-require 'ipaddr'
 
 require 'arborist/node'
+require 'arborist/mixins'
 
 
 # A node type for Arborist trees that represent network-connected hosts.
+#
+#    host_node = Arborist::Node.create( :host, 'acme' ) do
+#        description "Public-facing webserver"
+#        address '93.184.216.34'
+#
+#        tags :public, :dmz
+#
+#        resource 'disk'
+#        resource 'memory' do
+#            config hwm: '3.4G'
+#        end
+#        resource 'loadavg'
+#        resource 'processes' do
+#            config expect: { nginx: 2 }
+#        end
+#
+#        service 'ssh'
+#        service 'www'
+#
+#    end
+#
+#
 class Arborist::Node::Host < Arborist::Node
-
-	# A union of IPv4 and IPv6 regular expressions.
-	IPADDR_RE = Regexp.union(
-		IPAddr::RE_IPV4ADDRLIKE,
-		IPAddr::RE_IPV6ADDRLIKE_COMPRESSED,
-		IPAddr::RE_IPV6ADDRLIKE_FULL
-	)
-
+	include Arborist::NetworkUtilities
 
 	### Create a new Host node.
 	def initialize( identifier, attributes={}, &block )
@@ -60,19 +75,7 @@ class Arborist::Node::Host < Arborist::Node
 	### Set an IP address of the host.
 	def address( new_address )
 		self.log.debug "Adding address %p to %p" % [ new_address, self ]
-		case new_address
-		when IPAddr
-			@addresses << new_address
-		when IPADDR_RE
-			@addresses << IPAddr.new( new_address )
-		when String
-			ip_addr = TCPSocket.gethostbyname( new_address )
-			@addresses << IPAddr.new( ip_addr[3] )
-			@addresses << IPAddr.new( ip_addr[4] ) if ip_addr[4]
-		else
-			raise "I don't know how to parse a %p host address (%p)" %
-				[ new_address.class, new_address ]
-		end
+		@addresses += normalize_address( new_address )
 	end
 
 

data/lib/arborist/node/resource.rb

@@ -19,20 +19,16 @@ class Arborist::Node::Resource < Arborist::Node
 
 		@host = host
 
+		attributes[ :category ] ||= identifier
 		super( qualified_identifier, host, attributes, &block )
 	end
 
 
-	### Returns +true+ if the node matches the specified +key+ and +val+ criteria.
-	def match_criteria?( key, val )
-		self.log.debug "Matching %p: %p against %p" % [ key, val, self ]
-		return case key
-			when 'address'
-				search_addr = IPAddr.new( val )
-				self.addresses.any? {|a| search_addr.include?(a) }
-			else
+	### Set service +attributes+.
+	def modify( attributes )
+		attributes = stringify_keys( attributes )
 				super
-			end
+		self.category( attributes['category'] )
 	end
 
 
@@ -45,6 +41,13 @@ class Arborist::Node::Resource < Arborist::Node
 	end
 
 
+	### Get/set the resource category.
+	def category( new_category=nil )
+		return @category unless new_category
+		@category = new_category
+	end
+
+
 	### Delegate the resources's address to its host.
 	def addresses
 		return @host.addresses
@@ -59,15 +62,26 @@ class Arborist::Node::Resource < Arborist::Node
 	end
 
 
-	#
-	# Serialization
-	#
-
-	### Return a Hash of the host node's state.
+	### Serialize the resource node.  Return a Hash of the host node's state.
 	def to_h
 		return super.merge(
 			addresses: self.addresses.map( &:to_s )
 		)
 	end
 
+
+	### Returns +true+ if the node matches the specified +key+ and +val+ criteria.
+	def match_criteria?( key, val )
+		self.log.debug "Matching %p: %p against %p" % [ key, val, self ]
+		return case key
+			when 'address'
+				search_addr = IPAddr.new( val )
+				self.addresses.any? {|a| search_addr.include?(a) }
+			when 'category'
+				self.category == val
+			else
+				super
+			end
+	end
+
 end # class Arborist::Node::Resource