const IS_EE = require('./config/helpers/is_ee_env'); const isESLint = require('./config/helpers/is_eslint'); const IS_JH = require('./config/helpers/is_jh_env'); const { VUE_VERSION: EXPLICIT_VUE_VERSION } = process.env; if (![undefined, '2', '3'].includes(EXPLICIT_VUE_VERSION)) { throw new Error( `Invalid VUE_VERSION value: ${EXPLICIT_VUE_VERSION}. Only '2' and '3' are supported`, ); } const USE_VUE_3 = EXPLICIT_VUE_VERSION === '3'; const { TEST_HOST } = require('./spec/frontend/__helpers__/test_constants'); module.exports = (path, options = {}) => { const { moduleNameMapper: extModuleNameMapper = {}, moduleNameMapperEE: extModuleNameMapperEE = {}, moduleNameMapperJH: extModuleNameMapperJH = {}, } = options; const reporters = ['default']; const VUE_JEST_TRANSFORMER = USE_VUE_3 ? '@vue/vue3-jest' : '@vue/vue2-jest'; const setupFilesAfterEnv = [`/${path}/test_setup.js`, 'jest-canvas-mock']; const vueModuleNameMappers = {}; const globals = {}; if (EXPLICIT_VUE_VERSION) { Object.assign(vueModuleNameMappers, { '^@gitlab/ui/dist/([^.]*)$': [ '/node_modules/@gitlab/ui/src/$1.vue', '/node_modules/@gitlab/ui/src/$1.js', ], '^@gitlab/ui$': '/node_modules/@gitlab/ui/src/index.js', }); } if (USE_VUE_3) { setupFilesAfterEnv.unshift(`/${path}/vue_compat_test_setup.js`); Object.assign(vueModuleNameMappers, { '^vue$': '@vue/compat', '^@vue/test-utils$': '@vue/test-utils-vue3', }); Object.assign(globals, { 'vue-jest': { experimentalCSSCompile: false, compiler: require.resolve('./config/vue3migration/compiler'), compilerOptions: { compatConfig: { MODE: 2, }, }, }, }); } // To have consistent date time parsing both in local and CI environments we set // the timezone of the Node process. https://gitlab.com/gitlab-org/gitlab-foss/merge_requests/27738 process.env.TZ = 'GMT'; if (process.env.CI) { reporters.push([ 'jest-junit', { outputName: './junit_jest.xml', addFileAttribute: 'true', }, ]); } const glob = `${path}/**/*@([._])spec.js`; let testMatch = [`/${glob}`]; if (IS_EE) { testMatch.push(`/ee/${glob}`); } if (IS_JH) { testMatch.push(`/jh/${glob}`); } // workaround for eslint-import-resolver-jest only resolving in test files // see https://github.com/JoinColony/eslint-import-resolver-jest#note if (isESLint(module)) { testMatch = testMatch.map((modulePath) => modulePath.replace('_spec.js', '')); } const TEST_FIXTURES_PATTERN = 'test_fixtures(/.*)$'; const moduleNameMapper = { '^~(/.*)\\?(worker|raw)$': '/app/assets/javascripts$1', '^(.*)\\?(worker|raw)$': '$1', '^~(/.*)$': '/app/assets/javascripts$1', '^ee_component(/.*)$': '/app/assets/javascripts/vue_shared/components/empty_component.js', '^jh_component(/.*)$': '/app/assets/javascripts/vue_shared/components/empty_component.js', '^shared_queries(/.*)$': '/app/graphql/queries$1', '^ee_else_ce(/.*)$': '/app/assets/javascripts$1', '^jh_else_ce(/.*)$': '/app/assets/javascripts$1', '^any_else_ce(/.*)$': '/app/assets/javascripts$1', '^helpers(/.*)$': '/spec/frontend/__helpers__$1', '^vendor(/.*)$': '/vendor/assets/javascripts$1', [TEST_FIXTURES_PATTERN]: '/tmp/tests/frontend/fixtures$1', '^test_fixtures_static(/.*)$': '/spec/frontend/fixtures/static$1', '\\.(jpg|jpeg|png|svg|css)$': '/spec/frontend/__mocks__/file_mock.js', '\\.svg\\?url$': '/spec/frontend/__mocks__/file_mock.js', '^public(/.*)$': '/public$1', 'emojis(/.*).json': '/fixtures/emojis$1.json', '^spec/test_constants$': '/spec/frontend/__helpers__/test_constants', '^jest/(.*)$': '/spec/frontend/$1', '^ee_else_ce_jest/(.*)$': '/spec/frontend/$1', '^jquery$': '/node_modules/jquery/dist/jquery.slim.js', '^@sentry/browser$': '/app/assets/javascripts/sentry/sentry_browser_wrapper.js', ...extModuleNameMapper, ...vueModuleNameMappers, }; const collectCoverageFrom = ['/app/assets/javascripts/**/*.{js,vue}']; if (IS_EE) { const rootDirEE = '/ee/app/assets/javascripts$1'; const specDirEE = '/ee/spec/frontend/$1'; Object.assign(moduleNameMapper, { '^ee(/.*)$': rootDirEE, '^ee_component(/.*)$': rootDirEE, '^ee_else_ce(/.*)$': rootDirEE, '^ee_jest/(.*)$': specDirEE, '^ee_else_ce_jest/(.*)$': specDirEE, '^any_else_ce(/.*)$': rootDirEE, '^jh_else_ee(/.*)$': rootDirEE, [TEST_FIXTURES_PATTERN]: '/tmp/tests/frontend/fixtures-ee$1', ...extModuleNameMapperEE, }); collectCoverageFrom.push(rootDirEE.replace('$1', '/**/*.{js,vue}')); } if (IS_JH) { // DO NOT add additional path to Jihu side, it might break things. const rootDirJH = '/jh/app/assets/javascripts$1'; const specDirJH = '/jh/spec/frontend/$1'; Object.assign(moduleNameMapper, { '^jh(/.*)$': rootDirJH, '^jh_component(/.*)$': rootDirJH, '^jh_jest/(.*)$': specDirJH, // jh path alias https://gitlab.com/gitlab-org/gitlab/-/merge_requests/74305#note_732793956 '^jh_else_ce(/.*)$': rootDirJH, '^jh_else_ee(/.*)$': rootDirJH, '^any_else_ce(/.*)$': rootDirJH, ...extModuleNameMapperJH, }); collectCoverageFrom.push(rootDirJH.replace('$1', '/**/*.{js,vue}')); } const coverageDirectory = () => { if (process.env.CI_NODE_INDEX && process.env.CI_NODE_TOTAL) { return `/coverage-frontend/jest-${process.env.CI_NODE_INDEX}-${process.env.CI_NODE_TOTAL}`; } return '/coverage-frontend/'; }; const gfmParserDependencies = [ 'rehype-.*', 'remark-.*', 'hast*', 'unist.*', 'markdown-table', 'mdast-util-.*', 'micromark.*', 'vfile.*', 'bail', 'trough', 'unified', 'is-plain-obj', 'decode-named-character-reference', 'character-entities*', 'property-information', 'space-separated-tokens', 'comma-separated-tokens', 'web-namespaces', 'zwitch', 'html-void-elements', 'ccount', 'escape-string-regexp', ]; const transformIgnoreNodeModules = [ 'vue-test-utils-compat', '@gitlab/ui', '@gitlab/favicon-overlay', 'bootstrap-vue', 'three', 'monaco-editor', 'monaco-yaml', 'monaco-marker-data-provider', 'monaco-worker-manager', 'fast-mersenne-twister', 'prosemirror-markdown', 'marked', 'fault', 'dateformat', 'lowlight', 'vscode-languageserver-types', 'yaml', ...gfmParserDependencies, ]; return { globals, clearMocks: true, testMatch, moduleFileExtensions: ['js', 'json', 'vue', 'gql', 'graphql', 'yaml', 'yml'], moduleNameMapper, collectCoverageFrom, coverageDirectory: coverageDirectory(), coverageReporters: ['json', 'lcov', 'text-summary', 'clover'], // We need ignore _worker code coverage since we are manually transforming it coveragePathIgnorePatterns: ['/node_modules/', '_worker\\.js$'], cacheDirectory: '/tmp/cache/jest', modulePathIgnorePatterns: ['/.yarn-cache/'], reporters, resolver: './jest_resolver.js', setupFilesAfterEnv, restoreMocks: true, slowTestThreshold: process.env.CI ? 6000 : 500, transform: { '^.+\\.(gql|graphql)$': './spec/frontend/__helpers__/graphql_transformer.js', '^.+_worker\\.js$': './spec/frontend/__helpers__/web_worker_transformer.js', '^.+\\.js$': 'babel-jest', '^.+\\.vue$': VUE_JEST_TRANSFORMER, 'spec/frontend/editor/schema/ci/yaml_tests/.+\\.(yml|yaml)$': './spec/frontend/__helpers__/yaml_transformer.js', '^.+\\.(md|zip|png|yml|yaml|sh|ps1)$': './spec/frontend/__helpers__/raw_transformer.js', }, transformIgnorePatterns: [`node_modules/(?!(${transformIgnoreNodeModules.join('|')}))`], fakeTimers: { enableGlobally: true, doNotFake: ['nextTick', 'setImmediate'], legacyFakeTimers: true, }, testEnvironment: '/spec/frontend/environment.js', testEnvironmentOptions: { IS_EE, IS_JH, url: TEST_HOST, }, testRunner: 'jest-jasmine2', }; };