jest-runtime

What is jest-runtime?

The jest-runtime package is part of the Jest testing platform. It is responsible for executing tests and their associated code within a controlled environment. It handles the evaluation of the test files, mocking of modules, and provides utilities for loading and running the tests.

What are jest-runtime's main functionalities?

Module Mocking

Allows you to mock modules to isolate your tests from their dependencies, providing a way to test modules in isolation.

jest.mock('moduleName');

Test Environment Setup

Enables you to programmatically create a test environment, including the haste map (module map) and the test runner, which can be used to execute test files.

const runtime = require('jest-runtime');
// Create a runtime to execute the test
runtime.createHasteMap(config).then(hasteMap => {
  const environment = new runtime.TestEnvironment(config);
  const runner = new runtime.TestRunner(environment, hasteMap.resolver);
  // Execute the test file
  runner.runTest(filePath);
});

Script Transformation

Provides the ability to transform scripts using Jest's built-in transformers or custom ones. This is useful for preprocessing files before they are executed in the test environment.

const runtime = require('jest-runtime');
// Create a new runtime instance
const jestRuntime = new runtime.ScriptTransformer(config);
// Transform a script
const transformedCode = jestRuntime.transformSource(filePath, fileContent, false);

Other packages similar to jest-runtime

mocha

Mocha is a feature-rich JavaScript test framework running on Node.js and in the browser, making asynchronous testing simple. It is similar to jest-runtime in that it provides a test environment and runner, but it does not include a built-in mocking library or script transformation capabilities.

jasmine

Jasmine is a behavior-driven development framework for testing JavaScript code. It does not require a DOM, and it has a clean, obvious syntax so that you can easily write tests. It is similar to jest-runtime in providing an environment for running tests, but it has a different assertion library and does not handle module mocking and script transformation in the same way.

ava

AVA is a test runner for Node.js with a concise API, detailed error output, and process isolation that lets you develop with confidence. AVA is similar to jest-runtime in that it can run tests in parallel and supports the latest JavaScript features, but it differs in its approach to mocking and does not provide a built-in mechanism for script transformation.

README

The README file is missing

Changelog

27.4.0

Features

• [expect] Enhancing the toHaveProperty matcher to support array selection (#12092)
• [jest-core] Add support for testResultsProcessor written in ESM (#12006)
• [jest-diff, pretty-format] Add compareKeys option for custom sorting of object keys (#11992)
• [jest-mock] Add ts-jest mock util functions (#12089)

Fixes

• [expect] Allow again expect.Matchers generic with single value (#11986)
• [jest-circus, jest-jasmine2] Avoid false concurrent test failures due to unhandled promise rejections (#11987)
• [jest-config] Add missing slash dependency to package.json (#12080)
• [jest-core] Incorrect detection of open ZLIB handles (#12022)
• [jest-diff] Break dependency cycle (#10818)
• [jest-environment-jsdom] Add @types/jsdom dependency (#11999)
• [jest-environment-jsdom] Do not reset the global.document too early on teardown (#11871)
• [jest-transform] Improve error and warning messages (#11998)
• [jest-worker] Pass execArgv correctly to worker_threads worker (#12069)

Chore & Maintenance

• [docs] CLI options alphabetized (#11586)
• [jest-runner] Add info regarding timers to forcedExit message(#12083)
• [*] Replaced substr method with substring (#12066)
• [*] Add types entry to all export maps (#12073)