Reorganize tests and benchmark scripts.

Mainly to get rid of one top level directory. But this will also be useful when there are tests of the embedding API.
2015-03-14 12:45:56 -07:00
parent e2a72282a1
commit 64eccdd9be
562 changed files with 32 additions and 8 deletions
@@ -0,0 +1,21 @@
+This contains the automated validation suite for the VM and built-in libraries.
+
+* `benchmark/` - Performance tests. These aren't strictly pass/fail, but let us
+  compare performance both against other languages and against previous builds
+  of Wren itself.
+
+* `core/` - Tests for the built in core library, mainly methods on the core
+  classes. If a bug is in `wren_core.c` or `wren_value.c`, it will most likely
+  break one of these tests.
+
+* `io/` - Tests for the built in IO library. In other words, methods on the
+  `IO` class. If a bug is in `wren_io.c`, it should break one of these tests.
+
+* `language/` - Tests of the language itself, its grammar and runtime
+  semantics. If a bug is in `wren_compiler.c` or `wren_vm.c`, it will most
+  likely break one of these tests. This includes tests for the syntax for the
+  literal forms of the core classes.
+
+* `limit/` - Tests for various hardcoded limits. The language doesn't
+  officially *specify* these limits, but the Wren implementation has them.
+  These tests ensure that limit behavior is well-defined and tested.