| 1 |
// Copyright 2017 The Closure Library Authors. All Rights Reserved. |
| 2 |
// |
| 3 |
// Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 |
// you may not use this file except in compliance with the License. |
| 5 |
// You may obtain a copy of the License at |
| 6 |
// |
| 7 |
// http://www.apache.org/licenses/LICENSE-2.0 |
| 8 |
// |
| 9 |
// Unless required by applicable law or agreed to in writing, software |
| 10 |
// distributed under the License is distributed on an "AS-IS" BASIS, |
| 11 |
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 |
// See the License for the specific language governing permissions and |
| 13 |
// limitations under the License. |
| 14 |
|
| 15 |
goog.provide('goog.debug.ConsoleTest'); |
| 16 |
goog.setTestOnly('goog.debug.ConsoleTest'); |
| 17 |
|
| 18 |
goog.require('goog.debug.Console'); |
| 19 |
goog.require('goog.debug.LogRecord'); |
| 20 |
goog.require('goog.debug.Logger'); |
| 21 |
goog.require('goog.testing.jsunit'); |
| 22 |
goog.require('goog.testing.recordFunction'); |
| 23 |
|
| 24 |
var debugConsole; |
| 25 |
var mockConsole; |
| 26 |
var loggerName1; |
| 27 |
var logRecord1; |
| 28 |
var loggerName2; |
| 29 |
var logRecord2; |
| 30 |
var loggerName3; |
| 31 |
var logRecord3; |
| 32 |
|
| 33 |
function setUp() { |
| 34 |
debugConsole = new goog.debug.Console(); |
| 35 |
|
| 36 |
// Set up a recorder for mockConsole.log |
| 37 |
mockConsole = {log: goog.testing.recordFunction()}; |
| 38 |
goog.debug.Console.console_ = mockConsole; |
| 39 |
|
| 40 |
// Test logger 1. |
| 41 |
loggerName1 = 'this.is.a.logger'; |
| 42 |
logRecord1 = new goog.debug.LogRecord( |
| 43 |
goog.debug.Logger.Level.INFO, 'this is a statement', loggerName1); |
| 44 |
|
| 45 |
// Test logger 2. |
| 46 |
loggerName2 = 'name.of.logger'; |
| 47 |
logRecord2 = new goog.debug.LogRecord( |
| 48 |
goog.debug.Logger.Level.WARNING, 'hey, this is a warning', loggerName2); |
| 49 |
|
| 50 |
// Test logger 3. |
| 51 |
loggerName3 = 'third.logger'; |
| 52 |
logRecord3 = new goog.debug.LogRecord( |
| 53 |
goog.debug.Logger.Level.SEVERE, 'seriously, this statement is serious', |
| 54 |
loggerName3); |
| 55 |
} |
| 56 |
|
| 57 |
function testLoggingWithSimpleConsole() { |
| 58 |
// Make sure all messages use the log function. |
| 59 |
logAtAllLevels('test message'); |
| 60 |
assertEquals(9, mockConsole.log.getCallCount()); |
| 61 |
} |
| 62 |
|
| 63 |
function testLoggingWithInfoSupported() { |
| 64 |
// Make sure the log function is the default when only 'info' is available. |
| 65 |
mockConsole['info'] = goog.testing.recordFunction(); |
| 66 |
logAtAllLevels('test message'); |
| 67 |
assertEquals(1, mockConsole.info.getCallCount()); |
| 68 |
assertEquals(8, mockConsole.log.getCallCount()); |
| 69 |
} |
| 70 |
|
| 71 |
function testLoggingWithErrorSupported() { |
| 72 |
// Make sure the log function is the default when only 'error' is available. |
| 73 |
mockConsole['error'] = goog.testing.recordFunction(); |
| 74 |
logAtAllLevels('test message'); |
| 75 |
assertEquals(1, mockConsole.error.getCallCount()); |
| 76 |
assertEquals(8, mockConsole.log.getCallCount()); |
| 77 |
} |
| 78 |
|
| 79 |
function testLoggingWithWarningSupported() { |
| 80 |
// Make sure the log function is the default when only 'warn' is available. |
| 81 |
mockConsole['warn'] = goog.testing.recordFunction(); |
| 82 |
logAtAllLevels('test message'); |
| 83 |
assertEquals(1, mockConsole.warn.getCallCount()); |
| 84 |
assertEquals(8, mockConsole.log.getCallCount()); |
| 85 |
} |
| 86 |
|
| 87 |
function testLoggingWithEverythingSupported() { |
| 88 |
mockConsole['info'] = goog.testing.recordFunction(); |
| 89 |
mockConsole['error'] = goog.testing.recordFunction(); |
| 90 |
mockConsole['warn'] = goog.testing.recordFunction(); |
| 91 |
mockConsole['log'] = goog.testing.recordFunction(); |
| 92 |
logAtAllLevels('test message'); |
| 93 |
assertEquals(1, mockConsole.info.getCallCount()); |
| 94 |
assertEquals(1, mockConsole.error.getCallCount()); |
| 95 |
assertEquals(1, mockConsole.warn.getCallCount()); |
| 96 |
assertEquals(6, mockConsole.log.getCallCount()); |
| 97 |
} |
| 98 |
|
| 99 |
function testAddLogRecordWithoutFilters() { |
| 100 |
// Make sure none are filtered. |
| 101 |
debugConsole.addLogRecord(logRecord1); |
| 102 |
assertEquals(1, mockConsole.log.getCallCount()); |
| 103 |
debugConsole.addLogRecord(logRecord2); |
| 104 |
assertEquals(2, mockConsole.log.getCallCount()); |
| 105 |
debugConsole.addLogRecord(logRecord3); |
| 106 |
assertEquals(3, mockConsole.log.getCallCount()); |
| 107 |
} |
| 108 |
|
| 109 |
function testAddLogRecordWithOneFilter() { |
| 110 |
// Filter #2 and make sure the filtering is correct for all records. |
| 111 |
debugConsole.addFilter(loggerName2); |
| 112 |
debugConsole.addLogRecord(logRecord1); |
| 113 |
assertEquals(1, mockConsole.log.getCallCount()); |
| 114 |
debugConsole.addLogRecord(logRecord2); |
| 115 |
assertEquals(1, mockConsole.log.getCallCount()); |
| 116 |
debugConsole.addLogRecord(logRecord3); |
| 117 |
assertEquals(2, mockConsole.log.getCallCount()); |
| 118 |
} |
| 119 |
|
| 120 |
function testAddLogRecordWithMoreThanOneFilter() { |
| 121 |
// Filter #1 and #3 and check. |
| 122 |
debugConsole.addFilter(loggerName1); |
| 123 |
debugConsole.addFilter(loggerName3); |
| 124 |
debugConsole.addLogRecord(logRecord1); |
| 125 |
assertEquals(0, mockConsole.log.getCallCount()); |
| 126 |
debugConsole.addLogRecord(logRecord2); |
| 127 |
assertEquals(1, mockConsole.log.getCallCount()); |
| 128 |
debugConsole.addLogRecord(logRecord3); |
| 129 |
assertEquals(1, mockConsole.log.getCallCount()); |
| 130 |
} |
| 131 |
|
| 132 |
function testAddLogRecordWithAddAndRemoveFilter() { |
| 133 |
debugConsole.addFilter(loggerName1); |
| 134 |
debugConsole.addFilter(loggerName2); |
| 135 |
debugConsole.removeFilter(loggerName1); |
| 136 |
debugConsole.removeFilter(loggerName2); |
| 137 |
debugConsole.addLogRecord(logRecord1); |
| 138 |
assertEquals(1, mockConsole.log.getCallCount()); |
| 139 |
debugConsole.addLogRecord(logRecord2); |
| 140 |
assertEquals(2, mockConsole.log.getCallCount()); |
| 141 |
debugConsole.addLogRecord(logRecord3); |
| 142 |
assertEquals(3, mockConsole.log.getCallCount()); |
| 143 |
} |
| 144 |
|
| 145 |
function testSetConsole() { |
| 146 |
var fakeConsole = {log: goog.testing.recordFunction()}; |
| 147 |
|
| 148 |
logAtLevel(goog.debug.Logger.Level.INFO, 'test message 1'); |
| 149 |
logAtAllLevels('test message 1'); |
| 150 |
assertEquals(0, fakeConsole.log.getCallCount()); |
| 151 |
|
| 152 |
goog.debug.Console.setConsole(fakeConsole); |
| 153 |
|
| 154 |
logAtLevel(goog.debug.Logger.Level.INFO, 'test message 2'); |
| 155 |
assertEquals(1, fakeConsole.log.getCallCount()); |
| 156 |
} |
| 157 |
|
| 158 |
|
| 159 |
/** |
| 160 |
* Logs the message at all log levels. |
| 161 |
* @param {string} message The message to log. |
| 162 |
*/ |
| 163 |
function logAtAllLevels(message) { |
| 164 |
logAtLevel(goog.debug.Logger.Level.SHOUT, message); |
| 165 |
logAtLevel(goog.debug.Logger.Level.SEVERE, message); |
| 166 |
logAtLevel(goog.debug.Logger.Level.WARNING, message); |
| 167 |
logAtLevel(goog.debug.Logger.Level.INFO, message); |
| 168 |
logAtLevel(goog.debug.Logger.Level.CONFIG, message); |
| 169 |
logAtLevel(goog.debug.Logger.Level.FINE, message); |
| 170 |
logAtLevel(goog.debug.Logger.Level.FINER, message); |
| 171 |
logAtLevel(goog.debug.Logger.Level.FINEST, message); |
| 172 |
logAtLevel(goog.debug.Logger.Level.ALL, message); |
| 173 |
} |
| 174 |
|
| 175 |
|
| 176 |
/** |
| 177 |
* Adds a log record to the debug console. |
| 178 |
* @param {!goog.debug.Logger.Level} level The level at which to log. |
| 179 |
* @param {string} message The message to log. |
| 180 |
*/ |
| 181 |
function logAtLevel(level, message) { |
| 182 |
debugConsole.addLogRecord( |
| 183 |
new goog.debug.LogRecord(level, message, loggerName1)); |
| 184 |
} |