tests: run code coverage in github actions (#11770)

GoogleChrome · Mar 23, 2021 · f5ed5ff · f5ed5ff
1 parent fb41e60
commit f5ed5ff
Show file tree

Hide file tree

Showing 24 changed files with 276 additions and 441 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -112,8 +112,14 @@ jobs:
       if: matrix.os == 'ubuntu-latest'
 
     - name: yarn unit
-      run: xvfb-run --auto-servernum yarn unit
+      run: xvfb-run --auto-servernum yarn unit:cicoverage
       if: matrix.os == 'ubuntu-latest'
+    - name: Upload test coverage to Codecov
+      if: matrix.os == 'ubuntu-latest'
+      uses: codecov/codecov-action@6004246
+      with:
+        flags: unit
+        file: ./unit-coverage.lcov
 
     # For windows, just test the potentially platform-specific code.
     - name: yarn unit-cli
@@ -164,7 +170,14 @@ jobs:
 
     - run: sudo apt-get install xvfb
     - name: Run smoke tests
-      run: xvfb-run --auto-servernum yarn smoke --debug -j=1 --retries=2 --invert-match ${{ matrix.smoke-test-invert }} $SMOKE_GROUP_1
+      run: xvfb-run --auto-servernum yarn smoke:cicoverage --debug -j=1 --retries=2 --invert-match ${{ matrix.smoke-test-invert }} $SMOKE_GROUP_1
+
+    - name: Upload test coverage to Codecov
+      if: matrix.chrome-channel == 'ToT'
+      uses: codecov/codecov-action@6004246
+      with:
+        flags: smoke
+        file: ./smoke-coverage.lcov
 
     # Fail if any changes were written to source files.
     - run: git diff --exit-code

diff --git a/lighthouse-core/gather/fetcher.js b/lighthouse-core/gather/fetcher.js
@@ -141,7 +141,7 @@ class Fetcher {
     /**
      * @param {string} src
      */
-    /* istanbul ignore next */
+    /* c8 ignore start */
     function injectIframe(src) {
       /** @type {HTMLIFrameElement} */
       const iframe = document.createElement('iframe');
@@ -161,6 +161,7 @@ class Fetcher {
       };
       document.body.appendChild(iframe);
     }
+    /* c8 ignore stop */
 
     /** @type {NodeJS.Timeout} */
     let timeoutHandle;

diff --git a/lighthouse-core/gather/gatherers/accessibility.js b/lighthouse-core/gather/gatherers/accessibility.js
@@ -17,7 +17,7 @@ const pageFunctions = require('../../lib/page-functions.js');
  * containing any violations.
  * @return {Promise<LH.Artifacts.Accessibility>}
  */
-/* istanbul ignore next */
+/* c8 ignore start */
 async function runA11yChecks() {
   /** @type {import('axe-core/axe')} */
   // @ts-expect-error axe defined by axeLibSource
@@ -96,6 +96,7 @@ async function runA11yChecks() {
     version: axeResults.testEngine.version,
   };
 }
+/* c8 ignore stop */
 
 /**
  * @implements {LH.Gatherer.GathererInstance}

diff --git a/lighthouse-core/gather/gatherers/anchor-elements.js b/lighthouse-core/gather/gatherers/anchor-elements.js
@@ -21,7 +21,7 @@ const pageFunctions = require('../../lib/page-functions.js');
  *
  * @return {LH.Artifacts['AnchorElements']}
  */
-/* istanbul ignore next */
+/* c8 ignore start */
 function collectAnchorElements() {
   /** @param {string} url */
   const resolveURLOrEmpty = url => {
@@ -71,6 +71,7 @@ function collectAnchorElements() {
     };
   });
 }
+/* c8 ignore stop */
 
 /**
  * @param {LH.Gatherer.PassContext['driver']} driver

diff --git a/lighthouse-core/gather/gatherers/cache-contents.js b/lighthouse-core/gather/gatherers/cache-contents.js
@@ -13,7 +13,7 @@ const Gatherer = require('./gatherer.js');
  * This is run in the page, not Lighthouse itself.
  * @return {Promise<Array<string>>}
  */
-/* istanbul ignore next */
+/* c8 ignore start */
 function getCacheContents() {
   // Get every cache by name.
   return caches.keys()
@@ -36,6 +36,7 @@ function getCacheContents() {
         });
       });
 }
+/* c8 ignore stop */
 
 class CacheContents extends Gatherer {
   /**

diff --git a/lighthouse-core/gather/gatherers/dobetterweb/domstats.js b/lighthouse-core/gather/gatherers/dobetterweb/domstats.js
@@ -22,7 +22,7 @@ const pageFunctions = require('../../../lib/page-functions.js');
  * @param {boolean=} deep True to include shadow roots. Defaults to true.
  * @return {LH.Artifacts.DOMStats}
  */
-/* istanbul ignore next */
+/* c8 ignore start */
 function getDOMStats(element = document.body, deep = true) {
   let deepestElement = null;
   let maxDepth = -1;
@@ -74,6 +74,7 @@ function getDOMStats(element = document.body, deep = true) {
     totalBodyElements: result.numElements,
   };
 }
+/* c8 ignore stop */
 
 class DOMStats extends Gatherer {
   /**

diff --git a/lighthouse-core/gather/gatherers/dobetterweb/password-inputs-with-prevented-paste.js b/lighthouse-core/gather/gatherers/dobetterweb/password-inputs-with-prevented-paste.js
@@ -14,7 +14,7 @@ const pageFunctions = require('../../../lib/page-functions.js');
 /**
  * @return {LH.Artifacts['PasswordInputsWithPreventedPaste']}
  */
-/* istanbul ignore next */
+/* c8 ignore start */
 function findPasswordInputsWithPreventedPaste() {
   return Array.from(document.querySelectorAll('input[type="password"]'))
     .filter(passwordInput =>
@@ -27,6 +27,7 @@ function findPasswordInputsWithPreventedPaste() {
       node: getNodeDetails(passwordInput),
     }));
 }
+/* c8 ignore stop */
 
 class PasswordInputsWithPreventedPaste extends Gatherer {
   /**

diff --git a/lighthouse-core/gather/gatherers/dobetterweb/tags-blocking-first-paint.js b/lighthouse-core/gather/gatherers/dobetterweb/tags-blocking-first-paint.js
@@ -27,7 +27,7 @@ const Gatherer = require('../gatherer.js');
 /** @typedef {{tagName: 'SCRIPT', url: string, src: string}} ScriptTag */
 /** @typedef {import('../../driver.js')} Driver */
 
-/* istanbul ignore next */
+/* c8 ignore start */
 function installMediaListener() {
   // @ts-expect-error - inserted in page to track media changes.
   window.___linkMediaChanges = [];
@@ -47,11 +47,12 @@ function installMediaListener() {
     },
   });
 }
+/* c8 ignore stop */
 
 /**
  * @return {Promise<Array<LinkTag | ScriptTag>>}
  */
-/* istanbul ignore next */
+/* c8 ignore start */
 async function collectTagsThatBlockFirstPaint() {
   /** @type {Array<MediaChange>} */
   // @ts-expect-error - `___linkMediaChanges` created in `installMediaListener`.
@@ -112,6 +113,7 @@ async function collectTagsThatBlockFirstPaint() {
     throw new Error(`${friendly}: ${e.message}`);
   }
 }
+/* c8 ignore stop */
 
 class TagsBlockingFirstPaint extends Gatherer {
   /**

diff --git a/lighthouse-core/gather/gatherers/form-elements.js b/lighthouse-core/gather/gatherers/form-elements.js
@@ -15,7 +15,7 @@ const pageFunctions = require('../../lib/page-functions.js');
 /**
  * @return {LH.Artifacts['FormElements']}
  */
-/* istanbul ignore next */
+/* c8 ignore start */
 function collectFormElements() {
   // @ts-expect-error - put into scope via stringification
   const formChildren = getElementsInDocument('textarea, input, label, select'); // eslint-disable-line no-undef
@@ -82,6 +82,7 @@ function collectFormElements() {
   }
   return [...forms.values()];
 }
+/* c8 ignore stop */
 
 class FormElements extends Gatherer {
   /**

diff --git a/lighthouse-core/gather/gatherers/iframe-elements.js b/lighthouse-core/gather/gatherers/iframe-elements.js
@@ -15,7 +15,7 @@ const pageFunctions = require('../../lib/page-functions.js');
 /**
  * @return {LH.Artifacts['IFrameElements']}
  */
-/* istanbul ignore next */
+/* c8 ignore start */
 function collectIFrameElements() {
   // @ts-expect-error - put into scope via stringification
   const iFrameElements = getElementsInDocument('iframe'); // eslint-disable-line no-undef
@@ -33,6 +33,7 @@ function collectIFrameElements() {
     };
   });
 }
+/* c8 ignore stop */
 
 class IFrameElements extends Gatherer {
   /**

diff --git a/lighthouse-core/gather/gatherers/image-elements.js b/lighthouse-core/gather/gatherers/image-elements.js
@@ -17,7 +17,7 @@ const FontSize = require('./seo/font-size.js');
 /* global window, getElementsInDocument, Image, getNodeDetails, ShadowRoot */
 
 /** @param {Element} element */
-/* istanbul ignore next */
+/* c8 ignore start */
 function getClientRect(element) {
   const clientRect = element.getBoundingClientRect();
   return {
@@ -28,27 +28,29 @@ function getClientRect(element) {
     right: clientRect.right,
   };
 }
+/* c8 ignore stop */
 
 /**
  * If an image is within `picture`, the `picture` element's css position
  * is what we want to collect, since that position is relevant to CLS.
  * @param {Element} element
  * @param {CSSStyleDeclaration} computedStyle
  */
-/* istanbul ignore next */
+/* c8 ignore start */
 function getPosition(element, computedStyle) {
   if (element.parentElement && element.parentElement.tagName === 'PICTURE') {
     const parentStyle = window.getComputedStyle(element.parentElement);
     return parentStyle.getPropertyValue('position');
   }
   return computedStyle.getPropertyValue('position');
 }
+/* c8 ignore stop */
 
 /**
  * @param {Array<Element>} allElements
  * @return {Array<LH.Artifacts.ImageElement>}
  */
-/* istanbul ignore next */
+/* c8 ignore start */
 function getHTMLImages(allElements) {
   const allImageElements = /** @type {Array<HTMLImageElement>} */ (allElements.filter(element => {
     return element.localName === 'img';
@@ -84,12 +86,13 @@ function getHTMLImages(allElements) {
     };
   });
 }
+/* c8 ignore stop */
 
 /**
  * @param {Array<Element>} allElements
  * @return {Array<LH.Artifacts.ImageElement>}
  */
-/* istanbul ignore next */
+/* c8 ignore start */
 function getCSSImages(allElements) {
   // Chrome normalizes background image style from getComputedStyle to be an absolute URL in quotes.
   // Only match basic background-image: url("http://host/image.jpeg") declarations
@@ -130,21 +133,23 @@ function getCSSImages(allElements) {
 
   return images;
 }
+/* c8 ignore stop */
 
 /** @return {Array<LH.Artifacts.ImageElement>} */
-/* istanbul ignore next */
+/* c8 ignore start */
 function collectImageElementInfo() {
   /** @type {Array<Element>} */
   // @ts-expect-error - added by getElementsInDocumentFnString
   const allElements = getElementsInDocument();
   return getHTMLImages(allElements).concat(getCSSImages(allElements));
 }
+/* c8 ignore stop */
 
 /**
  * @param {string} url
  * @return {Promise<{naturalWidth: number, naturalHeight: number}>}
  */
-/* istanbul ignore next */
+/* c8 ignore start */
 function determineNaturalSize(url) {
   return new Promise((resolve, reject) => {
     const img = new Image();
@@ -159,6 +164,7 @@ function determineNaturalSize(url) {
     img.src = url;
   });
 }
+/* c8 ignore stop */
 
 /**
  * @param {Partial<Pick<LH.Crdp.CSS.CSSStyle, 'cssProperties'>>|undefined} rule

diff --git a/lighthouse-core/gather/gatherers/link-elements.js b/lighthouse-core/gather/gatherers/link-elements.js
@@ -46,7 +46,7 @@ function getCrossoriginFromHeader(value) {
 /**
  * @return {LH.Artifacts['LinkElements']}
  */
-/* istanbul ignore next */
+/* c8 ignore start */
 function getLinkElementsInDOM() {
   /** @type {Array<HTMLOrSVGElement>} */
   // @ts-expect-error - getElementsInDocument put into scope via stringification
@@ -77,6 +77,7 @@ function getLinkElementsInDOM() {
 
   return linkElements;
 }
+/* c8 ignore stop */
 
 class LinkElements extends Gatherer {
   /**

diff --git a/lighthouse-core/gather/gatherers/meta-elements.js b/lighthouse-core/gather/gatherers/meta-elements.js
@@ -10,7 +10,7 @@ const pageFunctions = require('../../lib/page-functions.js');
 
 /* globals getElementsInDocument */
 
-/* istanbul ignore next */
+/* c8 ignore start */
 function collectMetaElements() {
   // @ts-expect-error - getElementsInDocument put into scope via stringification
   const metas = /** @type {HTMLMetaElement[]} */ (getElementsInDocument('head meta'));
@@ -30,6 +30,7 @@ function collectMetaElements() {
     };
   });
 }
+/* c8 ignore stop */
 
 class MetaElements extends Gatherer {
   /**

diff --git a/lighthouse-core/gather/gatherers/script-elements.js b/lighthouse-core/gather/gatherers/script-elements.js
@@ -15,7 +15,7 @@ const pageFunctions = require('../../lib/page-functions.js');
 /**
  * @return {LH.Artifacts['ScriptElements']}
  */
-/* istanbul ignore next */
+/* c8 ignore start */
 function collectAllScriptElements() {
   /** @type {HTMLScriptElement[]} */
   // @ts-expect-error - getElementsInDocument put into scope via stringification
@@ -36,6 +36,7 @@ function collectAllScriptElements() {
     };
   });
 }
+/* c8 ignore stop */
 
 /**
  * @template T, U

diff --git a/lighthouse-core/gather/gatherers/seo/robots-txt.js b/lighthouse-core/gather/gatherers/seo/robots-txt.js
@@ -10,7 +10,7 @@ const Gatherer = require('../gatherer.js');
 /* global fetch, URL, location */
 
 /** @return {Promise<LH.Artifacts['RobotsTxt']>} */
-/* istanbul ignore next */
+/* c8 ignore start */
 async function getRobotsTxtContent() {
   try {
     const response = await fetch(new URL('/robots.txt', location.href).href);
@@ -24,6 +24,7 @@ async function getRobotsTxtContent() {
     return {status: null, content: null};
   }
 }
+/* c8 ignore stop */
 
 
 class RobotsTxt extends Gatherer {