Restrict deprecated parts of audio API usage to whitelisted apps

extensions/test/data/api_test/audio/test.js

 // Copyright 2013 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 /**
  * Asserts that device property values match properties in |expectedProperties|.
  * The method will *not* assert that the device contains *only* properties
  * specified in expected properties.
  * @param {Object} expectedProperties Expected device properties.
  * @param {Object} device Device object to test.
@@ skipping 48 matching lines @@
 
 /**
  * @param {Array.<Object>} devices List of devices returned by
  *    chrome.audio.getInfo or chrome.audio.getDevices.
  * @return {Array.<string>} Sorted list devices IDs for devices in |devices|.
  */
 function getDeviceIds(devices) {
   return devices.map(function(device) {return device.id;}).sort();
 }
 
+function EventListener(targetEvent) {
+  this.targetEvent = targetEvent;
+  this.listener = this.handleEvent.bind(this);
+  this.targetEvent.addListener(this.listener);
+  this.eventCount = 0;
+}
+
+EventListener.prototype.handleEvent = function() {
+  ++this.eventCount;
+}
+
+EventListener.prototype.reset = function() {
+  this.targetEvent.removeListener(this.listener);
+}
+
+var deviceChangedListener = null;
+
 chrome.test.runTests([
-  function getInfoTest() {
-    // Test output devices. Maps device ID -> tested device properties.
-    var kTestOutputDevices = {
-      '30001': {
-        id: '30001',
-        name: 'Jabra Speaker: Jabra Speaker 1'
-      },
-      '30002': {
-        id: '30002',
-        name: 'Jabra Speaker: Jabra Speaker 2'
-      },
-      '30003': {
-        id: '30003',
-        name: 'HDMI output: HDA Intel MID'
-      }
-    };
-
-    // Test input devices. Maps device ID -> tested device properties.
-    var kTestInputDevices = {
-      '40001': {
-        id: '40001',
-        name: 'Jabra Mic: Jabra Mic 1'
-      },
-      '40002': {
-        id: '40002',
-        name: 'Jabra Mic: Jabra Mic 2'
-      },
-      '40003': {
-        id: '40003',
-        name: 'Webcam Mic: Logitech Webcam'
-      }
-    };
-
-    chrome.audio.getInfo(chrome.test.callbackPass(
-        function(outputInfo, inputInfo) {
-          assertDevicesMatch(kTestOutputDevices, outputInfo);
-          assertDevicesMatch(kTestInputDevices, inputInfo);
-        }));
+  // Sets up a listener for audio.onDeviceChanged event -
+  // |verifyNoDeviceChangedEvents| test will later verify that no
+  // onDeviceChanged events have been observed.
+  function startDeviceChangedListener() {
+    deviceChangedListener = new EventListener(chrome.audio.onDeviceChanged);
+    chrome.test.succeed();
   },
 
   function getDevicesTest() {
     // Test output devices. Maps device ID -> tested device properties.
     var kTestDevices = {
       '30001': {
         id: '30001',
         stableDeviceId: '116606',
         displayName: 'Jabra Speaker 1',
         deviceName: 'Jabra Speaker',
@@ skipping 194 matching lines @@
       chrome.audio.getDevices({
         isActive: false
       }, chrome.test.callbackPass(function(devices) {
         assertDevicesMatch(
             deviceListToExpectedDevicesMap(initialInactiveDevices),
             devices);
       }));
     }));
   },
 
-  function deprecatedSetActiveDevicesTest() {

[Devlin, 2017/02/22 14:13:14]

These were all just cut-and-pasted, right?

[tbarzic, 2017/02/22 19:35:19]

yes, to audio/deprecated_api/test.js

-    //Test output devices. Maps device ID -> tested device properties.
-    var kTestDevices = {
-      '30001': {
-        id: '30001',
-        isActive: false
-      },
-      '30002': {
-        id: '30002',
-        isActive: false
-      },
-      '30003': {
-        id: '30003',
-        isActive: true
-      },
-      '40001': {
-        id: '40001',
-        isActive: false
-      },
-      '40002': {
-        id: '40002',
-        isActive: true
-      },
-      '40003': {
-        id: '40003',
-        isActive: false
-      }
-    };
-
-    chrome.audio.setActiveDevices([
-      '30003',
-      '40002'
-    ], chrome.test.callbackPass(function() {
-      chrome.audio.getDevices(chrome.test.callbackPass(function(devices) {
-        assertDevicesMatch(kTestDevices, devices);
-      }));
-    }));
-  },
-
-  function deprecatedSetPropertiesTest() {
-    chrome.audio.getDevices(chrome.test.callbackPass(function(initial) {
-      var expectedDevices = deviceListToExpectedDevicesMap(initial);
-
-      // Update expected input devices with values that should be changed in
-      // test.
-      var updatedInput = expectedDevices['40002'];
-      chrome.test.assertFalse(updatedInput.isMuted);
-      chrome.test.assertFalse(updatedInput.gain === 55);
-      updatedInput.isMuted = true;
-      updatedInput.level = 55;
-
-      // Update expected output devices with values that should be changed in
-      // test.
-      var updatedOutput = expectedDevices['30001'];
-      chrome.test.assertFalse(updatedOutput.volume === 35);
-      updatedOutput.level = 35;
-
-      chrome.audio.setProperties('30001', {
-        volume: 35
-      }, chrome.test.callbackPass(function() {
-        chrome.audio.setProperties('40002', {
-          isMuted: true,
-          gain: 55
-        }, chrome.test.callbackPass(function() {
-          chrome.audio.getDevices(chrome.test.callbackPass(function(devices) {
-            assertDevicesMatch(expectedDevices, devices);
-          }));
-        }));
-      }));
-    }));
-  },
-
   function setPropertiesTest() {
     chrome.audio.getDevices(chrome.test.callbackPass(function(initial) {
       var expectedDevices = deviceListToExpectedDevicesMap(initial);
 
       // Update expected input devices with values that should be changed in
       // test.
       var updatedInput = expectedDevices['40002'];
       chrome.test.assertFalse(updatedInput.gain === 65);
       updatedInput.level = 65;
 
@@ skipping 39 matching lines @@
     getMute(function(originalValue) {
       chrome.audio.setMute(
           'OUTPUT', !originalValue, chrome.test.callbackPass(function() {
             getMute(function(value) {
               chrome.test.assertEq(!originalValue, value);
             });
           }));
     });
   },
 
-  function setPropertiesInvalidValuesTest() {
-    chrome.audio.getDevices(chrome.test.callbackPass(function(initial) {
-      var expectedDevices = deviceListToExpectedDevicesMap(initial);
-      var expectedError = 'Could not set volume/gain properties';
-
-      chrome.audio.setProperties('30001', {
-        isMuted: true,
-        // Output device - should have volume set.
-        gain: 55
-      }, chrome.test.callbackFail(expectedError, function() {
-        chrome.audio.setProperties('40002', {
-          isMuted: true,
-          // Input device - should have gain set.
-          volume:55
-        }, chrome.test.callbackFail(expectedError, function() {
-          // Assert that device properties haven't changed.
-          chrome.audio.getDevices(chrome.test.callbackPass(function(devices) {
-            assertDevicesMatch(expectedDevices, devices);
-          }));
-        }));
-      }));
-    }));
-  },
-
   function setActiveDevicesTest() {
     chrome.audio.setActiveDevices({
       input: ['40002', '40003'],
       output: ['30001']
     }, chrome.test.callbackPass(function() {
       chrome.audio.getDevices({
         isActive: true
       }, chrome.test.callbackPass(function(activeDevices) {
         chrome.test.assertEq(['30001', '40002', '40003'],
                              getDeviceIds(activeDevices));
@@ skipping 73 matching lines @@
         output: []
       }, chrome.test.callbackPass(function() {
         chrome.audio.getDevices({
           isActive: true
         }, chrome.test.callbackPass(function(devices) {
           chrome.test.assertEq([], devices);
         }));
       }));
     }));
   },
+
+  function verifyNoDeviceChangedEvents() {
+    chrome.test.assertTrue(!!deviceChangedListener);
+    chrome.test.assertEq(0, deviceChangedListener.eventCount);
+    deviceChangedListener.reset();
+    deviceChangedListener = null;
+    chrome.test.succeed();
+  },
+
+  // Tests verifying the app doesn't have access to deprecated part of the API:
+  function deprecated_GetInfoTest() {
+    chrome.audio.getInfo(chrome.test.callbackFail("Not allowed."));
+  },
+
+  function deprecated_setProperties_isMuted() {
+    chrome.audio.getDevices(chrome.test.callbackPass(function(initial) {
+      var expectedDevices = deviceListToExpectedDevicesMap(initial);
+      var expectedError =
+          '|isMuted| property not allowed - use |audio.setMute|.';
+
+      chrome.audio.setProperties('30001', {
+        isMuted: true,
+        // Output device - should have volume set.
+        level: 55
+      }, chrome.test.callbackFail(expectedError, function() {
+        // Assert that device properties haven't changed.
+        chrome.audio.getDevices(chrome.test.callbackPass(function(devices) {
+          assertDevicesMatch(expectedDevices, devices);
+        }));
+      }));
+    }));
+  },
+
+  function deprecated_setProperties_volume() {
+    chrome.audio.getDevices(chrome.test.callbackPass(function(initial) {
+      var expectedDevices = deviceListToExpectedDevicesMap(initial);
+      var expectedError = '|volume| property not allowed - use |level|.';
+
+      chrome.audio.setProperties('30001', {
+        volume: 2,
+        // Output device - should have volume set.
+        level: 55
+      }, chrome.test.callbackFail(expectedError, function() {
+        // Assert that device properties haven't changed.
+        chrome.audio.getDevices(chrome.test.callbackPass(function(devices) {
+          assertDevicesMatch(expectedDevices, devices);
+        }));
+      }));
+    }));
+  },
+
+  function deprecated_setProperties_gain() {
+    chrome.audio.getDevices(chrome.test.callbackPass(function(initial) {
+      var expectedDevices = deviceListToExpectedDevicesMap(initial);
+      var expectedError = '|gain| property not allowed - use |level|.';
+
+      chrome.audio.setProperties('40001', {
+        gain: 2,
+        // Output device - should have volume set.
+        level: 55
+      }, chrome.test.callbackFail(expectedError, function() {
+        // Assert that device properties haven't changed.
+        chrome.audio.getDevices(chrome.test.callbackPass(function(devices) {
+          assertDevicesMatch(expectedDevices, devices);
+        }));
+      }));
+    }));
+  },
+
+  function deprecated_SetActiveDevicesTest() {
+    var kExpectedError = '|ids| should have DeviceIdLists type.';
+    chrome.audio.setActiveDevices([
+      '30003',
+      '40002'
+    ], chrome.test.callbackFail(kExpectedError));
+  },
 ]);