angular / angular/angular-cli

ng test: Collect total code coverage in multi project repository

Open
#11,268 6 comments 29 reactions 0 assignees View on GitHub
area: @angular-devkit/build-angular devkit/build-angular:karma feature feature: under consideration
Dominant language
TypeScript
Stars
27k
Forks
11.8k
Avg merge
14h 23m
Merged PRs (30d)
162

Description

### Bug Report or Feature Request (mark with an `x`)
```
- [ ] bug report -> please search issues before submitting
- [x] feature request
```

### Area
```
- [x] devkit
- [ ] schematics
```

### Versions

```
Angular CLI: 6.0.8
Node: 8.9.1
OS: win32 x64
Angular: 5.2.11
... animations, common, compiler, compiler-cli, core, forms
... http, language-service, platform-browser
... platform-browser-dynamic, router

Package Version
-----------------------------------------------------------
@angular-devkit/architect 0.6.8
@angular-devkit/build-angular 0.6.8
@angular-devkit/build-optimizer 0.6.8
@angular-devkit/core 0.6.8
@angular-devkit/schematics 0.6.8
@angular/cdk 5.2.5
@angular/cli 6.0.8
@ngtools/json-schema 1.1.0
@ngtools/webpack 6.0.8
@schematics/angular 0.6.1
@schematics/update 0.6.8
ng-packagr 3.0.2
rxjs 6.2.1
typescript 2.6.2
webpack 4.8.3
```

### Repro steps

Multi project workspace, run `ng test` to test all projects.

### The log given by the failure

Produced coverage report in `coverage/lcov.info` only contains results for the last run code coverage.

HTML reports are stored per project in `coverage/`.

### Desired functionality

Write indivudual lcovs per project, e.g, `coverage//lcov.info`, allowing users to get a total code coverage for the whole project.

Alternative would be functionality similar to [istanbul-combine](https://github.com/jamestalmage/istanbul-combine). Write `coverage.json` for each project and write a combined coverage report and end of test runs.

### Mention any other details that might be useful

Should eht changes be made in the builder or in the schematic?

https://github.com/angular/angular-cli/blob/master/packages/schematics/angular/library/files/__projectRoot__/karma.conf.js#L19

https://github.com/angular/angular-cli/blob/master/packages/schematics/angular/application/files/root/karma.conf.js#L19

Contributor guide

Open the contributing guide

Research direction

Start by reproducing the multi-project workspace case with `ng test`, then inspect the referenced `karma.conf.js` files under the application and library schematics. Trace whether coverage handling belongs in the builder or schematic; done means each project has its own lcov data and a combined report can represent total coverage.

Written by the indexing model from the issue text.

Assessment

Tech stack
angular, typescript
Domain
cli, testing
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.