feat(testing): add findRelatedTests option to jest builder

closes #1527
nrwl · Jul 9, 2019 · 1f5f0c2 · 1f5f0c2
1 parent 83311ae
commit 1f5f0c2
Show file tree

Hide file tree

Showing 4 changed files with 63 additions and 1 deletion.
diff --git a/docs/api-jest/builders/jest.md b/docs/api-jest/builders/jest.md
@@ -62,6 +62,12 @@ Type: `string`
 
 A list of reporter names that Jest uses when writing coverage reports. Any istanbul reporter
 
+### findRelatedTests
+
+Type: `string`
+
+Find and run the tests that cover a comma separated list of source files that were passed in as arguments. (https://jestjs.io/docs/en/cli#findrelatedtests-spaceseparatedlistofsourcefiles)
+
 ### jestConfig
 
 Type: `string`

diff --git a/packages/jest/src/builders/jest/jest.impl.spec.ts b/packages/jest/src/builders/jest/jest.impl.spec.ts
@@ -44,6 +44,7 @@ describe('Jest Builder', () => {
     );
     expect(runCLI).toHaveBeenCalledWith(
       {
+        _: [],
         globals: JSON.stringify({
           'ts-jest': {
             tsConfig: '/root/tsconfig.test.json',
@@ -115,6 +116,47 @@ describe('Jest Builder', () => {
     );
   });
 
+  it('should send appropriate options to jestCLI when findRelatedTests is specified', async () => {
+    const run = await architect.scheduleBuilder('@nrwl/jest:jest', {
+      findRelatedTests: 'file1.ts,file2.ts',
+      jestConfig: './jest.config.js',
+      tsConfig: './tsconfig.test.json',
+      codeCoverage: false,
+      runInBand: true,
+      testNamePattern: 'should load',
+      watch: false
+    });
+    expect(await run.result).toEqual(
+      jasmine.objectContaining({
+        success: true
+      })
+    );
+
+    expect(runCLI).toHaveBeenCalledWith(
+      {
+        _: ['file1.ts', 'file2.ts'],
+        globals: JSON.stringify({
+          'ts-jest': {
+            tsConfig: '/root/tsconfig.test.json',
+            diagnostics: {
+              warnOnly: true
+            },
+            stringifyContentPathRegex: '\\.html$',
+            astTransformers: [
+              'jest-preset-angular/InlineHtmlStripStylesTransformer'
+            ]
+          }
+        }),
+        coverage: false,
+        findRelatedTests: true,
+        runInBand: true,
+        testNamePattern: 'should load',
+        watch: false
+      },
+      ['/root/jest.config.js']
+    );
+  });
+
   it('should send other options to jestCLI', async () => {
     const run = await architect.scheduleBuilder('@nrwl/jest:jest', {
       jestConfig: './jest.config.js',
@@ -149,6 +191,7 @@ describe('Jest Builder', () => {
     );
     expect(runCLI).toHaveBeenCalledWith(
       {
+        _: [],
         globals: JSON.stringify({
           'ts-jest': {
             tsConfig: '/root/tsconfig.test.json',
@@ -201,6 +244,7 @@ describe('Jest Builder', () => {
     );
     expect(runCLI).toHaveBeenCalledWith(
       {
+        _: [],
         globals: JSON.stringify({
           'ts-jest': {
             tsConfig: '/root/tsconfig.test.json',

diff --git a/packages/jest/src/builders/jest/jest.impl.ts b/packages/jest/src/builders/jest/jest.impl.ts
@@ -26,6 +26,7 @@ export interface JestBuilderOptions extends JsonObject {
   ci?: boolean;
   color?: boolean;
   clearCache?: boolean;
+  findRelatedTests?: string;
   json?: boolean;
   maxWorkers?: number;
   onlyChanged?: boolean;
@@ -75,6 +76,7 @@ function run(
   } catch (e) {}
 
   const config: any = {
+    _: [],
     coverage: options.codeCoverage,
     bail: options.bail,
     ci: options.ci,
@@ -110,7 +112,13 @@ function run(
   }
 
   if (options.testFile) {
-    config._ = [options.testFile];
+    config._.push(options.testFile);
+  }
+
+  if (options.findRelatedTests) {
+    const parsedTests = options.findRelatedTests.split(',').map(s => s.trim());
+    config._.push(...parsedTests);
+    config.findRelatedTests = true;
   }
 
   if (options.clearCache) {

diff --git a/packages/jest/src/builders/jest/schema.json b/packages/jest/src/builders/jest/schema.json
@@ -41,6 +41,10 @@
       "description": "Forces test results output color highlighting (even if stdout is not a TTY). Set to false if you would like to have no colors. (https://jestjs.io/docs/en/cli#colors)",
       "type": "boolean"
     },
+    "findRelatedTests": {
+      "description": "Find and run the tests that cover a comma separated list of source files that were passed in as arguments. (https://jestjs.io/docs/en/cli#findrelatedtests-spaceseparatedlistofsourcefiles)",
+      "type": "string"
+    },
     "json": {
       "description": "Prints the test results in JSON. This mode will send all other test output and user messages to stderr. (https://jestjs.io/docs/en/cli#json)",
       "type": "boolean"