sfpagent 0.1.0 → 0.1.1

data/README.md

@@ -1,16 +1,14 @@
 SFP Agent for Ruby
 ==================
 - Author: Herry (herry13@gmail.com)
-- Version: 0.0.1
-- License: [BSD License](https://github.com/herry13/sfp-ruby/blob/master/LICENSE)
+- Version: 0.1.1
+- License: [BSD License](https://github.com/herry13/sfpagent/blob/master/LICENSE)
 
-A gem that provides a Ruby interface to an SFP agent.
+A Ruby script and API of an SFP agent. The agent could be accessed through HTTP RESTful API.
 
-
-To install
-----------
-
-	$ gem install sfpagent
+With this agent, you could manage a software component such as get the state, install, uninstall, update
+its configuration, etc. Each configuration should be specified in [SFP language](https://github.com/herry13/sfp).
+Every software component could have a set of methods which could be called through HTTP request.
 
 
 Requirements
@@ -20,3 +18,53 @@ Requirements
 	- sfp (>= 0.3.0)
 	- antlr3
 	- json
+
+
+To install
+----------
+
+	$ gem install sfpagent
+
+
+As daemon
+---------
+- start the agent daemon
+
+		$ sfpagent -s
+
+  In default, the agent will listen at port **1314**.
+
+- stop the agent daemon
+
+		$ sfpagent -t
+
+
+Cached Directory
+----------------
+Cached directory keeps all agent's local data such as:
+- log file
+- PID file
+- model file
+- installed modules
+
+In default, the agent will use (and created if not exist):
+- directory **~/.sfpagent**, when the daemon is running with non-root user,
+- directory **/var/sfpagent**, when the daemon is running with root user.
+
+
+HTTP RESTful API
+----------------
+- GET
+	- /state : return the state of the agent
+	- /model : return the model of the agent
+	- /modules : return the list of modules
+	- /log : return the last 100 lines of the log file
+
+- POST
+	- /execute : execute an action as specified in "action" parameter
+
+- PUT
+	- /model : set/replace the model with given model as specified in "model" parameter
+	- /module : set/replace the module if "module" parameter is specified, or delete the module if the parameter is not exist
+
+

data/bin/sfpagent

@@ -4,7 +4,7 @@ libdir = File.expand_path(File.dirname(__FILE__))
 require "#{libdir}/../lib/sfpagent"
 
 opts = Trollop::options do
-	version "sfpagent 0.0.1 (c) 2013 Herry"
+	version "sfpagent 0.1.1 (c) 2013 Herry"
 	banner <<-EOS
 SFP Agent that provides a Ruby framework for managing system configurations. The configurations are modelled in SFP language.
 

data/lib/sfpagent/agent.rb

@@ -9,6 +9,8 @@ require 'logger'
 
 module Sfp
 	module Agent
+		NetHelper = Object.new.extend(Nuri::Net::Helper)
+
 		if Process.euid == 0
 			CachedDir = '/var/sfpagent'
 		else
@@ -185,8 +187,9 @@ module Sfp
 		# Return the current state of the model.
 		#
 		def self.get_state(as_sfp=true)
-			return nil if !defined? @@runtime or @@runtime.nil?
+			return nil if !defined?(@@runtime) or @@runtime.nil?
 			begin
+				@@runtime.get_state if @@runtime.modules.nil?
 				return @@runtime.get_state(as_sfp)
 			rescue Exception => e
 				@@logger.error "Get state [Failed] #{e}\n#{e.backtrace.join("\n")}"
@@ -194,6 +197,39 @@ module Sfp
 			false
 		end
 
+		def self.resolve(path, as_sfp=true)
+			return Sfp::Undefined.new if !defined?(@@runtime) or @@runtime.nil? or @@runtime.modules.nil?
+			begin
+				path = path.simplify
+				_, node, _ = path.split('.', 3)
+				if @@runtime.modules.has_key?(node)
+					# local resolve
+					parent, attribute = path.pop_ref
+					mod = @@runtime.modules.at?(parent)
+					if mod.is_a?(Hash)
+						mod[:_self].update_state
+						state = mod[:_self].state
+						return state[attribute] if state.has_key?(attribute)
+					end
+				else
+					agents = get_agents
+					if agents[node].is_a?(Hash)
+						agent = agents[node]
+						path = path[1, path.length-1].gsub /\./, '/'
+						code, data = NetHelper.get_data(agent['sfpAddress'], agent['sfpPort'], "/state#{path}")
+						if code.to_i == 200
+							state = JSON[data]['state']
+							return Sfp::Unknown.new if state == '<sfp::unknown>'
+							return state if !state.is_a?(String) or state[0,15] != '<sfp::undefined'
+						end
+					end
+				end
+			rescue Exception => e
+				@@logger.error "Resolve #{path} [Failed] #{e}\n#{e.backtrace.join("\n")}"
+			end
+			Sfp::Undefined.new
+		end
+
 		# Execute an action
 		#
 		# @param action contains the action's schema.
@@ -342,13 +378,13 @@ module Sfp
 				raise Exception, "Invalid agents list." if not agents.is_a?(Hash)
 				buffer = {}
 				agents.each { |name,data|
-					raise Exception "Invalid agents list." if not data.is_a?(Hash) or
-						not data.has_key?('address') or data['address'].to_s.strip == '' or
-						not data.has_key?('port')
+					raise Exception, "Invalid agents list." if not data.is_a?(Hash) or
+						not data.has_key?('sfpAddress') or data['sfpAddress'].to_s.strip == '' or
+						not data.has_key?('sfpPort')
 					buffer[name] = {}
-					buffer[name]['address'] = data['address'].to_s
-					buffer[name]['port'] = data['port'].to_s.strip.to_i
-					buffer[name]['port'] = DefaultPort if buffer[name]['port'] == 0
+					buffer[name]['sfpAddress'] = data['sfpAddress'].to_s
+					buffer[name]['sfpPort'] = data['sfpPort'].to_s.strip.to_i
+					buffer[name]['sfpPort'] = DefaultPort if buffer[name]['sfpPort'] == 0
 				}
 				f.write(JSON.generate(buffer))
 				f.flush
@@ -408,6 +444,9 @@ module Sfp
 					elsif path == '/modules'
 						status, content_type, body = [200, 'application/json', JSON.generate(Sfp::Agent.get_modules)]
 
+					elsif path == '/agents'
+						status, content_type, body = [200, 'application/JSON', JSON.generate(Sfp::Agent.get_agents)]
+
 					elsif path == '/log'
 						status, content_type, body = [200, 'text/plain', Sfp::Agent.get_log(100)]
 
@@ -423,6 +462,8 @@ module Sfp
 			#
 			# uri:
 			#	/execute => receive an action's schema and execute it
+			#	/migrate => SFP object migration
+			#	/duplicate => SFP object duplication
 			#
 			def do_POST(request, response)
 				status = 400
@@ -433,6 +474,14 @@ module Sfp
 					path = (request.path[-1,1] == '/' ? ryyequest.path.chop : request.path)
 					if path == '/execute'
 						status, content_type, body = self.execute({:query => request.query})
+
+					elsif path =~ /\/migrate\/.+/
+						status, content_type, body = self.migrate({:src => path[8, path.length-8],
+						                                           :dest => request.query['destination']})
+
+					elsif path =~ /\/duplicate\/.+/
+						# TODO
+
 					end
 				end
 
@@ -458,13 +507,9 @@ module Sfp
 					if path == '/model'
 						status, content_type, body = self.set_model({:query => request.query})
 
-					elsif path =~ /\/module\/.+/
-						status, content_type, body = self.manage_modules({:name => path[8, path.length-8],
-						                                                 :query => request.query})
-
 					elsif path =~ /\/modules\/.+/
 						status, content_type, body = self.manage_modules({:name => path[9, path.length-9],
-						                                                 :query => request.query})
+						                                                  :query => request.query})
 
 					elsif path == '/modules'
 						status, content_type, body = self.manage_modules({:delete => true})
@@ -480,6 +525,35 @@ module Sfp
 				response.body = body
 			end
 
+			def migrate(p={})
+				# migrate: source path, destination path
+				#@logger.info "migrate #{p[:src]} => #{p[:dest]}"
+				return [400, 'plain/text', 'Destination path should begin with "/"'] if p[:dest].to_s[0,1] != '/'
+				begin
+					# reformat the source and destination paths to SFP reference
+					p[:src] = '$' + p[:src].gsub(/\//, '.')
+					p[:dest] = '$' + p[:dest].gsub(/\//, '.')
+
+					# find the target in agents' database
+					agents = Sfp::Agent.get_agents
+					data = agents.at?(p[:dest])
+					return [404, 'plain/text', 'Unrecognized destination!'] if !data.is_a?(Hash)
+
+					# send the sub-model to destination
+					model = Sfp::Agent.get_model
+					return [404, '', ''] if model.nil?
+					submodel = model.at?(p[:src])
+
+					# TODO
+					# 1. send the configuration to destination
+
+					return [200, 'plain/text', "#{p[:src]} #{p[:dest]}:#{data.inspect}"]
+				rescue Exception => e
+					@logger.error "Migration failed #{e}\n#{e.backtrace.join("\n")}"
+				end
+				return [500, 'plain/text', e.to_s]
+			end
+
 			def manage_agents(p={})
 				begin
 					if p[:query].has_key?('agents')

data/lib/sfpagent/module.rb

@@ -2,6 +2,7 @@ require 'etc'
 require 'fileutils'
 
 module Sfp::Resource
+	attr_accessor :parent
 	attr_reader :state, :model
 
 	def init(model, default)
@@ -23,6 +24,10 @@ module Sfp::Resource
 
 	alias_method :reset, :to_model
 
+	def resolve(path)
+		Sfp::Agent.resolve(path.simplify)
+	end
+
 	protected
 	def exec_seq(*commands)
 		commands = [commands.to_s] if not commands.is_a?(Array)

data/lib/sfpagent/net_helper.rb

@@ -0,0 +1,56 @@
+require 'uri'
+require 'net/http'
+
+module Nuri::Net
+end
+
+module Nuri::Net::Helper
+	def http_request(uri, request, open_timeout=5, read_timeout=1800)
+		http = Net::HTTP.new(uri.host, uri.port)
+		http.open_timeout = open_timeout
+		http.read_timeout = read_timeout
+		http.start
+		http.request(request) { |res| return [res.code, res.body] }
+	end	
+
+	def post_data(address, port, path, data, open_timeout=5, read_timeout=1800)
+		address = address.to_s.strip
+		port = port.to_s.strip
+		path = path.to_s.strip
+		raise Exception, "Invalid parameters [address:#{address},port:#{port},path:#{path}]" if
+			address.length <= 0 or port.length <= 0 or path.length <= 0
+
+		path.sub!(/^\/+/, '')
+		url = URI.parse("http://#{address}:#{port}/#{path}")
+		req = Net::HTTP::Post.new(url.path)
+		req.set_form_data(data)
+		http_request(url, req, open_timeout, read_timeout)
+	end
+
+	def put_data(address, port, path, data, open_timeout=5, read_timeout=1800)
+		address = address.to_s.strip
+		port = port.to_s.strip
+		path = path.to_s.strip
+		raise Exception, "Invalid parameters [address:#{address},port:#{port},path:#{path}]" if
+			address.length <= 0 or port.length <= 0 or path.length <= 0
+
+		path.sub!(/^\/+/, '')
+		url = URI.parse("http://#{address}:#{port}/#{path}")
+		req = Net::HTTP::Put.new(url.path)
+		req.set_form_data(data)
+		http_request(url, req, open_timeout, read_timeout)
+	end
+
+	def get_data(address, port, path, open_timeout=5, read_timeout=1800)
+		address = address.to_s.strip
+		port = port.to_s.strip
+		path = path.to_s.strip
+		raise Exception, "Invalid parameters [address:#{address},port:#{port},path:#{path}]" if
+			address.length <= 0 or port.length <= 0 or path.length <= 0
+
+		path.sub!(/^\/+/, '')
+		url = URI.parse("http://#{address}:#{port}/#{path}")
+		req = Net::HTTP::Get.new(url.path)
+		http_request(url, req, open_timeout, read_timeout)
+	end
+end

data/lib/sfpagent/runtime.rb

@@ -1,7 +1,10 @@
 class Sfp::Runtime
+	attr_reader :modules
+
 	def initialize(parser)
 		@parser = parser
 		@root = @parser.root
+		@modules = nil
 	end
 
 	def execute_action(action)
@@ -11,7 +14,7 @@ class Sfp::Runtime
 			p
 		end
 
-		self.get_state if not defined? @modules
+		self.get_state if not defined?(@modules) or @modules.nil?
 
 		module_path, method_name = action['name'].pop_ref
 		mod = @modules.at?(module_path)[:_self]
@@ -23,20 +26,24 @@ class Sfp::Runtime
 	end
 
 	def get_state(as_sfp=false)
-		def cleanup(value)
-			#value.accept(SfpState.new)
-			#value
-			value.select { |k,v| k[0,1] != '_' and !(v.is_a?(Hash) and v['_context'] != 'object') }
-			#value.keys.each { |k| value[k] = cleanup(value[k]) if value[k].is_a?(Hash) }
+		def cleanup(model)
+			model.select { |k,v| k[0,1] != '_' and !(v.is_a?(Hash) and v['_context'] != 'object') }
+		end
+
+		def add_hidden_attributes(model, state)
+			model.each { |k,v|
+				state[k] = v if (k[0,1] == '_' and k != '_parent') or
+					(v.is_a?(Hash) and v['_context'] == 'procedure')
+			}
 		end
 
 		# Load the implementation of an object, and return its current state
-		# @param value a Hash
+		# @param model a Hash
 		# @return a Hash which is the state of the object
 		#
-		def get_module_state(value, root, as_sfp=false)
+		def instantiate_module(model, root, as_sfp=false)
 			# extract class name
-			class_name = value['_isa'].sub(/^\$\./, '') # [2, value['_isa'].length]
+			class_name = model['_isa'].sub(/^\$\./, '')
 
 			# throw an exception if schema's implementation is not exist!
 			raise Exception, "Implementation of schema #{class_name} is not available!" if
@@ -44,45 +51,55 @@ class Sfp::Runtime
 
 			# create an instance of the schema
 			mod = Sfp::Module::const_get(class_name).new
-			default = cleanup(root.at?(value['_isa']))
-			model = cleanup(value)
-			mod.init(model, default)
-
-			# update and get state
-			mod.update_state
-			state = mod.state
-
-			# insert all hidden attributes, except "_parent"
-			value.each do |k,v|
-				state[k] = v if (k[0,1] == '_' and k != '_parent') or
-					(v.is_a?(Hash) and v['_context'] == 'procedure')
-			end if as_sfp
-			[mod, state]
+			default = cleanup(root.at?(model['_isa']))
+			ruby_model = cleanup(model)
+			mod.init(ruby_model, default)
+			mod
 		end
 
 		# Return the state of an object
 		#
-		def get_object_state(value, root, as_sfp=false)
+		def get_object_state(model, root, as_sfp=false, path='$')
 			modules = {}
 			state = {}
-			if value['_context'] == 'object' and value['_isa'].to_s.isref
-				if value['_isa'] != '$.Object'
-					# if this value is an instance of a subclass of Object, then
+			if model['_context'] == 'object' and model['_isa'].to_s.isref
+				if model['_isa'] != '$.Object'
+					# if this model is an instance of a subclass of Object, then
 					# get the current state of this object
-					modules[:_self], state = get_module_state(value, root, as_sfp)
+					#modules[:_self] = nil
+					mod = (!defined?(@modules) or @modules.nil? ? nil : @modules.at?(path))
+					if mod.is_a?(Hash)
+						modules[:_self] = mod[:_self]
+					else
+						# the module has not been instantiated yet!
+						modules[:_self] = instantiate_module(model, root, as_sfp)
+					end
+					# update and get the state
+					modules[:_self].update_state
+					state = modules[:_self].state
+					if !mod.nil? and mod.has_key?(:_vars)
+						state.keep_if { |k,v| mod[:_vars].index(k) }
+						modules[:_vars] = mod[:_vars]
+					else
+						modules[:_vars] = state.keys
+					end
+					# set hidden attributes
+					add_hidden_attributes(model, state) if as_sfp
 				end
 			end
 
 			# get the state for each attributes which are not covered by this
 			# object's module
-			(value.keys - state.keys).each { |key|
+			(model.keys - state.keys).each do |key|
 				next if key[0,1] == '_'
-				if value[key].is_a?(Hash)
-					modules[key], state[key] = get_object_state(value[key], root, as_sfp) if value[key]['_context'] == 'object'
+				if model[key].is_a?(Hash)
+					modules[key], state[key] = get_object_state(model[key], root, as_sfp, path.push(key)) if
+						model[key]['_context'] == 'object'
+					modules[key]['_parent'] = modules if modules[key].is_a?(Hash)
 				else
 					state[key] = Sfp::Undefined.new
 				end
-			}
+			end
 
 			[modules, state]
 		end
@@ -91,6 +108,8 @@ class Sfp::Runtime
 		root.accept(Sfp::Visitor::ParentEliminator.new)
 		@modules, state = get_object_state(root, root, as_sfp)
 
+		@modules.accept(ParentGenerator)
+
 		state
 	end
 
@@ -112,6 +131,12 @@ class Sfp::Runtime
 		end
 	end
 
+	ParentGenerator = Object.new
+	def ParentGenerator.visit(name, value, parent)
+		value['_parent'] = parent if value.is_a?(Hash)
+		true
+	end
+
 	def execute_sequential_plan(plan)
 		puts 'Execute a sequential plan...'
 
@@ -127,120 +152,3 @@ class Sfp::Runtime
 		true
 	end
 end
-
-=begin
-		def execute(plan)
-			plan = JSON.parse(plan)
-			if plan['type'] == 'sequential'
-				execute_sequential(plan)
-			else
-				execute_parallel(plan)
-			end
-		end
-
-
-		def execute_sequential(plan)
-			puts 'Execute a sequential plan...'
-
-			plan['workflow'].each_index { |index|
-				action = plan['workflow'][index]
-				print "#{index+1}) #{action['name']} "
-
-				module_path, method_name = action['name'].pop_ref
-				mod = @modules.at?(module_path)[:_self]
-				raise Exception, "Cannot execute #{action['name']}!" if not mod.respond_to?(method_name)
-				if not mod.send method_name.to_sym, normalise_parameters(action['parameters'])
-					puts '[Failed]'
-					return false
-				end
-
-				puts '[OK]'
-			}
-			true
-		end
-
-		def execute_parallel(plan)
-			# TODO
-			puts 'Execute a parallel plan...'
-			false
-		end
-=end
-
-=begin
-		def plan
-			# generate initial state
-			task = { 'initial' => Sfp::Helper.to_state('initial', self.get_state(true)) }
-
-			# add schemas
-			@root.each { |k,v|
-				next if !v.is_a?(Hash) or v['_context'] != 'class'
-				task[k] = v
-			}
-
-			# add goal constraint
-			model = @root.select { |k,v| v.is_a?(Hash) and v['_context'] == 'object' }
-			goalgen = Sfp::Helper::GoalGenerator.new
-			model.accept(goalgen)
-			task['goal'] = goalgen.results
-
-			# remove old parent links
-			task.accept(Sfp::Visitor::ParentEliminator.new)
-
-			# reconstruct Sfp parent links
-			task.accept(Sfp::Visitor::SfpGenerator.new(task))
-
-			# solve and return the plan solution
-			planner = Sfp::Planner.new
-			planner.solve({:sfp => task, :pretty_json => true})
-		end
-=end
-
-
-
-=begin
-	module Helper
-		def self.create_object(name)
-			{ '_self' => name, '_context' => 'object', '_isa' => '$.Object', '_classes' => ['$.Object'] }
-		end
-
-		def self.create_state(name)
-			{ '_self' => name, '_context' => 'state' }
-		end
-
-		def self.to_state(name, value)
-			raise Exception, 'Given value should be a Hash!' if not value.is_a?(Hash)
-			value['_self'] = name
-			value['_context'] = 'state'
-			value
-		end
-
-		module Constraint
-			def self.equals(value)
-				{ '_context' => 'constraint', '_type' => 'equals', '_value' => value }
-			end
-
-			def self.and(name)
-				{ '_context' => 'constraint', '_type' => 'and', '_self' => name }
-			end
-		end
-
-		class GoalGenerator
-			attr_reader :results
-
-			def initialize
-				@results = Sfp::Helper::Constraint.and('goal')
-			end
-				
-			def visit(name, value, parent)
-				return false if name[0,1] == '_'
-				if value.is_a?(Hash)
-					return true if value['_context'] == 'object'
-					return false
-				end
-
-				@results[ parent.ref.push(name) ] = Sfp::Helper::Constraint.equals(value)
-				false
-			end
-		end
-	end
-=end

data/lib/sfpagent.rb

@@ -3,12 +3,14 @@ require 'rubygems'
 require 'json'
 require 'sfp'
 
+module Nuri
+end
+
 # internal dependencies
 libdir = File.expand_path(File.dirname(__FILE__))
 
+require libdir + '/sfpagent/net_helper.rb'
 require libdir + '/sfpagent/executor.rb'
-
 require libdir + '/sfpagent/runtime.rb'
 require libdir + '/sfpagent/module.rb'
-
 require libdir + '/sfpagent/agent.rb'

data/sfpagent.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
 	s.name			= 'sfpagent'
-	s.version		= '0.1.0'
+	s.version		= '0.1.1'
 	s.date			= '2013-07-03'
 	s.summary		= 'SFP Agent'
 	s.description	= 'A Ruby implementation of SFP agent.'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sfpagent
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2013-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sfp
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &17002580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,12 +21,7 @@ dependencies:
         version: 0.3.0
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 0.3.0
+  version_requirements: *17002580
 description: A Ruby implementation of SFP agent.
 email: herry13@gmail.com
 executables:
@@ -43,6 +38,7 @@ files:
 - lib/sfpagent/agent.rb
 - lib/sfpagent/executor.rb
 - lib/sfpagent/module.rb
+- lib/sfpagent/net_helper.rb
 - lib/sfpagent/runtime.rb
 - sfpagent.gemspec
 homepage: https://github.com/herry13/sfpagent
@@ -66,7 +62,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: sfpagent
-rubygems_version: 1.8.23
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: SFP Agent