arborist 0.2.0.pre20170519125456 → 0.2.0

data/History.md

@@ -1,3 +1,70 @@
+## v0.2.0 [2018-08-08] Michael Granger <ged@FaerieMUD.org>
+
+Breaking:
+
+- Collapse startup event into the heartbeat event
+- Rename some actions in the Tree API for clarity
+  * Rename `list` to `fetch`
+  * Rename `fetch` to `search`
+- Don't let #add_node automatically replace nodes with the same
+  identifier, instead leaving the remove step to the caller.
+
+Enhancements:
+
+- Add acknowledgement changes to delta events.
+- Add batching to the socket monitor
+- Add a --path argument to the 'tree' command, that displays parents
+  to the root when specified.
+- Add a DSL method for returning a Client singleton.
+- Provide a way to disable colors for misbehaving terms.
+- Allow ack/unack on the root node to quiet and re-enable the tree.
+- Retain the previous time a node's status changed, for easy time
+  deltas between state transitions.
+- Add the node type as additional metadata to node events.
+- Add node parent to the default node event class, stick to symbols
+  for hash keys.
+- Allow "OR-ing" of statuses/identifiers/types when matching.
+- Make the default node search return all nodes
+  All nodes in the tree are returned by default now. You can omit
+  unreachable nodes with the `exclude_down` option/method.
+- Add a warning state to nodes
+- Add an optional 'hostname' label to the host node DSL.
+  This is a convenience matcher for selecting by host, since
+  identifiers are designed to be opaque, and description fields are
+  more human readable.
+- Add a configurable default splay for all instantiated Monitors.
+- Allow separate monitors to run in parallel.
+- Make ack friendlier for batch updates, prompt for missing values.
+- Add a 'summary' command, for quick display of existing problems.
+- Use the uid instead of gecos for default ack sender.
+- Add a "reset" command to the client.
+- Add wildcard matching to node events.
+- Add introspection on secondary dependencies to the Tree API
+- Add an `ack` command
+- Convert to CZTop for ZeroMQ
+- Add a block to Node.parent_type to allow for more-expressive
+  declarations
+- Normalize and emit better error messages from client commands.
+
+Bugfixes:
+
+- Fix behavior for child nodes whose parent transitions from 'down' to
+  'warn'.
+- Don't make loading config conditional, so loading config path from
+  ENV works as intended.
+- Propagate ack and unack events to parent nodes.
+- Keep the observer daemon running if observer action blocks raise
+  exceptions.
+- Throw a client error if attempting to graft over a pre-existing node.
+- Re-arrange constants to avoid Ruby 2.4 refinement warnings. Lower
+  debug output when loading nodes.
+- Fix the signature of Arborist::Client#fetch
+  It was defaulting trailing-hash arguments to options, which made the
+  typical case of fetching with only criteria awkward. This makes the
+  atypical case (fetching with options but empty criteria) the awkward
+  case instead.
+
+
 # v0.1.0 [2017-01-01] Michael Granger <ged@FaerieMUD.org>
 
 Initial release.

data/Manifest.txt

@@ -1,24 +1,22 @@
 .document
 .simplecov
 ChangeLog
-Events.md
 History.md
 Manifest.txt
-Monitors.md
-Nodes.md
-Observers.md
-Protocol.md
 README.md
 Rakefile
 TODO.md
-Tutorial.md
 bin/arborist
 lib/arborist.rb
 lib/arborist/cli.rb
 lib/arborist/client.rb
+lib/arborist/command/ack.rb
 lib/arborist/command/client.rb
 lib/arborist/command/config.rb
+lib/arborist/command/reset.rb
 lib/arborist/command/start.rb
+lib/arborist/command/summary.rb
+lib/arborist/command/tree.rb
 lib/arborist/command/watch.rb
 lib/arborist/dependency.rb
 lib/arborist/event.rb
@@ -31,6 +29,7 @@ lib/arborist/event/node_quieted.rb
 lib/arborist/event/node_unknown.rb
 lib/arborist/event/node_up.rb
 lib/arborist/event/node_update.rb
+lib/arborist/event/node_warn.rb
 lib/arborist/event_api.rb
 lib/arborist/exceptions.rb
 lib/arborist/loader.rb
@@ -38,6 +37,7 @@ lib/arborist/loader/file.rb
 lib/arborist/manager.rb
 lib/arborist/mixins.rb
 lib/arborist/monitor.rb
+lib/arborist/monitor/connection_batching.rb
 lib/arborist/monitor/socket.rb
 lib/arborist/monitor_runner.rb
 lib/arborist/node.rb
@@ -46,6 +46,7 @@ lib/arborist/node/host.rb
 lib/arborist/node/resource.rb
 lib/arborist/node/root.rb
 lib/arborist/node/service.rb
+lib/arborist/node_subscription.rb
 lib/arborist/observer.rb
 lib/arborist/observer/action.rb
 lib/arborist/observer/summarize.rb
@@ -71,6 +72,7 @@ spec/arborist/node/resource_spec.rb
 spec/arborist/node/root_spec.rb
 spec/arborist/node/service_spec.rb
 spec/arborist/node_spec.rb
+spec/arborist/node_subscription_spec.rb
 spec/arborist/observer/action_spec.rb
 spec/arborist/observer/summarize_spec.rb
 spec/arborist/observer_runner_spec.rb
@@ -85,6 +87,7 @@ spec/data/monitors/web_services.rb
 spec/data/nodes/localhost.rb
 spec/data/nodes/sidonie.rb
 spec/data/nodes/sub/duir.rb
+spec/data/nodes/vhosts.rb
 spec/data/nodes/yevaud.rb
 spec/data/observers/auditor.rb
 spec/data/observers/webservices.rb

data/README.md

@@ -19,8 +19,6 @@ Arborist is a monitoring toolkit that follows the UNIX philosophy
 of small parts and loose coupling for stability, reliability, and
 customizability.
 
-[![Build Status](https://semaphoreci.com/api/v1/projects/13677b60-5f81-4e6e-a9c6-e21d30daa4ca/461532/badge.svg)](https://semaphoreci.com/ged/arborist)
-
 
 ## Prerequisites
 
@@ -51,7 +49,7 @@ and generate the API documentation.
 
 ## License
 
-Copyright (c) 2015-2016, Michael Granger and Mahlon E. Smith
+Copyright (c) 2015-2018, Michael Granger and Mahlon E. Smith
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

data/Rakefile

@@ -1,5 +1,6 @@
 #!/usr/bin/env rake
 
+require 'pathname'
 require 'rake/clean'
 
 begin
@@ -10,6 +11,10 @@ end
 
 GEMSPEC = 'arborist.gemspec'
 
+BASEDIR = Pathname( __FILE__ ).dirname
+LIBDIR = BASEDIR + 'lib'
+NODE_STATE_GRAPH = BASEDIR + 'node-state-machine.dot'
+
 
 Hoe.plugin :mercurial
 Hoe.plugin :signing
@@ -37,17 +42,22 @@ hoespec = Hoe.spec 'arborist' do |spec|
 	spec.dependency 'loggability', '~> 0.12'
 	spec.dependency 'configurability', '~> 3.0'
 	spec.dependency 'pluggability', '~> 0.4'
-	spec.dependency 'state_machines', '~> 0.2'
+	spec.dependency 'state_machines', '~> 0.5'
 	spec.dependency 'msgpack', '~> 1.0'
 	spec.dependency 'cztop', '~> 0.11'
 	spec.dependency 'cztop-reactor', '~> 0.3'
 	spec.dependency 'gli', '~> 2.3'
-	spec.dependency 'highline', '~> 1.7'
+	spec.dependency 'tty', '~> 0.7'
+	spec.dependency 'tty-tree', '~> 0.1'
+	spec.dependency 'pry', '~> 0.11'
 
 	spec.dependency 'rspec', '~> 3.2', :developer
 	spec.dependency 'rspec-wait', '~> 0.0', :developer
 	spec.dependency 'simplecov', '~> 0.9', :developer
 	spec.dependency 'timecop', '~> 0.7', :developer
+	spec.dependency 'rdoc', '~> 5.1', :developer
+	spec.dependency 'rdoc', '~> 5.1', :developer
+	spec.dependency 'state_machines-graphviz', '~> 0.0', :developer
 
 	spec.require_ruby_version( '>=2.3.1' )
 	spec.hg_sign_tags = true if spec.respond_to?( :hg_sign_tags= )
@@ -86,14 +96,16 @@ if File.directory?( '.hg' )
 	end
 end
 
-task :gemspec => [ 'ChangeLog', __FILE__, GEMSPEC ]
+file 'Manifest.txt'
+
+task :gemspec => [ 'ChangeLog', __FILE__, 'Manifest.txt', GEMSPEC ]
 file GEMSPEC => __FILE__ do |task|
 	spec = $hoespec.spec
 	spec.files.delete( '.gemtest' )
 	spec.files.delete( 'LICENSE' )
 	spec.signing_key = nil
 	spec.version = "#{spec.version.bump}.0.pre#{Time.now.strftime("%Y%m%d%H%M%S")}"
-	spec.cert_chain = [ 'certs/ged.pem' ]
+	#spec.cert_chain = [ 'certs/ged.pem' ]
 	File.open( task.name, 'w' ) do |fh|
 		fh.write( spec.to_ruby )
 	end
@@ -102,3 +114,26 @@ CLOBBER.include( GEMSPEC )
 
 task :default => :gemspec
 
+
+file NODE_STATE_GRAPH
+
+desc "Generate a graph of the node status state machine."
+task NODE_STATE_GRAPH do |task|
+	$LOAD_PATH.unshift( LIBDIR.to_s )
+
+	require 'state_machines'
+	require 'state_machines/graphviz'
+	require 'arborist/node'
+
+	state_machine = Arborist::Node.state_machine
+	name = File.basename( NODE_STATE_GRAPH, '.dot' )
+	puts "Writing status state machine diagram to #{NODE_STATE_GRAPH}"
+	graph = state_machine.draw( path: BASEDIR.to_s, name: name, format: 'dot' )
+	# graph.output
+end
+
+CLEAN.include( NODE_STATE_GRAPH.to_s )
+
+
+task :diagrams => [ NODE_STATE_GRAPH ]
+

data/TODO.md

@@ -1,52 +1,43 @@
 # To-Do
 
-## First Release (0.1)
+## Third Release (0.3)
 
-* README, Tutorial, Setup docs
-* Performance/profiling examination
+### Command line
 
+* Add a 'lint' check, to provide warnings for common misconfigurations
+  * Host nodes without any addresses attached
 
-### Monitor
+### Setup/Installation
 
-* Add some default monitor types and utilities
-  - ftp
-  - imap
-  - pop
-  - smtp
+* Add a CLI for generating a basic setup and then adding nodes/monitors/observers to it.
 
-* Redo the select loop of the UDP socket monitor to wait for them in parallel instead of in series.
+### Manager
 
+* Potential federation / referral for sibling managers
+* Add optional authentication support (ZAUTH)
 
-## Second Release (0.2)
 
-### Setup/Installation
+### Nodes
 
-* Add a CLI for generating a basic setup and then adding nodes/monitors/observers to it.
-* Potential federation / referral for sibling managers
+* Allow 'address' host DSL to accept multiple addresses in one call
+* Allow disabling an ACKed node (kschies)
 
-### Nodes
 
-* Ask a node (via tree-api or otherwise) what nodes it affects (immediate children, secondary dependents)
+### Observers
 
-* Clarify the Tree API:
-	
-	- Rename `list` to `fetch`
-		- Return identified node `node.to_h`
-		- Return identified node and its children in a hierarchy `node.to_h(true)`
-		- Return identified node and its children as a flattened list
-	
-	- Rename `fetch` to `search`
-		- returns list of nodes which satisfy positive/negative criteria
+ * Action dependencies -- as an example, if an action sends an email, don't trigger if the email service is offline. Potential action "chains", ie: If the email service is down, use a separate out-of-band action that sends SMS.
 
+ * Flapping state detection
 
-### Observers
 
- * Action dependencies -- as an example, if an action sends an email,
-   don't trigger if the email service is offline.  Potential action
-   "chains", ie:  If the email service is down, use a separate
-   out-of-band action that sends SMS.
 
 ### Monitors
 
-Add a one-shot runner command for development of monitors. Loads and runs a monitor one time, maybe with some output describing how often it'd run, what its skew is, etc. [will@laika]
+* Add a one-shot runner command for development of monitors. Loads and runs a monitor one time, maybe with some output describing how often it'd run, what its skew is, etc. [will@laika]
+
+* Add some default monitor types and utilities
+  - ftp
+  - imap
+  - pop
+  - smtp
 

data/lib/arborist.rb

@@ -14,10 +14,10 @@ module Arborist
 	       Configurability
 
 	# Package version
-	VERSION = '0.1.0'
+	VERSION = '0.2.0'
 
 	# Version control revision
-	REVISION = %q$Revision: 17a8567d86e2 $
+	REVISION = %q$Revision: b7725c5136bc $
 
 
 	# The name of the environment variable which can be used to set the config path
@@ -137,6 +137,12 @@ module Arborist
 	end
 
 
+	### Return a new Arborist::Client.
+	def self::client
+		return Arborist::Client.new
+	end
+
+
 	### Load all node and event types
 	def self::load_all
 		Arborist::Node.load_all
@@ -156,6 +162,7 @@ module Arborist
 	autoload :Observer, 'arborist/observer'
 	autoload :ObserverRunner, 'arborist/observer_runner'
 	autoload :Subscription, 'arborist/subscription'
+	autoload :NodeSubscription, 'arborist/node_subscription'
 
 end # module Arborist
 

data/lib/arborist/cli.rb

@@ -2,7 +2,8 @@
 #encoding: utf-8
 
 require 'loggability'
-require 'highline'
+require 'tty/prompt'
+require 'pastel'
 require 'gli'
 
 require 'arborist' unless defined?( Arborist )
@@ -20,18 +21,6 @@ module Arborist::CLI
 	log_to :arborist
 
 
-	# Make a HighLine color scheme
-	COLOR_SCHEME = HighLine::ColorScheme.new do |scheme|
-		scheme[:header]    = [ :bold, :yellow ]
-		scheme[:subheader] = [ :bold, :white ]
-		scheme[:key]       = [ :white ]
-		scheme[:value]     = [ :bold, :white ]
-		scheme[:error]     = [ :red ]
-		scheme[:warning]   = [ :yellow ]
-		scheme[:message]   = [ :reset ]
-	end
-
-
 	#
 	# GLI
 	#
@@ -79,6 +68,9 @@ module Arborist::CLI
 	desc "Don't actually do anything, just show what would happen."
 	switch [:n, 'dry-run']
 
+	desc "Enable ANSI colors."
+	switch :color, default_value: true
+
 	desc "Additional Ruby libs to require before doing anything."
 	flag [:r, 'requires'], type: Array
 
@@ -97,9 +89,9 @@ module Arborist::CLI
 		self.require_additional_libs( global[:r] ) if global[:r]
 		self.load_config( global )
 		self.set_logging_level( global[:l] ) if global[:l] # again; override config file
-		self.install_highline_colorscheme
 
 		self.setup_output( global )
+		self.setup_pastel_aliases
 
 		true
 	end
@@ -126,10 +118,6 @@ module Arborist::CLI
 	# Registered subcommand modules
 	singleton_attr_accessor :subcommand_modules
 
-	##
-	# The IO opened to the output file
-	singleton_attr_accessor :outfile
-
 
 	### Overridden -- Add registered subcommands immediately before running.
 	def self::run( * )
@@ -159,17 +147,17 @@ module Arborist::CLI
 	end
 
 
-	### Return the HighLine prompt used by the command to communicate with the
-	### user.
-	def self::prompt
-		@prompt ||= HighLine.new( $stdin, $stderr )
+	### Return the Pastel colorizer.
+	###
+	def self::pastel
+		@pastel ||= Pastel.new( enabled: $stdout.tty? && $COLOR )
 	end
 
 
-	### If the command's output was redirected to a file, return the open File object
-	### for it.
-	def self::outfile
-		return @outfile
+	### Return the TTY prompt used by the command to communicate with the
+	### user.
+	def self::prompt
+		@prompt ||= TTY::Prompt.new
 	end
 
 
@@ -199,31 +187,31 @@ module Arborist::CLI
 	end
 
 
-	### Install the color scheme used by HighLine
-	def self::install_highline_colorscheme
-		HighLine.color_scheme = HighLine::ColorScheme.new do |cs|
-			cs[:headline]   = [ :bold, :white, :on_black ]
-			cs[:success]    = [ :bold, :green ]
-			cs[:error]      = [ :bold, :red ]
-			cs[:up]         = [ :green ]
-			cs[:down]       = [ :red ]
-			cs[:unknown]    = [ :dark, :yellow ]
-			cs[:disabled]   = [ :dark, :white ]
-			cs[:quieted]    = [ :dark, :green ]
-			cs[:acked]      = [ :yellow ]
-			cs[:highlight]  = [ :bold, :yellow ]
-			cs[:search_hit] = [ :black, :on_white ]
-			cs[:prompt]     = [ :cyan ]
-			cs[:even_row]   = [ :bold ]
-			cs[:odd_row]    = [ :normal ]
-		end
+	### Setup pastel color aliases
+	###
+	def self::setup_pastel_aliases
+		self.pastel.alias_color( :headline, :bold, :white, :on_black )
+		self.pastel.alias_color( :success, :bold, :green )
+		self.pastel.alias_color( :error, :bold, :red )
+		self.pastel.alias_color( :up, :green )
+		self.pastel.alias_color( :down, :red )
+		self.pastel.alias_color( :unknown, :dark, :yellow )
+		self.pastel.alias_color( :disabled, :dark, :white )
+		self.pastel.alias_color( :quieted, :dark, :green )
+		self.pastel.alias_color( :acked, :yellow )
+		self.pastel.alias_color( :warn, :bold, :magenta )
+		self.pastel.alias_color( :highlight, :bold, :yellow )
+		self.pastel.alias_color( :search_hit, :black, :on_white )
+		self.pastel.alias_color( :prompt, :cyan )
+		self.pastel.alias_color( :even_row, :bold )
+		self.pastel.alias_color( :odd_row, :reset )
 	end
 
 
 	### Load the config file using either arborist-base's config-loader if available, or
 	### fall back to DEFAULT_CONFIG_FILE
 	def self::load_config( global={} )
-		Arborist.load_config( global[:c] ) if global[:c]
+		Arborist.load_config( global[:c] )
 
 		# Set up the logging formatter
 		Loggability.format_with( :color ) if $stdout.tty?
@@ -241,6 +229,7 @@ module Arborist::CLI
 			$DRYRUN = false
 		end
 
+
 		if global[:verbose]
 			$VERBOSE = true
 			Loggability.level = :info
@@ -250,6 +239,8 @@ module Arborist::CLI
 			$DEBUG = true
 			Loggability.level = :debug
 		end
+
+		$COLOR = global[ :color ]
 	end
 
 
@@ -287,57 +278,65 @@ module Arborist::CLI
 		end
 
 
-		### Get the prompt (a Highline object)
+		### Get the prompt (a TTY::Prompt object)
 		def prompt
 			return Arborist::CLI.prompt
 		end
 
 
-		### Return the specified +text+ as a Highline::String for convenient formatting,
-		### color, etc.
-		def hl( text )
-			return HighLine::String.new( text.to_s )
+		### Return the global Pastel object for convenient formatting, color, etc.
+		def hl
+			return Arborist::CLI.pastel
 		end
 
 
 		### Return the specified +string+ in the 'headline' ANSI color.
 		def headline_string( string )
-			return hl( string ).color( :headline )
+			return hl.headline( string )
 		end
 
 
 		### Return the specified +string+ in the 'highlight' ANSI color.
 		def highlight_string( string )
-			return hl( string ).color( :highlight )
+			return hl.highlight( string )
 		end
 
 
 		### Return the specified +string+ in the 'success' ANSI color.
 		def success_string( string )
-			return hl( string ).color( :success )
+			return hl.success( string )
 		end
 
 
 		### Return the specified +string+ in the 'error' ANSI color.
 		def error_string( string )
-			return hl( string ).color( :error )
+			return hl.error( string )
 		end
 
 
-		### Output a table with the given +rows+.
-		def display_table( rows )
-			colwidths = rows.transpose.map do |colvals|
-				colvals.map {|val| visible_chars(val) }.max
-			end
+		### Output a table with the given +header+ (an array) and +rows+
+		### (an array of arrays).
+		def display_table( header, rows )
+			table = TTY::Table.new( header, rows )
+			renderer = nil
 
-			rows.each do |row|
-				row_string = row.zip( colwidths ).inject( '' ) do |accum, (val, colsize)|
-					padding = ' ' * (colsize - visible_chars(val) + 2)
-					accum + val.to_s + padding
-				end
+			if hl.enabled?
+				renderer = TTY::Table::Renderer::Unicode.new(
+					table,
+					multiline: true,
+					padding: [0,1,0,1]
+				)
+				renderer.border.style = :dim
 
-				Arborist::CLI.prompt.say( row_string + "\n" )
+			else
+				renderer = TTY::Table::Renderer::ASCII.new(
+					table,
+					multiline: true,
+					padding: [0,1,0,1]
+				)
 			end
+
+			puts renderer.render
 		end
 
 
@@ -363,32 +362,15 @@ module Arborist::CLI
 	end # module Subcommand
 
 
-	### Register one or more subcommands with the 'arborist' command shell. The given
-	### block will be evaluated in the context of Arborist::CLI.
-	def self::register( &block )
-		self.instance_eval( &block )
-	end
-
-
-	### Custom command loader. The default one is silly.
-	def self::load_commands( path )
-		self.log.debug "Load commands from %s" % [ path ]
-		Pathname.glob( path + '*.rb' ).each do |rbfile|
+	### Load commands from any files in the specified directory relative to LOAD_PATHs
+	def self::commands_from( subdir )
+		Gem.find_latest_files( File.join(subdir, '*.rb') ).each do |rbfile|
 			self.log.debug "  loading %s..." % [ rbfile ]
 			require( rbfile )
 		end
 	end
 
 
-	# Load commands from any files in the specified directory relative to LOAD_PATHs
-	def self::commands_from( subdir )
-		$LOAD_PATH.map {|path| Pathname(path) }.each do |libdir|
-			command_dir = libdir.expand_path + subdir
-			load_commands( command_dir )
-		end
-	end
-
-
 	commands_from 'arborist/command'
 
 end # class Arborist::CLI