# Endless

*Endless* is an End-to-End testing framework for TiDB which aims to shorten the time
for writing tests.

> :construction: **This project is still in very preliminary stage.
> Reach [Ray-Eldath][Ray-Eldath] for whatever you need.** :wink:

## Features

- [X] Based on [Ginkgo][ginkgo], which helps you efficiently write
  expressive and comprehensive tests using Behavior-Driven Development ("BDD") style.
- [ ] Integrating many existing common workloads and providing a framework
  for implementing workloads.
- [X] Making good use of [test-infra][test-infra] and affording high-level encapsulation,
  so you can operate TiDB and inject chaos easily.
- [X] Using [Gomega][gomega] as the assertion library and implements
  comprehensive yet declarative **checkers/matchers** based on that.

## Getting Started

Please see [docs](./docs/index.md) for full documentation, including tutorials
and best practices.

## Roadmap

Please check [roadmap][roadmap] for future plans.


[ginkgo]: https://onsi.github.io/ginkgo/
[gomega]: https://onsi.github.io/gomega/
[Ray-Eldath]: https://github.com/Ray-Eldath
[roadmap]: https://github.com/pingcap/endless/issues/21
[test-infra]: https://github.com/pingcap/test-infra
[test-plan]: https://github.com/pingcap/test-plan
[bdd]: https://en.wikipedia.org/wiki/Behavior-driven_development