remoting/webapp/base/js/console_wrapper_unittest.js

   1 // Copyright 2014 The Chromium Authors. All rights reserved.
   2 // Use of this source code is governed by a BSD-style license that can be
   3 // found in the LICENSE file.
   4
   5 /** @suppress {checkTypes|reportUnknownTypes} */
   6
   7 (function() {
   8
   9 'use strict';
  10
  11 var oldLog = null;
  12 var oldWarn = null;
  13 var oldError = null;
  14 var oldAssert = null;
  15
  16 var logSpy = null
  17 var warnSpy = null;
  18 var errorSpy = null;
  19 var assertSpy = null;
  20
  21 var LOCATION_PREFIX = 'console_wrapper_unittest.js:'
  22
  23 QUnit.module('console_wrapper', {
  24   beforeEach: function() {
  25     oldLog = console.log;
  26     oldWarn = console.warn;
  27     oldError = console.error;
  28     oldAssert = console.assert;
  29
  30     logSpy = sinon.spy();
  31     warnSpy = sinon.spy();
  32     errorSpy = sinon.spy();
  33     assertSpy = sinon.spy();
  34
  35     console.log = logSpy;
  36     console.warn = warnSpy;
  37     console.error = errorSpy;
  38     console.assert = assertSpy;
  39   },
  40
  41   afterEach: function() {
  42     remoting.ConsoleWrapper.getInstance().deactivate();
  43
  44     console.log = oldLog;
  45     console.warn = oldWarn;
  46     console.error = oldError;
  47     console.assert = oldAssert;
  48
  49     logSpy = null;
  50     warnSpy = null;
  51     errorSpy = null;
  52     assertSpy = null;
  53     oldLog = null;
  54     oldWarn = null;
  55     oldError = null;
  56     oldAssert = null;
  57   }
  58 });
  59
  60 QUnit.test('calls to console methods are passed through when wrapped.',
  61            function(assert)
  62 {
  63   remoting.ConsoleWrapper.getInstance().activate(
  64       0,  // No history
  65       remoting.ConsoleWrapper.LogType.LOG,
  66       remoting.ConsoleWrapper.LogType.WARN,
  67       remoting.ConsoleWrapper.LogType.ERROR,
  68       remoting.ConsoleWrapper.LogType.ASSERT);
  69
  70   // Ignore any logging in the ctor or activate() methods.
  71   logSpy.reset();
  72   warnSpy.reset();
  73   errorSpy.reset();
  74   assertSpy.reset();
  75
  76   console.log('log', 1, 2, 3);
  77   assert.ok(logSpy.calledWith('log', 1, 2, 3));
  78
  79   console.warn('warn', 1, 2, 3);
  80   assert.ok(warnSpy.calledWith('warn', 1, 2, 3));
  81
  82   console.error('error', 1, 2, 3);
  83   assert.ok(errorSpy.calledWith('error', 1, 2, 3));
  84
  85   console.assert(false, 'assert', 1, 2, 3);
  86   assert.ok(assertSpy.calledWith(false, 'assert', 1, 2, 3));
  87
  88   // Verify that all the above calls also include the call-site, and validate
  89   // it as far as is possible without making the test too flaky.
  90   assert.ok(typeof(logSpy.firstCall.args[4]) == 'string');
  91   assert.ok(logSpy.firstCall.args[4].startsWith(LOCATION_PREFIX));
  92
  93   assert.ok(typeof(warnSpy.firstCall.args[4]) == 'string');
  94   assert.ok(warnSpy.firstCall.args[4].startsWith(LOCATION_PREFIX));
  95
  96   assert.ok(typeof(errorSpy.firstCall.args[4]) == 'string');
  97   assert.ok(errorSpy.firstCall.args[4].startsWith(LOCATION_PREFIX));
  98
  99   assert.ok(typeof(assertSpy.firstCall.args[5]) == 'string');
 100   assert.ok(assertSpy.firstCall.args[5].startsWith(LOCATION_PREFIX));
 101
 102   // Verify that console methods are no longer wrapped after deactivate().
 103   remoting.ConsoleWrapper.getInstance().deactivate();
 104   logSpy.reset();
 105   console.log('Should not be intercepted.');
 106   assert.equal(logSpy.firstCall.args.length, 1);
 107 });
 108
 109
 110 QUnit.test('calls to console methods are saved when wrapped.',
 111            function(assert)
 112 {
 113   remoting.ConsoleWrapper.getInstance().activate(
 114       3,
 115       remoting.ConsoleWrapper.LogType.LOG,
 116       remoting.ConsoleWrapper.LogType.WARN,
 117       remoting.ConsoleWrapper.LogType.ERROR);
 118
 119   console.log('first', 1, 2, 3);
 120   assert.equal(remoting.ConsoleWrapper.getInstance().getHistory().length, 1);
 121   var entry = remoting.ConsoleWrapper.getInstance().getHistory()[0];
 122   assert.equal(entry.type,'log');
 123   assert.equal(entry.message, '["first",1,2,3]');
 124   assert.ok(entry.caller.startsWith(LOCATION_PREFIX));
 125   assert.equal(entry.timestamp.toGMTString(), 'Thu, 01 Jan 1970 00:00:00 GMT');
 126
 127   this.clock.tick(1000);
 128   console.log('second', 1, 2, 3);
 129   assert.equal(remoting.ConsoleWrapper.getInstance().getHistory().length, 2);
 130   entry = remoting.ConsoleWrapper.getInstance().getHistory()[1];
 131   assert.equal(entry.type, 'log');
 132   assert.equal(entry.message, '["second",1,2,3]');
 133   assert.ok(entry.caller.startsWith(LOCATION_PREFIX));
 134   assert.equal(entry.timestamp.toGMTString(), 'Thu, 01 Jan 1970 00:00:01 GMT');
 135
 136   this.clock.tick(1000);
 137   console.warn('third', 1, 2, 3);
 138   assert.equal(remoting.ConsoleWrapper.getInstance().getHistory().length, 3);
 139   entry = remoting.ConsoleWrapper.getInstance().getHistory()[2];
 140   assert.equal(entry.type, 'warn');
 141   assert.equal(entry.message, '["third",1,2,3]');
 142   assert.ok(entry.caller.startsWith(LOCATION_PREFIX));
 143   assert.equal(entry.timestamp.toGMTString(),'Thu, 01 Jan 1970 00:00:02 GMT');
 144
 145   this.clock.tick(1000);
 146   console.error('fourth', 1, 2, 3);
 147   assert.equal(remoting.ConsoleWrapper.getInstance().getHistory().length, 3);
 148   entry = remoting.ConsoleWrapper.getInstance().getHistory()[2];
 149   assert.equal(entry.type, 'error');
 150   assert.equal(entry.message, '["fourth",1,2,3]');
 151   assert.ok(entry.caller.startsWith(LOCATION_PREFIX));
 152   assert.equal(entry.timestamp.toGMTString(), 'Thu, 01 Jan 1970 00:00:03 GMT');
 153 });
 154
 155
 156 QUnit.test('calls to assert are saved only for failures.',
 157            function(assert)
 158 {
 159   remoting.ConsoleWrapper.getInstance().activate(
 160       2,
 161       remoting.ConsoleWrapper.LogType.ASSERT);
 162   console.assert(true, 'first', 1, 2, 3);
 163   this.clock.tick(1000);
 164   console.assert(false, 'second', 1, 2, 3);
 165   assert.equal(remoting.ConsoleWrapper.getInstance().getHistory().length, 1);
 166   var entry = remoting.ConsoleWrapper.getInstance().getHistory()[0];
 167   assert.equal(entry.type, 'assert');
 168   assert.equal(entry.message, '[false,"second",1,2,3]');
 169   assert.ok(entry.caller.startsWith(LOCATION_PREFIX));
 170   assert.equal(entry.timestamp.toGMTString(), 'Thu, 01 Jan 1970 00:00:01 GMT');
 171 });
 172
 173 })();