quickpizza

QuickPizza

What is QuickPizza? 🍕🍕🍕

QuickPizza is a web application, used for demonstrations and workshops, that generates new and exciting pizza combinations!

The app is built using SvelteKit for the frontend and Go for the backend.

The tests written for QuickPizza demonstrates the basic and advanced functionalities of k6, ranging from a basic load test to using different modules and extensions.

Requirements

• Docker
• Grafana k6 (v.0.43.1 or higher)

If you are running the xk6-disruptor test, Kubernetes needs to be setup and minikube to be downloaded.

• Minikube

Run locally with Docker

To run the app locally with Docker, run the command:

docker run -it -p 3333:3333  ghcr.io/grafana/quickpizza-local:latest

That's it!

Now you can go to localhost:3333 and get some pizza recommendations!

Using k6 to test it

All tests live in the k6 folder. Within this folder, you will find the following folders:

• foundations - covers the basic functionalities of k6.
• browser - covers a more deep-dive look on how to use the k6 browser module for browser and web performance testing.
• disruptor - covers a more deep-dive look on how to use xk6-disruptor for failure injection testing.
• advanced - covers tests that are more advanced such as hybrid tests, tracing, etc.

To run tests on the foundations folder, you can use the following commands:

cd k6/foundations
k6 run 01.basic.js

If you want to run one iteration with one virtual user, you can use the following command:

k6 run --iterations 1 --vus 1 01.basic.js

If QuickPizza is available remotely, then pass the hostname and port through the BASE_URL environment variable as follows:

k6 run -e BASE_URL=https://acmecorp.dev 01.basic.js
# or 
k6 run -e BASE_URL=https://acmecorp.dev:3333 01.basic.js

If the test uses the browser module, you need to pass the K6_BROWSER_ENABLED=true environment variable:

K6_BROWSER_ENABLED=true k6 run --iterations 1 --vus 1 browser.js

If the test uses an extension, you need to build it first via xk6. To build the extension using Docker, you can run the following command:

cd k6/foundations/extension

docker run --rm -e GOOS=darwin -u "$(id -u):$(id -g)" -v "${PWD}:/xk6" \
  grafana/xk6 build  \
  --with xk6-internal=.

Note that the GOOS variable is for Mac. Please refer to Build a k6 binary using Docker for more information.

To run the test that uses an extension, you can run the following command:

K6_BROWSER_ENABLED=true ./extension/k6 run 11.extension.js

Running a Prometheus instance

If you want to stream the metrics to a Prometheus instance, you need, well, a Prometheus instance. You can use the following command to run a local one:

docker run -p 9090:9090 prom/prometheus --config.file=/etc/prometheus/prometheus.yml \
             --storage.tsdb.path=/prometheus \
             --web.console.libraries=/usr/share/prometheus/console_libraries \
             --web.console.templates=/usr/share/prometheus/consoles \
             --web.enable-remote-write-receiver

Deploy application to Kubernetes

If you want to run a test that uses xk6-disruptor, you need to deploy QuickPizza to Kubernetes.

If you are already running the app with Docker, make sure you stop the QuickPizza container first.

Then, start minikube by running the command:

minikube start

To deploy the application, run:

kubectl apply -f pizza-info.yaml --namespace=pizza-ns

The IP of the service should be pending:

kubectl get all -n pizza-ns

NAME                 TYPE           CLUSTER-IP       EXTERNAL-IP   PORT(S)          AGE
service/pizza-info   LoadBalancer   10.108.142.101   <pending>     3333:30076/TCP   13s

The next step is to assign the external IP of the cluster. Using minikube, open another terminal window and run:

minikube tunnel

The external IP should be assigned:

kubectl get all -n pizza-ns

NAME                 TYPE           CLUSTER-IP       EXTERNAL-IP   PORT(S)          AGE
service/pizza-info   LoadBalancer   10.108.142.101   127.0.0.1     3333:30076/TCP   39s

Now you can go to localhost:3333 and get some pizza recommendations!

Running xk6-disruptor tests

To build the xk6-disruptor extension for fault injection testing, you can use the following command:

cd k6/disruptor

docker run --rm -e GOOS=darwin -u "$(id -u):$(id -g)" -v "${PWD}:/xk6" \
  grafana/xk6 build  \
  --with github.com/grafana/xk6-disruptor

To run a basic xk6-disruptor test, run the following command on the k6/disruptor folder:

./k6 run 01.basic.js

To run an example hybrid test of browser and xk6-disruptor, run the following command:

K6_BROWSER_ENABLED=true ./k6 run ../advanced/01.browser-with-disruptor.js

Deploy to Fly.io

Authenticate using the fly CLI. Then, run the CLI to deploy the application and set up the internal port 3333 that the server listens to.

fly launch --internal-port 3333 --now