build: treat warnings as errors (#819)

* build: treat warnings as errors

* resolve warning Client.dataset is deprecated and will be removed in a future version

* See #820

* address warning @pytest.yield_fixture is deprecated. Use @pytest.fixture instead; they are the same.

* filter warnings from grpcio

* revert

* update comment

Author: parthea

pytest.ini

@@ -0,0 +1,23 @@
+[pytest]
+filterwarnings =
+    # treat all warnings as errors
+    error
+    # Remove once https://github.com/protocolbuffers/protobuf/issues/12186 is fixed
+    ignore:.*custom tp_new.*in Python 3.14:DeprecationWarning
+    # Remove once Release PR https://github.com/googleapis/python-api-common-protos/pull/191 is merged
+    ignore:.*pkg_resources.declare_namespace:DeprecationWarning
+    ignore:.*pkg_resources is deprecated as an API:DeprecationWarning
+    # Remove once https://github.com/grpc/grpc/issues/35086 is fixed
+    ignore:There is no current event loop:DeprecationWarning:grpc.aio._channel
+    # Remove once release PR https://github.com/googleapis/proto-plus-python/pull/391 is merged
+    ignore:datetime.datetime.utcfromtimestamp\(\) is deprecated:DeprecationWarning:proto.datetime_helpers
+    # Remove once release PR https://github.com/googleapis/python-api-core/pull/555 is merged
+    ignore:datetime.datetime.utcnow\(\) is deprecated:DeprecationWarning:google.api_core.datetime_helpers
+    # Remove once https://github.com/googleapis/python-logging/issues/818 is fixed
+    ignore:datetime.datetime.utcfromtimestamp\(\) is deprecated:DeprecationWarning:google.cloud.logging_v2.handlers.transports
+    ignore:datetime.datetime.utcnow\(\) is deprecated:DeprecationWarning:tests.unit.test__http
+    ignore:datetime.datetime.utcnow\(\) is deprecated:DeprecationWarning:tests.unit.test_entries
+    # Remove once https://github.com/googleapis/python-logging/issues/820 is fixed
+    ignore:.*warn.*is deprecated, use.*warning.*instead:DeprecationWarning
+    # Remove once a version of grpcio newer than 1.59.3 is released to PyPI
+    ignore:datetime.datetime.utcnow\(\) is deprecated:DeprecationWarning:grpc._channel

samples/snippets/export_test.py

@@ -34,7 +34,7 @@ def _random_id():
     )
 
 
-@pytest.yield_fixture
+@pytest.fixture
 def example_sink():
     client = logging.Client()
 

tests/system/test_system.py

@@ -813,7 +813,7 @@ def _init_bigquery_dataset(self):
         # Stackdriver Logging to write into it.
         retry = RetryErrors((TooManyRequests, BadGateway, ServiceUnavailable))
         bigquery_client = bigquery.Client()
-        dataset_ref = bigquery_client.dataset(dataset_name)
+        dataset_ref = bigquery.DatasetReference(Config.CLIENT.project, dataset_name)
         dataset = retry(bigquery_client.create_dataset)(bigquery.Dataset(dataset_ref))
         self.to_delete.append((bigquery_client, dataset))
         bigquery_client.get_dataset(dataset)

tests/unit/handlers/test_app_engine.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 import logging
+import pytest
 import unittest
 
 import mock
@@ -46,6 +47,9 @@ def test_constructor_w_gae_standard_env(self):
         ), mock.patch(
             "google.cloud.logging_v2.handlers._monitored_resources.retrieve_metadata_server",
             return_value=self.PROJECT,
+        ), pytest.warns(
+            DeprecationWarning,
+            match="AppEngineHandler is deprecated. Use CloudLoggingHandler instead",
         ):
             handler = self._make_one(client, transport=_Transport)
 
@@ -78,6 +82,9 @@ def test_constructor_w_gae_flex_env(self):
         ), mock.patch(
             "google.cloud.logging_v2.handlers._monitored_resources.retrieve_metadata_server",
             return_value=self.PROJECT,
+        ), pytest.warns(
+            DeprecationWarning,
+            match="AppEngineHandler is deprecated. Use CloudLoggingHandler instead",
         ):
             handler = self._make_one(
                 client, name=name, transport=_Transport, stream=stream
@@ -99,7 +106,10 @@ def test_emit(self):
             "google.cloud.logging_v2.handlers.app_engine.get_request_data",
             return_value=(expected_http_request, trace_id, None, None),
         )
-        with get_request_patch:
+        with get_request_patch, pytest.warns(
+            DeprecationWarning,
+            match="AppEngineHandler is deprecated. Use CloudLoggingHandler instead",
+        ):
             # library integrations mocked to return test data
             client = mock.Mock(project=self.PROJECT, spec=["project"])
             handler = self._make_one(client, transport=_Transport)
@@ -137,7 +147,10 @@ def test_emit_manual_field_override(self):
             "google.cloud.logging_v2.handlers.app_engine.get_request_data",
             return_value=(inferred_http_request, inferred_trace_id, None, None),
         )
-        with get_request_patch:
+        with get_request_patch, pytest.warns(
+            DeprecationWarning,
+            match="AppEngineHandler is deprecated. Use CloudLoggingHandler instead",
+        ):
             # library integrations mocked to return test data
             client = mock.Mock(project=self.PROJECT, spec=["project"])
             handler = self._make_one(client, transport=_Transport)
@@ -197,12 +210,20 @@ def test_get_gae_labels_with_label(self):
         from google.cloud.logging_v2.handlers import app_engine
 
         trace_id = "test-gae-trace-id"
-        gae_labels = self._get_gae_labels_helper(trace_id)
+        with pytest.warns(
+            DeprecationWarning,
+            match="AppEngineHandler is deprecated. Use CloudLoggingHandler instead",
+        ):
+            gae_labels = self._get_gae_labels_helper(trace_id)
         expected_labels = {app_engine._TRACE_ID_LABEL: trace_id}
         self.assertEqual(gae_labels, expected_labels)
 
     def test_get_gae_labels_without_label(self):
-        gae_labels = self._get_gae_labels_helper(None)
+        with pytest.warns(
+            DeprecationWarning,
+            match="AppEngineHandler is deprecated. Use CloudLoggingHandler instead",
+        ):
+            gae_labels = self._get_gae_labels_helper(None)
         self.assertEqual(gae_labels, {})
 
 

tests/unit/handlers/test_container_engine.py

@@ -12,6 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import pytest
 import unittest
 
 
@@ -27,18 +28,30 @@ def _make_one(self, *args, **kw):
         return self._get_target_class()(*args, **kw)
 
     def test_ctor_defaults(self):
-        handler = self._make_one()
+        with pytest.warns(
+            DeprecationWarning,
+            match="ContainerEngineHandler is deprecated. Use StructuredLogHandler instead",
+        ):
+            handler = self._make_one()
         self.assertIsNone(handler.name)
 
     def test_ctor_w_name(self):
-        handler = self._make_one(name="foo")
+        with pytest.warns(
+            DeprecationWarning,
+            match="ContainerEngineHandler is deprecated. Use StructuredLogHandler instead",
+        ):
+            handler = self._make_one(name="foo")
         self.assertEqual(handler.name, "foo")
 
     def test_format(self):
         import logging
         import json
 
-        handler = self._make_one()
+        with pytest.warns(
+            DeprecationWarning,
+            match="ContainerEngineHandler is deprecated. Use StructuredLogHandler instead",
+        ):
+            handler = self._make_one()
         logname = "loggername"
         message = "hello world，嗨 世界"
         record = logging.LogRecord(
@@ -51,6 +64,10 @@ def test_format(self):
             "thread": record.thread,
             "severity": record.levelname,
         }
-        payload = handler.format(record)
+        with pytest.warns(
+            DeprecationWarning,
+            match="format_stackdriver_json is deprecated. Use StructuredLogHandler instead",
+        ):
+            payload = handler.format(record)
 
         self.assertEqual(payload, json.dumps(expected_payload, ensure_ascii=False))