Don't return transport from new_stats_exporter (#605)

Author: c24t

contrib/opencensus-ext-stackdriver/opencensus/ext/stackdriver/stats_exporter/__init__.py

@@ -390,9 +390,8 @@ def new_stats_exporter(options, interval=None):
     client = monitoring_v3.MetricServiceClient(client_info=ci)
     exporter = StackdriverStatsExporter(client=client, options=options)
 
-    tt = transport.get_exporter_thread(stats.stats, exporter,
-                                       interval=interval)
-    return exporter, tt
+    transport.get_exporter_thread(stats.stats, exporter, interval=interval)
+    return exporter
 
 
 def get_task_value():

contrib/opencensus-ext-stackdriver/tests/test_stackdriver_stats.py

@@ -125,7 +125,7 @@ def test_not_blank_project(self):
              '.monitoring_v3.MetricServiceClient'), _Client)
 
         with patch_client:
-            exporter_created, transport = stackdriver.new_stats_exporter(
+            exporter_created = stackdriver.new_stats_exporter(
                 stackdriver.Options(project_id=1))
 
         self.assertIsInstance(exporter_created,
@@ -146,7 +146,7 @@ def test_client_info_user_agent(self):
             '.MetricServiceClient', _Client)
 
         with patch_client:
-            exporter, transport = stackdriver.new_stats_exporter(
+            exporter = stackdriver.new_stats_exporter(
                 stackdriver.Options(project_id=1))
 
         self.assertIn(stackdriver.get_user_agent_slug(),
@@ -372,8 +372,38 @@ def step(self):
             self.logger.exception("Error handling metric export")
 
 
+class MockGetExporterThread(object):
+    """Intercept calls to get_exporter_thread.
+
+    To get a reference to the running PeriodicTask created by
+    get_exporter_thread.
+    """
+    def __init__(self):
+        self.transport = None
+
+    def __enter__(self):
+        original_func = transport_module.get_exporter_thread
+
+        def get_exporter_thread(*aa, **kw):
+            self.transport = original_func(*aa, **kw)
+
+        mock_get = mock.Mock()
+        mock_get.side_effect = get_exporter_thread
+        self.patcher = mock.patch(
+            ('opencensus.ext.stackdriver.stats_exporter'
+             '.transport.get_exporter_thread'),
+            mock_get)
+        self.patcher.start()
+        return self
+
+    def __exit__(self, type, value, traceback):
+        self.patcher.stop()
+
+
 @mock.patch('opencensus.ext.stackdriver.stats_exporter'
             '.monitoring_v3.MetricServiceClient')
+@mock.patch('opencensus.ext.stackdriver.stats_exporter'
+            '.stats.stats')
 class TestAsyncStatsExport(unittest.TestCase):
     """Check that metrics are exported using the exporter thread."""
 
@@ -384,22 +414,19 @@ def setUp(self):
         patcher.start()
         self.addCleanup(patcher.stop)
 
-    @mock.patch('opencensus.ext.stackdriver.stats_exporter'
-                '.stats.stats')
     def test_export_empty(self, mock_stats, mock_client):
         """Check that we don't attempt to export empty metric sets."""
 
         mock_stats.get_metrics.return_value = []
 
-        exporter, transport = stackdriver.new_stats_exporter(
-            stackdriver.Options(project_id=1))
+        with MockGetExporterThread() as mget:
+            exporter = stackdriver.new_stats_exporter(
+                stackdriver.Options(project_id=1))
+            mget.transport.step()
 
-        transport.step()
         exporter.client.create_metric_descriptor.assert_not_called()
         exporter.client.create_time_series.assert_not_called()
 
-    @mock.patch('opencensus.ext.stackdriver.stats_exporter'
-                '.stats.stats')
     def test_export_single_metric(self, mock_stats, mock_client):
         """Check that we can export a set of a single metric."""
 
@@ -424,10 +451,10 @@ def test_export_single_metric(self, mock_stats, mock_client):
         mm = metric.Metric(descriptor=desc, time_series=ts)
         mock_stats.get_metrics.return_value = [mm]
 
-        exporter, transport = stackdriver.new_stats_exporter(
-            stackdriver.Options(project_id=1))
-
-        transport.step()
+        with MockGetExporterThread() as mget:
+            exporter = stackdriver.new_stats_exporter(
+                stackdriver.Options(project_id=1))
+            mget.transport.step()
 
         exporter.client.create_metric_descriptor.assert_called()
         self.assertEqual(

tests/system/stats/stackdriver/stackdriver_stats_test.py

@@ -21,6 +21,7 @@
 import mock
 
 from opencensus.ext.stackdriver import stats_exporter as stackdriver
+from opencensus.metrics import transport
 from opencensus.stats import aggregation as aggregation_module
 from opencensus.stats import measure as measure_module
 from opencensus.stats import stats as stats_module
@@ -143,9 +144,8 @@ def test_stats_record_async(self):
         view_manager = stats.view_manager
         stats_recorder = stats.stats_recorder
 
-        exporter, transport = stackdriver.new_stats_exporter(
-            stackdriver.Options(project_id=PROJECT),
-            interval=ASYNC_TEST_INTERVAL)
+        exporter = stackdriver.new_stats_exporter(
+            stackdriver.Options(project_id=PROJECT))
         view_manager.register_exporter(exporter)
 
         # Register view.
@@ -164,7 +164,6 @@ def test_stats_record_async(self):
 
         measure_map.record(tag_map)
         # Give the exporter thread enough time to export exactly once
-        time.sleep(ASYNC_TEST_INTERVAL * 2 - 1)
-        transport.stop()
+        time.sleep(transport.DEFAULT_INTERVAL * 1.5)
 
         self.check_sd_md(exporter, view_description)