npmpackage.info

find-related-tests-js

Find related tests only for changed files in branch. Flexible alternate for jest findRelatedTests

1.3.0

TypeScript

1.01 MB

Installations

npm install find-related-tests-js

Developer Guide

BETA

Typescript

Yes

Module System

CommonJS

Node Version

10.15.3

NPM Version

6.4.1 Score

61.2

Supply Chain

91.9

Quality

71.4

Maintenance

Vulnerability

97.3

License

Pull Requests

Open

8

Total

9

Closed

1

Issues

Open

0

Total

0

Closed

0

Releases

1.2.80

Published on 19 May 2020

1.2.60

Published on 19 May 2020

Release master

v1.2.02

Published on 19 May 2020

View all 3 releases

Contributors

Unable to fetch Contributors

View all 2 contributors

Languages

TypeScript

JavaScript

TypeScript (76.41%)

JavaScript (23.59%)

Developer

tak2siva

Download Statistics

Total Downloads

3,846

Last Day

Last Week

Last Month

Last Year

339

GitHub Statistics

2 Stars

14 Commits

1 Forks

2 Watching

9 Branches

2 Contributors

Bundle Size

3.89 MB

Minified

1.01 MB

Minified + Gzipped

Bundlephobia

Maintainers

Package Meta Information

Latest Version

1.3.0

Package Id

find-related-tests-js@1.3.0

Unpacked Size

148.51 kB

Size

57.35 kB

File Count

NPM Version

6.4.1

Node Version

10.15.3

Total Downloads

Cumulative downloads

Total Downloads

3,846

Last day

Compared to previous day

Last week

-46.5%

Compared to previous week

Last month

1,260%

Compared to previous month

Last year

-36.5%

339

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

@types/dependency-tree @types/node dependency-tree loglevel yargs

Dev Dependencies

@types/chai @types/loglevel @types/mocha @types/yargs chai mocha nyc ts-node typescript

Versions

find-related-tests-js

Sometimes we need not run all unit tests in our project. This library will try to find the related files(i.e import files) of all files changed in current branch.

This library can be an alternate for jest findRelatedTests or jest changedSince with much more flexibility. Here consumers are responsible to map test file for each related source file.

npm install --save find-related-tests-js

Usage

Provide changeSet i.e files modified in git as input stream.
This library will load and process dependency graph for the application and provide the following three callbacks to identify related test files.

Callbacks:

sourceFileModifiedCb(fileName, accumulator) => This will be called if a file name found in changeSet. Use this to map test file for modified source file.
directDependencyModifiedCb(fileName, accumulator) => This will be called if any of the imports of a file is modified.
transitiveDependencyModifiedCb(fileName, accumulator) => This will be called if one of transitive dependency is modified.

Accumulator:

Every callback provides this to add test file name for give source file like accumulator.add(testFileName). The result will be unique so need to not worry about duplicates.

// config.js
// mandatory parameters

function mapSourceToTestFiles(sourceFile, accumulator) {
    if (sourceFile.indexOf('.test.js') >= 1) {
        // Add if this is already a test file
        accumulator.add(sourceFile)
        return
    }

    if (sourceFile.indexOf('.js') >= 1) {
        // Map multiple test files for single source file
        accumulator.add(sourceFile.replace(/\.js/, '.test.js'));
        accumulator.add(sourceFile.replace(/\.js/, '.snapshot.js'));
    }
}

module.exports = {
    entryPoint: '/react/sample/App.js',
    searchDir: '/react/sample',
    dependencyExcludeFilter: path => path.indexOf('node_modules') === -1, // Ignore node module from dep graph
    // It is okay to add same file name in multiple callback
    // result will be unique
    sourceFileModifiedCb: mapSourceToTestFiles,
    directDependencyModifiedCb: mapSourceToTestFiles,
    transitiveDependencyModifiedCb: (sourceFile, accumulator) => {
        // This will be called if any transitive dependency is modified
        // A -> B -> C -> D
        // C & D are transitive dependency for A
    },
    outputFile: '/react/temp.txt',
}

Run via command line

To findRelatedTests for staged files in Git

git diff --name-only | xargs printf -- "$PWD/%s\n" | find-related-tests-js --configPath $PWD/config.js --entryPoint $PWD/App.js --searchDir $PWD/src --outputFile temp.txt

To findRelatedTests for files committed but not pushed

git diff --name-only origin..head | xargs printf -- "$PWD/%s\n" | find-related-tests-js --configPath $PWD/config.js --entryPoint $PWD/App.js --searchDir $PWD/src --outputFile temp.txt

If you have not installed this package globally then use ./node_modules/find-related-tests-js/dist/cli.js as executable.

Test Runner

Above command will find all related test files and write their path to configured output file. Run test candidates with required runner

yarn jest $(cat temp.txt)

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Maintained

Determines if the project is "actively maintained".

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

SAST

Determines if the project uses static code analysis.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

License

Determines if the project has defined a license.

0

Signed-Releases

Determines if the project cryptographically signs release artifacts.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

2

/10

Last Scanned on 2025-01-27

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More