Tool for UI Performance testing
These simple steps will run Perf-UI container for test which described in ExampleTest.yaml
-
Install Docker
-
Start container and pass 3 config options and mount reports folder:
n- number of test executionst- test file namee- test environment or scenario from test fileyour_local_path_to_reports- path on your local filesystem where you want to store reports from this execution
For example:
docker run -t -v <your_local_path_to_reports>:/tmp/reports \
--rm --name perfui \
getcarrier/perf-ui -n 1 -t ExampleTest.yaml -e example
Results of test example you can find at your_local_path_to_reports as Lighthouse html reports, Screenshots of opened
and failed pages (if any) and JUnit xml report.
To receive all the benefits from Perf-UI you should use InfluxDB container as data storage for page timing API data and Grafana for data visualization using our dashboard.
Also you could use the ReportPortal as storage of screenshots, lighthouse results and error logs of failed pages, as auto analyzer for failed pages.
However neither Report Portal or InfluxDB with Grafana are not required inside test config, without them you will receive
Lighthouse html reports, Screenshots of opened and failed pages (if any) and JUnit xml report at your_local_path_to_reports.
Test scenarios can be configured as yaml (e.g. ExampleTest.yaml)
file following the config description below:
ExampleTest.yaml structure example:
# InfluxDB config (not required)
# Required fields:
# - url
# - db_name
# User and password are required If your InfluxDB using auth
# InfluxDB config example:
influxdb:
url: http://your_influx_url:port/ # Path to InfluxDB
db_name: your_database # Database name
user: # User name, if you enabled auth in InfluxDB
password: # User password for above user name
# ReportPortal tool config (not required)
# Required fields:
# - url
# - token
# - project
# - launch_name
# ReportPortal config example:
reportportal:
url: https://rp_url/api/v1 # ReportPortal API url
token: your-rp-uuid-token # Long-living auth token (UUID) for ReportPortal
project: your_project_name # ReportPortal project name where results will be send
launch_name: UI_Google_Test # Launch name for your test
launch_tags: # Launch tags to filter existing launches and show them on RP dashboard
- Google Test
- www.google.com
# Test Config
# For test config is required:
# - environment (e.g. staging);
# - page name (e.g. Google, Google_Search). Page names should not contain spaces.
# - url (e.g. https://www.google.com)
# Check for each page is not required but desirable to use.
# Test config example:
staging: # Name of environment or scenario of your test
Google: # Page Name
url: https://www.google.com # Page URL
Google_Search:
url: https://www.google.com/search?q= # Page url with parameters
# URL parameters. Each parameter is for different page
parameters:
- ui+performance # Google Search for UI Performance
- api+performance # Google Search for API Performance
# Check for page loading state
check:
# XPATH check for page state
xpath: //a[contains(text(), "performance")]
Yahoo:
url: https://www.yahoo.com
check:
# CSS check for page state
css: div#Masterwrap
- For using InfluxDB, you should have accessible web link to it.
- If your InfluxDB and Perf-UI containers located on the same host and you do not have accessible web link to InfluxDB, use link to InfluxDB container as described below:
- Change db_url at YourTest.yaml to
http://influx_db_link:<your_db_port>/ - At perf-ui startup command, before
--name perfuiparameter add--link <your_influxdb_name_or_id>:influx_db_link - Your run command should looks like:
docker run -t -v <your_local_path_to_reports>:/tmp/reports \ -v <your_local_path_to_test>/ExampleTest.yaml:/tmp/tests/ExampleTest.yaml \ --rm --link <your_influxdb_name_or_id>:influx_db_link --name perfui \ getcarrier/perf-ui -n 1 -t ExampleTest.yaml -e example
- Change db_url at YourTest.yaml to
-v <your_local_path_to_test>/ExampleTest.yaml:/tmp/tests/ExampleTest.yaml
When you configured your own test file run command should looks example below (where ExampleTest.yaml and other parameters described above should be yours):
docker run -t -v <your_local_path_to_reports>:/tmp/reports \
-v <your_local_path_to_test>/ExampleTest.yaml:/tmp/tests/ExampleTest.yaml \
--rm --name perfui \
getcarrier/perf-ui -n 1 -t ExampleTest.yaml -e example
- Grafana version not higher then 5.3.4
- Minimum 2 GB RAM to start container without errors
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent