arborist 0.0.1.pre20160128152542 → 0.0.1.pre20160606141735

data/Manifest.txt

@@ -3,7 +3,6 @@
 ChangeLog
 Events.md
 History.md
-LICENSE
 Manifest.txt
 Monitors.md
 Nodes.md
@@ -21,11 +20,19 @@ lib/arborist/command/client.rb
 lib/arborist/command/config.rb
 lib/arborist/command/start.rb
 lib/arborist/command/watch.rb
+lib/arborist/dependency.rb
 lib/arborist/event.rb
+lib/arborist/event/node.rb
 lib/arborist/event/node_acked.rb
 lib/arborist/event/node_delta.rb
-lib/arborist/event/node_matching.rb
+lib/arborist/event/node_disabled.rb
+lib/arborist/event/node_down.rb
+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/sys_node_added.rb
+lib/arborist/event/sys_node_removed.rb
 lib/arborist/event/sys_reloaded.rb
 lib/arborist/exceptions.rb
 lib/arborist/loader.rb
@@ -38,7 +45,9 @@ lib/arborist/monitor.rb
 lib/arborist/monitor/socket.rb
 lib/arborist/monitor_runner.rb
 lib/arborist/node.rb
+lib/arborist/node/ack.rb
 lib/arborist/node/host.rb
+lib/arborist/node/resource.rb
 lib/arborist/node/root.rb
 lib/arborist/node/service.rb
 lib/arborist/observer.rb
@@ -47,6 +56,10 @@ lib/arborist/observer/summarize.rb
 lib/arborist/observer_runner.rb
 lib/arborist/subscription.rb
 spec/arborist/client_spec.rb
+spec/arborist/dependency_spec.rb
+spec/arborist/event/node_delta_spec.rb
+spec/arborist/event/node_down_spec.rb
+spec/arborist/event/node_spec.rb
 spec/arborist/event/node_update_spec.rb
 spec/arborist/event_spec.rb
 spec/arborist/manager/event_publisher_spec.rb
@@ -56,7 +69,9 @@ spec/arborist/mixins_spec.rb
 spec/arborist/monitor/socket_spec.rb
 spec/arborist/monitor_runner_spec.rb
 spec/arborist/monitor_spec.rb
+spec/arborist/node/ack_spec.rb
 spec/arborist/node/host_spec.rb
+spec/arborist/node/resource_spec.rb
 spec/arborist/node/root_spec.rb
 spec/arborist/node/service_spec.rb
 spec/arborist/node_spec.rb

data/Nodes.md

@@ -0,0 +1,70 @@
+# Nodes
+
+
+
+    Arborist::Host 'sidonie' do
+    	parent 'duir'
+    	description "NAS and media server"
+    	address '192.168.16.3'
+    
+    	tags :infrastructure,
+    	     :storage,
+    	     :media,
+    	     :rip_status_check
+    
+    	service 'ssh'
+    	service 'demon-http', port: 6666, protocol: 'http'
+    	service 'postgresql'
+    
+    	service 'smtp'
+    
+    	service 'http',
+            depends_on: 'postgresql'
+    	service 'sabnzbd', port: 8080, protocol: 'http'
+    	service 'sickbeard', port: 8081, protocol: 'http'
+    	service 'pms', port: 32400, protocol: 'http'
+    	service 'couchpotato', port: 5050, protocol: 'http'
+    end
+
+
+    Arborist::Host 'jhereg' do
+        parent 'duir'
+        description "Directory server"
+        address '192.168.16.7'
+        
+        service 'ldaps'
+    end
+
+
+    Arborist::Host 'webserver' do
+    	description "Public webserver"
+    	address '54.16.62.181'
+    
+        service 'http',
+            depends_on: 'foo'
+            depends_on: all_of( 'postgresql', 'daemon-http', on: 'sidonie' ),
+                all_of( 'ldaps', on: 'jhereg' )
+    end
+
+
+An application server depends on one each of the 'http' services and 'ldaps' services
+to be up.
+
+    Arborist::Host 'appserver1' do
+        description "Public application webserver"
+        address '54.16.62.185'
+        service 'http',
+            depends_on: all_of(
+                    any_of( 'http', on: %w[service1 service2 service3] ),
+                    any_of( 'ldaps', on: %w[directory1 directory2] ),
+                    all_of( 'else', on: 'something' )
+                )
+    end
+
+
+[ :all_of,
+    [ :any_of, 'service1-http', 'service2-http', 'service3-http' ],
+    [ :any_of, 'directory1-ldaps', 'directory2-ldaps' ],
+    'something-else'
+]
+

data/Protocol.md

@@ -1,6 +1,6 @@
 # Monitors
 
-## Protocol
+## Basic Protocol
 
 ZMQ REQ socket, msgpack message consisting of an Array of two elements:
 
@@ -20,7 +20,25 @@ Header is a Map of the form:
 Body is either Nil, a Map of key-value pairs, or an Array of Maps appropriate to the `action`.
 
 
-## status
+## Commands
+
+
+### «commandname»
+
+«description»
+
+#### Header
+
+#### Body
+
+#### Return
+
+#### Examples
+
+
+
+
+### status
 
 Fetch the status of the Manager.
 
@@ -43,7 +61,13 @@ Response:
     }
 
 
-## list
+### list
+
+Retrieve an Array of Maps that describes all or part of the node tree. 
+
+#### Required 
+ from the node with the specified `identifier`, or the root node if no `identifier` is specified.
+
 
 Request:
 
@@ -52,6 +76,7 @@ Request:
             action: list,
             version: 1
             [from: «identifier»]
+            [depth: «arg»]
         }
     ]
 
@@ -89,11 +114,9 @@ failure example:
         }
     ]
 
-Fetch a data structure describing the node tree from the node with the specified
-`identifier`, or the root node if no `identifier` is specified.
 
 
-## fetch
+### fetch
 
 Fetch the `address`, `description`, and `status` of all nodes.
 
@@ -119,7 +142,7 @@ Fetch the `address`, `description`, and `status` of all nodes.
     ]
 
 
-### return
+#### return
 
 - not specified : returns everything.
 - `Nil` : returns just identifiers
@@ -128,7 +151,7 @@ Fetch the `address`, `description`, and `status` of all nodes.
 Search for nodes that match the filter given in the request body, returning a serialized map of node identifiers to requested state.
 
 
-## update
+### update
 
     [
         {
@@ -164,7 +187,7 @@ With a failure:
     ]
 
 
-## subscribe
+### subscribe
 
 Get node change delta events for every 'host' type node.
 
@@ -212,3 +235,39 @@ Get notified of every system event (startup, shutdown, reload, etc.)
     Nil
 
 
+### graft
+
+    {
+        action: graft,
+        version: 1,
+        type: 'host',
+        identifier: 'joliet',
+        parent: 'bennett' # defaults to root
+    },
+    {
+        addresses: [],
+        tags: []
+    }
+
+
+### prune
+
+    {
+        action: prune,
+        version: 1,
+        identifier: 'bennett'
+    },
+    Nil
+
+
+### modify
+
+    {
+        action: modify,
+        version: 1,
+        identifier: 'bennett'
+    },
+    {
+        addresses: ['10.13.0.22', '10.1.0.23']
+    }
+

data/README.md

@@ -29,12 +29,10 @@ customizability.
 
 ## Installation
 
-    $ gem install arborist
-
+This isn't really ready for serious usage yet, but when it is you can install
+it like so:
 
-## Further Reading
-
-You'll likely want to start with [the Tutorial](Tutorial.html).
+    $ gem install arborist
 
 
 ## Contributing

data/Rakefile

@@ -38,6 +38,8 @@ hoespec = Hoe.spec 'arborist' do |spec|
 	spec.dependency 'state_machines', '~> 0.2'
 	spec.dependency 'msgpack', '~> 0.6'
 	spec.dependency 'rbczmq', '~> 1.7'
+	spec.dependency 'gli', '~> 2.3'
+	spec.dependency 'highline', '~> 1.7'
 
 	spec.dependency 'rspec', '~> 3.2', :developer
 	spec.dependency 'simplecov', '~> 0.9', :developer
@@ -80,10 +82,11 @@ if File.directory?( '.hg' )
 	end
 end
 
-task :gemspec => GEMSPEC
+task :gemspec => [ 'ChangeLog', 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}.pre#{Time.now.strftime("%Y%m%d%H%M%S")}"
 	File.open( task.name, 'w' ) do |fh|

data/TODO.md

@@ -1,33 +1,65 @@
 # To-Do
 
-## Manager
+## First Release (0.1)
 
-* Serialize nodes on shutdown
-* Include a node's subscriptions in its serialized data
-* Implement loading/reloading nodes. 
-* Implement the system events (sys.acked, sys.reloaded, etc.)
+* README, Tutorial, Setup docs
 
-## Tree API
+* Performance/profiling examination
 
-* Add "grafting": node add/removal
 
-## Observers
+### Manager
 
-* Scheduling time periods for action/summarizing
-* Summarizing and Actions should be 1st order objects
-* Unsubscribe from Arborist and ZMQ subscriptions on shutdown
-* Figure out how to match on delta events: the criteria
-  for matching nodes has to be separated from that which matches
-  the delta pairs.
+* Only restore timestamps from serialized node dependencies, not the deps themselves.
 
-## Node
+* Broadcast system events:
+    - `sys.node.added`
+    - `sys.node.removed`
+    - `sys.startup`
+    - `sys.shutdown`
 
-* Allow (require?) node types to specify what kinds of nodes can be
-  their parent, and also adds the constructor DSL method to it
 
+### Observers
 
-## Setup/Installation
+* Re-subscribe on `sys.startup`, `sys.reloaded`, `sys.node.added`
+* Add `except` to observers DSL
 
-* Add a CLI for generating a basic setup and then adding 
-  nodes/monitors/observers to it.
 
+### Nodes
+
+* Allow a service node to not inherit all of its host's addresses (i.e., be bound to one address only or whatever)
+* Resource nodes: disk, load, process checks, etc.  Anything that might
+  be considered a problem, that you'd want to ack independantly of the
+  Host node they are attached to.
+
+### Monitor
+
+* Add some default monitor types and utilities
+  - UDP socket check
+  - Basic monitors for stdlib Net::* protocols/services
+  - 
+
+* Gems for monitor types that have external dependency
+  - SNMP
+
+### Watch Command
+
+* Re-subscribe on `sys.startup`, `sys.reloaded`, `sys.node.added`
+
+
+## Second Release (0.2)
+
+### Setup/Installation
+
+* Add a CLI for generating a basic setup and then adding nodes/monitors/observers to it.
+* Potential federation / referral for sibling managers
+
+### Nodes
+
+* Ask a node (via tree-api or otherwise) what nodes it affects (immediate children, secondary dependents)
+
+### 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.

data/lib/arborist.rb

@@ -17,7 +17,7 @@ module Arborist
 	VERSION = '0.0.1'
 
 	# Version control revision
-	REVISION = %q$Revision: e23d2b9f8f31 $
+	REVISION = %q$Revision: ed4f0655b4b6 $
 
 
 	# The name of the environment variable which can be used to set the config path
@@ -32,7 +32,7 @@ module Arborist
 	# Configurability API -- default configuration values
 	CONFIG_DEFAULTS = {
 		tree_api_url:  'ipc:///tmp/arborist_tree.sock',
-		event_api_url: 'ipc:///tmp/arborist_events.sock'
+		event_api_url: 'ipc:///tmp/arborist_events.sock',
 	}
 
 
@@ -103,10 +103,17 @@ module Arborist
 
 	### Add a constructor function to the Arborist namespace called +name+
 	### with the specified +method_body+.
-	def self::add_dsl_constructor( name, &method_body )
-		self.log.debug "Adding constructor for %p: %p" % [ name, method_body ]
-		singleton_class.instance_exec( name, method_body ) do |name, body|
-			define_method( name, &body )
+	def self::add_dsl_constructor( subclass, &method_body )
+		name = subclass.name
+
+		if name
+			name.sub!( /.*::/, '' )
+			self.log.debug "Adding factory method for %p: %p" % [ name, method_body ]
+			singleton_class.instance_exec( name, method_body ) do |name, body|
+				define_method( name, &body )
+			end
+		else
+			self.log.info "Skipping DSL constructor for anonymous class."
 		end
 	end
 
@@ -165,6 +172,12 @@ module Arborist
 	end
 
 
+	### Set the ZMQ context if it's already been created by something else.
+	def self::zmq_context=( existing_context )
+		@zmq_context = existing_context
+	end
+
+
 	require 'arborist/exceptions'
 	require 'arborist/mixins'
 

data/lib/arborist/cli.rb

@@ -43,7 +43,7 @@ module Arborist::CLI
 	version Arborist::VERSION
 
 	# Use an OpenStruct for options instead of a Hash
-	use_openstruct( true )
+	# use_openstruct( true )
 
 	# Subcommand options are independent of global[:ones]
 	subcommand_option_handling :normal
@@ -62,7 +62,8 @@ module Arborist::CLI
 
 
 	# Global options
-	desc "Specify the config file to load"
+	desc "Load the specified CONFIGFILE."
+	arg_name :CONFIGFILE
 	flag [:c, :config], type: Pathname
 
 	desc 'Enable debugging output'
@@ -72,7 +73,7 @@ module Arborist::CLI
 	switch [:v, :verbose]
 
 	desc 'Set log level to LEVEL (one of %s)' % [Loggability::LOG_LEVELS.keys.join(', ')]
-	default_value Loggability[self].level
+	arg_name :LEVEL
 	flag [:l, :loglevel], must_match: Loggability::LOG_LEVELS.keys
 
 	desc "Don't actually do anything, just show what would happen."
@@ -86,24 +87,41 @@ module Arborist::CLI
 	# GLI Event callbacks
 	#
 
+	# Set up global options
 	pre do |global, command, options, args|
-		if loglevel = global[:loglevel]
-			Loggability.level = loglevel.to_sym
-		else
-			Loggability.level = :fatal
-		end
+		self.set_logging_level( global[:l] )
 
 		# Include a 'lib' directory if there is one
 		$LOAD_PATH.unshift( 'lib' ) if File.directory?( 'lib' )
 
-		self.require_additional_libs( global.requires ) if global.requires
+		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 )
+
 		true
 	end
 
 
+	# Write the error to the log on exceptions.
+	on_error do |exception|
+		case exception
+		when OptionParser::ParseError, GLI::CustomExit
+			self.log.debug( exception )
+		else
+			self.log.error( exception )
+		end
+
+		exception.backtrace.each {|frame| self.log.debug(frame) }
+
+		true
+	end
+
+
+
+
 	##
 	# Registered subcommand modules
 	singleton_attr_accessor :subcommand_modules
@@ -162,6 +180,16 @@ module Arborist::CLI
 	end
 
 
+	### Set the global logging +level+ if it's defined.
+	def self::set_logging_level( level=nil )
+		if level
+			Loggability.level = level.to_sym
+		else
+			Loggability.level = :fatal
+		end
+	end
+
+
 	### Load any additional Ruby libraries given with the -r global option.
 	def self::require_additional_libs( requires)
 		requires.each do |path|
@@ -181,6 +209,7 @@ module Arborist::CLI
 			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 ]
@@ -194,7 +223,7 @@ module Arborist::CLI
 	### 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.config ) if global.config
+		Arborist.load_config( global[:c] ) if global[:c]
 
 		# Set up the logging formatter
 		Loggability.format_with( :color ) if $stdout.tty?
@@ -224,21 +253,6 @@ module Arborist::CLI
 	end
 
 
-	# Write the error to the log on exceptions.
-	on_error do |exception|
-		case exception
-		when OptionParser::ParseError, GLI::CustomExit
-			self.log.debug( exception )
-		else
-			self.log.error( exception )
-		end
-
-		exception.backtrace.each {|frame| self.log.debug(frame) }
-
-		true
-	end
-
-
 	#
 	# GLI subcommands
 	#