Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/stryker-mutator/robo-coasters-example
An example project for Stryker
https://github.com/stryker-mutator/robo-coasters-example
coverage javascript mutation-testing test-automation test-tools testing
Last synced: about 7 hours ago
JSON representation
An example project for Stryker
- Host: GitHub
- URL: https://github.com/stryker-mutator/robo-coasters-example
- Owner: stryker-mutator
- Created: 2018-04-09T06:29:52.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-08-22T07:57:02.000Z (3 months ago)
- Last Synced: 2024-08-22T09:04:36.231Z (3 months ago)
- Topics: coverage, javascript, mutation-testing, test-automation, test-tools, testing
- Language: JavaScript
- Homepage: https://stryker-mutator.io/robo-coasters-example
- Size: 6.82 MB
- Stars: 15
- Watchers: 4
- Forks: 33
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](https://stryker-mutator.io/robo-coasters-example/reports/coverage/lcov-report/index.html)
[](https://dashboard.stryker-mutator.io/reports/github.com/stryker-mutator/robo-coasters-example/master)
# Welcome to RoboCoasters
> An introduction to mutation testing
_How code coverage of 100% could mean only 60% is tested._
## TL;DR
No time to run the example yourself? Don't worry; we did it for you. Open it right in your browser:
- [The RoboCoasters website](https://stryker-mutator.io/robo-coasters-example/)
- [Coverage report](https://stryker-mutator.io/robo-coasters-example/reports/coverage/lcov-report/index.html)
- [Mutation report](https://dashboard.stryker-mutator.io/reports/github.com/stryker-mutator/robo-coasters-example/master)
## What is this?
RoboCoasters is a small application to demo mutation testing. It has a fair amount of unit tests. We didn't try our best to write bad tests when we wrote this application. We just focussed on code coverage and didn't practice Test Driven Development. It turns out it's easy to write bad tests or forget a few important test cases. RoboCoasters even has a fairly large bug. Finding it is easy using the mutation report. Why don't you give it a try? 😁
**Note:** Robo coasters is developed using [native web components](https://developer.mozilla.org/en-US/docs/Web/Web_Components) without a frontend framework. This is done on purpose to keep this example as accessible as possible and to keep the maintenance burden low.
## Try it yourself
1. Install [git](https://git-scm.com)
1. Install [nodejs](https://nodejs.org/)
1. Open command prompt and clone this repository:
```shell
git clone https://github.com/stryker-mutator/robo-coasters-example
```
1. Change directory into `robo-coasters-example` and install the dependencies.
```shell
cd robo-coasters-example
npm install
```
1. Run tests with npm. This will generate a code coverage report.
```shell
npm test
```
1. Review the 100% code coverage score. Open up the code coverage report in the `reports/coverage/lcov-report` directory.
1. Run mutation testing with [Stryker](https://stryker-mutator.io)
```shell
npm run test:mutation
```
1. Review the less than 60% mutation score. Open up the mutation report in the `reports/mutation` directory.
1. Run the website with `npm start`. Can you find the bug?
## Try to install stryker yourself.
If you want to install stryker yourself, step back in history using git:
```shell
git checkout pre-stryker
npm install
```
After that you can install stryker for yourself:
```shell
npm init stryker
```
Choose the following options in the questionnaire:
- **Are you using one of these frameworks?** `None/other`
- **Which test runner do you want to use?** `jest`
- **Reporters**: `html`, `clear-text`, `progress`
- **Which package manager do you want to use?**: `npm`
- **What file type do you want for your config file?**: `json`
After the plugins are installed, open the `stryker.conf.json` file and make the following change:
```diff
{
"$schema": "./node_modules/@stryker-mutator/core/schema/stryker-schema.json",
"_comment": "This config was generated using 'stryker init'. Please take a look at: https://stryker-mutator.io/docs/stryker-js/configuration/ for more information",
"packageManager": "npm",
"reporters": [
"html",
"clear-text",
"progress",
"dashboard"
],
"testRunner": "jest",
- "coverageAnalysis": "perTest"
+ "coverageAnalysis": "perTest",
+ "testRunnerNodeArgs": ["--experimental-vm-modules"]
}
```
(this is needed because we're using [jest with ECMAScript modules](https://jestjs.io/docs/ecmascript-modules))
After the plugins are installed, try it out:
```shell
npx stryker run
```