summaryrefslogtreecommitdiff
path: root/obnam-benchmark.md
diff options
context:
space:
mode:
Diffstat (limited to 'obnam-benchmark.md')
-rw-r--r--obnam-benchmark.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/obnam-benchmark.md b/obnam-benchmark.md
index 076255d..709260d 100644
--- a/obnam-benchmark.md
+++ b/obnam-benchmark.md
@@ -115,3 +115,24 @@ benchmarks:
}
```
+
+## Smoke test to run a trivial benchmark
+
+_Requirement: The benchmark tool can benchmarks at all._
+
+We verify this by running a trivial benchmark, which backs up an
+empty directory.
+
+~~~scenario
+given an installed Rust program obnam-benchmark
+given file smoke.yaml
+when I run obnam-benchmark run smoke.yaml --output smoke.json
+then file smoke.json is valid JSON
+~~~
+
+```{#smoke.yaml .yaml .file .numberLines}
+benchmarks:
+- benchmark: smoke
+ backups:
+ - changes: []
+```