Skip to content
A next-generation code testing stack for JavaScript.
TypeScript JavaScript Other
Branch: master
Clone or download
Latest commit b6f0068 Feb 14, 2020
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Update issue template Sep 5, 2017
docs chore: update api docs Feb 14, 2020
schemas Retry sessions (#1005) Jan 24, 2020
scripts build: use parent stdio for test commands Feb 6, 2020
src feat: add xsuite, xtest, xit, and xdescribe methods (#1090) Feb 14, 2020
tests
.commitlintrc.json build: add commitlint Feb 6, 2020
.editorconfig
.eslintrc.json Updated mocking, webpack-based unit tests Jan 13, 2020
.gitignore Intern build improvements Feb 3, 2020
.prettierrc.json Switch to eslint and husky Jan 13, 2020
.travis.yml Update slack notifications Mar 3, 2019
CONTRIBUTING.md Update contributor doc Feb 3, 2020
LICENSE Update license Feb 18, 2017
README.md chore: switch to Travis badge in README Feb 6, 2020
intern.json build: Enabled functional retries for CI tests Feb 6, 2020
package-lock.json build: add commitlint Feb 6, 2020
package.json build: add commitlint Feb 6, 2020
tsconfig-bin.json Improve IE and Windows support Jan 20, 2020
tsconfig-browser.json Improve IE and Windows support Jan 20, 2020
tsconfig-examples.json Initial reunion of main projects Jan 13, 2020
tsconfig-lib.json Improve IE and Windows support Jan 20, 2020
tsconfig-tests.json Improve IE and Windows support Jan 20, 2020
tsconfig.json Intern build improvements Feb 3, 2020
webpack-tests.config.ts
webpack.config.ts build: use parent stdio for test commands Feb 6, 2020

README.md

Intern

Software testing for humans

CI status codecov Average time to resolve an issue Percentage of issues still open FOSSA Status


Intern logo


⚠️ This documentation is for the development version of Intern. For the current release version, go here.

Intern is a complete test system for JavaScript designed to help you write and run consistent, high-quality test cases for your JavaScript libraries and applications. It can be used to test any JavaScript code.

  • Plain JavaScript code, in any module format (or no module format!)
  • Web pages generated by server-side languages (like Java, PHP, or Ruby)
  • Native or hybrid iOS, Android, and Firefox OS applications
  • TypeScript code when running in Node, with no additional config

Intern is minimally prescriptive and enforces only a basic set of best practices designed to ensure your tests stay maintainable over time. Its extensible architecture allows you to write custom test interfaces, executors, and reporters to influence how your tests run & easily integrate with your existing coding environment. Intern also comes with Grunt tasks so it can be quickly added to existing Grunt-based workflows, and is designed to work out-of-the-box with popular continuous integration services like Jenkins and Travis CI.

If you’re into name-dropping, Intern gets used every day by teams at Twitter, Stripe, Mozilla, IBM, Marriott, Philips, Zenput, Alfresco, Esri, HSBC, ING, Intuit, and more. It’s also the testing framework of choice for growing numbers of open-source projects.

💡 If you’re an Intern user who’s new to Intern 4, see the Changes from Intern 3 document for a summary of the major differences. For Intern 3 documentation, please see the Intern 3 README.

💡 Recently updated your browser and your WebDriver tests stopped working? You may need to pin your WebDriver versions.

Quick start

  1. Install from npm

    $ cd /my/project
    $ npm install intern
  2. Create an intern.json file in your project root.

    {
      "suites": "tests/unit/**/*.js"
    }
  3. Verify that your configuration works by running Intern and checking that no errors are output.

    $ ./node_modules/.bin/intern
  4. Start writing tests!

TypeScript setup

Intern installs a global variable that tests may not be aware of if nothing imports the base intern package. To ensure Intern’s types are loaded, add the following to your tsconfig.json:

{
  "compilerOptions": {
    "types": ["intern"]
  }
}

Alternatively, add a triple-slash directive to the top of your suite files:

/// <reference types="intern" />

Compatibility

Intern can run unit tests in most browsers that support ECMAScript 5, including mobile browsers on Android and iOS, and in Node 6+. Note that Internet Explorer versions below 11 are not supported.

Intern’s self-tests run against IE 11, Safari 13, and the most recent few vesions of Firefox, Chrome, and Chromium Edge, as well as the latest LTS and current versions of Node.

Intern can run functional tests using WebDriver-compatible applications and services, including Selenium, Appium, Selendroid. It has built-in support for cloud testing services from BrowserStack, CrossBrowserTesting, SauceLabs, and TestingBot.

More information

Get help

The best place to ask questions and get answers about Intern is Stack Overflow. Just tag your question with intern. If you have more immediate questions, or just want to chat with other people interested in Intern, join the Gitter room at theintern/intern. See the Help page for more information.

License

Intern is a JS Foundation project offered under the New BSD license.

FOSSA Status

© SitePen, Inc. and its contributors

Intern’s self-tests run on
BrowserStack logo

You can’t perform that action at this time.