diff --git a/examples/tests/cabort.py b/examples/tests/cabort.py index f56ee19e9aa3bca05bba074e2b3001d9151a41e4..45cf29c35d2d8f44920c57213809a15a2d280b0a 100755 --- a/examples/tests/cabort.py +++ b/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): diff --git a/examples/tests/datadir.py b/examples/tests/datadir.py index ed1f931e0cb91f4f0c59dd20e7fd214ccf29db96..d6b4d1adc3060bec4870f2593ba019353cc324a4 100644 --- a/examples/tests/datadir.py +++ b/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): diff --git a/examples/tests/doublefree.py b/examples/tests/doublefree.py index d5289bebbc358b6ac844d0846cbb1a3476566844..e2abedd6f21fcaa3952122274fbd208419f750bb 100755 --- a/examples/tests/doublefree.py +++ b/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): diff --git a/examples/tests/doublefree_nasty.py b/examples/tests/doublefree_nasty.py index 618488d857cb0e941b4a12c13edb622b91c79f49..edf15e694237fd8b1c3cc3fbc235f5a3a848487c 100755 --- a/examples/tests/doublefree_nasty.py +++ b/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 diff --git a/examples/tests/fiotest.py b/examples/tests/fiotest.py index 65277fa00a0ca578b06e16db4ad27f560a9bac46..149e1d5d302c9658c04bad64d44e2a59d8ae82db 100755 --- a/examples/tests/fiotest.py +++ b/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): diff --git a/examples/tests/linuxbuild.py b/examples/tests/linuxbuild.py index 10f6ae04f073556204ba5b104bdc72c1db5cea69..b7a4733897fc2425bf68daaea22401ccfd0122c1 100755 --- a/examples/tests/linuxbuild.py +++ b/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): diff --git a/examples/tests/modify_variable.py b/examples/tests/modify_variable.py index 9ebf76a6e66a61e2babf00a7473e2f2bc42d1750..794bba2981e4d9f365692c41faf271d8357a9d03 100755 --- a/examples/tests/modify_variable.py +++ b/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 diff --git a/examples/tests/multiplextest.py b/examples/tests/multiplextest.py index 0da459e1c5fd063d909c9003b61a6c5f66dd7f66..4030bad9b77daa63989580e8f6cf69d09e436d8c 100755 --- a/examples/tests/multiplextest.py +++ b/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): diff --git a/examples/tests/raise.py b/examples/tests/raise.py index b8f209e25cf26442f6eb2f32ccb49eebe6558072..733aa0c6aeb8a7d55e8607e9e11d34cbe9cccbb5 100755 --- a/examples/tests/raise.py +++ b/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): diff --git a/examples/tests/sleeptenmin.py b/examples/tests/sleeptenmin.py index a18f513fec10980d2ccac44e66467458efc6432d..d851568475a59bad7cea92598e469b8bc5dd1812 100755 --- a/examples/tests/sleeptenmin.py +++ b/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): diff --git a/examples/tests/sleeptest.py b/examples/tests/sleeptest.py index 7d28aee6b05341f8fc5723ea454458dd07e24634..6526250fd260f20fd966b06d8682f230bbf7c585 100755 --- a/examples/tests/sleeptest.py +++ b/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): diff --git a/examples/tests/synctest.py b/examples/tests/synctest.py index 6bef2dbb96c5bd10390758ec6e182e6ae2dd966e..66e9048c761821270fb52309011743caced25704 100755 --- a/examples/tests/synctest.py +++ b/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): diff --git a/examples/tests/timeouttest.py b/examples/tests/timeouttest.py index bb629a9736297d22c09358d7223d31d1ab48e524..09535629a1a9d1637caf1fd748b068c8b741dfe9 100755 --- a/examples/tests/timeouttest.py +++ b/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} diff --git a/examples/tests/whiteboard.py b/examples/tests/whiteboard.py index 9d6c55f7aba315316c1a956ea1ef08e289f30ba1..3985a2e41db85060be920c4aae20db7f24cb59cc 100755 --- a/examples/tests/whiteboard.py +++ b/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):