processwanker 0.0.7

data/lib/service_classes/process_service.rb

@@ -0,0 +1,218 @@
+############################################################################
+#
+# process_service.rb
+#
+# class representing a service that is a command-line launchable process
+#
+############################################################################
+
+require 'service'
+require 'digest/md5'
+require 'etc'
+require 'net_util'
+
+module ProcessWanker
+	
+	class ProcessService < Service
+
+		include Log
+
+	  ############################################################################
+	  #
+	  #
+	  #
+	  ############################################################################
+
+		def self.nice_name
+			"process_service"
+		end
+
+	  ############################################################################
+	  #
+	  # iparams is a hash containing:
+	  #
+	  #   :start_cmd
+	  #   :start_dir (optional)
+	  #   :stop_cmd (optional)
+	  #   :run_user (optional)
+	  #   :soft_kill_limit (optional)
+	  #
+	  # plus anything to be passed to Service
+	  #
+	  ############################################################################
+	
+	  def initialize(iparams)
+	  
+			# extract parameters
+			extract_params(
+				iparams,
+				[
+					:start_cmd,
+					:start_dir,
+					:stop_cmd,
+					:run_user,
+					:soft_kill_limit,
+				])
+	
+			# set defaults
+	  	@params=
+	  	{
+	  		:soft_kill_limit		=>		3,
+	  		:start_dir 					=> 		"/"
+	  	}.merge(@params)
+
+			raise "service has no start_cmd" if(!@params[:start_cmd])
+
+			# determine run_user properties
+			if(@params[:run_user])
+				if(@params[:run_user].class == String)
+					@params[:run_user]=Etc.getpwnam(@params[:run_user])
+				elsif(@params[:run_user].class == Fixnum)
+					@params[:run_user]=Etc.getpwuid(@params[:run_user].to_i)
+				else
+					raise "bad run_user parameter for process_service"
+				end
+
+				# verify we can switch to this uid if necessary
+				current_uid=Process.euid()
+				if(current_uid != 0 && current_uid != @params[:run_user].uid)
+					raise "can't have a :run_user parameter unless we are running as root, or the uids match"
+				end
+				
+			end
+
+	    super(iparams)    
+	  end
+
+	  ############################################################################
+	  #
+	  # start
+	  #
+	  # fork() and exec() the start_cmd
+	  #
+	  ############################################################################
+	
+	  def do_start(attempt_count)
+	    info("do_start[#{attempt_count}] for #{self.name}")
+	    
+	    Process.fork do
+
+				# close network descriptors
+				NetUtil::post_fork()
+
+				# start new session
+				Process.setsid()
+
+				# set environment cookie so we can be identified		
+				hash=env_hash()
+				ENV[ ProcessUtil::ENVIRONMENT_KEY ] = hash if(hash)
+				
+				# change user/group?
+				if(@params[:run_user])
+
+					current_uid=Process.euid()
+					current_user=Etc.getpwuid(current_uid)
+					
+					if(current_uid != @params[:run_user].uid)
+						Process.uid=@params[:run_user].uid
+						Process.gid=@params[:run_user].gid
+						Process.euid=@params[:run_user].uid
+						Process.egid=@params[:run_user].gid
+						ENV["HOME"]=@params[:run_user].dir
+					end					
+					
+				end
+				
+				# change directory?
+				Dir.chdir(@params[:start_dir])
+	    
+				# redirect inputs/outputs
+				STDIN.reopen("/dev/null")		# - closing STDIN causes problems with apache
+				file=@params[:log_file] ? @params[:log_file] : "/dev/null"
+				STDOUT.reopen(file,"a")
+				STDERR.reopen(file,"a")
+	    
+	    	# run!
+	    	Process.exec(@params[:start_cmd])
+	     
+	    end
+	    
+	  end
+	  
+	  ############################################################################
+	  #
+	  # stop
+	  #
+	  # stop the process (either with -TERM or -KILL)
+	  #
+	  ############################################################################
+	  
+	  def do_stop(attempt_count)
+	  
+	  	kl=@params[:soft_kill_limit]
+	  	mode = (kl && attempt_count >= kl) ? :hard : :soft
+
+	    info("do_stop[#{attempt_count}]->#{mode} for #{self.name}")
+	    
+			if(mode == :soft)
+				if(params[:stop_cmd])
+					system(params[:stop_cmd])
+					return
+				end
+			end	    
+	    
+	    # find all processes with matching hash
+	    procs=ProcessUtil::processes[ env_hash ]
+	    if(procs)
+				procs.each do |pid|
+					Process.kill({ :hard => "KILL", :soft => "TERM" }[mode],pid)
+				end
+	    end
+	  	   
+	  end
+	  
+	  ############################################################################
+	  #
+	  # ping
+	  #
+	  # return run state of process
+	  #
+	  ############################################################################
+	  
+	  def do_ping
+			ProcessUtil::processes[env_hash] ? :up : :down	  
+	  end
+
+	  ############################################################################
+	  #
+	  # env_hash
+	  #
+	  # returns magic environment cookie that identifies processes belonging to
+	  # this service.
+	  #
+	  ############################################################################
+	  
+		def env_hash()
+			Digest::MD5.hexdigest( name )
+		end	  
+	  
+	  ############################################################################
+	  #
+	  #
+	  #
+	  ############################################################################
+	  
+	  ############################################################################
+	  #
+	  #
+	  #
+	  ############################################################################
+	  
+	end
+
+
+	ServiceMgr::register_service_class(ProcessService)
+
+end
+
+

data/lib/service_classes/upstart_service.rb

@@ -0,0 +1,103 @@
+############################################################################
+#
+# upstart_service.rb
+#
+# class representing a service controlled by upstart
+#
+############################################################################
+
+require 'service'
+require 'digest/md5'
+require 'etc'
+require 'process_service'
+require 'process_util'
+
+#<BRS> used to require dbus, but upstart doesn't seem to use it in Ubuntu Server
+#require 'rubygems'
+#gem 'ruby-dbus'
+#require 'dbus'
+
+module ProcessWanker
+
+	class UpstartService < Service
+		
+		include Log
+
+	  ############################################################################
+	  #
+	  #
+	  #
+	  ############################################################################
+
+		def self.nice_name
+			"upstart_service"
+		end
+
+	  ############################################################################
+	  #
+	  #
+	  #
+	  ############################################################################
+	
+	  def initialize(iparams)
+		
+			# extract parameters
+			extract_params(
+				iparams,
+				[
+					:job_name,
+				])
+
+			@job_name=@params[:job_name] || iparams[:name]
+			
+			super(iparams)
+	  end
+
+	  ############################################################################
+	  #
+	  # start
+	  #
+	  ############################################################################
+	  
+	  def do_start(attempt_count)
+	  	debug("do_start #{self.name}")
+			system("initctl start #{@job_name}")
+	  end
+	  
+	  ############################################################################
+	  #
+	  # stop
+	  #
+	  ############################################################################
+	  
+	  def do_stop(attempt_count)
+			system("initctl stop #{@job_name}")
+  	end
+	  
+	  ############################################################################
+	  #
+	  # ping
+	  #
+	  # return run state of process
+	  #
+	  ############################################################################
+	  
+	  def do_ping
+			status=`initctl status #{@job_name}`
+			status.include?("running") ? :up : :down
+	  end
+
+	  ############################################################################
+	  #
+	  #
+	  #
+	  ############################################################################
+	  
+	end
+
+
+	ServiceMgr::register_service_class(UpstartService)
+
+end
+
+

data/lib/service_mgr.rb

@@ -0,0 +1,226 @@
+############################################################################
+#
+# service_mgr.rb
+#
+# the core of the application
+#
+############################################################################
+
+require 'process_util'
+require 'config'
+require 'service'
+
+module ProcessWanker
+	class ServiceMgr
+	
+		include Log
+		
+	  ############################################################################
+	  #
+	  #
+	  #
+	  ############################################################################
+
+		CLASS_SUBDIR 	= "service_classes"
+		CLASS_DIR			=	File.join(File.dirname(File.expand_path(__FILE__)),CLASS_SUBDIR)
+	
+	  ############################################################################
+	  #
+	  #
+	  #
+	  ############################################################################
+	
+	  attr_accessor         :services_by_name
+	  attr_accessor					:tick_count
+		attr_accessor					:service_classes
+		attr_accessor					:reload_config
+		attr_accessor					:terminate
+	  
+	  ############################################################################
+	  #
+	  #
+	  #
+	  ############################################################################
+	
+	  class << self
+	    def instance
+	      @@instance
+	    end
+	    def register_service(service)
+	      @@instance.register_service(service)
+	    end
+	    def register_service_class(service_class)
+	      @@instance.register_service_class(service_class)
+	    end
+	  end
+	  	  
+	  ############################################################################
+	  #
+	  # initialize
+	  #
+	  ############################################################################
+	
+	  def initialize()
+	    @@instance=self
+	    @services_by_name={}
+			@service_classes={}
+	    @tick_count=0
+	
+	    ProcessUtil::scan_processes()
+			load_classes()
+	  end
+	  
+	  ############################################################################
+	  #
+	  #
+	  #
+	  ############################################################################
+	
+		def load_classes()
+			$LOAD_PATH << CLASS_DIR unless($LOAD_PATH.include?(CLASS_DIR))
+			Dir.glob( File.join(CLASS_DIR,"*.rb") ).each do |fn|
+				require( File.basename(fn,".rb") )
+			end
+		end
+	
+	  ############################################################################
+	  #
+	  #
+	  #
+	  ############################################################################
+	
+	  def register_service(service)
+	  	raise "service is missing name" if(!service.name)
+			raise "service #{service.name} is multiply defined" if(@services_by_name[service.name])  
+	    @services_by_name[service.name]=service
+	  end
+	  
+		############################################################################
+	  #
+	  #
+	  #
+	  ############################################################################
+	
+	  def register_service_class(service_class)
+			@service_classes[ service_class.nice_name ]=service_class
+		end
+	
+	  ############################################################################
+	  #
+	  # main tick function
+	  #
+	  ############################################################################
+	
+	  def tick()
+	    
+	    # scan processes... and kill anything we don't recognize
+	    ProcessUtil::scan_processes()
+	    ProcessUtil::kill_unknown()
+	    ProcessUtil::reap()
+	    
+	    # tick each service in turn
+	    @services_by_name.values.each do |service|
+	      service.tick()      
+	    end
+	    
+	    @tick_count += 1
+	    
+	  end
+	  
+	  ############################################################################
+	  #
+	  #
+	  #
+	  ############################################################################
+
+		def match_services(spec)
+			matched={}
+			@services_by_name.each do |sn,s|
+				matched[sn]=s if(s.matches_spec(spec))
+			end
+			matched
+		end
+
+	  ############################################################################
+	  #
+	  #
+	  #
+	  ############################################################################
+	  
+		def apply_config(cfg,notboot=true)
+
+	    @services_by_name={}
+
+			cfg.daemon.services.each do |group_name,services|
+				services.services.each do |name,service|
+					params=service.params.merge({ :name => service.name, :group_name => group_name })
+					if(!notboot)
+						params[:initial_state]=:up
+					end
+					svc=service.klass.new(params)
+					
+					# the service will register itself
+					# we must store its config block
+					svc.config_node=service
+					
+				end
+			end
+			
+			@services_by_name.each do |n,v|
+				v.resolve_dependencies()
+			end
+			
+			ProcessUtil::build_known_hashes()
+
+		end	  
+	  
+		############################################################################
+		#
+		#
+		#
+		############################################################################
+
+	  def run()
+	  	
+	  	while(true)
+	  		
+				tick()
+				sleep(1)
+
+				#
+				# check for requests
+				#
+				
+				if(@reload_config)
+					info("reloading configuration")
+					ProcessWanker::with_logged_rescue("ServiceMgr - reloading configuration") do
+						c=Config::load_config(Config::get_config_path)
+						apply_config(c)
+					end
+					@reload_config=false
+				end
+				
+				if(@terminate)
+					info("terminating")
+					break
+				end
+
+	  	end
+		end  
+  
+
+	  ############################################################################
+	  #
+	  #
+	  #
+	  ############################################################################
+	  
+	  ############################################################################
+	  #
+	  #
+	  #
+	  ############################################################################
+	  
+	end
+end
+	

data/lib/util.rb

@@ -0,0 +1,31 @@
+############################################################################
+#
+# util.rb
+#
+############################################################################
+
+require 'log'
+
+module ProcessWanker
+
+	############################################################################
+	#
+	#
+	#
+	############################################################################
+	
+	def with_logged_rescue(context=nil,level=Log::ERROR)
+		
+		begin
+			yield
+		rescue Exception => e
+			Log::log(context,level) if(context)
+			Log::log(e.message,level)
+			Log::log(e.backtrace.join("\n"),level)
+		end
+		
+	end
+	module_function			:with_logged_rescue
+
+
+end

data/processwanker.gemspec

@@ -0,0 +1,36 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{processwanker}
+  s.version = "0.0.7"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ben Stragnell"]
+  s.cert_chain = ["/Users/ben/gem_certs/gem-public_cert.pem"]
+  s.date = %q{2011-05-05}
+  s.default_executable = %q{pw}
+  s.description = %q{Process monitoring and remote control system}
+  s.email = %q{pw@codepuppies.com}
+  s.executables = ["pw"]
+  s.extra_rdoc_files = ["README", "bin/pw", "lib/config/config.rb", "lib/config/config_auth.rb", "lib/config/config_client.rb", "lib/config/config_client_cluster.rb", "lib/config/config_client_clusters.rb", "lib/config/config_client_host.rb", "lib/config/config_daemon.rb", "lib/config/config_daemon_service.rb", "lib/config/config_daemon_service_dependency.rb", "lib/config/config_daemon_services.rb", "lib/config/config_hook.rb", "lib/config/config_node.rb", "lib/config/config_smtp.rb", "lib/events.rb", "lib/log.rb", "lib/net/net_api.rb", "lib/net/net_client.rb", "lib/net/net_connection.rb", "lib/net/net_server.rb", "lib/net/net_server_client.rb", "lib/net/net_util.rb", "lib/process_util.rb", "lib/pw_app.rb", "lib/service.rb", "lib/service_classes/dummy_service.rb", "lib/service_classes/pid_service.rb", "lib/service_classes/process_service.rb", "lib/service_classes/upstart_service.rb", "lib/service_mgr.rb", "lib/util.rb"]
+  s.files = ["README", "Rakefile", "bin/pw", "lib/config/config.rb", "lib/config/config_auth.rb", "lib/config/config_client.rb", "lib/config/config_client_cluster.rb", "lib/config/config_client_clusters.rb", "lib/config/config_client_host.rb", "lib/config/config_daemon.rb", "lib/config/config_daemon_service.rb", "lib/config/config_daemon_service_dependency.rb", "lib/config/config_daemon_services.rb", "lib/config/config_hook.rb", "lib/config/config_node.rb", "lib/config/config_smtp.rb", "lib/events.rb", "lib/log.rb", "lib/net/net_api.rb", "lib/net/net_client.rb", "lib/net/net_connection.rb", "lib/net/net_server.rb", "lib/net/net_server_client.rb", "lib/net/net_util.rb", "lib/process_util.rb", "lib/pw_app.rb", "lib/service.rb", "lib/service_classes/dummy_service.rb", "lib/service_classes/pid_service.rb", "lib/service_classes/process_service.rb", "lib/service_classes/upstart_service.rb", "lib/service_mgr.rb", "lib/util.rb", "Manifest", "processwanker.gemspec"]
+  s.homepage = %q{http://codepuppies.com/~ben/pw}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Processwanker", "--main", "README"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{processwanker}
+  s.rubygems_version = %q{1.6.2}
+  s.signing_key = %q{/Users/ben/gem_certs/gem-private_key.pem}
+  s.summary = %q{Process monitoring and remote control system}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<echoe>, [">= 0"])
+    else
+      s.add_dependency(%q<echoe>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<echoe>, [">= 0"])
+  end
+end