https://github.com/citrusframework/yaks
YAKS is a platform to enable Cloud Native BDD testing on Kubernetes
https://github.com/citrusframework/yaks
bdd cloud-native kubernetes messaging testing
Last synced: about 2 months ago
JSON representation
YAKS is a platform to enable Cloud Native BDD testing on Kubernetes
- Host: GitHub
- URL: https://github.com/citrusframework/yaks
- Owner: citrusframework
- License: apache-2.0
- Created: 2019-07-15T10:04:29.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-06-21T13:49:14.000Z (10 months ago)
- Last Synced: 2025-02-23T08:29:20.103Z (about 2 months ago)
- Topics: bdd, cloud-native, kubernetes, messaging, testing
- Language: Java
- Homepage:
- Size: 6.56 MB
- Stars: 84
- Watchers: 4
- Forks: 28
- Open Issues: 59
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-java - YAKS
README
# YAKS ![logo][1]
[](https://search.maven.org/search?q=g:org.citrusframework.yaks)
[](https://github.com/citrusframework/yaks/actions)
[](https://github.com/citrusframework/yaks/actions)
[](https://www.apache.org/licenses/LICENSE-2.0)
[](https://citrusframework.zulipchat.com)
## What is YAKS!?
YAKS is a framework to enable Cloud Native BDD testing on Kubernetes! Cloud Native here means that your tests execute
as Kubernetes PODs.
As a user you can run tests by creating a `Test` custom resource on your favorite Kubernetes based cloud provider.
Once the YAKS operator is installed it will listen for custom resources and automatically prepare a test runtime
that runs the test as part of the cloud infrastructure.
Tests in YAKS follow the BDD (Behavior Driven Development) concept and represent feature specifications written
in [Gherkin](https://cucumber.io/docs/gherkin/) syntax.
As a framework YAKS provides a set of predefined [Cucumber](https://cucumber.io/) steps which help you to connect with different
messaging transports (Http REST, JMS, Kafka, Knative eventing) and verify message data with assertions on the header and body content.
YAKS adds its functionality on top of on [Citrus](https://citrusframework.org) for connecting to different endpoints as a client
and/or server.
Read more about YAKS in the [reference manual](https://citrusframework.org/yaks/reference/html/index.html)
## Getting started
Assuming you have a Kubernetes playground and that you are connected to a namespace on that cluster
just write a `helloworld.feature` BDD file with the following content:
_helloworld.feature_
```gherkin
Feature: Hello
Scenario: Print hello message
Given print 'Hello from YAKS!'
```
You can then execute the following command using the [YAKS CLI tool](https://github.com/citrusframework/yaks/releases/):
```bash
yaks run helloworld.feature
```
This runs the test immediately on the current namespace in your connected Kubernetes cluster.
Nothing else is needed.
Please continue reading the [documentation](https://citrusframework.org/yaks/reference/html/index.html) and learn how to
install and get started working with YAKS.
## For YAKS developers
Requirements:
- Go 1.18+
- Operator SDK 0.19.4+
- Maven 3.8.4+
- Git client
You can build the YAKS project and get the `yaks` CLI by running:
```
make build
```
If you want to build the operator image locally for development in Minishift for instance, then:
```
# Build binaries and images
eval $(minishift docker-env)
make clean images-no-test
```
If the operator pod is running, just delete it to let it grab the new image.
```
oc delete pod yaks
```
[1]: /docs/logo-30x30.png "YAKS"