dysinger-rush 0.4

data/spec/local_spec.rb

@@ -0,0 +1,313 @@
+require File.dirname(__FILE__) + '/base'
+
+describe Rush::Connection::Local do
+	before do
+		@sandbox_dir = "/tmp/rush_spec.#{Process.pid}"
+		system "rm -rf #{@sandbox_dir}; mkdir -p #{@sandbox_dir}"
+
+		@con = Rush::Connection::Local.new
+	end
+
+	after do
+		system "rm -rf #{@sandbox_dir}"
+	end
+
+	it "receive -> write_file(file, contents)" do
+		@con.should_receive(:write_file).with('file', 'contents')
+		@con.receive(:action => 'write_file', :full_path => 'file', :payload => 'contents')
+	end
+
+	it "receive -> file_contents(file)" do
+		@con.should_receive(:file_contents).with('file').and_return('the contents')
+		@con.receive(:action => 'file_contents', :full_path => 'file').should == 'the contents'
+	end
+
+	it "receive -> destroy(file or dir)" do
+		@con.should_receive(:destroy).with('file')
+		@con.receive(:action => 'destroy', :full_path => 'file')
+	end
+
+	it "receive -> purge(dir)" do
+		@con.should_receive(:purge).with('dir')
+		@con.receive(:action => 'purge', :full_path => 'dir')
+	end
+
+	it "receive -> create_dir(path)" do
+		@con.should_receive(:create_dir).with('dir')
+		@con.receive(:action => 'create_dir', :full_path => 'dir')
+	end
+
+	it "receive -> rename(path, name, new_name)" do
+		@con.should_receive(:rename).with('path', 'name', 'new_name')
+		@con.receive(:action => 'rename', :path => 'path', :name => 'name', :new_name => 'new_name')
+	end
+
+	it "receive -> copy(src, dst)" do
+		@con.should_receive(:copy).with('src', 'dst')
+		@con.receive(:action => 'copy', :src => 'src', :dst => 'dst')
+	end
+
+	it "receive -> read_archive(full_path)" do
+		@con.should_receive(:read_archive).with('full_path').and_return('archive data')
+		@con.receive(:action => 'read_archive', :full_path => 'full_path').should == 'archive data'
+	end
+
+	it "receive -> write_archive(archive, dir)" do
+		@con.should_receive(:write_archive).with('archive', 'dir')
+		@con.receive(:action => 'write_archive', :dir => 'dir', :payload => 'archive')
+	end
+
+	it "receive -> index(base_path, glob)" do
+		@con.should_receive(:index).with('base_path', '*').and_return(%w(1 2))
+		@con.receive(:action => 'index', :base_path => 'base_path', :glob => '*').should == "1\n2\n"
+	end
+
+	it "receive -> stat(full_path)" do
+		@con.should_receive(:stat).with('full_path').and_return(1 => 2)
+		@con.receive(:action => 'stat', :full_path => 'full_path').should == YAML.dump(1 => 2)
+	end
+
+	it "receive -> set_access(full_path, user, group, permissions)" do
+		access = mock("access")
+		Rush::Access.should_receive(:from_hash).with(:action => 'set_access', :full_path => 'full_path', :user => 'joe').and_return(access)
+
+		@con.should_receive(:set_access).with('full_path', access)
+		@con.receive(:action => 'set_access', :full_path => 'full_path', :user => 'joe')
+	end
+
+	it "receive -> size(full_path)" do
+		@con.should_receive(:size).with('full_path').and_return("1024")
+		@con.receive(:action => 'size', :full_path => 'full_path').should == "1024"
+	end
+
+	it "receive -> processes" do
+		@con.should_receive(:processes).with().and_return([ { :pid => 1 } ])
+		@con.receive(:action => 'processes').should == YAML.dump([ { :pid => 1 } ])
+	end
+
+	it "receive -> process_alive" do
+		@con.should_receive(:process_alive).with(123).and_return(true)
+		@con.receive(:action => 'process_alive', :pid => 123).should == '1'
+	end
+
+	it "receive -> kill_process" do
+		@con.should_receive(:kill_process).with(123).and_return(true)
+		@con.receive(:action => 'kill_process', :pid => '123')
+	end
+
+	it "receive -> bash (foreground)" do
+		@con.should_receive(:bash).with('cmd', 'user', false).and_return('output')
+		@con.receive(:action => 'bash', :payload => 'cmd', :user => 'user', :background => 'false').should == 'output'
+	end
+
+	it "receive -> bash (background)" do
+		@con.should_receive(:bash).with('cmd', 'user', true).and_return('output')
+		@con.receive(:action => 'bash', :payload => 'cmd', :user => 'user', :background => 'true').should == 'output'
+	end
+
+	it "receive -> unknown action exception" do
+		lambda { @con.receive(:action => 'does_not_exist') }.should raise_error(Rush::Connection::Local::UnknownAction)
+	end
+
+	it "write_file writes contents to a file" do
+		fname = "#{@sandbox_dir}/a_file"
+		data = "some data"
+		@con.write_file(fname, data)
+		File.read(fname).should == data
+	end
+
+	it "file_contents reads a file's contents" do
+		fname = "#{@sandbox_dir}/a_file"
+		system "echo stuff > #{fname}"
+		@con.file_contents(fname).should == "stuff\n"
+	end
+
+	it "file_contents raises DoesNotExist if the file does not exist" do
+		fname = "#{@sandbox_dir}/does_not_exist"
+		lambda { @con.file_contents(fname) }.should raise_error(Rush::DoesNotExist, fname)
+	end
+
+	it "destroy to destroy a file or dir" do
+		fname = "#{@sandbox_dir}/delete_me"
+		system "touch #{fname}"
+		@con.destroy(fname)
+		File.exists?(fname).should be_false
+	end
+
+	it "purge to purge a dir" do
+		system "cd #{@sandbox_dir}; touch {1,2}; mkdir 3; touch 3/4"
+		@con.purge(@sandbox_dir)
+		File.exists?(@sandbox_dir).should be_true
+		Dir.glob("#{@sandbox_dir}/*").should == []
+	end
+
+	it "purge kills hidden (dotfile) entries too" do
+		system "cd #{@sandbox_dir}; touch .killme"
+		@con.purge(@sandbox_dir)
+		File.exists?(@sandbox_dir).should be_true
+		`cd #{@sandbox_dir}; ls -lA | grep -v total | wc -l`.to_i.should == 0
+	end
+
+	it "create_dir creates a directory" do
+		fname = "#{@sandbox_dir}/a/b/c/"
+		@con.create_dir(fname)
+		File.directory?(fname).should be_true
+	end
+
+	it "rename to rename entries within a dir" do
+		system "touch #{@sandbox_dir}/a"
+		@con.rename(@sandbox_dir, 'a', 'b')
+		File.exists?("#{@sandbox_dir}/a").should be_false
+		File.exists?("#{@sandbox_dir}/b").should be_true
+	end
+
+	it "copy to copy an entry to another dir on the same box" do
+		system "mkdir #{@sandbox_dir}/subdir"
+		system "touch #{@sandbox_dir}/a"
+		@con.copy("#{@sandbox_dir}/a", "#{@sandbox_dir}/subdir")
+		File.exists?("#{@sandbox_dir}/a").should be_true
+		File.exists?("#{@sandbox_dir}/subdir/a").should be_true
+	end
+
+	it "copy raises DoesNotExist with source path if it doesn't exist or otherwise can't be accessed" do
+		lambda { @con.copy('/does/not/exist', '/tmp') }.should raise_error(Rush::DoesNotExist, '/does/not/exist')
+	end
+
+	it "copy raises DoesNotExist with destination path if it can't access the destination" do
+		lambda { @con.copy('/tmp', '/does/not/exist') }.should raise_error(Rush::DoesNotExist, '/does/not')
+	end
+
+	it "read_archive to pull an archive of a dir into a byte stream" do
+		system "touch #{@sandbox_dir}/a"
+		@con.read_archive(@sandbox_dir).size.should > 50
+	end
+
+	it "write_archive to turn a byte stream into a dir" do
+		system "cd #{@sandbox_dir}; mkdir -p a; touch a/b; tar cf xfer.tar a; mkdir dst"
+		archive = File.read("#{@sandbox_dir}/xfer.tar")
+		@con.write_archive(archive, "#{@sandbox_dir}/dst")
+		File.directory?("#{@sandbox_dir}/dst/a").should be_true
+		File.exists?("#{@sandbox_dir}/dst/a/b").should be_true
+	end
+
+	it "index fetches list of all files and dirs in a dir when pattern is empty" do
+		system "cd #{@sandbox_dir}; mkdir dir; touch file"
+		@con.index(@sandbox_dir, '').should == [ 'dir/', 'file' ]
+	end
+
+	it "index fetches only files with a certain extension with a flat pattern, *.rb" do
+		system "cd #{@sandbox_dir}; touch a.rb; touch b.txt"
+		@con.index(@sandbox_dir, '*.rb').should == [ 'a.rb' ]
+	end
+
+	it "index raises DoesNotExist when the base path is invalid" do
+		lambda { @con.index('/does/not/exist', '*') }.should raise_error(Rush::DoesNotExist, '/does/not/exist')
+	end
+
+	it "stat gives file stats like size and timestamps" do
+		@con.stat(@sandbox_dir).should have_key(:ctime)
+		@con.stat(@sandbox_dir).should have_key(:size)
+	end
+
+	it "stat fetches the octal permissions" do
+		@con.stat(@sandbox_dir)[:mode].should be_kind_of(Fixnum)
+	end
+
+	it "stat raises DoesNotExist if the entry does not exist" do
+		fname = "#{@sandbox_dir}/does_not_exist"
+		lambda { @con.stat(fname) }.should raise_error(Rush::DoesNotExist, fname)
+	end
+
+	it "set_access invokes the access object" do
+		access = mock("access")
+		access.should_receive(:apply).with('/some/path')
+		@con.set_access('/some/path', access)
+	end
+
+	if !RUBY_PLATFORM.match(/darwin/)   # doesn't work on OS X 'cause du switches are different
+		it "size gives size of a directory and all its contents recursively" do
+			system "mkdir -p #{@sandbox_dir}/a/b/; echo 1234 > #{@sandbox_dir}/a/b/c"
+			@con.size(@sandbox_dir).should == (4096*3 + 5)
+		end
+	end
+
+	it "parses ps output on os x" do
+		@con.parse_ps("21712   501   21711   1236   0 /usr/bin/vi somefile.rb").should == {
+			:pid => "21712",
+			:uid => "501",
+			:parent_pid => 21711,
+			:mem => 1236,
+			:cpu => 0,
+			:command => '/usr/bin/vi',
+			:cmdline => '/usr/bin/vi somefile.rb',
+		}
+	end
+
+	it "gets the list of processes on os x via the ps command" do
+		@con.should_receive(:os_x_raw_ps).and_return <<EOPS
+PID UID   PPID  RSS  CPU COMMAND
+1     0      1 1111   0 cmd1 args
+2   501      1  222   1 cmd2
+EOPS
+		@con.os_x_processes.should == [
+			{ :pid => "1", :uid => "0", :parent_pid => 1, :mem => 1111, :cpu => 0, :command => "cmd1", :cmdline => "cmd1 args" },
+			{ :pid => "2", :uid => "501", :parent_pid => 1, :mem => 222, :cpu => 1, :command => "cmd2", :cmdline => "cmd2" },
+		]
+	end
+
+	it "the current process should be alive" do
+		@con.process_alive(Process.pid).should be_true
+	end
+
+	it "a made-up process should not be alive" do
+		@con.process_alive(99999).should be_false
+	end
+
+	it "kills a process by pid" do
+		::Process.should_receive(:kill).at_least(:once)
+		@con.kill_process(123)
+	end
+
+	it "does not raise an error if the process is already dead" do
+		::Process.should_receive(:kill).and_raise(Errno::ESRCH)
+		lambda { @con.kill_process(123) }.should_not raise_error
+	end
+
+	it "executes a bash command, returning stdout when successful" do
+		@con.bash("echo test").should == "test\n"
+	end
+
+	it "executes a bash command, raising and error (with stderr as the message) when return value is nonzero" do
+		lambda { @con.bash("no_such_bin") }.should raise_error(Rush::BashFailed, /command not found/)
+	end
+
+	it "executes a bash command as another user using sudo" do
+		@con.bash("echo test2", ENV['USER']).should == "test2\n"
+	end
+
+	it "executes a bash command in the background, returning the pid" do
+		@con.bash("true", nil, true).should > 0
+	end
+
+	it "ensure_tunnel to match with remote connection" do
+		@con.ensure_tunnel
+	end
+
+	it "always returns true on alive?" do
+		@con.should be_alive
+	end
+
+	it "resolves a unix uid to a user" do
+		@con.resolve_unix_uid_to_user(0).should == "root"
+		@con.resolve_unix_uid_to_user('0').should == "root"
+	end
+
+	it "returns nil if the unix uid does not exist" do
+		@con.resolve_unix_uid_to_user(9999).should be_nil
+	end
+
+	it "iterates through a process list and resolves the unix uid for each" do
+		list = [ { :uid => 0, :command => 'pureftpd' }, { :uid => 9999, :command => 'defunk' } ]
+		@con.resolve_unix_uids(list).should == [ { :uid => 0, :user => 'root', :command => 'pureftpd' }, { :uid => 9999, :command => 'defunk', :user => nil } ]
+	end
+end

data/spec/process_set_spec.rb

@@ -0,0 +1,50 @@
+require File.dirname(__FILE__) + '/base'
+
+describe Rush::ProcessSet do
+	before do
+		@process = mock('process')
+		@set = Rush::ProcessSet.new([ @process ])
+	end
+
+	it "is Enumerable" do
+		@set.select { |s| s == @process }.should == [ @process ]
+	end
+
+	it "defines size" do
+		@set.size.should == 1
+	end
+
+	it "defines first" do
+		@set.first.should == @process
+	end
+
+	it "is equal to sets with the same contents" do
+		@set.should == Rush::ProcessSet.new([ @process ])
+	end
+
+	it "is equal to arrays with the same contents" do
+		@set.should == [ @process ]
+	end
+
+	it "kills all processes in the set" do
+		@process.should_receive(:kill)
+		@set.kill
+	end
+
+	it "checks the alive? state of all processes in the set" do
+		@process.should_receive(:alive?).and_return(true)
+		@set.alive?.should == [ true ]
+	end
+
+	it "filters the set from a conditions hash and returns the filtered set" do
+		@process.stub!(:pid).and_return(123)
+		@set.filter(:pid => 123).first.should == @process
+		@set.filter(:pid => 456).size.should == 0
+	end
+
+	it "filters with regexps if provided in the conditions" do
+		@process.stub!(:command).and_return('foobaz')
+		@set.filter(:command => /baz/).first.should == @process
+		@set.filter(:command => /blerg/).size.should == 0
+	end
+end

data/spec/process_spec.rb

@@ -0,0 +1,73 @@
+require File.dirname(__FILE__) + '/base'
+
+describe Rush::Process do
+	before do
+		@pid = fork do
+			sleep 999
+		end
+		@process = Rush::Process.all.detect { |p| p.pid == @pid }
+	end
+
+	after do
+		system "kill -9 #{@pid}"
+	end
+
+	if !RUBY_PLATFORM.match(/darwin/)   # OS x reports pids weird
+		it "knows all its child processes" do
+			parent = Rush::Process.all.detect { |p| p.pid == Process.pid }
+			parent.children.should == [ @process ]
+		end
+	end
+
+	it "gets the list of all processes" do
+		list = Rush::Process.all
+		list.size.should > 5
+		list.first.should be_kind_of(Rush::Process)
+	end
+
+	it "knows the pid" do
+		@process.pid.should == @pid
+	end
+
+	it "knows the uid" do
+		@process.uid.should == ::Process.uid
+	end
+
+	it "knows the executed binary" do
+		@process.command.should match(/^ruby/)
+	end
+
+	it "knows the command line" do
+		@process.cmdline.should match(/process_spec.rb/)
+	end
+
+	it "knows the memory used" do
+		@process.mem.should > 0
+	end
+
+	it "knows the cpu used" do
+		@process.cpu.should >= 0
+	end
+
+	it "knows the parent process pid" do
+		@process.parent_pid.should == Process.pid
+	end
+
+	it "knows the parent process" do
+		this = Rush::Box.new.processes.select { |p| p.pid == Process.pid }.first
+		@process.parent.should == this
+	end
+
+	it "can kill itself" do
+		system "sleep 30 &"
+		process = Rush::Process.all.detect { |p| p.command == "sleep" }
+		process.kill
+		sleep 0.1
+		process.alive?.should be_false
+	end
+
+	it "if box and pid are the same, process is equal" do
+		other = Rush::Process.new({ :pid => @process.pid }, @process.box)
+		@process.should == other
+	end
+end

data/spec/remote_spec.rb

@@ -0,0 +1,135 @@
+require File.dirname(__FILE__) + '/base'
+
+describe Rush::Connection::Local do
+	before do
+		@sandbox_dir = "/tmp/rush_spec.#{Process.pid}"
+		system "rm -rf #{@sandbox_dir}; mkdir -p #{@sandbox_dir}"
+
+		@con = Rush::Connection::Remote.new('spec.example.com')
+	end
+
+	after do
+		system "rm -rf #{@sandbox_dir}"
+	end
+
+	it "transmits write_file" do
+		@con.should_receive(:transmit).with(:action => 'write_file', :full_path => 'file', :payload => 'contents')
+		@con.write_file('file', 'contents')
+	end
+
+	it "transmits file_contents" do
+		@con.should_receive(:transmit).with(:action => 'file_contents', :full_path => 'file').and_return('contents')
+		@con.file_contents('file').should == 'contents'
+	end
+
+	it "transmits destroy" do
+		@con.should_receive(:transmit).with(:action => 'destroy', :full_path => 'file')
+		@con.destroy('file')
+	end
+
+	it "transmits purge" do
+		@con.should_receive(:transmit).with(:action => 'purge', :full_path => 'dir')
+		@con.purge('dir')
+	end
+
+	it "transmits create_dir" do
+		@con.should_receive(:transmit).with(:action => 'create_dir', :full_path => 'file')
+		@con.create_dir('file')
+	end
+
+	it "transmits rename" do
+		@con.should_receive(:transmit).with(:action => 'rename', :path => 'path', :name => 'name', :new_name => 'new_name')
+		@con.rename('path', 'name', 'new_name')
+	end
+
+	it "transmits copy" do
+		@con.should_receive(:transmit).with(:action => 'copy', :src => 'src', :dst => 'dst')
+		@con.copy('src', 'dst')
+	end
+
+	it "transmits read_archive" do
+		@con.should_receive(:transmit).with(:action => 'read_archive', :full_path => 'full_path').and_return('archive data')
+		@con.read_archive('full_path').should == 'archive data'
+	end
+
+	it "transmits write_archive" do
+		@con.should_receive(:transmit).with(:action => 'write_archive', :dir => 'dir', :payload => 'archive')
+		@con.write_archive('archive', 'dir')
+	end
+
+	it "transmits index" do
+		@con.should_receive(:transmit).with(:action => 'index', :base_path => 'base_path', :glob => '*').and_return("1\n2\n")
+		@con.index('base_path', '*').should == %w(1 2)
+	end
+
+	it "transmits stat" do
+		@con.should_receive(:transmit).with(:action => 'stat', :full_path => 'full_path').and_return(YAML.dump(1 => 2))
+		@con.stat('full_path').should == { 1 => 2 }
+	end
+
+	it "transmits set_access" do
+		@con.should_receive(:transmit).with(:action => 'set_access', :full_path => 'full_path', :user => 'joe', :user_read => 1)
+		@con.set_access('full_path', :user => 'joe', :user_read => 1)
+	end
+
+	it "transmits size" do
+		@con.should_receive(:transmit).with(:action => 'size', :full_path => 'full_path').and_return("123")
+		@con.size('full_path').should == 123
+	end
+
+	it "transmits processes" do
+		@con.should_receive(:transmit).with(:action => 'processes').and_return(YAML.dump([ { :pid => 1 } ]))
+		@con.processes.should == [ { :pid => 1 } ]
+	end
+
+	it "transmits process_alive" do
+		@con.should_receive(:transmit).with(:action => 'process_alive', :pid => 123).and_return(true)
+		@con.process_alive(123).should == true
+	end
+
+	it "transmits kill_process" do
+		@con.should_receive(:transmit).with(:action => 'kill_process', :pid => 123)
+		@con.kill_process(123)
+	end
+
+	it "transmits bash" do
+		@con.should_receive(:transmit).with(:action => 'bash', :payload => 'cmd', :user => 'user', :background => 'bg').and_return('output')
+		@con.bash('cmd', 'user', 'bg').should == 'output'
+	end
+
+	it "an http result code of 401 raises NotAuthorized" do
+		lambda { @con.process_result("401", "") }.should raise_error(Rush::NotAuthorized)
+	end
+
+	it "an http result code of 400 raises the exception passed in the result body" do
+		@con.stub!(:parse_exception).and_return(Rush::DoesNotExist, "message")
+		lambda { @con.process_result("400", "") }.should raise_error(Rush::DoesNotExist)
+	end
+
+	it "an http result code of 501 (or anything other than the other defined codes) raises FailedTransmit" do
+		lambda { @con.process_result("501", "") }.should raise_error(Rush::FailedTransmit)
+	end
+
+	it "parse_exception takes the class from the first line and the message from the second" do
+		@con.parse_exception("Rush::DoesNotExist\nthe message\n").should == [ Rush::DoesNotExist, "the message" ]
+	end
+
+	it "parse_exception rejects unrecognized exceptions" do
+		lambda { @con.parse_exception("NotARushException\n") }.should raise_error
+	end
+
+	it "passes through ensure_tunnel" do
+		@con.tunnel.should_receive(:ensure_tunnel)
+		@con.ensure_tunnel
+	end
+
+	it "is alive if the box is responding to commands" do
+		@con.should_receive(:index).and_return(:dummy)
+		@con.should be_alive
+	end
+
+	it "not alive if an attempted command throws an exception" do
+		@con.should_receive(:index).and_raise(RuntimeError)
+		@con.should_not be_alive
+	end
+end