test: add subplot for testing Subplot against a curated list

1 files changed, 61 insertions, 0 deletions

diff --git a/reference.md b/reference.md
new file mode 100644
index 0000000..f6620c8
--- /dev/null
+++ b/reference.md
@@ -0,0 +1,61 @@
+# Introduction
+
+This document describes how we guard against accidental breaking
+changes in Subplot by running it against a curated set of subplot
+documents.
+
+# Subplot
+
+## Produce a PDF
+
+~~~scenario
+given an installed subplot
+given a clone of https://gitlab.com/larswirzenius/subplot.git in src at ec9652a72aa8ff47fa64b8a1b5ba9afe84be4f7e
+when I docgen subplot.md to test.pdf, in src
+then file src/test.pdf exists
+~~~
+
+## Produce HTML page
+
+~~~scenario
+given an installed subplot
+given a clone of https://gitlab.com/larswirzenius/subplot.git in src at ec9652a72aa8ff47fa64b8a1b5ba9afe84be4f7e
+when I docgen subplot.md to test.html, in src
+when I run, in src, subplot docgen subplot.md -o subplot.html
+then file src/test.html exists
+~~~
+
+## Generate and run test program
+
+~~~scenario
+given an installed subplot
+given file run_test.sh
+given a clone of https://gitlab.com/larswirzenius/subplot.git in src at ec9652a72aa8ff47fa64b8a1b5ba9afe84be4f7e
+when I run, in src, subplot codegen subplot.md -o test-inner.py
+when I run bash run_test.sh
+then command is successful
+~~~
+
+~~~{#run_test.sh .file .sh}
+#!/bin/bash
+
+set -euo pipefail
+python3 src/test-inner.py --log test-inner.log --env "SUBPLOT_DIR=$(pwd)/target/debug"
+~~~
+
+
+---
+title: Test Subplot against reference subplots
+author: The Subplot project
+template: python
+bindings: 
+- reference.yaml
+- subplot.yaml
+- lib/runcmd.yaml
+- lib/files.yaml
+functions:
+- reference.py
+- subplot.py
+- lib/files.py
+- lib/runcmd.py
+...