Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tldr-pages/tldr-pages-test-harness
A Bats test-suite that validates if a tldr-client is compatible with the client specifications set out in the tldr repository.
https://github.com/tldr-pages/tldr-pages-test-harness
bats hacktoberfest testing tldr tldr-client tldr-pages
Last synced: 3 months ago
JSON representation
A Bats test-suite that validates if a tldr-client is compatible with the client specifications set out in the tldr repository.
- Host: GitHub
- URL: https://github.com/tldr-pages/tldr-pages-test-harness
- Owner: tldr-pages
- License: mit
- Created: 2023-05-20T00:06:59.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-04T18:43:23.000Z (11 months ago)
- Last Synced: 2024-07-30T20:54:26.848Z (6 months ago)
- Topics: bats, hacktoberfest, testing, tldr, tldr-client, tldr-pages
- Language: Shell
- Homepage:
- Size: 33.2 KB
- Stars: 3
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
tldr-pages-test-harness
[![Matrix chat][matrix-image]][matrix-url]
[![license][license-image]][license-url]
[matrix-url]: https://matrix.to/#/#tldr-pages:matrix.org
[matrix-image]: https://img.shields.io/matrix/tldr-pages:matrix.org?label=Chat+on+Matrix
[license-url]: https://github.com/tldr-pages/tldr-translation-pairs-gen/blob/main/LICENSE
[license-image]: https://img.shields.io/badge/license-MIT-blue.svg?label=License
## About
A Bats test-suite that validates if a tldr-pages client is compatible with the [client specifications](https://github.com/tldr-pages/tldr/blob/main/CLIENT-SPECIFICATION.md) set out in the [tldr](https://github.com/tldr-pages/tldr) repository.
You can see a summary of each test, including links to the relevant sections of the specification in the [`tldr.bats`](./tldr.bats) file.
## Results
| Client | Compliance |
|---|---|
| [tealdeer](https://github.com/dbrgn/tealdeer) |  |
| [tldr-c-client](https://github.com/tldr-pages/tldr-c-client) |  |
| [tldr-node-client](https://github.com/tldr-pages/tldr-node-client) |  |
| [tldr-python-client](https://github.com/tldr-pages/tldr-python-client) |  |
| [tlrc](https://github.com/tldr-pages/tlrc) |  |
## Running Against Local Builds
This is for if you want to check the results for a particular client, or are a maintainer of a tldr-pages client and want to run your development build against our compliance test suite.
Run the `validate` task to test the `tldr` command found on your path:
```sh
make validate
```
Alternatively, you can test any arbitrary binary by specifying the `PATH_TO_TLDR_CLIENT` environment variable:
```sh
PATH_TO_TLDR_CLIENT={{path/to/binary}} make validate
```
There are also the `validate-level-2` and `validate-level-3` tasks to check if clients adhere to optional parts of the spec.
### Docker
You can execute the tests for a predefined tldr-pages client even if you don't have it installed, so long as the Dockerfile is available for the client.
Check the contents of the `dockerfiles/` directory, and run the `CLIENT={{client}} docker-validate` command, populating the `CLIENT` environment variable with the client to test. For example:
```sh
CLIENT=tldr-c-client make docker-validate
```
You can also run `docker-validate-level-2` or `docker-validate-level-3` to check optional parts of the spec.
## Dependencies
* [Bats](https://github.com/bats-core/bats-core)
* [Make](https://www.gnu.org/software/make/)
### Debian
```sh
sudo apt install bats make
```