Merge lp:~liuyq0307/lava-android-test/improve-test-docs into lp:lava-android-test

[Yongqin Liu]

Improve some documentation of test.rst and usage.rst

This branch is based the following branch:
lp:~liuyq0307/lava-android-test/connect-lab-wifi/

So wait until the above branch is merge.
Then the review of this branch will be clear

[lp:~liuyq0307/lava-android-test/improve-test-docs]

189. By Yongqin Liu on 2012-07-11

merge with trunk

Unmerged revisions

=== modified file 'doc/tests.rst'
--- doc/tests.rst	2012-06-25 17:22:29 +0000
+++ doc/tests.rst	2012-07-11 03:23:17 +0000
@@ -6,7 +6,7 @@
 
 The following tests are currently supported in LAVA Android Test:
 
- * `big-LITTLE`_
+ * `big_LITTLE`_
  * `bluetooth`_
  * `busybox`_
  * `cts`_
@@ -21,7 +21,11 @@
  * `v8`_
  * `wifi`_
  * `0xbench`_
-
+ * `commands`_
+ * `instruments`_
+ * `hostshells`_
+ * `shells`_
+ 
 busybox
 +++++++
 .. automodule:: lava_android_test.test_definitions.busybox
@@ -58,6 +62,42 @@
 +++++++++
 .. automodule:: lava_android_test.test_definitions.gatortest
 
-big-LITTLE
-++++++++++
-.. automodule:: lava_android_test.test_definitions.big-little
+big_LITTLE
+++++++++++
+.. automodule:: lava_android_test.test_definitions.big_LITTLE
+
+bluetooth
++++++++++
+.. automodule:: lava_android_test.test_definitions.bluetooth
+
+tjbench
++++++++
+.. automodule:: lava_android_test.test_definitions.tjbench
+
+ime
++++
+.. automodule:: lava_android_test.test_definitions.ime
+
+usbhardware
++++++++++++
+.. automodule:: lava_android_test.test_definitions.usbhardware
+
+wifi
+++++
+.. automodule:: lava_android_test.test_definitions.wifi
+
+commands
+++++++++
+.. automodule:: lava_android_test.test_definitions.commands
+
+hostshells
+++++++++++
+.. automodule:: lava_android_test.test_definitions.hostshells
+
+instruments
++++++++++++
+.. automodule:: lava_android_test.test_definitions.instruments
+
+shells
+++++++
+.. automodule:: lava_android_test.test_definitions.shells
\ No newline at end of file

=== modified file 'doc/usage.rst'
--- doc/usage.rst	2012-06-16 05:11:07 +0000
+++ doc/usage.rst	2012-07-11 03:23:17 +0000
@@ -144,7 +144,7 @@
 and the output is well formatted, then congratulations, you can go
 directly to step 6. You don't need to wrap script again.
 
-3. Three types simple test
+3. Four types simple test
 
   1. Instrumentation test, run like "adb shell am instrument ..."
   
@@ -176,6 +176,17 @@
 
     echo "test_case_fail=fail"
     echo "test_case_pass=pass"
+    
+  4. Host shell test, need to write a shell and run like "bash script.sh"
+
+  create a file like lava_android_test/test_definitions/hostshells/example.sh
+  and put it under lava_android_test/test_definitions/shells::
+    
+    #!/bin/bash
+    echo "hostshells-example-fail=fail"
+    echo "hostshells-example-pass=pass"
+    
+  this shell script will be passed "-s $(SERIAL) $(OPTIONS)" as arguments
 
 4. About test scripts/tools
 

=== renamed file 'lava_android_test/test_definitions/big-LITTLE.py' => 'lava_android_test/test_definitions/big_LITTLE.py'
--- lava_android_test/test_definitions/big-LITTLE.py	2012-06-25 17:23:05 +0000
+++ lava_android_test/test_definitions/big_LITTLE.py	2012-07-11 03:23:17 +0000
@@ -27,10 +27,9 @@
 **Default options:** None
 """
 
-import lava_android_test.config
 import lava_android_test.testdef
 
-test_name = 'big-LITTLE'
+test_name = 'big_LITTLE'
 
 INSTALL_STEPS_ADB_PRE = []
 ADB_SHELL_STEPS = ['run_stress_switcher_tests.sh -a']

=== renamed file 'lava_android_test/test_definitions/cache-coherency.py' => 'lava_android_test/test_definitions/cache_coherency.py'
--- lava_android_test/test_definitions/cache-coherency.py	2012-05-22 11:29:25 +0000
+++ lava_android_test/test_definitions/cache_coherency.py	2012-07-11 03:23:17 +0000
@@ -18,10 +18,9 @@
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-import lava_android_test.config
 import lava_android_test.testdef
 
-test_name = 'cache-coherency'
+test_name = 'cache_coherency'
 
 INSTALL_STEPS_ADB_PRE = []
 ADB_SHELL_STEPS = ['stressapptest -M 16 --cc_test -s 10']

=== modified file 'lava_android_test/test_definitions/commands/__init__.py'
--- lava_android_test/test_definitions/commands/__init__.py	2012-05-29 11:03:47 +0000
+++ lava_android_test/test_definitions/commands/__init__.py	2012-07-11 03:23:17 +0000
@@ -0,0 +1,29 @@
+# copyright (C) 2012 Linaro Limited
+#
+# Author: Linaro Validation Team <[e-mail]>
+#
+# This file is part of LAVA Android Test.
+#
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+"""
+This directory contains the test that only needs to run an android command and 
+specify the output pattern that to parse the command ouptu to get result.
+Please see the example.py for a reference.
+
+**URL:** None
+
+**Default options:** None
+"""

=== modified file 'lava_android_test/test_definitions/hostshells/__init__.py'
--- lava_android_test/test_definitions/hostshells/__init__.py	2012-07-10 06:34:06 +0000
+++ lava_android_test/test_definitions/hostshells/__init__.py	2012-07-11 03:23:17 +0000
@@ -1,2 +1,30 @@
+# copyright (C) 2012 Linaro Limited
+#
+# Author: Linaro Validation Team <[e-mail]>
+#
+# This file is part of LAVA Android Test.
+#
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+"""
+This directory contains the tests that only need to run a host command.
+Please see the example.sh for a reference.
+
+**URL:** None
+
+**Default options:** None
+"""
+
 import os
 curdir = os.path.dirname(os.path.realpath(__file__))

=== modified file 'lava_android_test/test_definitions/instruments/__init__.py'
--- lava_android_test/test_definitions/instruments/__init__.py	2012-05-29 11:03:47 +0000
+++ lava_android_test/test_definitions/instruments/__init__.py	2012-07-11 03:23:17 +0000
@@ -0,0 +1,27 @@
+# copyright (C) 2012 Linaro Limited
+#
+# Author: Linaro Validation Team <[e-mail]>
+#
+# This file is part of LAVA Android Test.
+#
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+"""
+This directory contains the tests that only need to run the "am instrument -w" 
+command on android. Please see the example.py for a reference.
+
+**URL:** None
+
+**Default options:** None
+"""

=== modified file 'lava_android_test/test_definitions/monkey.py'
--- lava_android_test/test_definitions/monkey.py	2012-06-19 02:56:46 +0000
+++ lava_android_test/test_definitions/monkey.py	2012-07-11 03:23:17 +0000
@@ -17,6 +17,13 @@
 #
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
+"""
+Performs a test of monkey functionality in Android with the monkey command
+
+**URL:** http://android.git.linaro.org/gitweb?p=platform/development.git;a=blob;f=cmds/monkey/monkey
+
+**Default options:** None
+"""
 import os
 import lava_android_test.testdef
 from lava_android_test.config import get_config

=== modified file 'lava_android_test/test_definitions/shells/__init__.py'
--- lava_android_test/test_definitions/shells/__init__.py	2012-05-29 11:03:47 +0000
+++ lava_android_test/test_definitions/shells/__init__.py	2012-07-11 03:23:17 +0000
@@ -1,2 +1,31 @@
+# copyright (C) 2012 Linaro Limited
+#
+# Author: Linaro Validation Team <[e-mail]>
+#
+# This file is part of LAVA Android Test.
+#
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+"""
+This directory contains the tests that only need to run the android shell
+script that stored under this directory. Please see the example.sh for a reference.
+
+**URL:** None
+
+**Default options:** None
+"""
+
+
 import os
 curdir = os.path.dirname(os.path.realpath(__file__))