adamwiggins-rush 0.6.1

data/spec/array_ext_spec.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + '/base'
+
+describe Array do
+	it "mixes commands into array" do
+		[ 1,2,3 ].entries.should == [ 1, 2, 3 ]
+	end
+
+	it "can call head" do
+		[ 1,2,3 ].head(1).should == [ 1 ]
+	end
+
+	it "can call tail" do
+		[ 1,2,3 ].tail(1).should == [ 3 ]
+	end
+end

data/spec/base.rb

@@ -0,0 +1,24 @@
+require 'rubygems'
+require 'spec'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+require 'rush'
+
+def mock_config(&block)
+	mock_config_start
+	block.call(config)
+	mock_config_end
+end
+
+def mock_config_sandbox_dir
+	"/tmp/fake_config.#{Process.pid}"
+end
+
+def mock_config_start
+	mock_config_cleanup
+	Rush::Config.new(mock_config_sandbox_dir)
+end
+
+def mock_config_cleanup
+	FileUtils.rm_rf(mock_config_sandbox_dir)
+end

data/spec/box_spec.rb

@@ -0,0 +1,64 @@
+require File.dirname(__FILE__) + '/base'
+
+describe Rush::Box do
+	before do
+		@sandbox_dir = "/tmp/rush_spec.#{Process.pid}"
+		system "rm -rf #{@sandbox_dir}; mkdir -p #{@sandbox_dir}"
+
+		@box = Rush::Box.new('localhost')
+	end
+
+	after do
+		system "rm -rf #{@sandbox_dir}"
+	end
+
+	it "looks up entries with [] syntax" do
+		@box['/'].should == Rush::Dir.new('/', @box)
+	end
+
+	it "looks up processes" do
+		@box.connection.should_receive(:processes).and_return([ { :pid => 123 } ])
+		@box.processes.should == [ Rush::Process.new({ :pid => 123 }, @box) ]
+	end
+
+	it "executes bash commands" do
+		@box.connection.should_receive(:bash).with('cmd', nil, false).and_return('output')
+		@box.bash('cmd').should == 'output'
+	end
+
+	it "executes bash commands with an optional user" do
+		@box.connection.should_receive(:bash).with('cmd', 'user', false)
+		@box.bash('cmd', :user => 'user')
+	end
+
+	it "executes bash commands in the background, returning a Rush::Process" do
+		@box.connection.should_receive(:bash).with('cmd', nil, true).and_return(123)
+		@box.stub!(:processes).and_return([ mock('ps', :pid => 123) ])
+		@box.bash('cmd', :background => true).pid.should == 123
+	end
+
+	it "builds a script of environment variables to prefix the bash command" do
+		@box.command_with_environment('cmd', { :a => 'b' }).should == "export a='b'\ncmd"
+	end
+
+	it "sets the environment variables from the provided hash" do
+		@box.connection.stub!(:bash)
+		@box.should_receive(:command_with_environment).with('cmd', { 1 => 2 })
+		@box.bash('cmd', :env => { 1 => 2 })
+	end
+
+	it "checks the connection to determine if it is alive" do
+		@box.connection.should_receive(:alive?).and_return(true)
+		@box.should be_alive
+	end
+
+	it "establish_connection to set up the connection manually" do
+		@box.connection.should_receive(:ensure_tunnel)
+		@box.establish_connection
+	end
+
+	it "establish_connection can take a hash of options" do
+		@box.connection.should_receive(:ensure_tunnel).with(:timeout => :infinite)
+		@box.establish_connection(:timeout => :infinite)
+	end
+end

data/spec/commands_spec.rb

@@ -0,0 +1,47 @@
+require File.dirname(__FILE__) + '/base'
+
+describe Rush::Commands do
+	before do
+		@sandbox_dir = "/tmp/rush_spec.#{Process.pid}"
+		system "rm -rf #{@sandbox_dir}; mkdir -p #{@sandbox_dir}"
+
+		@filename = "test_file"
+		system "echo thing_to_find > #{@sandbox_dir}/#{@filename}"
+		system "echo dont_find_me > #{@sandbox_dir}/some_other_file"
+
+		@dir = Rush::Dir.new(@sandbox_dir)
+		@array = @dir.files
+	end
+
+	after do
+		system "rm -rf #{@sandbox_dir}"
+	end
+
+	it "searches a list of files" do
+		results = @dir.files.search(/thing_to_find/)
+		results.should be_kind_of(Rush::SearchResults)
+		results.entries.should == [ @dir[@filename] ]
+		results.lines.should == [ "thing_to_find" ]
+	end
+
+	it "searches a dir" do
+		@dir.search(/thing_to_find/).entries.should == [ @dir[@filename] ]
+	end
+
+	it "searchs a dir's nested files" do
+		@dir.create_dir('sub').create_file('file').write('nested')
+		@dir['**'].search(/nested/).entries.should == [ @dir['sub/file'] ]
+	end
+
+	it "search and replace contents on all files in the glob" do
+		@dir['1'].create.write('xax')
+		@dir['2'].create.write('-a-')
+		@dir.replace_contents!(/a/, 'b')
+		@dir['1'].contents.should == "xbx"
+		@dir['2'].contents.should == "-b-"
+	end
+
+	it "counts lines of the contained files" do
+		@dir.files.line_count.should == 2
+	end
+end

data/spec/config_spec.rb

@@ -0,0 +1,108 @@
+require File.dirname(__FILE__) + '/base'
+
+describe Rush::Config do
+	before do
+		@sandbox_dir = "/tmp/rush_config_spec.#{Process.pid}"
+		system "rm -rf #{@sandbox_dir}"
+		@config = Rush::Config.new(@sandbox_dir)
+	end
+
+	after do
+		system "rm -rf #{@sandbox_dir}"
+	end
+
+	it "creates the dir" do
+		File.directory?(@sandbox_dir).should be_true
+	end
+
+	it "can access the history file" do
+		@config.history_file.class.should == Rush::File
+	end
+
+	it "saves the shell command history" do
+		@config.save_history(%w(1 2 3))
+		@config.history_file.contents.should == "1\n2\n3\n"
+	end
+
+	it "loads the shell command history" do
+		@config.save_history(%w(1 2 3))
+		@config.load_history.should == %w(1 2 3)
+	end
+
+	it "loads a blank history if no history file" do
+		@config.load_history.should == []
+	end
+
+	it "loads the env file" do
+		@config.env_file.write('abc')
+		@config.load_env.should == 'abc'
+	end
+
+	it "loads nothing if env file does not exist" do
+		@config.load_env.should == ""
+	end
+
+	it "loads the commands file" do
+		@config.commands_file.write('abc')
+		@config.load_commands.should == 'abc'
+	end
+
+	it "loads nothing if commands file does not exist" do
+		@config.load_commands.should == ""
+	end
+
+	it "loads usernames and password for rushd" do
+		system "echo 1:2 > #{@sandbox_dir}/passwords"
+		system "echo a:b >> #{@sandbox_dir}/passwords"
+		@config.passwords.should == { '1' => '2', 'a' => 'b' }
+	end
+
+	it "loads blank hash if no passwords file" do
+		@config.passwords.should == { }
+	end
+
+	it "loads credentials for client connecting to server" do
+		system "echo user:pass > #{@sandbox_dir}/credentials"
+		@config.credentials_user.should == 'user'
+		@config.credentials_password.should == 'pass'
+	end
+
+	it "loads list of ssh tunnels" do
+		system "echo host.example.com:123 > #{@sandbox_dir}/tunnels"
+		@config.tunnels.should == { 'host.example.com' => 123 }
+	end
+
+	it "returns an empty hash if tunnels file is blank" do
+		@config.tunnels.should == { }
+	end
+
+	it "saves a list of ssh tunnels" do
+		@config.save_tunnels({ 'my.example.com' => 4000 })
+		@config.tunnels_file.contents.should == "my.example.com:4000\n"
+	end
+
+	it "ensure_credentials_exist doesn't do anything if credentials already exist" do
+		@config.credentials_file.write "dummy"
+		@config.should_receive(:generate_credentials).exactly(0).times
+		@config.ensure_credentials_exist
+	end
+
+	it "ensure_credentials_exist generates credentials file if they don't exist" do
+		@config.should_receive(:generate_credentials)
+		@config.ensure_credentials_exist
+	end
+
+	it "secret_characters returns valid characters for username or password" do
+		@config.secret_characters.should be_kind_of(Array)
+	end
+
+	it "generate_secret products a random string for use in username and password" do
+		@config.should_receive(:secret_characters).and_return(%w(a))
+		@config.generate_secret(2, 2).should == "aa"
+	end
+
+	it "generate_credentials saves credentials" do
+		@config.generate_credentials
+		@config.credentials_file.contents.should match(/^.+:.+$/)
+	end
+end

data/spec/dir_spec.rb

@@ -0,0 +1,164 @@
+require File.dirname(__FILE__) + '/base'
+
+describe Rush::Dir do
+	before do
+		@sandbox_dir = "/tmp/rush_spec.#{Process.pid}"
+		system "rm -rf #{@sandbox_dir}; mkdir -p #{@sandbox_dir}"
+
+		@dirname = "#{@sandbox_dir}/test_dir/"
+		system "mkdir -p #{@dirname}"
+
+		@dir = Rush::Dir.new(@dirname)
+	end
+
+	after do
+		system "rm -rf #{@sandbox_dir}"
+	end
+
+	it "is a child of Rush::Entry" do
+		@dir.should be_kind_of(Rush::Entry)
+	end
+
+	it "can create itself, returning itself" do
+		system "rm -rf #{@sandbox_dir}"
+		@dir.create.should == @dir
+		File.directory?(@dir.full_path).should be_true
+	end
+
+	it "can create a new file" do
+		newfile = @dir.create_file('one.txt')
+		newfile.name.should == 'one.txt'
+		newfile.parent.should == @dir
+	end
+
+	it "can create a new subdir" do
+		newfile = @dir['two/'].create
+		newfile.name.should == 'two'
+		newfile.parent.should == @dir
+	end
+
+	it "find_by_name finds a single entry in the contents" do
+		file = @dir.create_file('one.rb')
+		@dir.find_by_name('one.rb').should == file
+	end
+
+	it "find_by_glob finds a list of entries by wildcard" do
+		file1 = @dir.create_file('one.rb')
+		file2 = @dir.create_file('two.txt')
+		@dir.find_by_glob('*.rb').should == [ file1 ]
+	end
+
+	it "lists files" do
+		@dir.create_file('a')
+		@dir.files.should == [ Rush::File.new("#{@dirname}/a") ]
+	end
+
+	it "lists dirs" do
+		system "mkdir -p #{@dir.full_path}/b"
+		@dir.dirs.should == [ Rush::Dir.new("#{@dirname}/b") ]
+	end
+
+	it "lists combined files and dirs" do
+		@dir['c'].create
+		@dir['d/'].create
+		@dir.contents.size.should == 2
+	end
+
+	it "fetches the entry_tree of all contents recursively" do
+		@dir['a/'].create['b/'].create['c'].create
+		@dir.entries_tree.should == @dir.make_entries(%w(a/ a/b/ a/b/c))
+	end
+
+	it "maps [] to find_by_name" do
+		@dir.should_receive(:find_by_name).once
+		@dir['one']
+	end
+
+	it "maps [] with a wildcard character to find_by_glob" do
+		@dir.should_receive(:find_by_glob).once
+		@dir['*']
+	end
+
+	it "can use symbols or strings for [] access" do
+		@dir.should_receive(:find_by_name).once.with('subdir')
+		@dir[:subdir]
+	end
+
+	it "[] can return a file that has yet to be created" do
+		@dir['not_yet'].class.should == Rush::File
+	end
+
+	it "makes a list of entries from an array of filenames" do
+		@dir['a'].create
+		@dir['b/c/'].create
+		@dir.make_entries(%w(a b/c)).should == [ @dir['a'], @dir['b/c'] ]
+	end
+
+	it "lists flattened files from all nested subdirectories" do
+		@dir['1'].create
+		@dir['2/3/'].create['4'].create
+		@dir['a/b/c/'].create['d'].create
+		@dir.files_flattened.should == @dir.make_entries(%w(1 2/3/4 a/b/c/d))
+	end
+
+	it "lists flattened dirs from all nested subdirectories" do
+		@dir.create_dir('1/2')
+		@dir.dirs_flattened.should == @dir.make_entries(%w(1/ 1/2/))
+	end
+
+	it "** as a shortcut to flattened_files" do
+		@dir['**'].should == @dir.files_flattened
+	end
+
+	it "**/ as a shortcut to flattened_files + regular globbing" do
+		@dir.create_file('1.rb')
+		@dir.create_file('ignore.txt')
+		@dir.create_dir('2').create_file('3.rb')
+		@dir.create_dir('a/b').create_file('c.rb')
+		@dir['**/*.rb'].should == @dir.make_entries(%w(1.rb 2/3.rb a/b/c.rb))
+	end
+
+	it "lists nonhidden files" do
+		@dir.create_file('show')
+		@dir.create_file('.dont_show')
+		@dir.nonhidden_files.should == @dir.make_entries(%(show))
+	end
+
+	it "lists nonhidden dirs" do
+		@dir.create_dir('show')
+		@dir.create_dir('.dont_show')
+		@dir.nonhidden_dirs.should == @dir.make_entries(%(show/))
+	end
+
+	if !RUBY_PLATFORM.match(/darwin/)   # doesn't work on OS X 'cause du switches are different
+		it "knows its size in bytes, which includes its contents recursively" do
+			@dir.create_file('a').write('1234')
+			@dir.size.should be(4096 + 4)
+		end
+	end
+
+	it "can destroy itself when empty" do
+		@dir.destroy
+	end
+
+	it "can destroy itself when not empty" do
+		@dir.create_dir('a').create_file('b').write('c')
+		@dir.destroy
+	end
+
+	it "can run a bash command within itself" do
+		system "echo test > #{@dir.full_path}/file"
+		@dir.bash("cat file").should == "test\n"
+	end
+
+	it "can run bash within directories with spaces" do
+		@dir.create_dir('with space').create_file('file').write('test')
+		@dir["with space/"].bash("cat file").should == "test"
+	end
+
+	it "passes bash options (e.g., :user) through to the box bash command" do
+		@dir.should_receive(:bash).with('cmd', :opt1 => 1, :opt2 => 2)
+		@dir.bash('cmd', :opt1 => 1, :opt2 => 2)
+	end
+
+end

data/spec/embeddable_shell_spec.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + '/base'
+
+describe Rush::EmbeddableShell do
+	before do
+		@shell = Rush::EmbeddableShell.new
+	end
+
+	it "should execute unknown methods against a Rush::Shell instance" do
+		@shell.root.class.should == Rush::Dir
+	end
+	
+	it "should executes a block as if it were inside the shell" do
+		@shell.execute_in_shell {
+			root.class.should == Rush::Dir
+		}
+	end
+end

data/spec/entry_spec.rb

@@ -0,0 +1,133 @@
+require File.dirname(__FILE__) + '/base'
+
+describe Rush::Entry do
+	before do
+		@sandbox_dir = "/tmp/rush_spec.#{Process.pid}/"
+		system "rm -rf #{@sandbox_dir}; mkdir -p #{@sandbox_dir}"
+
+		@filename = "#{@sandbox_dir}/test_file"
+		system "touch #{@filename}"
+
+		@entry = Rush::Entry.new(@filename)
+	end
+
+	after do
+		system "rm -rf #{@sandbox_dir}"
+	end
+
+	it "knows its name" do
+		@entry.name.should == File.basename(@filename)
+	end
+
+	it "knows its parent dir" do
+		@entry.parent.should be_kind_of(Rush::Dir)
+		@entry.parent.name.should == File.basename(@sandbox_dir)
+		@entry.parent.full_path.should == @sandbox_dir
+	end
+
+	it "cleans its pathname" do
+		Rush::Entry.new('/a//b//c').full_path.should == '/a/b/c'
+		Rush::Entry.new('/1/2/../3').full_path.should == '/1/3'
+	end
+
+	it "knows its changed_at time" do
+		@entry.changed_at.should == File.stat(@filename).ctime
+	end
+
+	it "knows its last_modified time" do
+		@entry.last_modified.should == File.stat(@filename).mtime
+	end
+
+	it "knows its last_accessed time" do
+		@entry.last_accessed.should == File.stat(@filename).atime
+	end
+
+	it "considers itself equal to other instances with the same full path" do
+		Rush::Entry.new('/not/the/same').should_not == @entry
+		Rush::Entry.new(@entry.full_path).should == @entry
+	end
+
+	it "can rename itself" do
+		new_file = "test2"
+
+		@entry.rename(new_file)
+
+		File.exists?(@filename).should be_false
+		File.exists?("#{@sandbox_dir}/#{new_file}").should be_true
+	end
+
+	it "rename returns the renamed file" do
+		@entry.rename('file2').should == @entry.parent['file2']
+	end
+
+	it "can't rename itself if another file already exists with that name" do
+		new_file = "test3"
+		system "touch #{@sandbox_dir}/#{new_file}"
+
+		lambda { @entry.rename(new_file) }.should raise_error(Rush::NameAlreadyExists, /#{new_file}/)
+	end
+
+	it "can't rename itself to something with a slash in it" do
+		lambda { @entry.rename('has/slash') }.should raise_error(Rush::NameCannotContainSlash, /slash/)
+	end
+
+	it "can duplicate itself within the directory" do
+		@entry.duplicate('newfile').should == Rush::File.new("#{@sandbox_dir}/newfile")
+	end
+
+	it "can move itself to another dir" do
+		newdir = "#{@sandbox_dir}/newdir"
+		system "mkdir -p #{newdir}"
+
+		dst = Rush::Dir.new(newdir)
+		@entry.move_to(dst)
+
+		File.exists?(@filename).should be_false
+		File.exists?("#{newdir}/#{@entry.name}").should be_true
+	end
+
+	it "can copy itself to another directory" do
+		newdir = "#{@sandbox_dir}/newdir"
+		system "mkdir -p #{newdir}"
+
+		dst = Rush::Dir.new(newdir)
+		@copied_dir = @entry.copy_to(dst)
+
+		File.exists?(@filename).should be_true
+		File.exists?("#{newdir}/#{@entry.name}").should be_true
+
+		@copied_dir.full_path.should == "#{@sandbox_dir}newdir/#{@entry.name}"
+	end
+
+	it "considers dotfiles to be hidden" do
+		Rush::Entry.new("#{@sandbox_dir}/show").should_not be_hidden
+		Rush::Entry.new("#{@sandbox_dir}/.dont_show").should be_hidden
+	end
+
+	it "is considered equal to entries with the same full path and on the same box" do
+		same = Rush::Entry.new(@entry.full_path, @entry.box)
+		@entry.should == same
+	end
+
+	it "is considered not equal to entries with the same full path on a different box" do
+		same = Rush::Entry.new(@entry.full_path, Rush::Box.new('dummy'))
+		@entry.should_not == same
+	end
+
+	it "can mimic another entry" do
+		copy = Rush::Entry.new('abc', :dummy)
+		copy.mimic(@entry)
+		copy.path.should == @entry.path
+	end
+
+	it "can update the read access permission" do
+		system "chmod 666 #{@filename}"
+		@entry.access = { :user_can => :read }
+		`ls -l #{@filename}`.should match(/^-r--------/)
+	end
+
+	it "reads the file permissions in the access hash" do
+		system "chmod 640 #{@filename}"
+		@entry.access.should == { :user_can_read => true, :user_can_write => true, :group_can_read => true }
+	end
+end

data/spec/file_spec.rb

@@ -0,0 +1,83 @@
+require File.dirname(__FILE__) + '/base'
+
+describe Rush::File do
+	before do
+		@sandbox_dir = "/tmp/rush_spec.#{Process.pid}"
+		system "rm -rf #{@sandbox_dir}; mkdir -p #{@sandbox_dir}"
+
+		@filename = "#{@sandbox_dir}/test_file"
+		@contents = "1234"
+		system "echo #{@contents} > #{@filename}"
+		@contents += "\n"
+
+		@file = Rush::File.new(@filename)
+	end
+
+	after do
+		system "rm -rf #{@sandbox_dir}"
+	end
+
+	it "is a child of Rush::Entry" do
+		@file.should be_kind_of(Rush::Entry)
+	end
+
+	it "is not a dir" do
+		@file.should_not be_dir
+	end
+
+	it "can create itself as a blank file, and return itself" do
+		create_me = Rush::File.new("#{@sandbox_dir}/create_me")
+		create_me.create.should == create_me
+		File.exists?("#{@sandbox_dir}/create_me").should == true
+	end
+
+	it "knows its size in bytes" do
+		@file.size.should == @contents.length
+	end
+
+	it "can read its contents" do
+		@file.contents.should == @contents
+	end
+
+	it "read is an alias for contents" do
+		@file.read.should == @contents
+	end
+
+	it "can write new contents" do
+		@file.write('write test')
+		@file.contents.should == 'write test'
+	end
+
+	it "can count the number of lines it contains" do
+		@file.write("1\n2\n3\n")
+		@file.line_count.should == 3
+	end
+
+	it "searches its contents for matching lines" do
+		@file.write("a\n1\nb\n2\n")
+		@file.search(/\d/).should == %w(1 2)
+	end
+
+	it "search returns nil if no lines match" do
+		@file.write("a\nb\nc\n")
+		@file.search(/\d/).should be_nil
+	end
+
+	it "find-in-file replace" do
+		@file.replace_contents!(/\d/, 'x')
+		@file.contents.should == "xxxx\n"
+	end
+
+	it "can destroy itself" do
+		@file.destroy
+		::File.exists?(@filename).should be_false
+	end
+
+	it "can fetch contents or blank if doesn't exist" do
+		Rush::File.new('/does/not/exist').contents_or_blank.should == ""
+	end
+
+	it "can fetch lines, or empty if doesn't exist" do
+		Rush::File.new('/does/not/exist').lines_or_empty.should == []
+	end
+end