fix: use backoff exception to gracefully exit and fail (GoogleCloudPlatform#8257)

dandhlee · m-strzelczyk · web-flow · commit a86d380568d3 · 2022-08-16T08:50:56.000-05:00
* fix: use backoff exception to gracefully exit and fail

* fix: using specific tuple of exceptions to track

* fix: update syntax

* fix: lint

* fix: lint2

* fix: update lint

* chore(deps): pin dependency for versions

Co-authored-by: Maciej Strzelczyk &lt;strzelczyk@google.com&gt;
diff --git a/compute/oslogin/requirements-test.txt b/compute/oslogin/requirements-test.txt
@@ -1,3 +1,4 @@
+backoff===1.11.1; python_version < "3.7"
+backoff===2.0.0; python_version >= "3.7"
 pytest==7.0.1
 mock==4.0.3
-retrying==1.3.3
diff --git a/compute/oslogin/service_account_ssh_test.py b/compute/oslogin/service_account_ssh_test.py
@@ -16,11 +16,13 @@
 import json
 import os
 import random
+from subprocess import CalledProcessError
 import time
 
+import backoff
+from google.auth.exceptions import RefreshError
 from google.oauth2 import service_account
 import googleapiclient.discovery
-from retrying import retry
 
 from service_account_ssh import main
 
@@ -84,22 +86,21 @@ def test_main(capsys):
         'oslogin', 'v1', cache_discovery=False, credentials=credentials)
     account = 'users/' + account_email
 
-    @retry(wait_exponential_multiplier=1000, wait_exponential_max=300000,
-           stop_max_attempt_number=10)
+    # More exceptions could be raised, keeping track of ones I could
+    # find for now.
+    @backoff.on_exception(backoff.expo,
+                          (CalledProcessError,
+                           RefreshError),
+                          max_tries=5)
     def ssh_login():
         main(cmd, project, test_id, zone, oslogin, account, hostname)
         out, _ = capsys.readouterr()
         assert_value = 'Linux {test_id}'.format(test_id=test_id)
         assert assert_value in out
 
     # Test SSH to the instance.
-    try:
-        ssh_login()
-    except Exception:
-        raise Exception('SSH to the test instance failed.')
-
-    finally:
-        cleanup_resources(compute, iam, project, test_id, zone, account_email)
+    ssh_login()
+    cleanup_resources(compute, iam, project, test_id, zone, account_email)
 
 
 def setup_resources(

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+backoff===1.11.1; python_version < "3.7"`
	`2`	`+backoff===2.0.0; python_version >= "3.7"`
`1`	`3`	`pytest==7.0.1`
`2`	`4`	`mock==4.0.3`
`3`		`-retrying==1.3.3`