Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add test coverage for client and component libraries #371

Open
jbrunton opened this issue Dec 1, 2024 · 0 comments
Open

Add test coverage for client and component libraries #371

jbrunton opened this issue Dec 1, 2024 · 0 comments

Comments

@jbrunton
Copy link
Collaborator

jbrunton commented Dec 1, 2024

Right now there are two 'core' packages:

  • packages/metrics – This is the code for computing flow metrics, forecasts and chart data.
  • apps/api – This is the code for the application API, which is responsible for syncing and storing data and configuration options.

There are also packages focused on web client concerns:

  • packages/components – Common components for displaying issues and reports.
  • packages/charts – Charts for displaying flow metrics.
  • apps/client – The web client itself.

The core packages (and also packages/lib) have decent test coverage, because they are crucial to syncing and storing data, and to computing that data correctly. It's therefore essential that they are tested to ensure data are correct.

The client packages should ideally be tested, but not to the same degree. For now, they aren't tested, and while that could lead to occasional bugs in the UX, it won't lead to incorrect data.

For this reason, Sonar Cloud is configured to compute coverage metrics only for the core packages (and lib). Coverage metrics are therefore incomplete for the project, but provide a meaningful summary of coverage of the core packages.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant