chore: simplify warnings check

Author: vchudnov-g

tests/asyncio/test_grpc_helpers_async.py

@@ -17,6 +17,7 @@
     from unittest.mock import AsyncMock  # pragma: NO COVER  # noqa: F401
 except ImportError:  # pragma: NO COVER
     import mock  # type: ignore
+from ..helpers import warn_deprecated_credentials_file
 import pytest  # noqa: I202
 
 try:
@@ -522,10 +523,7 @@ def test_create_channel_explicit_with_duplicate_credentials():
     target = "example:443"
 
     with pytest.raises(exceptions.DuplicateCredentialArgs) as excinfo:
-        with pytest.warns(
-            DeprecationWarning,
-            match="argument is deprecated because of a potential security risk",
-        ):
+        with warn_deprecated_credentials_file():
             grpc_helpers_async.create_channel(
                 target,
                 credentials_file="credentials.json",
@@ -645,10 +643,7 @@ def test_create_channel_with_credentials_file(
     credentials_file = "/path/to/credentials/file.json"
     composite_creds = composite_creds_call.return_value
 
-    with pytest.warns(
-        DeprecationWarning,
-        match="argument is deprecated because of a potential security risk",
-    ):
+    with warn_deprecated_credentials_file():
         channel = grpc_helpers_async.create_channel(
             target, credentials_file=credentials_file
         )
@@ -678,10 +673,7 @@ def test_create_channel_with_credentials_file_and_scopes(
     credentials_file = "/path/to/credentials/file.json"
     composite_creds = composite_creds_call.return_value
 
-    with pytest.warns(
-        DeprecationWarning,
-        match="argument is deprecated because of a potential security risk",
-    ):
+    with warn_deprecated_credentials_file():
         channel = grpc_helpers_async.create_channel(
             target, credentials_file=credentials_file, scopes=scopes
         )
@@ -711,10 +703,7 @@ def test_create_channel_with_credentials_file_and_default_scopes(
     credentials_file = "/path/to/credentials/file.json"
     composite_creds = composite_creds_call.return_value
 
-    with pytest.warns(
-        DeprecationWarning,
-        match="argument is deprecated because of a potential security risk",
-    ):
+    with warn_deprecated_credentials_file():
         channel = grpc_helpers_async.create_channel(
             target, credentials_file=credentials_file, default_scopes=default_scopes
         )

tests/helpers.py

@@ -14,7 +14,9 @@
 
 """Helpers for tests"""
 
+import functools
 import logging
+import pytest  # noqa: I202
 from typing import List
 
 import proto
@@ -69,3 +71,12 @@ def parse_responses(response_message_cls, all_responses: List[proto.Message]) ->
     logging.info(f"Sending JSON stream: {json_responses}")
     ret_val = "[{}]".format(",".join(json_responses))
     return bytes(ret_val, "utf-8")
+
+
+warn_deprecated_credentials_file = functools.partial(
+    # This is used to test that the auth credentials file deprecation
+    # warning is emitted as expected.
+    pytest.warns,
+    DeprecationWarning,
+    match="argument is deprecated because of a potential security risk",
+)

tests/unit/operations_v1/test_operations_rest_client.py

@@ -23,6 +23,7 @@
 
 import pytest
 from typing import Any, List
+from ...helpers import warn_deprecated_credentials_file
 
 try:
     import grpc  # noqa: F401
@@ -369,10 +370,7 @@ def test_operations_client_client_options(
         )
 
     # Check the case credentials_file is provided
-    with pytest.warns(
-        DeprecationWarning,
-        match="argument is deprecated because of a potential security risk",
-    ):
+    with warn_deprecated_credentials_file():
         options = client_options.ClientOptions(credentials_file="credentials.json")
     with mock.patch.object(transport_class, "__init__") as patched:
         patched.return_value = None
@@ -543,18 +541,12 @@ def test_operations_client_client_options_credentials_file(
     client_class, transport_class, transport_name
 ):
     # Check the case credentials file is provided.
-    with pytest.warns(
-        DeprecationWarning,
-        match="argument is deprecated because of a potential security risk",
-    ):
+    with warn_deprecated_credentials_file():
         options = client_options.ClientOptions(credentials_file="credentials.json")
     if "async" in str(client_class):
         # TODO(): Add support for credentials file to async REST transport.
         with pytest.raises(core_exceptions.AsyncRestUnsupportedParameterError):
-            with pytest.warns(
-                DeprecationWarning,
-                match="argument is deprecated because of a potential security risk",
-            ):
+            with warn_deprecated_credentials_file():
 
                 client_class(client_options=options, transport=transport_name)
     else:
@@ -584,10 +576,7 @@ def test_operations_client_client_options_credentials_file(
 )
 def test_list_operations_rest(google_auth_default, credentials_file):
     if credentials_file:
-        with pytest.warns(
-            DeprecationWarning,
-            match="argument is deprecated because of a potential security risk",
-        ):
+        with warn_deprecated_credentials_file():
             sync_transport = transports.rest.OperationsRestTransport(
                 credentials_file=credentials_file,
                 http_options=HTTP_OPTIONS,
@@ -1154,10 +1143,7 @@ def test_transport_adc(client_class, transport_class, credentials):
 def test_operations_base_transport_error():
     # Passing both a credentials object and credentials_file should raise an error
     with pytest.raises(core_exceptions.DuplicateCredentialArgs):
-        with pytest.warns(
-            DeprecationWarning,
-            match="argument is deprecated because of a potential security risk",
-        ):
+        with warn_deprecated_credentials_file():
             transports.OperationsTransport(
                 credentials=ga_credentials.AnonymousCredentials(),
                 credentials_file="credentials.json",
@@ -1199,10 +1185,7 @@ def test_operations_base_transport_with_credentials_file():
     ) as Transport:
         Transport.return_value = None
         load_creds.return_value = (ga_credentials.AnonymousCredentials(), None)
-        with pytest.warns(
-            DeprecationWarning,
-            match="argument is deprecated because of a potential security risk",
-        ):
+        with warn_deprecated_credentials_file():
             transports.OperationsTransport(
                 credentials_file="credentials.json",
                 quota_project_id="octopus",

tests/unit/test_client_options.py

@@ -14,6 +14,7 @@
 
 from re import match
 import pytest
+from ..helpers import warn_deprecated_credentials_file
 
 from google.api_core import client_options
 
@@ -27,11 +28,7 @@ def get_client_encrypted_cert():
 
 
 def test_constructor():
-
-    with pytest.warns(
-        DeprecationWarning,
-        match="argument is deprecated because of a potential security risk",
-    ):
+    with warn_deprecated_credentials_file():
         options = client_options.ClientOptions(
             api_endpoint="foo.googleapis.com",
             client_cert_source=get_client_cert,
@@ -106,10 +103,7 @@ def test_constructor_with_api_key():
 
 def test_constructor_with_both_api_key_and_credentials_file():
     with pytest.raises(ValueError):
-        with pytest.warns(
-            DeprecationWarning,
-            match="argument is deprecated because of a potential security risk",
-        ):
+        with warn_deprecated_credentials_file():
             client_options.ClientOptions(
                 api_key="api-key",
                 credentials_file="path/to/credentials.json",

tests/unit/test_grpc_helpers.py

@@ -15,6 +15,7 @@
 from unittest import mock
 
 import pytest
+from ..helpers import warn_deprecated_credentials_file
 
 try:
     import grpc
@@ -581,10 +582,7 @@ def test_create_channel_explicit_with_duplicate_credentials():
     target = "example.com:443"
 
     with pytest.raises(exceptions.DuplicateCredentialArgs):
-        with pytest.warns(
-            DeprecationWarning,
-            match="argument is deprecated because of a potential security risk",
-        ):
+        with warn_deprecated_credentials_file():
             grpc_helpers.create_channel(
                 target,
                 credentials_file="credentials.json",
@@ -714,10 +712,7 @@ def test_create_channel_with_credentials_file(
     credentials_file = "/path/to/credentials/file.json"
     composite_creds = composite_creds_call.return_value
 
-    with pytest.warns(
-        DeprecationWarning,
-        match="argument is deprecated because of a potential security risk",
-    ):
+    with warn_deprecated_credentials_file():
         channel = grpc_helpers.create_channel(target, credentials_file=credentials_file)
 
     google.auth.load_credentials_from_file.assert_called_once_with(
@@ -750,10 +745,7 @@ def test_create_channel_with_credentials_file_and_scopes(
     credentials_file = "/path/to/credentials/file.json"
     composite_creds = composite_creds_call.return_value
 
-    with pytest.warns(
-        DeprecationWarning,
-        match="argument is deprecated because of a potential security risk",
-    ):
+    with warn_deprecated_credentials_file():
         channel = grpc_helpers.create_channel(
             target, credentials_file=credentials_file, scopes=scopes
         )
@@ -788,10 +780,7 @@ def test_create_channel_with_credentials_file_and_default_scopes(
     credentials_file = "/path/to/credentials/file.json"
     composite_creds = composite_creds_call.return_value
 
-    with pytest.warns(
-        DeprecationWarning,
-        match="argument is deprecated because of a potential security risk",
-    ):
+    with warn_deprecated_credentials_file():
         channel = grpc_helpers.create_channel(
             target, credentials_file=credentials_file, default_scopes=default_scopes
         )