omf_rc 6.0.0.pre.8 → 6.0.0.pre.9

data/bin/install_omf_rc

@@ -0,0 +1,79 @@
+#!/usr/bin/env ruby
+
+abort "Please use Ruby 1.9.3 or higher" if RUBY_VERSION < "1.9.3"
+
+require 'optparse'
+require 'fileutils'
+
+if Process.uid!=0
+  abort "You have to be root to install the OMF RC startup script and config file.
+You also need to have the omf_rc gem installed as root and have RVM installed as root (if you don't use system ruby)."
+end
+
+options = {}
+optparse = OptionParser.new do |opts|
+  opts.banner = "Usage: #{File.basename($PROGRAM_NAME)} [options]"
+  opts.on("-i", "--initscript", "Install init script to run the OMF RC on boot (as root)") do |i|
+    options[:init] = i
+  end
+  opts.on("-c", "--configfile", "Install config file template in /etc/omf_rc/config.yml") do |c|
+    options[:config] = c
+  end
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+end
+
+optparse.parse!
+if options.empty?
+  puts optparse
+  exit
+end
+
+spec = Gem::Specification.find_by_name("omf_rc")
+gem_root = spec.gem_dir
+
+if options[:config]
+  puts "Copying configuration file..."
+  FileUtils.mkdir_p "/etc/omf_rc"
+  FileUtils.cp "#{gem_root}/config/config.yml", "/etc/omf_rc/config.yml"
+  FileUtils.chmod 0644, "/etc/omf_rc/config.yml"
+  puts "done."
+end
+
+if options[:init]
+  puts "Detecting operating system..."
+  
+  if !File.exist?("/etc/issue")
+    abort "Unknown or unsupported operating system. Cannot install init script."
+  end
+  
+  os=`awk 'NR==1 {print $1}' /etc/issue`.chomp
+  
+  if os.nil?
+    abort "Unknown or unsupported operating system. Cannot install init script."
+  end
+ 
+  puts "'#{os}' found"
+  
+  FileUtils.cp "#{gem_root}/init/run_omf_rc.sh", "/usr/local/bin/run_omf_rc.sh"
+  
+  case os
+  when "Ubuntu"
+    FileUtils.cp "#{gem_root}/init/ubuntu", "/etc/init/omf_rc.conf"
+    puts "Upstart script for Ubuntu has been installed. Execute 'start omf_rc' to run the daemon."
+  when "Debian"
+    FileUtils.cp "#{gem_root}/init/debian", "/etc/init.d/omf_rc"
+    `update-rc.d omf_rc defaults`
+    puts "Init script for Debian has been installed. Execute '/etc/init.d/omf_rc start' to run the daemon."
+  when "Fedora"
+     FileUtils.cp "#{gem_root}/init/fedora", "/etc/init.d/omf_rc"
+    `chkconfig --add omf_rc`
+    # older Fedora's don't use systemd
+    `systemctl --system daemon-reload` if File.exist?("/bin/systemctl")
+    puts "Init script for Fedora has been installed. Execute '/etc/init.d/omf_rc start' to run the daemon."
+  else
+    abort "OS '#{os}' is not supported. Cannot install init script."
+  end
+end

data/bin/omf_rc

@@ -1,43 +1,42 @@
 #!/usr/bin/env ruby
 
-require "optparse"
+abort "Please use Ruby 1.9.3 or higher" if RUBY_VERSION < "1.9.3"
+
+require 'optparse'
+require 'erb'
+require 'socket'
+
 require 'omf_rc'
 require 'omf_rc/resource_factory'
-$stdout.sync = true
-
-options = {
-  uid: `hostname`.chomp
-}
 
+$stdout.sync = true
+options = {}
 executable_name = File.basename($PROGRAM_NAME)
 oml_enabled = false
+gem_version = Gem::Specification.find_by_name('omf_rc').version.to_s
 
 begin
   oml_enabled = OML4R::init(ARGV, :appName => executable_name) do |opts|
     opts.banner = "usage: #{executable_name} [options]"
 
-    opts.on("-u USER", "Username") do |user|
-      options[:user] = user
+    opts.on("-c CONFIGFILE", "Configuration File") do |file|
+      options[:configfile] = file
     end
 
-    opts.on("-p PASSWORD", "Password") do |password|
-      options[:password] = password
+    opts.on("-a ADVANCED_CONFIGFILE", "Advanced Configuration File") do |file|
+      options[:advanced_configfile] = file
     end
 
-    opts.on("-s SERVER", "PubSub server") do |server|
-      options[:server] = server
+    opts.on("-u URI", "Communication URI (xmpp://user:password@domain)") do |uri|
+      options[:uri] = uri
     end
 
-    opts.on("-t TOPIC", "PubSub topic to create, also becomes the uid of the resource, default to hostname") do |topic|
-      options[:uid] = topic
+    opts.on("-e ENVIRONMENT", "Environment (development, production ...)") do |environment|
+      options[:environment] = environment
     end
 
-    opts.on("-d", "--debug", "Debug mode") do
-      options[:debug] = true
-    end
-
-    opts.on("-l LOG_FILE_DIR", "Write log file to this folder") do |file_dir|
-      options[:log_file_dir] = file_dir
+    opts.on("-i UID", "UID of the resource, also becomes the pubsub topic of the resource, default to hostname") do |uid|
+      options[:uid] = uid
     end
   end
 rescue => e
@@ -54,30 +53,47 @@ rescue => e
   end
 end
 
+if !options[:configfile].nil?
+  cfg_options = YAML.load(ERB.new(File.read(options[:configfile])).result)
+  options = cfg_options.merge(options)
+end
+
+options[:uid] ||=`hostname`.chomp
+
 OmfCommon::Measure.enable if oml_enabled
 
-unless options[:server] && options[:user] && options[:password]
-  puts "Error: Missing parameters to connect to a PubSub Server (see --help)"
-  exit(1)
+options[:environment] ||= :development
+
+if options[:uri]
+  common_options = { communication: { url: options[:uri] } }
+else
+  common_options = {}
 end
 
-Logging.logger.root.level = :debug if options[:debug]
-Blather.logger = logger
+if !options[:advanced_configfile].nil?
+  a_cfg_options = (YAML.load_file(options[:advanced_configfile]))
+  common_options = a_cfg_options.merge(common_options)
+end
 
-if options[:log_file_dir] && File.exist?(options[:log_file_dir])
-  Logging.logger.root.add_appenders(
-    Logging.appenders.file(
-      "#{options[:log_file_dir]}/omf_rc.log",
-      :layout => Logging.layouts.pattern(:date_pattern => '%F %T %z',
-                                         :pattern => '[%d] %-5l %c: %m\n')))
+unless common_options[:communication] && common_options[:communication][:url]
+  puts "Error: Missing parameters to connect to a PubSub Server (see --help)"
+  exit(1)
 end
 
+resource_options = {
+  uid: options[:uid]
+}
+
 OmfRc::ResourceFactory.load_default_resource_proxies
 
-EM.run do
-  node = OmfRc::ResourceFactory.new(:node, options)
-  node.connect
+OmfCommon.init(options[:environment].to_sym, common_options) do |el|
+  info "Starting OMF Resource Controller version '#{gem_version}'"
 
-  trap(:INT) { node.disconnect }
-  trap(:TERM) { node.disconnect }
+  OmfCommon.comm.on_connected do |comm|
+    info "Connected as #{comm.jid}" if comm.jid
+    res = OmfRc::ResourceFactory.create(:node, resource_options)
+
+    comm.on_interrupted { res.disconnect }
+  end
 end
+info "Stopping OMF Resource Controller version '#{gem_version}'"

data/config/config.yml

@@ -0,0 +1,8 @@
+---
+# default topic name is this machine's hostname
+# default xmpp user name/password is "hostname-pid"
+# this is to ensure that every RC has its own topic and XMPP account
+:uid: <%= Socket.gethostname %>
+:uri: xmpp://<%= "#{Socket.gethostname}-#{Process.pid}" %>:<%= "#{Socket.gethostname}-#{Process.pid}" %>@localhost
+:environment: production
+:debug: false

data/init/debian

@@ -0,0 +1,51 @@
+#! /bin/sh
+### BEGIN INIT INFO
+# Provides:          omf-rc
+# Required-Start:    $remote_fs $syslog
+# Required-Stop:     $remote_fs $syslog
+# Default-Start:     2 3 4 5
+# Default-Stop:      0 1 6
+# Short-Description: Start daemon at boot time
+# Description:       Enable service provided by daemon.
+### END INIT INFO
+
+DAEMON=/usr/local/bin/run_omf_rc.sh
+[ -x "$DAEMON" ] || exit 0
+NAME=omf_rc
+PIDFILE=/var/run/$NAME.pid
+. /lib/init/vars.sh
+. /lib/lsb/init-functions
+
+start(){
+        echo -n "Starting OMF Resource Controller: $NAME"
+	start-stop-daemon --start --quiet --background --pidfile $PIDFILE --make-pidfile --exec $DAEMON
+        echo "."
+}
+
+stop(){
+        echo -n "Stopping OMF Resource Controller: $NAME"
+	start-stop-daemon --stop --quiet --oknodo --pidfile $PIDFILE
+        echo "."
+}
+
+case "$1" in
+  start)
+	start
+	;;
+  stop)
+	stop
+	;;
+  restart|force-reload)
+ 	stop
+ 	start
+	;;
+  status)
+	status_of_proc -p $PIDFILE "$DAEMON" "$NAME" && exit 0 || exit $?
+	;;
+  *)
+	echo "Usage: $0 {start|stop|restart|force-reload|status}" >&2
+	exit 3
+	;;
+esac
+
+:

data/init/fedora

@@ -0,0 +1,54 @@
+#! /bin/sh
+### BEGIN INIT INFO
+# Provides:          omf-rc
+# Required-Start:    $remote_fs $syslog
+# Required-Stop:     $remote_fs $syslog
+# Default-Start:     2 3 4 5
+# Default-Stop:      0 1 6
+# Short-Description: Start daemon at boot time
+# Description:       Enable service provided by daemon.
+### END INIT INFO
+
+DAEMON=/usr/local/bin/run_omf_rc.sh
+[ -x "$DAEMON" ] || exit 0
+NAME=omf_rc
+PIDFILE=/var/run/$NAME.pid
+. /etc/rc.d/init.d/functions
+
+start(){
+    echo -n "Starting OMF Resource Controller: $NAME"
+    $DAEMON >& /var/log/$NAME.daemon.log &
+    echo $! > $PIDFILE
+    echo "."
+}
+
+stop(){
+    echo -n "Stopping OMF Resource Controller: $NAME"
+    if [ -f $PIDFILE ]; then
+	kill `cat $PIDFILE`
+	rm $PIDFILE
+	sleep 2
+    else
+	echo -e "\nNo pidfile found. Is $NAME running?"
+    fi
+    echo "."
+}
+
+case "$1" in
+  start)
+	start
+	;;
+  stop)
+	stop
+	;;
+  restart|force-reload)
+ 	stop
+ 	start
+	;;
+  *)
+	echo "Usage: $0 {start|stop|restart|force-reload}" >&2
+	exit 3
+	;;
+esac
+
+:

data/init/run_omf_rc.sh

@@ -0,0 +1,62 @@
+#!/bin/bash
+
+# Startup wrapper for the OMF6 RC
+# detects system-wide RVM installations & Ruby from distro packages
+# and runs OMF6 RC
+
+# system-wide RVM must be installed using
+# '\curl -L https://get.rvm.io | sudo bash -s stable'
+
+die() { echo "ERROR: $@" 1>&2 ; exit 1; }
+
+RUBY_VER="ruby-1.9.3-p286"
+RUBY_BIN_SUFFIX=""
+
+if [ `id -u` != "0" ]; then
+	die "This script is intended to be run as 'root'"
+fi
+
+if [ -e /etc/profile.d/rvm.sh ]; then
+    # use RVM if installed
+    echo "System-wide RVM installation detected"
+    source /etc/profile.d/rvm.sh
+    if [[ $? != 0 ]] ; then
+        die "Failed to initialize RVM environment"
+    fi
+    rvm use $RUBY_VER@omf > /dev/null
+    if [[ $? != 0 ]] ; then
+        die "$RUBY_VER with gemset 'omf' is not installed in your RVM"
+    fi
+    ruby -v | grep 1.9.3  > /dev/null
+    if [[ $? != 0 ]] ; then
+        die "Could not run Ruby 1.9.3"
+    fi
+    gem list | grep omf_rc  > /dev/null
+    if [[ $? != 0 ]] ; then
+        die "The omf_rc gem is not installed in the 'omf' gemset"
+    fi
+else
+    # check for distro ruby when no RVM was found
+    echo "No system-wide RVM installation detected"
+    ruby -v | grep 1.9.3  > /dev/null
+    if [[ $? != 0 ]] ; then
+        ruby1.9.3 -v | grep 1.9.3  > /dev/null
+        if [[ $? != 0 ]] ; then
+            die "Could not run system Ruby 1.9.3. No useable Ruby installation found."
+        fi
+        RUBY_BIN_SUFFIX="1.9.3"
+    fi
+    echo "Ruby 1.9.3 found"
+    gem$RUBY_BIN_SUFFIX list | grep omf_rc  > /dev/null
+    if [[ $? != 0 ]] ; then
+        die "The omf_rc gem is not installed"
+    fi
+fi
+
+RC=`which omf_rc`
+if [[ $? != 0 ]] ; then
+    die "could not find omf_rc executable"
+fi
+
+echo "Running OMF6 RC"
+exec /usr/bin/env ruby$RUBY_BIN_SUFFIX $RC -c /etc/omf_rc/config.yml $@

data/init/ubuntu

@@ -0,0 +1,12 @@
+description     "OMF6 Resource Controller"
+author          "NICTA <omf-user@lists.nicta.com.au>"
+
+start on (filesystem and net-device-up IFACE=lo)
+stop on runlevel [!2345]
+
+env DAEMON=/usr/local/bin/run_omf_rc.sh
+
+respawn
+respawn limit 10 5
+
+exec $DAEMON

data/lib/omf_rc/omf_error.rb

@@ -1,11 +1,11 @@
-# Error during message processing,  include message related information context_id and inform_to, for publishing  errors to pubsub server
+# Error during message processing,  include message related information cid and replyto, for publishing  errors to pubsub server
 #
 class OmfRc::MessageProcessError < StandardError
-  attr_reader :context_id, :inform_to
+  attr_reader :cid, :replyto
 
-  def initialize(context_id, inform_to, msg = nil)
-    @context_id = context_id
-    @inform_to = inform_to
+  def initialize(cid, replyto, msg = nil)
+    @cid = cid
+    @replyto = replyto
     super(msg)
   end
 end

data/lib/omf_rc/resource_factory.rb

@@ -9,27 +9,21 @@ class OmfRc::ResourceFactory
   # List of registered resource proxies
   @@proxy_list = Hashie::Mash.new
 
-  # By default, we use xmpp dsl, which based on blather
-  DEFAULT_OPTS = {
-    dsl: 'xmpp'
-  }
-
   class << self
     # Factory method to initiate new resource proxy
     #
     # @param (see OmfRc::ResourceProxy::AbstractResource#initialize)
     #
     # @see OmfRc::ResourceProxy::AbstractResource
-    def new(type, opts = nil, comm = nil, &block)
+    def create(type, opts = {}, creation_opts = {}, &creation_callback)
       unless @@proxy_list.include?(type)
         raise ArgumentError, "Resource type not found: #{type.to_s}" unless @@proxy_list.include?(type)
       end
-      type = type.to_s
-      opts = opts ? DEFAULT_OPTS.merge(opts) : DEFAULT_OPTS
       # Create a new instance of abstract resource
-      resource = OmfRc::ResourceProxy::AbstractResource.new(type, opts, comm)
+      resource = OmfRc::ResourceProxy::AbstractResource.new(type, opts, creation_opts, &creation_callback)
       # Then extend this instance with relevant module identified by type
-      resource.extend("OmfRc::ResourceProxy::#{type.camelize}".constantize)
+      emodule = @@proxy_list[type].proxy_module || "OmfRc::ResourceProxy::#{type.camelize}".constantize
+      resource.extend(emodule)
       # Initiate property hash
       resource.methods.each do |m|
         resource.__send__(m) if m =~ /def_property_(.+)/
@@ -39,6 +33,8 @@ class OmfRc::ResourceFactory
       resource
     end
 
+    alias :new :create
+
     # Return the proxy list
     def proxy_list
       @@proxy_list
@@ -61,7 +57,7 @@ class OmfRc::ResourceFactory
       end
     end
 
-    def load_addtional_resource_proxies(folder)
+    def load_additional_resource_proxies(folder)
       Dir["#{folder}/*.rb"].each do |file|
         require "#{folder}/#{File.basename(file).gsub(/\.rb/, '')}"
       end