Website Healthcheck

Description: Website Healthcheck is an automated tool that gathers data about given URL.
Current checks:

• Lighthouse score for mobiles and desktop - PageSpeedInsights API
• Core Web Vitals for mobiles and desktop - PageSpeedInsights API (CrUX data)
• Users' device distribution - BigQuery (CrUX data)
• Accessibility standards' violations (AXE + Firefox)

Prerequisites

Docker

Docker version 20.10.2, build 2291f61

Google service account credentials

To authenticate BigQuery request Google service account credentials are needed. Their default path is: root/credentials/gsa.json.
For more info, please visit: https://console.cloud.google.com/apis/credentials

PageSpeedInsights API key

To avoid request rate limiting key parameter is added to each request. By default, key string value should be placed in: root/credentials/psi.json under API_KEY key.
For more info, please visit: https://developers.google.com/speed/docs/insights/v5/get-started?pli=1#APIKey

{
    "API_KEY": "your-key-here"
}

Configuration

Currently all configuration variables are located in root/config.json.
Note: Supported browsers - Chrome, Firefox.
Default configuration:

{
  "accessibilityStandardTags": ["wcag2a", "wcag2aa", "wcag21aa"],
  "defaultBrowser": "Chrome",
  "psiApiRequestInterval": 5,
  "gsaCredentialsPath": "./credentials/gsa.json",
  "psiApiKeyPath": "./credentials/psi.json"
}

Executing the script

From the root folder: Build docker image from Dockerfile

docker build -t website-healthcheck .

Execute script in a container and save results.
Note: [arg] stands for an optional environment variable

docker run -t -e url="<TESTED_URL>" [-e browser="<BROWSER>"] -v ${PWD}:/website-healthcheck website-healthcheck

Output

Currently results are saved to root/output.json file.

Post MVP improvements:

• parametrize test module usage (e.g. run only accessibility check; all by default)
• present results in an user-readable way
• set date (from) as a parameter in crux module