arborist 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 755dd41faeb4ed205809c646017026c078f4aa9dfe59f194eeef91b8cd0ed77c
-  data.tar.gz: '0080619e822e2a8fac94d9c3bc5c4c723bf1f1c1b33c6ca1de0951c70070cb35'
+  metadata.gz: 8e381c42854fa4ee4d530c7ac6a0ec35a626ebf60c56966a034f3cf42e56d277
+  data.tar.gz: 583b4bc03a562550d8e6840c46fcd357e2bfeedc1986bb1813850a9a5fcf4b62
 SHA512:
-  metadata.gz: e9ef21ce54e29b1b1b46bbed628cb752bacc79c0a1ce9af32b945952bf96532677e2c29c5953dcb516bc2b13f316589b57294d9391aeed353234688b4c057f62
-  data.tar.gz: a8b4fbc85de0b4fa636a2e82cc086980f97b5bc666da0f8c11d8d8e0ed9d99d7d014b34a5b61ad8cd53f4aa7f869967f41ca49487d635253ff2d072c286172c2
+  metadata.gz: 0d53eee53ff4d17916bb90aa3def361179cd4a81cc16e102701e05a9f1548dafef24962ffb23542adb044b8757af3089ac92da0abdb90022d8fcabaaeedb3a10
+  data.tar.gz: 5b26f1215719f2746f092b9230acdf1350f7a241481b327dc3c74a230d3d5be390413d7db60287e83ac6e7d95365aed8440b0f60424e34445bdc3f1da48cfe31

data/ChangeLog

@@ -1,8 +1,66 @@
+2018-08-29  Michael Granger  <ged@FaerieMUD.org>
+
+	* lib/arborist/command/run_once.rb:
+	Add a `run` command for testing monitors
+	[1bc6155c5e9c] [tip]
+
+	* lib/arborist/node/host.rb:
+	Shut up warnings about uninitialized instance vars
+	[4329c98ea325]
+
+2018-08-29  Mahlon E. Smith  <mahlon@martini.nu>
+
+	* lib/arborist/node.rb, spec/arborist/node_spec.rb:
+	Acking an already acked node transitions the node to disabled.
+	[141000d6bec3]
+
+2018-08-28  Michael Granger  <ged@FaerieMUD.org>
+
+	* spec/spec_helper.rb:
+	Enabled RSpec warnings, example profiles
+	[404f8d609524]
+
+2018-08-24  Mahlon E. Smith  <mahlon@martini.nu>
+
+	* lib/arborist/client.rb:
+	Use the proper exception when raising errors from the client,
+	instead of RuntimeError.
+	[ff0b0fea9a9f]
+
+2018-08-15  Mahlon E. Smith  <mahlon@martini.nu>
+
+	* lib/arborist/command/tree.rb:
+	Add raw formatting for YAML and JSON to the tree command.
+	[f0b978d49569] [github/master]
+
+	* Rakefile, lib/arborist/command/ack.rb:
+	Optionally continue attempting to ack/clear nodes if some are
+	invalid.
+	[d379568d92cc]
+
+	* lib/arborist/monitor/socket.rb:
+	Expose socket batch size to configurability.
+	[17866a8a66d6]
+
+2018-08-08  Michael Granger  <ged@FaerieMUD.org>
+
+	* .hgtags:
+	Added tag v0.2.0 for changeset b5d07bcc4762
+	[0a39e734c94d]
+
+	* .hgsigs:
+	Added signature for changeset b7725c5136bc
+	[b5d07bcc4762] [v0.2.0]
+
+	* History.md, README.md, TODO.md, arborist.gemspec, lib/arborist.rb:
+	Bump the minor version, update history and the to-do file.
+	[b7725c5136bc]
+
 2018-08-01  Mahlon E. Smith  <mahlon@martini.nu>
 
 	* lib/arborist/manager.rb:
 	Add debug log for checkpoint timing.
-	[734e01730be6] [tip]
+	[734e01730be6]
 
 2018-07-27  Mahlon E. Smith  <mahlon@martini.nu>
 
@@ -29,7 +87,7 @@
 
 	* lib/arborist/node.rb, spec/arborist/node_spec.rb:
 	Add acknowledgement changes to delta events.
-	[f6b57c73929e] [github/master]
+	[f6b57c73929e]
 
 	* Manifest.txt, lib/arborist/monitor/connection_batching.rb,
 	lib/arborist/monitor/socket.rb:

data/History.md

@@ -1,3 +1,21 @@
+## v0.3.0 [2018-08-29] Michael Granger <ged@FaerieMUD.org>
+
+Enhancements:
+
+- Add a `run_once` command for testing monitors
+- Acking an already acked node transitions the node to disabled.
+- Add raw formatting for YAML and JSON to the tree command.
+- Optionally continue attempting to ack/clear nodes if some are
+  invalid.
+- Expose socket batch size to configurability.
+
+Fixes:
+
+- Use the proper exception when raising errors from the client,
+  instead of RuntimeError.
+
+
+
 ## v0.2.0 [2018-08-08] Michael Granger <ged@FaerieMUD.org>
 
 Breaking:

data/Manifest.txt

@@ -14,6 +14,7 @@ lib/arborist/command/ack.rb
 lib/arborist/command/client.rb
 lib/arborist/command/config.rb
 lib/arborist/command/reset.rb
+lib/arborist/command/run_once.rb
 lib/arborist/command/start.rb
 lib/arborist/command/summary.rb
 lib/arborist/command/tree.rb

data/Rakefile

@@ -56,7 +56,6 @@ hoespec = Hoe.spec 'arborist' do |spec|
 	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' )

data/lib/arborist.rb

@@ -14,10 +14,10 @@ module Arborist
 	       Configurability
 
 	# Package version
-	VERSION = '0.2.0'
+	VERSION = '0.3.0'
 
 	# Version control revision
-	REVISION = %q$Revision: b7725c5136bc $
+	REVISION = %q$Revision: db70f921e653 $
 
 
 	# The name of the environment variable which can be used to set the config path

data/lib/arborist/client.rb

@@ -312,7 +312,8 @@ class Arborist::Client
 
 		header, body = Arborist::TreeAPI.decode( res )
 		unless header[ 'success' ]
-			raise "Arborist manager said: %s" % [ header['reason'] ]
+			exception = header['category'] == 'client' ? Arborist::ClientError : Arborist::ServerError
+			raise exception, "Arborist manager said: %s" % [ header['reason'] ]
 		end
 
 		return body

data/lib/arborist/command/ack.rb

@@ -19,6 +19,9 @@ module Arborist::CLI::Ack
 		cmd.switch :clear, default: false,
 			desc: "Clear the ack instead of setting it.",
 			negatable: false
+		cmd.switch [ :k, 'keep-going' ], default: false,
+			desc: "Continue in the event of errors.",
+			negatable: false
 
 		cmd.flag [ :u, :user ],
 			desc: "The user to mark the nodes with."
@@ -46,12 +49,17 @@ module Arborist::CLI::Ack
 
 				identifiers.each do |id|
 					res[ id ] = unless_dryrun( "Acking #{id}...", true ) do
-						client.ack(
-							identifier: id,
-							message:    message,
-							sender:     userid,
-							via:        "command line"
-						)
+						begin
+							client.ack(
+								identifier: id,
+								message:    message,
+								sender:     userid,
+								via:        "command line"
+							)
+						rescue => err
+							raise unless options[ 'keep-going' ]
+							err.message
+						end
 					end
 				end
 			end
@@ -59,7 +67,7 @@ module Arborist::CLI::Ack
 			res.each_pair do |identifier, result|
 				prompt.say "%s: %s" % [
 					hl.bold.bright_blue( identifier ),
-					result == true ? "Okay." : hl.red( res.to_s )
+					result == true ? "Okay." : hl.red( res[identifier].to_s )
 				]
 			end
 		end

data/lib/arborist/command/run_once.rb

@@ -0,0 +1,113 @@
+# -*- ruby -*-
+#encoding: utf-8
+
+require 'tty-screen'
+require 'arborist/cli' unless defined?( Arborist::CLI )
+
+
+# Command to run a monitor in single-run mode
+module Arborist::CLI::RunOnce
+	extend Arborist::CLI::Subcommand
+
+	desc 'Run an Arborist monitor once'
+	long_desc <<-EOF
+	Run monitor(s) once.
+
+	If the MONITOR argument is a file, it is loaded and any monitors contained
+	in it are run once and their output is dumped. If it is not a readable file,
+	it is assumed to be the name of a monitor callback module, and that is
+	run inside of a simple monitor object instead.
+	EOF
+
+	arg :MONITOR
+
+	command :run_once do |cmd|
+
+		cmd.flag :type,
+			desc: "Specify the types of nodes to run a monitor class against. Ignored for monitor files.",
+			default_value: 'host'
+		cmd.flag :require, desc: "Require a file before instantiating monitor(s)."
+
+		cmd.action do |globals, options, args|
+			monitors = monitors_from_args( args, options )
+			client = Arborist.client
+
+			monitors.each do |monitor|
+				# :TODO: Should the client maybe have a method for searching for the nodes for a
+				#        monitor instead of having to stitch them together like this?
+				nodes = client.search(
+					criteria: monitor.positive_criteria,
+					exclude: monitor.negative_criteria,
+					exclude_down: monitor.exclude_down?,
+					properties: monitor.node_properties
+				)
+
+				desc = "running %p against %d nodes" % [ monitor, nodes.length ]
+				unless_dryrun( desc ) do
+					prompt.say( highlight_string(monitor.description) )
+					results = monitor.run( nodes )
+					display_results( results )
+				end
+
+			end
+		end
+	end
+
+
+	###############
+	module_function
+	###############
+
+
+	### Figure out what kind of monitor is being run from the provided +args+ and
+	### +options+ and return instances of them.
+	def monitors_from_args( args, options )
+		return args.flat_map do |monitor|
+			if File.exist?( monitor )
+				Arborist::Monitor.load( monitor )
+			else
+				wrap_monitor_callback( monitor, options )
+			end
+		end
+	end
+
+
+	### Try to load the monitor callback with the specified +mod_name+ and return
+	### it inside a plain monitor object.
+	def wrap_monitor_callback( mod_name, options )
+		filename = fileize( mod_name )
+		required_file = options[ :require ] || "arborist/monitor/%s" % [ filename ]
+		self.log.debug "Loading monitor callback from %p" % [ required_file ]
+
+		require( required_file )
+
+		exec_module = Arborist::Monitor.const_get( mod_name )
+		monitor = Arborist::Monitor.new( exec_module.name, filename )
+		monitor.exec( exec_module )
+		monitor.match( type: options[:type] )
+
+		return [ monitor ]
+	end
+
+
+	### Return the specified +mod_name+ as the corresponding file name.
+	def fileize( mod_name )
+		return mod_name.sub( /.*::/, '' ).
+			gsub( /([a-z0-9])([A-Z])/, '\\1_\\2' ).downcase
+	end
+
+
+	### Display the results of running a monitor.
+	def display_results( results )
+		width = TTY::Screen.width
+
+		results.keys.sort.each do |identifier|
+			result = results[ identifier ]
+			prompt.say( highlight_string(identifier) )
+			prompt.say( PP.pp(result, '', width) )
+			prompt.say "\n"
+		end
+	end
+
+end # module Arborist::CLI::Start
+

data/lib/arborist/command/tree.rb

@@ -2,6 +2,8 @@
 #encoding: utf-8
 
 require 'pp'
+require 'json'
+require 'yaml'
 require 'msgpack'
 require 'tty-tree'
 
@@ -23,6 +25,9 @@ module Arborist::CLI::Tree
 			desc: "Include the parent path back to root, when using --from.",
 			negatable: false
 
+		cmd.flag :format,
+			desc: "When dumping the tree using --raw, serialize to this format.",
+			must_match: %w[ yaml json ]
 		cmd.flag [:f, :from],
 			type: String,
 			desc: "Start at a node other than the root.",
@@ -42,7 +47,14 @@ module Arborist::CLI::Tree
 			nodes = client.fetch( opts )
 
 			if options[:raw]
-				pp nodes.first
+				case options[:format]
+				when 'json'
+					puts JSON.dump( nodes.first )
+				when 'yaml'
+					puts YAML.dump( nodes.first )
+				else
+					pp nodes.first
+				end
 
 			else
 				status = client.status

data/lib/arborist/monitor/socket.rb

@@ -24,6 +24,11 @@ module Arborist::Monitor::Socket
 			Float( val )
 		end
 
+		##
+		# The number of socket connections to attempt simultaneously.
+		setting :batch_size, default: 150 do |val|
+			Integer( val )
+		end
 	end
 
 
@@ -55,8 +60,11 @@ module Arborist::Monitor::Socket
 		###
 		### +:timeout+
 		###   Set the number of seconds to wait for a connection for each node.
-		def initialize( timeout: Arborist::Monitor::Socket.default_timeout )
+		### +:batch_size+
+		###   The number of UDP connection attempts to perform simultaneously.
+		def initialize( timeout: Arborist::Monitor::Socket.default_timeout, batch_size: Arborist::Monitor::Socket.batch_size )
 			self.timeout = timeout
+			self.batch_size = batch_size
 		end
 
 
@@ -127,12 +135,6 @@ module Arborist::Monitor::Socket
 
 		log_to :arborist
 
-
-		# Defaults for instances of this monitor
-		DEFAULT_OPTIONS = {
-			timeout: 0.001
-		}
-
 		# Always request the node addresses and port.
 		USED_PROPERTIES = [ :addresses, :port ].freeze
 
@@ -153,8 +155,11 @@ module Arborist::Monitor::Socket
 		###
 		### +:timeout+
 		###   Set the number of seconds to wait for a connection for each node.
-		def initialize( timeout: Arborist::Monitor::Socket.default_timeout )
+		### +:batch_size+
+		###   The number of UDP connection attempts to perform simultaneously.
+		def initialize( timeout: Arborist::Monitor::Socket.default_timeout, batch_size: Arborist::Monitor::Socket.batch_size )
 			self.timeout = timeout
+			self.batch_size = batch_size
 		end
 
 

data/lib/arborist/node.rb

@@ -129,8 +129,8 @@ class Arborist::Node
 		end
 
 		event :acknowledge do
-			transition any - [:down, :acked] => :disabled
-			transition [:down, :acked] => :acked
+			transition any - [:down] => :disabled
+			transition :down => :acked
 		end
 
 		event :unacknowledge do
@@ -156,7 +156,7 @@ class Arborist::Node
 		after_transition :down => :up, do: :on_node_up
 		after_transition :up => :warn, do: :on_node_warn
 		after_transition [:unknown, :warn, :up] => :down, do: :on_node_down
-		after_transition [:unknown, :warn, :up] => :disabled, do: :on_node_disabled
+		after_transition [:acked, :unknown, :warn, :up] => :disabled, do: :on_node_disabled
 		after_transition any => :quieted, do: :on_node_quieted
 		after_transition :disabled => :unknown, do: :on_node_enabled
 		after_transition :quieted => :unknown, do: :on_node_unquieted
@@ -1324,6 +1324,8 @@ class Arborist::Node
 
 	### Callback for when a node goes from up to disabled
 	def on_node_disabled( transition )
+		self.errors.clear
+		self.warnings.clear
 		self.log.warn "%s is %s" % [ self.identifier, self.status_description ]
 	end
 

data/lib/arborist/node/host.rb

@@ -36,6 +36,7 @@ class Arborist::Node::Host < Arborist::Node
 	### Create a new Host node.
 	def initialize( identifier, attributes={}, &block )
 		@addresses = []
+		@hostname = nil
 		super
 	end
 

data/spec/arborist/client_spec.rb

@@ -19,6 +19,7 @@ describe Arborist::Client do
 	describe "synchronous API", :testing_manager do
 
 		before( :each ) do
+			@manager = nil
 			@manager_thread = Thread.new do
 				@manager = make_testing_manager()
 				Loggability[ Arborist ].info "Starting a testing manager: %p" % [ @manager ]

data/spec/arborist/node_spec.rb

@@ -454,17 +454,16 @@ describe Arborist::Node do
 
 			let( :node ) do
 				obj = super()
-				obj.status = 'acked'
+				obj.status = 'down'
 				obj.errors['moldovia'] = 'Something is wrong | he falls | betraying the trust | "\
 					"there is a disaster in his life.'
-				obj.acknowledge( message: "Leitmotiv", sender: 'ged' )
+				obj.acknowledge( message: "Leitmotiv", sender: 'ged' )  # ack!
 				obj
 			end
 
 
 			it_behaves_like "a reachable node"
 
-
 			it "transitions to `up` status if its error is cleared" do
 				expect {
 					node.update( {error: nil}, 'moldovia' )
@@ -472,6 +471,14 @@ describe Arborist::Node do
 			end
 
 
+			it "transitions to `disabled` status if its acked twice" do
+				expect {
+					node.acknowledge( message: "Leitmotiv", sender: 'ged' )
+				}.to change { node.status }.from( 'acked' ).to( 'disabled' )
+				expect( node.errors ).to be_empty
+			end
+
+
 			it "stays `up` if it is updated twice with an error key" do
 				node.update( {error: nil}, 'moldovia' )
 

data/spec/arborist/observer_runner_spec.rb

@@ -67,6 +67,7 @@ describe Arborist::ObserverRunner do
 	describe "a runner with loaded observers", :testing_manager do
 
 		before( :each ) do
+			@manager = nil
 			@manager_thread = Thread.new do
 				@manager = make_testing_manager()
 				Thread.current.abort_on_exception = true

data/spec/spec_helper.rb

@@ -172,6 +172,8 @@ RSpec.configure do |config|
 	config.mock_with( :rspec ) do |mock|
 		mock.syntax = :expect
 	end
+	config.warnings = true
+	config.profile_examples = 5
 
 	config.after( :each ) do
 		Arborist::Node::Root.reset

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: arborist
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Michael Granger
@@ -36,7 +36,7 @@ cert_chain:
   X0qdrKi+2aZZ0NGuFj9AItBsVmAvkBGIpX4TEKQp5haEbPpmaqO5nIIhV26PXmyT
   OMKv6pWsoS81vw5KAGBmfX8nht/Py90DQrbRvakATGI=
   -----END CERTIFICATE-----
-date: 2018-08-09 00:00:00.000000000 Z
+date: 2018-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: schedulability
@@ -378,6 +378,7 @@ files:
 - lib/arborist/command/client.rb
 - lib/arborist/command/config.rb
 - lib/arborist/command/reset.rb
+- lib/arborist/command/run_once.rb
 - lib/arborist/command/start.rb
 - lib/arborist/command/summary.rb
 - lib/arborist/command/tree.rb