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

feat: add explicit check against codeCoverage.expectFrontendCoverageOnly before attempting to collect backend coverage #555

Merged
merged 5 commits into from
Mar 25, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 15 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -251,6 +251,21 @@ After:

![Cypress knows to expect the backend code coverage only](./images/expect-backend.png)

### expectFrontendCoverageOnly

If there is ONLY frontend code coverage, set `expectFrontendCoverageOnly: true` in the `cypress.json` file. Otherwise, Cypress complains that it cannot find the frontend code coverage.

```json
{
"env": {
"codeCoverage": {
"url": "http://localhost:3003/__coverage__",
"expectFrontendCoverageOnly": true
}
}
}
```

## Custom report folder

You can specify a custom report folder by adding `nyc` object to the `package.json` file. For example, to save reports to `cypress-coverage` folder, use:
Expand Down
11 changes: 10 additions & 1 deletion support.js
Original file line number Diff line number Diff line change
Expand Up @@ -148,10 +148,19 @@ const registerHooks = () => {
const baseUrl = Cypress.config('baseUrl') || cy.state('window').origin
// @ts-ignore
const runningEndToEndTests = baseUrl !== Cypress.config('proxyUrl')
const expectFrontendCoverageOnly = Cypress._.get(
Cypress.env('codeCoverage'),
'expectFrontendCoverageOnly',
false
)
const specType = Cypress._.get(Cypress.spec, 'specType', 'integration')
const isIntegrationSpec = specType === 'integration'

if (runningEndToEndTests && isIntegrationSpec) {
if (
!expectFrontendCoverageOnly &&
runningEndToEndTests &&
isIntegrationSpec
) {
// we can only request server-side code coverage
// if we are running end-to-end tests,
// otherwise where do we send the request?
Expand Down
Loading