https://github.com/techempower/tfbverifier
The application which verifies and benchmarks TechEmpower Framework Benchmark test implementations.
https://github.com/techempower/tfbverifier
Last synced: about 1 year ago
JSON representation
The application which verifies and benchmarks TechEmpower Framework Benchmark test implementations.
- Host: GitHub
- URL: https://github.com/techempower/tfbverifier
- Owner: TechEmpower
- License: other
- Created: 2020-07-01T17:05:38.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-02-18T17:20:59.000Z (over 4 years ago)
- Last Synced: 2025-04-07T03:03:02.682Z (about 1 year ago)
- Language: Rust
- Homepage: https://www.techempower.com/benchmarks/
- Size: 284 KB
- Stars: 3
- Watchers: 6
- Forks: 4
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TFBVerifier
[](https://github.com/TechEmpower/TFBVerifier/actions?query=workflow%3Abuild+branch%3Amaster)
The application that verifies the response from an application running in the
[TechEmpower Framework Benchmarks](https://github.com/TechEmpower/FrameworkBenchmarks).
The goal of this application is to live in isolation from
[test implementations](https://github.com/TechEmpower/FrameworkBenchmarks) and
even the [TFBToolset](https://github.com/TechEmpower/TFBToolset). This
application contains a Dockerfile which is how the Docker Image is created and
eventually published to Dockerhub.
The TFBToolset uses that published Docker image to verify test implementations
in the FrameworkBenchmarks project.
## Getting Started
These instructions will get you a copy of the project up and running on your
local machine for development and testing purposes.
### Prerequisites
* [Rust](https://rustup.rs/)
* [Docker](https://docs.docker.com/engine/install/)* or [Docker4Windows](https://docs.docker.com/docker-for-windows/install/)*
* [TechEmpower Frameworks](https://github.com/TechEmpower/FrameworkBenchmarks)*
* [TFBToolset](https://github.com/TechEmpower/TFBToolset)*
\* Not required for development or testing; only full-suite testing and deploying.
#### Windows Only
* [Expose daemon on `tcp://localhost:2375`](https://docs.docker.com/docker-for-windows/#general)*
\* Not required for development or testing; only full-suite testing and deploying.
### Running the tests
```
$ cargo test
```
### Building
```
$ cargo build --release
```
### Installing
```
$ docker build -t techempower/tfb.verifier .
```
## Running
To run any verification, a test implementation must be running from the
TFBToolset in `debug` mode, which will attach the test implementation to the
Docker Network `TFBNetwork`.
```
$ docker run -it --network=TFBNetwork -e "MODE=[probably verify, but maybe benchmark]" -e "CONCURRENCY_LEVELS=16,32,64,128,256,512" -e "PIPELINE_CONCURRENCY_LEVELS=256,1024,4096,16384" -e "DATABASE=[database you want to verify; this env var *can* be ignored]" -e "PORT=[the exposed port]" -e "TEST_TYPE=[the test type you want to verify]" -e "ENDPOINT=[the relative URL]" tfb.verifier
```
## Authors
* **Mike Smith** - *Initial work* - [msmith](https://github.com/msmith-techempower)
## License
This project is licensed under the BSD-3-Clause License - see the [LICENSE.md](LICENSE.md) file for details