Source code
Revision control
Copy as Markdown
Other Tools
/* 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,
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": {
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/EmbeddedBrowser.jsx": {
// Enzyme can't test this file because it relies on XUL elements
// which Enzyme can't simulate. Browser tests are in
// browser_aboutwelcome_embedded_browser.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: [
[
path.join(__dirname, "../newtab/"),
],
[
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 },
});
};