feat(testing): support root project generation for jest (#13353)

Co-authored-by: Miroslav Jonas <[email protected]>

docs/generated/packages/jest.json

@@ -41,6 +41,12 @@
             "type": "boolean",
             "default": false,
             "description": "Use JavaScript instead of TypeScript for config files"
+          },
+          "rootProject": {
+            "description": "initialize Jest for an application at the root of the workspace",
+            "type": "boolean",
+            "default": false,
+            "hidden": true
           }
         },
         "required": [],
@@ -123,6 +129,12 @@
             "type": "boolean",
             "default": false,
             "description": "Use JavaScript instead of TypeScript for config files"
+          },
+          "rootProject": {
+            "description": "Add Jest to an application at the root of the workspace",
+            "type": "boolean",
+            "default": false,
+            "hidden": true
           }
         },
         "required": [],

e2e/jest/src/jest-root.test.ts

@@ -0,0 +1,73 @@
+import { newProject, runCLI, uniq, runCLIAsync } from '@nrwl/e2e/utils';
+
+describe('Jest root projects', () => {
+  const myapp = uniq('myapp');
+  const mylib = uniq('mylib');
+
+  describe('angular', () => {
+    beforeAll(() => {
+      newProject();
+    });
+
+    it('should test root level app projects', async () => {
+      runCLI(`generate @nrwl/angular:app ${myapp} --rootProject=true`);
+
+      const rootProjectTestResults = await runCLIAsync(`test ${myapp}`);
+
+      expect(rootProjectTestResults.combinedOutput).toContain(
+        'Test Suites: 1 passed, 1 total'
+      );
+    }, 300_000);
+
+    it('should add lib project and tests should still work', async () => {
+      runCLI(`generate @nrwl/angular:lib ${mylib}`);
+      runCLI(
+        `generate @nrwl/angular:component ${mylib} --export --standalone --project=${mylib} --no-interactive`
+      );
+
+      const libProjectTestResults = await runCLIAsync(`test ${mylib}`);
+
+      expect(libProjectTestResults.combinedOutput).toContain(
+        'Test Suites: 1 passed, 1 total'
+      );
+
+      const rootProjectTestResults = await runCLIAsync(`test ${myapp}`);
+
+      expect(rootProjectTestResults.combinedOutput).toContain(
+        'Test Suites: 1 passed, 1 total'
+      );
+    }, 300_000);
+  });
+
+  describe('react', () => {
+    beforeAll(() => {
+      newProject();
+    });
+
+    it('should test root level app projects', async () => {
+      runCLI(`generate @nrwl/react:app ${myapp} --rootProject=true`);
+
+      const rootProjectTestResults = await runCLIAsync(`test ${myapp}`);
+
+      expect(rootProjectTestResults.combinedOutput).toContain(
+        'Test Suites: 1 passed, 1 total'
+      );
+    }, 300_000);
+
+    it('should add lib project and tests should still work', async () => {
+      runCLI(`generate @nrwl/react:lib ${mylib}`);
+
+      const libProjectTestResults = await runCLIAsync(`test ${mylib}`);
+
+      expect(libProjectTestResults.combinedOutput).toContain(
+        'Test Suites: 1 passed, 1 total'
+      );
+
+      const rootProjectTestResults = await runCLIAsync(`test ${myapp}`);
+
+      expect(rootProjectTestResults.combinedOutput).toContain(
+        'Test Suites: 1 passed, 1 total'
+      );
+    }, 300_000);
+  });
+});

e2e/jest/src/jest.test.ts

@@ -4,9 +4,12 @@ import {
   runCLI,
   runCLIAsync,
   uniq,
+  readJson,
   updateFile,
   expectJestTestsToPass,
   cleanupProject,
+  readFile,
+  checkFilesExist,
 } from '@nrwl/e2e/utils';
 
 describe('Jest', () => {

e2e/linter/src/linter.test.ts

@@ -473,9 +473,6 @@ export function tslibC(): string {
         'plugin:@nrwl/nx/javascript',
       ]);
 
-      console.log(JSON.stringify(rootEslint, null, 2));
-      console.log(JSON.stringify(e2eEslint, null, 2));
-
       runCLI(`generate @nrwl/react:lib ${mylib}`);
       // should add new tslint
       expect(() => checkFilesExist(`.eslintrc.base.json`)).not.toThrow();

packages/angular/src/generators/application/lib/add-unit-test-runner.ts

@@ -14,6 +14,7 @@ export async function addUnitTestRunner(host: Tree, options: NormalizedSchema) {
       supportTsx: false,
       skipSerializers: false,
       skipPackageJson: options.skipPackageJson,
+      rootProject: options.rootProject,
     });
   } else if (options.unitTestRunner === UnitTestRunner.Karma) {
     await karmaProjectGenerator(host, {

packages/jest/index.ts

@@ -5,4 +5,7 @@ export {
 export { jestConfigObjectAst } from './src/utils/config/functions';
 export { jestProjectGenerator } from './src/generators/jest-project/jest-project';
 export { jestInitGenerator } from './src/generators/init/init';
-export { getJestProjects } from './src/utils/config/get-jest-projects';
+export {
+  getJestProjects,
+  getNestedJestProjects,
+} from './src/utils/config/get-jest-projects';

packages/jest/src/generators/init/init.spec.ts

@@ -1,6 +1,8 @@
 import {
+  addProjectConfiguration,
   NxJsonConfiguration,
   readJson,
+  readProjectConfiguration,
   stripIndents,
   Tree,
   updateJson,
@@ -41,9 +43,29 @@ describe('jest', () => {
   });
 
   it('should not override existing files', async () => {
-    tree.write('jest.config.ts', `test`);
+    addProjectConfiguration(tree, 'my-project', {
+      root: 'apps/my-app',
+      name: 'my-app',
+      sourceRoot: 'apps/my-app/src',
+      targets: {
+        test: {
+          executor: '@nrwl/jest:jest',
+          options: {
+            jestConfig: 'apps/my-app/jest.config.ts',
+          },
+        },
+      },
+    });
+    const expected = stripIndents`
+import { getJestProjects } from '@nrwl/jest';
+export default {
+  projects: getJestProjects(),
+  extraThing: "Goes Here"
+}
+`;
+    tree.write('jest.config.ts', expected);
     jestInitGenerator(tree, {});
-    expect(tree.read('jest.config.ts', 'utf-8')).toEqual('test');
+    expect(tree.read('jest.config.ts', 'utf-8')).toEqual(expected);
   });
 
   it('should add target defaults for test', async () => {
@@ -144,6 +166,102 @@ describe('jest', () => {
     });
   });
 
+  describe('root project', () => {
+    it('should not add a monorepo jest.config.ts  to the project', () => {
+      jestInitGenerator(tree, { rootProject: true });
+      expect(tree.exists('jest.config.ts')).toBeFalsy();
+    });
+
+    it('should rename the project jest.config.ts to project jest config', () => {
+      addProjectConfiguration(tree, 'my-project', {
+        root: '.',
+        name: 'my-project',
+        sourceRoot: 'src',
+        targets: {
+          test: {
+            executor: '@nrwl/jest:jest',
+            options: {
+              jestConfig: 'jest.config.ts',
+            },
+          },
+        },
+      });
+      tree.write(
+        'jest.config.ts',
+        `
+/* eslint-disable */
+export default {
+  transform: {
+    '^.+\\.[tj]sx?$': 'ts-jest',
+  },
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'html'],
+  globals: { 'ts-jest': { tsconfig: '<rootDir>/tsconfig.spec.json' } },
+  displayName: 'my-project',
+  testEnvironment: 'node',
+  preset: './jest.preset.js',
+};
+`
+      );
+      jestInitGenerator(tree, { rootProject: false });
+      expect(tree.exists('jest.config.app.ts')).toBeTruthy();
+      expect(tree.read('jest.config.ts', 'utf-8'))
+        .toEqual(`import { getJestProjects } from '@nrwl/jest';
+
+export default {
+projects: getJestProjects()
+};`);
+      expect(readProjectConfiguration(tree, 'my-project').targets.test)
+        .toMatchInlineSnapshot(`
+        Object {
+          "executor": "@nrwl/jest:jest",
+          "options": Object {
+            "jestConfig": "jest.config.app.ts",
+          },
+        }
+      `);
+    });
+
+    it('should work with --js', () => {
+      addProjectConfiguration(tree, 'my-project', {
+        root: '.',
+        name: 'my-project',
+        sourceRoot: 'src',
+        targets: {
+          test: {
+            executor: '@nrwl/jest:jest',
+            options: {
+              jestConfig: 'jest.config.js',
+            },
+          },
+        },
+      });
+      tree.write(
+        'jest.config.js',
+        `
+/* eslint-disable */
+module.exports = {
+  transform: {
+    '^.+\\.[tj]sx?$': 'ts-jest',
+  },
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'html'],
+  globals: { 'ts-jest': { tsconfig: '<rootDir>/tsconfig.spec.json' } },
+  displayName: 'my-project',
+  testEnvironment: 'node',
+  preset: './jest.preset.js',
+};
+`
+      );
+      jestInitGenerator(tree, { js: true, rootProject: false });
+      expect(tree.exists('jest.config.app.js')).toBeTruthy();
+      expect(tree.read('jest.config.js', 'utf-8'))
+        .toEqual(`const { getJestProjects } = require('@nrwl/jest');
+
+module.exports = {
+projects: getJestProjects()
+};`);
+    });
+  });
+
   describe('adds jest extension', () => {
     beforeEach(async () => {
       writeJson(tree, '.vscode/extensions.json', {