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
|
/* -*- indent-tabs-mode: nil; js-indent-level: 2 -*-*/
/* vim: set ts=8 sts=2 et sw=2 tw=80: */
/* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this file,
* You can obtain one at http://mozilla.org/MPL/2.0/. */
"use strict";
const { FileUtils } = ChromeUtils.importESModule(
"resource://gre/modules/FileUtils.sys.mjs"
);
// The xpcshell test harness sets PYTHON so we can read it here.
var gPythonName = Services.env.get("PYTHON");
// If we're testing locally, the executable file is in "CurProcD". Otherwise,
// it is in another location that we have to find.
function getExecutable(aFilename) {
let file = FileUtils.getFile("CurProcD", [aFilename]);
if (!file.exists()) {
file = FileUtils.getFile("CurWorkD", []);
while (file.path.includes("xpcshell")) {
file = file.parent;
}
file.append("bin");
file.append(aFilename);
}
return file;
}
var gIsWindows = Services.appinfo.OS === "WINNT";
var gDmdTestFile = getExecutable("SmokeDMD" + (gIsWindows ? ".exe" : ""));
var gDmdScriptFile = getExecutable("dmd.py");
var gScanTestFile = FileUtils.getFile("CurWorkD", ["scan-test.py"]);
function readFile(aFile) {
let fstream = Cc["@mozilla.org/network/file-input-stream;1"].createInstance(
Ci.nsIFileInputStream
);
let cstream = Cc["@mozilla.org/intl/converter-input-stream;1"].createInstance(
Ci.nsIConverterInputStream
);
fstream.init(aFile, -1, 0, 0);
cstream.init(fstream, "UTF-8", 0, 0);
let data = "";
let str = {};
let read = 0;
do {
// Read as much as we can and put it in str.value.
read = cstream.readString(0xffffffff, str);
data += str.value;
} while (read != 0);
cstream.close(); // this closes fstream
return data.replace(/\r/g, ""); // normalize line endings
}
function runProcess(aExeFile, aArgs) {
let process = Cc["@mozilla.org/process/util;1"].createInstance(Ci.nsIProcess);
process.init(aExeFile);
process.run(/* blocking = */ true, aArgs, aArgs.length);
return process.exitValue;
}
function test(aPrefix, aArgs) {
// DMD writes the JSON files to CurWorkD, so we do likewise here with
// |actualFile| for consistency. It is removed once we've finished.
let expectedFile = FileUtils.getFile("CurWorkD", [aPrefix + "-expected.txt"]);
let actualFile = FileUtils.getFile("CurWorkD", [aPrefix + "-actual.txt"]);
// Run dmd.py on the JSON file, producing |actualFile|.
let args = [
gDmdScriptFile.path,
"--filter-stacks-for-testing",
"-o",
actualFile.path,
].concat(aArgs);
runProcess(new FileUtils.File(gPythonName), args);
// Compare |expectedFile| with |actualFile|. We produce nice diffs with
// /usr/bin/diff on systems that have it (Mac and Linux). Otherwise (Windows)
// we do a string compare of the file contents and then print them both if
// they don't match.
let success;
try {
let rv = runProcess(new FileUtils.File("/usr/bin/diff"), [
"-u",
expectedFile.path,
actualFile.path,
]);
success = rv == 0;
} catch (e) {
let expectedData = readFile(expectedFile);
let actualData = readFile(actualFile);
success = expectedData === actualData;
if (!success) {
expectedData = expectedData.split("\n");
actualData = actualData.split("\n");
for (let i = 0; i < expectedData.length; i++) {
print("EXPECTED:" + expectedData[i]);
}
for (let i = 0; i < actualData.length; i++) {
print(" ACTUAL:" + actualData[i]);
}
}
}
ok(success, aPrefix);
actualFile.remove(true);
}
// Run scan-test.py on the JSON file and see if it succeeds.
function scanTest(aJsonFilePath, aExtraArgs) {
let args = [gScanTestFile.path, aJsonFilePath].concat(aExtraArgs);
return runProcess(new FileUtils.File(gPythonName), args) == 0;
}
function run_test() {
let jsonFile, jsonFile2;
// These tests do complete end-to-end testing of DMD, i.e. both the C++ code
// that generates the JSON output, and the script that post-processes that
// output.
//
// Run these synchronously, because test() updates the complete*.json files
// in-place (to fix stacks) when it runs dmd.py, and that's not safe to do
// asynchronously.
Services.env.set("DMD", "1");
runProcess(gDmdTestFile, []);
function test2(aTestName, aMode) {
let name = "complete-" + aTestName + "-" + aMode;
jsonFile = FileUtils.getFile("CurWorkD", [name + ".json"]);
test(name, [jsonFile.path]);
jsonFile.remove(true);
}
// Please keep this in sync with RunTests() in SmokeDMD.cpp.
test2("empty", "live");
test2("empty", "dark-matter");
test2("empty", "cumulative");
test2("full1", "live");
test2("full1", "dark-matter");
test2("full2", "dark-matter");
test2("full2", "cumulative");
test2("partial", "live");
// Heap scan testing.
jsonFile = FileUtils.getFile("CurWorkD", ["basic-scan.json"]);
ok(scanTest(jsonFile.path), "Basic scan test");
let is64Bit = Services.appinfo.is64Bit;
let basicScanFileName = "basic-scan-" + (is64Bit ? "64" : "32");
test(basicScanFileName, ["--clamp-contents", jsonFile.path]);
ok(
scanTest(jsonFile.path, ["--clamp-contents"]),
"Scan with address clamping"
);
// Run the generic test a second time to ensure that the first time produced
// valid JSON output. "--clamp-contents" is passed in so we don't have to have
// more variants of the files.
test(basicScanFileName, ["--clamp-contents", jsonFile.path]);
jsonFile.remove(true);
// These tests only test the post-processing script. They use hand-written
// JSON files as input. Ideally the JSON files would contain comments
// explaining how they work, but JSON doesn't allow comments, so I've put
// explanations here.
// This just tests that stack traces of various lengths are truncated
// appropriately. The number of records in the output is different for each
// of the tested values.
jsonFile = FileUtils.getFile("CurWorkD", ["script-max-frames.json"]);
test("script-max-frames-8", [jsonFile.path]); // --max-frames=8 is the default
test("script-max-frames-3", [
"--max-frames=3",
"--no-fix-stacks",
jsonFile.path,
]);
test("script-max-frames-1", ["--max-frames=1", jsonFile.path]);
// This file has three records that are shown in a different order for each
// of the different sort values. It also tests the handling of gzipped JSON
// files.
jsonFile = FileUtils.getFile("CurWorkD", ["script-sort-by.json.gz"]);
test("script-sort-by-usable", ["--sort-by=usable", jsonFile.path]);
test("script-sort-by-req", [
"--sort-by=req",
"--no-fix-stacks",
jsonFile.path,
]);
test("script-sort-by-slop", ["--sort-by=slop", jsonFile.path]);
test("script-sort-by-num-blocks", ["--sort-by=num-blocks", jsonFile.path]);
// This file has several real stack traces taken from Firefox execution, each
// of which tests a different allocator function (or functions).
jsonFile = FileUtils.getFile("CurWorkD", ["script-ignore-alloc-fns.json"]);
test("script-ignore-alloc-fns", ["--ignore-alloc-fns", jsonFile.path]);
// This tests "live"-mode diffs.
jsonFile = FileUtils.getFile("CurWorkD", ["script-diff-live1.json"]);
jsonFile2 = FileUtils.getFile("CurWorkD", ["script-diff-live2.json"]);
test("script-diff-live", [jsonFile.path, jsonFile2.path]);
// This tests "dark-matter"-mode diffs.
jsonFile = FileUtils.getFile("CurWorkD", ["script-diff-dark-matter1.json"]);
jsonFile2 = FileUtils.getFile("CurWorkD", ["script-diff-dark-matter2.json"]);
test("script-diff-dark-matter", [jsonFile.path, jsonFile2.path]);
}
|
