mutation-testing-report-schema
Advanced tools
The mutation-testing-report-schema npm package provides a schema for mutation testing reports. It is used to validate and ensure consistency in the format of reports generated by mutation testing tools. Mutation testing is a method of software testing where the source code is modified in small ways to test if the existing test cases can detect the changes.
Schema Validation
The mutation-testing-report-schema provides a JSON schema to validate mutation testing reports. This ensures that the reports adhere to a standard structure, making it easier to process and analyze them.
{ "type": "object", "properties": { "files": { "type": "object" }, "schemaVersion": { "type": "string" } }, "required": ["files", "schemaVersion"] }Consistent Report Structure
By using the schema, reports generated by different mutation testing tools can have a consistent structure. This example shows a simple report structure with a file containing mutants and their statuses.
{ "files": { "example.js": { "mutants": [ { "id": "1", "status": "Killed", "mutatorName": "StringLiteral" } ] } }, "schemaVersion": "1.0" }The mutation-testing-elements package provides web components to visualize mutation testing reports. While mutation-testing-report-schema focuses on the structure and validation of the reports, mutation-testing-elements is about rendering and displaying the reports in a user-friendly way.
Stryker is a mutation testing framework for JavaScript and TypeScript. It generates mutation testing reports that can be validated against the mutation-testing-report-schema. Stryker focuses on the generation and execution of mutation tests, whereas mutation-testing-report-schema is concerned with the report format.
The json schema for mutation testing elements.
The schema can be found here.
Install it with npm like this:
$ npm i mutation-testing-report-schema
Use it from typescript or js (with babel)
import { schema } from 'mutation-testing-elements-schema';
For example, use AJV:
const schemaValidator = new Ajv();
schemaValidator.addSchema(schema, 'mutation-testing-report-schema');
schemaValidator.validate('mutation-testing-report-schema', {
/*.. report as json ...*/
});
Download the schema using https://www.unpkg.com/mutation-testing-report-schema@VERSION/dist/src/mutation-testing-report-schema.json
For the current version, see package.json.
3.3.0 (2024-09-11)
FAQs
The json schema for a mutation testing report.
The npm package mutation-testing-report-schema receives a total of 115,997 weekly downloads. As such, mutation-testing-report-schema popularity was classified as popular.
We found that mutation-testing-report-schema demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.