feat(testing): Support default Webstorm test runner

[dopsonbr]

feat(testing): Support default Webstorm test runner

This change adds additional jest options to builder's schema.json and maps them in jest.impl.ts.

Expected Behavior

Webstorm is able to run jest tests without updating the configuration.
Webstorm should be able to open a spec file, click the play icon for the relevant test, and the test should run without an error.

Current Behavior

Webstorm attempts to run the tests with options supported by jest but the builder.
The unknown options cause the IDE test runner to error with out running the tests.
The specific options are config, colors, reporters, verbose, and testPathPattern.

Steps to Reproduce

Please provide detailed steps for reproducing the issue.

1. yarn create nx-workspace my-workspace
2. webstorm my-workspace
3. open app.component.spec.ts
4. click play icon

[FrozenPandaz]

Hey thanks for the contribution!

How did you setup Webstorm exactly? The default test runner for me runs jest directly which works fine for React and Node apps but does not work for Angular Apps because it needs more configuration which is handled within the builder.

[dopsonbr]

Hey thanks for the contribution!

How did you setup Webstorm exactly? The default test runner for me runs jest directly which works fine for React and Node apps but does not work for Angular Apps because it needs more configuration which is handled within the builder.

The default settings settings correctly configure the test runner as ng. Setting the runner directly to jest causes a different set of issues.

The specific issue is Webstorm passes arguments that are supported by jest but not implemented by the builder. The unsupported arguments result in the command failing due to unknown options.

My pull request implements the additional arguments that are supported by jest.

/Users/bxd5017/.nvm/versions/node/v12.2.0/bin/node
--require "/Users/bxd5017/Library/Application Support/JetBrains/Toolbox/apps/WebStorm/ch-1/191.7479.14/WebStorm.app/Contents/plugins/JavaScriptLanguage/helpers/jest-intellij/lib/jest-intellij-stdin-fix.js"
/Users/bxd5017/tmp/usom-client/node_modules/@angular/cli/bin/ng test
test-project
--colors
--reporters "/Users/bxd5017/Library/Application Support/JetBrains/Toolbox/apps/WebStorm/ch-1/191.7479.14/WebStorm.app/Contents/plugins/JavaScriptLanguage/helpers/jest-intellij/lib/jest-intellij-reporter.js" --verbose "
--testPathPattern='^/Users/bxd5017/tmp/test-workspace/apps/test-app/src/app/app.component\.spec\.ts$'

Unknown option: '--colors'
Unknown option: '--reporters /Users/bxd5017/Library/Application Support/JetBrains/Toolbox/apps/WebStorm/ch-1/191.7479.14/WebStorm.app/Contents/plugins/JavaScriptLanguage/helpers/jest-intellij/lib/jest-intellij-reporter.js'
Unknown option: '--verbose'
Unknown option: '--testPathPattern'

The exact webstorm and node version is in the above output. I used the default setup and was able to reproduce with multiple different versions of webstorm. The versions were installed with the jetbrains toolbox and the license comes from an enterprise license server. This means each install is defaults only and no settings were transferred from my personal jetbrains account.

[dartavion]

One way that allows webstorm to debug properly and not continue with the zonejs issue:

1. Add the following jest config to the package.json and adjust where necessary:

 "jest": {
    "preset": "jest-preset-angular",
    "setupFilesAfterEnv": [
      "<rootDir>/apps/nx-jest-example/src/test-setup.ts"
    ],
    "testPathIgnorePatterns": [
      "<rootDir>/node_modules/",
      "<rootDir>/dist/",
      "<rootDir>/src/test.ts",
      "<rootDir>/apps/nx-jest-example-e2e/"
    ],
    "globals": {
      "ts-jest": {
        "diagnostics": false,
        "tsConfig": "<rootDir>/apps/nx-jest-example/tsconfig.spec.json",
        "stringifyContentPathRegex": "\\.html$",
        "astTransformers": [
          "<rootDir>/node_modules/jest-preset-angular/InlineHtmlStripStylesTransformer"
        ]
      }
    }
  }

2. Click on the green debug icon in the WebStorm IDE gutter and select Debug.

3. Change the configuration in the Edit Configurations to use the package.json instead of the jest.config

4. Run debug and you should be able to debug a single test.

The test config object was also deleted from the angular.json. That is probably not be necessary since we're using the package.json to setup jest.

For now...hope this helps others that have run into this.

[sroettering]

must be type string

[sroettering]

must be type string

[vsavkin]

@dopsonbr could you rebase?

[dopsonbr]

@vsavkin after rebasing it looks like my changes were already merged/made in a different branch. I'll check the webstorm later today with a clean project, but I'm closing the PR for now.

[PhilippeMorier]

Because I landed here via google... #1439 (comment) was the solution which worked for me.

1. Add setupFilesAfterEnv: ['./src/test-setup.ts'] into you jest.config.js
2. Run Test directly in WebStorm (first failed)
3. Edit Configurations.. and select the proper jest.config.js as Configuration file of your app/lib

[github-actions]

This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request.