mattermost-community/focalboard

Auto-generate Cypress code coverage report

Open

#330 opened on Apr 24, 2021

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (26,187 stars) (2,542 forks)user submission
EnhancementHacktoberfestHelp WantedUp for grabs

Description

An issue to track adding code coverage reports to the Cypress test runs. I had looked into this briefly (Cypress docs), but found that it created conflicts with the Jest code coverage. If someone would like to try setting this up, please grab this ticket. Thanks!

Ideally, we would auto-generate code coverage reports on CI runs. If that takes too long (around +10s), we can move that to a separate workflow.

Bonus points: Create a combined Jest + Cypress code coverage report.

Contributor guide

Tech stack
typescriptcypressjest
Domain
testingci cd
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic knowledge of CypressBasic knowledge of JestFamiliarity with CI/CD
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60
Research direction
Review the Cypress code coverage documentation at https://docs.cypress.io/guides/tooling/code coverage. Investigate how to resolve conflicts with Jest code coverage, possibly by using separate coverage directories or combining reports. Consider integrating coverage generation into the existing CI workflow (likely GitHub Actions). If runtime is a concern, evaluate creating a separate workflow for coverage. Optionally, explore tools like nyc (istanbul) to merge Cypress and Jest coverage reports.