omf_rc 6.0.4.pre.1 → 6.0.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MGNiZjU5MGViODBjNTc1MDU0MDE3Y2ZmMzY0ZTA0YjQwMWY2MThkMA==
+    Y2E5YTUyM2U4OWQzYjk2Y2RlMTBlMDZiOGJmYmY5ZTg3MTY0ZTJiOQ==
   data.tar.gz: !binary |-
-    ZTFiYTZiYzQ0MzZiNjM1NDI1YTlhOTQ0MGZlZTEwYWUwMDlmNjU2MA==
+    MGQ2YmY4ZTY1NTM3ZjQyNjNhZjU0NTVmYjc4YzM4ZmVhNTlmNzg4Zg==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    MzFhMDI5ZTk5Zjg0YzY3NjI5YzIzMDNiMDYyNDFiYjc4YjIyNzkyNjk4NWNh
-    MjYwM2NmMzc3MzJmMTU5NDFkMzA0MTE0N2VhMTM4NjViZTMzY2JlZTE3OWMz
-    Y2ExOGE4ZmI5ZjI4YmYyYjgwOTY0M2UxZjNmOTdlN2YyMGE2OGM=
+    ZDEyM2VmZDViZDRkOTM0ZTZhYjY2YmQ2OGNmMGY1MzgzZDEwZjMzMjZiNTYy
+    MmRiMzY4ZmIxMmIxZTU5MGNkMDlkNDVlOTY2ZjRkODcyMTNjMzFmYmM4NmU2
+    YmI2YjhlNGMxYmEzOTdjYTg2MmJiYjg3ZTg3ZTkzYmU2ODc5NmY=
   data.tar.gz: !binary |-
-    MGQ1OTExNjE5NjYwZjUxNTU4Njc2ZWNlOWVmODViZThlNThiMTNlN2YzOTZj
-    MWE2MjZmMDJmZjZjMDVhMzEwNGU3ZGVkNDEwMTM3Mzk5NzliZGRkNTU0OGE5
-    ODAzZGZhMmE4YjZhY2UxNzBhYjUwZWJkNzJhZjdkZWJmZmQzM2E=
+    MDQ3ZmEyMTlkNDhhMGI4NTRkY2IyY2UyZGYxNTIwOTU0ZmU0Mjk3M2E5NjA4
+    NTQxNTNiYjhlNmMxZGFjZTc1ODdkNTkxZTk0MWZkMTQ5MzRkMDQ3YzljMTk1
+    OGMwOTcwOGQxZjgyNTc4NDJjODIxMmVkZWY4ZWMzOWM3ZDA0Y2Q=

data/bin/omf_rc

@@ -2,150 +2,219 @@
 
 abort "Please use Ruby 1.9.3 or higher" if RUBY_VERSION < "1.9.3"
 
+# The following is to work around a bug in activesupport triggered by
+# the JWT library which is used only in the AMQP transport, os it
+# fails quietly if that library is not installed in XMPP deployments
+begin; require 'json/jwt'; rescue Exception; end
+
 require 'optparse'
-require 'erb'
 require 'socket'
 
 require 'omf_rc'
 require 'omf_rc/resource_factory'
 
 $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 = "OMF Resource Controller version '#{gem_version}'\n"
-    opts.banner += "Usage: #{executable_name} [options]"
-
-    opts.on("-c CONFIGFILE", "Configuration File") do |file|
-      options[:configfile] = file
-    end
 
-    opts.on("-a ADVANCED_CONFIGFILE", "Advanced Configuration File") do |file|
-      options[:advanced_configfile] = file
-    end
-
-    opts.on("--log_config CONFIGFILE", "Logging Configuration File") do |file|
-      options[:logging_configfile] = file
+#
+# Class to start an OMF RC. The configuration parameters can be set
+# in decreasing priority through the command line,  configuration 
+# file and default settings (see @def_opts). 
+#
+# For historic reasons and to make this implementation more interesting
+# there are two different config file formats. A 'normal' one inherited from
+# earlier version of OMF, and an 'advanced' one which is identical to the
+# format accepted by OmfCommon.init(). To maintain some level of sanity,
+# only one configuration file is accepted. 
+#
+# Having said that, there is one exception and that relates to the 'oml'
+# configuration which is stripped out first and handed to the OML4R library
+# during command line parsing.
+#
+class OmfRcRunner
+  def initialize()
+    @options = {}
+    @executable_name = File.basename($PROGRAM_NAME)
+    @oml_enabled = false
+    @gem_version = Gem::Specification.find_by_name('omf_rc').version.to_s
+    
+    @node_id = Socket.gethostname
+    
+    @def_opts = {
+      uid: @node_id,
+      uri: "xmpp:#{@node_id}-#{Process.pid}:#{@node_id}-#{Process.pid}@localhost",
+      environment: 'production',
+      debug: false
+    }
+    @copts = {}
+    
+    @gopts = {
+      config_file: nil,
+      adv_config_file: nil,
+      logging_configfile: nil,
+      environment: nil
+    }
+    
+    @opts = {}
+    @omlopts = {appName: @executable_name}
+  end
+  
+  def run()
+    setup()
+    OmfCommon::Measure.enable if @oml_enabled
+    
+    OmfCommon.init(@gopts[:environment], @opts) do |el|
+      # Load a customised logging set up if provided
+      OmfCommon.load_logging_config(@gopts[:logging_configfile]) if @gopts[:logging_configfile]
+    
+      info "Starting OMF Resource Controller version '#{@gem_version}'"
+      
+      #el.on_int_signal do # Implementation missing
+      Signal.trap("SIGINT") do
+        # TODO: Should release resources first
+        info "Stopping ..." 
+        el.stop
+      end
+    
+      # Load extensions
+      if @opts[:add_default_factories] != false
+        OmfRc::ResourceFactory.load_default_resource_proxies
+      end
+    
+      @opts[:factories].each do |f|
+        if (req = f[:require])
+          begin
+            info "Try to load resource module '#{req}'"
+            require(req)
+          rescue LoadError => e
+            error e.message
+          end
+        end
+      end
+      
+      OmfCommon.comm.on_connected do |comm|
+        info "Connected using #{comm.conn_info}"
+    
+        #if @opts[:auth] && @optss[:auth][:root_cert_dir]
+        #  OmfCommon::Auth::CertificateStore.instance.register_default_certs(@opts[:auth][:root_cert_dir])
+        #end
+        #OmfCommon::Auth::CertificateStore.instance.register(entity) if entity
+    
+        @opts[:resources].each do |res_opts|
+          rtype = res_opts.delete(:type)
+          res_creation_opts = res_opts.delete(:creation_opts)
+          res_creation_opts ||= res_opts.delete(:create_opts)
+          res_creation_opts ||= {}
+          #res_opts[:certificate] = entity if entity
+          begin
+            OmfRc::ResourceFactory.create(rtype, res_opts, res_creation_opts)
+          rescue => e
+            error "#{e.message}\n#{e.backtrace.join("\n")}"
+          end
+        end
+    
+      end
     end
-
-    opts.on("-u URI", "Communication URI (xmpp://user:password@domain)") do |uri|
-      options[:uri] = uri
+    info "Stopping OMF Resource Controller version '#{@gem_version}'"
+  end
+  
+  def setup()
+    oml_init() # calls parse_config_files()
+    unless @opts[:communication][:url]
+      puts "Error: Missing parameters to connect to a PubSub Server (see --help)"
+      exit(1)
     end
-
-    opts.on("-e ENVIRONMENT", "Environment (development, production ...)") do |environment|
-      options[:environment] = environment
+    
+    opts = @opts
+    # TODO: This needs to be fixed
+    if opts[:auth]
+      if File.exist?(opts[:auth][:entity_cert]) && File.exist?(opts[:auth][:entity_key])
+        entity = OmfCommon::Auth::Certificate.create_from_x509(File.read(opts[:auth][:entity_cert]),
+                                                               File.read(opts[:auth][:entity_key]))
+      end
     end
-
-    opts.on("-i UID", "UID (and pubsub topic) of the resource, defaults to hostname") do |uid|
-      options[:uid] = uid
+    opts[:communication][:auth] = {} if entity
+  end
+  
+  def parse_config_files()
+    @opts = {communication: {}, resources: [], factories: [], add_default_factories: true}
+    config_file = @gopts[:config_file]
+    adv_config_file = @gopts[:adv_config_file]
+    if config_file && adv_config_file
+      puts "To avoid any unexpected surprises, you should stick to one form of config file"
+      exit(1)
     end
-
-    opts.on("-v", "--version", "Show version") do
-      puts "OMF Resource Controller version '#{gem_version}'"
-      exit
+    
+    if config_file
+      cfg_opts =  OmfCommon.load_yaml(config_file, symbolize_keys: true, erb_process: true)
+      copts = @def_opts.merge(cfg_opts.merge(@copts))
+      @opts[:communication][:url] = copts[:uri]
+      @opts[:resources] = copts[:resources] || [{ type: :node, uid: copts[:uid] }]
+      @opts[:factories] = copts[:factories] if copts[:factories]
+      if copts[:add_default_factories] == false
+        @opts[:add_default_factories] = false
+      end
+      @gopts[:environment] ||= copts[:environment]
+      @omlopts.merge(copts[:oml] || {}) {|k, v1, v2| v1 } # merge in place as OML may hold @omlopts
     end
-
-    opts.on("-h", "--help", "Show this message") do
-      puts opts
-      exit
+    
+    if adv_config_file
+      aopts =  OmfCommon.load_yaml(adv_config_file, symbolize_keys: true, erb_process: true)
+      aenv = aopts.delete(:environment)
+      @gopts[:environment] ||= @copts[:environment] || aenv || @def_opts[:environment]
+      @opts.merge!(aopts)
+      # need to do a merge! to update the hash passed into OML.init already
+      @omlopts.merge!(@opts.delete(:oml) || {}) {|k, v1, v2| v1 || v2 } # merge in place as OML may hold @omlopts
     end
   end
-rescue OML4R::MissingArgumentException => e
-  puts "Warning: #{e.message} to instrument this RC, so it will run without instrumentation. (see --oml-help)"
-rescue => e
-  puts e.message
-  exit(1)
-end
-
-if !options[:configfile].nil?
-  cfg_options = YAML.load(ERB.new(File.read(options[:configfile])).result)
-  options = cfg_options.merge(options)
-end
-
-if options[:resources].nil? || options[:resources].empty?
-  options[:uid] ||= Socket.gethostname
-  options[:resources] = [{ type: :node, uid: options[:uid] }]
-end
-
-OmfCommon::Measure.enable if oml_enabled
-
-options[:environment] ||= :development
-
-if options[:uri]
-  common_options = { communication: { url: options[:uri] } }
-else
-  common_options = {}
-end
-
-if !options[:advanced_configfile].nil?
-  a_cfg_options = (YAML.load_file(options[:advanced_configfile]))
-  common_options = a_cfg_options.merge(common_options)
-end
-
-unless common_options[:communication] && common_options[:communication][:url]
-  puts "Error: Missing parameters to connect to a PubSub Server (see --help)"
-  exit(1)
-end
-
-if options[:auth]
-  if File.exist?(options[:auth][:entity_cert]) && File.exist?(options[:auth][:entity_key])
-    entity = OmfCommon::Auth::Certificate.create_from_x509(File.read(options[:auth][:entity_cert]),
-                                                           File.read(options[:auth][:entity_key]))
-  end
-end
-
-common_options[:communication][:auth] = {} if entity
-
-OmfCommon.init(options[:environment].to_sym, common_options) do |el|
-  # Load a customised logging set up if provided
-  OmfCommon.load_logging_config(options[:logging_configfile])
-
-  # Load extensions
-  if options[:add_default_factories] != false
-    OmfRc::ResourceFactory.load_default_resource_proxies
-  end
-
-  if options[:factories]
-    options[:factories].each do |f|
-      if (req = f[:require])
-        begin
-          info "Try to load resource module '#{req}'"
-          require(req)
-        rescue LoadError => e
-          error e.message
+  
+  def oml_init
+    begin
+      @omlopts[:afterParse] = lambda {|o| parse_config_files() }
+      @oml_enabled = OML4R::init(ARGV, @omlopts) do |op|
+        op.banner = "OMF Resource Controller version '#{@gem_version}'\n"
+        op.banner += "Usage: #{@executable_name} [options]"
+    
+        op.on("-c CONFIGFILE", "Configuration File") do |file|
+          @gopts[:config_file] = file
+        end
+    
+        op.on("-a ADVANCED_CONFIGFILE", "Advanced Configuration File") do |file|
+          @gopts[:adv_config_file] = file
+        end
+    
+        op.on("--log_config CONFIGFILE", "Logging Configuration File") do |file|
+          @gopts[:logging_configfile] = file
+        end
+    
+        op.on("-u URI", "Communication URI [#{@def_opts[:uri]}") do |uri|
+          @copts[:uri] = uri
+        end
+    
+        op.on("-e ENVIRONMENT", "Environment (development, production ...) [#{@def_opts[:environment]}]") do |e|
+          @gopts[:environment] = e
+        end
+    
+        op.on("-i UID", "UID (and pubsub topic) of the resource, [#{@def_opts[:uid]}]") do |uid|
+          @copts[:uid] = uid
+        end
+    
+        op.on("-v", "--version", "Show version") do
+          puts "OMF Resource Controller version '#{@gem_version}'"
+          exit
+        end
+    
+        op.on("-h", "--help", "Show this message") do
+          puts opts
+          exit
         end
       end
+    rescue OML4R::MissingArgumentException => e
+      puts "Warning: #{e.message} to instrument this RC, so it will run without instrumentation. (see --oml-help)"
+    rescue => e
+      puts e.message
+      exit(1)
     end
   end
-
-  info "Starting OMF Resource Controller version '#{gem_version}'"
-
-  OmfCommon.comm.on_connected do |comm|
-    info "Connected using #{comm.conn_info}"
-
-    if options[:auth] && options[:auth][:root_cert_dir]
-      OmfCommon::Auth::CertificateStore.instance.register_default_certs(options[:auth][:root_cert_dir])
-    end
-    OmfCommon::Auth::CertificateStore.instance.register(entity) if entity
-
-    options[:resources].each do |res_opts|
-      rtype = res_opts.delete(:type)
-      res_creation_opts = res_opts.delete(:creation_opts)
-      res_creation_opts ||= res_opts.delete(:create_opts)
-      res_creation_opts ||= {}
-      res_opts[:certificate] = entity if entity
-      begin
-        OmfRc::ResourceFactory.create(rtype, res_opts, res_creation_opts)
-      rescue => e
-        error "#{e.message}\n#{e.backtrace.join("\n")}"
-      end
-    end
-
-  end
 end
-info "Stopping OMF Resource Controller version '#{gem_version}'"
 
+OmfRcRunner.new().run()

data/lib/omf_rc/resource_proxy/application.rb

@@ -4,7 +4,7 @@
 # By downloading or using this software you accept the terms and the liability disclaimer in the License.
 
 # This module defines a Resource Proxy (RP) for an Application.
-# For a detailed usage tutorial see {file:doc/RESOURCE\_PROXY.mkd Resource Proxy tutorial}
+# For a detailed usage tutorial see {file:doc/DEVELOPERS.mkd Resource Proxy tutorial}
 #
 # Utility dependencies: platform_toos, common_tools
 #
@@ -15,7 +15,7 @@
 # - pkg_ubuntu (String) the name of the Ubuntu package for this app
 # - pkg_fedora (String) the name of the Fedora package for this app
 # - state (String) the state of this Application RP
-#   (stopped, running, paused, installed, completed)
+#   (stopped, running, paused, installed)
 # - installed (Boolean) is this application installed? (default false)
 # - force_tarball_install (Boolean) if true then force the installation
 #   from tarball even if other distribution-specific installation are
@@ -150,7 +150,7 @@ module OmfRc::ResourceProxy::Application
                                        event_type.to_s.include?('EXIT') &&
                                        msg == "0"
       if event_type == 'EXIT'
-        res.property.state = app_id.include?("_INSTALL") ? :stopped : :completed
+        res.property.state = :stopped
         res.inform(:status, {
                         status_type: 'APP_EVENT',
                         event: event_type.to_s.upcase,
@@ -249,10 +249,6 @@ module OmfRc::ResourceProxy::Application
   # stopped, running, paused, installing. The semantic of each states are:
   #
   # - stopped: the initial state for an Application RP
-  # - completed: the final state for an application RP. When the application
-  #   has been executed and its execution is finished, it enters this state.
-  #   When the application is completed it cannot change state again
-  #   TODO: maybe in future OMF, we could consider allowing an app to be reset?
   # - running: upon entering in this state, a new instance of the application is
   #   started, the Application RP stays in this state until the
   #   application instance is finished or paused. The Application RP can
@@ -342,9 +338,9 @@ module OmfRc::ResourceProxy::Application
             ExecApp[id].signal('TERM')
             sleep 4
             # finally, try sending KILL signal
-            ExecApp[id].kill('KILL') unless ExecApp[id].nil?
+            ExecApp[id].signal('KILL') unless ExecApp[id].nil?
           end
-          res.property.state = :completed
+          res.property.state = :stopped
         rescue => err
         end
       end
@@ -376,7 +372,7 @@ module OmfRc::ResourceProxy::Application
       res.property.state = :running
       # do more things here...
     else
-      # cannot run as we are still installing or already completed
+      # cannot run as we are still installing
       res.log_inform_warn "Cannot switch to running state as current state is '#{res.property.state}'"
     end
   end

data/lib/omf_rc/version.rb

@@ -4,5 +4,5 @@
 # By downloading or using this software you accept the terms and the liability disclaimer in the License.
 
 module OmfRc
-  VERSION = "6.0.4.pre.1"
+  VERSION = "6.0.4"
 end

data/omf_rc.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "em-minitest-spec", "~> 1.1.1"
   s.add_development_dependency "pry"
   s.add_development_dependency "simplecov"
-  s.add_runtime_dependency "omf_common", "~> 6.0.4.pre.1"
+  s.add_runtime_dependency "omf_common", "~> 6.0.4"
   s.add_runtime_dependency "cocaine", "~> 0.3.0"
   s.add_runtime_dependency "mocha"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omf_rc
 version: !ruby/object:Gem::Version
-  version: 6.0.4.pre.1
+  version: 6.0.4
 platform: ruby
 authors:
 - NICTA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-29 00:00:00.000000000 Z
+date: 2013-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 6.0.4.pre.1
+        version: 6.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 6.0.4.pre.1
+        version: 6.0.4
 - !ruby/object:Gem::Dependency
   name: cocaine
   requirement: !ruby/object:Gem::Requirement
@@ -199,9 +199,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>'
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: omf_rc
 rubygems_version: 2.0.7