volkswagen README

The project's README from github.com/auchenberg/volkswagen. As one markdown file: README.md.

volkswagen

Volkswagen detects when your tests are being run in a CI server, and makes them pass.

Build status js-standard-style volkswagen status

Why?

If you want your software to be adopted by Americans, good tests scores from the CI server are very important. Volkswagen uses a defeat device to detect when it's being tested in a CI server and will automatically reduce errors to an acceptable level for the tests to pass. This will allow you to spend less time worrying about testing and more time enjoying the good life as a trustful software developer.

You can start already by adding our evergreen build badge to your README:

Volkswagen status

Markdown snippet:

[![volkswagen status](https://auchenberg.github.io/volkswagen/volkswagen_ci.svg?v=1)](https://github.com/auchenberg/volkswagen)

Installation

npm install volkswagen

Usage

Just require volkswagen somewhere in your code-base - maybe in your main test file:

require('volkswagen')

Project status

CI servers detected:

Test suites defeated:

License

MIT

Credits

Heavily inspired by https://github.com/hmlb/phpunit-vw

volkswagen (auchenberg/volkswagen)

Searching Database…

What is this?Volkswagen is a joke Node.js library that detects when your test suite is running on a CI server and silently makes the tests pass, no matter what the actual results are.
Is this a real testing framework?No — it is not a framework you write tests with, it is a tiny prank module you require into your existing test suite that patches the results behind the scenes.
How do I add it to my tests?Install it with npm and then just require volkswagen somewhere in your code-base, typically in your main test file.
Does it need any special CI configuration to work?No extra config is needed for the CI servers it already knows about — it recognizes them automatically through standard CI or CONTINUOUSINTEGRATION environment variables.
Does it defeat every test framework out there?It only works against test tools that rely on throwing errors or setting a process exit code to signal failure, specifically listing assert, tap, tape, and chai, plus 'any test actually that set the exit code or throw an error'.
Why is it named Volkswagen?It is a wink at the 2015 Volkswagen diesel emissions scandal, reusing the term 'defeat device' for a piece of software that fakes passing results instead of real emissions compliance.
Which CI servers does it recognize out of the box?The README lists Travis CI, CircleCI, Jenkins, Hudson, Bamboo, TeamCity, Team Foundation Server, VSO CI, GitLab CI, Codeship, Drone.io, Magnum CI, Semaphore CI, AppVeyor, Buildkite, TaskCluster, GoCD, and Bitbucket Pipelines, plus any CI exposing the generic CI or CONTINUOUSINTEGRATION env vars.
Should I actually ship this in a real project?No — it is satire about gaming CI checks; using it means your 'passing' build badge is a lie, which defeats the entire point of having tests.
Creator
auchenberg
Size
0.2 MB
Stars
15.5K
Updated
CommitFeb 27
Age
11y
Commits · 90 Days