The starting point for using BrowserUp is The BrowserUp Command Line Util. It:
- Creates test configs (BrowserUp Yaml)
- Launches (provision) the test cluster (locally, or in Amazon AWS)
- Starts and Stops tests
- And More
Once the test cluster is running, you can log into the cluster’s web UI and view your results, create reports administer other users, etc.
Prerequisites
Local Cluster
- Docker Installed and Running (make sure it is current)
- Mac Arm64 (M1/M2) or AMD64 or Linux (Windows not yet supported)
- 32 GB Ram or more Recommended
Cloud Cluster
- Amazon AWS account
- Local Mac Arm64 (M1/M2) or AMD64 or Linux to operate the BrowserUp Command line Util
- Local Docker is not required for remote AWS execution, so CI/CD setup is simple
Installation
Mac
brew install -vd browserup/browserup-cli/browserup-cli
Linux
sudo curl https://github.com/browserup/browserup/archive/browserup-cli.tar.gz | tar xvf - -C /usr/local/bin/
Creating your first test
- Generate a basic test scaffold in the current working dir:
browserup generate ruby
Look in your working directory and you should see the test files,
as well as a browserup.yaml. The browserup.yaml is your test config that defines what
will be run for this test. Try cat browserup.yaml to see what’s in it.
- Run your test!
browserup start
The start command will run the provision command if your cluster is not already running.
This will take a couple minutes to start, and launch your test.
When the start command finishes, you are running a test and collecting live stats!
Let’s take a look!
Inspecting the Test
Visit http://localhost:6730/
Login
username: superadmin
password: ChangeMe!
- Click on Reports -> Summary in the left sidebar
- Select the Run in the drop-down at the top and check the summary
- Explore the other reports for this run
- Stop the test
Cloud Runs
This quick start focused on a local Docker run, but the process for a remote run is the same, except you’ll need AWS credentials defined, and to set in your config:
cluster_type: aws