Browser Performance Testing with the Sitespeed.io container
First, you need a GitLab Runner with the docker-in-docker executor.
Once you set up the Runner, add a new job to
stage: performance image: docker:git services: - docker:dind script: - mkdir sitespeed-results - docker run --shm-size=1g --rm -v "$(pwd)":/sitespeed.io sitespeedio/sitespeed.io --outputFolder sitespeed-results https://my.website.com artifacts: paths: - sitespeed-results/
This will create a
performance job in your CI/CD pipeline and will run Sitespeed.io against the webpage you define. The full HTML Sitespeed.io report will be saved as an artifact, and if you have Pages enabled it can be viewed directly in your browser. For further customization options of Sitespeed.io, including the ability to provide a list of URLs to test, please consult their documentation.
Performance testing on Review Apps
The above CI YML is great for testing against static environments, and it can be extended for dynamic environments. There are a few extra steps to take to set this up:
performancejob should run after the environment has started.
- In the
deployjob, persist the hostname so it is available to the
performancejob. The same can be done for static environments like staging and production to unify the code path. Saving it as an artifact is as simple as
echo $CI_ENVIRONMENT_URL > environment_url.txt.
- In the
performancejob read the artifact into an environment variable, like
$CI_ENVIRONMENT_URL, and use it to parameterize the test URL's.
- Now you can run the Sitespeed.io container against the desired hostname and paths.
performance job would look like:
stage: performance image: docker:git services: - docker:dind script: - export CI_ENVIRONMENT_URL=$(cat environment_url.txt) - mkdir sitespeed-results - docker run --shm-size=1g --rm -v "$(pwd)":/sitespeed.io sitespeedio/sitespeed.io --outputFolder sitespeed-results $CI_ENVIRONMENT_URL artifacts: paths: - sitespeed-results/