summaryrefslogtreecommitdiff
path: root/testenv/conf/server_files.py
diff options
context:
space:
mode:
Diffstat (limited to 'testenv/conf/server_files.py')
-rw-r--r--testenv/conf/server_files.py11
1 files changed, 11 insertions, 0 deletions
diff --git a/testenv/conf/server_files.py b/testenv/conf/server_files.py
index bf6c1633..1e9d3466 100644
--- a/testenv/conf/server_files.py
+++ b/testenv/conf/server_files.py
@@ -1,5 +1,16 @@
from conf import hook
+""" Pre-Test Hook: ServerFiles
+This hook is used to define a set of files on the server's virtual filesystem.
+server_files is expected to be dictionary that maps filenames to their
+contents. In the future, this can be used to add additional metadat to the
+files using the WgetFile class too.
+
+This hook also does some additional processing on the contents of the file. Any
+text between {{and}} is replaced by the contents of a class variable of the
+same name. This is useful in creating files that contain an absolute link to
+another file on the same server. """
+
@hook()
class ServerFiles: