Implement bump-scroll browser-test.

remoting/webapp/browser_test/bump_scroll_browser_test.js

+// Copyright 2014 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.
+
+/**
+ * @fileoverview
+ * @suppress {checkTypes}
+ * Browser test for the scenario below:
+ * 1. Enter full-screen mode
+ * 2. Move the mouse to each edge; verify that the desktop bump-scrolls.
+ */
+
+'use strict';
+
+/** @constructor */
+browserTest.FakeClientSession = function() {
+  this.pluginPosition = {
+    top: 0,
+    left: 0
+  };
+  this.defineEvents(Object.keys(remoting.ClientSession.Events));
+};
+
+base.extend(browserTest.FakeClientSession, base.EventSource);
+
+browserTest.FakeClientSession.prototype.getPluginPositionForTesting =
+    function() {
+  return this.pluginPosition;
+};
+
+
+/** @constructor */
+browserTest.Bump_Scroll = function() {};
+
+browserTest.Bump_Scroll.prototype.run = function(data) {
+  browserTest.expect(typeof data.pin == 'string');
+
+  if (!remoting.isAppsV2) {
+    browserTest.fail(
+        'Bump-scroll requires full-screen, which can only be activated ' +
+        'programmatically in apps v2.')
+  }
+
+  this.testVerifyScroll().then(function() {
+    return browserTest.connectMe2Me();
+  }).then(function() {
+    return browserTest.enterPIN(data.pin);
+  }).then(
+      this.noScrollWindowed.bind(this)

[kelvinp, 2014/08/04 16:31:47]

Nit: Indent

[Jamie, 2014/08/05 19:54:18]

Done.

+  ).then(
+    this.activateFullscreen.bind(this)
+  ).then(
+    this.noScrollSmaller.bind(this)
+    // The order of these operations is important. Because the plugin starts
+    // scrolled to the top-left, it needs to be scrolled right and down first.
+  ).then(
+    this.scrollDirection.bind(this, 1.0, 0.5)  // Right edge
+  ).then(
+    this.scrollDirection.bind(this, 0.5, 1.0)  // Bottom edge
+  ).then(
+    this.scrollDirection.bind(this, 0.0, 0.5)  // Left edge
+  ).then(
+    this.scrollDirection.bind(this, 0.5, 0.0)  // Top edge
+  ).then(
+    function(value) {
+      browserTest.disconnect();
+      return browserTest.pass(value);
+    },
+    function(error) {
+      browserTest.disconnect();
+      return browserTest.fail(error);
+    }
+  );
+};
+
+browserTest.Bump_Scroll.prototype.noScrollWindowed = function() {
+  remoting.clientSession.pluginWidthForBumpScrollTesting =
+      window.innerWidth + 10;

[kelvinp, 2014/08/04 16:31:47]

Where does 10px come from?  Does it represent the width of some on screen
elements?

[Jamie, 2014/08/05 19:54:18]

It's arbitrary, but positive. The idea is to fake the situation where the host
desktop is larger than the client window. I've moved it into a constant with a
comment.

+  remoting.clientSession.pluginHeightForBumpScrollTesting =
+      window.innerHeight + 10;
+  this.moveMouseTo(0, 0);
+  return base.Promise.negate(this.verifyScroll(undefined, undefined));
+};
+
+browserTest.Bump_Scroll.prototype.noScrollSmaller = function() {
+  remoting.clientSession.pluginWidthForBumpScrollTesting =
+      window.innerWidth - 10;
+  remoting.clientSession.pluginHeightForBumpScrollTesting =
+      window.innerHeight - 10;
+  this.moveMouseTo(0, 0);
+  return base.Promise.negate(this.verifyScroll(undefined, undefined));
+};
+
+browserTest.Bump_Scroll.prototype.scrollDirection =
+    function(widthFraction, heightFraction) {
+  remoting.clientSession.pluginWidthForBumpScrollTesting = screen.width + 10;
+  remoting.clientSession.pluginHeightForBumpScrollTesting = screen.height + 10;
+  var expectedTop = heightFraction == 0.0 ? 0 :

[kelvinp, 2014/08/04 16:31:47]

I am a bit confused about how this work.  Say if widthFraction is 1.0 and
heightFraction is 0.5.
expectedTop would be -10 and expectedLeft would be undefined.

Would the test fails as the expectedLeft should not be undefined?

[Jamie, 2014/08/05 19:54:18]

undefined means "I don't care what value this has", although now I think of it,
it's always used to mean "this value should not change", which is a stricter
guarantee. I've changed it to be interpreted that way.

+                    heightFraction == 1.0 ? -10 : undefined;
+  var expectedLeft = widthFraction == 0.0 ? 0 :
+                     widthFraction == 1.0 ? -10 : undefined;
+  var result = this.verifyScroll(expectedTop, expectedLeft);
+  this.moveMouseTo(widthFraction * screen.width,
+                   heightFraction * screen.height);
+  return result;
+};
+
+browserTest.Bump_Scroll.prototype.activateFullscreen = function() {
+  return new Promise(function(fulfill, reject) {
+    remoting.fullscreen.activate(true, function() {
+      // The onFullscreen callback is invoked before the window has
+      // resized, so defer fulfilling the promise so that innerWidth
+      // and innerHeight are correct.
+      base.Promise.sleep(1000).then(fulfill);
+    });
+    base.Promise.sleep(5000).then(function(){
+      reject('Timed out waiting for full-screen');
+    });
+  });
+};
+
+browserTest.Bump_Scroll.prototype.moveMouseTo = function(x, y) {
+  var e = {
+    bubbles: true,
+    cancelable: false,
+    view: window,
+    detail: 0,
+    screenX: x,
+    screenY: y,
+    clientX: x,
+    clientY: y,
+    ctrlKey: false,
+    altKey: false,
+    shiftKey: false,
+    metaKey: false,
+    button: 0,
+    relatedTarget: undefined
+  };
+  var event = document.createEvent('MouseEvents');
+  event.initMouseEvent('mousemove',
+                       e.bubbles, e.cancelable, e.view, e.detail,
+                       e.screenX, e.screenY, e.clientX, e.clientY,
+                       e.ctrlKey, e.altKey, e.shiftKey, e.metaKey,
+                       e.button, document.documentElement);
+  document.documentElement.dispatchEvent(event);
+};
+
+// verifyScroll is complicated enough to warrant a test
+browserTest.Bump_Scroll.prototype.testVerifyScroll = function() {
+  var STARTED = remoting.ClientSession.Events.bumpScrollStarted;
+  var STOPPED = remoting.ClientSession.Events.bumpScrollStopped;
+  var fakeSession = new browserTest.FakeClientSession;
+  var that = this;
+
+  // No events raised (e.g. windowed mode).
+  var result = base.Promise.negate(
+      this.verifyScroll(undefined, undefined, fakeSession)
+
+  ).then(function() {
+    // Start and end events raised, but no scrolling (e.g. full-screen mode
+    // with host desktop <= window size).
+    fakeSession = new browserTest.FakeClientSession;
+    var result = base.Promise.negate(
+        that.verifyScroll(undefined, undefined, fakeSession));
+    fakeSession.raiseEvent(STARTED, {});
+    fakeSession.raiseEvent(STOPPED, {});
+    return result;
+
+  }).then(function() {
+    // Start and end events raised, with any scrolling.
+    fakeSession = new browserTest.FakeClientSession;
+    var result = that.verifyScroll(undefined, undefined, fakeSession);
+    fakeSession.raiseEvent(STARTED, {});
+    fakeSession.pluginPosition.top = 1;
+    fakeSession.pluginPosition.left = 1;
+    fakeSession.raiseEvent(STOPPED, {});
+    return result;
+
+  }).then(function() {
+    // Start and end events raised, with incorrect scrolling.
+    fakeSession = new browserTest.FakeClientSession;
+    var result = base.Promise.negate(
+        that.verifyScroll(2, 2, fakeSession));
+    fakeSession.raiseEvent(STARTED, {});
+    fakeSession.pluginPosition.top = 1;
+    fakeSession.pluginPosition.left = 1;
+    fakeSession.raiseEvent(STOPPED, {});
+    return result;
+
+  }).then(function() {
+    // Start and end events raised, with correct scrolling.
+    fakeSession = new browserTest.FakeClientSession;
+    var result = that.verifyScroll(2, 2, fakeSession);
+    fakeSession.raiseEvent(STARTED, {});
+    fakeSession.pluginPosition.top = 2;
+    fakeSession.pluginPosition.left = 2;
+    fakeSession.raiseEvent(STOPPED, {});
+    return result;
+  });
+
+  return result;
+};
+
+browserTest.Bump_Scroll.prototype.verifyScroll =
+    function (expectedTop, expectedLeft, opt_clientSession) {
+  var clientSession = opt_clientSession || remoting.clientSession;
+  base.debug.assert(clientSession != null);
+  var STARTED = remoting.ClientSession.Events.bumpScrollStarted;
+  var STOPPED = remoting.ClientSession.Events.bumpScrollStopped;
+
+  var initialPosition = clientSession.getPluginPositionForTesting();
+  var initialTop = initialPosition.top;
+  var initialLeft = initialPosition.left;
+  var verifyPluginPosition = function(fulfill, reject) {
+    var position = clientSession.getPluginPositionForTesting();
+    if (position.top == initialTop &&
+        position.left == initialLeft) {
+      reject(Error('No scroll detected: (' +
+                   position.left + ',' + position.top + ')'));
+    } else if ((expectedTop !== undefined && position.top != expectedTop) ||
+               (expectedLeft !== undefined && position.left != expectedLeft)) {
+      reject(Error('Incorrect scroll detected: (' +

[kelvinp, 2014/08/04 16:31:47]

Practically, Error and new Error has the same effect.  However, for readability
and consistency.  Since Error is a constructor, I prefer putting the new
keyboard before it so that it is clear that it is a constructor.

[Jamie, 2014/08/05 19:54:18]

Done.

+                   position.left + ',' + position.top + ' instead of ' +
+                   expectedLeft + ',' + expectedTop + ')'));
+    } else {
+      fulfill();
+    }
+  };
+
+  var started = browserTest.expectEvent(clientSession, STARTED, 1000);
+  var stopped = browserTest.expectEvent(clientSession, STOPPED, 5000);
+  return started.then(function(){
+    return stopped;
+  }).then(function() {
+    return new Promise(verifyPluginPosition);

[kelvinp, 2014/08/04 16:31:47]

Since verifyPluginPosition doesn't have any async wait.
You can just return Promise.reject(new Error(...)) or Promise.resolve() in the
branches.  In this case, you won't need to wrap the function with the promise
constructor.

[Jamie, 2014/08/05 19:54:18]

Done.

+  });
+};