carioca 1.0 → 1.1

data/lib/carioca/services.rb

@@ -0,0 +1,143 @@
+#!/usr/bin/env ruby
+#---
+# Author : Romain GEORGES
+# type : gem component library
+# obj : Carioca::Services Module
+#---
+
+
+
+module Carioca
+
+  # namespace Services for Registry AND buitlins
+  module  Services
+    # class method returning full path in Carioca gem for builtin services files according to installed gem path. 
+    # @note do not use directly for generale purpose (expert/hacks only)
+    # @param [String] _name the name of a service
+    # @return [String,false] the full path filename orfalse if not found
+    def Services::search_builtins(_name)
+      if Gem::Specification.respond_to?(:find_by_name)
+        begin 
+        spec = Gem::Specification.find_by_name('carioca')
+        rescue LoadError
+          spec = nil
+        end
+      else
+        spec = Gem.searcher.find('carioca')
+    end
+      if spec then
+        if Gem::Specification.respond_to?(:find_by_name)
+
+          res = spec.lib_dirs_glob.split('/')
+        else
+          res = Gem.searcher.lib_dirs_for(spec).split('/')
+        end
+        res.pop
+        services_path = res.join('/').concat('/lib/carioca/services')
+      else
+        services_path = "./lib/carioca/services"
+      end
+      _file ="#{services_path}/#{_name}.rb"
+      if ( File::exist? _file or File::exist? "lib/#{_file}" ) then
+        return _file
+      else
+        return false
+      end
+    end
+    
+    # class method returning the path of a file in gem if exist or false
+    # @note do not use directly for generale purpose (expert/hacks only)
+    # @return [String|FalseClass] the full path of a service file
+    def Services::search_file_in_gem(_gem,_file)
+      if Gem::Specification.respond_to?(:find_by_name)
+        begin 
+        spec = Gem::Specification.find_by_name(_gem)
+        rescue LoadError
+          spec = nil
+        end
+      else
+        spec = Gem.searcher.find(_gem)
+      end
+      if spec then
+        if Gem::Specification.respond_to?(:find_by_name)
+          res = spec.lib_dirs_glob.split('/')
+        else
+          res = Gem.searcher.lib_dirs_for(spec).split('/')
+        end
+        res.pop
+        services_path = res.join('/').concat("/#{_file}")
+        return services_path if File::exist?(services_path)
+        return false
+      else
+        return false
+      end
+    end
+
+
+    # class method returning the [Carioca::Services::Registry]@list complement for builtins service found for a carioca gem version
+    # @note do not use directly for generale purpose (expert/hacks only)
+    # @return [Hash] the [Carioca::Services::Registry]@list complement
+    def Services::discover_builtins
+      if Gem::Specification.respond_to?(:find_by_name)
+        begin 
+          spec = Gem::Specification.find_by_name('carioca')
+        rescue LoadError
+          spec = nil
+        end
+      else
+        spec = Gem.searcher.find('carioca')
+      end
+
+      if spec then
+        if Gem::Specification.respond_to?(:find_by_name)
+          res = spec.lib_dirs_glob.split('/')
+        else
+          res = Gem.searcher.lib_dirs_for(spec).split('/')
+        end
+        res.pop
+        services_path = res.join('/').concat('/lib/carioca/services')
+      else
+        services_path = "./lib/carioca/services"
+      end
+
+      map = Dir["#{services_path}/*"]
+      map.delete_if { |item| not File::file?(item) }
+      map.delete_if { |item| File::basename(item) == 'logger.rb' }
+
+      res = {}
+      map.each do |file|
+        Services::validate_service(file,res)
+      end
+      return res
+    end
+
+    def Services::validate_service(file,res)
+        init_options =  {}
+        if open(file).grep(/^# \$BUILTIN/).size > 0 then
+          service = open(file).grep(/# \$SERVICE/).first.split[2] 
+          resource = open(file).grep(/# \$RESOURCE/).first.split[2]
+          desc = open(file).grep(/# \$DESCRIPTION/).first
+          desc = desc.split(' ')
+          desc.shift(2)
+          description= desc.join(' ')
+          open(file).grep(/# \$INIT_OPTIONS/).each do |opt|
+            prev = opt.split
+            init_options[prev[2].to_sym] = prev[4]
+          end
+          distributed = (open(file).grep(/# \$DISTRIBUTED/))? true : false 
+          req = open(file).grep(/# \$REQUIRES/)
+          if req.empty? then
+            requires = []
+          else
+            requires = req.split
+            requires.shift   
+          end
+
+        end
+        unless service.nil? or resource.nil? or description.nil? then
+          res[resource] = { :service => service, :type => :builtin, :description => description, :resource => resource}
+          res[resource][:init_options] = init_options unless init_options.empty?
+        end
+    end    
+  end
+end

data/lib/{services → carioca/services}/configuration.rb

@@ -17,14 +17,14 @@
 
 require 'rubygems'
 require 'methodic'
-require 'services'
+require 'carioca/services'
 require 'yaml'
+require 'drb/drb'
 
 # overwriting Hash class 
 # @private
 class Hash
 
-  
   # recursively transform Hash keys form String to Symbols 
   # come from Rails code
   # exist in Ruby 2.0
@@ -61,7 +61,8 @@ module Carioca
     # @note please do not use Standalone ( dependancy of Configuration class )
     # @private
     class Settings < Hash
-      
+
+
       # the name of the config file in YAML format
       attr_accessor :config_file
       
@@ -107,7 +108,7 @@ module Carioca
     # Service Configuration of Carioca
     class Configuration 
       
-
+      include DRb::DRbUndumped
       
       # @example 
       #   config = Carioca::Services::Configuration::new :config_file => 'afilename', :context => 'production'
@@ -120,8 +121,10 @@ module Carioca
       # Configuration service constructor (open config)
       # @param [Hash] _options the params
       # @option _options [String] :config_file the filename of the config
-      def initialize(_options = {})
-        options = Methodic.get_options(_options)
+      def initialize(_opts = {})
+
+
+        options = Methodic.get_options(_opts)
         options.specify_default_value :config_file => "./.config"
         options.merge
         @settings = Carioca::Services::Settings.new(options)

data/lib/{services → carioca/services}/debug.rb

@@ -46,7 +46,7 @@ module Carioca
       def method_missing(methodname, *args,&block)
         @log.debug("ProxyDebug") { "BEGIN CALL for mapped service #{@mapped_service} "} 
         @log.debug("ProxyDebug") { "called: #{methodname} " }
-        @log.debug("ProxyDebug") { "args : #{args}" }
+        @log.debug("ProxyDebug") { "args : #{args.join " "}" }
         if block_given? then
           @log.debug("ProxyDebug") { "block given" }
           a = @obj.send(methodname, *args,&block)

data/lib/carioca/tasks/rake.rb

@@ -0,0 +1,23 @@
+require 'rake'
+require 'rubygems' 
+require 'carioca'
+
+$VERBOSE = nil
+if Gem::Specification.respond_to?(:find_by_name)
+  begin
+    spec = Gem::Specification.find_by_name('carioca')
+    res = spec.lib_dirs_glob.split('/')
+  rescue LoadError
+    spec = nil
+  end
+else
+  spec = Gem.searcher.find('carioca')
+  res = Gem.searcher.lib_dirs_for(spec).split('/')
+end
+
+res.pop
+tasks_path = res.join('/').concat('/lib/carioca/tasks/')
+
+  
+Dir["#{tasks_path}/*.rake"].each { |ext| load ext }
+

data/lib/carioca/tasks/registry_init.rake

@@ -0,0 +1,11 @@
+require 'carioca' 
+namespace :carioca  do
+  desc "initialize Carioca Registry"
+  task :init_registry do
+    mkdir 'services'
+    carioca = Carioca::Services::Registry.init :name => 'services/registry.yml', :debug => true
+    carioca.discover_builtins
+    carioca.save!
+    puts "Carioca : Registry initialize in services/registry.yml (see /tmp/log.file for details)"
+  end
+end

data/spec/carioca_spec.rb

@@ -5,8 +5,19 @@ require 'carioca'
 $debug = true
 
 describe Carioca do
+
   before :all do 
     FileUtils.rm_rf("/tmp/log.file")
+    File::unlink('/tmp/dorsal/ringserver.pid') if File::exist?('/tmp/dorsal/ringserver.pid')
+    File::unlink('/tmp/dorsal/service-distdummy.pid') if File::exist?('/tmp/dorsal/service-distdummy.pid')
+    pid = `ps aux|grep ruby|grep -v grep |grep 'Ultragreen Ring Server'|awk '{ print $2}'`
+    unless pid.empty? then
+      res = `kill -TERM #{pid.chomp}`
+    end
+    pid = `ps aux|grep ruby|grep -v grep |grep 'a dummy test service'|awk '{ print $2}'`
+    unless pid.empty? then
+      res = `kill -TERM #{pid.chomp}`
+    end
     $carioca = Carioca::Services::Registry.init :file => 'spec/config/services.registry', :debug => $debug
   end  
   
@@ -65,12 +76,18 @@ describe Carioca do
         end
       end
 
+      context "#name (RW)" do
+        it { should respond_to :name }
+        it { should respond_to :name= }
+        it { $carioca.name.should be_an_instance_of String }
+        it  { $carioca.name.should eq 'Carioca'}
+      end
 
       context "#list (RO)" do
         it { should respond_to :list }
         it { should_not respond_to :list= }
         it { subject.list.should be_an_instance_of Hash }
-        it  { $carioca.list.keys.sort.should eq ["configuration", "debug", "dummy", "logger", "uuid"] }
+        it  { $carioca.list.keys.sort.should eq ["configuration", "debug", "distdummy","dorsal", "dummy", "logger", "uuid", "uuidbygemfile"] }
       end
 
       context "#loaded_services (RO)" do
@@ -113,7 +130,7 @@ describe Carioca do
             myservice.test 'titi'            
           end
           it { subject.list.keys.should include "debug" }
-          it "should log a proxy service log sequence" do 
+          it "should log a proxy service log sequence", :if => $debug do 
             open('/tmp/log.file').grep(/DEBUG -- ProxyDebug: BEGIN CALL for mapped service dummy/).size.should eq 1 
             open('/tmp/log.file').grep(/DEBUG -- ProxyDebug: called: test/).size.should eq 1 
             open('/tmp/log.file').grep(/DEBUG -- ProxyDebug: args : titi/).size.should eq 1
@@ -127,28 +144,30 @@ describe Carioca do
             $conf = subject.start_service :name => 'configuration' 
           end
           it "should access flat settings" do
-            $conf.settings.context1.key.should eq 'value'
+            $conf.settings.context1.key0.should eq 'value'
             $conf.settings.context1.node.key1 eq 'value1'
             $conf.settings.context1.node.key2 eq 'value2'
-            $conf.settings.context2.key.should eq 'value'
+            $conf.settings.context2.key0.should eq 'value'
             $conf.settings.context2.node.key1 eq 'value3'
             $conf.settings.context2.node.key2 eq 'value4'            
           end
           it "should access contextualized settings" do
             $conf = subject.restart_service :name => 'configuration', :params => { :context => 'context2' }
-            $conf.settings.key.should eq 'value'
+            $conf.settings.key0.should eq 'value'
             $conf.settings.node.key1 eq 'value3'
             $conf.settings.node.key2 eq 'value4'            
           end
           it "should access inherited settings from YAML" do
             $conf = subject.restart_service :name => 'configuration', :params => { :context => 'context3' }
-            $conf.settings.key.should eq 'value'
+            $conf.settings.key0.should eq 'value'
             $conf.settings.node.key1 eq 'value3'
             $conf.settings.node.key2 eq 'value4'            
           end
           it "should be possible to override a config value" do 
             $conf.settings.node.key2 = 'value8'
             $conf.settings.node.key2.should eq 'value8'
+            $conf.settings[:node][:key2] = 'value6'
+            $conf.settings[:node][:key2].should eq 'value6'
           end
           it { $conf.should respond_to :config_file }
           it { $conf.should respond_to :config_file= }
@@ -157,6 +176,7 @@ describe Carioca do
           it "should be saved in other file" do 
             $conf.config_file = '/tmp/.config'
             $conf.save!.should be_true
+            
           end
           it "should stop the configuration service" do
             subject.stop_service({:name => 'configuration'}).should eq true
@@ -164,6 +184,7 @@ describe Carioca do
         end
         
       end
+
       context "External services" do
         
         it "should start a dummy service precised in registry YAML configuration" do 
@@ -183,6 +204,44 @@ describe Carioca do
         it "should be possible to execute a method with the gem service" do
           $uuid.generate.should be_a_kind_of String
         end
+        it "should start a file in gem service precised by gem_file in registry YAML configuration" do
+          $uuidgemfile = subject.start_service :name => 'uuidbygemfile'
+          $uuidgemfile.should be_an_instance_of UUID
+        end
+        it { subject.list.keys.should include "uuidbygemfile" }
+        it { subject.loaded_services.keys.should include "uuidbygemfile" }
+        it "should be possible to execute a method with the gem_file service" do
+          $uuidgemfile.generate.should be_a_kind_of String
+          subject.stop_service :name => "uuidbygemfile"
+        end
+
+
+        context "Distributed service" do
+          it "should be possible to execute a distributed service" do 
+            $dummy_dist = subject.start_service :name => 'distdummy'        
+          end
+          it "should exist a processus Ring server" do 
+            File::exist?('/tmp/dorsal/ringserver.pid').should be_true
+            pid = `ps aux|grep ruby|grep -v grep |grep 'Ultragreen Ring Server'|awk '{ print $2}'`
+            pid.should_not be_empty
+          end
+          it "should log if debug mode", :if => $debug do
+            open('/tmp/log.file').grep(/DEBUG -- Carioca: Starting new Ring Server/).size.should >= 1
+          end
+          it "should not log if debug mode", :unless => $debug do
+            open('/tmp/log.file').grep(/DEBUG -- Carioca: Starting new Ring Server/).size.should eq 0
+          end
+          it "should include 'distdummy' in @loaded_services.keys" do
+            subject.loaded_services.should include "distdummy"
+          end
+          it "should distdummy be a DRbObject" do 
+            $dummy_dist.should be_a_kind_of DRb::DRbObject
+          end
+          it "should be possible to use test method of the distributed dummy service, and return 'OK'" do
+            $dummy_dist.test.should eq 'OK'
+          end 
+        end
+
       end
     end
 
@@ -200,7 +259,7 @@ describe Carioca do
         open('/tmp/log.file').grep(/DEBUG -- Carioca: Service dummy stopped/).size.should >= 1
       end
       it "should not log if debug mode", :unless => $debug do 
-        open('/tmp/log.file').grep(/DEBUG -- Carioca: Service dummy stopped/).size.should = 0
+        open('/tmp/log.file').grep(/DEBUG -- Carioca: Service dummy stopped/).size.should eq 0
       end
       it "should return false if service not already running" do
         subject.stop_service({:name => 'dum'}).should eq false
@@ -209,7 +268,7 @@ describe Carioca do
         open('/tmp/log.file').grep(/DEBUG -- Carioca: Service dum not loaded/).size.should >= 1
       end
       it "should not log if debug mode and service not loaded", :unless => $debug do 
-        open('/tmp/log.file').grep(/DEBUG -- Carioca: Service dum not loaded/).size.should = 0
+        open('/tmp/log.file').grep(/DEBUG -- Carioca: Service dum not loaded/).size.should eq 0
       end
       it "should return false if service :name is logger" do
         subject.stop_service({:name => 'logger'}).should eq false
@@ -218,9 +277,23 @@ describe Carioca do
         open('/tmp/log.file').grep(/DEBUG -- Carioca: Service logger can't be unloaded/).size.should >= 1
       end
       it "should not log if debug mode and service :name is logger", :unless => $debug do
-        open('/tmp/log.file').grep(/DEBUG -- Carioca: Service logger can't be unloaded/).size.should = 0
+        open('/tmp/log.file').grep(/DEBUG -- Carioca: Service logger can't be unloaded/).size.should eq 0
       end
 
+      context "Distributed Service" do
+        it "should be possible to stop a distributed service" do
+          $dummy_dist = subject.start_service :name => 'distdummy'        
+          subject.stop_service({:name => 'distdummy'}).should be_true        
+        end
+        it "should not exist forked daemon instance for this stopped service" do
+          pid = `ps aux|grep ruby|grep -v grep |grep 'a dummy test service'|awk '{ print $2}'`
+          pid.should be_empty
+        end
+        it "should not exist the pid file of this stopped services" do
+          File::exist?('/tmp/dorsal/service-distdummy.pid').should be_false
+          $dummy_dist = subject.start_service :name => 'distdummy'
+        end
+      end
       
     end
 
@@ -236,6 +309,16 @@ describe Carioca do
       it "should restart a service already loaded and log it" do
         $dummy = subject.restart_service :name => 'dummy'
       end
+
+      context "Distributed service" do
+        it "should ne possible to restart a distributed service" do
+          $dummy_dist = subject.restart_service :name => 'distdummy'
+        end
+        it "should log it if debug mode", :if => $debug do
+          open('/tmp/log.file').grep(/DEBUG -- Carioca: Restarting distributed service distdummy/).size.should eq 1
+        end
+      end
+
       it "should log it if debug mode", :if => $debug do
         open('/tmp/log.file').grep(/DEBUG -- Carioca: Restarting service dummy/).size.should eq 1
       end
@@ -275,7 +358,7 @@ describe Carioca do
       it "should add a new service" do 
         subject.register_service :name => 'otherdummy', 
                                  :type => :file, 
-                                 :resource => 'spec/samples/otherdummy.rb', 
+                                 :resource => './spec/samples/otherdummy.rb', 
                                  :service =>'ExternalServices::OtherDummy',
                                  :description => 'An other Dummy Service',
                                  :requires => ['requireddummy']
@@ -286,15 +369,15 @@ describe Carioca do
       it "should follow requires when started" do
         subject.register_service :name => 'requireddummy',
                                  :type => :file,
-                                 :resource => 'spec/samples/requireddummy.rb',
+                                 :resource => './spec/samples/requireddummy.rb',
                                  :service =>'ExternalServices::RequiredDummy',
                                  :description => 'An other Dummy Service'
         subject.start_service :name => 'otherdummy'
-        open('/tmp/log.file').grep(/DEBUG -- Carioca: Registry dependancy found and not loaded : requireddummy/).size.should eq 1
+        open('/tmp/log.file').grep(/DEBUG -- Carioca: Registry dependancy found and not loaded : requireddummy/).size.should eq 1 if $debug
         subject.loaded_services.keys.should include 'requireddummy'
         subject.loaded_services.keys.should include 'otherdummy'
       end
-      it "should raise Argument error if :type is not :gem, :file or :builtin" do 
+      it "should raise Argument error if :type is not :gem, :file, :gem_file or :builtin" do 
         lambda { subject.register_service :name => 'otherdummy', 
                                  :type => :error, 
                                  :resource => 'spec/samples/otherdummy.rb', 
@@ -336,14 +419,20 @@ describe Carioca do
         it "should not log a registry closing notification if not debug mode", :unless => $debug do
           open('/tmp/log.file').grep(/DEBUG -- Carioca: closing Registry .../).size.should eq 0
         end
+        it "should log a distributed service killing notification if debug mode", :if => $debug do
+          open('/tmp/log.file').grep(/DEBUG -- Carioca: Killing distributed Service distdummy./).size.should >= 1
+        end
+        it "should not log a distributed service killing notification if not debug mode", :unless => $debug do
+          open('/tmp/log.file').grep(/DEBUG -- Carioca: Killing distributed Service distdummy./).size.should eq 0
+        end
         it "should log a stopping notification for each services if debug mode", :if => $debug do
-          ['debug','uuid'].each do |service|
-            open('/tmp/log.file').grep(/DEBUG -- Carioca: Stopping service #{service} .../).size.should eq 1
+          ['debug','uuid','dorsal','dummy','dummy_one','requireddummy','otherdummy'].each do |service|
+            open('/tmp/log.file').grep(/DEBUG -- Carioca: Service #{service} stopped/).size.should >= 1
           end
         end
         it "should not log a stopping notification for each services if not debug mode", :unless => $debug do
-          ['debug','uuid'].each do |service|
-            open('/tmp/log.file').grep(/DEBUG -- Carioca: Stopping service #{service} .../).size.should eq 0
+          ['debug','uuid','dorsal','dummy','dummy_one','requireddummy','otherdummy'].each do |service|
+            open('/tmp/log.file').grep(/DEBUG -- Carioca: Service #{service} stopped/).size.should eq 0
           end
         end
         it "should log a registry closing confirmation if debug mode", :if => $debug do
@@ -355,6 +444,8 @@ describe Carioca do
         it "should loaded services empty" do
           subject.loaded_services.empty?.should eq true
         end  
+        context "Distributed service" do
+        end
       end
     end
   end