tools/perf/metrics/webrtc_stats_unittest.py

   1 # Copyright 2013 The Chromium Authors. All rights reserved.
   2 # Use of this source code is governed by a BSD-style license that can be
   3 # found in the LICENSE file.
   4
   5 import unittest
   6
   7 from telemetry.testing import simple_mock
   8
   9 from metrics import webrtc_stats
  10
  11
  12 SAMPLE_JSON = '''
  13 [[
  14    [
  15       {
  16          "googFrameHeightInput":"480",
  17          "googFrameWidthInput":"640",
  18          "googFrameRateSent": "23",
  19          "packetsLost":"-1",
  20          "googRtt":"19",
  21          "packetsSent":"1",
  22          "bytesSent":"0"
  23       },
  24       {
  25          "audioInputLevel":"2048",
  26          "googRtt":"20",
  27          "googCodecName":"opus",
  28          "packetsSent":"4",
  29          "bytesSent":"0"
  30       }
  31    ],
  32    [
  33       {
  34          "googFrameHeightInput":"480",
  35          "googFrameWidthInput":"640",
  36          "googFrameRateSent": "21",
  37          "packetsLost":"-1",
  38          "googRtt":"18",
  39          "packetsSent":"8",
  40          "bytesSent":"6291"
  41       },
  42       {
  43          "audioInputLevel":"1878",
  44          "googRtt":"17",
  45          "googCodecName":"opus",
  46          "packetsSent":"16",
  47          "bytesSent":"634"
  48       }
  49    ],
  50    [
  51       {
  52           "googAvailableSendBandwidth":"30000",
  53           "googAvailableRecvBandwidth":"12345",
  54           "googTargetEncBitrate":"10000"
  55       }
  56   ]
  57 ],
  58 [
  59    [
  60       {
  61          "googFrameRateReceived": "23",
  62          "googDecodeMs":"0",
  63          "packetsReceived":"8",
  64          "googRenderDelayMs":"10",
  65          "googMaxDecodeMs":"0",
  66          "googRtt":"100"
  67       }
  68    ],
  69    [
  70       {
  71          "googFrameRateReceived": "23",
  72          "googDecodeMs":"14",
  73          "packetsReceived":"1234",
  74          "googRenderDelayMs":"102",
  75          "googMaxDecodeMs":"150",
  76          "googRtt":"101"
  77       }
  78    ],
  79    [
  80       {
  81           "googAvailableSendBandwidth":"40000",
  82           "googAvailableRecvBandwidth":"22345",
  83           "googTargetEncBitrate":"20000"
  84       }
  85   ]
  86 ]]
  87 '''
  88
  89
  90 class FakeResults(object):
  91   def __init__(self, current_page):
  92     self._received_values = []
  93     self._current_page = current_page
  94
  95   @property
  96   def received_values(self):
  97     return self._received_values
  98
  99   @property
 100   def current_page(self):
 101     return self._current_page
 102
 103   def AddValue(self, value):
 104     self._received_values.append(value)
 105
 106
 107 class WebRtcStatsUnittest(unittest.TestCase):
 108
 109   def _RunMetricOnJson(self, json_to_return):
 110     stats_metric = webrtc_stats.WebRtcStatisticsMetric()
 111
 112     tab = simple_mock.MockObject()
 113     page = simple_mock.MockObject()
 114
 115     stats_metric.Start(page, tab)
 116
 117     tab.ExpectCall('EvaluateJavaScript',
 118                    simple_mock.DONT_CARE).WillReturn(json_to_return)
 119     stats_metric.Stop(page, tab)
 120
 121     page.url = simple_mock.MockObject()
 122     results = FakeResults(page)
 123     stats_metric.AddResults(tab, results)
 124     return results
 125
 126   def testExtractsValuesAsTimeSeries(self):
 127     results = self._RunMetricOnJson(SAMPLE_JSON)
 128
 129     self.assertTrue(results.received_values,
 130                     'Expected values for googDecodeMs and others, got none.')
 131
 132     # This also ensures we're clever enough to tell video packetsSent from audio
 133     # packetsSent.
 134     self.assertEqual(results.received_values[3].values,
 135                      [4.0, 16.0])
 136     self.assertEqual(results.received_values[5].values,
 137                      [1.0, 8.0])
 138
 139   def testExtractsInterestingMetricsOnly(self):
 140     results = self._RunMetricOnJson(SAMPLE_JSON)
 141
 142     self.assertTrue(len(results.received_values) > 0)
 143     self.assertIn('peer_connection_0', results.received_values[0].name,
 144                   'The result should be a ListOfScalarValues instance with '
 145                   'a name <peer connection id>_<statistic>.')
 146     all_names = [value.name for value in results.received_values]
 147     self.assertIn('peer_connection_0_video_packets_sent', all_names)
 148     self.assertNotIn('peer_connection_1_video_packets_sent', all_names,
 149                      'Peer connection 1 does not have a video packets sent in '
 150                      'the JSON above, unlike peer connection 0 which does.')
 151     self.assertIn('peer_connection_0_video_goog_rtt', all_names)
 152     self.assertIn('peer_connection_1_video_goog_rtt', all_names)
 153     # The audio_audio is intentional since the code distinguishes audio repots
 154     # from video reports (even though audio_input_level is quite obvious).
 155     self.assertNotIn('peer_connection_0_audio_audio_input_level', all_names,
 156                      'Input level is in the JSON for both connections but '
 157                      'should not be reported since it is not interesting.')
 158     self.assertNotIn('peer_connection_1_audio_audio_input_level', all_names)
 159
 160   def testReturnsIfJsonIsEmpty(self):
 161     results = self._RunMetricOnJson('[]')
 162     self.assertFalse(results.received_values)
 163