forked from hashicorp/vagrant
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
(hashicorp#6827) Introduce tty flag for ssh command execution
Prior to this commit, if a user ran the `vagrant ssh -c CMD` command, it would not allow the user to configure pseudo-terminal allocation. This commit introduces a -t flag for the `vagrant ssh` command which defaults to true if not specified.
- Loading branch information
Showing
3 changed files
with
108 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,98 @@ | ||
require File.expand_path("../../../../base", __FILE__) | ||
|
||
describe Vagrant::Action::Builtin::SSHRun do | ||
let(:app) { lambda { |env| } } | ||
let(:env) { { machine: machine } } | ||
|
||
# SSH configuration information mock | ||
let(:ssh) do | ||
double("ssh", | ||
timeout: 1, | ||
host: nil, | ||
port: 5986, | ||
guest_port: 5986, | ||
pty: false, | ||
keep_alive: false, | ||
insert_key: false, | ||
shell: 'bash -l' | ||
) | ||
end | ||
|
||
# Configuration mock | ||
let(:config) { double("config", ssh: ssh) } | ||
|
||
let(:machine) do | ||
double("machine", | ||
config: config,) | ||
end | ||
|
||
let(:machine_ssh_info) { {} } | ||
let(:ssh_klass) { Vagrant::Util::SSH } | ||
|
||
before(:each) do | ||
# Stub the methods so that even if we test incorrectly, no side | ||
# effects actually happen. | ||
allow(ssh_klass).to receive(:exec) | ||
allow(machine).to receive(:ssh_info).and_return(machine_ssh_info) | ||
end | ||
|
||
it "should raise an exception if SSH is not ready" do | ||
not_ready_machine = double("machine") | ||
allow(not_ready_machine).to receive(:ssh_info).and_return(nil) | ||
|
||
env[:machine] = not_ready_machine | ||
expect { described_class.new(app, env).call(env) }. | ||
to raise_error(Vagrant::Errors::SSHNotReady) | ||
end | ||
|
||
it "should exec with the SSH info in the env if given" do | ||
ssh_info = { foo: :bar } | ||
opts = {:extra_args=>["bash -l -c 'echo test'"], :subprocess=>true} | ||
|
||
expect(ssh_klass).to receive(:exec). | ||
with(ssh_info, opts) | ||
|
||
env[:ssh_info] = ssh_info | ||
env[:ssh_run_command] = "echo test" | ||
described_class.new(app, env).call(env) | ||
end | ||
|
||
|
||
it "should exec with the SSH info in the env if given and disable tty" do | ||
ssh_info = { foo: :bar } | ||
opts = {:extra_args=>["-t", "bash -l -c 'echo test'"], :subprocess=>true} | ||
env[:tty] = true | ||
|
||
expect(ssh_klass).to receive(:exec). | ||
with(ssh_info, opts) | ||
|
||
env[:ssh_info] = ssh_info | ||
env[:ssh_run_command] = "echo test" | ||
described_class.new(app, env).call(env) | ||
end | ||
|
||
it "should exec with the SSH info in the env if given and not disable tty" do | ||
ssh_info = { foo: :bar } | ||
opts = {:extra_args=>["bash -l -c 'echo test'"], :subprocess=>true} | ||
env[:tty] = false | ||
|
||
expect(ssh_klass).to receive(:exec). | ||
with(ssh_info, opts) | ||
|
||
env[:ssh_info] = ssh_info | ||
env[:ssh_run_command] = "echo test" | ||
described_class.new(app, env).call(env) | ||
end | ||
|
||
|
||
it "should exec with the options given in `ssh_opts`" do | ||
ssh_opts = { foo: :bar } | ||
|
||
expect(ssh_klass).to receive(:exec). | ||
with(machine_ssh_info, ssh_opts) | ||
|
||
env[:ssh_opts] = ssh_opts | ||
env[:ssh_run_command] = "echo test" | ||
described_class.new(app, env).call(env) | ||
end | ||
end |