fix: improve spec filtering (#171)

bahmutov · web-flow · commit bd094627944c · 2020-04-04T15:37:46.000-04:00
* fix: better unit coverage filter

* add to CI

* fix path
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -168,6 +168,33 @@ workflows:
                 command: npm run coverage:check
                 working_directory: examples/ts-example
 
+      - cypress/run:
+          attach-workspace: true
+          name: example-same-folder
+          requires:
+            - cypress/install
+          # there are no jobs to follow this one
+          # so no need to save the workspace files (saves time)
+          no-workspace: true
+          command: npx cypress run --project examples/same-folder
+          # store screenshots and videos
+          store_artifacts: true
+          post-steps:
+            - run: cat examples/same-folder/.nyc_output/out.json
+            # store the created coverage report folder
+            # you can click on it in the CircleCI UI
+            # to see live static HTML site
+            - store_artifacts:
+                path: examples/same-folder/coverage
+            # make sure the examples captures 100% of code
+            - run:
+                command: npx nyc report --check-coverage true --lines 100
+                working_directory: examples/same-folder
+            # how to fail if the specific file coverage is not found?!
+            - run:
+                command: npx nyc report --check-coverage true --lines 100 --include unit-utils.js
+                working_directory: examples/same-folder
+
       - publish:
           filters:
             branches:
@@ -181,3 +208,4 @@ workflows:
             - example-before-each-visit
             - example-before-all-visit
             - example-ts-example
+            - example-same-folder
diff --git a/examples/same-folder/.babelrc b/examples/same-folder/.babelrc
@@ -0,0 +1,3 @@
+{
+  "plugins": ["istanbul"]
+}
diff --git a/examples/same-folder/README.md b/examples/same-folder/README.md
@@ -0,0 +1,3 @@
+# example: same-folder
+
+Check if test files are correctly filtered out
diff --git a/examples/same-folder/cypress.json b/examples/same-folder/cypress.json
@@ -0,0 +1,6 @@
+{
+  "integrationFolder": ".",
+  "testFiles": "**/spec.js",
+  "supportFile": "support.js",
+  "pluginsFile": "plugins.js"
+}
diff --git a/examples/same-folder/cypress/fixtures/example.json b/examples/same-folder/cypress/fixtures/example.json
@@ -0,0 +1,5 @@
+{
+  "name": "Using fixtures to represent data",
+  "email": "hello@cypress.io",
+  "body": "Fixtures are a great way to mock data for responses to routes"
+}
diff --git a/examples/same-folder/index.html b/examples/same-folder/index.html
@@ -0,0 +1,4 @@
+<body>
+  Page body
+  <script src="main-instrumented.js"></script>
+</body>
diff --git a/examples/same-folder/main-instrumented.js b/examples/same-folder/main-instrumented.js
diff --git a/examples/same-folder/main.js b/examples/same-folder/main.js
@@ -0,0 +1,3 @@
+window.add = (a, b) => a + b
+
+window.sub = (a, b) => a - b
diff --git a/examples/same-folder/package.json b/examples/same-folder/package.json
@@ -0,0 +1,8 @@
+{
+  "name": "example-same-folder",
+  "description": "Check if test files are correctly filtered out",
+  "devDependencies": {},
+  "scripts": {
+    "cy:open": "../../node_modules/.bin/cypress open"
+  }
+}
diff --git a/examples/same-folder/plugins.js b/examples/same-folder/plugins.js
@@ -0,0 +1,4 @@
+module.exports = (on, config) => {
+  on('task', require('../../task'))
+  on('file:preprocessor', require('../../use-babelrc'))
+}
diff --git a/examples/same-folder/spec.js b/examples/same-folder/spec.js
@@ -0,0 +1,26 @@
+/// <reference types="cypress" />
+
+import { reverse } from './unit-utils'
+
+describe('coverage information', () => {
+  before(() => {
+    cy.log('visiting index.html')
+    cy.visit('index.html')
+  })
+
+  it('calls add', () => {
+    cy.window()
+      .invoke('add', 2, 3)
+      .should('equal', 5)
+  })
+
+  it('calls sub', () => {
+    cy.window()
+      .invoke('sub', 2, 3)
+      .should('equal', -1)
+  })
+
+  it('reverses a string', () => {
+    expect(reverse('Hello')).to.equal('olleH')
+  })
+})
diff --git a/examples/same-folder/support.js b/examples/same-folder/support.js
@@ -0,0 +1 @@
+import '../../support'
diff --git a/examples/same-folder/unit-utils.js b/examples/same-folder/unit-utils.js
@@ -0,0 +1,5 @@
+export const reverse = s =>
+  s
+    .split('')
+    .reverse()
+    .join('')
diff --git a/support.js b/support.js
@@ -134,8 +134,6 @@ if (Cypress.env('coverage') === false) {
 
   after(function mergeUnitTestCoverage() {
     // collect and merge frontend coverage
-    const specFolder = Cypress.config('integrationFolder')
-    const supportFolder = Cypress.config('supportFolder')
 
     // if spec bundle has been instrumented (using Cypress preprocessor)
     // then we will have unit test coverage
@@ -145,10 +143,12 @@ if (Cypress.env('coverage') === false) {
     if (unitTestCoverage) {
       // remove coverage for the spec files themselves,
       // only keep "external" application source file coverage
+      const supportFile = Cypress.config('supportFile')
+      const testFilePattern = Cypress.config('testFiles')
 
-      // does this handle unset support file?
       const isTestFile = (fileCoverage, filename) =>
-        filename.startsWith(specFolder) || filename.startsWith(supportFolder)
+        Cypress.minimatch(filename, testFilePattern) || filename === supportFile
+
       const coverage = Cypress._.omitBy(window.__coverage__, isTestFile)
       sendCoverage(coverage, 'unit')
     }

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+{`
	`2`	`+ "plugins": ["istanbul"]`
	`3`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# example: same-folder`
	`2`	`+`
	`3`	`+Check if test files are correctly filtered out`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +{
 +  "name": "Using fixtures to represent data",
 +  "email": "[email protected]",
 +  "body": "Fixtures are a great way to mock data for responses to routes"
 +}
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+window.add = (a, b) => a + b`
	`2`	`+`
	`3`	`+window.sub = (a, b) => a - b`