Skip to content
This repository has been archived by the owner on May 8, 2021. It is now read-only.
/ helix-perf Public archive

Microservice for Performance Tests on Project Helix sites

License

Notifications You must be signed in to change notification settings

adobe/helix-perf

Helix peformance testing

Status

codecov CircleCI GitHub license GitHub issues LGTM Code Quality Grade: JavaScript

Microservice for getting Project Helix performance results

This microservice runs performance tests on a customer website using Calibreapp, but only if the customer has a valid Project Helix account.

Usage

Send a POST request with following (Content-Type: application/json-encoded) body parameters to https://adobeioruntime.net/api/v1/web/helix/helix-services/perf@v1:

  • service: the service ID of your Fastly service config
  • token: a Fastly authentication token that has global permission on the service config
  • tests: an array of test specs, i.e. objects with following properties
    • url: the URL to test
    • location: the remote location to test from
    • device: the device emulate during the test
    • connection: the connection throttling settings
    • strain: the strain or variant to test

Developing Helix Perf

You need node>=8.0.0 and npm>=5.4.0. Follow the typical npm install, npm test workflow.

Contributions are highly welcome.

Deploying Helix Perf

Deploying Helix Perf requires the wsk command line client, authenticated to a namespace of your choice. For Project Helix, we use the helix namespace.

Run npm run deploy to do a one-shot deploment of Helix Perf. All commits to master that pass the testing will be deployed automatically.