Set up and improve code coverage

.github/workflows/tests.yml

@@ -50,8 +50,13 @@ jobs:
       run: |
         ./test/server-start.sh
 
-        npm test
+        npm test 2>&1 | tee /tmp/npm-test.log
 
+    - name: Code coverage to be improved
+      run: |
+        cat /tmp/npm-test.log | grep '|' | head -n4
+        cat /tmp/npm-test.log | grep '|' | grep -v '100 |      100 |     100 |     10' | grep '\.js'
+
     - name: Check that bin/phantomas.js works
       run: ./bin/phantomas.js http://127.0.0.1:8888/ --pretty | grep "generator" -A4
 

.prettierignore

@@ -1,4 +1,5 @@
 test/webroot/
+coverage/
 *.md
 *.yml
 *.yaml

core/modules/navigationTiming/scope.js

@@ -1,4 +1,5 @@
-(function (phantomas) {
+/* istanbul ignore next */
+(function navigationTimingScope(phantomas) {
   // Prevent events from being sent from an iframe. Only from the main document.
   if (window.parent !== window || window.location.href === "about:blank") {
     return;

core/scope.js

@@ -3,7 +3,8 @@
  *
  * Code below is executed in page's "scope" (injected by lib/browser.js)
  */
-(function (scope) {
+/* istanbul ignore next */
+(function coreScope(scope) {
   "use strict";
 
   // create a scope

extensions/pageSource/pageSource.js

@@ -33,6 +33,8 @@ module.exports = (phantomas) => {
     return new Promise(async (resolve) => {
       // https://github.com/GoogleChrome/puppeteer/blob/v1.11.0/docs/api.md#pageevaluatepagefunction-args
       const bodyHandle = await page.$("body");
+
+      /* istanbul ignore next */
       const html = await page.evaluate((body) => body.innerHTML, bodyHandle);
 
       // phantomas.log(html);

extensions/scroll/scroll.js

@@ -21,7 +21,10 @@ module.exports = function (phantomas) {
     return new Promise(async (resolve) => {
       phantomas.log("Scrolling the page...");
 
+      /* istanbul ignore next */
       await page.evaluate(() => document.body.scrollIntoView(false));
+
+      /* istanbul ignore next */
       const scrollOffset = await page.evaluate(() => document.body.scrollTop);
 
       // wait for lazy loading to do its job

lib/browser.js

@@ -41,13 +41,15 @@ Browser.prototype.init = async (phantomasOptions) => {
   }
 
   // customize path to Chromium binary
+  /* istanbul ignore next */
   if (env["PHANTOMAS_CHROMIUM_EXECUTABLE"]) {
     options.executablePath = env["PHANTOMAS_CHROMIUM_EXECUTABLE"];
   }
 
   // detect that we run inside a container
   // @see https://github.com/jessfraz/dockerfiles/issues/65
   // @see https://github.com/Zenika/alpine-chrome#-the-best-with-seccomp
+  /* istanbul ignore next */
   if (env["DOCKERIZED"]) {
     debug("Docker environment detected");
     debug(
@@ -58,6 +60,7 @@ Browser.prototype.init = async (phantomasOptions) => {
   // detect that we run inside an Amazon Lambda machine
   // (note: the LAMBDA_TASK_ROOT env variable is automatically set by AWS)
   // @see https://docs.aws.amazon.com/lambda/latest/dg/configuration-envvars.html#configuration-envvars-runtime
+  /* istanbul ignore next */
   if (env["LAMBDA_TASK_ROOT"]) {
     // Chrome then requires some more flags
     options.args.push(
@@ -74,7 +77,7 @@ Browser.prototype.init = async (phantomasOptions) => {
     // https://github.com/puppeteer/puppeteer/blob/main/docs/api.md#puppeteerlaunchoptions
     this.browser = await puppeteer.launch(options);
     this.page = await this.browser.newPage();
-  } catch (ex) {
+  } catch (ex) /* istanbul ignore next */ {
     debug("Puppeteer failed to launch: %s", ex);
     throw ex;
   }
@@ -172,6 +175,7 @@ Browser.prototype.init = async (phantomasOptions) => {
   this.onRequestLoaded = (eventName, data) => {
     var meta = responses[data.requestId];
 
+    /* istanbul ignore if */
     if (typeof meta === "undefined") {
       // the browser sometimes looses trace of a request, let's ignore.
       networkDebug(
@@ -312,7 +316,7 @@ Browser.prototype.visit = (url, waitUntil, timeout) => {
       debug("Metrics: %s", JSON.stringify(metrics));
 
       this.events.emit("metrics", metrics); // @desc Emitted when Chromuim's page.metrics() has been called
-    } catch (ex) {
+    } catch (ex) /* istanbul ignore next */ {
       debug("Get metrics failed: " + ex);
       return reject(ex);
     }
@@ -330,7 +334,7 @@ Browser.prototype.close = async () => {
 
     // The page is closed, let's close the browser
     if (this.browser && this.browser.isConnected()) await this.browser.close();
-  } catch (ex) {
+  } catch (ex) /* istanbul ignore next */ {
     debug("An exception was raised in Browser.prototype.close(): " + ex);
     debug(ex);
   }