[tor-commits] [spec/master] Add specification of the deck metadata

[art at torproject.org]

commit 645536d4bf847d1702c55e6839c040176407ed22
Author: Arturo Filastò <art at fuffa.org>
Date:   Wed Aug 13 17:44:17 2014 +0200

    Add specification of the deck metadata
---
 test-decks/td-spec.md |   24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/test-decks/td-spec.md b/test-decks/td-spec.md
index 70e523a..da85985 100644
--- a/test-decks/td-spec.md
+++ b/test-decks/td-spec.md
@@ -72,6 +72,16 @@ header:
   - no-collector
 ```
 
+The deck header can also contain metadata associated to the test deck. The
+possible fields are:
+
+1. name: The name of the test deck.
+2. description: A short description of the test deck.
+3. author: The author of the test deck.
+4. version: A version number for the test deck.
+5. requires-root: A flag to indicate that the test deck requires root to run. (FLAG)
+6. requires-tor: A flag to indicate that the test deck requires tor to run. (FLAG)
+
 The header may also be omitted.
 
 The body is a list composed of one element per nettest execution. Every nettest
@@ -174,6 +184,20 @@ separately, which is unacceptable.
 
 The container proposed is tar+gzip because it's well supported in python. 
 
+# 4. Container format
+
+The container proposed is tar+gzip because it's well supported in python. The
+deck container will be composed of a directory named "deck" containing the deck
+file and the inputs.
+
+The directory layout will be:
+
+deck/test.deck
+deck/input-filename-1.txt
+deck/input-filename-2.txt
+
+This will then be compressed using tar+gzip.
+
 # 5. Example deck
 
 The complete.deck provided with each installation of ooni-probe would be: