Skip to content

LinuxCommand#verify cleaned up #530

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jan 15, 2020
Merged

LinuxCommand#verify cleaned up #530

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
64bf914
Wrap known exception in LinuxCommand#verify  
Nov 2, 2019
f884192
Add more test cases to validate error message
Nov 18, 2019
c029473
Add verify! method & exact match for sudo errors.
Nov 25, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 22 additions & 17 deletions lib/train/extras/command_wrapper.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,22 +56,27 @@ def verify
res = @backend.run_command(run("echo"))
return nil if res.exit_status == 0

rawerr = res.stdout + " " + res.stderr
msg, reason =
case rawerr
when /Sorry, try again/
["Wrong sudo password.", :bad_sudo_password]
when /sudo: no tty present and no askpass program specified/
["Sudo requires a password, please configure it.", :sudo_password_required]
when /sudo: command not found/
["Can't find sudo command. Please either install and "\
"configure it on the target or deactivate sudo.", :sudo_command_not_found]
when /sudo: sorry, you must have a tty to run sudo/
["Sudo requires a TTY. Please see the README on how to configure "\
"sudo to allow for non-interactive usage.", :sudo_no_tty]
else
rawerr
end
rawerr = "#{res.stdout} #{res.stderr}".strip

case rawerr
when "Sorry, try again"
["Wrong sudo password.", :bad_sudo_password]
when "sudo: no tty present and no askpass program specified"
["Sudo requires a password, please configure it.", :sudo_password_required]
when "sudo: command not found"
["Can't find sudo command. Please either install and "\
"configure it on the target or deactivate sudo.", :sudo_command_not_found]
when "sudo: sorry, you must have a tty to run sudo"
["Sudo requires a TTY. Please see the README on how to configure "\
"sudo to allow for non-interactive usage.", :sudo_no_tty]
else
[rawerr, nil]
end
end

def verify!
msg, reason = verify
return nil unless msg
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the future: return and return nil have the same effect.


raise Train::UserError.new("Sudo failed: #{msg}", reason)
end
Expand Down Expand Up @@ -168,7 +173,7 @@ def self.load(transport, options)
return nil unless LinuxCommand.active?(options)

res = LinuxCommand.new(transport, options)
res.verify
res.verify!

res
elsif transport.platform.windows?
Expand Down
10 changes: 5 additions & 5 deletions test/unit/extras/command_wrapper_test.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,35 +121,35 @@ def mock_connect_result(stderr, exit_status)
it "error message for bad sudo password" do
backend.stubs(:run_command).returns(mock_connect_result("Sorry, try again", 1))
lc = cls.new(backend, { sudo: true })
err = _ { lc.verify }.must_raise Train::UserError
err = _ { lc.verify! }.must_raise Train::UserError
_(err.message).must_match(/Sudo failed: Wrong sudo password./)
end

it "error message for sudo password required" do
backend.stubs(:run_command).returns(mock_connect_result("sudo: no tty present and no askpass program specified", 1))
lc = cls.new(backend, { sudo: true })
err = _ { lc.verify }.must_raise Train::UserError
err = _ { lc.verify! }.must_raise Train::UserError
_(err.message).must_match(/Sudo requires a password, please configure it./)
end

it "error message for sudo: command not found" do
backend.stubs(:run_command).returns(mock_connect_result("sudo: command not found", 1))
lc = cls.new(backend, { sudo: true })
err = _ { lc.verify }.must_raise Train::UserError
err = _ { lc.verify! }.must_raise Train::UserError
_(err.message).must_match(/Can't find sudo command. Please either install and configure it on the target or deactivate sudo./)
end

it "error message for requires tty" do
backend.stubs(:run_command).returns(mock_connect_result("sudo: sorry, you must have a tty to run sudo", 1))
lc = cls.new(backend, { sudo: true })
err = _ { lc.verify }.must_raise Train::UserError
err = _ { lc.verify! }.must_raise Train::UserError
_(err.message).must_match(/Sudo failed: Sudo requires a TTY. Please see the README/)
end

it "error message for other sudo related errors" do
backend.stubs(:run_command).returns(mock_connect_result("Other sudo related error", 1))
lc = cls.new(backend, { sudo: true })
err = _ { lc.verify }.must_raise Train::UserError
err = _ { lc.verify! }.must_raise Train::UserError
_(err.message).must_match(/Other sudo related error/)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

great!

end
end
Expand Down