Add ssh command to Vagrant

Add tests as well.

Author: Todd DeLuca

CHANGELOG.md

@@ -4,6 +4,12 @@
 This document lists the changes (and individuals who contributed to those
 changes) for each release of python-vagrant.
 
+## To be released
+
+- Pull Request #54: Create ssh() method to run shell commands in a VM
+  Authors: Parker Thompson (https://github.com/mothran) and Todd DeLuca
+  (https://github.com/todddeluca)
+
 ## 0.5.14
 
 - Pull Request #51: Add support for the vagrant package command.

tests/test_vagrant.py

@@ -520,6 +520,30 @@ def test_multivm_config():
         eq_(keyfile, parsed_config["IdentityFile"].lstrip('"').rstrip('"'))
 
 
+@with_setup(make_setup_vm(), teardown_vm)
+def test_ssh_command():
+    '''
+    Test executing a command via ssh on a vm.
+    '''
+    v = vagrant.Vagrant(TD)
+    v.up()
+    output = v.ssh(command='echo hello')
+    assert output.strip() == 'hello'
+
+
+@with_setup(make_setup_vm(MULTIVM_VAGRANTFILE), teardown_vm)
+def test_ssh_command_multivm():
+    '''
+    Test executing a command via ssh on a specific vm
+    '''
+    v = vagrant.Vagrant(TD)
+    v.up()
+    output = v.ssh(vm_name=VM_1, command='echo hello')
+    assert output.strip() == 'hello'
+    output = v.ssh(vm_name=VM_2, command='echo I like your hat')
+    assert output.strip() == 'I like your hat'
+
+
 def test_make_file_cm():
     filename = os.path.join(TD, 'test.log')
     if os.path.exists(filename):

vagrant/__init__.py

@@ -728,6 +728,19 @@ def snapshot_delete(self, name):
         '''
         self._call_vagrant_command(['snapshot', 'delete', name])
 
+    def ssh(self, vm_name=None, command=None, extra_ssh_args=None):
+        '''
+        Execute a command via ssh on the vm specified.
+        command: The command to execute via ssh.
+        extra_ssh_args: Corresponds to '--' option in the vagrant ssh command
+        Returns the output of running the command.
+        '''
+        cmd = ['ssh', vm_name, '--command', command]
+        if extra_ssh_args is not None:
+            cmd += ['--', extra_ssh_args]
+
+        return self._run_vagrant_command(cmd)
+
     def _parse_box_list(self, output):
         '''
         Remove Vagrant usage for unit testing