Tests for the Copresence API.

chrome/test/data/extensions/api_test/copresence/test_copresence_api.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.
+
+function stringToArrayBuffer(str) {
+  var utf8_string = unescape(encodeURIComponent(str));
+  var buffer = new ArrayBuffer(utf8_string.length);
+  var view = new Uint8Array(buffer);
+  for (var i = 0; i < utf8_string.length; ++i) {
+    view[i] = utf8_string.charCodeAt(i);
+  }
+  return buffer;
+}
+
+function arrayBufferToString(buffer) {
+  var utf8_string = String.fromCharCode.apply(null, new Uint8Array(buffer));
+  return decodeURIComponent(escape(utf8_string));
+}
+
+function assertSuccess(status) {
+  chrome.test.assertEq('success', status);
+  chrome.test.assertNoLastError();
+}
+
+chrome.copresence.onMessagesReceived.addListener(
+    function(subscriptionId, messages) {
+      chrome.test.assertEq('response', subscriptionId);
+      chrome.test.assertEq(2, messages.length);
+      chrome.test.assertEq('joke', messages[0].type);
+      chrome.test.assertEq('Who\'s there?',
+          arrayBufferToString(messages[0].payload));
+      chrome.test.succeed();
+    });
+
+var PUBLISH_OPERATION = {
+  id: 'call',
+  message: {
+    type: 'joke',
+    payload: stringToArrayBuffer('Knock Knock!')
+  },
+  timeToLiveMillis: 1000,
+  policy: {},
+  strategies: {
+    onlyBroadcast: true
+  }
+};
+
+var SUBSCRIBE_OPERATION = {
+  id: 'response',
+  filter: {
+    type: 'joke'
+  },
+  timeToLiveMillis: 1000,
+  strategies: {
+    onlyScan: true
+  }
+};
+
+chrome.test.runTests([
+  function testPubSub() {
+    chrome.copresence.execute(
+        [{ publish: PUBLISH_OPERATION }],
+        assertSuccess);

[rkc, 2014/08/07 08:56:57]

kalman@ already mentioned that you need callbackPass on all of these. I just
wanted to note that if you don't use callbackPass, your test will not wait for
that callback to actually trigger, letting your test pass without even checking
the return value.

[Charlie, 2014/08/07 22:24:15]

Yeah I didn't understand the conventions for wrapping and tracking the pending
callbacks. It turns out that the callbacks do still run and still can fail the
tests - you just get multiple calls to chrome.test.succeed(), and the test
counts get messed up :-)

+
+    chrome.copresence.execute(
+        [{ subscribe: SUBSCRIBE_OPERATION }],
+        assertSuccess);

[not at google - send to devlin, 2014/08/06 21:45:27]

2 general comments:

- it'd be good to enforce some kind of order in these tests. here you fire off 2
execute() calls and expect that the test will know when they're back before
moving onto the next test. it doesn't. on the onMessagesReceived event listener
you make some assertions, but it's never clear in what context those assertions
are being made.

- for the first, you need to wrap *all* callbacks in callbackPass. you've done
that in the other tests, but it needs to be done here as well.

- for the event, add/remove listeners using chrome.test.listenOnce.

[Charlie, 2014/08/07 22:24:15]

Done. I think.

+  },
+
+  function testUnPubSub() {
+    chrome.copresence.execute(
+        [{
+          unpublish: { unpublishId: 'call' }
+        },
+        {
+          unsubscribe: { unsubscribeId: 'response' }
+        }],
+        chrome.test.callbackPass(assertSuccess));
+  },
+
+  function testBadId() {
+    chrome.copresence.execute(
+        [{ unsubscribe: { unsubscribeId: 'invalid' } }],
+        chrome.test.callbackFail("Invalid operation in operations array."));
+  },
+
+  function testMultipleOperations() {
+    chrome.copresence.execute(
+        [{
+          publish: PUBLISH_OPERATION,
+          subscribe: SUBSCRIBE_OPERATION
+        }],
+        chrome.test.callbackFail("Invalid operation in operations array."));
+  }
+]);