oats

README

OpenTelemetry Acceptance Tests (OATs)

Goals

1. Flexibility to support qualification of changes to the OpenTelemetry Collector, and Tempo
2. Ability to support OpenTelemetry SDK functionality such as sampling
3. Highlight the use of Ginkgo, and Gomega
4. Have a cute name

Getting Started

1. Install Go
2. Install Docker (Podman also works provided it is listening on the expected Docker Unix socket)
3. Clone the repository
4. Ensure that ${GOBIN} is on your ${PATH}
5. From within the repository directory, install Ginkgo

go install github.com/onsi/ginkgo/v2/ginkgo

1. Run the specs

ginkgo -r (or ginkgo ./...)

1. Browse the example

Writing Specs

1. Decide whether to use the testhelpers/observability package, individual packages such as testhelpers/tempo, or only support externally provisioned endpoints
2. Write the specs using Ginkgo, and Gomega
3. Profit