Skip to content

fix(oslogin): Fix error reporting for OSLogin #9222

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
m-strzelczyk merged 5 commits into from
Mar 6, 2023
Merged

fix(oslogin): Fix error reporting for OSLogin #9222

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7d23b46
fix(oslogin): Fix error reporting for OSLogin
m-strzelczyk Mar 3, 2023
f8c9430
Update oslogin_service_account_ssh.py
m-strzelczyk Mar 6, 2023
b09233f
Update oslogin_service_account_ssh.py
m-strzelczyk Mar 6, 2023
fb55b8b
Merge branch 'main' into m-strzelczyk-patch-1
m-strzelczyk Mar 6, 2023
fc1a340
Merge branch 'main' into m-strzelczyk-patch-1
m-strzelczyk Mar 6, 2023
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
21 changes: 12 additions & 9 deletions compute/oslogin/oslogin_service_account_ssh.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
# [START compute_oslogin_ssh]
"""
Example of using the OS Login API to apply public SSH keys for a service
account, and use that service account to execute commands on a remote
account, and use that service account to run commands on a remote
instance over SSH. This example uses zonal DNS names to address instances
on the same internal VPC network.
"""
Expand All @@ -43,19 +43,19 @@ def execute(
raise_errors: Optional[bool] = True
) -> Tuple[int, str]:
"""
Executes an external command (wrapper for Python subprocess).
Run an external command (wrapper for Python subprocess).

Args:
cmd: The command to be executed.
cwd: Directory in which to execute the command.
cmd: The command to be run.
cwd: Directory in which to run the command.
capture_output: Should the command output be captured and returned or just ignored.
env: Environmental variables passed to the child process.
raise_errors: Should errors in executed command raise exceptions.
raise_errors: Should errors in run command raise exceptions.

Returns:
Return code and captured output.
"""
print(f'Executing command: {cmd}')
print(f'Running command: {cmd}')
process = subprocess.run(
cmd,
cwd=cwd,
Expand Down Expand Up @@ -126,7 +126,7 @@ def run_ssh(cmd: str, private_key_file: str, username: str, hostname: str) -> st
hostname: Hostname of the machine you want to run the command on.

Returns:
Output of the executed command.
Output of the run command.
"""
ssh_command = [
'ssh',
Expand All @@ -136,7 +136,7 @@ def run_ssh(cmd: str, private_key_file: str, username: str, hostname: str) -> st
f'{username}@{hostname}',
cmd,
]
print(f"Executing ssh command: {' '.join(ssh_command)}")
print(f"Running ssh command: {' '.join(ssh_command)}")
tries = 0
while tries < 3:
try:
Expand All @@ -154,7 +154,10 @@ def run_ssh(cmd: str, private_key_file: str, username: str, hostname: str) -> st
time.sleep(30)
tries += 1
if tries == 3:
print(f"Failed to execute SSH command (return code: {err.returncode}. Output received: {err.output}")
if isinstance(subprocess.CalledProcessError, err):
print(f"Failed to run SSH command (return code: {err.returncode}. Output received: {err.output}")
else:
print("Failed to run SSH - timed out.")
raise err
else:
return ssh.stdout
Expand Down