about summary refs log tree commit diff
path: root/tvix/eval/src/tests/tvix_tests/README.md
diff options
context:
space:
mode:
authorVincent Ambo <mail@tazj.in>2022-08-10T16·31+0300
committertazjin <tazjin@tvl.su>2022-08-24T23·11+0000
commit96e9f750c59153f8d6353e3831ffd55ea810d08a (patch)
tree5ab8ad97e9c94122a6f038c4082454807db51070 /tvix/eval/src/tests/tvix_tests/README.md
parent3671056640dc2dfe339bbb044c7bccca2ada9901 (diff)
test(tvix/eval): add identity tests for literal evaluation r/4467
Change-Id: Id3f37fbe341e15e9428ef1d579d61a514232c0e8
Reviewed-on: https://cl.tvl.fyi/c/depot/+/6132
Tested-by: BuildkiteCI
Reviewed-by: grfn <grfn@gws.fyi>
Diffstat (limited to 'tvix/eval/src/tests/tvix_tests/README.md')
-rw-r--r--tvix/eval/src/tests/tvix_tests/README.md19
1 files changed, 19 insertions, 0 deletions
diff --git a/tvix/eval/src/tests/tvix_tests/README.md b/tvix/eval/src/tests/tvix_tests/README.md
new file mode 100644
index 000000000000..b493aa81f12f
--- /dev/null
+++ b/tvix/eval/src/tests/tvix_tests/README.md
@@ -0,0 +1,19 @@
+These tests are "native" to Tvix and exist in addition to the Nix test
+suite.
+
+All of these are straightforward code snippets which are expected to
+produce a certain result.
+
+# `identity-*` tests
+
+Files named `identity-*.nix` contain code that is supposed to produce
+itself exactly after evaluation.
+
+These are useful for testing literals.
+
+# `eval-okay-*` tests
+
+Files named `eval-okay-*.nix` contain code which is supposed to
+evaluate to the output in the corresponding `eval-okay-*.exp` file.
+
+This convention is taken from the original Nix test suite.