embed

README

Frisbee - A Test Automation Framework For Kubernetes

Website | Blog | Docs | Contact

What is Frisbee ?

Frisbee is the first Kubernetes framework designed to support declarative end-to-end system testing of containerized applications.

✔ Design end-to-end testing scenarios in an intuitive language!

✔ Run the actual production software - no mocks!

✔ Replay complex workloads through automated workflows!

✔ Combine Chaos Engineering with large-scale performance testing!

✔ Verify program behavior through programmable assertions!

To learn more about Frisbee, check the Walkthrough tutorial or visit our Website.

Testing Patterns

In declarative testing, a test scenario focuses on what to accomplish rather than on the imperative details of how to manipulate the state of an application under test and verify the final application state against an expected state.

This approach not make tests more readable, maintainable, and reproducible, but it also help devops in identifying testing patterns.

Here, you can see some testing patterns we have identified across different application domains.

👉 Databases

👉 Federated Learning

👉 HPC

👉 CI

Getting Started

Step 1 – Prerequsities:

To run Frisbee you must have access to a running Kubernetes cluster and ensure that kubectl and Helm are installed on your system.

For quick testing, you can use microk8s to deploy a local Kubernetes cluster on your machine.

sudo microk8s config > ~/.kube/config
sudo microk8s enable dns
sudo microk8s enable ingress
sudo microk8s enable helm3
sudo snap alias microk8s.kubectl kubectl
sudo snap alias microk8s.helm3 helm

Step 2 – Install Frisbee on K8s cluster:

Firstly, we need to download the Frisbee CLI:

curl -sSLf https://frisbee.dev/install.sh | sudo bash
export PATH=$PATH:/usr/local/bin

Since the majority of Frisbee operations happens through this CLI, it is suggested to enable the autocompletion.

source <(kubectl-frisbee completion bash)

As usual, use tab twice to get the CLI fields auto-completed.

The next step is to install Frisbee in your Kubernetes cluster.

kubectl-frisbee install production
kubectl logs -l control-plane=frisbee-operator -n frisbee --follow

Finally, you can download the Frisbee project to get access to the ready-to-use examples.

git clone git@github.com:CARV-ICS-FORTH/frisbee.git
cd frisbee

Step 3 – Submit a testing job:

To submit a testing job, the general syntax is:

kubectl-frisbee submit test <testName> <scenario.yaml> <path to dependent charts>

Conventionally, we separate the test-cases from the templates of the system under evaluation.

• examples: contains a list of test-cases.
• charts: contains Helm charts that provide templates used in the test-cases.

Let's try to run a scenario from the tutorial.

kubectl-frisbee submit test demo- ./examples/tutorial/15.performance-monitoring.yml ./charts/networking/iperf2/ ./charts/system/ 

• demo-: demo is the naming prefix, and the - indicate an autogenerated postfix (e.g, demo-326)
• ./examples/tutorial/15.performance-monitoring.yml: the scenario executes the iperf benchmark and the monitoring stack for observing its execution.
• ./examples/apps/iperf2: provides the application templates used within the scenario.
• ./charts/system: provides system-wide templates for the telemetry stack, chaos injection, etc.

Inspect Submitted Jobs:

To get a list of submitted tests, use:

kubectl frisbee get tests

Note that every test-case runs on a dedicated namespace (named after the test). To further dive into execution details use:

kubectl frisbee inspect tests demo-326

Step 4 – Live Progress Monitoring:

The last section of inspect provides the URLs for accessing Prometheus/Grafana.

Note that every scenario has its own monitoring stack in order to avoid interfering metrics.

firefox $(kubectl frisbee inspect tests demo-326 | grep grafana- | awk '{print $3'})

In contrast to the vanilla Grafana which plots only the performance metrics, Frisbee provides Contextualized Visualizations that contain information for:

• Joining nodes (blue vertical lines)
• Exiting nodes (orange vertical lines)
• Fault-Injection (red ranges)

Information like that helps in root-cause analysis, as it makes it easy to correlate an observed behavior back to a testing event.

For example, in the next figure, it fairly easy to understand that INSERT_ERROR messages (yellow line) are triggered by a fault-injection event.

Step 5 – Auto-generate test reports:

Finally, Frisbee provides an advanced functionality for auto-generating reports for the tests.

kubectl-frisbee report test demo-326 ~/frisbee-reports --pdf  --force

This will create report on ~/frisbee-reports directory including the pdf from Grafana.

Features

👉 Workflow templating to store commonly used workflows in the cluster.

👉 DAG based declaration of testing workflows.

👉 Step level input & outputs (template parameterization).

👉 Conditional Execution (Time-Driven, Status-Driven, Performance-Driven).

👉 Live Progress monitoring via Prometheus/Grafana.

👉 Assertions and alerting of SLA violations.

👉 Placement Policies (affinity/tolerations/node selectors).

👉 Archiving Test results after executing for later access.

👉 Garbage collection of completed resources.

👉 Chaos-Engineering and Fault-Injection via Chaos-Mesh.

👉 On-Demand reliable container attached storage.

👉 CLI applications to test management and test inspection.

Citation

If you publish work that uses Frisbee, please cite Frisbee as follows:

@article{nikolaidis2021frisbee,
title={Frisbee: automated testing of Cloud-native applications in Kubernetes},
author={Nikolaidis, Fotis and Chazapis, Antony and Marazakis, Manolis and Bilas, Angelos},
journal={arXiv preprint arXiv:2109.10727},
year={2021}
}

Contributing to Frisbee

We welcome contributions. Please see CONTRIBUTING.md to get started!

Acknowledgements

This project has received funding from the European Union's Horizon 2020 research and innovation programme under grant agreement No. 894204 (Ether, H2020-MSCA-IF-2019).

Documentation

Overview

Package embed is used to embed the various required scripts into the Frisbee Terminal. This allows to execute the Terminal from any path. For more info see https://zetcode.com/golang/embed/

Index

• Variables
• func UpdateLocalFiles(embeddedFS embed.FS, installationDir string) error

Variables

var Hack embed.FS

Functions

func UpdateLocalFiles

func UpdateLocalFiles(embeddedFS embed.FS, installationDir string) error

UpdateLocalFiles duplicates the structure of embedded fs into the installation dir.