Merge pull request #696 from ldoktor/yaml-descriptions

examples.tests: Add params descriptions

examples/tests/cabort.py

@@ -13,6 +13,9 @@ class CAbort(Test):
 
     """
     A test that calls C standard lib function abort().
+
+    params:
+    :param tarball: Path to the c-source file relative to deps dir.
     """
 
     def setUp(self):

examples/tests/datadir.py

@@ -13,6 +13,8 @@ class DataDirTest(Test):
 
     """
     Test that uses resources from the data dir.
+
+    :param tarball: Path to the c-source file relative to deps dir.
     """
 
     def setUp(self):

examples/tests/doublefree.py

@@ -14,6 +14,8 @@ class DoubleFreeTest(Test):
 
     """
     Double free test case.
+
+    :param source: name of the source file located in deps path
     """
 
     def setUp(self):

examples/tests/doublefree_nasty.py

@@ -13,6 +13,8 @@ class DoubleFreeTest(Test):
 
     """
     10% chance to execute double free exception.
+
+    :param source: name of the source file located in deps path
     """
 
     __binary = None     # filename of the compiled program

examples/tests/fiotest.py

@@ -16,6 +16,9 @@ class FioTest(Test):
     stress/hardware verification.
 
     :see: http://freecode.com/projects/fio
+
+    :param fio_tarbal: name of the tarbal of fio suite located in deps path
+    :param fio_job: config defining set of executed tests located in deps path
     """
 
     def setUp(self):

examples/tests/linuxbuild.py

@@ -9,6 +9,9 @@ class LinuxBuildTest(Test):
 
     """
     Execute the Linux Build test.
+
+    :param linux_version: kernel version to be built
+    :param linux_config: name of the config file located in deps path
     """
 
     def setUp(self):

examples/tests/modify_variable.py

@@ -16,6 +16,8 @@ class PrintVariableTest(Test):
     1) it executes C program which prints MY VARIABLE 'A' IS: 0
     2) using GDB it modifies the variable to ff
     3) checks the output
+
+    :param source: path to the source file relative to deps dir.
     """
 
     __binary = None    # filename of the compiled program

examples/tests/multiplextest.py

@@ -8,6 +8,8 @@ class MultiplexTest(Test):
 
     """
     Execute a test that uses provided parameters (for multiplexing testing).
+
+    :param *: All params are only logged, they have no special meaning
     """
 
     def setUp(self):

examples/tests/raise.py

@@ -13,6 +13,9 @@ class Raise(Test):
 
     """
     A test that calls raise() to signals to itself.
+
+    :param source: name of the source file located in data path
+    :param signal_number: Which signal number should be raised
     """
 
     def setUp(self):

examples/tests/sleeptenmin.py

@@ -11,6 +11,10 @@ class SleepTenMin(Test):
 
     """
     Sleeps for 10 minutes
+
+    :param sleep_cycles: How many iterations should be executed
+    :param sleep_length: single sleep duration
+    :param sleep_method: what method of sleep should be used (builtin|shell)
     """
 
     def test(self):

examples/tests/sleeptest.py

@@ -9,7 +9,9 @@ from avocado import main
 class SleepTest(Test):
 
     """
-    Example test for avocado.
+    This test sleeps for 1s by default
+
+    :param sleep_length: Sleep duration
     """
 
     def test(self):

examples/tests/synctest.py

@@ -13,6 +13,11 @@ class SyncTest(Test):
 
     """
     Execute the synctest test suite.
+
+    :param sync_tarball: path to the tarball relative to deps dir.
+    :param default_symbols: whether to build with debug symbols (bool)
+    :param sync_length: how many data should by used in sync test
+    :param sync_loop: how many writes should be executed in sync test
     """
 
     def setUp(self):

examples/tests/timeouttest.py

@@ -10,6 +10,8 @@ class TimeoutTest(Test):
 
     """
     Functional test for avocado. Throw a TestTimeoutError.
+
+    :param sleep_time: How long should the test sleep
     """
 
     default_params = {'timeout': 3}

examples/tests/whiteboard.py

@@ -10,6 +10,11 @@ class WhiteBoard(Test):
 
     """
     Simple test that saves test custom data to the test whiteboard
+
+    :param whiteboard_data_file: File to be used as source for whiteboard data
+    :param whiteboard_data_size: Size of the generated data of the whiteboard
+    :param whiteboard_data_text: Text used when no file supplied
+    :param whiteboard_writes: How many times to copy the data into whiteboard
     """
 
     def test(self):