.eslintrc-test-paths.js

   1 /* This Source Code Form is subject to the terms of the Mozilla Public
   2  * License, v. 2.0. If a copy of the MPL was not distributed with this
   3  * file, You can obtain one at http://mozilla.org/MPL/2.0/. */
   4
   5 "use strict";
   6
   7 /* eslint-env node */
   8
   9 // The `*testPaths` defined below for test paths are the main path formats we
  10 // prefer to support for tests as they are commonly used across the tree.
  11
  12 // We prefer the tests to be in named directories as this makes it easier
  13 // to identify the types of tests developers are working with. Additionally,
  14 // it is not possible to scope ESLint rules to individual files based on .ini
  15 // files without a build step that would break editors, or an expensive loading
  16 // cycle.
  17
  18 // Please do not add more cases of multiple test types in a single
  19 // directory. This may cause ESLint rules to be incorrectly applied to the wrong
  20 // tests, leading to false negatives. It could cause the wrong sets of globals
  21 // to be defined in the scope, causing false positives when checking for no
  22 // undefined variables.
  23
  24 // See https://firefox-source-docs.mozilla.org/code-quality/lint/linters/eslint.html#i-m-adding-tests-how-do-i-set-up-the-right-configuration
  25 // for more information.
  26
  27 const browserTestPaths = ["**/test*/**/browser*/"];
  28
  29 const chromeTestPaths = ["**/test*/chrome/"];
  30
  31 const mochitestTestPaths = [
  32   // Note: we do not want to match testing/mochitest as that would apply
  33   // too many globals for that directory.
  34   "**/test/mochitest*/",
  35   "**/tests/mochitest*/",
  36   "testing/mochitest/tests/SimpleTest/",
  37   "testing/mochitest/tests/Harness_sanity/",
  38 ];
  39
  40 const xpcshellTestPaths = [
  41   "**/test*/unit*/**/",
  42   "**/test*/*/unit*/",
  43   "**/test*/xpcshell/**/",
  44 ];
  45
  46 // NOTE: Before adding to the list below, please see the note at the top
  47 // of the file.
  48
  49 const extraXpcshellTestPaths = [
  50   "devtools/platform/tests/xpcshell/",
  51   "dom/file/tests/",
  52   "dom/ipc/tests/",
  53   "intl/benchmarks/",
  54   "intl/l10n/test/",
  55   "ipc/testshell/tests/",
  56   "memory/replace/dmd/test/",
  57   "netwerk/test/httpserver/test/",
  58   "testing/modules/tests/xpcshell/",
  59   "toolkit/components/backgroundhangmonitor/tests/",
  60   "toolkit/components/downloads/test/data/",
  61   "toolkit/components/mozintl/test/",
  62   "toolkit/components/places/tests/",
  63   "toolkit/components/places/tests/bookmarks/",
  64   "toolkit/components/places/tests/expiration/",
  65   "toolkit/components/places/tests/favicons/",
  66   "toolkit/components/places/tests/history/",
  67   "toolkit/components/places/tests/legacy/",
  68   "toolkit/components/places/tests/migration/",
  69   "toolkit/components/places/tests/queries/",
  70   "toolkit/components/thumbnails/test/",
  71   "toolkit/modules/tests/modules/",
  72   "toolkit/mozapps/update/tests/data/",
  73   "toolkit/profile/xpcshell/",
  74   "toolkit/xre/test/",
  75   "widget/headless/tests/",
  76 ];
  77
  78 // NOTE: Before adding to the list below, please see the note at the top
  79 // of the file.
  80
  81 const extraBrowserTestPaths = [
  82   "dom/ipc/tests/",
  83   "toolkit/components/thumbnails/test/",
  84   "toolkit/xre/test/",
  85   "browser/base/content/test/about/",
  86   "browser/base/content/test/alerts/",
  87   "browser/base/content/test/backforward/",
  88   "browser/base/content/test/caps/",
  89   "browser/base/content/test/captivePortal/",
  90   "browser/base/content/test/contentTheme/",
  91   "browser/base/content/test/contextMenu/",
  92   "browser/base/content/test/favicons/",
  93   "browser/base/content/test/forms/",
  94   "browser/base/content/test/fullscreen/",
  95   "browser/base/content/test/general/",
  96   "browser/base/content/test/gesture/",
  97   "browser/base/content/test/historySwipeAnimation/",
  98   "browser/base/content/test/keyboard/",
  99   "browser/base/content/test/menubar/",
 100   "browser/base/content/test/metaTags/",
 101   "browser/base/content/test/notificationbox/",
 102   "browser/base/content/test/outOfProcess/",
 103   "browser/base/content/test/pageActions/",
 104   "browser/base/content/test/pageStyle/",
 105   "browser/base/content/test/pageinfo/",
 106   "browser/base/content/test/performance/",
 107   "browser/base/content/test/permissions/",
 108   "browser/base/content/test/plugins/",
 109   "browser/base/content/test/popupNotifications/",
 110   "browser/base/content/test/popups/",
 111   "browser/base/content/test/protectionsUI/",
 112   "browser/base/content/test/referrer/",
 113   "browser/base/content/test/sanitize/",
 114   "browser/base/content/test/sidebar/",
 115   "browser/base/content/test/siteIdentity/",
 116   "browser/base/content/test/startup/",
 117   "browser/base/content/test/static/",
 118   "browser/base/content/test/statuspanel/",
 119   "browser/base/content/test/sync/",
 120   "browser/base/content/test/tabMediaIndicator/",
 121   "browser/base/content/test/tabPrompts/",
 122   "browser/base/content/test/tabcrashed/",
 123   "browser/base/content/test/tabdialogs/",
 124   "browser/base/content/test/tabs/",
 125   "browser/base/content/test/touch/",
 126   "browser/base/content/test/utilityOverlay/",
 127   "browser/base/content/test/webextensions/",
 128   "browser/base/content/test/webrtc/",
 129   "browser/base/content/test/zoom/",
 130   "browser/components/customizableui/test/",
 131   "browser/components/pocket/test/",
 132   "browser/components/preferences/tests/",
 133   "browser/components/safebrowsing/content/test/",
 134   "browser/components/sessionstore/test/",
 135   "browser/components/shell/test/",
 136   "browser/components/touchbar/tests/",
 137   "browser/components/translation/test/",
 138   "browser/components/uitour/test/",
 139   "browser/extensions/report-site-issue/test/browser/",
 140   "browser/tools/mozscreenshots/",
 141   "caps/tests/mochitest/",
 142   "devtools/client/debugger/test/mochitest/",
 143   "devtools/client/dom/test/",
 144   "devtools/client/framework/browser-toolbox/test/",
 145   "devtools/client/framework/test/",
 146   "devtools/client/inspector/animation/test/",
 147   "devtools/client/inspector/boxmodel/test/",
 148   "devtools/client/inspector/changes/test/",
 149   "devtools/client/inspector/computed/test/",
 150   "devtools/client/inspector/extensions/test/",
 151   "devtools/client/inspector/flexbox/test/",
 152   "devtools/client/inspector/fonts/test/",
 153   "devtools/client/inspector/grids/test/",
 154   "devtools/client/inspector/markup/test/",
 155   "devtools/client/inspector/rules/test/",
 156   "devtools/client/inspector/shared/test/",
 157   "devtools/client/inspector/test/",
 158   "devtools/client/jsonview/test/",
 159   "devtools/client/memory/test/browser/",
 160   "devtools/client/netmonitor/src/har/test/",
 161   "devtools/client/netmonitor/test/",
 162   "devtools/client/shared/sourceeditor/test/",
 163   "devtools/client/shared/test/",
 164   "devtools/client/storage/test/",
 165   "devtools/client/styleeditor/test/",
 166   "devtools/shared/commands/inspected-window/tests/",
 167   "devtools/shared/commands/inspector/tests/",
 168   "devtools/shared/commands/resource/tests/",
 169   "devtools/shared/commands/script/tests/",
 170   "devtools/shared/commands/target-configuration/tests/",
 171   "devtools/shared/commands/target/tests/",
 172   "devtools/shared/commands/thread-configuration/tests/",
 173   "devtools/shared/test-helpers/",
 174   "docshell/test/navigation/",
 175   "dom/base/test/",
 176   "dom/broadcastchannel/tests/",
 177   "dom/events/test/",
 178   "dom/fetch/tests/",
 179   "dom/html/test/",
 180   "dom/indexedDB/test/",
 181   "dom/ipc/tests/",
 182   "dom/l10n/tests/mochitest/",
 183   "dom/localstorage/test/",
 184   "dom/manifest/test/",
 185   "dom/midi/tests/",
 186   "dom/payments/test/",
 187   "dom/plugins/test/mochitest/",
 188   "dom/reporting/tests/",
 189   "dom/security/test/cors/",
 190   "dom/security/test/csp/",
 191   "dom/security/test/general/",
 192   "dom/security/test/https-first/",
 193   "dom/security/test/https-only/",
 194   "dom/security/test/mixedcontentblocker/",
 195   "dom/security/test/referrer-policy/",
 196   "dom/security/test/sec-fetch/",
 197   "dom/serviceworkers/test/",
 198   "dom/tests/browser/",
 199   "dom/url/tests/",
 200   "dom/workers/test/",
 201   "dom/xhr/tests/",
 202   "editor/libeditor/tests/",
 203   "extensions/permissions/test/",
 204   "layout/base/tests/",
 205   "layout/style/test/",
 206   "layout/xul/test/",
 207   "netwerk/test/useragent/",
 208   "parser/htmlparser/tests/mochitest/",
 209   "security/sandbox/test/",
 210   "testing/mochitest/baselinecoverage/browser_chrome/",
 211   "testing/mochitest/tests/python/files/",
 212   "toolkit/components/alerts/test/",
 213   "toolkit/components/mozprotocol/tests/",
 214   "toolkit/components/narrate/test/",
 215   "toolkit/components/pdfjs/test/",
 216   "toolkit/components/pictureinpicture/tests/",
 217   "toolkit/components/printing/tests/",
 218   "toolkit/components/reader/test/",
 219   "toolkit/components/thumbnails/test/",
 220   "toolkit/components/tooltiptext/tests/",
 221   "toolkit/components/windowcreator/test/",
 222   "toolkit/components/windowwatcher/test/",
 223   "toolkit/mozapps/extensions/test/xpinstall/",
 224   "uriloader/exthandler/tests/mochitest/",
 225 ];
 226
 227 // NOTE: Before adding to the list below, please see the note at the top
 228 // of the file.
 229
 230 const extraChromeTestPaths = [
 231   "devtools/shared/security/tests/chrome/",
 232   "devtools/shared/webconsole/test/chrome/",
 233   "dom/base/test/",
 234   "dom/battery/test/",
 235   "dom/bindings/test/",
 236   "dom/console/tests/",
 237   "dom/encoding/test/",
 238   "dom/events/test/",
 239   "dom/flex/test/",
 240   "dom/grid/test/",
 241   "dom/html/test/",
 242   "dom/html/test/forms/",
 243   "dom/indexedDB/test/",
 244   "dom/messagechannel/tests/",
 245   "dom/network/tests/",
 246   "dom/promise/tests/",
 247   "dom/security/test/general/",
 248   "dom/security/test/sec-fetch/",
 249   "dom/serviceworkers/test/",
 250   "dom/system/tests/",
 251   "dom/url/tests/",
 252   "dom/websocket/tests/",
 253   "dom/workers/test/",
 254   "dom/xul/test/",
 255   "editor/composer/test/",
 256   "extensions/universalchardet/tests/",
 257   "gfx/layers/apz/test/mochitest/",
 258   "image/test/mochitest/",
 259   "layout/forms/test/",
 260   "layout/generic/test/",
 261   "layout/mathml/tests/",
 262   "layout/svg/tests/",
 263   "layout/xul/test/",
 264   "toolkit/components/aboutmemory/tests/",
 265   "toolkit/components/osfile/tests/mochi/",
 266   "toolkit/components/printing/tests/",
 267   "toolkit/components/url-classifier/tests/mochitest/",
 268   "toolkit/components/viewsource/test/",
 269   "toolkit/components/windowcreator/test/",
 270   "toolkit/components/windowwatcher/test/",
 271   "toolkit/components/workerloader/tests/",
 272   "toolkit/content/tests/widgets/",
 273   "toolkit/profile/test/",
 274   "widget/tests/",
 275   "xpfe/appshell/test/",
 276 ];
 277
 278 // NOTE: Before adding to the list below, please see the note at the top
 279 // of the file.
 280
 281 const extraMochitestTestPaths = [
 282   "dom/file/tests/",
 283   "dom/ipc/tests/",
 284   "toolkit/xre/test/",
 285   "accessible/tests/crashtests/",
 286   "browser/components/protocolhandler/test/",
 287   "caps/tests/mochitest/",
 288   "docshell/test/iframesandbox/",
 289   "docshell/test/navigation/",
 290   "dom/abort/tests/",
 291   "dom/animation/test/mozilla/",
 292   "dom/animation/test/style/",
 293   "dom/base/test/",
 294   "dom/battery/test/",
 295   "dom/bindings/test/",
 296   "dom/broadcastchannel/tests/",
 297   "dom/canvas/test/",
 298   "dom/console/tests/",
 299   "dom/credentialmanagement/tests/",
 300   "dom/crypto/test/",
 301   "dom/encoding/test/",
 302   "dom/events/test/",
 303   "dom/file/tests/",
 304   "dom/filesystem/compat/tests/",
 305   "dom/filesystem/tests/",
 306   "dom/html/test/",
 307   "dom/html/test/forms/",
 308   "dom/indexedDB/test/",
 309   "dom/ipc/tests/",
 310   "dom/jsurl/test/",
 311   "dom/localstorage/test/",
 312   "dom/locks/test/",
 313   "dom/manifest/test/",
 314   "dom/media/mediasession/test/",
 315   "dom/media/mediasource/test/",
 316   "dom/media/test/",
 317   "dom/media/webcodecs/test/",
 318   "dom/media/webspeech/recognition/test/",
 319   "dom/media/webspeech/synth/test/",
 320   "dom/messagechannel/tests/",
 321   "dom/midi/tests/",
 322   "dom/network/tests/",
 323   "dom/payments/test/",
 324   "dom/performance/tests/",
 325   "dom/permission/tests/",
 326   "dom/plugins/test/mochitest/",
 327   "dom/promise/tests/",
 328   "dom/push/test/",
 329   "dom/quota/test/modules/content/",
 330   "dom/reporting/tests/",
 331   "dom/security/test/cors/",
 332   "dom/security/test/csp/",
 333   "dom/security/test/https-only/",
 334   "dom/security/test/mixedcontentblocker/",
 335   "dom/security/test/referrer-policy/",
 336   "dom/security/test/sec-fetch/",
 337   "dom/security/test/sri/",
 338   "dom/serviceworkers/test/",
 339   "dom/smil/test/",
 340   "dom/svg/test/",
 341   "dom/system/tests/",
 342   "dom/u2f/tests/",
 343   "dom/url/tests/",
 344   "dom/webauthn/tests/",
 345   "dom/websocket/tests/",
 346   "dom/workers/test/",
 347   "dom/worklet/tests/",
 348   "dom/xhr/tests/",
 349   "dom/xml/test/",
 350   "dom/xul/test/",
 351   "editor/composer/test/",
 352   "editor/libeditor/tests/",
 353   "editor/spellchecker/tests/",
 354   "extensions/permissions/test/",
 355   "gfx/layers/apz/test/mochitest/",
 356   "image/test/mochitest/",
 357   "intl/uconv/tests/",
 358   "layout/base/tests/",
 359   "layout/forms/test/",
 360   "layout/generic/test/",
 361   "layout/inspector/tests/",
 362   "layout/mathml/tests/",
 363   "layout/style/test/",
 364   "layout/svg/tests/",
 365   "layout/tables/test/",
 366   "layout/xul/test/",
 367   "parser/htmlparser/tests/mochitest/",
 368   "services/sync/tests/tps/",
 369   "testing/mochitest/baselinecoverage/plain/",
 370   "testing/mochitest/tests/python/files/",
 371   "toolkit/components/alerts/test/",
 372   "toolkit/components/passwordmgr/test/mochitest/",
 373   "toolkit/components/prompts/test/",
 374   "toolkit/components/satchel/test/",
 375   "toolkit/components/url-classifier/tests/mochitest/",
 376   "toolkit/components/windowcreator/test/",
 377   "toolkit/components/windowwatcher/test/",
 378   "toolkit/content/tests/widgets/",
 379   "toolkit/xre/test/",
 380   "uriloader/exthandler/tests/mochitest/",
 381   "widget/tests/",
 382 ];
 383
 384 // Please DO NOT add more entries to the list below.
 385 // Doing so may cause conflicts in ESLint rules and globals, and cause
 386 // unexpected issues to be raised or missed.
 387 let expectedDupePaths = new Set([
 388   "caps/tests/mochitest/",
 389   "docshell/test/navigation/",
 390   "dom/base/test/",
 391   "dom/battery/test/",
 392   "dom/bindings/test/",
 393   "dom/broadcastchannel/tests/",
 394   "dom/console/tests/",
 395   "dom/encoding/test/",
 396   "dom/events/test/",
 397   "dom/file/tests/",
 398   "dom/indexedDB/test/",
 399   "dom/ipc/tests/",
 400   "dom/localstorage/test/",
 401   "dom/html/test/",
 402   "dom/html/test/forms/",
 403   "dom/manifest/test/",
 404   "dom/messagechannel/tests/",
 405   "dom/midi/tests/",
 406   "dom/network/tests/",
 407   "dom/payments/test/",
 408   "dom/plugins/test/mochitest/",
 409   "dom/promise/tests/",
 410   "dom/reporting/tests/",
 411   "dom/security/test/cors/",
 412   "dom/security/test/csp/",
 413   "dom/security/test/general/",
 414   "dom/security/test/https-only/",
 415   "dom/security/test/mixedcontentblocker/",
 416   "dom/security/test/referrer-policy/",
 417   "dom/security/test/sec-fetch/",
 418   "dom/serviceworkers/test/",
 419   "dom/system/tests/",
 420   "dom/url/tests/",
 421   "dom/websocket/tests/",
 422   "dom/workers/test/",
 423   "dom/xhr/tests/",
 424   "dom/xul/test/",
 425   "editor/composer/test/",
 426   "editor/libeditor/tests/",
 427   "extensions/permissions/test/",
 428   "gfx/layers/apz/test/mochitest/",
 429   "image/test/mochitest/",
 430   "layout/base/tests/",
 431   "layout/forms/test/",
 432   "layout/generic/test/",
 433   "layout/mathml/tests/",
 434   "layout/style/test/",
 435   "layout/svg/tests/",
 436   "layout/xul/test/",
 437   "parser/htmlparser/tests/mochitest/",
 438   "testing/mochitest/tests/python/files/",
 439   "toolkit/components/alerts/test/",
 440   "toolkit/components/printing/tests/",
 441   "toolkit/components/thumbnails/test/",
 442   "toolkit/components/url-classifier/tests/mochitest/",
 443   "toolkit/components/windowcreator/test/",
 444   "toolkit/components/windowwatcher/test/",
 445   "toolkit/content/tests/widgets/",
 446   "toolkit/xre/test/",
 447   "uriloader/exthandler/tests/mochitest/",
 448   "widget/tests/",
 449 ]);
 450 // Please DO NOT add more paths to the list above.
 451
 452 let paths = new Set(extraXpcshellTestPaths);
 453 for (let path of [
 454   ...extraBrowserTestPaths,
 455   ...extraChromeTestPaths,
 456   ...extraMochitestTestPaths,
 457 ]) {
 458   if (paths.has(path) && !expectedDupePaths.has(path)) {
 459     throw new Error(`
 460 Unexpected directory containing different test types: ${path}
 461
 462 Please do not add new paths containing different test types. Please use
 463 separate directories.
 464
 465 Having different test types in the same directory may cause ESLint rules to be
 466 incorrectly applied.
 467 `);
 468   }
 469   paths.add(path);
 470 }
 471
 472 module.exports = {
 473   testPaths: {
 474     browser: [...browserTestPaths, ...extraBrowserTestPaths],
 475     chrome: [...chromeTestPaths, ...extraChromeTestPaths],
 476     mochitest: [...mochitestTestPaths, ...extraMochitestTestPaths],
 477     xpcshell: [...xpcshellTestPaths, ...extraXpcshellTestPaths],
 478   },
 479 };