summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLars Wirzenius <liw@liw.fi>2022-11-02 16:06:59 +0200
committerLars Wirzenius <liw@liw.fi>2022-11-02 16:06:59 +0200
commit33d5ccde179ba7ff794fc77d808f710d561f2fb2 (patch)
tree1f2946c4664e3ae45fa29c672f5df730b64625ea
parente9f991060e3c0577a999f427e84b255d68d25a9b (diff)
downloaddebian-subplot-33d5ccde179ba7ff794fc77d808f710d561f2fb2.tar.gz
docs: explain how to run the scenarios
Sponsored-by: author
-rw-r--r--debian.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/debian.md b/debian.md
index da26c56..32d86c6 100644
--- a/debian.md
+++ b/debian.md
@@ -11,6 +11,19 @@ to verify the acceptance criteria, based on scenarios specified here.
# Acceptance criteria
+This chapter contains requirements and scenarios that verify they are
+met. To generate code from the scenarios and run it, use the following
+commands:
+
+~~~sh
+subplot codegen debian.subplot -o test.py
+python3 test.py --env DEBIAN_HOST=xyzzy --env HOME=$HOME --log test.log
+~~~
+
+This runs the scenarios against the host `xyzzy`, and writes a log
+file to `test.log`. The environment variable `HOME` is copied to the
+test program so that it can use your normal SSH configuration.
+
## Can log in via SSH as the `debian` user and become root with sudo
_Requirement: The system administrator can log in and do things as