bddframework

BDD framework (bddframework)

Reusable Go module that the test suite in testbdd builds on. It wraps cluster access, operator installation (OLM and YAML), configuration flags, and a set of generic Gherkin steps.

The module is an extract of the test framework from the Kogito operator. Some packages (Infinispan, Kafka, Keycloak, Hyperfoil, Grafana, MongoDB) are inherited from it and are not used by the current scenarios.

Packages

Frequently used helpers

// Poll until the condition is true or the timeout (in minutes, scaled by load_factor) expires
framework.WaitForOnOpenshift(namespace, "description", timeoutInMin, func() (bool, error) { ... })

// Pods and deployments
framework.WaitForPodsWithLabel(namespace, "label-key", "label-value", count, timeoutInMin)
framework.GetDeployment(namespace, name)

// Run oc/kubectl
out, err := framework.CreateCommand("oc", "get", "csv", "-n", namespace).Execute()

// OLM
framework.GetClusterOperatorNamespace()      // openshift-operators on OpenShift
framework.GetCustomKogitoOperatorCatalog()   // bdd-tests-kogito-catalog (from operator_catalog_image)
framework.GetProductCatalog()                // redhat-operators

// Logging
framework.GetLogger(namespace).Info("message", "key", value)

Adding a configuration flag

1. Add a field to the env struct, a set.StringVar/set.BoolVar call in BindFlags, and a getter in pkg/config/config.go. Flags are registered with the tests. prefix.
2. Add the flag name (without the prefix) to STRING_TEST_PARAMS or BOOLEAN_TEST_PARAMS in hack/run-tests.sh, so make run-tests key=value accepts it.
3. Document the flag in testbdd/README.md.

Development

cd bddframework
go vet ./...
make test        # go mod tidy, go fmt, go vet, go test ./...

Changes here affect the whole suite. Also vet the testbdd module and dry-run a few tags (see testbdd/README.md).