test: rework unit tests to separate dom and node tests (#1276)

## Proposed change

Currently, we only have 1 jest config for all unit-tests
Unfortunately, the tests for `src` usually don't require the same
environment as the tests for `schematics` and `builders`

The idea is to have a different project for each (check
`packages/@o3r/core/jest.config.ts`)

This will fix the tests issue on
#1255 and
#1243

## Related issues

- 🐛 Fixes #(issue)
- 🚀 Feature #(issue)

<!-- Please make sure to follow the contributing guidelines on
https://github.com/amadeus-digital/Otter/blob/main/CONTRIBUTING.md -->

.yarnrc.yml

@@ -19,7 +19,7 @@ packageExtensions:
       "@angular/compiler-cli": ~17.0.4
       "@schematics/angular": ~17.0.3
       "@types/node": ^20.0.0
-      esbuild: ~0.19.0
+      esbuild: ~0.20.0
       eslint: ^8.42.0
       nx: ~17.2.0
       rxjs: ^7.8.1

apps/chrome-devtools/jest.config.js

@@ -1,16 +1,9 @@
-const getJestConfig = require('../../jest.config.ut').getJestConfig;
+const getJestGlobalConfig = require('../../jest.config.ut').getJestGlobalConfig;
 
 /** @type {import('ts-jest/dist/types').JestConfigWithTsJest} */
 module.exports = {
-  ...getJestConfig(__dirname, true),
-  displayName: require('./package.json').name,
-  transformIgnorePatterns: ['^.+\\.js$'],
-  globals: {
-    chrome: {
-      runtime: {},
-      devtools: {
-        inspectedWindow: {}
-      }
-    }
-  }
+  ...getJestGlobalConfig(),
+  projects: [
+    '<rootDir>/testing/jest.config.ut.js'
+  ]
 };

apps/chrome-devtools/testing/jest.config.ut.js

@@ -0,0 +1,19 @@
+const path = require('node:path');
+const getJestProjectConfig = require('../../../jest.config.ut').getJestProjectConfig;
+const rootDir = path.join(__dirname, '..');
+
+/** @type {import('ts-jest/dist/types').JestConfigWithTsJest} */
+module.exports = {
+  ...getJestProjectConfig(rootDir, true),
+  displayName: require('../package.json').name,
+  rootDir,
+  transformIgnorePatterns: ['^.+\\.js$'],
+  globals: {
+    chrome: {
+      runtime: {},
+      devtools: {
+        inspectedWindow: {}
+      }
+    }
+  }
+};

apps/github-cascading-app/jest.config.js

@@ -1,7 +1,9 @@
-const getJestConfig = require('../../jest.config.ut').getJestConfig;
+const getJestGlobalConfig = require('../../jest.config.ut').getJestGlobalConfig;
 
 /** @type {import('ts-jest/dist/types').JestConfigWithTsJest} */
 module.exports = {
-  ...getJestConfig(__dirname, true),
-  displayName: require('./package.json').name
+  ...getJestGlobalConfig(),
+  projects: [
+    '<rootDir>/testing/jest.config.ut.js'
+  ]
 };

apps/github-cascading-app/testing/jest.config.ut.js

@@ -0,0 +1,10 @@
+const path = require('node:path');
+const getJestProjectConfig = require('../../../jest.config.ut').getJestProjectConfig;
+const rootDir = path.join(__dirname, '..');
+
+/** @type {import('ts-jest/dist/types').JestConfigWithTsJest} */
+module.exports = {
+  ...getJestProjectConfig(rootDir, true),
+  displayName: require('../package.json').name,
+  rootDir
+};

apps/showcase/jest.config.js

@@ -1,7 +1,9 @@
-const getJestConfig = require('../../jest.config.ut').getJestConfig;
+const getJestGlobalConfig = require('../../jest.config.ut').getJestGlobalConfig;
 
-/** @type {import('ts-jest/dist/types').InitialOptionsTsJest} */
+/** @type {import('ts-jest/dist/types').JestConfigWithTsJest} */
 module.exports = {
-  ...getJestConfig(__dirname, true),
-  displayName: require('./package.json').name
+  ...getJestGlobalConfig(),
+  projects: [
+    '<rootDir>/testing/jest.config.ut.js'
+  ]
 };

apps/showcase/testing/jest.config.ut.js

@@ -0,0 +1,10 @@
+const path = require('node:path');
+const getJestProjectConfig = require('../../../jest.config.ut').getJestProjectConfig;
+const rootDir = path.join(__dirname, '..');
+
+/** @type {import('ts-jest/dist/types').JestConfigWithTsJest} */
+module.exports = {
+  ...getJestProjectConfig(rootDir, true),
+  displayName: require('../package.json').name,
+  rootDir
+};

apps/vscode-extension/jest.config.js

@@ -1,12 +1,9 @@
-const getJestConfig = require('../../jest.config.ut').getJestConfig;
+const getJestGlobalConfig = require('../../jest.config.ut').getJestGlobalConfig;
 
 /** @type {import('ts-jest/dist/types').JestConfigWithTsJest} */
 module.exports = {
-  ...getJestConfig(__dirname, false),
-  displayName: require('./package.json').name,
-  testPathIgnorePatterns: [
-    '<rootDir>/dist',
-    '<rootDir>/.*/templates/.*',
-    '\\.it\\.spec\\.ts$'
+  ...getJestGlobalConfig(),
+  projects: [
+    '<rootDir>/testing/jest.config.ut.js'
   ]
 };

apps/vscode-extension/testing/jest.config.ut.js

@@ -0,0 +1,10 @@
+const path = require('node:path');
+const getJestProjectConfig = require('../../../jest.config.ut').getJestProjectConfig;
+const rootDir = path.join(__dirname, '..');
+
+/** @type {import('ts-jest/dist/types').JestConfigWithTsJest} */
+module.exports = {
+  ...getJestProjectConfig(rootDir, false),
+  displayName: require('../package.json').name,
+  rootDir
+};

jest.config.it.js

@@ -1,12 +1,12 @@
-const getJestConfig = require('./jest.config.ut').getJestConfig;
+const getJestProjectConfig = require('./jest.config.ut').getJestProjectConfig;
 
 
 /**
  * @param rootDir {string}
  * @returns {import('ts-jest/dist/types').JestConfigWithTsJest}
  */
 module.exports.getJestConfig = (rootDir) => ({
-  ...getJestConfig(rootDir, false),
+  ...getJestProjectConfig(rootDir, false),
   rootDir: '..',
   setupFilesAfterEnv: null,
   testPathIgnorePatterns: [

jest.config.js

@@ -4,7 +4,7 @@ const { getJestProjects } = require('@o3r/workspace');
 module.exports = {
   projects: [
     ...getJestProjects(__dirname),
-    ...getJestProjects(__dirname, 'testing/jest.config.it.{j,t}s')
+    ...getJestProjects(__dirname, 'testing/jest.config.*.{j,t}s')
   ],
   globalSetup: 'jest-preset-angular/global-setup',
   reporters: [

jest.config.ut.js

@@ -7,16 +7,17 @@ globalThis.ngJest = {
 };
 
 /**
+ * Jest configuration that can be set at project level
  * @param rootDir {string}
  * @param isAngularSetup {boolean}
  * @returns {import('ts-jest/dist/types').JestConfigWithTsJest}
  */
-module.exports.getJestConfig = (rootDir, isAngularSetup) => {
-  const relativePath = relative(rootDir, '.');
-  const moduleNameMapper = Object.entries(pathsToModuleNameMapper(compilerOptions.paths)).reduce((acc, [moduleName, path]) => {
-    acc[moduleName] = `<rootDir>/${relativePath}/${path}`;
-    return acc;
-  }, {});
+module.exports.getJestProjectConfig = (rootDir, isAngularSetup) => {
+  const relativePath = relative(rootDir, __dirname);
+  const moduleNameMapper = Object.fromEntries(
+    Object.entries(pathsToModuleNameMapper(compilerOptions.paths))
+      .map(([moduleName, path]) => [moduleName, `<rootDir>/${relativePath}/${path}`])
+  );
   return {
     preset: 'ts-jest',
     setupFilesAfterEnv: ['<rootDir>/testing/setup-jest.ts'],
@@ -29,11 +30,6 @@ module.exports.getJestConfig = (rootDir, isAngularSetup) => {
       '<rootDir>/.*/templates/.*',
       '\\.it\\.spec\\.ts$'
     ],
-    reporters: [
-      'default',
-      ['jest-junit', {outputDirectory: '<rootDir>/dist-test', outputName: 'ut-report.xml'}],
-      'github-actions'
-    ],
     fakeTimers: {
       enableGlobally: true
     },
@@ -51,7 +47,6 @@ module.exports.getJestConfig = (rootDir, isAngularSetup) => {
       // workaround for the SDK Core
       customExportConditions: ['require', 'node']
     },
-    testTimeout: 20000,
     workerIdleMemoryLimit: '700MB',
     ...isAngularSetup ? {
       preset: 'jest-preset-angular',
@@ -69,3 +64,18 @@ module.exports.getJestConfig = (rootDir, isAngularSetup) => {
     } : {}
   };
 }
+
+/**
+ * Jest configuration that can be set at root level
+ * @returns {import('ts-jest/dist/types').JestConfigWithTsJest}
+ */
+module.exports.getJestGlobalConfig = () => {
+  return {
+    testTimeout: 30000,
+    reporters: [
+      'default',
+      ['jest-junit', {outputDirectory: '<rootDir>/dist-test', outputName: 'ut-report.xml'}],
+      'github-actions'
+    ],
+  }
+}

packages/@ama-sdk/core/jest.config.js

@@ -1,12 +1,10 @@
-const getJestConfig = require('../../../jest.config.ut').getJestConfig;
+const getJestGlobalConfig = require('../../../jest.config.ut').getJestGlobalConfig;
 
 /** @type {import('ts-jest/dist/types').JestConfigWithTsJest} */
 module.exports = {
-  ...getJestConfig(__dirname, false),
-  displayName: require('./package.json').name,
-  fakeTimers: {
-    enableGlobally: true,
-    // TODO try to make date utils work with fake Date
-    doNotFake: ['Date']
-  }
+  ...getJestGlobalConfig(),
+  projects: [
+    '<rootDir>/testing/jest.config.ut.js',
+    '<rootDir>/testing/jest.config.ut.builders.js'
+  ]
 };

packages/@ama-sdk/core/package.json

@@ -109,6 +109,7 @@
     "@nx/jest": "~17.2.0",
     "@o3r/build-helpers": "workspace:^",
     "@o3r/eslint-plugin": "workspace:^",
+    "@o3r/test-helpers": "workspace:^",
     "@schematics/angular": "~17.0.3",
     "@swc/cli": "^0.3.0",
     "@swc/core": "^1.3.85",

packages/@ama-sdk/core/schematics/ng-add/index.spec.ts

@@ -3,10 +3,6 @@ import { readFileSync } from 'node:fs';
 import { join } from 'node:path';
 import { firstValueFrom } from 'rxjs';
 import { ngAdd } from './index';
-jest.mock('@o3r/schematics', () => ({
-  ...jest.requireActual('@o3r/schematics'),
-  createSchematicWithMetricsIfInstalled: jest.fn().mockImplementation((fn) => fn)
-}));
 
 describe('Ng add @ama-sdk/core', () => {
   it('should update imports', async () => {

packages/@ama-sdk/core/testing/jest.config.ut.builders.js

@@ -0,0 +1,15 @@
+const path = require('node:path');
+const getJestProjectConfig = require('../../../../jest.config.ut').getJestProjectConfig;
+const rootDir = path.join(__dirname, '..');
+
+/** @type {import('ts-jest/dist/types').JestConfigWithTsJest} */
+module.exports = {
+  ...getJestProjectConfig(rootDir, false),
+  displayName: `${require('../package.json').name}/builders`,
+  rootDir,
+  testPathIgnorePatterns: [
+    '<rootDir>/.*/templates/.*',
+    '<rootDir>/src/.*',
+    '\\.it\\.spec\\.ts$'
+  ]
+};

packages/@ama-sdk/core/testing/jest.config.ut.js

@@ -0,0 +1,21 @@
+const path = require('node:path');
+const getJestProjectConfig = require('../../../../jest.config.ut').getJestProjectConfig;
+const rootDir = path.join(__dirname, '..');
+
+/** @type {import('ts-jest/dist/types').JestConfigWithTsJest} */
+module.exports = {
+  ...getJestProjectConfig(rootDir, false),
+  displayName: require('../package.json').name,
+  rootDir,
+  fakeTimers: {
+    enableGlobally: true,
+    // TODO re-enable fake dates when issue fixed https://github.com/sinonjs/fake-timers/issues/437
+    doNotFake: ['Date']
+  },
+  testPathIgnorePatterns: [
+    '<rootDir>/.*/templates/.*',
+    '<rootDir>/builders/.*',
+    '<rootDir>/schematics/.*',
+    '\\.it\\.spec\\.ts$'
+  ]
+};

packages/@ama-sdk/core/testing/setup-jest.ts

@@ -1 +1,3 @@
 import 'isomorphic-fetch';
+import '@o3r/test-helpers/setup-jest-builders';
+

packages/@ama-sdk/schematics/jest.config.js

@@ -1,12 +1,10 @@
-const getJestConfig = require('../../../jest.config.ut').getJestConfig;
+const getJestGlobalConfig = require('../../../jest.config.ut').getJestGlobalConfig;
 
 /** @type {import('ts-jest/dist/types').JestConfigWithTsJest} */
 module.exports = {
-  ...getJestConfig(__dirname, false),
-  displayName: require('./package.json').name,
-  testPathIgnorePatterns: [
-    '<rootDir>/.*/templates/.*',
-    '\\.it\\.spec\\.ts$'
-  ],
-  testTimeout: 30 * 1000
+  ...getJestGlobalConfig(),
+  projects: [
+    '<rootDir>/testing/jest.config.ut.js',
+    '<rootDir>/testing/jest.config.ut.builders.js'
+  ]
 };

packages/@ama-sdk/schematics/package.json

@@ -74,6 +74,7 @@
     "@o3r/build-helpers": "workspace:^",
     "@o3r/eslint-plugin": "workspace:^",
     "@o3r/schematics": "workspace:^",
+    "@o3r/test-helpers": "workspace:^",
     "@openapitools/openapi-generator-cli": "~2.9.0",
     "@schematics/angular": "~17.0.3",
     "@types/jest": "~29.5.2",

packages/@ama-sdk/schematics/schematics/typescript/shell/index.spec.ts

@@ -78,7 +78,7 @@ describe('Typescript Shell Generator', () => {
       skipInstall: true,
       packageManager: 'npm'
     }, Tree.empty());
-  }, 15000);
+  });
 
   it('should generate basic SDK package', () => {
     expect(yarnTree.files.sort()).toEqual(baseFileList.sort());

packages/@ama-sdk/schematics/testing/jest.config.ut.builders.js

@@ -0,0 +1,15 @@
+const path = require('node:path');
+const getJestProjectConfig = require('../../../../jest.config.ut').getJestProjectConfig;
+const rootDir = path.join(__dirname, '..');
+
+/** @type {import('ts-jest/dist/types').JestConfigWithTsJest} */
+module.exports = {
+  ...getJestProjectConfig(rootDir, false),
+  displayName: `${require('../package.json').name}/builders`,
+  rootDir,
+  testPathIgnorePatterns: [
+    '<rootDir>/.*/templates/.*',
+    '<rootDir>/src/.*',
+    '\\.it\\.spec\\.ts$'
+  ]
+};

packages/@ama-sdk/schematics/testing/jest.config.ut.js

@@ -0,0 +1,16 @@
+const path = require('node:path');
+const getJestProjectConfig = require('../../../../jest.config.ut').getJestProjectConfig;
+const rootDir = path.join(__dirname, '..');
+
+/** @type {import('ts-jest/dist/types').JestConfigWithTsJest} */
+module.exports = {
+  ...getJestProjectConfig(rootDir, false),
+  displayName: require('../package.json').name,
+  rootDir,
+  testPathIgnorePatterns: [
+    '<rootDir>/.*/templates/.*',
+    '<rootDir>/builders/.*',
+    '<rootDir>/schematics/.*',
+    '\\.it\\.spec\\.ts$'
+  ]
+};

packages/@ama-sdk/schematics/testing/setup-jest.ts

@@ -1 +1,2 @@
 import 'isomorphic-fetch';
+import '@o3r/test-helpers/setup-jest-builders';

packages/@ama-sdk/showcase-sdk/.eslintrc.js

@@ -6,6 +6,7 @@ module.exports = {
   'parserOptions': {
     'tsconfigRootDir': __dirname,
     'project': [
+      'tsconfig.eslint.json',
       'testing/tsconfig.spec.json',
       'tsconfigs/tsconfig.jasmine.json',
       'tsconfigs/tsconfig.jest.json',

packages/@ama-sdk/showcase-sdk/jest.config.js

@@ -1,12 +1,9 @@
-const { getJestConfig } = require('../../../jest.config.ut');
+const getJestGlobalConfig = require('../../../jest.config.ut').getJestGlobalConfig;
 
 /** @type {import('ts-jest/dist/types').JestConfigWithTsJest} */
 module.exports = {
-  ...getJestConfig(__dirname, false),
-  displayName: require('./package.json').name,
-  setupFilesAfterEnv: null,
-  moduleNameMapper: {
-    '^@ama-sdk/showcase-sdk$': ['<rootDir>/dist/cjs', '<rootDir>/src'],
-    '^@ama-sdk/showcase-sdk/(.*)$': ['<rootDir>/dist/cjs/$1', '<rootDir>/src/$1'],
-  }
+  ...getJestGlobalConfig(),
+  projects: [
+    '<rootDir>/testing/jest.config.ut.js'
+  ]
 };