sfpagent 0.3.10 → 0.4.0

data/.travis.yml

@@ -25,5 +25,5 @@ matrix:
     - rvm: jruby-19mode
       gemfile: Gemfile.1.8.7
 
-notification:
+notifications:
   - email: false

data/VERSION

@@ -1 +1 @@
-0.3.10
+0.4.0

data/bin/sfpagent

@@ -9,7 +9,7 @@ end
 opts = Trollop::options do
 	version "sfpagent #{version?} (c) 2013 Herry"
 	banner <<-EOS
-SFP Agent that provides a Ruby framework for managing system configurations. The configurations are modelled in SFP language.
+Agent for Nuri configuration management tool.
 
 Usage:
        sfpagent [options] [model-file] [plan-file]
@@ -20,12 +20,14 @@ EOS
 	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 :no_daemon, "start agent non-daemon process", :default => false
 	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 :ssl, "Set the agent to use HTTPS instead of HTTP.", :default => false
 	opt :certfile, "Certificate file for HTTPS.", :default => ''
 	opt :keyfile, "Private key file for HTTPS.", :default => ''
 	opt :modules_dir, "A directory that holds all SFP modules.", :default => ''
+	opt :resolve, "get current state of given reference", :default => ''
 end
 
 def parse(filepath)
@@ -54,6 +56,11 @@ elsif opts[:restart]
 	Sfp::Agent.stop if Sfp::Agent.pid.to_i > 0
 	Sfp::Agent.start(opts)
 
+elsif opts[:no_daemon]
+puts "no-daemon"
+	opts[:daemon] = false
+	Sfp::Agent.start(opts)
+
 elsif opts[:status]
 	Sfp::Agent.status
 
@@ -80,6 +87,15 @@ elsif opts[:execute]
 	runtime.get_state
 	puts (runtime.execute_plan(File.read(plan_file)) ? "Success!" : "Failed!")
 
+elsif opts[:resolve].to_s.strip.length > 0
+	path = opts[:resolve].to_s.strip.sub(/^\$\./, '').gsub(/\./, '/')
+	path = "/state/" + path
+	http = Object.new.extend(Sfp::Helper::Net)
+	code, state = http.get_data('localhost', Sfp::Agent::DefaultPort, path)
+	if code == '200'
+		puts state
+	end
+
 else
 	Trollop::help
 

data/lib/sfpagent/agent.rb

@@ -13,21 +13,21 @@ module Sfp
 	module Agent
 		NetHelper = Object.new.extend(Sfp::Helper::Net)
 
-		CacheDir = (Process.euid == 0 ? '/var/sfpagent' : File.expand_path(Dir.home + '/.sfpagent'))
-		Dir.mkdir(CacheDir, 0700) if not File.exist?(CacheDir)
+		Home = ((Process.euid == 0 and File.directory?('/var')) ? '/var/sfpagent' : File.expand_path(Dir.home + '/.sfpagent'))
+		Dir.mkdir(Home, 0700) if not File.exist?(Home)
 
 		DefaultPort = 1314
 
-		PIDFile = "#{CacheDir}/sfpagent.pid"
-		LogFile = "#{CacheDir}/sfpagent.log"
-		ModelFile = "#{CacheDir}/sfpagent.model"
-		AgentsDataFile = "#{CacheDir}/sfpagent.agents"
+		PIDFile = "#{Home}/sfpagent.pid"
+		LogFile = "#{Home}/sfpagent.log"
+		ModelFile = "#{Home}/sfpagent.model"
+		AgentsDataFile = "#{Home}/sfpagent.agents"
 
-		CacheModelFile = "#{CacheDir}/cache.model"
+		CacheModelFile = "#{Home}/cache.model"
 
-		BSigFile = "#{CacheDir}/bsig.model"
-		BSigPIDFile = "#{CacheDir}/bsig.pid"
-		BSigThreadsLockFile = "#{CacheDir}/bsig.threads.lock.#{Time.now.to_i}"
+		BSigFile = "#{Home}/bsig.model"
+		BSigPIDFile = "#{Home}/bsig.pid"
+		BSigThreadsLockFile = "#{Home}/bsig.threads.lock.#{Time.now.to_i}"
 
 		@@logger = WEBrick::Log.new(LogFile, WEBrick::BasicLog::INFO ||
 		                                     WEBrick::BasicLog::ERROR ||
@@ -78,7 +78,7 @@ module Sfp
 
 			begin
 				# check modules directory, and create it if it's not exist
-				opts[:modules_dir] = File.expand_path(opts[:modules_dir].to_s.strip != '' ? opts[:modules_dir].to_s : "#{CacheDir}/modules")
+				opts[:modules_dir] = File.expand_path(opts[:modules_dir].to_s.strip != '' ? opts[:modules_dir].to_s : "#{Home}/modules")
 				Dir.mkdir(opts[:modules_dir], 0700) if not File.exist?(opts[:modules_dir])
 
 				# load modules from cached directory
@@ -108,20 +108,22 @@ module Sfp
 				# create maintenance object
 				maintenance = Maintenance.new(opts)
 
-				# trap signal
-				['INT', 'KILL', 'HUP'].each { |signal|
-					trap(signal) {
-						maintenance.stop
-
-						Sfp::Agent.logger.info "Shutting down web server and BSig engine..."
-						bsig_engine.stop
-						loop do
-							break if bsig_engine.status == :stopped
-							sleep 1
-						end
-						server.shutdown
-					}
-				}
+				if not is_windows
+					# trap signal
+					['INT', 'KILL', 'HUP'].each do |signal|
+						trap(signal) {
+							maintenance.stop
+
+							Sfp::Agent.logger.info "Shutting down web server and BSig engine..."
+							bsig_engine.stop
+							loop do
+								break if bsig_engine.status == :stopped
+								sleep 1
+							end
+							server.shutdown
+						}
+					end
+				end
 
 				File.open(PIDFile, 'w', 0644) { |f| f.write($$.to_s) }
 
@@ -197,6 +199,10 @@ module Sfp
 			nil
 		end
 
+		def self.is_windows
+			(RbConfig::CONFIG['host_os'] =~ /mswin|mingw|cygwin/)
+		end
+		
 		def self.set_cache_model(p={})
 			File.open(CacheModelFile, File::RDWR|File::CREAT, 0600) do |f|
 				f.flock(File::LOCK_EX)
@@ -414,31 +420,51 @@ module Sfp
 			false
 		end
 
-		# Load all modules in given directory.
+		###############
+		#
+		# Load all modules in given agent's module directory.
 		#
 		# options:
-		#	:dir => directory that holds all modules
+		#	:dir => directory that contains all modules
 		#
+		###############
 		def self.load_modules(p={})
 			dir = p[:modules_dir]
 
-			@@modules = []
+			@@modules = {}
 			counter = 0
-			if dir != '' and File.exist?(dir)
+			if dir != '' and File.directory?(dir)
 				Sfp::Agent.logger.info "Modules directory: #{dir}"
-				Dir.entries(dir).each { |name|
-					next if name == '.' or name == '..' or File.file?("#{dir}/#{name}")
-					module_file = "#{dir}/#{name}/#{name}.rb"
-					next if not File.exist?(module_file)
-					begin
-						load module_file # use 'load' than 'require'
-						Sfp::Agent.logger.info "Loading module #{dir}/#{name} [OK]"
+				Dir.entries(dir).each do |name|
+					module_dir = "#{dir}/#{name}"
+					next if name == '.' or name == '..' or not File.directory?(module_dir)
+					module_file = "#{module_dir}/#{name}.rb"
+					if File.exist?(module_file)
+						begin
+							### use 'load' than 'require' to rewrite previous definitions
+							load module_file
+							Sfp::Agent.logger.info "Loading module #{module_dir} [OK]"
+							counter += 1
+							@@modules[name] = {
+								:type => :ruby,
+								:home => module_dir,
+								:hash => get_module_hash(name)
+							}
+						rescue Exception => e
+							Sfp::Agent.logger.warn "Loading module #{dir}/#{name} [Failed]\n#{e}"
+						end
+					elsif File.exist?("#{module_dir}/main")
+						Sfp::Agent.logger.info "Loading module #{module_dir} [OK]"
+						@@modules[name] = {
+							:type => :shell,
+							:home => module_dir,
+							:hash => get_module_hash(name)
+						}
 						counter += 1
-						@@modules << name
-					rescue Exception => e
-						Sfp::Agent.logger.warn "Loading module #{dir}/#{name} [Failed]\n#{e}"
+					else
+						logger.warn "Module #{module_dir} is invalid."
 					end
-				}
+				end
 			end
 			Sfp::Agent.logger.info "Successfully loading #{counter} modules."
 		end
@@ -467,27 +493,11 @@ module Sfp
 		end
 
 		def self.get_modules
-			return [] if not (defined? @@modules and @@modules.is_a? Array)
-			data = {}
-			@@modules.each { |m| data[m] = get_module_hash(m) }
-			data
-		end
-
-		# Push a list of modules to an agent using a script in $SFPAGENT_HOME/bin/install_module.
-		#
-		# parameters:
-		#   :address => address of target agent
-		#   :port    => port of target agent
-		#   :modules => an array of modules' name that will be pushed
-		#
-		def self.push_modules(p={})
-			fail "Incomplete parameters." if !p[:modules] or !p[:address] or !p[:port]
-
-			install_module = File.expand_path('../../../bin/install_module', __FILE__)
-			modules = p[:modules].join(' ')
-			cmd = "cd #{@@config[:modules_dir]}; #{install_module} #{p[:address]} #{p[:port]} #{modules}"
-			result = `#{cmd}`
-			(result =~ /status: ok/)
+			#return [] if not (defined? @@modules and @@modules.is_a?(Hash))
+			#data = {}
+			#@@modules.each_key { |m| data[m] = get_module_hash(m) }
+			#data
+			(defined?(@@modules) ? @@modules : {})
 		end
 
 		def self.uninstall_all_modules(p={})
@@ -662,14 +672,14 @@ module Sfp
 				@logger = logger
 			end
 
-			# Process HTTP Get request
+			# Process HTTP GET request
 			#
 			# uri:
-			#	/pid      => save daemon's PID to a file (only requested from localhost)
-			#	/state    => return the current state
-			#	/model    => return the current model
-			#	/sfp      => return the SFP description of a module
-			#	/modules  => return a list of available modules
+			#  /pid      => save daemon's PID to a file (only requested from localhost)
+			#  /state    => return the current state
+			#  /model    => return the current model
+			#  /sfp      => return the SFP description of a module
+			#  /modules  => return a list of available modules
 			#  /agents   => return a list of agents database
 			#  /log      => return last 100 lines of log file
 			#
@@ -708,7 +718,9 @@ module Sfp
 						status, content_type, body = get_sfp({:module => path[10, path.length-10]})
 
 					elsif path == '/modules'
-						status, content_type, body = [200, 'application/json', JSON.generate(Sfp::Agent.get_modules)]
+						mods = {}
+						Sfp::Agent.get_modules.each { |name,data| mods[name] = data[:hash] }
+						status, content_type, body = [200, 'application/json', JSON.generate(mods)]
 
 					elsif path == '/agents'
 						status, content_type, body = [200, 'application/JSON', JSON.generate(Sfp::Agent.get_agents)]
@@ -724,7 +736,7 @@ module Sfp
 				response.body = body
 			end
 
-			# Handle HTTP Post request
+			# Handle HTTP POST request
 			#
 			# uri:
 			#	/execute => receive an action's schema and execute it
@@ -746,16 +758,16 @@ module Sfp
 				response.body = body
 			end
 
-			# Handle HTTP Put request
+			# Handle HTTP PUT request
 			#
 			# uri:
-			#	/model          => receive a new model and then save it
+			#  /model          => receive a new model and then save it
 			#  /model/cache    => receive a "cache" model and then save it
-			#	/modules        => save the module if parameter "module" is provided
-			#	/agents         => save the agents' list if parameter "agents" is provided
+			#  /modules        => save the module if parameter "module" is provided
+			#  /agents         => save the agents' list if parameter "agents" is 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
+			#                     a satisfier thread in order to achieve it
 			#
 			def do_PUT(request, response)
 				status = 400
@@ -800,15 +812,15 @@ module Sfp
 				response.body = body
 			end
 
-			# Handle HTTP Delete request
+			# Handle HTTP DELETE request
 			#
 			# uri:
-			#	/model            => delete existing model
+			#  /model            => delete existing model
 			#  /model/cache      => delete all cache models
 			#  /model/cache/name => delete cache model of agent "name"
-			#	/modules          => delete all modules from module database
-			#	/modules/name     => delete module "name" from module database
-			#	/agents           => delete all agents from agent database
+			#  /modules          => delete all modules from module database
+			#  /modules/name     => delete module "name" from module database
+			#  /agents           => delete all agents from agent database
 			#  /agents/name      => delete "name" from agent database
 			#  /bsig             => delete existing BSig model
 			#

data/lib/sfpagent/bsig.rb

@@ -7,8 +7,8 @@ class Sfp::BSig
 	MaxTries = 5
 
 	SatisfierPath = '/bsig/satisfier'
-	CacheDir = (Process.euid == 0 ? '/var/sfpagent' : File.expand_path(Dir.home + '/.sfpagent'))
-	SatisfierLockFile = "#{CacheDir}/bsig.satisfier.lock.#{Time.now.to_i}"
+	Home = ((Process.euid == 0 and File.directory?('/var')) ? '/var/sfpagent' : File.expand_path(Dir.home + '/.sfpagent'))
+	SatisfierLockFile = "#{Home}/bsig.satisfier.lock.#{Time.now.to_i}"
 
 	attr_reader :enabled, :status, :mode
 
@@ -33,7 +33,7 @@ class Sfp::BSig
 		Thread.new {
 			register_satisfier_thread(:reset)
 	
-			system("rm -f #{CacheDir}/operator.*.lock")
+			system("rm -f #{Home}/operator.*.lock")
 	
 			Sfp::Agent.logger.info "[main] BSig engine is running."
 	
@@ -307,7 +307,7 @@ class Sfp::BSig
 
 	def lock_operator(operator)
 		@lock.synchronize {
-			operator_lock_file = "#{CacheDir}/operator.#{operator['id']}.#{operator['name']}.lock"
+			operator_lock_file = "#{Home}/operator.#{operator['id']}.#{operator['name']}.lock"
 			return false if File.exist?(operator_lock_file)
 			File.open(operator_lock_file, 'w') { |f| f.write('1') }
 			return true
@@ -316,7 +316,7 @@ class Sfp::BSig
 
 	def unlock_operator(operator)
 		@lock.synchronize {
-			operator_lock_file = "#{CacheDir}/operator.#{operator['id']}.#{operator['name']}.lock"
+			operator_lock_file = "#{Home}/operator.#{operator['id']}.#{operator['name']}.lock"
 			File.delete(operator_lock_file) if File.exist?(operator_lock_file)
 		}
 	end

data/lib/sfpagent/module.rb

@@ -1,10 +1,71 @@
+require 'yaml'
+require 'shellwords'
+
+module Sfp::Module
+end
+
+###############
+#
+# Module Sfp::Resource must be included by every module. It provides
+# standard methods which are used by Runtime engine in mapping between
+# SFP object and schema implementation.
+#
+# accessible attributes
+# - parent        : holds instance of parent's object
+#
+# - synchronized  : an list of SFP procedures that must be executed in
+#                   serial
+#
+# - path          : an absolute path of this instance
+#
+# read-only attributes
+# - state         : holds the current state of this module instance
+#
+# - model         : holds the model of desired state of this module
+#                   instance
+#
+# methods:
+# - init          : invoked by Runtime engine after instantiating this
+#                   module instance for initialization
+#
+# - update_state  : invoked by Runtime engine to request this module
+#                   instance to update the current state which should
+#                   be kept in attribute @state
+#
+# - to_model      : can be invoked by this module instance to set the
+#                   current state equals the desired state (model), or
+#                   in short: @state == @model
+#
+# - resolve_state : can be invoked by this module to resolve given
+#                   reference of current state either local or other
+#                   module instances
+#
+# - resolve       : an alias to method resolve_state
+#
+# - resolve_model : can be invoked by this module to resolve given
+#                   reference of desired state (model) either local or
+#                   other module instances
+#
+# - log           : return logger object
+#
+# - copy          : copy a file, whose path is the first parameter, to
+#                   a destination path given in the second parameter
 #
-# predefined methods: update_state, apply, reset, resolve, resolve_model, resolve_state
+# - render        : render given template file, whose path is the first
+#                   parameter, and the template's variable is a merged
+#                   between a Hash in the second parameter with model;
+#                   the result is returned as a string
 #
+# - render_file   : render given template file, whose path is the first
+#                   parameter, and the template's variable is a merged
+#                   between a Hash on the second parameter with model;
+#                   the result is written back to the file
+#
+###############
 module Sfp::Resource
 	@@resource = Object.new.extend(Sfp::Resource)
 
-	attr_accessor :parent, :synchronized
+	attr_accessor :parent, :synchronized, :path
 	attr_reader :state, :model
 
 	def init(model={})
@@ -99,5 +160,53 @@ module Sfp::Resource
 	end
 end
 
-module Sfp::Module
+class Sfp::Module::Shell
+	include Sfp::Resource
+
+	attr_reader :home, :main
+
+	def initialize(metadata)
+		### set module's home directory
+		@home = metadata[:home]
+
+		### set main shell command
+		@main = @home + '/main'
+	end
+
+	def update_state
+		@state = invoke({
+			:command => :state,
+			:model => @model,
+			:path => @path
+		})
+	end
+
+	def execute(name, parameters={})
+		result = invoke({
+			:command => :execute,
+			:procedure => name.split('.').last,
+			:parameters => parameters,
+			:model => @model,
+			:path => @path
+		})
+		if result['status'] != 'ok'
+			log.error "Error in executing #{name} - description: #{result['description']}"
+			false
+		else
+			true
+		end
+	end
+
+	private
+
+	def invoke(parameters)
+		log.info Shellwords.shellescape(JSON.generate(parameters))
+		begin
+			output = `#{@main} #{Shellwords.shellescape(JSON.generate(parameters))}`
+			JSON.parse(output)
+		rescue Exception => exp
+			log.info "Invalid module output: #{output}"
+			raise exp
+		end
+	end
 end

data/lib/sfpagent/runtime.rb

@@ -27,14 +27,27 @@ class Sfp::Runtime
 
 		module_path, method_name = action['name'].pop_ref
 		mod = @root.at?(module_path)[:_self]
-		raise Exception, "Module #{module_path} cannot be found!" if mod.nil?
-		raise Exception, "Cannot execute #{action['name']}!" if not mod.respond_to?(method_name)
 
-		params = normalise_parameters(action['parameters'])
-		if mod.synchronized.rindex(method_name)
-			@mutex_procedure.synchronize { mod.send method_name.to_sym, params }
+		if mod.nil?
+			raise Exception, "Module #{module_path} cannot be found!"
+
+		elsif mod.is_a?(Sfp::Module::Shell)
+			params = normalise_parameters(action['parameters'])
+			mod.execute method_name, params
+
+		elsif not mod.respond_to?(method_name)
+			raise Exception, "Cannot execute #{action['name']}!"
+
 		else
-			mod.send method_name.to_sym, params
+			params = normalise_parameters(action['parameters'])
+			if mod.synchronized.rindex(method_name)
+				@mutex_procedure.synchronize {
+					mod.send method_name.to_sym, params
+				}
+			else
+				mod.send method_name.to_sym, params
+			end
+
 		end
 
 		# TODO - check post-execution state for verification
@@ -98,7 +111,7 @@ class Sfp::Runtime
 	def update_model(model, root, path)
 		object = {}
 		if model['_context'] == 'object' and model['_isa'].to_s.isref #and model['_isa'].to_s != '$.Object'
-			object[:_self] = instantiate_sfp_object(model, root)
+			object[:_self] = instantiate_sfp_object(model, path)
 		end
 
 		model.each do |key,child|
@@ -110,28 +123,47 @@ class Sfp::Runtime
 		object
 	end
 
-	def instantiate_sfp_object(model, root)
-		# get SFP schema name
-		schema_name = model['_isa'].sub(/^\$\./, '')
+	def shell_module?(schema)
+		Sfp::Agent.get_modules.each do |name,data|
+			return true if schema == name and data[:type] == :shell
+		end
+		false
+	end
+	
+	def instantiate_sfp_object(model, path)
+		### get SFP schema's name
+		schema = model['_isa'].sub(/^\$\./, '')
+		object = nil
 
-		# throw an exception if schema's implementation is not exist!
-		raise Exception, "Implementation of schema #{schema_name} is not available!" if
-			not Sfp::Module.const_defined?(schema_name)
+		if schema[0] =~ /[A-Z]/ and Sfp::Module.const_defined?(schema)
+			### create an instance of the schema
+			object = Sfp::Module::const_get(schema).new
 
-		# create an instance of the schema
-		object = Sfp::Module::const_get(schema_name).new
+		elsif shell_module?(schema)
+			### get module's metadata
+			metadata = Sfp::Agent.get_modules[schema]
+
+			### create module wrapper instance
+			object = Sfp::Module::Shell.new(metadata)
+
+		else
+			# throw an exception if schema's implementation is not exist!
+			raise Exception, "Implementation of schema #{schema} is not available!"
+
+		end
 
 		# initialize the instance
-		object_model = model.select { |k,v| k[0,1] != '_' and
-			not (v.is_a?(Hash) and v['_context'] == 'procedure') }
 		object.init(model)
-		
+			
 		# update list of synchronized procedures
 		model.each { |k,v|
 			next if k[0,1] == '_' or not (v.is_a?(Hash) and v['_context'] == 'procedure')
 			object.synchronized << k if v['_synchronized']
 		}
 
+		# set object's path
+		object.path = path
+
 		object
 	end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sfpagent
 version: !ruby/object:Gem::Version
-  version: 0.3.10
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-07 00:00:00.000000000 Z
+date: 2013-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sfp
-  requirement: &21609180 !ruby/object:Gem::Requirement
+  requirement: &6198020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 0.3.17
   type: :runtime
   prerelease: false
-  version_requirements: *21609180
+  version_requirements: *6198020
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &21608740 !ruby/object:Gem::Requirement
+  requirement: &6197580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21608740
+  version_requirements: *6197580
 description: A Ruby implementation of SFP agent.
 email: herry13@gmail.com
 executables: