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
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
|
/*!
* Piwik - Web Analytics
*
* chai assertion extensions
*
* @link http://piwik.org
* @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
*/
var fs = require('fs'),
PageRenderer = require('./page-renderer.js').PageRenderer,
AssertionError = chai.AssertionError;
// add screenshot keyword to `expect`
expect.screenshot = function (file, prefix) {
if (!prefix) {
prefix = app.runner.suite.title; // note: runner is made global by run-tests.js
}
return chai.expect(prefix + '_' + file);
};
// add page keyword to `expect`
expect.page = function (url) {
return chai.expect(url);
};
expect.current_page = expect.page(null);
function getPageLogsString(pageLogs, indent) {
var result = "";
if (pageLogs.length) {
result = "\n\n" + indent + "Rendering logs:\n";
pageLogs.forEach(function (message) {
result += indent + " " + message.replace(/\n/g, "\n" + indent + " ") + "\n";
});
result = result.substring(0, result.length - 1);
}
return result;
}
// add capture assertion
var pageRenderer = new PageRenderer(path.join(config.piwikUrl, "tests", "PHPUnit", "proxy"));
function capture(screenName, compareAgainst, selector, pageSetupFn, done) {
if (!(done instanceof Function)) {
throw new Error("No 'done' callback specified in capture assertion.");
}
var screenshotFileName = screenName + '.png',
dirsBase = app.runner.suite.baseDirectory,
expectedScreenshotDir = path.join(dirsBase, config.expectedScreenshotsDir),
expectedScreenshotPath = path.join(expectedScreenshotDir, compareAgainst + '.png'),
processedScreenshotDir = path.join(options['store-in-ui-tests-repo'] ? uiTestsDir : dirsBase, config.processedScreenshotsDir),
processedScreenshotPath = path.join(processedScreenshotDir, screenshotFileName),
screenshotDiffDir = path.join(options['store-in-ui-tests-repo'] ? uiTestsDir : dirsBase, config.screenshotDiffDir);
if (!fs.isDirectory(processedScreenshotDir)) {
fs.makeTree(processedScreenshotDir);
}
if (!fs.isDirectory(screenshotDiffDir)) {
fs.makeTree(screenshotDiffDir);
}
pageSetupFn(pageRenderer);
try {
pageRenderer.capture(processedScreenshotPath, function (err) {
if (err) {
var indent = " ";
err.stack = err.message + "\n" + indent + getPageLogsString(pageRenderer.pageLogs, indent);
done(err);
return;
}
var testInfo = {
name: screenName,
processed: fs.isFile(processedScreenshotPath) ? processedScreenshotPath : null,
expected: fs.isFile(expectedScreenshotPath) ? expectedScreenshotPath : null,
baseDirectory: dirsBase
};
var fail = function (message) {
app.diffViewerGenerator.failures.push(testInfo);
var expectedPath = testInfo.expected ? path.resolve(testInfo.expected) : "",
processedPath = testInfo.processed ? path.resolve(testInfo.processed) : "";
var indent = " ";
var failureInfo = message + "\n";
failureInfo += indent + "Url to reproduce: " + pageRenderer.getCurrentUrl() + "\n";
failureInfo += indent + "Generated screenshot: " + processedPath + "\n";
failureInfo += indent + "Expected screenshot: " + expectedPath + "\n";
failureInfo += getPageLogsString(pageRenderer.pageLogs, indent);
error = new AssertionError(message);
// stack traces are useless so we avoid the clutter w/ this
error.stack = failureInfo;
done(error);
};
var pass = function () {
if (options['print-logs']) {
console.log(getPageLogsString(pageRenderer.pageLogs, " "));
}
done();
};
if (!testInfo.processed) {
fail("Failed to generate screenshot to " + screenshotFileName + ".");
return;
}
if (!testInfo.expected) {
fail("No expected screenshot found for " + screenshotFileName + ".");
return;
}
var expected = fs.read(expectedScreenshotPath),
processed = fs.read(processedScreenshotPath);
if (processed == expected) {
pass();
return;
}
// if the files are not exact, perform a diff to check if they are truly different
resemble("file://" + processedScreenshotPath).compareTo("file://" + expectedScreenshotPath).onComplete(function(data) {
if (data.misMatchPercentage != 0) {
fail("Processed screenshot does not match expected for " + screenshotFileName + ".");
return;
}
pass();
});
}, selector);
} catch (ex) {
var err = new Error(ex.message);
err.stack = ex.message;
done(err);
}
}
chai.Assertion.addChainableMethod('captureSelector', function () {
var compareAgainst = this.__flags['object'];
if (arguments.length == 3) {
var screenName = compareAgainst,
selector = arguments[0],
pageSetupFn = arguments[1],
done = arguments[2];
} else {
var screenName = app.runner.suite.title + "_" + arguments[0],
selector = arguments[1],
pageSetupFn = arguments[2],
done = arguments[3];
}
capture(screenName, compareAgainst, selector, pageSetupFn, done);
});
chai.Assertion.addChainableMethod('capture', function () {
var compareAgainst = this.__flags['object'];
if (arguments.length == 2) {
var screenName = compareAgainst,
pageSetupFn = arguments[0],
done = arguments[1];
} else {
var screenName = app.runner.suite.title + "_" + arguments[0],
pageSetupFn = arguments[1],
done = arguments[2];
}
capture(screenName, compareAgainst, null, pageSetupFn, done);
});
// add `contains` assertion
chai.Assertion.addChainableMethod('contains', function () {
var url = this.__flags['object'],
elementSelector = arguments[0],
pageSetupFn = arguments[1],
done = arguments[2];
if (url
&& pageRenderer.getCurrentUrl() != url
) {
pageRenderer.load(url);
}
pageSetupFn(pageRenderer);
if (!(done instanceof Function)) {
throw new Error("No 'done' callback specified in 'contains' assertion.");
}
pageRenderer.capture(null, function (err) {
if (err) {
var indent = " ";
err.stack = err.message + "\n" + indent + getPageLogsString(pageRenderer.pageLogs, indent);
done(err);
return;
}
if (!pageRenderer.contains(elementSelector)) {
var error = new AssertionError("Page does not contain element '" + elementSelector + "'.");
error.stack = getPageLogsString(pageRenderer.pageLogs, indent);
done(error);
} else {
done();
}
});
});
|