lsync 2.3.1 → 2.3.2

data/lib/lsync.rb

@@ -39,6 +39,10 @@ module LSync
 	def self.run_script(options = {}, &block)
 		script = LSync::Script.new(options, &block)
 		
+		script.on(:failure) do |error|
+			LSync::log_error(error, logger)
+		end
+		
 		script.run!
 	end
 	

data/lib/lsync/client.rb

@@ -28,29 +28,40 @@ $connection.run do |object|
 		Dir.chdir(object[1])
 	when :script
 		# [:script, :command, :data]
-		
+		$connection.exceptions = false
+
+		status = 255
+
 		command = object[1]
+		command.collect! { |a| a.to_s }
+
 		script_name = File.basename(command[0])
-		
+
 		local_path = `mktemp -t #{script_name.gsub(/[^a-z]/i, '')}.XXXX`.chomp
-		
+
 		File.open(local_path, 'w') { |fp| fp.write(object[2]) }
 		system('chmod', '+x', local_path)
-		
+
 		pid = fork do
 			command[0] = local_path
 			exec *command
 		end
-		
+
 		# Clean up the script after execution:
 		pid, result = Process.wait2(pid)
-		# system('rm', '-f', local_path)
-		
-		exit!(result.exitstatus)
+		status = result.exitstatus
+		system('rm', '-f', local_path)
+
+		exit!(status)
 	when :exec
 		# [:exec, :command]
+		$connection.exceptions = false
+
 		command = object[1]
-		
+
 		exec *command
+
+		# If the above command failed, the exit status is 255
+		exit!(255)
 	end
 end

data/lib/lsync/controller.rb

@@ -18,7 +18,38 @@
 # OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 # THE SOFTWARE.
 
+require 'rexec/task'
+
 module LSync
+	
+	def self.log_task(task, logger)
+		pipes = [task.output, task.error]
+
+		while pipes.size > 0
+			result = IO.select(pipes)
+
+			result[0].each do |pipe|
+				if pipe.closed? || pipe.eof?
+					pipes.delete(pipe)
+					next
+				end
+
+				if pipe == task.output
+					logger.info pipe.readline.chomp
+				elsif pipe == task.error
+					logger.error pipe.readline.chomp
+				end
+			end
+		end
+	end
+	
+	def self.log_error(error, logger)
+		logger.error "Error #{error.class.name}: #{error}"
+		error.backtrace.each do |where|
+			logger.error "\t#{where}"
+		end
+	end
+	
 	class BasicController
 		def initialize(script, logger)
 			@script = script
@@ -60,6 +91,10 @@ module LSync
 				connection, task = @server.shell.connect(@server)
 				connection.send_object([:chdir, root])
 				
+				# Convert all arguments to strings for execution.
+				# For some reason, the parent process hangs if you don't have this.. need to investigate further.
+				command = command.collect{|arg| arg.to_s}
+				
 				if options[:script]
 					data = command[0]
 					
@@ -73,16 +108,16 @@ module LSync
 						command[0] = "script"
 					end
 					
-					@logger.info "Running script #{command.inspect} on #{@server}"
+					@logger.info "Running script #{command.to_cmd} on #{@server}"
 					
 					connection.send_object([:script, command, data])
 				elsif options[:remote]
-					@logger.info "Running script #{command.inspect} on #{@server}"
+					@logger.info "Running script #{command.to_cmd} on #{@server}"
 					
 					data = File.read(command[0])
 					connection.send_object([:script, command, data])
 				else
-					@logger.info "Running command #{command.inspect} on #{@server}"
+					@logger.info "Running command #{command.to_cmd} on #{@server}"
 					connection.send_object([:exec, command])
 				end
 				
@@ -93,8 +128,12 @@ module LSync
 				end
 			ensure
 				if task
-					task.stop
-					task.wait
+					# task.stop
+					result = task.wait
+					
+					unless result.exitstatus == 0
+						raise CommandFailure.new(command, result.exitstatus)
+					end
 				end
 			end
 		end
@@ -105,7 +144,7 @@ module LSync
 				command = @server.shell.connection_command(@server) + ["--"] + command
 			end
 
-			@logger.debug "Executing #{command.inspect} on #{@server}"
+			@logger.info "Executing #{command.to_cmd} on #{@server}"
 			RExec::Task.open(command, options, &block)
 		end
 
@@ -116,7 +155,7 @@ module LSync
 				result = task.wait
 
 				unless result.exitstatus == 0
-					raise ShellScriptError.new("Command #{command.inspect} failed: #{result.exitstatus}", result.exitstatus)
+					raise CommandFailure.new(command, result.exitstatus)
 				end
 
 				return task.output.read

data/lib/lsync/error.rb

@@ -44,9 +44,9 @@ module LSync
 	end
 
 	# Indicates that a backup action shell script has failed.
-	class ShellScriptError < Error
-		def initialize(script, return_code)
-			super("Shell script #{script} failed", :return_code => return_code)
+	class CommandFailure < Error
+		def initialize(command, status)
+			super("Command #{command.inspect} failed with exit status #{status}", :command => command, :status => status)
 		end
 	end
 end

data/lib/lsync/event_handler.rb

@@ -42,7 +42,7 @@ module LSync
 					handled = true
 
 					if scope
-						scope.instance_eval &handler
+						scope.instance_exec *args, &handler
 					else
 						handler.call
 					end

data/lib/lsync/method.rb

@@ -20,7 +20,6 @@
 
 require 'fileutils'
 require 'pathname'
-require 'lsync/run'
 require 'lsync/event_handler'
 
 module LSync

data/lib/lsync/methods/rsync.rb

@@ -23,8 +23,42 @@ require 'lsync/method'
 module LSync
 	module Methods
 		
+		# RSync Exit Codes as of 2011:
+		
+		# 0      Success
+		# 1      Syntax or usage error
+		# 2      Protocol incompatibility
+		# 3      Errors selecting input/output files, dirs
+		# 4      Requested  action not supported: an attempt was made to manipulate 64-bit files on a platform 
+		#        that cannot support them; or an option was specified that is supported by the client and not by the server.
+		# 5      Error starting client-server protocol
+		# 6      Daemon unable to append to log-file
+		# 10     Error in socket I/O
+		# 11     Error in file I/O
+		# 12     Error in rsync protocol data stream
+		# 13     Errors with program diagnostics
+		# 14     Error in IPC code
+		# 20     Received SIGUSR1 or SIGINT
+		# 21     Some error returned by waitpid()
+		# 22     Error allocating core memory buffers
+		# 23     Partial transfer due to error
+		# 24     Partial transfer due to vanished source files
+		# 25     The --max-delete limit stopped deletions
+		# 30     Timeout in data send/receive
+		# 35     Timeout waiting for daemon connection
+		
 		class RSync < Method
-			protected
+			def initialize(direction, options = {})
+				super(options)
+
+				@direction = direction
+				@command = options[:command] || "rsync"
+
+				@options = options
+				@connection = nil
+			end
+			
+		protected
 			
 			def connect_arguments (local_server, remote_server)
 				# RSync -e option simply appends the hostname. There is no way to control this behaviour.
@@ -39,56 +73,60 @@ module LSync
 				return ['-e', command.to_cmd]
 			end
 
-			public
-			
-			def initialize(direction, options = {})
-				super(options)
-
-				@direction = direction
-				@command = options[:command] || "rsync"
-
-				@options = options
-				@connection = nil
-			end
-			
-			def run(controller)
-				directory = controller.directory
-				arguments = (@options[:arguments] || ["--archive"]) + (directory.options[:arguments] || [])
-
+			def configuration(controller, source_directory, destination_directory)
 				local_server = nil
 				remote_server = nil
+				source = nil
+				destination = nil
 
 				if @direction == :push
 					local_server = controller.master
 					remote_server = controller.target
 
-					destination = remote_server.connection_string(directory)
-					source = local_server.full_path(directory)
+					destination = remote_server.connection_string(destination_directory)
+					source = local_server.full_path(source_directory)
 				else
 					local_server = controller.target
 					remote_server = controller.master
 
-					source = remote_server.connection_string(directory)
-					destination = local_server.full_path(directory)
+					source = remote_server.connection_string(source_directory)
+					destination = local_server.full_path(destination_directory)
 				end
+				
+				return local_server, remote_server, source, destination
+			end
+			
+		public
+			
+			def run(controller)
+				directory = controller.directory
+				arguments = (@options[:arguments] || ["--archive"]) + (directory.options[:arguments] || [])
+
+				local_server, remote_server, source, destination = configuration(controller, controller.directory, controller.directory)
 
 				arguments += connect_arguments(local_server, remote_server)
 
 				# Create the destination backup directory
 				controller.target.exec!(["mkdir", "-p", controller.target.full_path(directory.path)])
 
-				controller.logger.info "In directory #{Dir.getwd}..."
-				Dir.chdir(local_server.root) do
-					if run_handler(controller, source, destination, arguments) == false
+				run_handler(controller, local_server, source, destination, arguments)
+			end
+			
+			def run_handler(controller, local_server, source, destination, arguments)
+				command = [@command] + arguments + [source, destination]
+
+				local_server.exec(command) do |task|
+					LSync::log_task(task, controller.logger)
+
+					result = task.wait
+
+					# Exit status 24 means that some files were deleted between indexing the data and copying it.
+					unless result.exitstatus == 0 || result.exitstatus == 24
 						raise BackupMethodError.new("Backup from #{source} to #{destination} failed.", :method => self)
 					end
 				end
 			end
 			
-			def run_handler(controller, source, destination, arguments)
-				run_command(controller, [@command] + arguments + [source, destination])
-			end
-			
 			def should_run?(controller)
 				if @direction == :push
 					return controller.current == controller.master
@@ -98,10 +136,6 @@ module LSync
 					return false
 				end
 			end
-			
-			def run_command(controller, command)
-				return LSync.run_command("/", command, controller.logger) == 0
-			end
 		end
 		
 		class RSyncSnapshot < RSync
@@ -118,33 +152,14 @@ module LSync
 
 				destination_directory = File.join(inprogress_path, directory.path)
 
-				local_server = nil
-				remote_server = nil
-
-				if @direction == :push
-					local_server = controller.master
-					remote_server = controller.target
-
-					destination = remote_server.connection_string(destination_directory)
-					source = local_server.full_path(directory)
-				else
-					local_server = controller.target
-					remote_server = controller.master
-
-					destination = local_server.full_path(destination_directory)
-					source = remote_server.connection_string(directory)
-				end
+				local_server, remote_server, source, destination = configuration(controller, controller.directory, destination_directory)
 
 				arguments += connect_arguments(local_server, remote_server)
 
 				# Create the destination backup directory
 				controller.target.exec!(["mkdir", "-p", controller.target.full_path(destination_directory)])
 
-				Dir.chdir(local_server.root) do
-					if run_handler(controller, source, destination, arguments) == false
-						raise BackupMethodError.new("Backup from #{source} to #{destination} failed.", :method => self)
-					end
-				end
+				run_handler(controller, local_server, source, destination, arguments)
 			end
 		end
 		

data/lib/lsync/script.rb

@@ -52,35 +52,51 @@ module LSync
 		end
 
 		# Given a name, find out which server config matches it
-		def find_named_server name
+		def find_named_server(name)
 			if @servers.key? name
 				return @servers[name]
 			else
 				hostname = Socket.gethostbyname(name)[0] rescue name
 				return @servers.values.find { |s| s.host == hostname }
 			end
+			
+			# No server was found for this name
+			return nil
 		end
 
 		alias :[] :find_named_server
 
 		# Find the master server based on the name #master= specified
 		def find_master_server
-			find_named_server(@master)
+			server = find_named_server(@master)
+			
+			# At this point we must know the current server or we can't continue
+			if server == nil
+				raise ScriptError.new("Could not determine master server!", :script => self, :name => @master)
+			end
+			
+			return server
 		end
 
-		# Find out the config section for the current server
+		# Find the server that matches the current machine
 		def find_current_server
 			master = find_master_server
 			server = nil
 
-			# Find out if the master server is local...
-			if master && master.local?
+			# There might be the case that the the local machine is both the master server and the backup server..
+			# thus we check first if the master server is the local machine:
+			if master.local?
 				server = master
 			else
 				# Find a server config that specifies the local host
 				server = @servers.values.find { |s| s.local? }
 			end
 
+			# At this point we must know the current server or we can't continue
+			if server == nil
+				raise ScriptError.new("Could not determine current server!", :script => self)
+			end
+
 			return server
 		end
 
@@ -144,11 +160,6 @@ module LSync
 			master = find_master_server
 			current = find_current_server
 
-			# At this point we must know the current server or we can't continue
-			if current == nil
-				raise ScriptError.new("Could not determine current server!", :script => self, :master => @master)
-			end
-
 			if master.local?
 				logger.info "We are the master server..."
 			else
@@ -158,8 +169,8 @@ module LSync
 
 			master_controller = ServerController.new(self, logger, master)
 
-			self.try do
-				method.try do
+			self.try(master_controller) do
+				method.try(master_controller) do
 					logger.info "Running backups for server #{current}..."
 
 					run_backups!(master, current, logger, options)

data/lib/lsync/tee_logger.rb

@@ -58,7 +58,7 @@ module LSync
 			@start_time ||= time
 			diff = time - @start_time
 			
-			"[T+#{sprintf('%0.1f', diff).ljust(5)} #{severity.rjust(5)}] #{msg}\n"
+			"[T+#{sprintf('%0.1f', diff).ljust(6)} #{severity.rjust(5)}] #{msg}\n"
 		end
 	end
 end

data/lib/lsync/version.rb

@@ -22,7 +22,7 @@ module LSync
   module VERSION
     MAJOR = 2
     MINOR = 3
-    TINY  = 1
+    TINY  = 2
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: lsync
 version: !ruby/object:Gem::Version 
-  hash: 1
+  hash: 7
   prerelease: 
   segments: 
   - 2
   - 3
-  - 1
-  version: 2.3.1
+  - 2
+  version: 2.3.2
 platform: ruby
 authors: 
 - Samuel Williams
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-08 00:00:00 Z
+date: 2011-08-09 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: fingerprint
@@ -41,12 +41,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 7
+        hash: 5
         segments: 
         - 1
         - 4
-        - 0
-        version: 1.4.0
+        - 1
+        version: 1.4.1
   type: :runtime
   version_requirements: *id002
 description: 
@@ -71,7 +71,6 @@ files:
 - lib/lsync/event_timer.rb
 - lib/lsync/method.rb
 - lib/lsync/methods/rsync.rb
-- lib/lsync/run.rb
 - lib/lsync/script.rb
 - lib/lsync/server.rb
 - lib/lsync/shell.rb

data/lib/lsync/run.rb

@@ -1,71 +0,0 @@
-# Copyright (c) 2007, 2011 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-
-require 'rexec/task'
-
-module LSync
-
-	def self.log_task(task, logger)
-		pipes = [task.output, task.error]
-
-		while pipes.size > 0
-			result = IO.select(pipes)
-
-			result[0].each do |pipe|
-				if pipe.closed? || pipe.eof?
-					pipes.delete(pipe)
-					next
-				end
-
-				if pipe == task.output
-					logger.info pipe.readline.chomp
-				elsif pipe == task.error
-					logger.error pipe.readline.chomp
-				end
-			end
-		end
-	end
-
-	# Run a specific command and output the results to the given logger.
-	def self.run_command(root, command, logger)
-		Dir.chdir(root) do
-			logger.info "Running #{command.inspect} in #{Dir.getwd.inspect}"
-
-			process_result = RExec::Task.open(command) do |task|
-				log_task(task, logger)
-			end
-
-			return process_result
-		end
-	end
-
-	def self.run_remote_command(root, connection_command, command, logger)
-		logger.info "Running remote command #{command.inspect} in #{root}"
-		
-		process_result = RExec::Task.open(connection_command) do |connection|
-			connection.puts(["cd", root].to_cmd)
-			connection.puts((["exec"] + command).to_cmd)
-			
-			LSync::log_task(connection, logger)
-		end
-		
-		return process_result
-	end
-end