From 72d1fe572d3eb3748a86042a818d140f682ebc14 Mon Sep 17 00:00:00 2001
From: Peter Andersson <peppe@erlang.org>
Date: Thu, 5 Jun 2014 16:44:34 +0200
Subject: Introduce test categories for OTP tests

---
 lib/common_test/doc/src/run_test_chapter.xml | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

(limited to 'lib/common_test/doc/src')

diff --git a/lib/common_test/doc/src/run_test_chapter.xml b/lib/common_test/doc/src/run_test_chapter.xml
index 864f82cb63..df60e5f7f2 100644
--- a/lib/common_test/doc/src/run_test_chapter.xml
+++ b/lib/common_test/doc/src/run_test_chapter.xml
@@ -1005,6 +1005,31 @@
 	  for starting the tests, the relaxed scanner
 	  mode is enabled by means of the tuple: <c>{allow_user_terms,true}</c></p>
 	</section>
+	<section>
+	  <title>Reading test specification terms</title>
+	  <p>It's possible to look up terms in the current test specification
+	  (i.e. the spec that's been used to configure and run the current test).
+	  The function <c>get_testspec_terms()</c> returns a list of all test spec
+	  terms (both config- and test terms) and <c>get_testspec_terms(Tags)</c>
+	  returns the term (or a list of terms) matching the tag (or tags) in
+	  <c>Tags</c>.</p>
+	  <p>For example, in the test specification:</p>
+	  <pre>
+	    ...
+	    {label, my_server_smoke_test}.
+	    {config, "../../my_server_setup.cfg"}.
+	    {config, "../../my_server_interface.cfg"}.
+	    ...</pre>	    
+	  <p>And in e.g. a test suite or a CT hook function:</p>
+	  <pre>
+	    ...
+	    [{label,[{_Node,TestType}]}, {config,CfgFiles}] =
+                ct:get_testspec_terms([label,config]),
+
+            [verify_my_server_cfg(TestType, CfgFile) || {Node,CfgFile} &lt;- CfgFiles,
+                                                        Node == node()];
+	    ...</pre>
+	</section>
   </section>
 
   <section>
-- 
cgit v1.2.3