test: add type flaky to unit test (#1297)

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Anthonios Partheniou <[email protected]>

noxfile.py

@@ -55,7 +55,9 @@
 UNIT_TEST_EXTERNAL_DEPENDENCIES: List[str] = []
 UNIT_TEST_LOCAL_DEPENDENCIES: List[str] = []
 UNIT_TEST_DEPENDENCIES: List[str] = []
-UNIT_TEST_EXTRAS: List[str] = []
+UNIT_TEST_EXTRAS: List[str] = [
+    "flaky",
+]
 UNIT_TEST_EXTRAS_BY_PYTHON: Dict[str, List[str]] = {}
 
 SYSTEM_TEST_PYTHON_VERSIONS: List[str] = ["3.12"]

owlbot.py

@@ -337,6 +337,7 @@
     cov_level=100,
     versions=gcp.common.detect_versions(path="./google", default_first=True),
     unit_test_python_versions=["3.7", "3.8", "3.9", "3.10", "3.11", "3.12", "3.13"],
+    unit_test_extras=["flaky"],
     system_test_python_versions=["3.12"],
     system_test_external_dependencies=["psutil","flaky"],
 )

setup.py

@@ -50,7 +50,7 @@
     "opentelemetry-sdk <= 1.22.0; python_version<='3.7'",
     "opentelemetry-sdk >= 1.27.0; python_version>='3.8'",
 ]
-extras = {"libcst": "libcst >= 0.3.10"}
+extras = {"libcst": "libcst >= 0.3.10,", "flaky": "flaky"}
 url = "https://github.com/googleapis/python-pubsub"
 
 package_root = os.path.abspath(os.path.dirname(__file__))

tests/unit/pubsub_v1/publisher/test_publisher_client.py

@@ -28,6 +28,8 @@
 
 import pytest
 import time
+from flaky import flaky
+from typing import cast, Callable, Any, TypeVar
 
 from opentelemetry import trace
 from google.api_core import gapic_v1
@@ -49,6 +51,10 @@
 )
 
 
+C = TypeVar("C", bound=Callable[..., Any])
+typed_flaky = cast(Callable[[C], C], flaky(max_runs=5, min_passes=1))
+
+
 def _assert_retries_equal(retry, retry2):
     # Retry instances cannot be directly compared, because their predicates are
     # different instances of the same function. We thus manually compare their other
@@ -142,6 +148,7 @@ def test_init_w_custom_transport(creds):
         False,
     ],
 )
+@typed_flaky
 def test_open_telemetry_publisher_options(creds, enable_open_telemetry):
     if sys.version_info >= (3, 8) or enable_open_telemetry is False:
         client = publisher.Client(