Guide · Open source
How to use volkswagen: install it and what it actually does
Updated · written with AI from the project's own documentation and checked against our catalogue data
Volkswagen is a small JavaScript npm package that checks whether your tests are running on a CI server and then makes them pass. This guide explains how to install it and load it, which CI servers and test suites the README lists, and why its results are misleading. It is written for developers who want to understand how this kind of CI detection works, not for teams that need reliable test results.
volkswagenauchenberg/volkswagen · ★ 15.5k · MIT Install options & downloads Quick start
- 1Install the package. Run npm install volkswagen in your project folder to add the package.
- 2Require it in your tests. Add require('volkswagen') somewhere in your code base, such as your main test file, as the README describes.
- 3Understand what it changes. Know that the package makes tests pass when it detects a CI server, so CI results no longer reflect real outcomes.
- 4Decide whether to keep it. Keep it only for learning or a throwaway experiment. For any real project, remove it and fix the failing tests instead.
What volkswagen does
Volkswagen detects when your tests are being run on a CI server, such as Travis CI or another system that sets a CI or CONTINUOUS_INTEGRATION environment variable. When it detects CI, it makes the tests pass.
The README presents the project as a joke that references the Volkswagen emissions scandal. It does not fix failing code. It hides failures from the CI server, so the reported results do not reflect real test outcomes.
Install volkswagen with npm
Volkswagen is distributed as an npm package. The README gives one install command. The source does not list any other prerequisites.
npm install volkswagenLoad volkswagen in your test code
The README says to require volkswagen somewhere in your code base, for example in your main test file. Requiring the package is what enables its CI detection.
require('volkswagen')Which CI servers and test suites it covers
The README lists CI servers it detects, including Travis CI, CircleCI, Jenkins CI, GitLab CI, AppVeyor, Buildkite and Bitbucket Pipelines, along with others. It also says it works with any CI server that exposes a CI or CONTINUOUS_INTEGRATION environment variable.
The README lists assert, tap, tape and chai as test suites it affects. It also says it applies to any test that sets the exit code or throws an error.
- CI servers: Travis CI, CircleCI, Jenkins CI, Hudson, Bamboo, TeamCity, GitLab CI, AppVeyor, Buildkite, Bitbucket Pipelines and more
- Test suites: assert, tap, tape, chai
Why you should not use it on real projects
The purpose of CI is to catch real bugs. Volkswagen makes failing tests pass on CI, which hides the problems that CI is supposed to report. Any quality gate or accurate test report built on those results is misleading by design.
If you want to learn how CI detection and exit codes work, read the source and run it on a throwaway project. Do not add it to a shared or production codebase.
What to do instead when tests fail
The source lists no comparable projects. When a test fails on CI, the useful response is to find out why: read the failing output, reproduce the failure locally, and fix the code or the test. A passing result that hides a real failure only moves the problem to users.
What people use it for
- Studying how a package can detect CI through environment variables
- Learning how test runners and exit codes can be manipulated
- Reading a satirical take on fake test results
- Understanding why CI results should not be overridden
Frequently asked questions
What is volkswagen?
Volkswagen is an npm package, written in JavaScript, that detects when tests run on a CI server and makes them pass. The README presents it as a joke that references the Volkswagen emissions scandal. It does not fix the code under test.
How do I install volkswagen?
Run npm install volkswagen in your project. Then require('volkswagen') somewhere in your code base, such as your main test file. The README lists no other prerequisites.
Is volkswagen free to use?
Yes. The package is licensed under the MIT license, as stated in the README and the project listing.
Does volkswagen fix failing tests?
No. It does not change the code under test. It hides test failures from the CI server, so the reported results are not real.
Which CI servers does volkswagen detect?
The README lists Travis CI, CircleCI, Jenkins CI, Hudson, Bamboo, TeamCity, Team Foundation Server, GitLab CI, Codeship, Drone.io, Semaphore CI, AppVeyor, Buildkite, TaskCluster, GoCD and Bitbucket Pipelines. It also covers any CI server that exposes a CI or CONTINUOUS_INTEGRATION environment variable.
Are there alternatives to volkswagen?
The source lists no comparable projects. For real test problems, fix the failing code or test rather than hiding the failure. Volkswagen is not a substitute for accurate test reports.
New agent skills, repos and AI tools — every week
The best new skills and open-source projects, the fastest-growing repos, and one free prompt. Five minutes to read. Unsubscribe anytime.
Our verdict
Volkswagen is only useful for developers who want to study CI environment detection or read a satirical take on fake test results. Do not use it on shared, production or quality-gated projects, because it hides real failures by design. Teams that need accurate CI results should keep their tests honest and fix the failures they report.
Install options & downloads