botbuilder-unit
Version:
Unit tests for chatbot dialogs
681 lines (680 loc) • 22.8 kB
HTML
<html lang="en">
<head>
<title>Code coverage report for botbuilder-unit/src/log-reporters/BeautyLogReporter.js</title>
<meta charset="utf-8" />
<link rel="stylesheet" href="../../../prettify.css" />
<link rel="stylesheet" href="../../../base.css" />
<meta name="viewport" content="width=device-width, initial-scale=1">
<style type='text/css'>
.coverage-summary .sorter {
background-image: url(../../../sort-arrow-sprite.png);
}
</style>
</head>
<body>
<div class='wrapper'>
<div class='pad1'>
<h1>
<a href="../../../index.html">All files</a> / <a href="index.html">botbuilder-unit/src/log-reporters</a> BeautyLogReporter.js
</h1>
<div class='clearfix'>
<div class='fl pad1y space-right2'>
<span class="strong">87.02% </span>
<span class="quiet">Statements</span>
<span class='fraction'>114/131</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">54.55% </span>
<span class="quiet">Branches</span>
<span class='fraction'>24/44</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">90.91% </span>
<span class="quiet">Functions</span>
<span class='fraction'>20/22</span>
</div>
<div class='fl pad1y space-right2'>
<span class="strong">87.02% </span>
<span class="quiet">Lines</span>
<span class='fraction'>114/131</span>
</div>
</div>
</div>
<div class='status-line high'></div>
<pre><table class="coverage">
<tr><td class="line-count quiet">1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206</td><td class="line-coverage quiet"><span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">21x</span>
<span class="cline-any cline-yes">21x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">12x</span>
<span class="cline-any cline-yes">12x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">8x</span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">8x</span>
<span class="cline-any cline-yes">8x</span>
<span class="cline-any cline-yes">8x</span>
<span class="cline-any cline-yes">8x</span>
<span class="cline-any cline-yes">8x</span>
<span class="cline-any cline-yes">8x</span>
<span class="cline-any cline-yes">8x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">59x</span>
<span class="cline-any cline-yes">13x</span>
<span class="cline-any cline-yes">13x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">59x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">13x</span>
<span class="cline-any cline-yes">13x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">13x</span>
<span class="cline-any cline-yes">13x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">13x</span>
<span class="cline-any cline-yes">13x</span>
<span class="cline-any cline-yes">13x</span>
<span class="cline-any cline-yes">16x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">13x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">16x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">16x</span>
<span class="cline-any cline-yes">18x</span>
<span class="cline-any cline-yes">18x</span>
<span class="cline-any cline-yes">16x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">18x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">18x</span>
<span class="cline-any cline-yes">18x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">2x</span>
<span class="cline-any cline-yes">2x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">7x</span>
<span class="cline-any cline-yes">7x</span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">7x</span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">7x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">7x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">3x</span>
<span class="cline-any cline-yes">3x</span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">3x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">3x</span>
<span class="cline-any cline-yes">3x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">2x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">2x</span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">2x</span>
<span class="cline-any cline-yes">2x</span>
<span class="cline-any cline-yes">2x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-no"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-yes">1x</span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-neutral"> </span>
<span class="cline-any cline-yes">1x</span></td><td class="text"><pre class="prettyprint lang-js">const BaseLogReporter = require('./BaseLogReporter');
const util = require('util');
const colors = require('colors');
const MIN_COLUMNS_PER_ROW = 40;
const EMPTY_FINAL_REPORT = {
firstErrorOnStep: false,
totalSteps: 0,
warnings: false
}
function BeautyLogReporter() {
this.columnsPerRow = 0;
this.contentColumnsPerRow = 0;
this.isLeftPaddingEnabled = false;
BaseLogReporter.call(this);
}
BeautyLogReporter.prototype = Object.create(BaseLogReporter.prototype);
BeautyLogReporter.prototype.constructor = BeautyLogReporter;
BeautyLogReporter.prototype.refreshDimensions = function (msg) {
this.columnsPerRow = Math.max(process.stdout.columns, MIN_COLUMNS_PER_ROW);
this.contentColumnsPerRow = Math.floor(2 / 3 * this.columnsPerRow);
}
BeautyLogReporter.prototype.normalizeOutput = function (message) {
let isObject = (message instanceof Object) || (<span class="branch-1 cbranch-no" title="branch not covered" >"function" == typeof message)</span>;;
return isObject ? util.inspect(message, {depth: 6, color: true, showHidden: true}) :<span class="branch-1 cbranch-no" title="branch not covered" >message;</span>
}
BeautyLogReporter.prototype.outputCentralized = function (msg, colorFunc) {
<span class="missing-if-branch" title="if path not taken" >I</span>if (!colorFunc) {
<span class="cstat-no" title="statement not covered" > colorFunc = colors.black;</span>
}
this.refreshDimensions(msg)
let offset1 = Math.floor((this.columnsPerRow - msg.length) / 2);
let offset2 = this.columnsPerRow - offset1 - msg.length;
let result = '='.repeat(offset1) + msg + '='.repeat(offset2);
console.log();
console.log(colorFunc(result));
console.log();
}
BeautyLogReporter.prototype.log = function (msg, colorFunc) {
if (this.isLeftPaddingEnabled) {
<span class="missing-if-branch" title="else path not taken" >E</span>if (this.columnsPerRow > msg.length) {
msg = ' '.repeat(this.columnsPerRow - msg.length) + msg;
}
}
console.log(colorFunc(msg));
}
BeautyLogReporter.prototype.getDate = function () {
let date = new Date();
return date.toTimeString().split(' ')[0];
}
BeautyLogReporter.prototype.outputMessageBox = function (step, msg, title, colorFunc) {
this.refreshDimensions(msg);
let lines = msg.split("\n");
this.log('#' + step + ' ' + this.getDate() + `, ${title}`, colors.black);
this.log(('+' + '-'.repeat(this.contentColumnsPerRow - 2) + '+'), colorFunc);
lines.forEach((item) => {
this.wrap(item, colorFunc);
})
this.log(('+' + '-'.repeat(this.contentColumnsPerRow - 2) + '+'), colorFunc);
}
BeautyLogReporter.prototype.wrap = function (msg, colorFunc) {
let moreThanOnce = false;
do {
let chunk = msg.substr(0, this.contentColumnsPerRow - 4);
if (chunk.length < this.contentColumnsPerRow - 4) {
chunk = chunk + ' '.repeat(this.contentColumnsPerRow - 4 - chunk.length);
} else {
}
chunk = '| ' + chunk + ' |';
msg = msg.substr(this.contentColumnsPerRow - 4);
this.log(chunk, colorFunc);
} while (msg.length > 0);
}
// ---------------------------------------------------------------------------------------------------------------------
// Base Reporter Inherited methods
BeautyLogReporter.prototype.newScript = function (messages, scriptName) {
this.finalReport = Object.assign({}, EMPTY_FINAL_REPORT);
<span class="missing-if-branch" title="if path not taken" >I</span>if (scriptName) {
<span class="cstat-no" title="statement not covered" > this.outputCentralized(`NEW SCRIPT: ${scriptName.toUpperCase()}`, colors.blue);</span>
}
this.finalReport.totalSteps = messages.length;
BaseLogReporter.prototype.newScript.call(this, messages);
}
BeautyLogReporter.prototype.scriptFinished = function () {
this.isLeftPaddingEnabled = false;
if (false !== this.finalReport.firstErrorOnStep) {
this.outputCentralized(' SCRIPT FINISHED WITH ERRORS ', colors.red);
this.log(`Completed / Total steps: ${this.finalReport.firstErrorOnStep}/${this.finalReport.totalSteps}`, colors.red)
} else <span class="missing-if-branch" title="if path not taken" >I</span>if (this.finalReport.warnings) {
<span class="cstat-no" title="statement not covered" > this.outputCentralized(' SCRIPT FINISHED WITH WARNINGS', colors.yellow);</span>
<span class="cstat-no" title="statement not covered" > this.log(`Completed / Total steps: ${this.finalReport.totalSteps}/${this.finalReport.totalSteps}`, colors.yellow);</span>
} else {
this.outputCentralized(' SCRIPT FINISHED SUCCESSFULLY', colors.green);
this.log(`Completed / Total steps: ${this.finalReport.totalSteps}/${this.finalReport.totalSteps}`, colors.green);
}
}
BeautyLogReporter.prototype.messageReceived = function (step, message) {
let outputMessage = this.normalizeOutput(message);
<span class="missing-if-branch" title="if path not taken" >I</span>if ( message.attachmentLayout ) {
<span class="cstat-no" title="statement not covered" > outputMessage += `\n-- attachmentLayout:${message.attachmentLayout}`</span>
}
<span class="missing-if-branch" title="if path not taken" >I</span>if ( message.attachments ) {
<span class="cstat-no" title="statement not covered" > outputMessage += `\n-- attachments:\n${util.inspect(message.attachments)}`</span>
}
//let outputMessage = this.normalizeOutput(message);
this.isLeftPaddingEnabled = false;
this.outputMessageBox(step, outputMessage, 'Bot wrote:', colors.blue);
}
BeautyLogReporter.prototype.endConversation = function (step) {
this.outputCentralized(` STEP #${step}, END OF CONVERSATION `, colors.blue);
}
BeautyLogReporter.prototype.typing = <span class="fstat-no" title="function not covered" >fu</span>nction (step) {
<span class="cstat-no" title="statement not covered" > this.outputCentralized(` STEP #${step}, TYPING ... `, colors.blue);</span>
}
BeautyLogReporter.prototype.messageSent = function (step, message) {
let outputMessage = '';
<span class="missing-if-branch" title="if path not taken" >I</span>if ("function" == typeof message.user) {
<span class="cstat-no" title="statement not covered" > outputMessage = message.user.toString();</span>
} else {
outputMessage = message.user ? message.user : <span class="branch-1 cbranch-no" title="branch not covered" >this.normalizeOutput(message);</span>
}
this.isLeftPaddingEnabled = true;
this.outputMessageBox(step, outputMessage, 'User wrote:', colors.green);
}
BeautyLogReporter.prototype.customStep = <span class="fstat-no" title="function not covered" >fu</span>nction (step, message) {
let outputMessage = <span class="cstat-no" title="statement not covered" >'';</span>
<span class="cstat-no" title="statement not covered" > if ("function" == typeof message.custom) {</span>
<span class="cstat-no" title="statement not covered" > outputMessage = message.custom.toString();</span>
} else {
<span class="cstat-no" title="statement not covered" > outputMessage = message.custom ? message.custom : this.normalizeOutput(message);</span>
}
<span class="cstat-no" title="statement not covered" > this.isLeftPaddingEnabled = true;</span>
<span class="cstat-no" title="statement not covered" > this.outputMessageBox(step, outputMessage, 'Custom Validation Step:', colors.yellow);</span>
}
BeautyLogReporter.prototype.expectationError = function (step, received, error ) {
<span class="missing-if-branch" title="else path not taken" >E</span>if (false === this.finalReport.firstErrorOnStep) {
this.finalReport.firstErrorOnStep = step;
this.finalReport.error = error;
}
this.outputCentralized(`EXPECTATION ERROR ON STEP #${step}`, colors.red);
this.error('Error:', error);
}
BeautyLogReporter.prototype.error = function (errorHeader, message) {
if (!this.finalReport.error) {
this.finalReport.error = message;
}
<span class="missing-if-branch" title="if path not taken" >I</span>if ( "undefined" == typeof errorHeader ) {
<span class="cstat-no" title="statement not covered" > errorHeader = 'ERROR';</span>
}
this.outputCentralized(errorHeader, colors.red);
console.log(colors.red(this.normalizeOutput(message)));
this.isLeftPaddingEnabled = false;
}
BeautyLogReporter.prototype.warning = function (warningHeader, message) {
this.finalReport.warnings = true;
<span class="missing-if-branch" title="if path not taken" >I</span>if ( "undefined" == typeof warningHeader ) {
<span class="cstat-no" title="statement not covered" > warningHeader = 'WARNING';</span>
}
this.outputCentralized(warningHeader, colors.yellow);
console.log(colors.yellow(message));
}
BeautyLogReporter.prototype.info = function (infoHeader, message ) {
<span class="missing-if-branch" title="if path not taken" >I</span>if ( "undefined" == typeof infoHeader ) {
<span class="cstat-no" title="statement not covered" > infoHeader = 'INFO';</span>
}
this.outputCentralized(infoHeader, colors.yellow);
console.log(colors.yellow(this.normalizeOutput(message)));
}
BeautyLogReporter.prototype.session = function (step, message) {
let output = {
userData : Object.assign({}, message.userData),
conversationData : Object.assign({}, message.conversationData),
privateConversationData : Object.assign({}, message.privateConversationData),
sessionState : Object.assign({}, message.sessionState)
}
output = this.normalizeOutput(output);
this.isLeftPaddingEnabled = false;
this.outputMessageBox(step, output, 'Session set:', colors.blue);
}
BeautyLogReporter.prototype.startupDialog = function (step, dialog, args) {
this.isLeftPaddingEnabled = false;
dialog = dialog || <span class="branch-1 cbranch-no" title="branch not covered" >'';</span>
args = args || <span class="branch-1 cbranch-no" title="branch not covered" >'';</span>
this.outputMessageBox(step, dialog, 'Next Dialog:', colors.blue);
this.outputMessageBox(step, this.normalizeOutput(args), 'ARGS Set:', colors.blue);
}
module.exports = BeautyLogReporter;</pre></td></tr>
</table></pre>
<div class='push'></div><!-- for sticky footer -->
</div><!-- /wrapper -->
<div class='footer quiet pad2 space-top1 center small'>
Code coverage
generated by <a href="https://istanbul.js.org/" target="_blank">istanbul</a> at Tue Feb 27 2018 06:41:45 GMT+0300 (+03)
</div>
</div>
<script src="../../../prettify.js"></script>
<script>
window.onload = function () {
if (typeof prettyPrint === 'function') {
prettyPrint();
}
};
</script>
<script src="../../../sorter.js"></script>
</body>
</html>