How can Karma unit tests with Jasmine in a TypeScript Node project accurately measure code coverage, even with external dependencies?

Question

How can Karma unit tests with Jasmine in a TypeScript Node project accurately measure code coverage, even with external dependencies?

We have a unique situation with the code coverage of our project involving a node dependency. It's important to note that the npm dependency source code is actually part of our project, as we are responsible for its development and publication. Here's an overview of the project structure:

root
- main_project
  - karma.conf.ts
  - src and other files to be tested and for which the coverage is to be generated
  - test
- side_project which is packaged and published to npm and used across multiple projects including this one
  - src etc.

Despite the karma config being located within the main_project folder, where we want to focus on testing and generating coverage, karma includes the side_project in the coverage report as well. You can see this illustrated here: https://i.sstatic.net/3CwRK.png

Below is the relevant karma configuration:

const testRecursivePath = "test/*Test.ts";
const srcOriginalRecursivePath = "src/**/*.ts";
frameworks: ["jasmine"],
reporters: [
    "progress",
    "junit",
    "coverage-istanbul"
],
files: [
    testRecursivePath,
    {
        pattern: srcOriginalRecursivePath,
        included: false,
        served: true
    }
],
preprocessors: {
    [testRecursivePath]: ["webpack", "coverage"]
},

If anyone could offer assistance with this issue, it would be greatly appreciated.

typescript karma-jasmine istanbul karma-coverage

Answer 1

Answer №1

If you want to exclude specific files in your karma.conf configuration, you can use the following example to exclude all .ts files within the node_modules folder. Pay attention to the relative path provided in the example below. You also have the option to ignore all files using **.*.

exclude: [
        "node_modules/**/*.ts"
]

You can implement this as shown below:

const testRecursivePath = "test/*Test.ts";
const srcOriginalRecursivePath = "src/**/*.ts";
frameworks: ["jasmine"],
reporters: [
    "progress",
    "junit",
    "coverage-istanbul"
],
files: [
    testRecursivePath,
    {
        pattern: srcOriginalRecursivePath,
        included: false,
        served: true
    }
],
exclude: [
        "node_modules/**/*.ts"
]
preprocessors: {
    [testRecursivePath]: ["webpack", "coverage"]
},

Answer 2

If you want to exclude specific files in your karma.conf configuration, you can use the following example to exclude all .ts files within the node_modules folder. Pay attention to the relative path provided in the example below. You also have the option to ignore all files using **.*.

exclude: [
        "node_modules/**/*.ts"
]

You can implement this as shown below:

const testRecursivePath = "test/*Test.ts";
const srcOriginalRecursivePath = "src/**/*.ts";
frameworks: ["jasmine"],
reporters: [
    "progress",
    "junit",
    "coverage-istanbul"
],
files: [
    testRecursivePath,
    {
        pattern: srcOriginalRecursivePath,
        included: false,
        served: true
    }
],
exclude: [
        "node_modules/**/*.ts"
]
preprocessors: {
    [testRecursivePath]: ["webpack", "coverage"]
},

How can Karma unit tests with Jasmine in a TypeScript Node project accurately measure code coverage, even with external dependencies?

Answer №1

Similar questions

Which components can be interacted with in Protractor?

Setting up VSCode to run various tasks

Executing cypress tests with tags in nrwl nx workspace: A simple guide

I am experiencing a strange situation in node.js where the `then` condition of a Promise is not being executed as expected

Convert C# delegate into TypeScript

What is the best method to adjust the width of the PrimeNG ConfirmDialog widget from a logic perspective

Error in TypeScript: The property "component" is not found on the React MUI MenuItem

Creating and managing global context with useReducer in TypeScript and React

I keep encountering the following error message: " ERROR Error Code: 200 Message: Http failure during parsing for http://localhost:3000/login"

Is it necessary to include a module in another module if it is not utilized in the template?

Using Nestjs to inject providers into new instances of objects created using the "new" keyword

Encountering an Angular 13 ChunkLoadError during application deployment, despite the presence of the respective chunk

Is There a Comparable Feature to *ngIf in DevExtreme?

Exploring the usage of intervalTimer with async and fakeAsync functions

Component that can be used multiple times to load data

Find the identifier that does not currently exist in the collection of objects

Encountering difficulty invoking a component method from d3's call() function

Encountered an issue loading resource: net::ERR_BLOCKED_BY_CLIENT while attempting to access NuxtJS API

Looking for guidance on creating a TypeScript interface within React?

Using asynchronous functions in a loop in Node.js