Stackdriver end to end tests (#305)

Author: vcasadei

.circleci/config.yml

@@ -29,7 +29,7 @@ jobs:
           command: |
             if [ -n "$GOOGLE_APPLICATION_CREDENTIALS" ]; then
               openssl aes-256-cbc -d -a -k "$GOOGLE_CREDENTIALS_PASSPHRASE" \
-                  -in tests/system/trace/credentials.json.enc \
+                  -in tests/system/credentials.json.enc \
                   -out $GOOGLE_APPLICATION_CREDENTIALS
             else
               echo "No credentials. System tests will not run."

README.rst

@@ -411,6 +411,7 @@ You can enable Google Cloud client libraries integration by specifying ``'google
 
 .. _Cloud client libraries: https://github.com/GoogleCloudPlatform/google-cloud-python#google-cloud-python-client
 
+
 ------
  Stats
 ------

tests/system/trace/credentials.json.enc tests/system/credentials.json.enctests/system/trace/credentials.json.enc renamed to tests/system/credentials.json.enc

@@ -0,0 +1,157 @@
+# Copyright 2018, OpenCensus Authors
+#
+# Licensed 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.
+
+import os
+import random
+import time
+import unittest
+from retrying import retry
+from pprint import pprint
+from opencensus.stats import aggregation as aggregation_module
+from opencensus.stats.exporters import stackdriver_exporter as stackdriver
+from opencensus.stats import measure as measure_module
+from opencensus.stats import stats as stats_module
+from opencensus.stats import view as view_module
+from opencensus.tags import tag_key as tag_key_module
+from opencensus.tags import tag_map as tag_map_module
+from opencensus.tags import tag_value as tag_value_module
+from opencensus.common.transports import sync
+from google.cloud import monitoring_v3
+
+MiB = 1 << 20
+
+PROJECT = os.environ.get('GCLOUD_PROJECT_PYTHON')
+RETRY_WAIT_PERIOD = 10000  # Wait 10 seconds between each retry
+RETRY_MAX_ATTEMPT = 10  # Retry 10 times
+
+class TestBasicStats(unittest.TestCase):
+
+    def test_stats_record_sync(self):
+        # We are using sufix in order to prevent cached objects
+        sufix = str(os.getgid())
+
+        tag_key = "SampleKeySyncTest%s" % sufix
+        measure_name = "SampleMeasureNameSyncTest%s" % sufix
+        measure_description = "SampleDescriptionSyncTest%s" % sufix
+        view_name = "SampleViewNameSyncTest%s" % sufix
+        view_description = "SampleViewDescriptionSyncTest%s" % sufix
+
+        FRONTEND_KEY = tag_key_module.TagKey(tag_key)
+        VIDEO_SIZE_MEASURE = measure_module.MeasureInt(
+            measure_name, measure_description, "By")
+        VIDEO_SIZE_VIEW_NAME = view_name
+        VIDEO_SIZE_DISTRIBUTION = aggregation_module.DistributionAggregation(
+                                    [0.0, 16.0 * MiB, 256.0 * MiB])
+        VIDEO_SIZE_VIEW = view_module.View(VIDEO_SIZE_VIEW_NAME,
+                                        view_description,
+                                        [FRONTEND_KEY],
+                                        VIDEO_SIZE_MEASURE,
+                                        VIDEO_SIZE_DISTRIBUTION)
+
+        stats = stats_module.Stats()
+        view_manager = stats.view_manager
+        stats_recorder = stats.stats_recorder
+
+        client = monitoring_v3.MetricServiceClient()
+        exporter = stackdriver.StackdriverStatsExporter(options=stackdriver.Options(project_id=PROJECT),
+                                                        client=client,
+                                                        transport=sync.SyncTransport)
+        view_manager.register_exporter(exporter)
+
+        # Register view.
+        view_manager.register_view(VIDEO_SIZE_VIEW)
+
+        # Sleep for [0, 10] milliseconds to fake work.
+        time.sleep(random.randint(1, 10) / 1000.0)
+
+        # Process video.
+        # Record the processed video size.
+        tag_value = tag_value_module.TagValue("1200")
+        tag_map = tag_map_module.TagMap()
+        tag_map.insert(FRONTEND_KEY, tag_value)
+        measure_map = stats_recorder.new_measurement_map()
+        measure_map.measure_int_put(VIDEO_SIZE_MEASURE, 25 * MiB)
+
+        measure_map.record(tag_map)
+
+        # Sleep for [0, 10] milliseconds to fake wait.
+        time.sleep(random.randint(1, 10) / 1000.0)
+
+        @retry(wait_fixed=RETRY_WAIT_PERIOD, stop_max_attempt_number=RETRY_MAX_ATTEMPT)
+        def get_metric_descriptors(self, exporter, view_description):
+            name = exporter.client.project_path(PROJECT)
+            list_metrics_descriptors = exporter.client.list_metric_descriptors(name)
+            element = next((element for element in list_metrics_descriptors if element.description == view_description), None)
+        
+            self.assertIsNotNone(element)
+            self.assertEqual(element.description, view_description)
+            self.assertEqual(element.unit, "By")
+
+        get_metric_descriptors(self, exporter, view_description)
+
+    def test_stats_record_async(self):
+        # We are using sufix in order to prevent cached objects
+        sufix = str(os.getpid())
+
+        tag_key = "SampleKeyAsyncTest%s" % sufix
+        measure_name = "SampleMeasureNameAsyncTest%s" % sufix
+        measure_description = "SampleDescriptionAsyncTest%s" % sufix
+        view_name = "SampleViewNameAsyncTest%s" % sufix
+        view_description = "SampleViewDescriptionAsyncTest%s" % sufix
+
+        FRONTEND_KEY_ASYNC = tag_key_module.TagKey(tag_key)
+        VIDEO_SIZE_MEASURE_ASYNC = measure_module.MeasureInt(
+            measure_name, measure_description, "By")
+        VIDEO_SIZE_VIEW_NAME_ASYNC = view_name
+        VIDEO_SIZE_DISTRIBUTION_ASYNC = aggregation_module.DistributionAggregation(
+                                    [0.0, 16.0 * MiB, 256.0 * MiB])
+        VIDEO_SIZE_VIEW_ASYNC = view_module.View(VIDEO_SIZE_VIEW_NAME_ASYNC,
+                                        view_description,
+                                        [FRONTEND_KEY_ASYNC],
+                                        VIDEO_SIZE_MEASURE_ASYNC,
+                                        VIDEO_SIZE_DISTRIBUTION_ASYNC)
+
+        stats = stats_module.Stats()
+        view_manager = stats.view_manager
+        stats_recorder = stats.stats_recorder
+
+        exporter = stackdriver.new_stats_exporter(stackdriver.Options(project_id=PROJECT))
+        view_manager.register_exporter(exporter)
+
+        # Register view.
+        view_manager.register_view(VIDEO_SIZE_VIEW_ASYNC)
+
+        # Sleep for [0, 10] milliseconds to fake work.
+        time.sleep(random.randint(1, 10) / 1000.0)
+
+        # Process video.
+        # Record the processed video size.
+        tag_value = tag_value_module.TagValue("1200")
+        tag_map = tag_map_module.TagMap()
+        tag_map.insert(FRONTEND_KEY_ASYNC, tag_value)
+        measure_map = stats_recorder.new_measurement_map()
+        measure_map.measure_int_put(VIDEO_SIZE_MEASURE_ASYNC, 25 * MiB)
+
+        measure_map.record(tag_map)
+
+        @retry(wait_fixed=RETRY_WAIT_PERIOD, stop_max_attempt_number=RETRY_MAX_ATTEMPT)
+        def get_metric_descriptors(self, exporter, view_description):
+            name = exporter.client.project_path(PROJECT)
+            list_metrics_descriptors = exporter.client.list_metric_descriptors(name)
+            element = next((element for element in list_metrics_descriptors if element.description == view_description), None)
+            self.assertIsNotNone(element)
+            self.assertEqual(element.description, view_description)
+            self.assertEqual(element.unit, "By")
+
+        get_metric_descriptors(self, exporter, view_description)