bmabey-vagrant 0.2.0

data/test/vagrant/ssh_test.rb

@@ -0,0 +1,222 @@
+require File.join(File.dirname(__FILE__), '..', 'test_helper')
+
+class SshTest < Test::Unit::TestCase
+  setup do
+    mock_config
+  end
+
+  def mock_ssh
+    @env = mock_environment do |config|
+      yield config if block_given?
+    end
+
+    @ssh = Vagrant::SSH.new(@env)
+  end
+
+  context "connecting to external SSH" do
+    setup do
+      mock_ssh
+      @ssh.stubs(:check_key_permissions)
+    end
+
+    should "check key permissions prior to exec" do
+      exec_seq = sequence("exec_seq")
+      @ssh.expects(:check_key_permissions).with(@env.config.ssh.private_key_path).once.in_sequence(exec_seq)
+      Kernel.expects(:exec).in_sequence(exec_seq)
+      @ssh.connect
+    end
+
+    should "call exec with defaults when no options are supplied" do
+      ssh_exec_expect(@ssh.port,
+                      @env.config.ssh.private_key_path,
+                      @env.config.ssh.username,
+                      @env.config.ssh.host)
+      @ssh.connect
+    end
+
+    should "call exec with supplied params" do
+      args = {:username => 'bar', :private_key_path => 'baz', :host => 'bak', :port => 'bag'}
+      ssh_exec_expect(args[:port], args[:private_key_path], args[:username], args[:host])
+      @ssh.connect(args)
+    end
+
+    def ssh_exec_expect(port, key_path, uname, host)
+      Kernel.expects(:exec).with() do |arg|
+        assert arg =~ /^ssh/
+        assert arg =~ /-p #{port}/
+        assert arg =~ /-i #{key_path}/
+        assert arg =~ /#{uname}@#{host}/
+        # TODO options not tested for as they may be removed
+        true
+      end
+    end
+  end
+
+  context "executing ssh commands" do
+    setup do
+      mock_ssh
+    end
+
+    should "call net::ssh.start with the proper names" do
+      Net::SSH.expects(:start).once.with() do |host, username, opts|
+        assert_equal @env.config.ssh.host, host
+        assert_equal @env.config.ssh.username, username
+        assert_equal @ssh.port, opts[:port]
+        assert_equal [@env.config.ssh.private_key_path], opts[:keys]
+        true
+      end
+      @ssh.execute
+    end
+
+    should "use custom host if set" do
+      @env.config.ssh.host = "foo"
+      Net::SSH.expects(:start).with(@env.config.ssh.host, @env.config.ssh.username, anything).once
+      @ssh.execute
+    end
+  end
+
+  context "SCPing files to the remote host" do
+    setup do
+      mock_ssh
+    end
+
+    should "use Vagrant::SSH execute to setup an SCP connection and upload" do
+      scp = mock("scp")
+      ssh = mock("ssh")
+      scp.expects(:upload!).with("foo", "bar").once
+      Net::SCP.expects(:new).with(ssh).returns(scp).once
+      @ssh.expects(:execute).yields(ssh).once
+      @ssh.upload!("foo", "bar")
+    end
+  end
+
+  context "checking if host is up" do
+    setup do
+      mock_ssh
+    end
+
+    should "return true if SSH connection works" do
+      Net::SSH.expects(:start).yields("success")
+      assert @ssh.up?
+    end
+
+    should "return false if SSH connection times out" do
+      Net::SSH.expects(:start)
+      assert !@ssh.up?
+    end
+
+    should "allow the thread the configured timeout time" do
+      @thread = mock("thread")
+      @thread.stubs(:[])
+      Thread.expects(:new).returns(@thread)
+      @thread.expects(:join).with(@env.config.ssh.timeout).once
+      @ssh.up?
+    end
+
+    should "return false if the connection is refused" do
+      Net::SSH.expects(:start).raises(Errno::ECONNREFUSED)
+      assert_nothing_raised {
+        assert !@ssh.up?
+      }
+    end
+
+    should "return false if the connection is dropped" do
+      Net::SSH.expects(:start).raises(Net::SSH::Disconnect)
+      assert_nothing_raised {
+        assert !@ssh.up?
+      }
+    end
+
+    should "specifity the timeout as an option to execute" do
+      @ssh.expects(:execute).with(:timeout => @env.config.ssh.timeout).yields(true)
+      assert @ssh.up?
+    end
+
+    should "error and exit if a Net::SSH::AuthenticationFailed is raised" do
+      @ssh.expects(:execute).raises(Net::SSH::AuthenticationFailed)
+      @ssh.expects(:error_and_exit).with(:vm_ssh_auth_failed).once
+      @ssh.up?
+    end
+  end
+
+  context "getting the ssh port" do
+    setup do
+      mock_ssh
+    end
+
+    should "return the configured port by default" do
+      assert_equal @env.config.vm.forwarded_ports[@env.config.ssh.forwarded_port_key][:hostport], @ssh.port
+    end
+
+    should "return the port given in options if it exists" do
+      assert_equal "47", @ssh.port({ :port => "47" })
+    end
+  end
+
+  context "checking key permissions" do
+    setup do
+      mock_ssh
+      @ssh.stubs(:file_perms)
+
+      @key_path = "foo"
+
+
+      @stat = mock("stat")
+      @stat.stubs(:owned?).returns(true)
+      File.stubs(:stat).returns(@stat)
+    end
+
+    should "do nothing if the user is not the owner" do
+      @stat.expects(:owned?).returns(false)
+      File.expects(:chmod).never
+      @ssh.check_key_permissions(@key_path)
+    end
+
+    should "do nothing if the file perms equal 600" do
+      @ssh.expects(:file_perms).with(@key_path).returns("600")
+      File.expects(:chmod).never
+      @ssh.check_key_permissions(@key_path)
+    end
+
+    should "chmod the file if the file perms aren't 600" do
+      perm_sequence = sequence("perm_seq")
+      @ssh.expects(:file_perms).returns("900").in_sequence(perm_sequence)
+      File.expects(:chmod).with(0600, @key_path).once.in_sequence(perm_sequence)
+      @ssh.expects(:file_perms).returns("600").in_sequence(perm_sequence)
+      @ssh.expects(:error_and_exit).never
+      @ssh.check_key_permissions(@key_path)
+    end
+
+    should "error and exit if the resulting chmod doesn't work" do
+      perm_sequence = sequence("perm_seq")
+      @ssh.expects(:file_perms).returns("900").in_sequence(perm_sequence)
+      File.expects(:chmod).with(0600, @key_path).once.in_sequence(perm_sequence)
+      @ssh.expects(:file_perms).returns("900").in_sequence(perm_sequence)
+      @ssh.expects(:error_and_exit).once.with(:ssh_bad_permissions, :key_path => @key_path).in_sequence(perm_sequence)
+      @ssh.check_key_permissions(@key_path)
+    end
+
+    should "error and exit if a bad file perm is raised" do
+      @ssh.expects(:file_perms).with(@key_path).returns("900")
+      File.expects(:chmod).raises(Errno::EPERM)
+      @ssh.expects(:error_and_exit).once.with(:ssh_bad_permissions, :key_path => @key_path)
+      @ssh.check_key_permissions(@key_path)
+    end
+  end
+
+  context "getting file permissions" do
+    setup do
+      mock_ssh
+    end
+
+    should "return the last 3 characters of the file mode" do
+      path = "foo"
+      mode = "10000foo"
+      stat = mock("stat")
+      File.expects(:stat).with(path).returns(stat)
+      stat.expects(:mode).returns(mode)
+      @ssh.expects(:sprintf).with("%o", mode).returns(mode)
+      assert_equal path, @ssh.file_perms(path)
+    end
+  end
+end

data/test/vagrant/util/errors_test.rb

@@ -0,0 +1,57 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'test_helper')
+
+class ErrorsUtilTest < Test::Unit::TestCase
+  include Vagrant::Util
+
+  context "loading the errors from the YML" do
+    setup do
+      YAML.stubs(:load_file)
+      Errors.reset!
+    end
+
+    should "load the file initially, then never again unless reset" do
+      YAML.expects(:load_file).with(File.join(PROJECT_ROOT, "templates", "errors.yml")).once
+      Errors.errors
+      Errors.errors
+      Errors.errors
+      Errors.errors
+    end
+
+    should "reload if reset! is called" do
+      YAML.expects(:load_file).with(File.join(PROJECT_ROOT, "templates", "errors.yml")).twice
+      Errors.errors
+      Errors.reset!
+      Errors.errors
+    end
+  end
+
+  context "getting the error string" do
+    setup do
+      @errors = {}
+      @errors[:foo] = "foo bar baz"
+      Errors.stubs(:errors).returns(@errors)
+    end
+
+    should "render the error string" do
+      TemplateRenderer.expects(:render_string).with(@errors[:foo], anything).once
+      Errors.error_string(:foo)
+    end
+
+    should "pass in any data entries" do
+      data = mock("data")
+      TemplateRenderer.expects(:render_string).with(@errors[:foo], data).once
+      Errors.error_string(:foo, data)
+    end
+
+    should "return the result of the render" do
+      result = mock("result")
+      TemplateRenderer.expects(:render_string).returns(result)
+      assert_equal result, Errors.error_string(:foo)
+    end
+
+    should "return an unknown if the key doesn't exist" do
+      result = Errors.error_string(:unknown)
+      assert result =~ /Unknown/i
+    end
+  end
+end

data/test/vagrant/util/stacked_proc_runner_test.rb

@@ -0,0 +1,43 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'test_helper')
+
+class StackedProcRunnerUtilTest < Test::Unit::TestCase
+  class TestClass
+    include Vagrant::Util::StackedProcRunner
+  end
+
+  setup do
+    @instance = TestClass.new
+    @instance.proc_stack.clear
+  end
+
+  should "not run the procs right away" do
+    obj = mock("obj")
+    obj.expects(:foo).never
+    @instance.push_proc { |config| obj.foo }
+    @instance.push_proc { |config| obj.foo }
+    @instance.push_proc { |config| obj.foo }
+  end
+
+  should "run the blocks when run_procs! is ran" do
+    obj = mock("obj")
+    obj.expects(:foo).times(2)
+    @instance.push_proc { obj.foo }
+    @instance.push_proc { obj.foo }
+    @instance.run_procs!
+  end
+
+  should "run the blocks with the same arguments" do
+    passed_config = mock("config")
+    @instance.push_proc { |config| assert passed_config.equal?(config) }
+    @instance.push_proc { |config| assert passed_config.equal?(config) }
+    @instance.run_procs!(passed_config)
+  end
+
+  should "not clear the blocks after running" do
+    obj = mock("obj")
+    obj.expects(:foo).times(2)
+    @instance.push_proc { obj.foo }
+    @instance.run_procs!
+    @instance.run_procs!
+  end
+end

data/test/vagrant/util/template_renderer_test.rb

@@ -0,0 +1,138 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'test_helper')
+
+class TemplateRendererUtilTest < Test::Unit::TestCase
+  context "initializing" do
+    should "set the template to the given argument" do
+      r = Vagrant::Util::TemplateRenderer.new("foo")
+      assert_equal "foo", r.template
+    end
+
+    should "set any additional variables" do
+      r = Vagrant::Util::TemplateRenderer.new("foo", {:bar => :baz})
+      assert_equal :baz, r.bar
+    end
+  end
+
+  context "rendering" do
+    setup do
+      @template = "foo"
+      @r = Vagrant::Util::TemplateRenderer.new(@template)
+      @r.stubs(:full_template_path).returns(@template + "!")
+
+      @contents = "bar"
+
+      @file = mock("file")
+      @file.stubs(:read).returns(@contents)
+      File.stubs(:open).yields(@file)
+    end
+
+    should "open the template file for reading" do
+      File.expects(:open).with(@r.full_template_path, 'r').once
+      @r.render
+    end
+
+    should "set the template to the file contents, render, then set it back" do
+      result = "bar"
+
+      template_seq = sequence("template_seq")
+      @r.expects(:template=).with(@file.read).in_sequence(template_seq)
+      @r.expects(:render_string).returns(result).in_sequence(template_seq)
+      @r.expects(:template=).with(@template).in_sequence(template_seq)
+      assert_equal result, @r.render
+    end
+
+    should "render the ERB file in the context of the renderer" do
+      result = "bar"
+      template = "<%= foo %>"
+      @r.foo = result
+      @file.expects(:read).returns(template)
+      assert_equal result, @r.render
+    end
+  end
+
+  context "rendering as string" do
+    setup do
+      @result = "foo"
+      @erb = mock("erb")
+      @erb.stubs(:result).returns(@result)
+
+      @r = Vagrant::Util::TemplateRenderer.new("foo")
+    end
+
+    should "simply render the template as a string" do
+      ERB.expects(:new).with(@r.template).returns(@erb)
+      assert_equal @result, @r.render_string
+    end
+  end
+
+  context "the full template path" do
+    setup do
+      @template = "foo"
+      @r = Vagrant::Util::TemplateRenderer.new(@template)
+    end
+
+    should "be the ERB file in the templates directory" do
+      result = File.join(PROJECT_ROOT, "templates", "#{@template}.erb")
+      assert_equal result, @r.full_template_path
+    end
+  end
+
+  context "class methods" do
+    context "render_with method" do
+      setup do
+        @template = "foo"
+        @r = Vagrant::Util::TemplateRenderer.new(@template)
+        @r.stubs(:render)
+
+        @method = :rawr
+
+        Vagrant::Util::TemplateRenderer.stubs(:new).with(@template, {}).returns(@r)
+      end
+
+      should "use the second argument as the template" do
+        Vagrant::Util::TemplateRenderer.expects(:new).with(@template, {}).returns(@r)
+        Vagrant::Util::TemplateRenderer.render_with(@method, @template)
+      end
+
+      should "send in additional argument to the renderer" do
+        data = {:hey => :foo}
+        Vagrant::Util::TemplateRenderer.expects(:new).with(@template, data).returns(@r)
+        Vagrant::Util::TemplateRenderer.render_with(@method, @template, data)
+      end
+
+      should "yield a block if given with the renderer as the argument" do
+        @r.expects(:yielded=).with(true).once
+        Vagrant::Util::TemplateRenderer.render_with(@method, @template) do |r|
+          r.yielded = true
+        end
+      end
+
+      should "render the result using the given method" do
+        result = mock('result')
+        @r.expects(@method).returns(result)
+        assert_equal result, Vagrant::Util::TemplateRenderer.render_with(@method, @template)
+      end
+
+      should "convert the given method to a sym prior to calling" do
+        @r.expects(@method.to_sym).returns(nil)
+        Vagrant::Util::TemplateRenderer.render_with(@method.to_s, @template)
+      end
+    end
+
+    context "render method" do
+      should "call render_with the render! method" do
+        args = ["foo", "bar", "baz"]
+        Vagrant::Util::TemplateRenderer.expects(:render_with).with(:render, *args)
+        Vagrant::Util::TemplateRenderer.render(*args)
+      end
+    end
+
+    context "render_string method" do
+      should "call render_with the render! method" do
+        args = ["foo", "bar", "baz"]
+        Vagrant::Util::TemplateRenderer.expects(:render_with).with(:render_string, *args)
+        Vagrant::Util::TemplateRenderer.render_string(*args)
+      end
+    end
+  end
+end