Skip to content

Commit dfaed9b

Browse files
bahmutovbahmutov
authored
feat: find local files better (#197)
* chore: refactor * adding detecting folder that matches current folder root * move utility functions * feat: find matching folder example * add docker paths example to circleci * exclude utils file from coverage
1 parent 20a2a9a commit dfaed9b

File tree

16 files changed

+460
-53
lines changed

16 files changed

+460
-53
lines changed

‎.circleci/config.yml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,30 @@ workflows:
194194
../../node_modules/.bin/only-covered main.js
195195
working_directory: examples/before-all-visit
196196

197+
- cypress/run:
198+
attach-workspace: true
199+
name: example-docker-paths
200+
requires:
201+
- cypress/install
202+
# there are no jobs to follow this one
203+
# so no need to save the workspace files (saves time)
204+
no-workspace: true
205+
working_directory: examples/docker-paths
206+
command: '../../node_modules/.bin/cypress run'
207+
post-steps:
208+
# store the created coverage report folder
209+
# you can click on it in the CircleCI UI
210+
# to see live static HTML site
211+
- store_artifacts:
212+
path: examples/docker-paths/coverage
213+
- run:
214+
name: Check code coverage 📈
215+
command: |
216+
../../node_modules/.bin/check-coverage main.js
217+
../../node_modules/.bin/check-coverage second.js
218+
../../node_modules/.bin/only-covered main.js second.js
219+
working_directory: examples/docker-paths
220+
197221
- cypress/run:
198222
attach-workspace: true
199223
name: example-ts-example
@@ -395,3 +419,4 @@ workflows:
395419
- example-use-plugins-and-support
396420
- example-one-spec
397421
- example-exclude-files
422+
- example-docker-paths

‎examples/docker-paths/README.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
# example-docker-paths
2+
3+
In this example, the source files are "instrumented" as if they were instrumented inside a Docker container. Still, Cypress code coverage plugin should find the matching current folder where same files exist and update `.nyc_output/out.json` file before generating reports.
4+
5+
Source files from `app` folder were instrumented into `dist` folder with command
6+
7+
```shell
8+
$ npx nyc instrument app dist
9+
```
10+
11+
Then the `index.html` file was copied into `dist` folder.
12+
13+
Then the source paths in [dist/main.js](dist/main.js) and [dist/second.js](dist/second.js) were changed to non-existent prefix folder `/var/www/test/site`.
14+
15+
When Cypress runs, the `.nyc_output/out.json` is updated, so the path is valid local path like:
16+
17+
```
18+
{
19+
"/var/www/test/site/app/main.js": {
20+
"path": "/Users/gleb/git/code-coverage/examples/docker-paths/app/main.js",
21+
"statementMap": {
22+
...
23+
```
24+
25+
And the report has valid HTML with sources
26+
27+
![All files](images/files.png)
28+
29+
![Single file](images/file.png)
30+
31+
**Note:** remember to remove existing `.nyc_output` folder if running Cypress in non-interactive mode `rm -rf .nyc_output/`.
32+
33+
When running with [debug logs](https://github.com/cypress-io/code-coverage#debugging) you should see messages:
34+
35+
```
36+
found common folder /var/www/test/site that matches
37+
current working directory /Users/gleb/git/code-coverage/examples/docker-paths
38+
```

‎examples/docker-paths/app/index.html

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<body>
2+
Page body
3+
<script src="main.js"></script>
4+
<script src="second.js"></script>
5+
<script>
6+
// use functions creates in "main.js"
7+
if (add(2, 3) !== 5) {
8+
throw new Error('wrong addition')
9+
}
10+
if (sub(2, 3) !== -1) {
11+
throw new Error('wrong subtraction')
12+
}
13+
if (reverse('foo') !== 'oof') {
14+
throw new Error('wrong string reverse')
15+
}
16+
</script>
17+
</body>

‎examples/docker-paths/app/main.js

Lines changed: 3 additions & 0 deletions
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/docker-paths/app/second.js

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
// this file should be excluded from the final coverage numbers
2+
// using "nyc.exclude" list in package.json
3+
window.reverse = s =>
4+
s
5+
.split('')
6+
.reverse()
7+
.join('')

‎examples/docker-paths/cypress.json

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
{
2+
"pluginsFile": "../../plugins",
3+
"supportFile": "../../support",
4+
"fixturesFolder": false
5+
}

‎examples/docker-paths/cypress/integration/spec.js

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
/// <reference types="cypress" />
2+
describe('docker-paths', () => {
3+
it('works', () => {
4+
cy.visit('dist/index.html')
5+
cy.contains('Page body')
6+
7+
cy.window()
8+
.invoke('reverse', 'super')
9+
.should('equal', 'repus')
10+
})
11+
})

‎examples/docker-paths/dist/index.html

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<body>
2+
Page body
3+
<script src="main.js"></script>
4+
<script src="second.js"></script>
5+
<script>
6+
// use functions creates in "main.js"
7+
if (add(2, 3) !== 5) {
8+
throw new Error('wrong addition')
9+
}
10+
if (sub(2, 3) !== -1) {
11+
throw new Error('wrong subtraction')
12+
}
13+
if (reverse('foo') !== 'oof') {
14+
throw new Error('wrong string reverse')
15+
}
16+
</script>
17+
</body>

‎examples/docker-paths/dist/main.js

Lines changed: 58 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎examples/docker-paths/dist/second.js

Lines changed: 48 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)