Skip to content

Commit bd09462

Browse files
bahmutovbahmutov
authoredApr 4, 2020
fix: improve spec filtering (#171)
* fix: better unit coverage filter * add to CI * fix path
·
v3.14.0v2.0.2
1 parent 732001d commit bd09462

14 files changed

+246
-4
lines changed
 

‎.circleci/config.yml

+28
Original file line numberDiff line numberDiff line change
@@ -168,6 +168,33 @@ workflows:
168168
command: npm run coverage:check
169169
working_directory: examples/ts-example
170170

171+
- cypress/run:
172+
attach-workspace: true
173+
name: example-same-folder
174+
requires:
175+
- cypress/install
176+
# there are no jobs to follow this one
177+
# so no need to save the workspace files (saves time)
178+
no-workspace: true
179+
command: npx cypress run --project examples/same-folder
180+
# store screenshots and videos
181+
store_artifacts: true
182+
post-steps:
183+
- run: cat examples/same-folder/.nyc_output/out.json
184+
# store the created coverage report folder
185+
# you can click on it in the CircleCI UI
186+
# to see live static HTML site
187+
- store_artifacts:
188+
path: examples/same-folder/coverage
189+
# make sure the examples captures 100% of code
190+
- run:
191+
command: npx nyc report --check-coverage true --lines 100
192+
working_directory: examples/same-folder
193+
# how to fail if the specific file coverage is not found?!
194+
- run:
195+
command: npx nyc report --check-coverage true --lines 100 --include unit-utils.js
196+
working_directory: examples/same-folder
197+
171198
- publish:
172199
filters:
173200
branches:
@@ -181,3 +208,4 @@ workflows:
181208
- example-before-each-visit
182209
- example-before-all-visit
183210
- example-ts-example
211+
- example-same-folder

‎examples/same-folder/.babelrc

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"plugins": ["istanbul"]
3+
}

‎examples/same-folder/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# example: same-folder
2+
3+
Check if test files are correctly filtered out

‎examples/same-folder/cypress.json

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"integrationFolder": ".",
3+
"testFiles": "**/spec.js",
4+
"supportFile": "support.js",
5+
"pluginsFile": "plugins.js"
6+
}

‎examples/same-folder/cypress/fixtures/example.json

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"name": "Using fixtures to represent data",
3+
"email": "hello@cypress.io",
4+
"body": "Fixtures are a great way to mock data for responses to routes"
5+
}

‎examples/same-folder/index.html

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
<body>
2+
Page body
3+
<script src="main-instrumented.js"></script>
4+
</body>

‎examples/same-folder/main-instrumented.js

+146
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎examples/same-folder/main.js

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
window.add = (a, b) => a + b
2+
3+
window.sub = (a, b) => a - b

‎examples/same-folder/package.json

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"name": "example-same-folder",
3+
"description": "Check if test files are correctly filtered out",
4+
"devDependencies": {},
5+
"scripts": {
6+
"cy:open": "../../node_modules/.bin/cypress open"
7+
}
8+
}

‎examples/same-folder/plugins.js

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
module.exports = (on, config) => {
2+
on('task', require('../../task'))
3+
on('file:preprocessor', require('../../use-babelrc'))
4+
}

‎examples/same-folder/spec.js

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
/// <reference types="cypress" />
2+
3+
import { reverse } from './unit-utils'
4+
5+
describe('coverage information', () => {
6+
before(() => {
7+
cy.log('visiting index.html')
8+
cy.visit('index.html')
9+
})
10+
11+
it('calls add', () => {
12+
cy.window()
13+
.invoke('add', 2, 3)
14+
.should('equal', 5)
15+
})
16+
17+
it('calls sub', () => {
18+
cy.window()
19+
.invoke('sub', 2, 3)
20+
.should('equal', -1)
21+
})
22+
23+
it('reverses a string', () => {
24+
expect(reverse('Hello')).to.equal('olleH')
25+
})
26+
})

‎examples/same-folder/support.js

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
import '../../support'

‎examples/same-folder/unit-utils.js

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
export const reverse = s =>
2+
s
3+
.split('')
4+
.reverse()
5+
.join('')

‎support.js

+4-4
Original file line numberDiff line numberDiff line change
@@ -134,8 +134,6 @@ if (Cypress.env('coverage') === false) {
134134

135135
after(function mergeUnitTestCoverage() {
136136
// collect and merge frontend coverage
137-
const specFolder = Cypress.config('integrationFolder')
138-
const supportFolder = Cypress.config('supportFolder')
139137

140138
// if spec bundle has been instrumented (using Cypress preprocessor)
141139
// then we will have unit test coverage
@@ -145,10 +143,12 @@ if (Cypress.env('coverage') === false) {
145143
if (unitTestCoverage) {
146144
// remove coverage for the spec files themselves,
147145
// only keep "external" application source file coverage
146+
const supportFile = Cypress.config('supportFile')
147+
const testFilePattern = Cypress.config('testFiles')
148148

149-
// does this handle unset support file?
150149
const isTestFile = (fileCoverage, filename) =>
151-
filename.startsWith(specFolder) || filename.startsWith(supportFolder)
150+
Cypress.minimatch(filename, testFilePattern) || filename === supportFile
151+
152152
const coverage = Cypress._.omitBy(window.__coverage__, isTestFile)
153153
sendCoverage(coverage, 'unit')
154154
}

0 commit comments

Comments
 (0)
Please sign in to comment.