This is an automated email from the ASF dual-hosted git repository. Abacn pushed a commit to branch revert-39826-feat-extended-cleanup-manager in repository https://gitbox.apache.org/repos/asf/beam.git
commit 9bcb250b4fabd88eed23cb6e0b87a75d0d8e33e2 Author: Yi Hu <[email protected]> AuthorDate: Sat Aug 22 22:47:23 2026 -0400 Revert "[GSoC-273] Feat: Integrate TestPubsubContext to prevent Pub/Sub resou…" This reverts commit 015e823a1a9a8962f6f7cda5986d594413d307d0. --- .../streaming_wordcount_debugging_it_test.py | 12 +-- .../examples/streaming_wordcount_it_test.py | 12 +-- .../apache_beam/io/gcp/pubsub_integration_test.py | 17 +--- sdks/python/apache_beam/testing/README.md | 109 --------------------- 4 files changed, 13 insertions(+), 137 deletions(-) diff --git a/sdks/python/apache_beam/examples/streaming_wordcount_debugging_it_test.py b/sdks/python/apache_beam/examples/streaming_wordcount_debugging_it_test.py index c0a7af1b42e..f3460ec24f1 100644 --- a/sdks/python/apache_beam/examples/streaming_wordcount_debugging_it_test.py +++ b/sdks/python/apache_beam/examples/streaming_wordcount_debugging_it_test.py @@ -32,7 +32,6 @@ from apache_beam.runners.runner import PipelineState from apache_beam.testing import test_utils from apache_beam.testing.pipeline_verifiers import PipelineStateMatcher from apache_beam.testing.test_pipeline import TestPipeline -from apache_beam.testing.pubsub_test_context import TestPubsubContext INPUT_TOPIC = 'wc_topic_input' OUTPUT_TOPIC = 'wc_topic_output' @@ -61,7 +60,6 @@ class StreamingWordcountDebuggingIT(unittest.TestCase): def setUp(self): self.test_pipeline = TestPipeline(is_integration_test=True) self.project = self.test_pipeline.get_option('project') - self.pubsub_monitor = TestPubsubContext(project_id=self.project) self.setup_pubsub() def setup_pubsub(self): @@ -85,10 +83,6 @@ class StreamingWordcountDebuggingIT(unittest.TestCase): self.project, OUTPUT_SUB + self.uuid), topic=self.output_topic.name, ack_deadline_seconds=60) - self.pubsub_monitor.register_topic(self.input_topic.name) - self.pubsub_monitor.register_topic(self.output_topic.name) - self.pubsub_monitor.register_subscription(self.input_sub.name) - self.pubsub_monitor.register_subscription(self.output_sub.name) def _inject_data(self, topic, data): """Inject numbers as test data to PubSub.""" @@ -97,8 +91,10 @@ class StreamingWordcountDebuggingIT(unittest.TestCase): self.pub_client.publish(self.input_topic.name, str(n).encode('utf-8')) def tearDown(self): - with self.pubsub_monitor: - pass + test_utils.cleanup_subscriptions( + self.sub_client, [self.input_sub, self.output_sub]) + test_utils.cleanup_topics( + self.pub_client, [self.input_topic, self.output_topic]) @pytest.mark.it_postcommit @unittest.skip( diff --git a/sdks/python/apache_beam/examples/streaming_wordcount_it_test.py b/sdks/python/apache_beam/examples/streaming_wordcount_it_test.py index 786e79bc3cd..9ed27a500a7 100644 --- a/sdks/python/apache_beam/examples/streaming_wordcount_it_test.py +++ b/sdks/python/apache_beam/examples/streaming_wordcount_it_test.py @@ -32,7 +32,6 @@ from apache_beam.runners.runner import PipelineState from apache_beam.testing import test_utils from apache_beam.testing.pipeline_verifiers import PipelineStateMatcher from apache_beam.testing.test_pipeline import TestPipeline -from apache_beam.testing.pubsub_test_context import TestPubsubContext INPUT_TOPIC = 'wc_topic_input' OUTPUT_TOPIC = 'wc_topic_output' @@ -47,7 +46,6 @@ class StreamingWordCountIT(unittest.TestCase): def setUp(self): self.test_pipeline = TestPipeline(is_integration_test=True) self.project = self.test_pipeline.get_option('project') - self.pubsub_monitor = TestPubsubContext(project_id=self.project) self.uuid = str(uuid.uuid4()) # Set up PubSub environment. @@ -68,10 +66,6 @@ class StreamingWordCountIT(unittest.TestCase): self.project, OUTPUT_SUB + self.uuid), topic=self.output_topic.name, ack_deadline_seconds=60) - self.pubsub_monitor.register_topic(self.input_topic.name) - self.pubsub_monitor.register_topic(self.output_topic.name) - self.pubsub_monitor.register_subscription(self.input_sub.name) - self.pubsub_monitor.register_subscription(self.output_sub.name) def _inject_numbers(self, topic, num_messages): """Inject numbers as test data to PubSub.""" @@ -80,8 +74,10 @@ class StreamingWordCountIT(unittest.TestCase): self.pub_client.publish(self.input_topic.name, str(n).encode('utf-8')) def tearDown(self): - with self.pubsub_monitor: - pass + test_utils.cleanup_subscriptions( + self.sub_client, [self.input_sub, self.output_sub]) + test_utils.cleanup_topics( + self.pub_client, [self.input_topic, self.output_topic]) @pytest.mark.it_postcommit def test_streaming_wordcount_it(self): diff --git a/sdks/python/apache_beam/io/gcp/pubsub_integration_test.py b/sdks/python/apache_beam/io/gcp/pubsub_integration_test.py index ae1da92ac86..89fd4461beb 100644 --- a/sdks/python/apache_beam/io/gcp/pubsub_integration_test.py +++ b/sdks/python/apache_beam/io/gcp/pubsub_integration_test.py @@ -36,7 +36,6 @@ from apache_beam.runners.runner import PipelineState from apache_beam.testing import test_utils from apache_beam.testing.pipeline_verifiers import PipelineStateMatcher from apache_beam.testing.test_pipeline import TestPipeline -from apache_beam.testing.pubsub_test_context import TestPubsubContext INPUT_TOPIC = 'psit_topic_input' OUTPUT_TOPIC = 'psit_topic_output' @@ -138,7 +137,7 @@ class PubSubIntegrationTest(unittest.TestCase): self.runner_name = type(self.test_pipeline.runner).__name__ self.project = self.test_pipeline.get_option('project') self.uuid = str(uuid.uuid4()) - self.pubsub_monitor = TestPubsubContext(project_id=self.project) + # Set up PubSub environment. from google.cloud import pubsub self.pub_client = pubsub.PublisherClient() @@ -156,19 +155,15 @@ class PubSubIntegrationTest(unittest.TestCase): name=self.sub_client.subscription_path( self.project, OUTPUT_SUB + self.uuid), topic=self.output_topic.name) - # Register resources with the monitor immediately upon creation. - self.pubsub_monitor_register_topic(self.input_topic.name) - self.pubsub_monitor_register_topic(self.output_topic.name) - self.pubsub_monitor_register_subscription(self.input_sub.name) - self.pubsub_monitor_register_subscription(self.output_sub.name) # Add a 30 second sleep after resource creation to ensure subscriptions will # receive messages. time.sleep(30) def tearDown(self): - # The TestPubsubContext will automatically delete the topics and subscriptions - with self.pubsub_monitor: - pass + test_utils.cleanup_subscriptions( + self.sub_client, [self.input_sub, self.output_sub]) + test_utils.cleanup_topics( + self.pub_client, [self.input_topic, self.output_topic]) def _test_streaming(self, with_attributes): """Runs IT pipeline with message verifier. @@ -334,7 +329,6 @@ class PubSubIntegrationTest(unittest.TestCase): ordering_topic = self.pub_client.create_topic( name=self.pub_client.topic_path( self.project, 'psit_topic_ordering' + self.uuid)) - self.pubsub_monitor.register_topic(ordering_topic.name) ordering_sub = self.sub_client.create_subscription( request=Subscription( name=self.sub_client.subscription_path( @@ -342,7 +336,6 @@ class PubSubIntegrationTest(unittest.TestCase): topic=ordering_topic.name, enable_message_ordering=True, )) - self.pubsub_monitor.register_subscription(ordering_sub.name) time.sleep(10) try: diff --git a/sdks/python/apache_beam/testing/README.md b/sdks/python/apache_beam/testing/README.md deleted file mode 100644 index 99a3716c3f9..00000000000 --- a/sdks/python/apache_beam/testing/README.md +++ /dev/null @@ -1,109 +0,0 @@ -<!-- - Licensed to the Apache Software Foundation (ASF) under one - or more contributor license agreements. See the NOTICE file - distributed with this work for additional information - regarding copyright ownership. The ASF licenses this file - to you under the Apache License, Version 2.0 (the - "License"); you may not use this file except in compliance - with the License. You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, - software distributed under the License is distributed on an - "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY - KIND, either express or implied. See the License for the - specific language governing permissions and limitations - under the License. ---> - -# Audit Log and Justification: Implementation of TestPubsubContext -#### Date: 2026-08-20 - -This document serves as a living log of resource leaks detected in our GCP environment due to failures or premature interruptions in CI/CD pipelines (such as Jenkins or GitHub Actions). The purpose of this log is to centralize evidence of orphaned components and provide technical and economic justification for implementing the TestPubsubContext lifecycle manager across all integration tests. The engineering team is encouraged to document any new leaks detected in future test suites in th [...] - -## Detection Methodology (Audit Script) - -To identify optimization opportunities and prevent the accumulation of phantom resources in GCP, we developed an automated audit script (`auditar_backlog_wordcount.py`). This script connects to the `apache-beam-testing` project and actively filters for orphaned subscriptions based on the prefixes used by our test suites. -``` -python - -from google.cloud import pubsub_v1 -from datetime import datetime, timezone, timedelta - -def audit_wordcount_subscriptions(project_id): - subscriber = pubsub_v1.SubscriberClient() - project_path = f"projects/{project_id}" - - print(f"Searching for orphan subscriptions with 'resource_sub' prefixes in: {project_id}...\n") - print(f"{'Orphan Subscription Detected':<70} | {'Status'}") - print("-" * 90) - total_leaks = 0 - - # List subscriptions in the GCP project - for sub in subscriber.list_subscriptions(project=project_path): - sub_name = sub.name.split("/")[-1] - - # Filter by those created by wordcount_it_test ('name of the resource') - if sub_name.startswith("resource_sub") or "resource_subscription" in sub_name: - total_leaks += 1 - print(f"{sub_name:<70} | ACTIVE (ORPHAN)") - - print("-" * 90) - print(f"Diagnosis: Detected {total_leaks} active orphan 'resource_sub' subscriptions in GCP.") - -if __name__ == "__main__": - audit_wordcount_subscriptions("apache-beam-testing") - -``` - -## Evidence: Leaks in Pub/Sub Integration Tests (`psit_`) - -During the execution of the main integration test suite, the standard cleanup mechanism proved insufficient when tests failed or were abruptly aborted. - -### **Critical findings:** - -* We detected exactly 87 active, orphaned subscriptions in GCP under the patterns `psit_subscription_input`..., `psit_subscription_output`..., and `psit_sub_ordering`.... -* These dead queues were created during previous CI/CD test runs but were never deleted due to Jenkins or GitHub Actions pipeline failures that bypassed the standard cleanup block. -* These active queues have been silently accumulating and retaining unacknowledged messages (backlog) from continuous test runs, generating ongoing ghost storage costs. - -```text -Orphan Subscription Detected | Status ------------------------------------------------------------------------------------------- -psit_subscription_output50347d48-743d-4ee7-9f9c-8fdcca650b84 | ACTIVE (ORPHAN) -psit_subscription_input51a51eec-193c-455f-9cc5-ea6a57d79062 | ACTIVE (ORPHAN) -psit_subscription_output85e31e61-0eb4-4ecf-8f8d-e824b6fa7c66 | ACTIVE (ORPHAN) -psit_subscription_input6906b262-7818-4b20-9ace-e3c6885f3f49 | ACTIVE (ORPHAN) -psit_subscription_inputed376474-e61e-49e1-95ee-7ed4174cc264 | ACTIVE (ORPHAN) -... -[82 more orphaned psit_ subscriptions listed] ------------------------------------------------------------------------------------------- -Diagnosis: Detected 87 active orphan 'psit_' subscriptions in GCP. -``` - -## Evidence: Leaks in Streaming Wordcount (`wc_`) and Handler Justification - -**Critical findings:** -* We detected exactly **142 active, orphaned subscriptions** in GCP—following the patterns `wc_subscription_input...` and `wc_subscription_output...`—left behind by aborted or failed Jenkins CI runs. -* These 142 inactive queues have been silently accumulating unacknowledged messages (backlogs), thereby inflating GCP storage costs. - -**Evidence from the GCP audit log:** -```text -Orphaned subscription detected | Status ------------------------------------------------------------------------------------------- -wc_subscription_outputd71a1c7c-ba81-40f6-8d03-682cad78e162 | ACTIVE (ORPHANED) -wc_subscription_input7bd1abaa-6955-4f0a-a3b4-fa51c0a835eb | ACTIVE (ORPHANED) -... -[140 additional orphaned subscriptions listed] ------------------------------------------------------------------------------------------- -Diagnosis: 142 active, orphaned 'wc_' subscriptions detected in GCP. -``` - -### Justification for adopting TestPubsubContext - -Both Wordcount tests dynamically instantiate subscriptions and topics using the variables INPUT_TOPIC = 'wc_topic_input' -OUTPUT_TOPIC = 'wc_topic_output', INPUT_SUB = 'wc_subscription_input', and OUTPUT_SUB = 'wc_subscription_output'. -Historically, when these tests ran in parallel in CI/CD and failed, it was impossible to determine which specific test left -each resource behind. - -By wrapping these tests with TestPubsubContext, the handler uses Python's execution stack inspection (inspect.stack()) to automatically capture the class name of the test that originated the request (self.caller_class = self_obj.__class__.__name__). When a subscription or topic is registered, the handler detects which test created it and injects it directly into the execution log. If the test fails, the handler logs it and allows for a "teardown" with the exact trace of who created the r [...] \ No newline at end of file
