sambala 0.9.2 → 0.9.3

data/lib/sambala.rb

@@ -46,6 +46,7 @@
 # :title:Sambala
 
 class Sambala
+	require 'logger'
   require 'pty'
   require 'expect'
   require 'rubygems'
@@ -53,6 +54,7 @@ class Sambala
   
   require 'sambala_gardener'
   include Gardener
+	@@log_level = Logger::WARN; @@log_output = STDERR
   
   # The +new+ class method initializes Sambala.
   # === Parameters
@@ -69,7 +71,8 @@ class Sambala
   #                       :password =>  'eggman', 
   #                       :threads  =>  2 )
   def initialize(options={:domain => '', :host => '', :share => '', :user => '', :password => '', :threads => 1})
-    begin
+    init_logger
+		begin
       options[:threads] = 4 if options[:threads] > 4
       options[:init_timeout] = options[:threads]
       @options = options; gardener_ok
@@ -270,24 +273,46 @@ class Sambala
   def volume
     execute('volume' ,'', false)[1]
   end
-
-	# The +local+ methods allow shell command execution on the local machine.
-	# === Parameters
-	# * _command_ = the shell comand to be executed locally
-	# === Interactive Returns
-	# * _string_ = the normal return message of the command
+  
+	# The +queue_waiting+ method returns the number of waiting task in queue
 	# === Example
-	# 	samba.local('mkdir mydir')
-	def local(command)
-		execute('!', command, false)[1]
+	# 	samba.queue_waiting		# => 3
+	def queue_waiting
+		@gardener.growth(:seed)
 	end
-  
-  # The +queue_results+ methods collect a done queue items results
+	
+	# The +queue_processing+ method returns an array containing the tasks actually processing
+	# === Example
+	# 	samba.queue_processing		# => [[1, "put myFile"],[2, "put lib/sambala.rb sambala.rb"]]
+	def queue_processing
+		results = @gardener.harvest(:sprout)
+		results.map { |result| [result[:id], result[:seed]] }
+	end
+	
+	# The +queue_completed+ method returns an array containing the task that have completed
+	def queue_completed
+		parse_results(@gardener.harvest(:crop))
+	end
+	
+	# The +queue_empty?+ method return true if there are no jobs in queue
+	# === Example
+	# 	samba.queue_empty?		# false
+	def queue_empty?
+		@gardener.growth(:empty)
+	end
+	
+	# The queue_done? method return true if all jobs have finished processing
+	# === Example
+	# 	samba.queue_done? 	# true
+	def queue_done?
+		@gardener.growth(:finished)
+	end
+	
+  # The +queue_results+ methods wait for all queued items to finish and returns them.
   # === Example 
   #   result = samba.queue_results
   def queue_results
-    crop = @gardener.harvest(:full_crop)
-    crop.map! { |result| [ result[:success], result[:seed], result[:message] ]  }
+    parse_results(@gardener.harvest(:full_crop))
   end
   
   # The +progress+ method returns a progress ratio indicator from 0.00 to 1.00
@@ -302,7 +327,34 @@ class Sambala
   #   samba.close
   def close
     result = @gardener.close
+		# $log_sambala.close
     result.values.map { |queue| queue.empty? }.uniq.size == 1 ? true : false
   end
+
+	def Sambala::log_output=(out)
+		@@log_output = out
+	end
+	
+	def Sambala::log_level=(level)
+		@@log_level = case level
+		when :debug
+			Logger::DEBUG
+		when :info
+			Logger::INFO
+		when :warn
+			Logger::WARN
+		when :error
+			Logger::ERROR
+		when :fatal
+			Logger::FATAL
+		end
+	end
+
+	private
+	
+	def init_logger
+		$log_sambala = Logger.new(@@log_output)
+		$log_sambala.level = @@log_level
+	end
   
 end

data/lib/sambala_gardener.rb

@@ -46,6 +46,7 @@ class Sambala
     #   result = execute_all('mask','match*')   # =>  true
     def execute_all(command,data)
       result = @gardener.seed_all("#{command} #{data}")
+			$log_sambala.debug("execute_all result") {"#{result.inspect}"}
       bools = result.map { |row| row[:success] }
       bools.uniq.size == 1 ? true : false
     end
@@ -59,6 +60,7 @@ class Sambala
     def exec_interactive(command,data)
       id = @gardener.seed("#{command} #{data}")
       result = @gardener.harvest(:one,id)
+			$log_sambala.debug("exec_interactive result") {"#{result.inspect}"}
       return result[:success], result[:message]
     end
 
@@ -67,10 +69,17 @@ class Sambala
     # * _command_ = the command as a string
     # * _data_ = the command argument as a string
     # === Example
-    #   result = exec_queue('get','aFile.txt')  # => [true,true]
+    #   result = exec_queue('get','aFile.txt')  # => [true,1]
     def exec_queue(command,data)
-      @gardener.seed("#{command} #{data}").integer? ? [true,true] : [false,false]
+      result = @gardener.seed("#{command} #{data}")
+			$log_sambala.debug("exec_queue result") {"#{result.inspect}"}
+			result.integer? ? [true,result] : [false,result]
     end
+		
+		# The +parse_results+ method map the gardener's return hash values to an array
+		def parse_results(results)
+			results.map { |result| [result[:id], result[:success], result[:seed], result[:message]] }
+		end
     
     # The +gardener_ok+ method does the +init_gardener+ invocation, degrading the options parameters until
     # it initializes, or raise SmbInitError exception after 4 try.
@@ -85,11 +94,11 @@ class Sambala
           	init.map! { |result| result[:success] }
           	throw :gardener if init.uniq.size == 1 and init[0] == true
 					rescue Timeout::Error
-						$! = "Slugish Network or Server?"
+						$log_sambala.error("Having problem setting the smb client... TRY #{num}")
 					end
 					kill_gardener_and_incr
         end
-				$! = "All Attemps Failed, Gardener could not be initiated" if $!.nil?
+				$log_sambala.fatal("All Attemps Failed, Gardener could not be initiated")
         raise SmbInitError.exception("Couldn't set smbclient properly (#{$!.to_s})")
       end
 			@posix_support = posix?(@init_status[0][:message])
@@ -98,7 +107,8 @@ class Sambala
     # The +init_gardener+ method initialize a gardener class object
     def init_gardener
       @gardener = Abundance.gardener(:rows => @options[:threads], :init_timeout => @options[:init_timeout]) do
-        PTY.spawn("smbclient //#{@options[:host]}/#{@options[:share]} #{@options[:password]} -W #{@options[:domain]} -U #{@options[:user]}") do |r,w,pid|
+				
+				PTY.spawn("smbclient //#{@options[:host]}/#{@options[:share]} #{@options[:password]} -W #{@options[:domain]} -U #{@options[:user]}") do |r,w,pid|
           w.sync = true
           $expect_verbose = false
           catch :init do
@@ -112,32 +122,47 @@ class Sambala
             end
           end
           Abundance.grow do |seed|
-            w.print "#{seed.sprout}\r"
+            w.print "#{seed.sprout}\r"; $log_sambala.debug("smbclient") {"sprout: -- #{seed.sprout} --"}
             catch :result do
+							iter = 1
               loop do
                 r.expect(/.*\xD\xAsmb: [\x5C]*\w*[\x5C]+\x3E.*/) do |text|
+									$log_sambala.debug("smbclient") {"expect: -- #{text} --"}
                   if text != nil
                     msg = text[0]
 										
                     msg.gsub!(/smb: \w*\x5C\x3E\s*$/, '')
                     msg.gsub!(/^\s*#{seed.sprout}/, '')
-                    msg.lstrip!
-                    
+                    msg.lstrip!; $log_sambala.debug("smbclient") {"msg: -- #{msg} --"}
+
                     success = case seed.sprout
                       when /^put/
                         msg['putting'].nil? ? false : true
                       else
-                        msg['NT_STATUS'].nil? ? true : false
+                        if msg['NT_STATUS']
+													false
+												elsif msg['timed out'] || msg['Server stopped']
+													false
+												else
+													true
+												end
                       end
-                    
+
                     seed.crop(success, msg)
                     throw :result
+									elsif iter > 20
+										$log_sambala.warn("Failed to #{seed.sprout}")
+										seed.crop(false, "Failed to #{seed.sprout}")
+										throw :result
+									else
+										iter += 1
                   end
                 end
               end
             end
           end
         end
+
       end
     end
 		

data/test/tc_sambala_main.rb

@@ -1,9 +1,10 @@
 $:.unshift File.join(File.dirname(__FILE__), "..", "lib")
+require 'logger'
 require 'test/unit'
 require 'sambala'
 
 TESTFILE = 'sambala_test'
-TESTDIR = 'sambala_temp'
+TESTDIR = 'sambala_test_dir'
 WELCOME = <<TITLE
   .|'''.|                     '||              '||          
   ||..  '   ....   .. .. ..    || ...   ....    ||   ....   
@@ -14,16 +15,27 @@ WELCOME = <<TITLE
 
 /////////////////////////////////////////////////////////////
 TITLE
+THREADS = 4
+
+if ARGV[0].nil? 
+	LOG_LEVEL = :warn
+else
+	LOG_LEVEL = ARGV[0].to_sym
+end
 
 class TestSambalaMain < Test::Unit::TestCase
   
   def setup
+		setup_logger(STDERR,LOG_LEVEL)
     check_smbclient_presence
     get_samba_param_from_input
     init_sambala
+		put_marker
+		Dir.mkdir(TESTDIR)
   end
   
   def test_main
+		@log_test.info("Testing sample SMB operations...")
     ls_one = check_ls
 		check_mkdir(TESTDIR)
 		check_exist(TESTDIR)
@@ -31,20 +43,58 @@ class TestSambalaMain < Test::Unit::TestCase
 		
 		ls_two = check_ls
 		assert(ls_one != ls_two)
+		
 		check_lcd_put_get
+		check_queue
 
 		check_cd('..')
 		check_rmdir(TESTDIR)
   end
   
   def teardown
-		@samba.rmdir(TESTDIR) if @samba.exist?(TESTDIR)
+		back_to_marker
+		@log_test.info("All Test Done!!! Tearing Down!!!")
+		@samba.rmdir(TESTDIR).to_s if @samba.exist?(TESTDIR)
+		@log_test.debug("remote directory clean")
     close = @samba.close
     assert(close)
-		Dir.rmdir(TESTDIR) if File.exist?(TESTDIR)
+		@log_test.debug("samba client closed")
+		FileUtils.remove_dir(TESTDIR) if File.exist?(TESTDIR)
+		@log_test.debug("local directory clean")
+		@log_test.close
+		puts "\nBEWARE, if test fails you may have to clean up your server and the test directory,\na folder named #{TESTDIR} may be left after exiting... Sorry!"
   end
   
   private
+
+	def setup_logger(out,level)
+		Sambala::log_level = level
+		@log_test = Logger.new(out)
+		case level
+		when :debug
+			@log_test.level = Logger::DEBUG
+		when :info
+			@log_test.level = Logger::INFO
+		when :warn
+			@log_test.level = Logger::WARN
+		when :error
+			@log_test.level = Logger::ERROR
+		when :fatal
+			@log_test.level = Logger::FATAL
+		else
+			@log_test.level = Logger::UNKNOWN
+		end
+	end
+
+	def put_marker
+		result = @samba.put(:from => 'test/' + File.basename(__FILE__), :to => File.basename(__FILE__))
+		assert_equal(true, result[0], "Putting initial path marker failed: #{result[1]}")
+	end
+	
+	def back_to_marker
+		@samba.cd('..') unless @samba.exist?(File.basename(__FILE__))
+		@samba.del(File.basename(__FILE__))
+	end
   
   def check_smbclient_presence
     answer = `smbclient --help`
@@ -75,7 +125,7 @@ class TestSambalaMain < Test::Unit::TestCase
                           :share => @share,
                           :user => @user, 
                           :password => @password, 
-                          :threads => 1)
+                          :threads => THREADS)
     puts "Connection successfull,\nnow proceding with test:"
   end
   
@@ -83,8 +133,7 @@ class TestSambalaMain < Test::Unit::TestCase
     result = @samba.ls
     assert_not_nil(result)
 		result_alias = @samba.dir
-    assert_not_nil(result)
-		assert(result == result_alias)
+    assert_not_nil(result_alias)
 		return result
   end
 
@@ -109,48 +158,115 @@ class TestSambalaMain < Test::Unit::TestCase
 	end
 	
 	def check_lcd_put_get
-		before = @samba.local('ls')
-		@samba.local("mkdir #{TESTDIR}")
-		after = @samba.local('ls')
-		assert(before != after)
-		
+		@log_test.debug("cd in testdir")
 		re = @samba.lcd(TESTDIR)
 		assert_equal(true,re)
-		before2 = @samba.local('ls')
-		@samba.local("touch #{TESTFILE}")
-		after2 = @samba.local('ls')
-		assert(before2 != after2)
 		
+		@log_test.debug("making local test file")
+		f = File.new("#{TESTDIR}/#{TESTFILE}",'w')
+		f.puts "test file"
+		f.close
+		assert(File.exist?("#{TESTDIR}/#{TESTFILE}"))
 		
+		@log_test.debug("putting file")
 		re = @samba.put(:from => TESTFILE, :to => TESTFILE)
 		assert_kind_of(Array,re)
 		assert_equal(true,re[0])
 		
-		check_exist(TESTFILE)
+		@log_test.debug("deleting local test file")
+		File.delete("#{TESTDIR}/#{TESTFILE}")
+		assert(!File.exist?("#{TESTDIR}/#{TESTFILE}"))
 		
-		@samba.local("rm #{TESTFILE}")
-		after2_2 = @samba.local('ls')
-		assert(before2 == after2_2)
+		check_exist(TESTFILE)
 		
+		@log_test.debug("getting test file")
 		re = @samba.get(:from => TESTFILE, :to => TESTFILE)
 		assert_kind_of(Array,re)
 		assert_equal(true,re[0])
 		
+		@log_test.debug("delete remote test file")
 		re = @samba.del(TESTFILE)
 		assert_equal(true,re)
 		
-		after2_3 = @samba.local('ls')
-		assert(after2 == after2_3)
-		@samba.local("rm #{TESTFILE}")
+		@log_test.debug("check local test file")
+		assert(File.exist?("#{TESTDIR}/#{TESTFILE}"))
+		File.delete("#{TESTDIR}/#{TESTFILE}")
+		assert(!File.exist?("#{TESTDIR}/#{TESTFILE}"))
 		
 		re = @samba.lcd('..')
 		assert_equal(true,re)
-		@samba.local("rmdir #{TESTDIR}")
-		after = @samba.local('ls')
-		assert(before == after)
+		
 	end
 	
-	
-  
+	def check_queue
+		jobs = 300
+		@log_test.info("Testing queue... (be patient, this will take a couple minutes)")
+		assert_equal(true, @samba.queue_empty?)
+		assert_equal(true, @samba.queue_done?)
+		assert_equal(0,@samba.queue_waiting)
+		
+		files = Array.new(jobs) { |id| "file_" + id.to_s }
+		content = "01" * 10000
+		files.each do |file|
+			f = File.new("#{TESTDIR}/#{file}",'w')
+			f.puts content
+			f.close
+		end
+		
+		re = @samba.lcd(TESTDIR)
+		assert_equal(true,re)
+		
+		files.each do |file|
+			@samba.put(:from => file, :to => file, :queue => true)
+		end
+		
+		assert_equal(false, @samba.queue_empty?)
+		assert_equal(false, @samba.queue_done?)
+		assert(@samba.queue_waiting > 0)
+		
+		result = @samba.queue_processing
+		@log_test.debug("queue processing result is: #{result.inspect}")
+		assert_kind_of(Array,result)
+		assert_kind_of(Array,result[0])
+		assert_equal(2,result[0].size)
+		assert_kind_of(Integer,result[0][0])
+		assert_kind_of(String,result[0][1])
+		
+		result = @samba.queue_completed
+		@log_test.debug("queue completed results is: #{result.inspect}")
+		assert_kind_of(Array,result)
+		assert_kind_of(Array,result[0])
+		assert_equal(4,result[0].size)
+		assert_kind_of(Integer,result[0][0])
+		assert(result[0][1] == true || result[0][1] == false)
+		assert_kind_of(String,result[0][2])
+		assert_kind_of(String,result[0][3])
+		
+		more_result = @samba.queue_results
+		@log_test.debug("more result: #{more_result.inspect}")
+		assert_kind_of(Array,more_result)
+		assert_kind_of(Array,more_result[0])
+		assert_equal(4,more_result[0].size)
+		assert_kind_of(Integer,more_result[0][0])
+		assert(more_result[0][1] == true || more_result[0][1] == false)
+		assert_kind_of(String,more_result[0][2])
+		assert_kind_of(String,more_result[0][3])
+		
+		total_result = result + more_result
+		assert_equal(jobs,total_result.size)
+		
+		assert_equal(true, @samba.queue_empty?)
+		assert_equal(true, @samba.queue_done?)
+		assert_equal(0,@samba.queue_waiting)
+		
+		files.each do |file|
+			del = @samba.del(file)
+			@log_test.debug("remote delete: #{del.inspect}")
+			File.delete("#{TESTDIR}/#{file}")
+		end
+		
+		re = @samba.lcd('..')
+		assert_equal(true,re)
+	end
   
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: sambala
 version: !ruby/object:Gem::Version 
-  version: 0.9.2
+  version: 0.9.3
 platform: ruby
 authors: 
 - Louis-Philippe Perron
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-03 00:00:00 -05:00
+date: 2009-02-09 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.3.2
+        version: 1.3.4
     version: 
 description: 
 email: lp@spiralix.org