https://github.com/techempower/tfbtoolset
The tool which orchestrates the running of a TechEmpower Framework Benchmark.
https://github.com/techempower/tfbtoolset
Last synced: 10 months ago
JSON representation
The tool which orchestrates the running of a TechEmpower Framework Benchmark.
- Host: GitHub
- URL: https://github.com/techempower/tfbtoolset
- Owner: TechEmpower
- License: other
- Created: 2020-07-01T17:01:12.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-05-30T18:43:50.000Z (about 2 years ago)
- Last Synced: 2025-05-02T15:37:20.519Z (about 1 year ago)
- Language: Rust
- Homepage: https://www.techempower.com/benchmarks/
- Size: 213 KB
- Stars: 7
- Watchers: 6
- Forks: 5
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# TFBToolset
[](https://github.com/TechEmpower/TFBToolset/actions?query=workflow%3Abuild+branch%3Amaster)
The suite of tools that are run in the TechEmpower Framework
Benchmarks. This application is a stand-alone executable which orchestrates
several functions: auditing existing test implementations, running benchmarks,
running test implementation verifications, etc.
The goal of this application is to live in isolation from the test
implementations. Separately, the executable that is built from this toolset
will execute against the test implementations as local data.
## 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
* [TechEmpower Frameworks](https://github.com/TechEmpower/FrameworkBenchmarks)
* [Rust](https://rustup.rs/)
* [Docker](https://docs.docker.com/engine/install/) or [Docker4Windows](https://docs.docker.com/docker-for-windows/install/)
* [Git](https://git-scm.com/) (required for benchmarking only)
#### Windows Only
* [Expose daemon on `tcp://localhost:2375`](https://docs.docker.com/docker-for-windows/#general)
### EnvVars
To run any tests, the toolset needs to know the location of `FrameworkBenchmarks`.
There are three places the toolset searches (in order):
* Environment variable `TFB_HOME`
* Home directory; e.g. `~/.tfb`
* Current directory
### Running the tests
```
$ cargo test
```
### Building
```
$ cargo build --release
```
### Installing
The executable `tfb_toolset` (`tfb_toolset.exe` on Windows) only needs to be on
the `PATH`.
## Running
#### Verify Example
Unix:
```
$ cd TFBToolset
$ cargo build --release
$ cd ..
$ git clone https://github.com/TechEmpower/FrameworkBenchmarks.git
$ cd FrameworkBenchmarks
$ ../TFBToolset/target/release/tfb_toolset -m verify --test gemini
```
Windows:
```
> cd TFBToolset
> cargo build --release
> cd ..
> git clone https://github.com/TechEmpower/FrameworkBenchmarks.git
> cd FrameworkBenchmarks
> ..\TFBToolset\target\release\tfb_toolset.exe -m verify --test gemini
```
## Authors
* **Mike Smith** - *Initial work* - [msmith-techempower](https://github.com/msmith-techempower)
## License
This project is licensed under the BSD-3-Clause License - see the [LICENSE](LICENSE) file for details