fix(run/markdown-preview): make tests more robust (GoogleCloudPlatform#8795)

Ace Nassri · web-flow · commit 670ba465a0e5 · 2022-12-09T14:39:56.000-05:00
* fix(run/markdown-preview): make tests more robust

* Fix bad quotation marks
diff --git a/run/markdown-preview/e2e_test.py b/run/markdown-preview/e2e_test.py
@@ -22,6 +22,7 @@
 from urllib import request
 import uuid
 
+import backoff
 import pytest
 
 
@@ -31,10 +32,37 @@
 RENDERER_IMAGE_NAME = f"gcr.io/{PROJECT}/renderer-{SUFFIX}"
 
 
+@backoff.on_exception(backoff.expo, subprocess.CalledProcessError, max_tries=10)
+def run_shell_command(args):
+    """
+    Runs a command with given args.
+    Usage: gcloud_cli(options)
+        options: command line options
+    Example:
+        result = gcloud_cli("app deploy --no-promote")
+        print(f"Deployed version {result['versions'][0]['id']}")
+    Raises Exception with the stderr output of the last attempt on failure.
+    """
+    full_command = " ".join(args)
+    print("Running command:", full_command)
+
+    try:
+        output = subprocess.run(
+            full_command,
+            capture_output=True,
+            shell=True,
+            check=True,
+        )
+        return output.stdout
+    except subprocess.CalledProcessError as e:
+        print(f"Command failed: {e.stderr}")
+        raise e
+
+
 @pytest.fixture()
 def renderer_image():
     # Build container image for Cloud Run deployment
-    subprocess.check_call(
+    run_shell_command(
         [
             "gcloud",
             "builds",
@@ -50,7 +78,7 @@ def renderer_image():
     yield RENDERER_IMAGE_NAME
 
     # Delete container image
-    subprocess.check_call(
+    run_shell_command(
         [
             "gcloud",
             "container",
@@ -67,7 +95,7 @@ def renderer_image():
 @pytest.fixture()
 def editor_image():
     # Build container image for Cloud Run deployment
-    subprocess.check_call(
+    run_shell_command(
         [
             "gcloud",
             "builds",
@@ -83,7 +111,7 @@ def editor_image():
     yield EDITOR_IMAGE_NAME
 
     # Delete container image
-    subprocess.check_call(
+    run_shell_command(
         [
             "gcloud",
             "container",
@@ -101,7 +129,7 @@ def editor_image():
 def renderer_deployed_service(renderer_image):
     # Deploy image to Cloud Run
     renderer_service_name = f"renderer-{SUFFIX}"
-    subprocess.check_call(
+    run_shell_command(
         [
             "gcloud",
             "run",
@@ -119,7 +147,7 @@ def renderer_deployed_service(renderer_image):
 
     yield renderer_service_name
 
-    subprocess.check_call(
+    run_shell_command(
         [
             "gcloud",
             "run",
@@ -140,7 +168,7 @@ def renderer_deployed_service(renderer_image):
 def renderer_service_url_auth_token(renderer_deployed_service):
     # Get Cloud Run service URL and auth token
     renderer_service_url = (
-        subprocess.run(
+        run_shell_command(
             [
                 "gcloud",
                 "run",
@@ -149,23 +177,19 @@ def renderer_service_url_auth_token(renderer_deployed_service):
                 renderer_deployed_service,
                 "--platform=managed",
                 "--region=us-central1",
-                "--format=value(status.url)",
+                "--format=\"value(status.url)\"",
                 "--project",
                 PROJECT,
-            ],
-            stdout=subprocess.PIPE,
-            check=True,
+            ]
         )
-        .stdout.strip()
+        .strip()
         .decode()
     )
     renderer_auth_token = (
-        subprocess.run(
-            ["gcloud", "auth", "print-identity-token"],
-            stdout=subprocess.PIPE,
-            check=True,
+        run_shell_command(
+            ["gcloud", "auth", "print-identity-token"]
         )
-        .stdout.strip()
+        .strip()
         .decode()
     )
 
@@ -177,7 +201,7 @@ def editor_deployed_service(editor_image, renderer_service_url_auth_token):
     # Deploy editor image with renderer URL environment var
     editor_service_name = f"editor-{SUFFIX}"
     renderer_service_url, renderer_auth_token = renderer_service_url_auth_token
-    subprocess.run(
+    run_shell_command(
         [
             "gcloud",
             "run",
@@ -192,13 +216,12 @@ def editor_deployed_service(editor_image, renderer_service_url_auth_token):
             "--set-env-vars",
             f"EDITOR_UPSTREAM_RENDER_URL={renderer_service_url}",
             "--no-allow-unauthenticated",
-        ],
-        check=True,
+        ]
     )
 
     yield editor_service_name
 
-    subprocess.run(
+    run_shell_command(
         [
             "gcloud",
             "run",
@@ -210,16 +233,15 @@ def editor_deployed_service(editor_image, renderer_service_url_auth_token):
             "--quiet",
             "--project",
             PROJECT,
-        ],
-        check=True,
+        ]
     )
 
 
 @pytest.fixture
 def editor_service_url_auth_token(editor_deployed_service):
     # Get Cloud Run service URL and auth token
     editor_service_url = (
-        subprocess.run(
+        run_shell_command(
             [
                 "gcloud",
                 "run",
@@ -228,23 +250,19 @@ def editor_service_url_auth_token(editor_deployed_service):
                 editor_deployed_service,
                 "--platform=managed",
                 "--region=us-central1",
-                "--format=value(status.url)",
+                "--format=\"value(status.url)\"",
                 "--project",
                 PROJECT,
-            ],
-            stdout=subprocess.PIPE,
-            check=True,
+            ]
         )
-        .stdout.strip()
+        .strip()
         .decode()
     )
     editor_auth_token = (
-        subprocess.run(
-            ["gcloud", "auth", "print-identity-token"],
-            stdout=subprocess.PIPE,
-            check=True,
+        run_shell_command(
+            ["gcloud", "auth", "print-identity-token"]
         )
-        .stdout.strip()
+        .strip()
         .decode()
     )
 
diff --git a/run/markdown-preview/requirements-test.txt b/run/markdown-preview/requirements-test.txt
@@ -1,3 +1,4 @@
+backoff==2.1.2
 pytest==7.0.1
 google-auth==2.6.2
 google-api-python-client==2.47.0
