sfpagent 0.1.12 → 0.1.13

data/README.md

@@ -23,7 +23,7 @@ Requirements
 To install
 ----------
 
-	$ apt-get install git make gcc ruby1.9.1 ruby1.9.1-dev libz-dev libaugeas-ruby1.9.1 libxml2-dev libxslt-dev
+	$ apt-get install ruby1.9.1 ruby1.9.1-dev libz-dev libaugeas-ruby1.9.1
 	$ gem install sfpagent
 
 

data/VERSION

@@ -1 +1 @@
-0.1.12
+0.1.13

data/bin/sfpagent

@@ -14,14 +14,14 @@ Usage:
 where [options] are:
 EOS
 
-	opt :start, "Start the agent. If --daemon option is set true, then the agent will start as a daemon."
-	opt :stop, "Stop the daemon agent."
-	opt :restart, "Restart the daemon agent."
-	opt :status, "Print the status of the daemon agent."
+	opt :start, "Start the agent. If --daemon option is set true, then the agent will start as a daemon.", :short => '-s'
+	opt :stop, "Stop the daemon agent.", :short => '-t'
+	opt :restart, "Restart the daemon agent.", :short => '-r'
+	opt :status, "Print the status of the daemon agent.", :short => '-a'
 	opt :port, "Port number of the daemon agent should listen to.", :short => '-p', :default => Sfp::Agent::DefaultPort
-	opt :state, "Given a model, print the state of all modules. (Note: [model-file] should be specified.)"
-	opt :execute, "Given a model, execute a plan in given file. (Note: [model-file] should be specified.)"
-	opt :pretty, "Print the result in a pretty JSON format.", :short => '-r'
+	#opt :state, "Given a model, print the state of all modules. (Note: [model-file] should be specified.)"
+	#opt :execute, "Given a model, execute a plan in given file. (Note: [model-file] should be specified.)"
+	#opt :pretty, "Print the result in a pretty JSON format.", :short => '-r'
 	#opt :daemon, "Start the agent as a daemon.", :default => true
 	opt :ssl, "Set the agent to use HTTPS instead of HTTP.", :default => false
 	opt :certfile, "Certificate file for HTTPS.", :default => ''

data/lib/sfpagent/agent.rb

@@ -40,6 +40,9 @@ module Sfp
 
 		@@runtime_lock = Mutex.new
 
+		@@agents_database = nil
+		@@agents_database_modified_time = nil
+
 		def self.logger
 			@@logger
 		end
@@ -47,13 +50,16 @@ module Sfp
 		# Start the agent.
 		#
 		# options:
-		#	:daemon => true if running as a daemon, false if as a normal application
-		#	:port
-		#	:ssl
-		#	:certfile
-		#	:keyfile
+		#	:daemon   => true if running as a daemon, false if as a console application
+		#	:port     => port of web server will listen to
+		#	:ssl      => set true to enable HTTPS
+		#	:certfile => certificate file path for HTTPS
+		#	:keyfile  => key file path for HTTPS
 		#
 		def self.start(p={})
+			Sfp::Agent.logger.info "Starting SFP Agent daemons..."
+			puts "Starting SFP Agent daemons..."
+
 			Process.daemon
 
 			begin
@@ -66,10 +72,10 @@ module Sfp
 				load_modules(p)
 
 				# reload model
-				build_model({:complete => true})
+				update_model({:rebuild => true})
 
 				# create web server
-				server_type = (p[:daemon] ? WEBrick::Daemon : WEBrick::SimpleServer)
+				server_type = WEBrick::SimpleServer
 				port = (p[:port] ? p[:port] : DefaultPort)
 				config = { :Host => '0.0.0.0',
 				           :Port => port,
@@ -89,35 +95,16 @@ module Sfp
 				# trap signal
 				['INT', 'KILL', 'HUP'].each { |signal|
 					trap(signal) {
-						Sfp::Agent.logger.info "Shutting down web server"
-						bsig_engine.disable
+						Sfp::Agent.logger.info "Shutting down web server and BSig engine..."
+						bsig_engine.stop
 						server.shutdown
 					}
 				}
 
-				# send request to local web server to save its PID
-				fork {
-					sleep 0.5
-					1.upto(5) do |i|
-						begin
-							NetHelper.get_data('127.0.0.1', config[:Port], '/pid')
-							break if File.exist?(PIDFile)
-						rescue
-							sleep (i*i)
-						end
-					end
-					puts "SFP Agent is running with PID #{File.read(PIDFile)}" if File.exist?(PIDFile)
-				}
-
-				# start BSig's main thread in a separate process
-				fork {
-					bsig_engine.enable({:mode => :main})
-				}
+				File.open(PIDFile, 'w', 0644) { |f| f.write($$.to_s) }
 
-				# enable BSig's satisfier
-				bsig_engine.enable({:mode => :satisfier})
+				bsig_engine.start
 
-				# start web server
 				server.start
 
 			rescue Exception => e
@@ -129,54 +116,36 @@ module Sfp
 		# Stop the agent's daemon.
 		#
 		def self.stop
-			# stopping web server (main thread)
-			pid = (File.exist?(PIDFile) ? File.read(PIDFile).to_i : nil)
-			if not pid.nil? and `ps h #{pid}`.strip =~ /.*sfpagent.*/
-				Process.kill('HUP', pid)
-				puts "Stopping SFP Agent with PID #{pid}"
-				File.delete(PIDFile) if File.exist?(PIDFile)
-			else
-				puts "SFP Agent is not running."
-			end
+			begin
+				pid = File.read(PIDFile).to_i
+				puts "Stopping SFP Agent with PID #{pid}..."
+				Process.kill 'HUP', pid
 
-			# stopping BSig engine
-			pid_bsig = (File.exist?(BSigPIDFile) ? File.read(BSigPIDFile).to_i : nil)
-			if not pid_bsig.nil? and `ps h #{pid_bsig}`.strip =~ /.*sfpagent.*/
-				Process.kill('HUP', pid_bsig)
-				puts "Stopping BSig engine with PID #{pid_bsig}"
-				File.delete(BSigPIDFile) if File.exist?(BSigPIDFile)
-			else
-				puts "BSig engine is not running."
+				sleep (Sfp::BSig::SleepTime + 0.25)
+
+				# forcely kill the process if it is still running
+				system("kill -9 #{pid} 1>/dev/null 2>/dev/null")
+
+				Sfp::Agent.logger.info "SFP Agent daemon has stopped."
+				puts "SFP Agent daemon has stopped."
+			rescue
+				puts "SFP Agent is not running."
 			end
 
-			Sfp::Agent.logger.info "SFP Agent daemon has been stopped."
+		ensure
+			File.delete(PIDFile) if File.exist?(PIDFile)
 		end
 
 		# Print the status of the agent.
 		#
 		def self.status
-			if not File.exist?(PIDFile)
-				puts "SFP Agent is not running."
-			else
+			begin
 				pid = File.read(PIDFile).to_i
-				if `ps hf #{pid}`.strip =~ /.*sfpagent.*/
-					puts "SFP Agent is running with PID #{pid}"
-				else
-					File.delete(PIDFile)
-					puts "SFP Agent is not running."
-				end
-			end
-
-			if not File.exist?(BSigPIDFile)
-				puts "BSig engine is not running."
-			else
-				pid = File.read(BSigPIDFile).to_i
-				if `ps hf #{pid}`.strip =~ /.*sfpagent.*/
-					puts "BSig engine is running with PID #{pid}"
-				else
-					File.delete(BSigPIDFile)
-					puts "BSig engine is not running."
-				end
+				Process.kill 0, pid
+				puts "SFP Agent is running with PID #{pid}"
+			rescue
+				puts "SFP Agent is not running."
+				File.delete(PIDFile) if File.exist?(PIDFile)
 			end
 		end
 
@@ -198,10 +167,8 @@ module Sfp
 						f.flush
 						f.truncate(f.pos)
 					}
-					build_model
+					update_model
 					Sfp::Agent.logger.info "Setting the model [OK]"
-				else
-					#Sfp::Agent.logger.info "The model is not changed."
 				end
 				return true
 			rescue Exception => e
@@ -212,7 +179,7 @@ module Sfp
 
 		# Reload the model from cached file.
 		#
-		def self.build_model(p={})
+		def self.update_model(p={})
 			if not File.exist?(ModelFile)
 				Sfp::Agent.logger.info "There is no model in cache."
 			else
@@ -220,7 +187,7 @@ module Sfp
 					@@runtime_lock.synchronize {
 						data = File.read(ModelFile)
 						@@current_model_hash = Digest::MD5.hexdigest(data)
-						if !defined?(@@runtime) or @@runtime.nil? or p[:complete]
+						if !defined?(@@runtime) or @@runtime.nil? or p[:rebuild]
 							@@runtime = Sfp::Runtime.new(JSON[data])
 						else
 							@@runtime.set_model(JSON[data])
@@ -363,7 +330,7 @@ module Sfp
 					module_file = "#{dir}/#{name}/#{name}.rb"
 					next if not File.exist?(module_file)
 					begin
-						load module_file #require module_file
+						load module_file # use 'load' than 'require'
 						Sfp::Agent.logger.info "Loading module #{dir}/#{name} [OK]"
 						counter += 1
 						@@modules << name
@@ -458,7 +425,7 @@ module Sfp
 			load_modules(@@config)
 			
 			# rebuild the model
-			build_model({:complete => true})
+			update_model({:rebuild => true})
 
 			Sfp::Agent.logger.info "Installing module #{name} [OK]"
 
@@ -493,15 +460,13 @@ module Sfp
 			true
 		end
 
-		@@agents_data = nil
-		@@agents_data_modified_time = nil
 		def self.get_agents
 			return {} if not File.exist?(AgentsDataFile)
-			return @@agents_data if File.mtime(AgentsDataFile) == @@agents_data_modified_time
-			@@agents_data = JSON[File.read(AgentsDataFile)]
+			return @@agents_database if File.mtime(AgentsDataFile) == @@agents_database_modified_time
+			@@agents_database = JSON[File.read(AgentsDataFile)]
 		end
 
-		# A class that handles each request.
+		# A class that handles HTTP request.
 		#
 		class Handler < WEBrick::HTTPServlet::AbstractServlet
 			def initialize(server, logger)
@@ -511,11 +476,13 @@ module Sfp
 			# Process HTTP Get request
 			#
 			# uri:
-			#	/pid => save daemon's PID to a file
-			#	/state => return the current state
-			#	/model => return the current model
+			#	/pid      => save daemon's PID to a file (only requested from localhost)
+			#	/state    => return the current state
+			#	/model    => return the current model
 			#	/schemata => return the schemata of a module
-			#	/modules => return a list of available modules
+			#	/modules  => return a list of available modules
+			#  /agents   => return a list of agents database
+			#  /log      => return last 100 lines of log file
 			#
 			def do_GET(request, response)
 				status = 400
@@ -587,12 +554,17 @@ module Sfp
 				response.body = body
 			end
 
+			# Handle HTTP Put request
+			#
 			# uri:
-			#	/model => receive a new model and save to cached file
-			#	/modules => save the module if parameter "module" is provided
-			#               delete the module if parameter "module" is not provided
-			#	/agents => save the agents' list if parameter "agents" is provided
-			#	           delete all agents if parameter "agents" is not provided
+			#	/model          => receive a new model and save to cached file
+			#	/modules        => save the module if parameter "module" is provided
+			#                     delete the module if parameter "module" is not provided
+			#	/agents         => save the agents' list if parameter "agents" is provided
+			#	                   delete all agents if parameter "agents" is not provided
+			#  /bsig           => receive BSig model and receive it in cached directory
+			#  /bsig/satisfier => receive goal request from other agents and then start
+			#                     a satisfier thread to try to achieve it
 			def do_PUT(request, response)
 				status = 400
 				content_type, body = ''

data/lib/sfpagent/bsig.rb

@@ -3,69 +3,55 @@ require 'thread'
 class Sfp::BSig
 	include Nuri::Net::Helper
 
-	BSigSleepTime = 5
+	SleepTime = 5
 	MaxTries = 5
 
 	SatisfierPath = '/bsig/satisfier'
 	CachedDir = (Process.euid == 0 ? '/var/sfpagent' : File.expand_path('~/.sfpagent'))
 	SatisfierLockFile = "#{CachedDir}/bsig.satisfier.lock.#{Time.now.nsec}"
 
-	attr_reader :enabled, :mode
+	attr_reader :enabled, :status, :mode
 
 	def initialize(p={})
 		@lock = Mutex.new
 		@enabled = false
+		@status = :stopped
 	end
 
-	def disable
+	def stop
 		@enabled = false
 	end
 
-	def enable(p={})
+	def start
+		@enabled = true
 		@lock.synchronize {
-			return if @enabled
-			@enabled = true
+			return if @status == :running
+			@status = :running
 		}
 
-		@mode = p[:mode]
-		if p[:mode] == :main
-			enable_main_thread
-		elsif p[:mode] == :satisfier
-			enable_satisfier_thread
-		end
-	end
-
-	def enable_satisfier_thread
-		Sfp::Agent.logger.info "[#{@mode}] BSig engine is enabled."
-	end
+		Thread.new {
+			register_satisfier_thread(:reset)
+	
+			system("rm -f #{CachedDir}/operator.*.lock")
+	
+			Sfp::Agent.logger.info "[main] BSig engine is running."
+	
+			puts "BSig Engine is running with PID #{$$}"
+			File.open(Sfp::Agent::BSigPIDFile, 'w') { |f| f.write($$.to_s) }
+	
+			self.execute_model
+	
+			File.delete(SatisfierLockFile) if File.exist?(SatisfierLockFile)
+			Sfp::Agent.logger.info "[main] BSig engine has stopped."
 
-	def enable_main_thread
-		['INT', 'KILL', 'HUP'].each { |signal|
-			trap(signal) {
-				Sfp::Agent.logger.info "[#{@mode}] Shutting down BSig engine"
-				disable
-			}
+			@status = :stopped
 		}
-
-		register_satisfier_thread(:reset)
-
-		system("rm -f #{CachedDir}/operator.*.lock")
-
-		Sfp::Agent.logger.info "[#{@mode}] BSig engine is running."
-
-		puts "BSig Engine is running with PID #{$$}"
-		File.open(Sfp::Agent::BSigPIDFile, 'w') { |f| f.write($$.to_s) }
-
-		self.execute_model
-
-		File.delete(SatisfierLockFile) if File.exist?(SatisfierLockFile)
-		Sfp::Agent.logger.info "[#{@mode}] BSig engine has stopped."
 	end
 
 	def execute_model
-		Sfp::Agent.logger.info "[#{@mode}] Executing BSig model"
+		Sfp::Agent.logger.info "[main] Executing BSig model"
 
-		previous_status = nil
+		previous_exec_status = exec_status = nil
 		while @enabled
 			begin
 	
@@ -73,25 +59,25 @@ class Sfp::BSig
 	
 				bsig = Sfp::Agent.get_bsig
 				if bsig.nil?
-					status = :no_bsig
-					sleep BSigSleepTime
+					exec_status = :no_bsig
+					sleep SleepTime
 				else
-					status = achieve_local_goal(bsig['id'], bsig['goal'], bsig['operators'], 1)
-					if status == :failure
-						Sfp::Agent.logger.error "[#{@mode}] Executing BSig model [Failed]"
-						sleep BSigSleepTime
-					elsif status == :no_flaw
-						sleep BSigSleepTime
+					exec_status = achieve_local_goal(bsig['id'], bsig['goal'], bsig['operators'], 1, :main)
+					if exec_status == :failure
+						Sfp::Agent.logger.error "[main] Executing BSig model [Failed]"
+						sleep SleepTime
+					elsif exec_status == :no_flaw
+						sleep SleepTime
 					end
 				end
 
-				if previous_status != status
-					Sfp::Agent.logger.info "[#{@mode}] BSig engine - status: " + status.to_s
-					previous_status = status
+				if previous_exec_status != exec_status
+					Sfp::Agent.logger.info "[main] BSig engine - status: " + exec_status.to_s
+					previous_exec_status = exec_status
 				end
 			rescue Exception => e
-				Sfp::Agent.logger.error "[#{@mode}] Error on executing BSig model\n#{e}\n#{e.backtrace.join("\n")}"
-				sleep BSigSleepTime
+				Sfp::Agent.logger.error "[main] Error on executing BSig model\n#{e}\n#{e.backtrace.join("\n")}"
+				sleep SleepTime
 			end
 		end
 	end
@@ -106,11 +92,12 @@ class Sfp::BSig
 	end
 
 	# returns
-	# :no_flaw   : there is no goal-flaw
-	# :failure   : there is a failure on achieving the goal
-	# :ongoing   : the selected operator is being executed
-	# :repaired  : some goal-flaws have been repaired, but the goal may have other flaws
-	def achieve_local_goal(id, goal, operators, pi)
+	#   :no_flaw  => there is no goal-flaw
+	#   :failure  => there is a failure on achieving the goal
+	#   :ongoing  => the selected operator is being executed
+	#   :repaired => some goal-flaws have been repaired, but the goal may have other flaws
+	#
+	def achieve_local_goal(id, goal, operators, pi, mode)
 		operator = nil
 
 		current = get_current_state
@@ -120,25 +107,25 @@ class Sfp::BSig
 		operator = select_operator(flaws, operators, pi)
 		return :failure if operator.nil?
 
-#Sfp::Agent.logger.info "[#{@mode}] Flaws: #{JSON.generate(flaws)}"
+#Sfp::Agent.logger.info "[#{mode}] Flaws: #{JSON.generate(flaws)}"  # debugging
 
 		return :ongoing if not lock_operator(operator)
 
-		Sfp::Agent.logger.info "[#{@mode}] Selected operator: #{operator['name']}"
+		Sfp::Agent.logger.info "[#{mode}] Selected operator: #{operator['name']}"
 
 		next_pi = operator['pi'] + 1
 		pre_local, pre_remote = split_preconditions(operator)
 
-#Sfp::Agent.logger.info "[#{@mode}] local-flaws: #{JSON.generate(pre_local)}, remote-flaws: #{JSON.generate(pre_remote)}"
+#Sfp::Agent.logger.info "[#{mode}] local-flaws: #{JSON.generate(pre_local)}, remote-flaws: #{JSON.generate(pre_remote)}"  # debugging
 
 		status = nil
 		tries = MaxTries
 		begin
-			status = achieve_local_goal(id, pre_local, operators, next_pi)
+			status = achieve_local_goal(id, pre_local, operators, next_pi, mode)
 			if status == :no_flaw or status == :failure or not @enabled
 				break
 			elsif status == :ongoing
-				sleep BSigSleepTime
+				sleep SleepTime
 				tries += 1
 			elsif status == :repaired
 				tries = MaxTries
@@ -147,8 +134,8 @@ class Sfp::BSig
 		end until tries <= 0
 
 		if status != :no_flaw or
-			not achieve_remote_goal(id, pre_remote, next_pi) or
-			not invoke(operator)
+			not achieve_remote_goal(id, pre_remote, next_pi, mode) or
+			not invoke(operator, mode)
 
 			unlock_operator(operator) if not operator.nil?
 			return :failure
@@ -158,13 +145,13 @@ class Sfp::BSig
 		:repaired
 	end
 
-	def achieve_remote_goal(id, goal, pi)
+	def achieve_remote_goal(id, goal, pi, mode)
 		if goal.length > 0
 			agents = Sfp::Agent.get_agents
 			split_goal_by_agent(goal).each do |agent_name,agent_goal|
 				return false if not agents.has_key?(agent_name) or agents[agent_name]['sfpAddress'].to_s == ''
 
-				return false if not send_goal_to_agent(agents[agent_name], id, agent_goal, pi, agent_name)
+				return false if not send_goal_to_agent(agents[agent_name], id, agent_goal, pi, agent_name, mode)
 			end
 		end
 		true
@@ -182,11 +169,11 @@ class Sfp::BSig
 		status = nil
 		tries = MaxTries
 		begin
-			status = achieve_local_goal(bsig['id'], goal, bsig['operators'], pi)
+			status = achieve_local_goal(bsig['id'], goal, bsig['operators'], pi, :satisfier)
 			if status == :no_flaw or status == :failure or not @enabled
 				break
 			elsif status == :ongoing
-				sleep BSigSleepTime
+				sleep SleepTime
 				tries += 1
 			elsif status == :repaired
 				tries = MaxTries
@@ -251,15 +238,16 @@ class Sfp::BSig
 		agent_goal
 	end
 
-	def send_goal_to_agent(agent, id, g, pi, agent_name='')
+	def send_goal_to_agent(agent, id, g, pi, agent_name='', mode)
 		data = {'id' => id,
 		        'goal' => JSON.generate(g),
 		        'pi' => pi}
-Sfp::Agent.logger.info "[#{@mode}] Request goal to: #{agent_name} [WAIT]"
+
+		Sfp::Agent.logger.info "[#{mode}] Request goal to: #{agent_name} [WAIT]"
 
 		code, _ = put_data(agent['sfpAddress'], agent['sfpPort'], SatisfierPath, data)
 
-Sfp::Agent.logger.info "[#{@mode}] Request goal to: #{agent_name} - status: " + code.to_s
+		Sfp::Agent.logger.info "[#{mode}] Request goal to: #{agent_name} - status: #{code}"
 
 		(code == '200')
 	end
@@ -322,8 +310,8 @@ Sfp::Agent.logger.info "[#{@mode}] Request goal to: #{agent_name} - status: " +
 		[local, remote]
 	end
 
-	def invoke(operator)
-		Sfp::Agent.logger.info "[#{@mode}] Invoking #{operator['name']}"
+	def invoke(operator, mode)
+		Sfp::Agent.logger.info "[#{mode}] Invoking #{operator['name']}"
 		Sfp::Agent.execute_action(operator)
 	end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sfpagent
 version: !ruby/object:Gem::Version
-  version: 0.1.12
+  version: 0.1.13
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2013-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sfp
-  requirement: &10824140 !ruby/object:Gem::Requirement
+  requirement: &6605340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,7 +21,7 @@ dependencies:
         version: 0.3.12
   type: :runtime
   prerelease: false
-  version_requirements: *10824140
+  version_requirements: *6605340
 description: A Ruby implementation of SFP agent.
 email: herry13@gmail.com
 executables: