Stryker Mutator

https://stryker-mutator.io/docs
Admin
Stryker Mutator is a mutation testing framework that introduces changes (mutants) to your code to...
Tokens:109,699
Snippets:858
Trust Score:9.4
Update:21 hours ago
Show doc for...
Tokens:
Raw
### Baseline fallback version example: setup

Source: https://stryker-mutator.io/docs/stryker-net/configuration/

Example configuration showing `since-target` and `current-branch` values used in the baseline fallback examples.

```json
"since-target": 'development',
"current-branch" 'feat-2'
```

--------------------------------

### commandRunner command line and config file examples

Source: https://stryker-mutator.io/docs/stryker-js/configuration/

Examples for setting the commandRunner command via command line or config file.

```text
--commandRunner.command "npm run mocha"
```

```json
"commandRunner": { "command": "npm run mocha" }
```

--------------------------------

### Express routes.js example

Source: https://stryker-mutator.io/docs/stryker-js/parallel-workers/

Defines two routes: GET /home returns 'Hello World!' and POST /echo returns the request body as JSON. Used to illustrate how parallel test runners can conflict on shared resources like ports.

```javascript
// routes.js

const express = require('express');
const router = express.Router();

router.get('/home', (_req, res) => res.send('Hello World!'));

router.post('/echo', (req, res) => res.json(req.body));

module.exports = router;
```

--------------------------------

### coverageAnalysis command line and config file examples

Source: https://stryker-mutator.io/docs/stryker-js/configuration/

Examples for setting coverageAnalysis via command line or config file. Default is 'perTest'.

```text
--coverageAnalysis perTest
```

```json
"coverageAnalysis": "perTest"
```

--------------------------------

### testRunnerNodeArgs command line and config file examples

Source: https://stryker-mutator.io/docs/stryker-js/configuration/

Command line and config file examples for passing arguments to the test runner child process. Default is an empty array.

```bash
--testRunnerNodeArgs "--inspect-brk --cpu-prof"
```

```json
"testRunnerNodeArgs": ["--inspect-brk", "--cpu-prof"]
```

--------------------------------

### Install Stryker locally with dotnet tool install

Source: https://stryker-mutator.io/docs/stryker-net/getting-started/

Installs Stryker.NET as a local tool for the current project. Run in the project folder after creating the tool manifest.

```bash
dotnet tool install dotnet-stryker
```

--------------------------------

### commandRunner configuration example

Source: https://stryker-mutator.io/docs/stryker-js/configuration/

Configuration file example for setting the command used by the command test runner. Default command is 'npm test'.

```json
commandRunner: { command: 'npm run mocha' }
```

--------------------------------

### Build and install Maven plugin

Source: https://stryker-mutator.io/docs/stryker4s/contributing/

Builds and installs the Maven plugin itself into your local Maven repository.

```bash
cd maven && mvn install
```

--------------------------------

### Install and initialize Stryker

Source: https://stryker-mutator.io/docs/stryker-js/getting-started/

Runs the Stryker initializer, which asks a series of questions to set up Stryker for your project. If prompted to install Stryker, choose Yes.

```bash
npm init stryker@latest
```

--------------------------------

### Example stryker-config.json with reporters

Source: https://stryker-mutator.io/docs/stryker-net/getting-started/

Optional configuration file to store options. This example enables the 'progress' and 'html' reporters.

```json
{
    "stryker-config":
    {
        "reporters": [
            "progress",
            "html"
        ]
    }
}
```

--------------------------------

### tempDirName command line and config file examples

Source: https://stryker-mutator.io/docs/stryker-js/configuration/

Command line and config file examples for setting the temporary directory used during mutation testing. Default is '.stryker-tmp'.

```bash
--tempDirName .stryker-tmp
```

```json
"tempDirName": '.stryker-tmp'
```

--------------------------------

### Checkout pre-stryker branch and install dependencies

Source: https://stryker-mutator.io/docs/General/example/

Steps back in history to the 'pre-stryker' branch and installs dependencies, preparing for manual Stryker installation.

```shell
git checkout pre-stryker
npm install
```

--------------------------------

### tap.nodeArgs examples table

Source: https://stryker-mutator.io/docs/stryker-js/tap-runner/

Table showing example nodeArgs configurations and the generated actual node arguments. Includes default, tsx, and Ava versions.

```text
[]
```

```text
["-r", "actual/hook.cjs", "test/foo.spec.js"]
```

```text
["--import", "tsx"]
```

```text
["-r", "actual/hook.cjs", "--import", "tsx", "test/foo.spec.js"]
```

```text
["node_modules/ava/entrypoints/cli.mjs", "--tap", "--node-arguments='-r {{hookFile}}'"]
```

```text
["node_modules/ava/entrypoints/cli.mjs", "--tap", "--node-arguments='-r actual/hook.cjs'", "test/foo.spec.js"]
```

```text
["node_modules/ava/entrypoints/cli.js", "--tap", "--node-arguments='-r {{hookFile}}'"]
```

```text
["node_modules/ava/entrypoints/cli.js", "--tap", "--node-arguments='-r actual/hook.cjs'", "test/foo.spec.js"]
```

--------------------------------

### Install Stryker globally with dotnet tool install -g

Source: https://stryker-mutator.io/docs/stryker-net/getting-started/

Installs Stryker.NET as a global dotnet tool, making it available system-wide. Requires dotnet 10 runtime or newer.

```bash
dotnet tool install -g dotnet-stryker
```

--------------------------------

### testRunnerNodeArgs debugging example

Source: https://stryker-mutator.io/docs/stryker-js/configuration/

Command line example for debugging the test runner child process using --inspect-brk.

```bash
--timeoutMS 9999999 --concurrency 1 --testRunnerNodeArgs "--inspect-brk"
```

--------------------------------

### Clone the RoboCoasters repository

Source: https://stryker-mutator.io/docs/General/example/

Clones the example repository from GitHub. Requires git to be installed.

```shell
git clone https://github.com/stryker-mutator/robo-coasters-example
```

--------------------------------

### package.json scripts with tsx loader for cucumber-js

Source: https://stryker-mutator.io/docs/stryker-js/cucumber-runner/

Example package.json scripts that use cross-env and NODE_OPTIONS to import tsx for cucumber-js. This setup is used to just-in-time transpile TypeScript code with native ESM.

```json
{
  "scripts": {
    "test": "cross-env NODE_OPTIONS=\"--import tsx\" cucumber-js",
    "test:mutation": "stryker run"
  }
}
```

--------------------------------

### concurrency command line and config file examples

Source: https://stryker-mutator.io/docs/stryker-js/configuration/

Examples for setting concurrency via command line or config file. Supports a number or a percentage string, e.g., '50%'.

```text
--concurrency 4
```

```text
--concurrency 50%
```

```json
"concurrency": 4
```

```json
"concurrency": "50%"
```

--------------------------------

### Supertest test suite for API routes

Source: https://stryker-mutator.io/docs/stryker-js/parallel-workers/

Test suite using supertest to test the GET /home and POST /echo routes. It starts the server on a fixed port 4444, which can cause conflicts when Stryker runs multiple test runners in parallel.

```javascript
// index.test.js

const server = require('../src/index.js');
const supertest = require('supertest');

describe('API tests', () => {
  let app;
  let port = 4444;

  beforeAll(() => {
    app = server.listen(port);
  });

  afterAll(() => {
    app.close();
  });

  test('GET /home', async () => {
    await supertest(server)
      .get('/home')
      .expect(200)
      .then((response) => expect(response.text).toBe('Hello World!'));
  });

  test('POST /echo - non-empty request body', async () => {
    const body = { john: 'doe', marilyn: 'monroe' };
    await supertest(server)
      .post('/echo')
      .send(body)
      .expect(200)
      .then((response) => expect(response.body).toStrictEqual(body));
  });
});
```

--------------------------------

### testFiles command line and config file examples

Source: https://stryker-mutator.io/docs/stryker-js/configuration/

Command line and config file examples for limiting which test files are executed during mutation testing. Default is an empty array.

```bash
--testFiles "foo/tests/**/*.spec.js","bar/tests/**/*.test.js"
```

```json
"testFiles": ["foo/tests/**/*.spec.js", "bar/tests/**/*.test.js"]
```

--------------------------------

### Ignore methods option in stryker-config.json

Source: https://stryker-mutator.io/docs/stryker-net/ignore-mutations/

Use the 'ignore-methods' option to ignore specific method calls. The example shows patterns to ignore methods ending with 'Log', methods starting with 'Write' in the Console class, and all exception constructors. Note that this only ignores mutations inside the method calls, not the method declaration.

```json
"stryker-config": {
    "ignore-methods": [
        "*Log", // Ignores all methods ending with Log
        "Console.Write*", // Ignores all methods starting with Write in the class Console
        "*Exception.ctor" // Ignores all exception constructors
    ]
}
```

--------------------------------

### Install dependencies for RoboCoasters

Source: https://stryker-mutator.io/docs/General/example/

Changes into the project directory and installs dependencies using npm. Requires Node.js to be installed.

```shell
cd robo-coasters-example
npm install
```

--------------------------------

### Install @stryker-mutator/vitest-runner

Source: https://stryker-mutator.io/docs/stryker-js/vitest-runner/

Install the plugin locally within your project folder. The plugin does not include its own vitest; you must install your own version.

```bash
npm i --save-dev @stryker-mutator/vitest-runner
```

--------------------------------

### Command line example for incrementalFile

Source: https://stryker-mutator.io/docs/stryker-js/configuration/

Specifies an alternative file for incremental mode via command line.

```bash
--incrementalFile reports/stryker-incremental-alternative.json
```

--------------------------------

### Install StrykerJS packages for Angular with Jest

Source: https://stryker-mutator.io/docs/stryker-js/guides/angular/

Install the required StrykerJS packages using npm. This command installs @stryker-mutator/core and @stryker-mutator/jest-runner as dev dependencies.

```shell
npm i -D @stryker-mutator/core @stryker-mutator/jest-runner
```

--------------------------------

### CLI arguments example: sbt stryker --base-dir --mutate

Source: https://stryker-mutator.io/docs/stryker4s/configuration/

Shows how to pass configuration options as command-line arguments. Options are kebab-case and case-insensitive. Use --help to see all options and short versions.

```sh
sbt stryker --base-dir submodule1 --mutate "**/main/scala/**/*.scala"
```

--------------------------------

### Config file example for incremental

Source: https://stryker-mutator.io/docs/stryker-js/configuration/

Enables incremental mode, storing results in a file to speed up the next run.

```json
"incremental": true
```

--------------------------------

### Install @stryker-mutator/api

Source: https://stryker-mutator.io/docs/stryker-js/guides/create-a-plugin/

Installs the @stryker-mutator/api package as a dependency for your plugin.

```shell
npm install @stryker-mutator/api
```

--------------------------------

### Install @stryker-mutator/api

Source: https://stryker-mutator.io/docs/stryker-js/disable-mutants/

Install `@stryker-mutator/api` as a dev dependency to declare an ignore-plugin.

```text
npm i -D @stryker-mutator/api
```

--------------------------------

### testRunner command line and config file examples

Source: https://stryker-mutator.io/docs/stryker-js/configuration/

Command line and config file examples for specifying the test runner. Default is 'command'. The command runner runs a configurable bash/cmd command and bases the result on the exit code.

```bash
--testRunner karma
```

```json
"testRunner": "karma"
```

--------------------------------

### Install @stryker-mutator/jasmine-runner

Source: https://stryker-mutator.io/docs/stryker-js/jasmine-runner/

Install the Jasmine runner plugin as a dev dependency.

```bash
npm i --save-dev @stryker-mutator/jasmine-runner
```

--------------------------------

### Install TypeScript checker

Source: https://stryker-mutator.io/docs/stryker-js/guides/angular/

Install the @stryker-mutator/typescript-checker package as a development dependency.

```bash
npm install --save-dev @stryker-mutator/typescript-checker
```

--------------------------------

### Config file example: stryker4s.conf

Source: https://stryker-mutator.io/docs/stryker4s/configuration/

Shows the HOCON-format configuration file read from the project root. All configuration must be in the 'stryker4s' namespace and in kebab-case.

```conf
stryker4s {
  base-dir = "submodule1"
  mutate = [ "**/main/scala/**/*.scala" ]
  # Your configuration here
}
```

--------------------------------

### Install Stryker packages for Angular

Source: https://stryker-mutator.io/docs/stryker-js/guides/legacy/stryker-3/angular/

Install the required Stryker packages for Angular projects using npm. This command installs the core, karma-runner, typescript, and html-reporter packages at version 3.

```bash
npm i -D @stryker-mutator/core@3 @stryker-mutator/karma-runner@3 @stryker-mutator/typescript@3 @stryker-mutator/html-reporter@3
```

--------------------------------

### Install @stryker-mutator/karma-runner

Source: https://stryker-mutator.io/docs/stryker-js/karma-runner/

Install the plugin locally within your project folder using npm.

```bash
npm i --save-dev @stryker-mutator/karma-runner
```

--------------------------------

### Example stryker-config.yaml file

Source: https://stryker-mutator.io/docs/stryker-net/configuration/

YAML configuration file with solution and project paths. The file must be named stryker-config.yaml and placed in the test project folder.

```yaml
  stryker-config:
    solution: '../SolutionFile.sln'
    project: 'ExampleProject.csproj'
```

--------------------------------

### Install @stryker-mutator/cucumber-runner

Source: https://stryker-mutator.io/docs/stryker-js/cucumber-runner/

Install the plugin locally within your project folder using npm.

```shell
npm i --save-dev @stryker-mutator/cucumber-runner
```

--------------------------------

### Config file example for inPlace

Source: https://stryker-mutator.io/docs/stryker-js/configuration/

Enables in-place mutation, overriding files but keeping originals in temp directory.

```json
"inPlace": true
```

--------------------------------

### warnings config file example

Source: https://stryker-mutator.io/docs/stryker-js/configuration/

Configures specific warnings. Default is true. Object allows enabling/disabling individual warnings like slow.

```json
"warnings": { "slow": false }
```

--------------------------------

### Install dotnet-stryker in Azure DevOps pipeline

Source: https://stryker-mutator.io/docs/stryker-net/stryker-in-pipeline/

Use DotNetCoreCLI@2 task with custom command to install dotnet-stryker to a local folder using --tool-path. This avoids issues with global tool installation in pipelines.

```yaml
- task: DotNetCoreCLI@2
    displayName: 'Install dotnet-stryker'
    inputs:
      command: custom
      custom: tool
      arguments: install dotnet-stryker --tool-path $(Agent.BuildDirectory)/tools
```
Tokens:
Raw