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
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
|
/* 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/. */
const path = require("path");
const webpack = require("webpack");
const { ResourceUriPlugin } = require("../newtab/tools/resourceUriPlugin");
const PATHS = {
// Where is the entry point for the unit tests?
testEntryFile: path.resolve(__dirname, "./tests/unit/unit-entry.js"),
// A glob-style pattern matching all unit tests
testFilesPattern: "./tests/unit/unit-entry.js",
// The base directory of all source files (used for path resolution in webpack importing)
moduleResolveDirectory: __dirname,
newtabResolveDirectory: "../newtab",
// a RegEx matching all Cu.import statements of local files
resourcePathRegEx: /^resource:\/\/activity-stream\//,
coverageReportingPath: "logs/coverage/",
};
// When tweaking here, be sure to review the docs about the execution ordering
// semantics of the preprocessors array, as they are somewhat odd.
const preprocessors = {};
preprocessors[PATHS.testFilesPattern] = [
"webpack", // require("karma-webpack")
"sourcemap", // require("karma-sourcemap-loader")
];
module.exports = function (config) {
const isTDD = config.tdd;
const browsers = isTDD ? ["Firefox"] : ["FirefoxHeadless"]; // require("karma-firefox-launcher")
config.set({
singleRun: !isTDD,
browsers,
customLaunchers: {
FirefoxHeadless: {
base: "Firefox",
flags: ["--headless"],
},
},
frameworks: [
"chai", // require("chai") require("karma-chai")
"mocha", // require("mocha") require("karma-mocha")
"sinon", // require("sinon") require("karma-sinon")
],
reporters: [
"coverage-istanbul", // require("karma-coverage")
"mocha", // require("karma-mocha-reporter")
// for bin/try-runner.js to parse the output easily
"json", // require("karma-json-reporter")
],
jsonReporter: {
// So this doesn't get interleaved with other karma output
stdout: false,
outputFile: path.join("logs", "karma-run-results.json"),
},
coverageIstanbulReporter: {
reports: ["lcov", "text-summary"], // for some reason "lcov" reallys means "lcov" and "html"
"report-config": {
// so the full m-c path gets printed; needed for https://coverage.moz.tools/ integration
lcov: {
projectRoot: "../../..",
},
},
dir: PATHS.coverageReportingPath,
// This will make karma fail if coverage reporting is less than the minimums here
thresholds: !isTDD && {
each: {
statements: 80,
lines: 80,
functions: 80,
branches: 80,
overrides: {
"modules/AboutWelcomeDefaults.sys.mjs": {
statements: 48.15,
lines: 48.75,
functions: 61.54,
branches: 37.04,
},
"content-src/lib/aboutwelcome-utils.mjs": {
statements: 73.68,
lines: 73.68,
functions: 71.43,
branches: 66.67,
},
"content-src/components/LanguageSwitcher.jsx": {
// This file is covered by the mochitest: browser_aboutwelcome_multistage_languageSwitcher.js
statements: 0,
lines: 0,
functions: 0,
branches: 0,
},
"content-src/components/EmbeddedMigrationWizard.jsx": {
// This file is covered by the mochitest: browser_aboutwelcome_multistage_mr.js
// Can't be unit tested because it relies on the migration-wizard custom element
statements: 0,
lines: 0,
functions: 0,
branches: 0,
},
"content-src/components/AddonsPicker.jsx": {
// This file is covered by the mochitest: browser_aboutwelcome_multistage_addonspicker.js
statements: 0,
lines: 0,
functions: 0,
branches: 0,
},
"content-src/components/SubmenuButton.jsx": {
// Enzyme can't test this file because it relies on XUL elements
// and JS events, which Enzyme can't simulate. Browser tests are
// in browser_feature_callout_panel.js
statements: 0,
lines: 0,
functions: 0,
branches: 0,
},
"content-src/components/MSLocalized.jsx": {
statements: 77.42,
lines: 77.42,
functions: 75,
branches: 73.08,
},
"content-src/components/CTAParagraph.jsx": {
functions: 50,
branches: 75,
},
"content-src/components/HeroImage.jsx": {
branches: 62.5,
},
"content-src/components/LinkParagraph.jsx": {
functions: 75,
branches: 37.5,
},
"content-src/components/MRColorways.jsx": {
statements: 76.09,
lines: 75,
functions: 76.92,
branches: 74.07,
},
"content-src/components/MobileDownloads.jsx": {
branches: 56.25,
},
"content-src/components/Themes.jsx": {
branches: 50,
},
"content-src/components/MultiStageAboutWelcome.jsx": {
statements: 78.06,
lines: 79.89,
functions: 73.17,
branches: 61.74,
},
"content-src/components/AdditionalCTA.jsx": {
branches: 75,
},
"content-src/components/MultiStageProtonScreen.jsx": {
branches: 79.07,
},
},
},
},
},
files: [PATHS.testEntryFile],
preprocessors,
webpack: {
mode: "none",
devtool: "inline-source-map",
// This resolve config allows us to import with paths relative to the root directory
resolve: {
extensions: [".js", ".jsx"],
modules: [
PATHS.moduleResolveDirectory,
"node_modules",
PATHS.newtabResolveDirectory,
],
alias: {
newtab: path.join(__dirname, "../newtab"),
asrouter: path.join(__dirname, "../asrouter"),
},
},
plugins: [
// The ResourceUriPlugin handles translating resource URIs in import
// statements in .mjs files to paths on the filesystem.
new ResourceUriPlugin({
resourcePathRegExes: [
[
new RegExp("^resource://activity-stream/"),
path.join(__dirname, "../newtab/"),
],
[
new RegExp("^resource:///modules/asrouter/"),
path.join(__dirname, "../asrouter/modules/"),
],
],
}),
new webpack.DefinePlugin({
"process.env.NODE_ENV": JSON.stringify("development"),
}),
],
externals: {
// enzyme needs these for backwards compatibility with 0.13.
// see https://github.com/airbnb/enzyme/blob/master/docs/guides/webpack.md#using-enzyme-with-webpack
"react/addons": true,
"react/lib/ReactContext": true,
"react/lib/ExecutionEnvironment": true,
},
module: {
rules: [
{
test: /\.js$/,
exclude: [/node_modules\/(?!@fluent\/).*/, /tests/],
loader: "babel-loader",
},
{
test: /\.jsx$/,
exclude: /node_modules/,
loader: "babel-loader",
options: {
presets: ["@babel/preset-react"],
},
},
{
test: /\.md$/,
use: "raw-loader",
},
{
enforce: "post",
test: /\.m?js[mx]?$/,
loader: "@jsdevtools/coverage-istanbul-loader",
options: { esModules: true },
include: [path.resolve("content-src"), path.resolve("modules")],
exclude: [path.resolve("tests"), path.resolve("../newtab")],
},
],
},
},
// Silences some overly-verbose logging of individual module builds
webpackMiddleware: { noInfo: true },
});
};
|
