joviano-dias / lighthouse-puppeteer

Puppeteer and Lighthouse

Using Google Puppeteer to run Google Lighthouse programmatically within a CI-CD environment and generate reports to measure performance accessibility and security on the fly.

Two projects

• Google Lighthouse Puppeteer A simple implementation

• Google Lighthouse Puppeteer multi-page with score analysis and slack alerts Does multi-page lighthouse puppeteer scans with lighthouse score analysis, and slack alerts

What is Lighthouse?

Google Lighthouse is an open-source, automated tool for improving the quality of web pages. You can run it against any web page, public or requiring authentication. It has audits for performance, accessibility, progressive web apps, and more.

What is Puppeteer?

Most things that you can do manually in the browser can be done using Google Puppeteer! Automate form submission, UI testing, keyboard input, etc. Create an up-to-date, automated testing environment. Run your tests directly in the latest version of Chrome using the latest JavaScript and browser features.

Setup

Install node via brew install node

Run

./build

Notes

• Runs only Desktop compatibility tests, to run mobile pass in a different config to lighthouse

const report = await lighthouse(page.url(), opts, config).then(results => {
    return results;
});

• Can be run against different configs by referencing up https://github.com/GoogleChrome/lighthouse/blob/master/docs/configuration.md#more-examples

lighthouse-puppeteer's Issues

Facing Issue while integrating with CI/CD

Hi @joviano-dias-springernature ,

I am facing error while automating this in CI/CD. Getting below error while running the test inside Docker image :

Error :
ChromeLauncher:error connect ECONNREFUSED 127.0.0.1:37139 +1ms ChromeLauncher:error Logging contents of /tmp/lighthouse.lqSemFJ/chrome-err.log +0ms ChromeLauncher:error [0610/095945.085518:ERROR:zygote_host_impl_linux.cc(89)] Running as root without --no-sandbox is not supported. See https://crbug.com/638180. ChromeLauncher:error +0ms { Error: connect ECONNREFUSED 127.0.0.1:37139 at TCPConnectWrap.afterConnect [as oncomplete] (net.js:1106:14) errno: 'ECONNREFUSED', code: 'ECONNREFUSED', syscall: 'connect', address: '127.0.0.1', port: 37139 } (node:19) UnhandledPromiseRejectionWarning: Error: connect ECONNREFUSED 127.0.0.1:80 ChromeLauncher:error connect ECONNREFUSED 127.0.0.1:37139 +1ms ChromeLauncher:error Logging contents of /tmp/lighthouse.lqSemFJ/chrome-err.log +0ms ChromeLauncher:error [0610/095945.085518:ERROR:zygote_host_impl_linux.cc(89)] Running as root without --no-sandbox is not supported. See https://crbug.com/638180. ChromeLauncher:error +0ms { Error: connect ECONNREFUSED 127.0.0.1:37139 at TCPConnectWrap.afterConnect [as oncomplete] (net.js:1106:14) errno: 'ECONNREFUSED', code: 'ECONNREFUSED', syscall: 'connect', address: '127.0.0.1', port: 37139 } (node:19) UnhandledPromiseRejectionWarning: Error: connect ECONNREFUSED 127.0.0.1:80

Docker image :

`
FROM node-image:v10.16

USER root

RUN apt-get update && apt-get -y install chromium

RUN set -ex
&& apt-get update

# Chromium dependences
&& apt-get install -y
xvfb gconf-service libasound2 libatk1.0-0 libc6 libcairo2 libcups2
libdbus-1-3 libexpat1 libfontconfig1 libgcc1 libgconf-2-4 libgdk-pixbuf2.0-0 libglib2.0-0
libgtk-3-0 libnspr4 libpango-1.0-0 libpangocairo-1.0-0 libstdc++6 libx11-6 libx11-xcb1 libxcb1
libxcomposite1 libxcursor1 libxdamage1 libxext6 libxfixes3 libxi6 libxrandr2 libxrender1 libxss1
libxtst6 ca-certificates fonts-liberation libappindicator1 libnss3 lsb-release xdg-utils wget &&
rm -rf /var/lib/apt/lists/*

RUN mkdir -p /lighthouse

RUN chown -R root /lighthouse

RUN cd /lighthouse

COPY / /lighthouse

WORKDIR /lighthouse