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

Code coverage plugin #430

Closed
16 tasks done
Tlacenka opened this issue Jan 23, 2024 · 0 comments · Fixed by #505
Closed
16 tasks done

Code coverage plugin #430

Tlacenka opened this issue Jan 23, 2024 · 0 comments · Fixed by #505
Assignees

Comments

@Tlacenka
Copy link
Collaborator

Tlacenka commented Jan 23, 2024

As a Code PushUp user, I want to be able to see my code coverage results in the Code PushUp report.

Acceptance criteria

  • Code coverage plugin is implemented.
  • The plugin has sufficient documentation of its interface and usage.
  • The plugin is covered by tests.
  • Its audits as well as issues can be checked in portal.
  • Preset for unit tests is added to our code-pushup.config.ts for dogfooding.
  • Integration tests are added to our code-pushup.config.ts via nx helper for dogfooding.
  • The plugin is published and referenced in our README.
  • The plugin is fully integrated to all CLI commands (project.json)

Implementation details

  • One can choose whether to only provide code coverage results or run a specified command first to collect results.
  • Paths to coverage results are provided either as an array (simple project) or deduced via nx helpers (uncovering path to project within workspace).
  • E2E should be implemented to test running a coverage command tool on our example repo.
  • Both integration and unit test results are used for dogfooding.
  • Audits are provided as a group for convenience.
  • A unified format is chosen for the expected results (currently between XML cobertura and LCOV).
  • Audit is a type of coverage (function, branch, condition, statement/line) for the whole project.
  • Issue is a finding of missing coverage (table can be filtered by folder for issues within one package).

Additional post-MVP features

#498

Detailed research available on demand.

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

Successfully merging a pull request may close this issue.

1 participant