-
Notifications
You must be signed in to change notification settings - Fork 1.4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add Jest to MW Core for testing Vue components
This brings Jest to MW Core so that Vue components can more easily be tested. Packages ending with 'icons.json' are auto-mapped to the @wikimedia/codex-icons package, establishing a new convention. Jest is needed for testing Vue, but can be used for general JS testing as well. Documentation to come at https://www.mediawiki.org/wiki/Jest Usage: to run the tests, run "npx jest" or "npm run jest" in the root folder. This could be aliased to a "test:unit" script in package.json if desired. In order to make a Vue component testable, it is required to follow the `module.exports = exports` pattern. See: https://nodejs.org/api/modules.html#exports-shortcut A default jest.setup.js is added that mocks Core's mw global object, as well as providing the $i18n Vue plugin. This is based on Extension:GrowthExperiments (GPL-3.0-or-later). See https://w.wiki/B9vM An initial test for mediawiki.special.block is added, exemplifying how to mock calls to mw.config.get(). NOTE: The "overrides" added to package.json is a temporary measure to get around a current issue with caniuse-lite and the stylelint plugin that relies on it. See: RJWadley/stylelint-no-unsupported-browser-features#299 Bug: T251790 Change-Id: I1af15e038d17b0f1c645fc5debf9db5846f6215c
- Loading branch information
1 parent
5319d0b
commit 48798f1
Showing
14 changed files
with
22,427 additions
and
10,748 deletions.
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,23 @@ | ||
| { | ||
| "root": true, | ||
| "extends": [ | ||
| "wikimedia/client-common", | ||
| "wikimedia/language/es2020", | ||
| "wikimedia/jquery", | ||
| "wikimedia/mediawiki" | ||
| ], | ||
| "parserOptions": { | ||
| "sourceType": "module" | ||
| }, | ||
| "env": { | ||
| "browser": true, | ||
| "jest": true | ||
| }, | ||
| "globals": { | ||
| "global": "writable" | ||
| }, | ||
| "rules": { | ||
| "compat/compat": [ "error", "last 2 chrome versions, last 2 firefox versions" ], | ||
| "max-len": "off" | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,204 @@ | ||
| 'use strict'; | ||
|
|
||
| /* | ||
| * For a detailed explanation regarding each configuration property, visit: | ||
| * https://jestjs.io/docs/configuration | ||
| */ | ||
| module.exports = { | ||
| // All imported modules in your tests should be mocked automatically | ||
| // automock: false, | ||
|
|
||
| // Stop running tests after `n` failures | ||
| // bail: 0, | ||
|
|
||
| // The directory where Jest should store its cached dependency information | ||
| // cacheDirectory: '/private/var/folders/4c/2pxczd5n1c7_7z_s5djxfx5w0000gn/T/jest_dx', | ||
|
|
||
| // Automatically clear mock calls, instances and results before every test | ||
| clearMocks: true, | ||
|
|
||
| // Indicates whether the coverage information should be collected while executing the test | ||
| collectCoverage: false, | ||
|
|
||
| // An array of glob patterns indicating a set of files for which coverage information should be | ||
| // collected | ||
| // collectCoverageFrom: undefined, | ||
|
|
||
| // The directory where Jest should output its coverage files | ||
| coverageDirectory: 'coverage', | ||
|
|
||
| // An array of regexp pattern strings used to skip coverage collection | ||
| // coveragePathIgnorePatterns: [ | ||
| // '/node_modules/' | ||
| // ], | ||
|
|
||
| // Indicates which provider should be used to instrument code for coverage | ||
| // coverageProvider: "babel", | ||
|
|
||
| // A list of reporter names that Jest uses when writing coverage reports | ||
| // coverageReporters: [ | ||
| // 'json', | ||
| // 'text', | ||
| // 'lcov', | ||
| // 'clover' | ||
| // ], | ||
|
|
||
| // An object that configures minimum threshold enforcement for coverage results | ||
| // coverageThreshold: undefined, | ||
|
|
||
| // A path to a custom dependency extractor | ||
| // dependencyExtractor: undefined, | ||
|
|
||
| // Make calling deprecated APIs throw helpful error messages | ||
| // errorOnDeprecated: false, | ||
|
|
||
| // Force coverage collection from ignored files using an array of glob patterns | ||
| // forceCoverageMatch: [], | ||
|
|
||
| // A path to a module which exports an async function that is triggered once before all test suites | ||
| // globalSetup: undefined, | ||
|
|
||
| // A path to a module which exports an async function that is triggered once after all test suites | ||
| // globalTeardown: undefined, | ||
|
|
||
| // A set of global variables that need to be available in all test environments | ||
| // globals: {}, | ||
|
|
||
| // The maximum amount of workers used to run your tests. Can be specified as % or a number. E.g. maxWorkers: 10% will use 10% of your CPU amount + 1 as the maximum worker number. maxWorkers: 2 will use a maximum of 2 workers. | ||
| // maxWorkers: '50%', | ||
|
|
||
| // An array of directory names to be searched recursively up from the requiring module's location | ||
| // moduleDirectories: [ | ||
| // 'node_modules' | ||
| // ], | ||
|
|
||
| // An array of file extensions your modules use | ||
| moduleFileExtensions: [ | ||
| 'js', | ||
| 'json', | ||
| 'vue' | ||
| ], | ||
|
|
||
| // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module | ||
| moduleNameMapper: { | ||
| 'icons.json$': '@wikimedia/codex-icons' | ||
| }, | ||
|
|
||
| // An array of regexp pattern strings, matched against all module paths before considered 'visible' to the module loader | ||
| // modulePathIgnorePatterns: [], | ||
|
|
||
| // Activates notifications for test results | ||
| // notify: false, | ||
|
|
||
| // An enum that specifies notification mode. Requires { notify: true } | ||
| // notifyMode: 'failure-change', | ||
|
|
||
| // A preset that is used as a base for Jest's configuration | ||
| // preset: undefined, | ||
|
|
||
| // Run tests from one or more projects | ||
| // projects: undefined, | ||
|
|
||
| // Use this configuration option to add custom reporters to Jest | ||
| // reporters: undefined, | ||
|
|
||
| // Automatically reset mock state before every test | ||
| // resetMocks: false, | ||
|
|
||
| // Reset the module registry before running each individual test | ||
| // resetModules: false, | ||
|
|
||
| // A path to a custom resolver | ||
| // resolver: undefined, | ||
|
|
||
| // Automatically restore mock state and implementation before every test | ||
| // restoreMocks: false, | ||
|
|
||
| // The root directory that Jest should scan for tests and modules within | ||
| rootDir: '../../', | ||
|
|
||
| // A list of paths to directories that Jest should use to search for files in | ||
| // roots: [ | ||
| // '<rootDir>' | ||
| // ], | ||
|
|
||
| // Allows you to use a custom runner instead of Jest's default test runner | ||
| // runner: 'jest-runner', | ||
|
|
||
| // The paths to modules that run some code to configure or set up the testing environment before each test | ||
| setupFiles: [ | ||
| '<rootDir>/tests/jest/jest.setup.js' | ||
| ], | ||
|
|
||
| // A list of paths to modules that run some code to configure or set up the testing framework before each test | ||
| // setupFilesAfterEnv: [], | ||
|
|
||
| // The number of seconds after which a test is considered as slow and reported as such in the results. | ||
| // slowTestThreshold: 5, | ||
|
|
||
| // A list of paths to snapshot serializer modules Jest should use for snapshot testing | ||
| // snapshotSerializers: [], | ||
|
|
||
| // The test environment that will be used for testing | ||
| testEnvironment: 'jsdom', | ||
|
|
||
| // Options that will be passed to the testEnvironment | ||
| testEnvironmentOptions: { | ||
| customExportConditions: [ 'node', 'node-addons' ] | ||
| }, | ||
|
|
||
| // Adds a location field to test results | ||
| // testLocationInResults: false, | ||
|
|
||
| // The glob patterns Jest uses to detect test files | ||
| testMatch: [ | ||
| '<rootDir>/tests/jest/**/*.test.js' | ||
| ], | ||
|
|
||
| // An array of regexp pattern strings that are matched against all test paths, matched tests are skipped | ||
| testPathIgnorePatterns: [ | ||
| '/node_modules/', | ||
| '/vendor/', | ||
| '/skins/', | ||
| '/extensions/', | ||
| '/tests/qunit/' | ||
| ], | ||
|
|
||
| // The regexp pattern or array of patterns that Jest uses to detect test files | ||
| // testRegex: [], | ||
|
|
||
| // This option allows the use of a custom results processor | ||
| // testResultsProcessor: undefined, | ||
|
|
||
| // This option allows use of a custom test runner | ||
| // testRunner: 'jest-circus/runner', | ||
|
|
||
| // This option sets the URL for the jsdom environment. It is reflected in properties such as location.href | ||
| // testURL: 'http://localhost', | ||
|
|
||
| // Setting this value to "fake" allows the use of fake timers for functions such as "setTimeout" | ||
| // timers: 'real', | ||
|
|
||
| // A map from regular expressions to paths to transformers | ||
| transform: { | ||
| '^.+\\.vue$': '<rootDir>/node_modules/@vue/vue3-jest' | ||
| } | ||
|
|
||
| // An array of regexp pattern strings that are matched against all source file paths, matched files will skip transformation | ||
| // transformIgnorePatterns: [ | ||
| // '/node_modules/', | ||
| // '\\.pnp\\.[^\\/]+$' | ||
| // ], | ||
|
|
||
| // An array of regexp pattern strings that are matched against all modules before the module loader will automatically return a mock for them | ||
| // unmockedModulePathPatterns: undefined, | ||
|
|
||
| // Indicates whether each individual test should be reported during the run | ||
| // verbose: undefined, | ||
|
|
||
| // An array of regexp patterns that are matched against all source file paths before re-running tests in watch mode | ||
| // watchPathIgnorePatterns: [], | ||
|
|
||
| // Whether to use watchman for file crawling | ||
| // watchman: true, | ||
| }; |
Oops, something went wrong.