]> git.proxmox.com Git - mirror_novnc.git/blobdiff - tests/test.keyboard.js
Move localization.js to app
[mirror_novnc.git] / tests / test.keyboard.js
index f1f33af8ded22420756f30a205af81eeb476dbab..513d797f99ab1d2119d2be923b15e81d287bbdc2 100644 (file)
@@ -1,9 +1,9 @@
 var assert = chai.assert;
 var expect = chai.expect;
 
-import { Keyboard } from '../core/input/devices.js';
-import keysyms from '../core/input/keysymdef.js';
-import * as KeyboardUtil from '../core/input/util.js';
+import sinon from '../vendor/sinon.js';
+
+import Keyboard from '../core/input/keyboard.js';
 
 function isIE() {
     return navigator && !!(/trident/i).exec(navigator.userAgent);
@@ -31,67 +31,107 @@ describe('Key Event Handling', function() {
     describe('Decode Keyboard Events', function() {
         it('should decode keydown events', function(done) {
             if (isIE() || isEdge()) this.skip();
-            var kbd = new Keyboard({
-            onKeyEvent: function(keysym, code, down) {
+            var kbd = new Keyboard(document);
+            kbd.onkeyevent = function(keysym, code, down) {
                 expect(keysym).to.be.equal(0x61);
                 expect(code).to.be.equal('KeyA');
                 expect(down).to.be.equal(true);
                 done();
-            }});
+            };
             kbd._handleKeyDown(keyevent('keydown', {code: 'KeyA', key: 'a'}));
         });
         it('should decode keyup events', function(done) {
             if (isIE() || isEdge()) this.skip();
             var calls = 0;
-            var kbd = new Keyboard({
-            onKeyEvent: function(keysym, code, down) {
+            var kbd = new Keyboard(document);
+            kbd.onkeyevent = function(keysym, code, down) {
                 expect(keysym).to.be.equal(0x61);
                 expect(code).to.be.equal('KeyA');
                 if (calls++ === 1) {
                     expect(down).to.be.equal(false);
                     done();
                 }
-            }});
+            };
             kbd._handleKeyDown(keyevent('keydown', {code: 'KeyA', key: 'a'}));
             kbd._handleKeyUp(keyevent('keyup', {code: 'KeyA', key: 'a'}));
         });
 
         describe('Legacy keypress Events', function() {
             it('should wait for keypress when needed', function() {
-                var callback = sinon.spy();
-                var kbd = new Keyboard({onKeyEvent: callback});
+                var kbd = new Keyboard(document);
+                kbd.onkeyevent = sinon.spy();
                 kbd._handleKeyDown(keyevent('keydown', {code: 'KeyA', keyCode: 0x41}));
-                expect(callback).to.not.have.been.called;
+                expect(kbd.onkeyevent).to.not.have.been.called;
             });
             it('should decode keypress events', function(done) {
-                var kbd = new Keyboard({
-                onKeyEvent: function(keysym, code, down) {
+                var kbd = new Keyboard(document);
+                kbd.onkeyevent = function(keysym, code, down) {
                     expect(keysym).to.be.equal(0x61);
                     expect(code).to.be.equal('KeyA');
                     expect(down).to.be.equal(true);
                     done();
-                }});
+                };
                 kbd._handleKeyDown(keyevent('keydown', {code: 'KeyA', keyCode: 0x41}));
                 kbd._handleKeyPress(keyevent('keypress', {code: 'KeyA', charCode: 0x61}));
             });
             it('should ignore keypress with different code', function() {
-                var callback = sinon.spy();
-                var kbd = new Keyboard({onKeyEvent: callback});
+                var kbd = new Keyboard(document);
+                kbd.onkeyevent = sinon.spy();
                 kbd._handleKeyDown(keyevent('keydown', {code: 'KeyA', keyCode: 0x41}));
                 kbd._handleKeyPress(keyevent('keypress', {code: 'KeyB', charCode: 0x61}));
-                expect(callback).to.not.have.been.called;
+                expect(kbd.onkeyevent).to.not.have.been.called;
             });
             it('should handle keypress with missing code', function(done) {
-                var kbd = new Keyboard({
-                onKeyEvent: function(keysym, code, down) {
+                var kbd = new Keyboard(document);
+                kbd.onkeyevent = function(keysym, code, down) {
                     expect(keysym).to.be.equal(0x61);
                     expect(code).to.be.equal('KeyA');
                     expect(down).to.be.equal(true);
                     done();
-                }});
+                };
                 kbd._handleKeyDown(keyevent('keydown', {code: 'KeyA', keyCode: 0x41}));
                 kbd._handleKeyPress(keyevent('keypress', {charCode: 0x61}));
             });
+            it('should guess key if no keypress and numeric key', function(done) {
+                var kbd = new Keyboard(document);
+                kbd.onkeyevent = function(keysym, code, down) {
+                    expect(keysym).to.be.equal(0x32);
+                    expect(code).to.be.equal('Digit2');
+                    expect(down).to.be.equal(true);
+                    done();
+                };
+                kbd._handleKeyDown(keyevent('keydown', {code: 'Digit2', keyCode: 0x32}));
+            });
+            it('should guess key if no keypress and alpha key', function(done) {
+                var kbd = new Keyboard(document);
+                kbd.onkeyevent = function(keysym, code, down) {
+                    expect(keysym).to.be.equal(0x61);
+                    expect(code).to.be.equal('KeyA');
+                    expect(down).to.be.equal(true);
+                    done();
+                };
+                kbd._handleKeyDown(keyevent('keydown', {code: 'KeyA', keyCode: 0x41, shiftKey: false}));
+            });
+            it('should guess key if no keypress and alpha key (with shift)', function(done) {
+                var kbd = new Keyboard(document);
+                kbd.onkeyevent = function(keysym, code, down) {
+                    expect(keysym).to.be.equal(0x41);
+                    expect(code).to.be.equal('KeyA');
+                    expect(down).to.be.equal(true);
+                    done();
+                };
+                kbd._handleKeyDown(keyevent('keydown', {code: 'KeyA', keyCode: 0x41, shiftKey: true}));
+            });
+            it('should not guess key if no keypress and unknown key', function(done) {
+                var kbd = new Keyboard(document);
+                kbd.onkeyevent = function(keysym, code, down) {
+                    expect(keysym).to.be.equal(0);
+                    expect(code).to.be.equal('KeyA');
+                    expect(down).to.be.equal(true);
+                    done();
+                };
+                kbd._handleKeyDown(keyevent('keydown', {code: 'KeyA', keyCode: 0x09}));
+            });
         });
 
         describe('suppress the right events at the right time', function() {
@@ -99,7 +139,7 @@ describe('Key Event Handling', function() {
                 if (isIE() || isEdge()) this.skip();
             });
             it('should suppress anything with a valid key', function() {
-                var kbd = new Keyboard({});
+                var kbd = new Keyboard(document, {});
                 var evt = keyevent('keydown', {code: 'KeyA', key: 'a'});
                 kbd._handleKeyDown(evt);
                 expect(evt.preventDefault).to.have.been.called;
@@ -108,13 +148,13 @@ describe('Key Event Handling', function() {
                 expect(evt.preventDefault).to.have.been.called;
             });
             it('should not suppress keys without key', function() {
-                var kbd = new Keyboard({});
+                var kbd = new Keyboard(document, {});
                 var evt = keyevent('keydown', {code: 'KeyA', keyCode: 0x41});
                 kbd._handleKeyDown(evt);
                 expect(evt.preventDefault).to.not.have.been.called;
             });
             it('should suppress the following keypress event', function() {
-                var kbd = new Keyboard({});
+                var kbd = new Keyboard(document, {});
                 var evt = keyevent('keydown', {code: 'KeyA', keyCode: 0x41});
                 kbd._handleKeyDown(evt);
                 var evt = keyevent('keypress', {code: 'KeyA', charCode: 0x41});
@@ -128,8 +168,8 @@ describe('Key Event Handling', function() {
         it('should fake keyup events for virtual keyboards', function(done) {
             if (isIE() || isEdge()) this.skip();
             var count = 0;
-            var kbd = new Keyboard({
-            onKeyEvent: function(keysym, code, down) {
+            var kbd = new Keyboard(document);
+            kbd.onkeyevent = function(keysym, code, down) {
                 switch (count++) {
                     case 0:
                         expect(keysym).to.be.equal(0x61);
@@ -142,7 +182,7 @@ describe('Key Event Handling', function() {
                         expect(down).to.be.equal(false);
                         done();
                 }
-            }});
+            };
             kbd._handleKeyDown(keyevent('keydown', {code: 'Unidentified', key: 'a'}));
         });
 
@@ -175,8 +215,8 @@ describe('Key Event Handling', function() {
             it('should fake keyup events on iOS', function(done) {
                 if (isIE() || isEdge()) this.skip();
                 var count = 0;
-                var kbd = new Keyboard({
-                onKeyEvent: function(keysym, code, down) {
+                var kbd = new Keyboard(document);
+                kbd.onkeyevent = function(keysym, code, down) {
                     switch (count++) {
                         case 0:
                             expect(keysym).to.be.equal(0x61);
@@ -189,7 +229,7 @@ describe('Key Event Handling', function() {
                             expect(down).to.be.equal(false);
                             done();
                     }
-                }});
+                };
                 kbd._handleKeyDown(keyevent('keydown', {code: 'KeyA', key: 'a'}));
             });
         });
@@ -200,35 +240,70 @@ describe('Key Event Handling', function() {
             if (isIE() || isEdge()) this.skip();
         });
         it('should send release using the same keysym as the press', function(done) {
-            var kbd = new Keyboard({
-            onKeyEvent: function(keysym, code, down) {
+            var kbd = new Keyboard(document);
+            kbd.onkeyevent = function(keysym, code, down) {
                 expect(keysym).to.be.equal(0x61);
                 expect(code).to.be.equal('KeyA');
                 if (!down) {
                     done();
                 }
-            }});
+            };
             kbd._handleKeyDown(keyevent('keydown', {code: 'KeyA', key: 'a'}));
             kbd._handleKeyUp(keyevent('keyup', {code: 'KeyA', key: 'b'}));
         });
         it('should send the same keysym for multiple presses', function() {
             var count = 0;
-            var kbd = new Keyboard({
-            onKeyEvent: function(keysym, code, down) {
+            var kbd = new Keyboard(document);
+            kbd.onkeyevent = function(keysym, code, down) {
                 expect(keysym).to.be.equal(0x61);
                 expect(code).to.be.equal('KeyA');
                 expect(down).to.be.equal(true);
                 count++;
-            }});
+            };
             kbd._handleKeyDown(keyevent('keydown', {code: 'KeyA', key: 'a'}));
             kbd._handleKeyDown(keyevent('keydown', {code: 'KeyA', key: 'b'}));
             expect(count).to.be.equal(2);
         });
         it('should do nothing on keyup events if no keys are down', function() {
-            var callback = sinon.spy();
-            var kbd = new Keyboard({onKeyEvent: callback});
+            var kbd = new Keyboard(document);
+            kbd.onkeyevent = sinon.spy();
             kbd._handleKeyUp(keyevent('keyup', {code: 'KeyA', key: 'a'}));
-            expect(callback).to.not.have.been.called;
+            expect(kbd.onkeyevent).to.not.have.been.called;
+        });
+
+        describe('Legacy Events', function() {
+            it('should track keys using keyCode if no code', function(done) {
+                var kbd = new Keyboard(document);
+                kbd.onkeyevent = function(keysym, code, down) {
+                    expect(keysym).to.be.equal(0x61);
+                    expect(code).to.be.equal('Platform65');
+                    if (!down) {
+                        done();
+                    }
+                };
+                kbd._handleKeyDown(keyevent('keydown', {keyCode: 65, key: 'a'}));
+                kbd._handleKeyUp(keyevent('keyup', {keyCode: 65, key: 'b'}));
+            });
+            it('should ignore compositing code', function() {
+                var kbd = new Keyboard(document);
+                kbd.onkeyevent = function(keysym, code, down) {
+                    expect(keysym).to.be.equal(0x61);
+                    expect(code).to.be.equal('Unidentified');
+                };
+                kbd._handleKeyDown(keyevent('keydown', {keyCode: 229, key: 'a'}));
+            });
+            it('should track keys using keyIdentifier if no code', function(done) {
+                var kbd = new Keyboard(document);
+                kbd.onkeyevent = function(keysym, code, down) {
+                    expect(keysym).to.be.equal(0x61);
+                    expect(code).to.be.equal('Platform65');
+                    if (!down) {
+                        done();
+                    }
+                };
+                kbd._handleKeyDown(keyevent('keydown', {keyIdentifier: 'U+0041', key: 'a'}));
+                kbd._handleKeyUp(keyevent('keyup', {keyIdentifier: 'U+0041', key: 'b'}));
+            });
         });
     });
 
@@ -260,8 +335,8 @@ describe('Key Event Handling', function() {
 
         it('should change Alt to AltGraph', function() {
             var count = 0;
-            var kbd = new Keyboard({
-            onKeyEvent: function(keysym, code, down) {
+            var kbd = new Keyboard(document);
+            kbd.onkeyevent = function(keysym, code, down) {
                 switch (count++) {
                     case 0:
                         expect(keysym).to.be.equal(0xFF7E);
@@ -272,27 +347,27 @@ describe('Key Event Handling', function() {
                         expect(code).to.be.equal('AltRight');
                         break;
                 }
-            }});
+            };
             kbd._handleKeyDown(keyevent('keydown', {code: 'AltLeft', key: 'Alt', location: 1}));
             kbd._handleKeyDown(keyevent('keydown', {code: 'AltRight', key: 'Alt', location: 2}));
             expect(count).to.be.equal(2);
         });
         it('should change left Super to Alt', function(done) {
-            var kbd = new Keyboard({
-            onKeyEvent: function(keysym, code, down) {
+            var kbd = new Keyboard(document);
+            kbd.onkeyevent = function(keysym, code, down) {
                 expect(keysym).to.be.equal(0xFFE9);
                 expect(code).to.be.equal('MetaLeft');
                 done();
-            }});
+            };
             kbd._handleKeyDown(keyevent('keydown', {code: 'MetaLeft', key: 'Meta', location: 1}));
         });
         it('should change right Super to left Super', function(done) {
-            var kbd = new Keyboard({
-            onKeyEvent: function(keysym, code, down) {
+            var kbd = new Keyboard(document);
+            kbd.onkeyevent = function(keysym, code, down) {
                 expect(keysym).to.be.equal(0xFFEB);
                 expect(code).to.be.equal('MetaRight');
                 done();
-            }});
+            };
             kbd._handleKeyDown(keyevent('keydown', {code: 'MetaRight', key: 'Meta', location: 2}));
         });
     });
@@ -325,8 +400,8 @@ describe('Key Event Handling', function() {
 
         it('should generate fake undo/redo events on press when AltGraph is down', function() {
             var times_called = 0;
-            var kbd = new Keyboard({
-            onKeyEvent: function(keysym, code, down) {
+            var kbd = new Keyboard(document);
+            kbd.onkeyevent = function(keysym, code, down) {
                 switch(times_called++) {
                 case 0:
                     expect(keysym).to.be.equal(0xFFE3);
@@ -364,7 +439,7 @@ describe('Key Event Handling', function() {
                     expect(down).to.be.equal(true);
                     break;
                 }
-            }});
+            };
             // First the modifier combo
             kbd._handleKeyDown(keyevent('keydown', {code: 'ControlLeft', key: 'Control', location: 1}));
             kbd._handleKeyDown(keyevent('keydown', {code: 'AltRight', key: 'Alt', location: 2}));
@@ -374,8 +449,8 @@ describe('Key Event Handling', function() {
         });
         it('should no do anything on key release', function() {
             var times_called = 0;
-            var kbd = new Keyboard({
-            onKeyEvent: function(keysym, code, down) {
+            var kbd = new Keyboard(document);
+            kbd.onkeyevent = function(keysym, code, down) {
                 switch(times_called++) {
                 case 7:
                     expect(keysym).to.be.equal(0x61);
@@ -383,7 +458,7 @@ describe('Key Event Handling', function() {
                     expect(down).to.be.equal(false);
                     break;
                 }
-            }});
+            };
             // First the modifier combo
             kbd._handleKeyDown(keyevent('keydown', {code: 'ControlLeft', key: 'Control', location: 1}));
             kbd._handleKeyDown(keyevent('keydown', {code: 'AltRight', key: 'Alt', location: 2}));
@@ -394,8 +469,8 @@ describe('Key Event Handling', function() {
         });
         it('should not consider a char modifier to be down on the modifier key itself', function() {
             var times_called = 0;
-            var kbd = new Keyboard({
-            onKeyEvent: function(keysym, code, down) {
+            var kbd = new Keyboard(document);
+            kbd.onkeyevent = function(keysym, code, down) {
                 switch(times_called++) {
                 case 0:
                     expect(keysym).to.be.equal(0xFFE3);
@@ -413,7 +488,7 @@ describe('Key Event Handling', function() {
                     expect(down).to.be.equal(true);
                     break;
                 }
-            }});
+            };
             // First the modifier combo
             kbd._handleKeyDown(keyevent('keydown', {code: 'ControlLeft', key: 'Control', location: 1}));
             kbd._handleKeyDown(keyevent('keydown', {code: 'AltLeft', key: 'Alt', location: 1}));