testing: Add a way to extract variables from the test suite

1 files changed, 17 insertions, 0 deletions

diff --git a/TESTING b/TESTING
index 6253086..8d65f15 100644
--- a/TESTING
+++ b/TESTING
@@ -254,3 +254,20 @@ Tip and tricks when writing tests for Gitano
   however, `bash` then you should take extra care not to write bashisms into
   your test implementations.
 
+Analysing the variables used in lace contexts
+=============================================
+
+The set of predicates and variables available to lace contexts
+depends on the operation, and in many cases the data in the repository.
+
+This makes it difficult to know exactly what variables are available.
+
+To aid with this, if `GITANO_DUMP_VARIABLE_FILE` is set in the environment
+it will write a table of variables and the operations they exist in
+to the file path in `GITANO_DUMP_VARIABLE_FILE`.
+
+To make use of this in the test suite add
+`--env GITANO_DUMP_VARIABLE_FILE=$file_path` to `YARN_ARGS`.
+
+This is not compatible with running yarns in parallel
+and depends on the test suite coverage to produce sufficient results.