arborist 0.0.1.pre20161005182540 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 1771e739c3bd2da57549f3319a7a745ab1f93633f2b5008e61419b7d47bf036e
-  data.tar.gz: ee38a2f6e1653aecbe9a685d416a5ed2840361e3f5e964aaa490b7a9d00ea589
+SHA1:
+  metadata.gz: cc3ce9e3d25176605f9895778c5654b57e8aa1c0
+  data.tar.gz: 4528bd2bcc17d925a9ea2ce63c475117839e98cd
 SHA512:
-  metadata.gz: 7d90ade9518414adf18f623412b673f1ef3e285438249fcde328701a2c8f48ae91866c5bccca176f3b26f91465aed74e078acb228c6a9c4374fdea56b237c86c
-  data.tar.gz: 247ed95856ccd2ae33d239d861bb99245018abe3bbab336532c0cba1431ca3bc34e5b19b62ec516ea60a50c2949f443a4e2ebc5e53b592764800796587ba38e4
+  metadata.gz: fd351f828f9d9dd9738541d93d852f82a7a12bcda91f1e4a7bda5bd38adedbf3da6fe52e7f729eab2f0d0678f71cd6b953ce449532e1b1cd9da14d18076a49c2
+  data.tar.gz: 3ac9921a9a8fc177ccba6036ab1fa00682cfc6ee892e7fde5aa3db34c5dc2832b32fd5a6e3f59518d8b4a9956b48a36ca39e10a83ff3b57dae895c845c5bf800

checksums.yaml.gz.sig

@@ -1,2 +1,3 @@
-a
����RA��v�y��mg�ݒ����GN�w�Dh
E��������Ӧ��i*u1���2y��y�T�
-a���W��:�luRZ�6y
+bZ_�Ov�97�~��2�+쳦�;鄀	��#��D5ma��5�PÀ\,�G(�	%A3��&���Z!�g��s�x4
+���ʩ�V�da�oMʡ8��K��:���40�R����t˝&�� 3��/c����"Y�*��w�����N�;Q��#�~xZ��jw��J#�<�_���C\�X������ܘ5)a�$:��gLd)T��&�z)k��T)}�V��Dv��^�&��S�T$(� 	��vE���Vn�M,]ST�x��i�OR�L���]�9qn������
+�=�x=�8@fv~���c�gim))���f�@����ހh!�5^���¼Hp�	�o 3ϸ�*�c���ꎛ]�c"�X��

data/ChangeLog

@@ -1,9 +1,75 @@
+2016-12-28  Michael Granger  <ged@FaerieMUD.org>
+
+	* .gems, Rakefile:
+	Update to latest *ability
+	[09438b7a8aff] [tip]
+
+2016-10-19  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/arborist/client.rb:
+	Use ** instead of * for client methods that take keyword args
+	[73b6f150a8c1] [github/master]
+
+	* lib/arborist/mixins.rb, lib/arborist/node.rb,
+	spec/arborist/client_spec.rb:
+	Add specs for Client#ack and #unack
+	[819556c743c6]
+
+2016-10-17  Michael Granger  <ged@FaerieMUD.org>
+
+	* TODO.md:
+	Add a note to the TODO list
+	[3de683ee0405]
+
+2016-10-12  Michael Granger  <ged@FaerieMUD.org>
+
+	* spec/arborist/node_spec.rb:
+	Remove accidentally-commited focus
+	[d2cac6a84aaa]
+
+2016-10-12  Mahlon E. Smith  <mahlon@martini.nu>
+
+	* lib/arborist/node.rb, spec/arborist/node_spec.rb:
+	Add matching for 'parent' attribute data.
+	[c50907900b60]
+
+2016-10-06  Mahlon E. Smith  <mahlon@martini.nu>
+
+	* lib/arborist/manager.rb, lib/arborist/monitor.rb,
+	lib/arborist/node.rb, spec/arborist/monitor_spec.rb,
+	spec/arborist/node_spec.rb:
+	Make monitors automatically set #include_down if matching on an
+	unreachable status type.
+
+	 - Add reachable? and unreachable? predacates to node
+	 - Whitespace fixes
+	[3dcff4c89426]
+
+2016-10-05  Mahlon E. Smith  <mahlon@martini.nu>
+
+	* lib/arborist/node.rb:
+	Reenable event publishing from handle_event().
+	[1918cc1afa1a]
+
+2016-10-05  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/arborist/node.rb, spec/arborist/node_spec.rb:
+	Fix event broadcasting for deep hierarchies.
+
+	- Refactored event broadcasting so #update and #handle_event share
+	broadcasting code.
+	[9ab8636bb2c5]
+
+	* Rakefile, arborist.gemspec:
+	Update gemspec with Ruby requirements
+	[8ea4314d4dc9]
+
 2016-10-04  Mahlon E. Smith  <mahlon@martini.nu>
 
 	* lib/arborist/node.rb:
 	State transition cleanup: Only nodes in a 'down' state can
 	transition to 'acked'.
-	[eed40468bb5e] [tip]
+	[eed40468bb5e]
 
 2016-10-03  Mahlon E. Smith  <mahlon@laika.com>
 
@@ -15,7 +81,7 @@
 
 	* TODO.md, lib/arborist/node.rb, spec/arborist/node_spec.rb:
 	Fix the unknown => disabled transition when updating with an ACK
-	[30d2548e1308] [github/master]
+	[30d2548e1308]
 
 	* lib/arborist/manager.rb, spec/arborist/manager_spec.rb:
 	Flatten the config into one namespace

data/History.md

@@ -1,4 +1,4 @@
-# v0.0.1 [YYYY-MM-DD] Michael Granger <ged@FaerieMUD.org>
+# v0.1.0 [2017-01-01] Michael Granger <ged@FaerieMUD.org>
 
 Initial release.
 

data/Monitors.md

@@ -7,7 +7,7 @@ of an Arborist::MonitorRunner object. The `Arborist::Monitor.each_in` method, gi
 
 ## Declaration DSL
 
-To facilitate describing monitors to run, Arborist::Monitor also provides a DSL-like syntax for constructing them. 
+To facilitate describing monitors to run, Arborist::Monitor also provides a DSL-like syntax for constructing them.
 
 For example, this would declare two monitors, one which pings every 'host' node except those tagged as laptops in the network every 20 seconds, and the other which pings 'host' nodes tagged as laptops every 5 minutes.
 
@@ -15,24 +15,38 @@ For example, this would declare two monitors, one which pings every 'host' node
     require 'arborist/monitor'
 
     Arborist::Monitor 'ping check' do
-    	every 20.seconds
-    	match type: 'host'
-    	exclude tag: :laptop
-    	use :address
-    	exec 'fping'
+        key :pingcheck
+        every 20.seconds
+        match type: 'host'
+        exclude tag: :laptop
+        use :address
+        exec 'fping'
     end
 
     Arborist::Monitor 'transient host pings' do
-    	every 5.minutes
-    	match type: 'host', tag: 'laptop'
+        key :pingcheck
+        every 5.minutes
+        match type: 'host', tag: 'laptop'
         use :address
-    	exec 'fping'
+        exec 'fping'
     end
 
 Each monitor is given a human-readable description for use in user interfaces, and one or more attributes that describe which nodes should be monitored, how they should be monitored, and how often the monitor should be run.
 
 ### Monitor Attributes
 
+#### key
+
+Declare a namespace for the monitor. The error status for a node is keyed by this value, so that monitors with different keys don't clear each other's errors.
+
+This attribute is mandatory.
+
+#### description
+
+Set a human-readable description for the monitor, for use in interfaces or logs.
+
+This attribute is mandatory.
+
 #### every( seconds )
 
 Declare the interval between runs of the monitor. The monitor will be skewed by a small amount from this value (unless you specify `splay 0`) to prevent many monitors from starting up simultaneously.
@@ -45,7 +59,7 @@ Manually set the amount of splay (random offset from the interval) the monitor s
 #### exec {|node_attributes| ... }
 #### exec( module )
 
-Specify what should be run to do the actual monitoring. The first form simply `spawn`s the specified command with its STDIN opened to a stream of serialized node data. 
+Specify what should be run to do the actual monitoring. The first form simply `spawn`s the specified command with its STDIN opened to a stream of serialized node data.
 
 By default, the format of the serialized nodes is one node per line, and each line looks like this:
 

data/Rakefile

@@ -16,7 +16,7 @@ Hoe.plugin :signing
 Hoe.plugin :deveiate
 
 Hoe.plugins.delete :rubyforge
-Hoe.plugins.delete :gemcutter
+
 
 hoespec = Hoe.spec 'arborist' do |spec|
 	spec.readme_file = 'README.md'
@@ -34,8 +34,8 @@ hoespec = Hoe.spec 'arborist' do |spec|
 	spec.developer 'Mahlon E. Smith', 'mahlon@martini.nu'
 
 	spec.dependency 'schedulability', '~> 0.1'
-	spec.dependency 'loggability', '~> 0.11'
-	spec.dependency 'configurability', '~> 2.2'
+	spec.dependency 'loggability', '~> 0.12'
+	spec.dependency 'configurability', '~> 3.0'
 	spec.dependency 'pluggability', '~> 0.4'
 	spec.dependency 'state_machines', '~> 0.2'
 	spec.dependency 'msgpack', '~> 0.6'

data/TODO.md

@@ -14,8 +14,6 @@
   - pop
   - smtp
 
-* Write a gem for `fping` monitor 
-
 * Redo the select loop of the UDP socket monitor to wait for them in parallel instead of in series.
 
 

data/lib/arborist.rb

@@ -14,10 +14,10 @@ module Arborist
 	       Configurability
 
 	# Package version
-	VERSION = '0.0.1'
+	VERSION = '0.1.0'
 
 	# Version control revision
-	REVISION = %q$Revision: 4cc9924e6b0c $
+	REVISION = %q$Revision: 02a11882f53b $
 
 
 	# The name of the environment variable which can be used to set the config path

data/lib/arborist/client.rb

@@ -92,8 +92,8 @@ class Arborist::Client
 
 
 	### Return the manager's current node tree.
-	def list( *args )
-		request = self.make_list_request( *args )
+	def list( **args )
+		request = self.make_list_request( **args )
 		return self.send_tree_api_request( request )
 	end
 
@@ -110,8 +110,8 @@ class Arborist::Client
 
 
 	### Return the manager's current node tree.
-	def fetch( criteria={}, *args )
-		request = self.make_fetch_request( criteria, *args )
+	def fetch( criteria={}, **args )
+		request = self.make_fetch_request( criteria, **args )
 		return self.send_tree_api_request( request )
 	end
 
@@ -141,8 +141,8 @@ class Arborist::Client
 
 
 	### Add a subscription
-	def subscribe( *args )
-		request = self.make_subscribe_request( *args )
+	def subscribe( **args )
+		request = self.make_subscribe_request( **args )
 		response = self.send_tree_api_request( request )
 		return response.first
 	end

data/lib/arborist/command/watch.rb

@@ -96,12 +96,12 @@ module Arborist::CLI::Watch
 
 		case event_type
 		when 'node.update'
-			type, status, error = event['data'].values_at( *%w'type status error' )
+			type, status, errors = event['data'].values_at( *%w'type status errors' )
 			return "%s updated: %s is %s%s" % [
 				hl( id ).color( :cyan ),
 				type,
 				hl( status ).color( status.to_sym ),
-				error ? " (#{error})" : ''
+				errors ? " (#{errors})" : ''
 			]
 		when 'node.delta'
 			pairs = diff_pairs( event['data'] )

data/lib/arborist/manager.rb

@@ -639,9 +639,7 @@ class Arborist::Manager
 	### Yield each node that is not down to the specified +block+, or return
 	### an Enumerator if no block is given.
 	def reachable_nodes( &block )
-		iter = self.enumerator_for( self.root ) do |node|
-			!(node.down? || node.disabled? || node.quieted?)
-		end
+		iter = self.enumerator_for( self.root ) {|node| node.reachable? }
 		return iter.each( &block ) if block
 		return iter
 	end

data/lib/arborist/mixins.rb

@@ -326,7 +326,7 @@ module Arborist
 		alias_method :internify_keys, :symbolify_keys
 
 
-		# Recursive hash-merge function
+		### Recursive hash-merge function
 		def merge_recursively( key, oldval, newval )
 			case oldval
 			when Hash
@@ -351,7 +351,7 @@ module Arborist
 		end
 
 
-		# Recursively remove hash pairs in place whose value is nil.
+		### Recursively remove hash pairs in place whose value is nil.
 		def compact_hash( hash )
 			hash.each_key do |k|
 				hash.delete( k ) if hash[ k ].nil?

data/lib/arborist/monitor.rb

@@ -35,8 +35,8 @@ class Arborist::Monitor
 	DEFAULT_SPLAY = 0
 
 
-	Arborist.add_dsl_constructor( self ) do |description, &block|
-		Arborist::Monitor.new( description, &block )
+	Arborist.add_dsl_constructor( self ) do |description=nil, key=nil, &block|
+		Arborist::Monitor.new( description, key, &block )
 	end
 
 
@@ -143,7 +143,8 @@ class Arborist::Monitor
 	### Create a new Monitor with the specified +description+. If the +block+ is
 	### given, it will be evaluated in the context of the new Monitor before it's
 	### returned.
-	def initialize( description, &block )
+	def initialize( description=nil, key=nil, &block )
+		@key = key
 		@description = description
 		@interval = DEFAULT_INTERVAL
 		@splay = DEFAULT_SPLAY
@@ -160,6 +161,8 @@ class Arborist::Monitor
 		@source = nil
 
 		self.instance_exec( &block ) if block
+
+		self.check_config
 	end
 
 
@@ -168,8 +171,13 @@ class Arborist::Monitor
 	######
 
 	##
-	# The object's description
-	attr_accessor :description
+	# The monitor's key. This key should be shared between monitors that check the
+	# same resources.
+	attr_writer :key
+
+	##
+	# The monitor's (human) description.
+	attr_writer :description
 
 	##
 	# The interval between runs in seconds, as set by `every`.
@@ -226,6 +234,26 @@ class Arborist::Monitor
 	end
 
 
+	### Check the monitor for sanity, raising an Arborist::ConfigError if it isn't.
+	def check_config
+		raise Arborist::ConfigError, "No description set" unless self.description
+		raise Arborist::ConfigError, "No key set" unless self.key
+	end
+
+
+	### Get/set the description of the monitor.
+	def description( new_value=nil )
+		self.description = new_value if new_value
+		return @description
+	end
+
+
+	### Get/set the key used by the monitor.
+	def key( new_value=nil )
+		self.key = new_value if new_value
+		return @key
+	end
+
 	### Run the monitor
 	def run( nodes )
 		if self.exec_block
@@ -252,10 +280,10 @@ class Arborist::Monitor
 		parent_err_reader, child_stderr = IO.pipe
 
 		self.log.debug "Spawning command: %s" % [ Shellwords.join(command) ]
-        pid = Process.spawn( *command, out: child_stdout, in: child_stdin, err: child_stderr )
+		pid = Process.spawn( *command, out: child_stdout, in: child_stdin, err: child_stderr )
 
-        child_stdout.close
-        child_stdin.close
+		child_stdout.close
+		child_stdin.close
 		child_stderr.close
 
 		context.exec_input( nodes, parent_writer )
@@ -302,6 +330,8 @@ class Arborist::Monitor
 	### for nodes it will run against.
 	def match( criteria )
 		self.positive_criteria.merge!( criteria )
+		@include_down = !self.include_down &&
+			Arborist::Node::UNREACHABLE_STATES.include?( self.positive_criteria[:status] )
 	end
 
 

data/lib/arborist/monitor_runner.rb

@@ -69,6 +69,12 @@ class Arborist::MonitorRunner
 
 			self.fetch( positive, include_down, props, negative ) do |nodes|
 				results = monitor.run( nodes )
+				monitor_key = monitor.key
+
+				results.each do |ident, properties|
+					properties['_monitor_key'] = monitor_key
+				end
+
 				self.update( results ) do
 					self.log.debug "Updated %d via the '%s' monitor" %
 						[ results.length, monitor.description ]

data/lib/arborist/node.rb

@@ -44,11 +44,19 @@ class Arborist::Node
 		status_changed
 		last_contacted
 		ack
-		error
+		errors
 		quieted_reasons
 		config
 	]
 
+	# Node states that are unreachable by default.
+	UNREACHABLE_STATES = %w[
+		down
+		disabled
+		quieted
+	]
+
+
 	autoload :Root, 'arborist/node/root'
 	autoload :Ack, 'arborist/node/ack'
 
@@ -114,8 +122,8 @@ class Arborist::Node
 
 		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, :unknown, :acked] => :up, unless: :has_errors?
+			transition [:up, :unknown, :acked] => :down, if: :has_errors?
 			transition :down => :acked, if: :ack_set?
 			transition :disabled => :unknown, unless: :ack_set?
 		end
@@ -274,7 +282,7 @@ class Arborist::Node
 		@status_changed  = Time.at( 0 )
 
 		# Attributes that govern state
-		@error           = nil
+		@errors          = {}
 		@ack             = nil
 		@last_contacted  = Time.at( 0 )
 		@quieted_reasons = {}
@@ -321,8 +329,9 @@ class Arborist::Node
 	attr_accessor :status_changed
 
 	##
-	# The last error encountered by a monitor attempting to update this node.
-	attr_accessor :error
+	# The Hash of last errors encountered by a monitor attempting to update this
+	# node, keyed by the monitor's `key`.
+	attr_accessor :errors
 
 	##
 	# The acknowledgement currently in effect. Should be an instance of Arborist::Node::ACK
@@ -478,13 +487,17 @@ class Arborist::Node
 	### Update specified +properties+ for the node.
 	def update( new_properties )
 		new_properties = stringify_keys( new_properties )
-		self.log.debug "Updated: %p" % [ new_properties ]
+		monitor_key = new_properties[ '_monitor_key' ] || '_'
 
+		self.log.debug "Updated via a %s monitor: %p" % [ monitor_key, new_properties ]
 		self.last_contacted = Time.now
+
 		if new_properties.key?( 'ack' )
 			self.ack = new_properties.delete( 'ack' )
+		elsif new_properties['error']
+			self.errors[ monitor_key ] = new_properties.delete( 'error' )
 		else
-			self.error = new_properties.delete( 'error' )
+			self.errors.delete( monitor_key )
 		end
 
 		self.properties.merge!( new_properties, &self.method(:merge_and_record_delta) )
@@ -587,6 +600,8 @@ class Arborist::Node
 			when 'type'
 				self.log.debug "Checking node type %p against %p" % [ self.type, val ]
 				self.type == val
+			when 'parent'
+				self.parent == val
 			when 'tag' then @tags.include?( val.to_s )
 			when 'tags' then Array(val).all? {|tag| @tags.include?(tag) }
 			when 'identifier' then @identifier == val
@@ -680,7 +695,8 @@ class Arborist::Node
 
 		super # to state-machine
 
-		return self.collect_events
+		self.publish_events( event, *self.pending_update_events )
+		self.collect_events
 	end
 
 
@@ -792,6 +808,20 @@ class Arborist::Node
 	end
 
 
+	### Returns +true+ if the node's status indicates it shouldn't be
+	### included by default when traversing nodes.
+	def unreachable?
+		return UNREACHABLE_STATES.include?( self.status )
+	end
+
+
+	### Returns +true+ if the node's status indicates it is included by
+	### default when traversing nodes.
+	def reachable?
+		return !self.unreachable?
+	end
+
+
 	### Register the specified +node+ as a child of this node, replacing any existing
 	### node with the same identifier.
 	def add_child( node )
@@ -880,7 +910,7 @@ class Arborist::Node
 		@ack             = old_node.ack.dup if old_node.ack
 		@last_contacted  = old_node.last_contacted
 		@status_changed  = old_node.status_changed
-		@error           = old_node.error
+		@errors          = old_node.errors
 		@quieted_reasons = old_node.quieted_reasons
 
 		# Only merge in downed dependencies.
@@ -904,7 +934,7 @@ class Arborist::Node
 			ack: self.ack ? self.ack.to_h : nil,
 			last_contacted: self.last_contacted ? self.last_contacted.iso8601 : nil,
 			status_changed: self.status_changed ? self.status_changed.iso8601 : nil,
-			error: self.error,
+			errors: self.errors,
 			dependencies: self.dependencies.to_h,
 			quieted_reasons: self.quieted_reasons,
 		}
@@ -934,7 +964,7 @@ class Arborist::Node
 		@status_changed  = Time.parse( hash[:status_changed] )
 		@ack             = Arborist::Node::Ack.from_hash( hash[:ack] ) if hash[:ack]
 
-		@error           = hash[:error]
+		@errors          = hash[:errors]
 		@properties      = hash[:properties] || {}
 		@last_contacted  = Time.parse( hash[:last_contacted] )
 		@quieted_reasons = hash[:quieted_reasons] || {}
@@ -988,13 +1018,23 @@ class Arborist::Node
 
 	### State machine guard predicate -- Returns +true+ if the last time the node
 	### was monitored resulted in an update.
-	def last_contact_successful?
-		self.log.debug "Checking to see if last contact was successful (it %s)" %
-			[ self.error ? "wasn't" : "was" ]
-		return !self.error
+	def has_errors?
+		has_errors = ! self.errors.empty?
+		self.log.debug "Checking to see if last contact cleared remaining errors (it %s)" %
+			[ has_errors ? "did not" : "did" ]
+		self.log.debug "Errors are: %p" % [ self.errors ]
+		return has_errors
 	end
 
 
+	### Return a string describing the errors that are set on the node.
+	def errors_description
+		return "No errors" if self.errors.empty?
+		return self.errors.map do |key, msg|
+			"%s: %s" % [ key, msg ]
+		end.join( '; ' )
+	end
+
 	#
 	# :section: State Callbacks
 	#
@@ -1035,7 +1075,7 @@ class Arborist::Node
 
 	### Callback for when a node goes from down to up
 	def on_node_up( transition )
-		self.error = nil
+		self.errors.clear
 		self.log.warn "%s is %s" % [ self.identifier, self.status_description ]
 	end
 
@@ -1043,7 +1083,7 @@ class Arborist::Node
 	### Callback for when a node goes from up to down
 	def on_node_down( transition )
 		self.log.error "%s is %s" % [ self.identifier, self.status_description ]
-		self.update_delta[ 'error' ] = [ nil, self.error ]
+		self.update_delta[ 'errors' ] = [ nil, self.errors_description ]
 	end