import FakeWebSocket from './fake.websocket.js';
import sinon from '../vendor/sinon.js';
-function make_rfb (extra_opts) {
- if (!extra_opts) {
- extra_opts = {};
+/* UIEvent constructor polyfill for IE */
+(function () {
+ if (typeof window.UIEvent === "function") return;
+
+ function UIEvent ( event, params ) {
+ params = params || { bubbles: false, cancelable: false, view: window, detail: undefined };
+ var evt = document.createEvent( 'UIEvent' );
+ evt.initUIEvent( event, params.bubbles, params.cancelable, params.view, params.detail );
+ return evt;
}
- extra_opts.target = extra_opts.target || document.createElement('canvas');
- return new RFB(extra_opts);
-}
+ UIEvent.prototype = window.UIEvent.prototype;
+
+ window.UIEvent = UIEvent;
+})();
var push8 = function (arr, num) {
"use strict";
};
describe('Remote Frame Buffer Protocol Client', function() {
- "use strict";
+ var clock;
+ var raf;
+
before(FakeWebSocket.replace);
after(FakeWebSocket.restore);
before(function () {
- this.clock = sinon.useFakeTimers();
+ this.clock = clock = sinon.useFakeTimers();
+ // sinon doesn't support this yet
+ raf = window.requestAnimationFrame;
+ window.requestAnimationFrame = setTimeout;
// Use a single set of buffers instead of reallocating to
// speed up tests
var sock = new Websock();
after(function () {
Websock.prototype._allocate_buffers = Websock.prototype._old_allocate_buffers;
this.clock.restore();
+ window.requestAnimationFrame = raf;
});
- describe('Public API Basic Behavior', function () {
- var client;
- beforeEach(function () {
- client = make_rfb();
+ var container;
+ var rfbs;
+
+ beforeEach(function () {
+ // Create a container element for all RFB objects to attach to
+ container = document.createElement('div');
+ container.style.width = "100%";
+ container.style.height = "100%";
+ document.body.appendChild(container);
+
+ // And track all created RFB objects
+ rfbs = [];
+ });
+ afterEach(function () {
+ // Make sure every created RFB object is properly cleaned up
+ // or they might affect subsequent tests
+ rfbs.forEach(function (rfb) {
+ rfb.disconnect();
+ expect(rfb._disconnect).to.have.been.called;
});
+ rfbs = [];
- describe('#connect', function () {
- beforeEach(function () { client._updateConnectionState = sinon.spy(); });
+ document.body.removeChild(container);
+ container = null;
+ });
+ function make_rfb (url, options) {
+ url = url || 'wss://host:8675';
+ var rfb = new RFB(container, url, options);
+ clock.tick();
+ rfb._sock._websocket._open();
+ rfb._rfb_connection_state = 'connected';
+ sinon.spy(rfb, "_disconnect");
+ rfbs.push(rfb);
+ return rfb;
+ }
+
+ describe('Connecting/Disconnecting', function () {
+ describe('#RFB', function () {
it('should set the current state to "connecting"', function () {
- client.connect('host', 8675);
- expect(client._updateConnectionState).to.have.been.calledOnce;
- expect(client._updateConnectionState).to.have.been.calledWith('connecting');
+ var client = new RFB(document.createElement('div'), 'wss://host:8675');
+ client._rfb_connection_state = '';
+ this.clock.tick();
+ expect(client._rfb_connection_state).to.equal('connecting');
});
- it('should not try to connect if we are missing a host', function () {
- client._fail = sinon.spy();
- client._rfb_connection_state = '';
- client.connect(undefined, 8675);
- expect(client._fail).to.have.been.calledOnce;
- expect(client._updateConnectionState).to.not.have.been.called;
- expect(client._rfb_connection_state).to.equal('');
+ it('should actually connect to the websocket', function () {
+ var client = new RFB(document.createElement('div'), 'ws://HOST:8675/PATH');
+ sinon.spy(client._sock, 'open');
+ this.clock.tick();
+ expect(client._sock.open).to.have.been.calledOnce;
+ expect(client._sock.open).to.have.been.calledWith('ws://HOST:8675/PATH');
});
});
describe('#disconnect', function () {
- beforeEach(function () { client._updateConnectionState = sinon.spy(); });
+ var client;
+ beforeEach(function () {
+ client = make_rfb();
+ });
- it('should set the current state to "disconnecting"', function () {
+ it('should go to state "disconnecting" before "disconnected"', function () {
+ sinon.spy(client, '_updateConnectionState');
client.disconnect();
- expect(client._updateConnectionState).to.have.been.calledOnce;
- expect(client._updateConnectionState).to.have.been.calledWith('disconnecting');
+ expect(client._updateConnectionState).to.have.been.calledTwice;
+ expect(client._updateConnectionState.getCall(0).args[0])
+ .to.equal('disconnecting');
+ expect(client._updateConnectionState.getCall(1).args[0])
+ .to.equal('disconnected');
+ expect(client._rfb_connection_state).to.equal('disconnected');
});
it('should unregister error event handler', function () {
});
});
- describe('#sendPassword', function () {
- beforeEach(function () { this.clock = sinon.useFakeTimers(); });
- afterEach(function () { this.clock.restore(); });
+ describe('#sendCredentials', function () {
+ var client;
+ beforeEach(function () {
+ client = make_rfb();
+ client._rfb_connection_state = 'connecting';
+ });
- it('should set the rfb password properly"', function () {
- client.sendPassword('pass');
- expect(client._rfb_password).to.equal('pass');
+ it('should set the rfb credentials properly"', function () {
+ client.sendCredentials({ password: 'pass' });
+ expect(client._rfb_credentials).to.deep.equal({ password: 'pass' });
});
it('should call init_msg "soon"', function () {
client._init_msg = sinon.spy();
- client.sendPassword('pass');
+ client.sendCredentials({ password: 'pass' });
this.clock.tick(5);
expect(client._init_msg).to.have.been.calledOnce;
});
});
+ });
- describe('#sendCtrlAlDel', function () {
- beforeEach(function () {
- client._sock = new Websock();
- client._sock.open('ws://', 'binary');
- client._sock._websocket._open();
- sinon.spy(client._sock, 'flush');
- client._rfb_connection_state = 'connected';
- client._view_only = false;
- });
+ describe('Public API Basic Behavior', function () {
+ var client;
+ beforeEach(function () {
+ client = make_rfb();
+ });
+ describe('#sendCtrlAlDel', function () {
it('should sent ctrl[down]-alt[down]-del[down] then del[up]-alt[up]-ctrl[up]', function () {
var expected = {_sQ: new Uint8Array(48), _sQlen: 0, flush: function () {}};
RFB.messages.keyEvent(expected, 0xFFE3, 1);
});
it('should not send the keys if we are not in a normal state', function () {
- client._rfb_connection_state = "broken";
+ sinon.spy(client._sock, 'flush');
+ client._rfb_connection_state = "connecting";
client.sendCtrlAltDel();
expect(client._sock.flush).to.not.have.been.called;
});
it('should not send the keys if we are set as view_only', function () {
- client._view_only = true;
+ sinon.spy(client._sock, 'flush');
+ client._viewOnly = true;
client.sendCtrlAltDel();
expect(client._sock.flush).to.not.have.been.called;
});
});
describe('#sendKey', function () {
- beforeEach(function () {
- client._sock = new Websock();
- client._sock.open('ws://', 'binary');
- client._sock._websocket._open();
- sinon.spy(client._sock, 'flush');
- client._rfb_connection_state = 'connected';
- client._view_only = false;
- });
-
it('should send a single key with the given code and state (down = true)', function () {
var expected = {_sQ: new Uint8Array(8), _sQlen: 0, flush: function () {}};
RFB.messages.keyEvent(expected, 123, 1);
});
it('should not send the key if we are not in a normal state', function () {
- client._rfb_connection_state = "broken";
+ sinon.spy(client._sock, 'flush');
+ client._rfb_connection_state = "connecting";
client.sendKey(123, 'Key123');
expect(client._sock.flush).to.not.have.been.called;
});
it('should not send the key if we are set as view_only', function () {
- client._view_only = true;
+ sinon.spy(client._sock, 'flush');
+ client._viewOnly = true;
client.sendKey(123, 'Key123');
expect(client._sock.flush).to.not.have.been.called;
});
});
});
- describe('#clipboardPasteFrom', function () {
- beforeEach(function () {
- client._sock = new Websock();
- client._sock.open('ws://', 'binary');
- client._sock._websocket._open();
- sinon.spy(client._sock, 'flush');
- client._rfb_connection_state = 'connected';
- client._view_only = false;
+ describe('#focus', function () {
+ it('should move focus to canvas object', function () {
+ client._canvas.focus = sinon.spy();
+ client.focus();
+ expect(client._canvas.focus).to.have.been.called.once;
});
+ });
+ describe('#blur', function () {
+ it('should remove focus from canvas object', function () {
+ client._canvas.blur = sinon.spy();
+ client.blur();
+ expect(client._canvas.blur).to.have.been.called.once;
+ });
+ });
+
+ describe('#clipboardPasteFrom', function () {
it('should send the given text in a paste event', function () {
var expected = {_sQ: new Uint8Array(11), _sQlen: 0, flush: function () {}};
RFB.messages.clientCutText(expected, 'abc');
});
it('should not send the text if we are not in a normal state', function () {
- client._rfb_connection_state = "broken";
+ sinon.spy(client._sock, 'flush');
+ client._rfb_connection_state = "connecting";
client.clipboardPasteFrom('abc');
expect(client._sock.flush).to.not.have.been.called;
});
});
- describe("#requestDesktopSize", function () {
- beforeEach(function() {
- client._sock = new Websock();
- client._sock.open('ws://', 'binary');
- client._sock._websocket._open();
- sinon.spy(client._sock, 'flush');
- client._rfb_connection_state = 'connected';
- client._view_only = false;
- client._supportsSetDesktopSize = true;
- });
-
- it('should send the request with the given width and height', function () {
- var expected = [251];
- push8(expected, 0); // padding
- push16(expected, 1); // width
- push16(expected, 2); // height
- push8(expected, 1); // number-of-screens
- push8(expected, 0); // padding before screen array
- push32(expected, 0); // id
- push16(expected, 0); // x-position
- push16(expected, 0); // y-position
- push16(expected, 1); // width
- push16(expected, 2); // height
- push32(expected, 0); // flags
-
- client.requestDesktopSize(1, 2);
- expect(client._sock).to.have.sent(new Uint8Array(expected));
+ describe("XVP operations", function () {
+ beforeEach(function () {
+ client._rfb_xvp_ver = 1;
});
- it('should not send the request if the client has not recieved a ExtendedDesktopSize rectangle', function () {
- client._supportsSetDesktopSize = false;
- client.requestDesktopSize(1,2);
- expect(client._sock.flush).to.not.have.been.called;
+ it('should send the shutdown signal on #machineShutdown', function () {
+ client.machineShutdown();
+ expect(client._sock).to.have.sent(new Uint8Array([0xFA, 0x00, 0x01, 0x02]));
+ });
+
+ it('should send the reboot signal on #machineReboot', function () {
+ client.machineReboot();
+ expect(client._sock).to.have.sent(new Uint8Array([0xFA, 0x00, 0x01, 0x03]));
+ });
+
+ it('should send the reset signal on #machineReset', function () {
+ client.machineReset();
+ expect(client._sock).to.have.sent(new Uint8Array([0xFA, 0x00, 0x01, 0x04]));
});
- it('should not send the request if we are not in a normal state', function () {
- client._rfb_connection_state = "broken";
- client.requestDesktopSize(1,2);
+ it('should not send XVP operations with higher versions than we support', function () {
+ sinon.spy(client._sock, 'flush');
+ client._xvpOp(2, 7);
expect(client._sock.flush).to.not.have.been.called;
});
});
+ });
- describe("XVP operations", function () {
+ describe('Clipping', function () {
+ var client;
+ beforeEach(function () {
+ client = make_rfb();
+ container.style.width = '70px';
+ container.style.height = '80px';
+ client.clipViewport = true;
+ });
+
+ it('should update display clip state when changing the property', function () {
+ var spy = sinon.spy(client._display, "clipViewport", ["set"]);
+
+ client.clipViewport = false;
+ expect(spy.set).to.have.been.calledOnce;
+ expect(spy.set).to.have.been.calledWith(false);
+ spy.set.reset();
+
+ client.clipViewport = true;
+ expect(spy.set).to.have.been.calledOnce;
+ expect(spy.set).to.have.been.calledWith(true);
+ });
+
+ it('should update the viewport when the container size changes', function () {
+ sinon.spy(client._display, "viewportChangeSize");
+
+ container.style.width = '40px';
+ container.style.height = '50px';
+ var event = new UIEvent('resize');
+ window.dispatchEvent(event);
+ clock.tick();
+
+ expect(client._display.viewportChangeSize).to.have.been.calledOnce;
+ expect(client._display.viewportChangeSize).to.have.been.calledWith(40, 50);
+ });
+
+ it('should update the viewport when the remote session resizes', function () {
+ // Simple ExtendedDesktopSize FBU message
+ var incoming = [ 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00,
+ 0x00, 0xff, 0x00, 0xff, 0xff, 0xff, 0xfe, 0xcc,
+ 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+ 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0x00, 0xff,
+ 0x00, 0x00, 0x00, 0x00 ];
+
+ sinon.spy(client._display, "viewportChangeSize");
+
+ client._sock._websocket._receive_data(new Uint8Array(incoming));
+
+ // FIXME: Display implicitly calls viewportChangeSize() when
+ // resizing the framebuffer, hence calledTwice.
+ expect(client._display.viewportChangeSize).to.have.been.calledTwice;
+ expect(client._display.viewportChangeSize).to.have.been.calledWith(70, 80);
+ });
+
+ it('should not update the viewport if not clipping', function () {
+ client.clipViewport = false;
+ sinon.spy(client._display, "viewportChangeSize");
+
+ container.style.width = '40px';
+ container.style.height = '50px';
+ var event = new UIEvent('resize');
+ window.dispatchEvent(event);
+ clock.tick();
+
+ expect(client._display.viewportChangeSize).to.not.have.been.called;
+ });
+
+ it('should not update the viewport if scaling', function () {
+ client.scaleViewport = true;
+ sinon.spy(client._display, "viewportChangeSize");
+
+ container.style.width = '40px';
+ container.style.height = '50px';
+ var event = new UIEvent('resize');
+ window.dispatchEvent(event);
+ clock.tick();
+
+ expect(client._display.viewportChangeSize).to.not.have.been.called;
+ });
+
+ describe('Dragging', function () {
beforeEach(function () {
- client._sock = new Websock();
- client._sock.open('ws://', 'binary');
- client._sock._websocket._open();
- sinon.spy(client._sock, 'flush');
- client._rfb_connection_state = 'connected';
- client._view_only = false;
- client._rfb_xvp_ver = 1;
+ client.dragViewport = true;
+ sinon.spy(RFB.messages, "pointerEvent");
});
- it('should send the shutdown signal on #xvpShutdown', function () {
- client.xvpShutdown();
- expect(client._sock).to.have.sent(new Uint8Array([0xFA, 0x00, 0x01, 0x02]));
+ afterEach(function () {
+ RFB.messages.pointerEvent.restore();
});
- it('should send the reboot signal on #xvpReboot', function () {
- client.xvpReboot();
- expect(client._sock).to.have.sent(new Uint8Array([0xFA, 0x00, 0x01, 0x03]));
+ it('should not send button messages when initiating viewport dragging', function () {
+ client._handleMouseButton(13, 9, 0x001);
+ expect(RFB.messages.pointerEvent).to.not.have.been.called;
});
- it('should send the reset signal on #xvpReset', function () {
- client.xvpReset();
- expect(client._sock).to.have.sent(new Uint8Array([0xFA, 0x00, 0x01, 0x04]));
+ it('should send button messages when release without movement', function () {
+ // Just up and down
+ client._handleMouseButton(13, 9, 0x001);
+ client._handleMouseButton(13, 9, 0x000);
+ expect(RFB.messages.pointerEvent).to.have.been.calledTwice;
+
+ RFB.messages.pointerEvent.reset();
+
+ // Small movement
+ client._handleMouseButton(13, 9, 0x001);
+ client._handleMouseMove(15, 14);
+ client._handleMouseButton(15, 14, 0x000);
+ expect(RFB.messages.pointerEvent).to.have.been.calledTwice;
});
- it('should support sending arbitrary XVP operations via #xvpOp', function () {
- client.xvpOp(1, 7);
- expect(client._sock).to.have.sent(new Uint8Array([0xFA, 0x00, 0x01, 0x07]));
+ it('should send button message directly when drag is disabled', function () {
+ client.dragViewport = false;
+ client._handleMouseButton(13, 9, 0x001);
+ expect(RFB.messages.pointerEvent).to.have.been.calledOnce;
});
- it('should not send XVP operations with higher versions than we support', function () {
- expect(client.xvpOp(2, 7)).to.be.false;
- expect(client._sock.flush).to.not.have.been.called;
+ it('should be initiate viewport dragging on sufficient movement', function () {
+ sinon.spy(client._display, "viewportChangePos");
+
+ // Too small movement
+
+ client._handleMouseButton(13, 9, 0x001);
+ client._handleMouseMove(18, 9);
+
+ expect(RFB.messages.pointerEvent).to.not.have.been.called;
+ expect(client._display.viewportChangePos).to.not.have.been.called;
+
+ // Sufficient movement
+
+ client._handleMouseMove(43, 9);
+
+ expect(RFB.messages.pointerEvent).to.not.have.been.called;
+ expect(client._display.viewportChangePos).to.have.been.calledOnce;
+ expect(client._display.viewportChangePos).to.have.been.calledWith(-30, 0);
+
+ client._display.viewportChangePos.reset();
+
+ // Now a small movement should move right away
+
+ client._handleMouseMove(43, 14);
+
+ expect(RFB.messages.pointerEvent).to.not.have.been.called;
+ expect(client._display.viewportChangePos).to.have.been.calledOnce;
+ expect(client._display.viewportChangePos).to.have.been.calledWith(0, -5);
+ });
+
+ it('should not send button messages when dragging ends', function () {
+ // First the movement
+
+ client._handleMouseButton(13, 9, 0x001);
+ client._handleMouseMove(43, 9);
+ client._handleMouseButton(43, 9, 0x000);
+
+ expect(RFB.messages.pointerEvent).to.not.have.been.called;
});
+
+ it('should terminate viewport dragging on a button up event', function () {
+ // First the dragging movement
+
+ client._handleMouseButton(13, 9, 0x001);
+ client._handleMouseMove(43, 9);
+ client._handleMouseButton(43, 9, 0x000);
+
+ // Another movement now should not move the viewport
+
+ sinon.spy(client._display, "viewportChangePos");
+
+ client._handleMouseMove(43, 59);
+
+ expect(client._display.viewportChangePos).to.not.have.been.called;
+ });
+ });
+ });
+
+ describe('Scaling', function () {
+ var client;
+ beforeEach(function () {
+ client = make_rfb();
+ container.style.width = '70px';
+ container.style.height = '80px';
+ client.scaleViewport = true;
+ });
+
+ it('should update display scale factor when changing the property', function () {
+ var spy = sinon.spy(client._display, "scale", ["set"]);
+ sinon.spy(client._display, "autoscale");
+
+ client.scaleViewport = false;
+ expect(spy.set).to.have.been.calledOnce;
+ expect(spy.set).to.have.been.calledWith(1.0);
+ expect(client._display.autoscale).to.not.have.been.called;
+
+ client.scaleViewport = true;
+ expect(client._display.autoscale).to.have.been.calledOnce;
+ expect(client._display.autoscale).to.have.been.calledWith(70, 80);
+ });
+
+ it('should update the clipping setting when changing the property', function () {
+ client.clipViewport = true;
+
+ var spy = sinon.spy(client._display, "clipViewport", ["set"]);
+
+ client.scaleViewport = false;
+ expect(spy.set).to.have.been.calledOnce;
+ expect(spy.set).to.have.been.calledWith(true);
+
+ spy.set.reset();
+
+ client.scaleViewport = true;
+ expect(spy.set).to.have.been.calledOnce;
+ expect(spy.set).to.have.been.calledWith(false);
+ });
+
+ it('should update the scaling when the container size changes', function () {
+ sinon.spy(client._display, "autoscale");
+
+ container.style.width = '40px';
+ container.style.height = '50px';
+ var event = new UIEvent('resize');
+ window.dispatchEvent(event);
+ clock.tick();
+
+ expect(client._display.autoscale).to.have.been.calledOnce;
+ expect(client._display.autoscale).to.have.been.calledWith(40, 50);
+ });
+
+ it('should update the scaling when the remote session resizes', function () {
+ // Simple ExtendedDesktopSize FBU message
+ var incoming = [ 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00,
+ 0x00, 0xff, 0x00, 0xff, 0xff, 0xff, 0xfe, 0xcc,
+ 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+ 0x00, 0x00, 0x00, 0x00, 0x00, 0xff, 0x00, 0xff,
+ 0x00, 0x00, 0x00, 0x00 ];
+
+ sinon.spy(client._display, "autoscale");
+
+ client._sock._websocket._receive_data(new Uint8Array(incoming));
+
+ expect(client._display.autoscale).to.have.been.calledOnce;
+ expect(client._display.autoscale).to.have.been.calledWith(70, 80);
+ });
+
+ it('should not update the display scale factor if not scaling', function () {
+ client.scaleViewport = false;
+
+ sinon.spy(client._display, "autoscale");
+
+ container.style.width = '40px';
+ container.style.height = '50px';
+ var event = new UIEvent('resize');
+ window.dispatchEvent(event);
+ clock.tick();
+
+ expect(client._display.autoscale).to.not.have.been.called;
+ });
+ });
+
+ describe('Remote resize', function () {
+ var client;
+ beforeEach(function () {
+ client = make_rfb();
+ client._supportsSetDesktopSize = true;
+ client.resizeSession = true;
+ container.style.width = '70px';
+ container.style.height = '80px';
+ sinon.spy(RFB.messages, "setDesktopSize");
+ });
+
+ afterEach(function () {
+ RFB.messages.setDesktopSize.restore();
+ });
+
+ it('should only request a resize when turned on', function () {
+ client.resizeSession = false;
+ expect(RFB.messages.setDesktopSize).to.not.have.been.called;
+ client.resizeSession = true;
+ expect(RFB.messages.setDesktopSize).to.have.been.calledOnce;
+ });
+
+ it('should request a resize when initially connecting', function () {
+ // Simple ExtendedDesktopSize FBU message
+ var incoming = [ 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00,
+ 0x00, 0x04, 0x00, 0x04, 0xff, 0xff, 0xfe, 0xcc,
+ 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+ 0x00, 0x00, 0x00, 0x00, 0x00, 0x04, 0x00, 0x04,
+ 0x00, 0x00, 0x00, 0x00 ];
+
+ // First message should trigger a resize
+
+ client._supportsSetDesktopSize = false;
+
+ client._sock._websocket._receive_data(new Uint8Array(incoming));
+
+ expect(RFB.messages.setDesktopSize).to.have.been.calledOnce;
+ expect(RFB.messages.setDesktopSize).to.have.been.calledWith(sinon.match.object, 70, 80, 0, 0);
+
+ RFB.messages.setDesktopSize.reset();
+
+ // Second message should not trigger a resize
+
+ client._sock._websocket._receive_data(new Uint8Array(incoming));
+
+ expect(RFB.messages.setDesktopSize).to.not.have.been.called;
+ });
+
+ it('should request a resize when the container resizes', function () {
+ container.style.width = '40px';
+ container.style.height = '50px';
+ var event = new UIEvent('resize');
+ window.dispatchEvent(event);
+ clock.tick(1000);
+
+ expect(RFB.messages.setDesktopSize).to.have.been.calledOnce;
+ expect(RFB.messages.setDesktopSize).to.have.been.calledWith(sinon.match.object, 40, 50, 0, 0);
+ });
+
+ it('should not resize until the container size is stable', function () {
+ container.style.width = '20px';
+ container.style.height = '30px';
+ var event = new UIEvent('resize');
+ window.dispatchEvent(event);
+ clock.tick(400);
+
+ expect(RFB.messages.setDesktopSize).to.not.have.been.called;
+
+ container.style.width = '40px';
+ container.style.height = '50px';
+ var event = new UIEvent('resize');
+ window.dispatchEvent(event);
+ clock.tick(400);
+
+ expect(RFB.messages.setDesktopSize).to.not.have.been.called;
+
+ clock.tick(200);
+
+ expect(RFB.messages.setDesktopSize).to.have.been.calledOnce;
+ expect(RFB.messages.setDesktopSize).to.have.been.calledWith(sinon.match.object, 40, 50, 0, 0);
+ });
+
+ it('should not resize when resize is disabled', function () {
+ client._resizeSession = false;
+
+ container.style.width = '40px';
+ container.style.height = '50px';
+ var event = new UIEvent('resize');
+ window.dispatchEvent(event);
+ clock.tick(1000);
+
+ expect(RFB.messages.setDesktopSize).to.not.have.been.called;
+ });
+
+ it('should not resize when resize is not supported', function () {
+ client._supportsSetDesktopSize = false;
+
+ container.style.width = '40px';
+ container.style.height = '50px';
+ var event = new UIEvent('resize');
+ window.dispatchEvent(event);
+ clock.tick(1000);
+
+ expect(RFB.messages.setDesktopSize).to.not.have.been.called;
+ });
+
+ it('should not resize when in view only mode', function () {
+ client._viewOnly = true;
+
+ container.style.width = '40px';
+ container.style.height = '50px';
+ var event = new UIEvent('resize');
+ window.dispatchEvent(event);
+ clock.tick(1000);
+
+ expect(RFB.messages.setDesktopSize).to.not.have.been.called;
+ });
+
+ it('should not try to override a server resize', function () {
+ // Simple ExtendedDesktopSize FBU message
+ var incoming = [ 0x00, 0x00, 0x00, 0x01, 0x00, 0x00, 0x00, 0x00,
+ 0x00, 0x04, 0x00, 0x04, 0xff, 0xff, 0xfe, 0xcc,
+ 0x01, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00, 0x00,
+ 0x00, 0x00, 0x00, 0x00, 0x00, 0x04, 0x00, 0x04,
+ 0x00, 0x00, 0x00, 0x00 ];
+
+ client._sock._websocket._receive_data(new Uint8Array(incoming));
+
+ expect(RFB.messages.setDesktopSize).to.not.have.been.called;
});
});
describe('#_updateConnectionState', function () {
var client;
beforeEach(function () {
- this.clock = sinon.useFakeTimers();
client = make_rfb();
});
- afterEach(function () {
- this.clock.restore();
- });
-
it('should clear the disconnect timer if the state is not "disconnecting"', function () {
var spy = sinon.spy();
client._disconnTimer = setTimeout(spy, 50);
- client._updateConnectionState('connecting');
+ client._rfb_connection_state = 'connecting';
+ client._updateConnectionState('connected');
this.clock.tick(51);
expect(spy).to.not.have.been.called;
expect(client._disconnTimer).to.be.null;
});
- it('should call the updateState callback', function () {
- client.set_onUpdateState(sinon.spy());
- client._updateConnectionState('connecting');
- var spy = client.get_onUpdateState();
- expect(spy).to.have.been.calledOnce;
- expect(spy.args[0][1]).to.equal('connecting');
- });
-
it('should set the rfb_connection_state', function () {
- client._rfb_connection_state = 'disconnecting';
- client._updateConnectionState('disconnected');
- expect(client._rfb_connection_state).to.equal('disconnected');
+ client._rfb_connection_state = 'connecting';
+ client._updateConnectionState('connected');
+ expect(client._rfb_connection_state).to.equal('connected');
});
it('should not change the state when we are disconnected', function () {
- client._rfb_connection_state = 'disconnected';
+ client.disconnect();
+ expect(client._rfb_connection_state).to.equal('disconnected');
client._updateConnectionState('connecting');
expect(client._rfb_connection_state).to.not.equal('connecting');
});
it('should ignore state changes to the same state', function () {
- client.set_onUpdateState(sinon.spy());
- client._rfb_connection_state = 'connecting';
- client._updateConnectionState('connecting');
- var spy = client.get_onUpdateState();
- expect(spy).to.not.have.been.called;
+ var connectSpy = sinon.spy();
+ client.addEventListener("connect", connectSpy);
+
+ expect(client._rfb_connection_state).to.equal('connected');
+ client._updateConnectionState('connected');
+ expect(connectSpy).to.not.have.been.called;
+
+ client.disconnect();
+
+ var disconnectSpy = sinon.spy();
+ client.addEventListener("disconnect", disconnectSpy);
+
+ expect(client._rfb_connection_state).to.equal('disconnected');
+ client._updateConnectionState('disconnected');
+ expect(disconnectSpy).to.not.have.been.called;
});
it('should ignore illegal state changes', function () {
- client.set_onUpdateState(sinon.spy());
- client._rfb_connection_state = 'connected';
+ var spy = sinon.spy();
+ client.addEventListener("disconnect", spy);
client._updateConnectionState('disconnected');
expect(client._rfb_connection_state).to.not.equal('disconnected');
- var spy = client.get_onUpdateState();
expect(spy).to.not.have.been.called;
});
});
describe('#_fail', function () {
var client;
beforeEach(function () {
- this.clock = sinon.useFakeTimers();
client = make_rfb();
- client.connect('host', 8675);
- });
-
- afterEach(function () {
- this.clock.restore();
});
it('should close the WebSocket connection', function () {
expect(client._rfb_connection_state).to.equal('disconnected');
});
- it('should set disconnect_reason', function () {
- client._rfb_connection_state = 'connected';
- client._fail('a reason');
- expect(client._rfb_disconnect_reason).to.equal('a reason');
- });
-
- it('should not include details in disconnect_reason', function () {
+ it('should set clean_disconnect variable', function () {
+ client._rfb_clean_disconnect = true;
client._rfb_connection_state = 'connected';
- client._fail('a reason', 'details');
- expect(client._rfb_disconnect_reason).to.equal('a reason');
+ client._fail();
+ expect(client._rfb_clean_disconnect).to.be.false;
});
- it('should result in disconnect callback with message when reason given', function () {
+ it('should result in disconnect event with clean set to false', function () {
client._rfb_connection_state = 'connected';
- client.set_onDisconnected(sinon.spy());
- client._fail('a reason');
- var spy = client.get_onDisconnected();
+ var spy = sinon.spy();
+ client.addEventListener("disconnect", spy);
+ client._fail();
this.clock.tick(2000);
expect(spy).to.have.been.calledOnce;
- expect(spy.args[0].length).to.equal(2);
- expect(spy.args[0][1]).to.equal('a reason');
- });
-
- });
-
- describe('#_notification', function () {
- var client;
- beforeEach(function () { client = make_rfb(); });
-
- it('should call the notification callback', function () {
- client.set_onNotification(sinon.spy());
- client._notification('notify!', 'warn');
- var spy = client.get_onNotification();
- expect(spy).to.have.been.calledOnce;
- expect(spy.args[0][1]).to.equal('notify!');
- expect(spy.args[0][2]).to.equal('warn');
+ expect(spy.args[0][0].detail.clean).to.be.false;
});
- it('should not call the notification callback when level is invalid', function () {
- client.set_onNotification(sinon.spy());
- client._notification('notify!', 'invalid');
- var spy = client.get_onNotification();
- expect(spy).to.not.have.been.called;
- });
- });
- });
-
- describe('Connection States', function () {
- describe('connecting', function () {
- var client;
- beforeEach(function () { client = make_rfb(); });
-
- it('should reset the variable states', function () {
- sinon.spy(client, '_init_vars');
- client._updateConnectionState('connecting');
- expect(client._init_vars).to.have.been.calledOnce;
- });
+ });
+ });
- it('should actually connect to the websocket', function () {
+ describe('Connection States', function () {
+ describe('connecting', function () {
+ it('should open the websocket connection', function () {
+ var client = new RFB(document.createElement('div'),
+ 'ws://HOST:8675/PATH');
sinon.spy(client._sock, 'open');
- client._updateConnectionState('connecting');
+ this.clock.tick();
expect(client._sock.open).to.have.been.calledOnce;
});
+ });
- it('should use wss:// to connect if encryption is enabled', function () {
- sinon.spy(client._sock, 'open');
- client.set_encrypt(true);
- client._updateConnectionState('connecting');
- expect(client._sock.open.args[0][0]).to.contain('wss://');
+ describe('connected', function () {
+ var client;
+ beforeEach(function () {
+ client = make_rfb();
});
- it('should use ws:// to connect if encryption is not enabled', function () {
- sinon.spy(client._sock, 'open');
- client.set_encrypt(true);
- client._updateConnectionState('connecting');
- expect(client._sock.open.args[0][0]).to.contain('wss://');
+ it('should result in a connect event if state becomes connected', function () {
+ var spy = sinon.spy();
+ client.addEventListener("connect", spy);
+ client._rfb_connection_state = 'connecting';
+ client._updateConnectionState('connected');
+ expect(spy).to.have.been.calledOnce;
});
- it('should use a uri with the host, port, and path specified to connect', function () {
- sinon.spy(client._sock, 'open');
- client.set_encrypt(false);
- client._rfb_host = 'HOST';
- client._rfb_port = 8675;
- client._rfb_path = 'PATH';
+ it('should not result in a connect event if the state is not "connected"', function () {
+ var spy = sinon.spy();
+ client.addEventListener("connect", spy);
+ client._sock._websocket.open = function () {}; // explicitly don't call onopen
client._updateConnectionState('connecting');
- expect(client._sock.open).to.have.been.calledWith('ws://HOST:8675/PATH');
- });
-
- it('should not include a port in the uri if not specified in connect', function () {
- sinon.spy(client._sock, 'open');
- client.set_encrypt(true);
- client.connect('HOST', undefined)
- expect(client._sock.open).to.have.been.calledWith('wss://HOST/');
+ expect(spy).to.not.have.been.called;
});
});
describe('disconnecting', function () {
var client;
beforeEach(function () {
- this.clock = sinon.useFakeTimers();
client = make_rfb();
- client.connect('host', 8675);
- });
-
- afterEach(function () {
- this.clock.restore();
});
it('should force disconnect if we do not call Websock.onclose within the disconnection timeout', function () {
sinon.spy(client, '_updateConnectionState');
client._sock._websocket.close = function () {}; // explicitly don't call onclose
client._updateConnectionState('disconnecting');
- this.clock.tick(client.get_disconnectTimeout() * 1000);
+ this.clock.tick(3 * 1000);
expect(client._updateConnectionState).to.have.been.calledTwice;
expect(client._rfb_disconnect_reason).to.not.equal("");
expect(client._rfb_connection_state).to.equal("disconnected");
it('should not fail if Websock.onclose gets called within the disconnection timeout', function () {
client._updateConnectionState('disconnecting');
- this.clock.tick(client.get_disconnectTimeout() * 500);
+ this.clock.tick(3 * 1000 / 2);
client._sock._websocket.close();
- this.clock.tick(client.get_disconnectTimeout() * 500 + 1);
+ this.clock.tick(3 * 1000 / 2 + 1);
expect(client._rfb_connection_state).to.equal('disconnected');
});
client._updateConnectionState('disconnecting');
expect(client._sock.close).to.have.been.calledOnce;
});
+
+ it('should not result in a disconnect event', function () {
+ var spy = sinon.spy();
+ client.addEventListener("disconnect", spy);
+ client._sock._websocket.close = function () {}; // explicitly don't call onclose
+ client._updateConnectionState('disconnecting');
+ expect(spy).to.not.have.been.called;
+ });
});
describe('disconnected', function () {
var client;
- beforeEach(function () { client = make_rfb(); });
+ beforeEach(function () {
+ client = new RFB(document.createElement('div'), 'ws://HOST:8675/PATH');
+ });
- it('should call the disconnect callback if the state is "disconnected"', function () {
- client.set_onDisconnected(sinon.spy());
+ it('should result in a disconnect event if state becomes "disconnected"', function () {
+ var spy = sinon.spy();
+ client.addEventListener("disconnect", spy);
client._rfb_connection_state = 'disconnecting';
- client._rfb_disconnect_reason = "error";
client._updateConnectionState('disconnected');
- var spy = client.get_onDisconnected();
expect(spy).to.have.been.calledOnce;
- expect(spy.args[0][1]).to.equal("error");
- });
-
- it('should not call the disconnect callback if the state is not "disconnected"', function () {
- client.set_onDisconnected(sinon.spy());
- client._updateConnectionState('disconnecting');
- var spy = client.get_onDisconnected();
- expect(spy).to.not.have.been.called;
+ expect(spy.args[0][0].detail.clean).to.be.true;
});
- it('should call the disconnect callback without msg when no reason given', function () {
- client.set_onDisconnected(sinon.spy());
+ it('should result in a disconnect event without msg when no reason given', function () {
+ var spy = sinon.spy();
+ client.addEventListener("disconnect", spy);
client._rfb_connection_state = 'disconnecting';
client._rfb_disconnect_reason = "";
client._updateConnectionState('disconnected');
- var spy = client.get_onDisconnected();
expect(spy).to.have.been.calledOnce;
expect(spy.args[0].length).to.equal(1);
});
-
- it('should call the updateState callback before the disconnect callback', function () {
- client.set_onDisconnected(sinon.spy());
- client.set_onUpdateState(sinon.spy());
- client._rfb_connection_state = 'disconnecting';
- client._updateConnectionState('disconnected');
- var updateStateSpy = client.get_onUpdateState();
- var disconnectSpy = client.get_onDisconnected();
- expect(updateStateSpy.calledBefore(disconnectSpy)).to.be.true;
- });
});
-
- // NB(directxman12): Connected does *nothing* in updateConnectionState
});
describe('Protocol Initialization States', function () {
- describe('ProtocolVersion', function () {
- beforeEach(function () {
- this.clock = sinon.useFakeTimers();
- });
-
- afterEach(function () {
- this.clock.restore();
- });
+ var client;
+ beforeEach(function () {
+ client = make_rfb();
+ client._rfb_connection_state = 'connecting';
+ });
+ describe('ProtocolVersion', function () {
function send_ver (ver, client) {
var arr = new Uint8Array(12);
for (var i = 0; i < ver.length; i++) {
}
describe('version parsing', function () {
- var client;
- beforeEach(function () {
- client = make_rfb();
- client.connect('host', 8675);
- client._sock._websocket._open();
- });
-
- it('should interpret version 000.000 as a repeater', function () {
- client._repeaterID = '\x01\x02\x03\x04\x05';
- send_ver('000.000', client);
- expect(client._rfb_version).to.equal(0);
-
- var sent_data = client._sock._websocket._get_sent_data();
- expect(new Uint8Array(sent_data.buffer, 0, 5)).to.array.equal(new Uint8Array([1, 2, 3, 4, 5]));
- });
-
it('should interpret version 003.003 as version 3.3', function () {
send_ver('003.003', client);
expect(client._rfb_version).to.equal(3.3);
});
});
- var client;
- beforeEach(function () {
- client = make_rfb();
- client.connect('host', 8675);
- client._sock._websocket._open();
- });
-
- it('should handle two step repeater negotiation', function () {
- client._repeaterID = '\x01\x02\x03\x04\x05';
-
- send_ver('000.000', client);
- expect(client._rfb_version).to.equal(0);
- var sent_data = client._sock._websocket._get_sent_data();
- expect(new Uint8Array(sent_data.buffer, 0, 5)).to.array.equal(new Uint8Array([1, 2, 3, 4, 5]));
- expect(sent_data).to.have.length(250);
-
- send_ver('003.008', client);
- expect(client._rfb_version).to.equal(3.8);
- });
-
it('should send back the interpreted version', function () {
send_ver('004.000', client);
send_ver('003.008', client);
expect(client._rfb_init_state).to.equal('Security');
});
+
+ describe('Repeater', function () {
+ beforeEach(function () {
+ client = make_rfb('wss://host:8675', { repeaterID: "12345" });
+ client._rfb_connection_state = 'connecting';
+ });
+
+ it('should interpret version 000.000 as a repeater', function () {
+ send_ver('000.000', client);
+ expect(client._rfb_version).to.equal(0);
+
+ var sent_data = client._sock._websocket._get_sent_data();
+ expect(new Uint8Array(sent_data.buffer, 0, 9)).to.array.equal(new Uint8Array([73, 68, 58, 49, 50, 51, 52, 53, 0]));
+ expect(sent_data).to.have.length(250);
+ });
+
+ it('should handle two step repeater negotiation', function () {
+ send_ver('000.000', client);
+ send_ver('003.008', client);
+ expect(client._rfb_version).to.equal(3.8);
+ });
+ });
});
describe('Security', function () {
- var client;
-
beforeEach(function () {
- client = make_rfb();
- client.connect('host', 8675);
- client._sock._websocket._open();
client._rfb_init_state = 'Security';
});
expect(client._fail).to.have.been.calledOnce;
expect(client._fail).to.have.been.calledWith(
- 'Error while negotiating with server','Security failure: whoops');
+ 'Security negotiation failed on no security types (reason: whoops)');
});
it('should transition to the Authentication state and continue on successful negotiation', function () {
});
describe('Authentication', function () {
- var client;
-
beforeEach(function () {
- client = make_rfb();
- client.connect('host', 8675);
- client._sock._websocket._open();
client._rfb_init_state = 'Security';
});
sinon.spy(client, '_fail');
client._sock._websocket._receive_data(new Uint8Array(data));
expect(client._fail).to.have.been.calledWith(
- 'Authentication failure', 'Whoopsies');
+ 'Security negotiation failed on authentication scheme (reason: Whoopsies)');
});
it('should transition straight to SecurityResult on "no auth" (1) for versions >= 3.8', function () {
});
describe('VNC Authentication (type 2) Handler', function () {
- var client;
-
beforeEach(function () {
- client = make_rfb();
- client.connect('host', 8675);
- client._sock._websocket._open();
client._rfb_init_state = 'Security';
client._rfb_version = 3.8;
});
- it('should call the passwordRequired callback if missing a password', function () {
- client.set_onPasswordRequired(sinon.spy());
+ it('should fire the credentialsrequired event if missing a password', function () {
+ var spy = sinon.spy();
+ client.addEventListener("credentialsrequired", spy);
send_security(2, client);
var challenge = [];
for (var i = 0; i < 16; i++) { challenge[i] = i; }
client._sock._websocket._receive_data(new Uint8Array(challenge));
- var spy = client.get_onPasswordRequired();
- expect(client._rfb_password.length).to.equal(0);
+ expect(client._rfb_credentials).to.be.empty;
expect(spy).to.have.been.calledOnce;
+ expect(spy.args[0][0].detail.types).to.have.members(["password"]);
});
it('should encrypt the password with DES and then send it back', function () {
- client._rfb_password = 'passwd';
+ client._rfb_credentials = { password: 'passwd' };
send_security(2, client);
client._sock._websocket._get_sent_data(); // skip the choice of auth reply
});
it('should transition to SecurityResult immediately after sending the password', function () {
- client._rfb_password = 'passwd';
+ client._rfb_credentials = { password: 'passwd' };
send_security(2, client);
var challenge = [];
});
describe('XVP Authentication (type 22) Handler', function () {
- var client;
-
beforeEach(function () {
- client = make_rfb();
- client.connect('host', 8675);
- client._sock._websocket._open();
client._rfb_init_state = 'Security';
client._rfb_version = 3.8;
});
it('should fall through to standard VNC authentication upon completion', function () {
- client.set_xvp_password_sep('#');
- client._rfb_password = 'user#target#password';
+ client._rfb_credentials = { username: 'user',
+ target: 'target',
+ password: 'password' };
client._negotiate_std_vnc_auth = sinon.spy();
send_security(22, client);
expect(client._negotiate_std_vnc_auth).to.have.been.calledOnce;
});
- it('should call the passwordRequired callback if the password is missing', function() {
- client.set_onPasswordRequired(sinon.spy());
- client._rfb_password = '';
+ it('should fire the credentialsrequired event if all credentials are missing', function() {
+ var spy = sinon.spy();
+ client.addEventListener("credentialsrequired", spy);
+ client._rfb_credentials = {};
send_security(22, client);
- var spy = client.get_onPasswordRequired();
- expect(client._rfb_password.length).to.equal(0);
+ expect(client._rfb_credentials).to.be.empty;
expect(spy).to.have.been.calledOnce;
+ expect(spy.args[0][0].detail.types).to.have.members(["username", "password", "target"]);
});
- it('should call the passwordRequired callback if the password is improperly formatted', function() {
- client.set_onPasswordRequired(sinon.spy());
- client._rfb_password = 'user@target';
+ it('should fire the credentialsrequired event if some credentials are missing', function() {
+ var spy = sinon.spy();
+ client.addEventListener("credentialsrequired", spy);
+ client._rfb_credentials = { username: 'user',
+ target: 'target' };
send_security(22, client);
- var spy = client.get_onPasswordRequired();
expect(spy).to.have.been.calledOnce;
+ expect(spy.args[0][0].detail.types).to.have.members(["username", "password", "target"]);
});
- it('should split the password, send the first two parts, and pass on the last part', function () {
- client.set_xvp_password_sep('#');
- client._rfb_password = 'user#target#password';
+ it('should send user and target separately', function () {
+ client._rfb_credentials = { username: 'user',
+ target: 'target',
+ password: 'password' };
client._negotiate_std_vnc_auth = sinon.spy();
send_security(22, client);
- expect(client._rfb_password).to.equal('password');
-
var expected = [22, 4, 6]; // auth selection, len user, len target
for (var i = 0; i < 10; i++) { expected[i+3] = 'usertarget'.charCodeAt(i); }
});
describe('TightVNC Authentication (type 16) Handler', function () {
- var client;
-
beforeEach(function () {
- client = make_rfb();
- client.connect('host', 8675);
- client._sock._websocket._open();
client._rfb_init_state = 'Security';
client._rfb_version = 3.8;
send_security(16, client);
});
describe('SecurityResult', function () {
- var client;
-
beforeEach(function () {
- client = make_rfb();
- client.connect('host', 8675);
- client._sock._websocket._open();
client._rfb_init_state = 'SecurityResult';
});
it('should fall through to ServerInitialisation on a response code of 0', function () {
- client._updateConnectionState = sinon.spy();
client._sock._websocket._receive_data(new Uint8Array([0, 0, 0, 0]));
expect(client._rfb_init_state).to.equal('ServerInitialisation');
});
var failure_data = [0, 0, 0, 1, 0, 0, 0, 6, 119, 104, 111, 111, 112, 115];
client._sock._websocket._receive_data(new Uint8Array(failure_data));
expect(client._fail).to.have.been.calledWith(
- 'Authentication failure', 'whoops');
+ 'Security negotiation failed on security result (reason: whoops)');
});
it('should fail on an error code of 1 with a standard message for version < 3.8', function () {
sinon.spy(client, '_fail');
client._rfb_version = 3.7;
client._sock._websocket._receive_data(new Uint8Array([0, 0, 0, 1]));
- expect(client._fail).to.have.been.calledWith('Authentication failure');
+ expect(client._fail).to.have.been.calledWith(
+ 'Security handshake failed');
});
- });
- describe('ClientInitialisation', function () {
- var client;
+ it('should result in securityfailure event when receiving a non zero status', function () {
+ var spy = sinon.spy();
+ client.addEventListener("securityfailure", spy);
+ client._sock._websocket._receive_data(new Uint8Array([0, 0, 0, 2]));
+ expect(spy).to.have.been.calledOnce;
+ expect(spy.args[0][0].detail.status).to.equal(2);
+ });
- beforeEach(function () {
- client = make_rfb();
- client.connect('host', 8675);
- client._sock._websocket._open();
- client._rfb_init_state = 'SecurityResult';
+ it('should include reason when provided in securityfailure event', function () {
+ client._rfb_version = 3.8;
+ var spy = sinon.spy();
+ client.addEventListener("securityfailure", spy);
+ var failure_data = [0, 0, 0, 1, 0, 0, 0, 12, 115, 117, 99, 104,
+ 32, 102, 97, 105, 108, 117, 114, 101];
+ client._sock._websocket._receive_data(new Uint8Array(failure_data));
+ expect(spy.args[0][0].detail.status).to.equal(1);
+ expect(spy.args[0][0].detail.reason).to.equal('such failure');
+ });
+
+ it('should not include reason when length is zero in securityfailure event', function () {
+ client._rfb_version = 3.9;
+ var spy = sinon.spy();
+ client.addEventListener("securityfailure", spy);
+ var failure_data = [0, 0, 0, 1, 0, 0, 0, 0];
+ client._sock._websocket._receive_data(new Uint8Array(failure_data));
+ expect(spy.args[0][0].detail.status).to.equal(1);
+ expect('reason' in spy.args[0][0].detail).to.be.false;
});
+ it('should not include reason in securityfailure event for version < 3.8', function () {
+ client._rfb_version = 3.6;
+ var spy = sinon.spy();
+ client.addEventListener("securityfailure", spy);
+ client._sock._websocket._receive_data(new Uint8Array([0, 0, 0, 2]));
+ expect(spy.args[0][0].detail.status).to.equal(2);
+ expect('reason' in spy.args[0][0].detail).to.be.false;
+ });
+ });
+
+ describe('ClientInitialisation', function () {
it('should transition to the ServerInitialisation state', function () {
+ var client = make_rfb();
+ client._rfb_connection_state = 'connecting';
+ client._rfb_init_state = 'SecurityResult';
client._sock._websocket._receive_data(new Uint8Array([0, 0, 0, 0]));
expect(client._rfb_init_state).to.equal('ServerInitialisation');
});
it('should send 1 if we are in shared mode', function () {
- client.set_shared(true);
+ var client = make_rfb('wss://host:8675', { shared: true });
+ client._rfb_connection_state = 'connecting';
+ client._rfb_init_state = 'SecurityResult';
client._sock._websocket._receive_data(new Uint8Array([0, 0, 0, 0]));
expect(client._sock).to.have.sent(new Uint8Array([1]));
});
it('should send 0 if we are not in shared mode', function () {
- client.set_shared(false);
+ var client = make_rfb('wss://host:8675', { shared: false });
+ client._rfb_connection_state = 'connecting';
+ client._rfb_init_state = 'SecurityResult';
client._sock._websocket._receive_data(new Uint8Array([0, 0, 0, 0]));
expect(client._sock).to.have.sent(new Uint8Array([0]));
});
});
describe('ServerInitialisation', function () {
- var client;
-
beforeEach(function () {
- client = make_rfb();
- client.connect('host', 8675);
- client._sock._websocket._open();
client._rfb_init_state = 'ServerInitialisation';
});
// NB(sross): we just warn, not fail, for endian-ness and shifts, so we don't test them
it('should set the framebuffer name and call the callback', function () {
- client.set_onDesktopName(sinon.spy());
+ var spy = sinon.spy();
+ client.addEventListener("desktopname", spy);
send_server_init({ name: 'some name' }, client);
- var spy = client.get_onDesktopName();
expect(client._fb_name).to.equal('some name');
expect(spy).to.have.been.calledOnce;
- expect(spy.args[0][1]).to.equal('some name');
+ expect(spy.args[0][0].detail.name).to.equal('some name');
});
it('should handle the extended init message of the tight encoding', function () {
expect(client._rfb_connection_state).to.equal('connected');
});
- it('should call the resize callback and resize the display', function () {
- client.set_onFBResize(sinon.spy());
+ it('should resize the display', function () {
sinon.spy(client._display, 'resize');
send_server_init({ width: 27, height: 32 }, client);
- var spy = client.get_onFBResize();
expect(client._display.resize).to.have.been.calledOnce;
expect(client._display.resize).to.have.been.calledWith(27, 32);
- expect(spy).to.have.been.calledOnce;
- expect(spy.args[0][1]).to.equal(27);
- expect(spy.args[0][2]).to.equal(32);
});
it('should grab the mouse and keyboard', function () {
beforeEach(function () {
client = make_rfb();
- client.connect('host', 8675);
- client._sock._websocket._open();
- client._rfb_connection_state = 'connected';
client._fb_name = 'some device';
client._fb_width = 640;
client._fb_height = 20;
});
describe('Framebuffer Update Handling', function () {
- var client;
-
- beforeEach(function () {
- client = make_rfb();
- client.connect('host', 8675);
- client._sock._websocket._open();
- client._rfb_connection_state = 'connected';
- client._fb_name = 'some device';
- client._fb_width = 640;
- client._fb_height = 20;
- });
-
var target_data_arr = [
0xff, 0x00, 0x00, 255, 0x00, 0xff, 0x00, 255, 0x00, 0x00, 0xff, 255, 0x00, 0x00, 0xff, 255,
0x00, 0xff, 0x00, 255, 0xff, 0x00, 0x00, 255, 0x00, 0x00, 0xff, 255, 0x00, 0x00, 0xff, 255,
expect(client._sock._websocket._get_sent_data()).to.have.length(0);
});
- it('should parse out information from a header before any actual data comes in', function () {
- client.set_onFBUReceive(sinon.spy());
- var rect_info = { x: 8, y: 11, width: 27, height: 32, encoding: 0x02, encodingName: 'RRE' };
- send_fbu_msg([rect_info], [[]], client);
-
- var spy = client.get_onFBUReceive();
- expect(spy).to.have.been.calledOnce;
- expect(spy).to.have.been.calledWith(sinon.match.any, rect_info);
- });
-
- it('should fire onFBUComplete when the update is complete', function () {
- client.set_onFBUComplete(sinon.spy());
- var rect_info = { x: 8, y: 11, width: 27, height: 32, encoding: -224, encodingName: 'last_rect' };
- send_fbu_msg([rect_info], [[]], client); // last_rect
-
- var spy = client.get_onFBUComplete();
- expect(spy).to.have.been.calledOnce;
- });
-
- it('should not fire onFBUComplete if we have not finished processing the update', function () {
- client.set_onFBUComplete(sinon.spy());
- var rect_info = { x: 8, y: 11, width: 27, height: 32, encoding: 0x00, encodingName: 'RAW' };
- send_fbu_msg([rect_info], [[]], client);
- expect(client.get_onFBUComplete()).to.not.have.been.called;
- });
-
it('should fail on an unsupported encoding', function () {
sinon.spy(client, "_fail");
var rect_info = { x: 8, y: 11, width: 27, height: 32, encoding: 234 };
});
describe('Message Encoding Handlers', function () {
- var client;
-
beforeEach(function () {
- client = make_rfb();
- client.connect('host', 8675);
- client._sock._websocket._open();
- client._rfb_connection_state = 'connected';
- client._fb_name = 'some device';
// a really small frame
client._fb_width = 4;
client._fb_height = 4;
});
describe('the HEXTILE encoding handler', function () {
- var client;
- beforeEach(function () {
- client = make_rfb();
- client.connect('host', 8675);
- client._sock._websocket._open();
- client._rfb_connection_state = 'connected';
- client._fb_name = 'some device';
- // a really small frame
- client._fb_width = 4;
- client._fb_height = 4;
- client._display.resize(4, 4);
- });
-
it('should handle a tile with fg, bg specified, normal subrects', function () {
var info = [{ x: 0, y: 0, width: 4, height: 4, encoding: 0x05 }];
var rect = [];
});
it('should handle the DesktopSize pseduo-encoding', function () {
- client.set_onFBResize(sinon.spy());
+ var spy = sinon.spy();
sinon.spy(client._display, 'resize');
send_fbu_msg([{ x: 0, y: 0, width: 20, height: 50, encoding: -223 }], [[]], client);
- var spy = client.get_onFBResize();
- expect(spy).to.have.been.calledOnce;
- expect(spy).to.have.been.calledWith(sinon.match.any, 20, 50);
-
expect(client._fb_width).to.equal(20);
expect(client._fb_height).to.equal(50);
});
describe('the ExtendedDesktopSize pseudo-encoding handler', function () {
- var client;
+ var resizeSpy;
beforeEach(function () {
- client = make_rfb();
- client.connect('host', 8675);
- client._sock._websocket._open();
- client._rfb_connection_state = 'connected';
- client._fb_name = 'some device';
- client._supportsSetDesktopSize = false;
// a really small frame
client._fb_width = 4;
client._fb_height = 4;
client._display.resize(4, 4);
sinon.spy(client._display, 'resize');
- client.set_onFBResize(sinon.spy());
+ resizeSpy = sinon.spy();
});
function make_screen_data (nr_of_screens) {
width: 20, height: 50, encoding: -308 }],
make_screen_data(1), client);
- expect(client._supportsSetDesktopSize).to.be.true;
expect(client._fb_width).to.equal(20);
expect(client._fb_height).to.equal(50);
expect(client._display.resize).to.have.been.calledOnce;
expect(client._display.resize).to.have.been.calledWith(20, 50);
-
- var spy = client.get_onFBResize();
- expect(spy).to.have.been.calledOnce;
- expect(spy).to.have.been.calledWith(sinon.match.any, 20, 50);
});
it('should handle a resize requested by another client', function () {
width: 20, height: 50, encoding: -308 }],
make_screen_data(1), client);
- expect(client._supportsSetDesktopSize).to.be.true;
expect(client._fb_width).to.equal(20);
expect(client._fb_height).to.equal(50);
expect(client._display.resize).to.have.been.calledOnce;
expect(client._display.resize).to.have.been.calledWith(20, 50);
-
- var spy = client.get_onFBResize();
- expect(spy).to.have.been.calledOnce;
- expect(spy).to.have.been.calledWith(sinon.match.any, 20, 50);
});
it('should be able to recieve requests which contain data for multiple screens', function () {
width: 60, height: 50, encoding: -308 }],
make_screen_data(3), client);
- expect(client._supportsSetDesktopSize).to.be.true;
expect(client._fb_width).to.equal(60);
expect(client._fb_height).to.equal(50);
expect(client._display.resize).to.have.been.calledOnce;
expect(client._display.resize).to.have.been.calledWith(60, 50);
-
- var spy = client.get_onFBResize();
- expect(spy).to.have.been.calledOnce;
- expect(spy).to.have.been.calledWith(sinon.match.any, 60, 50);
});
it('should not handle a failed request', function () {
expect(client._fb_height).to.equal(4);
expect(client._display.resize).to.not.have.been.called;
-
- var spy = client.get_onFBResize();
- expect(spy).to.not.have.been.called;
});
});
});
it('should handle the last_rect pseudo-encoding', function () {
- client.set_onFBUReceive(sinon.spy());
send_fbu_msg([{ x: 0, y: 0, width: 0, height: 0, encoding: -224}], [[]], client, 100);
expect(client._FBU.rects).to.equal(0);
- expect(client.get_onFBUReceive()).to.have.been.calledOnce;
});
});
});
describe('XVP Message Handling', function () {
- beforeEach(function () {
- client = make_rfb();
- client.connect('host', 8675);
- client._sock._websocket._open();
- client._rfb_connection_state = 'connected';
- client._fb_name = 'some device';
- client._fb_width = 27;
- client._fb_height = 32;
- });
-
- it('should send a notification on XVP_FAIL', function () {
- client.set_onNotification(sinon.spy());
- client._sock._websocket._receive_data(new Uint8Array([250, 0, 10, 0]));
- var spy = client.get_onNotification();
- expect(spy).to.have.been.calledOnce;
- expect(spy.args[0][1]).to.equal('XVP Operation Failed');
- });
-
it('should set the XVP version and fire the callback with the version on XVP_INIT', function () {
- client.set_onXvpInit(sinon.spy());
+ var spy = sinon.spy();
+ client.addEventListener("capabilities", spy);
client._sock._websocket._receive_data(new Uint8Array([250, 0, 10, 1]));
expect(client._rfb_xvp_ver).to.equal(10);
- expect(client.get_onXvpInit()).to.have.been.calledOnce;
- expect(client.get_onXvpInit()).to.have.been.calledWith(10);
+ expect(spy).to.have.been.calledOnce;
+ expect(spy.args[0][0].detail.capabilities.power).to.be.true;
+ expect(client.capabilities.power).to.be.true;
});
it('should fail on unknown XVP message types', function () {
var data = [3, 0, 0, 0];
push32(data, expected_str.length);
for (var i = 0; i < expected_str.length; i++) { data.push(expected_str.charCodeAt(i)); }
- client.set_onClipboard(sinon.spy());
+ var spy = sinon.spy();
+ client.addEventListener("clipboard", spy);
client._sock._websocket._receive_data(new Uint8Array(data));
- var spy = client.get_onClipboard();
expect(spy).to.have.been.calledOnce;
- expect(spy.args[0][1]).to.equal(expected_str);
+ expect(spy.args[0][0].detail.text).to.equal(expected_str);
});
it('should fire the bell callback on Bell', function () {
- client.set_onBell(sinon.spy());
+ var spy = sinon.spy();
+ client.addEventListener("bell", spy);
client._sock._websocket._receive_data(new Uint8Array([2]));
- expect(client.get_onBell()).to.have.been.calledOnce;
+ expect(spy).to.have.been.calledOnce;
});
it('should respond correctly to ServerFence', function () {
});
describe('Asynchronous Events', function () {
- describe('Mouse event handlers', function () {
- var client;
- beforeEach(function () {
- client = make_rfb();
- client._sock = new Websock();
- client._sock.open('ws://', 'binary');
- client._sock._websocket._open();
- sinon.spy(client._sock, 'flush');
- client._rfb_connection_state = 'connected';
- });
+ var client;
+ beforeEach(function () {
+ client = make_rfb();
+ });
+ describe('Mouse event handlers', function () {
it('should not send button messages in view-only mode', function () {
- client._view_only = true;
- client._mouse._onMouseButton(0, 0, 1, 0x001);
+ client._viewOnly = true;
+ sinon.spy(client._sock, 'flush');
+ client._handleMouseButton(0, 0, 1, 0x001);
expect(client._sock.flush).to.not.have.been.called;
});
it('should not send movement messages in view-only mode', function () {
- client._view_only = true;
- client._mouse._onMouseMove(0, 0);
+ client._viewOnly = true;
+ sinon.spy(client._sock, 'flush');
+ client._handleMouseMove(0, 0);
expect(client._sock.flush).to.not.have.been.called;
});
it('should send a pointer event on mouse button presses', function () {
- client._mouse._onMouseButton(10, 12, 1, 0x001);
+ client._handleMouseButton(10, 12, 1, 0x001);
var pointer_msg = {_sQ: new Uint8Array(6), _sQlen: 0, flush: function () {}};
RFB.messages.pointerEvent(pointer_msg, 10, 12, 0x001);
expect(client._sock).to.have.sent(pointer_msg._sQ);
});
it('should send a mask of 1 on mousedown', function () {
- client._mouse._onMouseButton(10, 12, 1, 0x001);
+ client._handleMouseButton(10, 12, 1, 0x001);
var pointer_msg = {_sQ: new Uint8Array(6), _sQlen: 0, flush: function () {}};
RFB.messages.pointerEvent(pointer_msg, 10, 12, 0x001);
expect(client._sock).to.have.sent(pointer_msg._sQ);
it('should send a mask of 0 on mouseup', function () {
client._mouse_buttonMask = 0x001;
- client._mouse._onMouseButton(10, 12, 0, 0x001);
+ client._handleMouseButton(10, 12, 0, 0x001);
var pointer_msg = {_sQ: new Uint8Array(6), _sQlen: 0, flush: function () {}};
RFB.messages.pointerEvent(pointer_msg, 10, 12, 0x000);
expect(client._sock).to.have.sent(pointer_msg._sQ);
});
it('should send a pointer event on mouse movement', function () {
- client._mouse._onMouseMove(10, 12);
+ client._handleMouseMove(10, 12);
var pointer_msg = {_sQ: new Uint8Array(6), _sQlen: 0, flush: function () {}};
RFB.messages.pointerEvent(pointer_msg, 10, 12, 0x000);
expect(client._sock).to.have.sent(pointer_msg._sQ);
});
it('should set the button mask so that future mouse movements use it', function () {
- client._mouse._onMouseButton(10, 12, 1, 0x010);
- client._mouse._onMouseMove(13, 9);
+ client._handleMouseButton(10, 12, 1, 0x010);
+ client._handleMouseMove(13, 9);
var pointer_msg = {_sQ: new Uint8Array(12), _sQlen: 0, flush: function () {}};
RFB.messages.pointerEvent(pointer_msg, 10, 12, 0x010);
RFB.messages.pointerEvent(pointer_msg, 13, 9, 0x010);
expect(client._sock).to.have.sent(pointer_msg._sQ);
});
-
- // NB(directxman12): we don't need to test not sending messages in
- // non-normal modes, since we haven't grabbed input
- // yet (grabbing input should be checked in the lifecycle tests).
-
- it('should not send movement messages when viewport dragging', function () {
- client._viewportDragging = true;
- client._display.viewportChangePos = sinon.spy();
- client._mouse._onMouseMove(13, 9);
- expect(client._sock.flush).to.not.have.been.called;
- });
-
- it('should not send button messages when initiating viewport dragging', function () {
- client._viewportDrag = true;
- client._mouse._onMouseButton(13, 9, 0x001);
- expect(client._sock.flush).to.not.have.been.called;
- });
-
- it('should be initiate viewport dragging on a button down event, if enabled', function () {
- client._viewportDrag = true;
- client._mouse._onMouseButton(13, 9, 0x001);
- expect(client._viewportDragging).to.be.true;
- expect(client._viewportDragPos).to.deep.equal({ x: 13, y: 9 });
- });
-
- it('should terminate viewport dragging on a button up event, if enabled', function () {
- client._viewportDrag = true;
- client._viewportDragging = true;
- client._mouse._onMouseButton(13, 9, 0x000);
- expect(client._viewportDragging).to.be.false;
- });
-
- it('if enabled, viewportDragging should occur on mouse movement while a button is down', function () {
- var oldX = 123;
- var oldY = 109;
- var newX = 123 + 11 * window.devicePixelRatio;
- var newY = 109 + 4 * window.devicePixelRatio;
-
- client._viewportDrag = true;
- client._viewportDragging = true;
- client._viewportHasMoved = false;
- client._viewportDragPos = { x: oldX, y: oldY };
- client._display.viewportChangePos = sinon.spy();
-
- client._mouse._onMouseMove(newX, newY);
-
- expect(client._viewportDragging).to.be.true;
- expect(client._viewportHasMoved).to.be.true;
- expect(client._viewportDragPos).to.deep.equal({ x: newX, y: newY });
- expect(client._display.viewportChangePos).to.have.been.calledOnce;
- expect(client._display.viewportChangePos).to.have.been.calledWith(oldX - newX, oldY - newY);
- });
});
describe('Keyboard Event Handlers', function () {
- var client;
- beforeEach(function () {
- client = make_rfb();
- client._sock = new Websock();
- client._sock.open('ws://', 'binary');
- client._sock._websocket._open();
- sinon.spy(client._sock, 'flush');
- client._rfb_connection_state = 'connected';
- client._view_only = false;
- });
-
it('should send a key message on a key press', function () {
var keyevent = {};
- client._keyboard._onKeyEvent(0x41, 'KeyA', true);
+ client._handleKeyEvent(0x41, 'KeyA', true);
var key_msg = {_sQ: new Uint8Array(8), _sQlen: 0, flush: function () {}};
RFB.messages.keyEvent(key_msg, 0x41, 1);
expect(client._sock).to.have.sent(key_msg._sQ);
});
it('should not send messages in view-only mode', function () {
- client._view_only = true;
- client._keyboard._onKeyEvent('a', 'KeyA', true);
+ client._viewOnly = true;
+ sinon.spy(client._sock, 'flush');
+ client._handleKeyEvent('a', 'KeyA', true);
expect(client._sock.flush).to.not.have.been.called;
});
});
describe('WebSocket event handlers', function () {
- var client;
- beforeEach(function () {
- client = make_rfb();
- this.clock = sinon.useFakeTimers();
- });
-
- afterEach(function () { this.clock.restore(); });
-
// message events
it ('should do nothing if we receive an empty message and have nothing in the queue', function () {
- client.connect('host', 8675);
- client._rfb_connection_state = 'connected';
client._normal_msg = sinon.spy();
client._sock._websocket._receive_data(new Uint8Array([]));
expect(client._normal_msg).to.not.have.been.called;
});
it('should handle a message in the connected state as a normal message', function () {
- client.connect('host', 8675);
- client._rfb_connection_state = 'connected';
client._normal_msg = sinon.spy();
client._sock._websocket._receive_data(new Uint8Array([1, 2, 3]));
expect(client._normal_msg).to.have.been.calledOnce;
});
it('should handle a message in any non-disconnected/failed state like an init message', function () {
- client.connect('host', 8675);
+ client._rfb_connection_state = 'connecting';
client._rfb_init_state = 'ProtocolVersion';
client._init_msg = sinon.spy();
client._sock._websocket._receive_data(new Uint8Array([1, 2, 3]));
});
it('should process all normal messages directly', function () {
- client.connect('host', 8675);
- client._sock._websocket._open();
- client._rfb_connection_state = 'connected';
- client.set_onBell(sinon.spy());
+ var spy = sinon.spy();
+ client.addEventListener("bell", spy);
client._sock._websocket._receive_data(new Uint8Array([0x02, 0x02]));
- expect(client.get_onBell()).to.have.been.calledTwice;
+ expect(spy).to.have.been.calledTwice;
});
// open events
it('should update the state to ProtocolVersion on open (if the state is "connecting")', function () {
- client.connect('host', 8675);
+ client = new RFB(document.createElement('div'), 'wss://host:8675');
+ this.clock.tick();
client._sock._websocket._open();
expect(client._rfb_init_state).to.equal('ProtocolVersion');
});
it('should fail if we are not currently ready to connect and we get an "open" event', function () {
sinon.spy(client, "_fail");
- client.connect('host', 8675);
- client._rfb_connection_state = 'some_other_state';
+ client._rfb_connection_state = 'connected';
client._sock._websocket._open();
expect(client._fail).to.have.been.calledOnce;
});
// close events
it('should transition to "disconnected" from "disconnecting" on a close event', function () {
- client.connect('host', 8675);
- client._rfb_connection_state = 'disconnecting';
+ var real = client._sock._websocket.close;
+ client._sock._websocket.close = function () {};
+ client.disconnect();
+ expect(client._rfb_connection_state).to.equal('disconnecting');
+ client._sock._websocket.close = real;
client._sock._websocket.close();
expect(client._rfb_connection_state).to.equal('disconnected');
});
it('should fail if we get a close event while connecting', function () {
sinon.spy(client, "_fail");
- client.connect('host', 8675);
client._rfb_connection_state = 'connecting';
client._sock._websocket.close();
expect(client._fail).to.have.been.calledOnce;
});
- it('should fail if we get a close event while disconnected', function () {
- sinon.spy(client, "_fail");
- client.connect('host', 8675);
- client._rfb_connection_state = 'disconnected';
- client._sock._websocket.close();
- expect(client._fail).to.have.been.calledOnce;
- });
-
it('should unregister close event handler', function () {
sinon.spy(client._sock, 'off');
- client.connect('host', 8675);
- client._rfb_connection_state = 'disconnecting';
+ client.disconnect();
client._sock._websocket.close();
expect(client._sock.off).to.have.been.calledWith('close');
});
projects / mirror_novnc.git / blobdiff