diff options
author | Lars Wirzenius <liw@liw.fi> | 2021-12-04 12:43:34 +0200 |
---|---|---|
committer | Lars Wirzenius <liw@liw.fi> | 2021-12-04 12:43:34 +0200 |
commit | 28c362b68983193b78beca014f41fdc63b9f5466 (patch) | |
tree | 960d0ecbe571f01b4dbe59b7c4a96514c1b53158 /obnam-benchmark.md | |
parent | 684b96b132282a4723e9fa847746b13ee0900ecb (diff) | |
download | obnam-benchmark-28c362b68983193b78beca014f41fdc63b9f5466.tar.gz |
initial thing that runs
Sponsored-by: author
Diffstat (limited to 'obnam-benchmark.md')
-rw-r--r-- | obnam-benchmark.md | 38 |
1 files changed, 7 insertions, 31 deletions
diff --git a/obnam-benchmark.md b/obnam-benchmark.md index 7403211..1f1f353 100644 --- a/obnam-benchmark.md +++ b/obnam-benchmark.md @@ -2,12 +2,13 @@ title: "`obnam-benchmark`---tool to run benchmarks" author: "The Obnam project" documentclass: report +template: rust bindings: - subplot/benchmark.yaml - lib/files.yaml - lib/runcmd.yaml -impls: - rust: [] +functions: +- subplot/benchmark.rs ... @@ -70,33 +71,6 @@ file can describe synthetic benchmarks for different use cases. # Acceptance criteria -## Smoke test - -_Requirement: The benchmark tool must be able to handle a simplistic -specification file and report results that are very fast._ - -This requirement verifies that we can run `obnam-benchmark` in the -simplest possible case: to run a benchmark with one backup, using test -data consisting only of an empty directory. If this works, then we -know that the executable program exists, can be invoked, at least some -of its command line and specification code works. If this scenario -doesn't work, then we can't expect anything else to work either. - -```scenario -given the benchmark system is set up -given file smoke.yaml -when I run obnam-benchmark smoke.yaml -then file smoke.json exists -then benchmark "smoke" in smoke.json lasted less than 1000 milliseconds -``` - -```{#smoke.yaml .yaml .file .numberLines} -- benchmark: smoke - backups: - - change: [] -``` - - ## Parses a specification file _Requirement: The benchmark tool can parse a specification file._ @@ -112,12 +86,14 @@ Specifically, we verify that the tool parses file sizes such as "1K" correctly. ```scenario -given an installed obnam-benchmark +given an installed Rust program obnam-benchmark given file spec.yaml when I run obnam-benchmark dump-spec spec.yaml -then stdout, as JSON, matches spec.json ``` +then stdout, as JSON, matches spec.json + + ```{#spec.yaml .yaml .file .numberLines} benchmarks: - benchmark: foo |