synco 1.2.0 → 1.3.0

data/spec/synco/local_backup.rb

@@ -1,56 +0,0 @@
-#!/usr/bin/env ruby
-
-require 'synco'
-require 'synco/shells/ssh'
-require 'synco/methods/rsync'
-
-# Check we've got two paths for sync.
-unless ARGV.size == 2
-	$stderr.puts "Usage: #{$0} [master] [copy]"
-	exit(255)
-end
-
-# $growl = Growl.new "localhost", "Synco", ["Backup Status"]
-# $growl.register
-
-$stdout.sync = true
-$stderr.sync = true
-
-Synco::run_script do |script|
-	self.method = Synco::Methods::RSyncSnapshot.new(:push, "--archive", "--compress", "--stats")
-	
-	self.master = :src
-	
-	server(:src) do |server|
-		server.root = ARGV[0]
-	end
-	
-	server(:dst) do |server|
-		server.root = ARGV[1]
-		
-		# Runs after all directories have been successfully backed up.
-		server.on(:success) do
-			target.run "synco", "rotate"
-			target.run "synco", "prune"
-		end
-	end
-	
-	# This event is fired before the backup starts
-	#script.on(:prepare) do
-	#	$growl.notify "Backup Status", "Starting Backup", "Starting at #{Time.now.to_s}"
-	#end
-	#
-	## This event occurs if the backup is successful
-	#script.on(:success) do
-	#	$growl.notify "Backup Status", "Backup Successful", script.log.string
-	#end
-	#
-	## This event occurs if any part of the backup fails and is not handled elsewhere.
-	#script.on(:failure) do |failure|
-	#	$growl.notify "Backup Status", "Backup Failure", failure.to_s
-	#	
-	#	raise failure
-	#end
-	
-	backup('./')
-end

data/spec/synco/local_sync.rb

@@ -1,91 +0,0 @@
-#!/usr/bin/env ruby
-
-# You need to have the FSSM gem installed for this to work.
-require 'fssm'
-
-require 'synco'
-require 'synco/shells/ssh'
-require 'synco/methods/rsync'
-require 'synco/event_timer'
-
-MONITOR = ARGV.delete "-m"
-
-# Check we've got two paths for sync.
-unless ARGV.size == 2
-	$stderr.puts "Usage: #{$0} [master] [copy]"
-	exit(255)
-end
-
-script = Synco::Script.new do |script|
-	script.method = Synco::Methods::RSync.new(:push, :arguments => ["--archive", "--delete"])
-	
-	script.master = :src
-	
-	server(:src) do |server|
-		server.root = ARGV[0]
-	end
-	
-	server(:dst) do |server|
-		server.root = ARGV[1]
-		
-		#server.on(:prepare) do
-		#	logger.warn "Aborting backup!"
-		#	server.abort!
-		#end
-	end
-	
-	#server(:remote) do |server|
-	#	server.host = "ayako.oriontransfer.org"
-	#	server.shell = Synco::Shells::SSH.new(:user => "nobody")
-	#	server.root = "/tmp/sync-test"
-	#end
-	
-	#server(:remote2) do |server|
-	#	server.host = "remote2.example.com"
-	#	server.root = "/tmp/sync-test"
-	#	
-	#	server.on(:prepare) do |controller|
-	#		controller.run! "mysqldump", "..."
-	#	end
-	#	
-	#	server.on(:success) do |controller|
-	#		controller.run! "uname", "-a"
-	#	end
-	#end
-	
-	backup('./')
-end
-
-# Initial sync:
-
-context = Synco::Context.new(script)
-context.run!
-
-if MONITOR
-	# Monitor directories for changes:
-	monitor = FSSM::Monitor.new(:directories => true)
-
-	# The event timer aggregates events into a single callback which will be called at most
-	# once every k seconds (where k = 10 in this case).
-	$event_timer = Synco::EventTimer.new(10) do
-		$script.run!
-	end
-
-	$script.directories.each do |directory|
-		full_path = $script[:src].full_path(directory)
-		puts "Monitoring path: #{full_path}"
-	
-		monitor.path(full_path, "**/*") do
-			update { $event_timer.trigger! }
-			delete { $event_timer.trigger! }
-			create { $event_timer.trigger! }
-		end
-	end
-
-	begin
-		monitor.run
-	ensure
-		# We should wait for the backup to complete nicely.
-		$event_timer.join
-	end
-end

data/spec/synco/method_spec.rb

@@ -1,62 +0,0 @@
-#!/usr/bin/env rspec
-
-# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# 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 'synco/scope'
-require 'synco/methods/scp'
-
-require_relative 'backup_script'
-
-RSpec.describe Synco::Methods::SCP do
-	include_context "backup script"
-	
-	let(:test_server) {ENV.fetch('TEST_SERVER', 'localhost')}
-	
-	let(:script) {Synco::Script.new}
-	let(:logger) {Logger.new($stderr)}
-	let(:master_server) {Synco::Server.new('localhost', root: master_path)}
-	let(:target_server) {Synco::Server.new(test_server, root: target_path)}
-	
-	let(:group) {Process::Group.new}
-	let(:script_scope) {Synco::ScriptScope.new(script, logger, group)}
-	let(:sync_scope) {Synco::TargetScope.new(script_scope, target_server)}
-	
-	let(:directory) {Synco::Directory.new(".", arguments: ['--archive'])}
-	let(:directory_scope) {Synco::DirectoryScope.new(sync_scope, directory)}
-	
-	# This example shows all the state which goes into one single method invocation:
-	it 'should copy files from master to target' do
-		script.instance_variable_set(:@master_server, master_server)
-		script.instance_variable_set(:@current_server, master_server)
-		
-		expect(directory_scope.master_server).to_not be == nil
-		expect(directory_scope.target_server).to_not be == nil
-		expect(directory_scope.current_server).to_not be == nil
-
-		group.wait do
-			Fiber.new do
-				subject.call(directory_scope)
-			end.resume
-		end
-		
-		expect(Fingerprint).to be_identical(master_path, target_path)
-	end
-end

data/spec/synco/rsync_spec.rb

@@ -1,89 +0,0 @@
-#!/usr/bin/env rspec
-
-# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# 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 'logger'
-require 'synco/script'
-require 'synco/scope'
-require 'synco/methods/rsync'
-
-require_relative 'backup_script'
-
-RSpec.describe Synco::Methods::RSync do
-	include_context "backup script"
-	
-	it 'should copy files using rsync' do
-		script = Synco::Script.build do |script|
-			script.method = Synco::Methods::RSync.new(archive: true)
-			
-			script.server(:master) do |server|
-				server.root = master_path
-			end
-			
-			script.server(:backup) do |server|
-				server.root = target_path
-			end
-			
-			script.copy '.'
-		end
-		
-		expect(script.method.arguments).to include('--archive')
-		expect(script.method.arguments).to_not include('--stats')
-		
-		Synco::Runner.new(script).call
-		
-		expect(Fingerprint).to be_identical(master_path, target_path)
-	end
-	
-	it 'should copy files using rsync snapshot' do
-		script = Synco::Script.build do |script|
-			script.method = Synco::Methods::RSyncSnapshot.new
-			
-			script.server(:master) do |server|
-				server.root = master_path
-			end
-			
-			script.server(:backup) do |server|
-				server.root = target_path
-				
-				server.on(:success) do
-					run SYNCO_PATH, "rotate", chdir: target_server.root
-					run SYNCO_PATH, "prune", chdir: target_server.root
-				end
-			end
-			
-			script.copy '.', arguments: %W{--archive}
-		end
-		
-		expect(script.method.arguments).to include('--archive', '--stats')
-		
-		Synco::Runner.new(script).call
-		
-		expect(Fingerprint).to be_identical(master_path, File.join(target_path, Synco::LATEST_NAME))
-	end
-end
-
-RSpec.describe Synco::Methods::RSyncSnapshot do
-	it 'should generate correct command for ssh shell' do
-		expect(subject.escape(['ssh', '-o', 'BatchMode=yes'])).to be == 'ssh -o BatchMode=yes'
-	end
-end
-	

data/spec/synco/scp_spec.rb

@@ -1,58 +0,0 @@
-#!/usr/bin/env rspec
-
-# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# 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 'logger'
-require 'synco/script'
-require 'synco/scope'
-require 'synco/methods/scp'
-
-require_relative 'backup_script'
-
-RSpec.describe Synco::Methods::SCP do
-	include_context "backup script"
-	
-	it 'should build a script with desired configuration' do
-		script = Synco::Script.build do |script|
-			script.method = Synco::Methods::SCP.new
-			
-			script.server(:master) do |server|
-				server.root = master_path
-			end
-			
-			script.server(:target) do |server|
-				server.root = target_path
-			end
-			
-			script.copy(".")
-			
-			script.on(:failure) do |exception|
-				logger.error{exception}
-			end
-		end
-		
-		expect(script.events).to include(:failure)
-		
-		Synco::Runner.new(script).call
-		
-		expect(Fingerprint).to be_identical(master_path, target_path)
-	end
-end

data/spec/synco/script_spec.rb

@@ -1,51 +0,0 @@
-#!/usr/bin/env rspec
-
-# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# 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 'logger'
-require 'synco/script'
-require 'synco/methods/scp'
-
-RSpec.describe Synco::Script do
-	it 'should build a script with desired configuration' do
-		script = Synco::Script.build do |script|
-			script.server(:master) do |server|
-			end
-			
-			script.server(:backup) do |server|
-				server.root = 'backup'
-				
-				server.on(:prepare) do
-					run "synco", "mount", chdir: server.root
-				end
-			end
-		end
-		
-		# After building, everything should be frozen..
-		expect(script).to be_frozen
-		
-		# We should have the two servers defined:
-		expect(script.servers).to include(:master, :backup)
-		
-		# We should have a single event for backup server:
-		expect(script[:backup].events).to include(:prepare)
-	end
-end

data/spec/synco/shell_spec.rb

@@ -1,40 +0,0 @@
-#!/usr/bin/env rspec
-
-# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# 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 'synco/server'
-require 'synco/shells/ssh'
-
-RSpec.describe Synco::Shells::SSH do
-	let(:server) {Synco::Server.new('localhost')}
-	
-	it 'should generate a connection command' do
-		expect(subject.connection_command(server)).to be == ['ssh', 'localhost']
-	end
-end
-
-RSpec.describe Synco::Shells::SSH.new(batch_mode: true) do
-	let(:server) {Synco::Server.new('localhost')}
-	
-	it 'should generate a connection command with options' do
-		expect(subject.connection_command(server)).to be == ['ssh', '-o', 'BatchMode=yes', 'localhost']
-	end
-end

data/spec/synco/usb_spec.rb

@@ -1,76 +0,0 @@
-#!/usr/bin/env rspec
-
-# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# 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 'synco/disk'
-require 'synco/methods/rsync'
-require_relative 'backup_script'
-
-RSpec.describe Synco::Methods::RSyncSnapshot, if: Synco::Disk.available?('TEST') do
-	include_context "backup script"
-	
-	before(:each) do
-		Synco::Disk.unmount(target_path)
-	end
-	
-	after(:each) do
-		Synco::Disk.unmount(target_path)
-	end
-	
-	it 'should mount and backup to an attached USB stick' do
-		script = Synco::Script.build do |script|
-			script.method = Synco::Methods::RSyncSnapshot.new
-			
-			script.master = :source
-			
-			script.server(:source) do |server|
-				server.root = master_path
-			end
-			
-			script.server(:destination) do |server|
-				server.mountpoint = target_path
-				server.root = target_path
-				
-				server.on(:prepare) do
-					target_server.run "synco", "mount", target_server.mountpoint, 'TEST'
-				end
-				
-				# Runs after all directories have been successfully backed up.
-				server.on(:success) do
-					run "synco", "rotate", chdir: server.root
-					run "synco", "prune", chdir: server.root
-				end
-				
-				server.on(:finish) do
-					target_server.run "synco", "unmount", target_server.mountpoint
-				end
-			end
-			
-			script.backup('.')
-		end
-		
-		Synco::Runner.new(script).call
-		
-		Synco::Disk.mount(target_path, 'TEST')
-		
-		expect(Fingerprint).to be_identical(master_path, File.join(target_path, Synco::LATEST_NAME))
-	end
-end

data/spec/synco/zfs_spec.rb

@@ -1,50 +0,0 @@
-#!/usr/bin/env rspec
-
-# Copyright, 2016, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# 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 'logger'
-require 'synco/script'
-require 'synco/scope'
-require 'synco/methods/zfs'
-
-RSpec.describe Synco::Methods::ZFS do
-	xit 'should mirror two ZFS partitions' do
-		script = Synco::Script.build(master: :source) do |script|
-			script.method = Synco::Methods::ZFS.new
-			
-			script.server(:master) do |server|
-				server.host = 'hinoki.local'
-				server.root = '/tank/test/source'
-			end
-			
-			script.server(:backup) do |server|
-				server.host = 'hinoki.local'
-				server.root = '/tank/test/destination'
-			end
-			
-			script.copy("./")
-		end
-		
-		Synco::Runner.new(script).call
-		
-		expect(Fingerprint).to be_identical(script[:master].root, script[:backup].root)
-	end
-end

data/synco.gemspec

@@ -1,31 +0,0 @@
-
-require_relative 'lib/synco/version'
-
-Gem::Specification.new do |spec|
-	spec.name          = "synco"
-	spec.version       = Synco::VERSION
-	spec.authors       = ["Samuel Williams"]
-	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
-	spec.summary       = %q{Synco is a tool for scripted synchronization and backups.}
-	spec.homepage      = ""
-	spec.license       = "MIT"
-	
-	spec.files         = `git ls-files -z`.split("\x0")
-	spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-	spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-	spec.require_paths = ["lib"]
-	
-	spec.add_dependency("periodical", "~> 1.1")
-	spec.add_dependency("samovar", "~> 2.0")
-	spec.add_dependency("fingerprint", "~> 3.0")
-	spec.add_dependency("mapping", "~> 1.0")
-	spec.add_dependency("build-files", "~> 1.0")
-	spec.add_dependency("process-group", "~> 1.1")
-	
-	spec.add_dependency("lockfile")
-	
-	spec.add_development_dependency "covered"
-	spec.add_development_dependency "bundler"
-	spec.add_development_dependency "rspec", "~> 3.4"
-	spec.add_development_dependency "rake"
-end