Merge lp:~stylesen/lava-dispatcher/testdef-from-repo-doc into lp:lava-dispatcher

[Senthil Kumaran S]

Added documentation for explaining the new job definition format for defining lava test shell action to get test definitions from repository.

[Dave Pigott (dpigott)]

+1

review: Approve

[Antonio Terceiro (terceiro)]

Small nitpick ...

On Mon, Nov 26, 2012 at 10:17:30AM -0000, Senthil Kumaran S wrote:
> -You can put multiple test definition URLs in the "testdef_urls" section. These
> -will be run sequentially without reboot. Alternatively, you can specify each
> -URL in a separate ``lava_test_shell`` action which will allow for a reboot
> -between each test.
> -
> -.. seealso:: The test definition format for ``lava_test_shell`` actions here_
> -
> -.. _here: lava_test_shell.html
> +You can put multiple test definition URLs in "testdef_urls"
> +section. The "testdef_urls" section takes a python list of strings
> +which are URLs. These will be run sequentially without
> +reboot. Alternatively, you can specify each URL in a separate
> +``lava_test_shell`` action which will allow for a reboot between each test.

s/python list of strings/JSON list of strings/ ??

(the syntax for a list of strings is probably the same in Python and
JSON, but still)

--
Antonio Terceiro
Software Engineer - Linaro
http://www.linaro.org

[Michael Hudson-Doyle (mwhudson)]

Antonio Terceiro <email address hidden> writes:

> Small nitpick ...
>
> On Mon, Nov 26, 2012 at 10:17:30AM -0000, Senthil Kumaran S wrote:
>> -You can put multiple test definition URLs in the "testdef_urls" section. These
>> -will be run sequentially without reboot. Alternatively, you can specify each
>> -URL in a separate ``lava_test_shell`` action which will allow for a reboot
>> -between each test.
>> -
>> -.. seealso:: The test definition format for ``lava_test_shell`` actions here_
>> -
>> -.. _here: lava_test_shell.html
>> +You can put multiple test definition URLs in "testdef_urls"
>> +section. The "testdef_urls" section takes a python list of strings
>> +which are URLs. These will be run sequentially without
>> +reboot. Alternatively, you can specify each URL in a separate
>> +``lava_test_shell`` action which will allow for a reboot between each test.
>
> s/python list of strings/JSON list of strings/ ??
>
> (the syntax for a list of strings is probably the same in Python and
> JSON, but still)

I would just say "list" -- the syntax is implied, I think.

Cheers,
mwh

[Senthil Kumaran S (stylesen)]

Hi Antonio,

On Tuesday 27 November 2012 12:08 AM, Michael Hudson-Doyle wrote:
> I would just say "list" -- the syntax is implied, I think.

Thanks for pointing it out. I just made the change in revision 469 @
trunk. I took Michael's suggestion as follows:

"The "testdef_urls" section takes a list of strings which are URLs."

Thank You.
--
Senthil Kumaran S
http://www.stylesen.org/
http://www.sasenthilkumaran.com/

=== modified file 'doc/jobfile.rst'
--- doc/jobfile.rst	2012-10-10 19:29:04 +0000
+++ doc/jobfile.rst	2012-11-26 10:16:04 +0000
@@ -68,7 +68,7 @@
 Using LAVA Test Shell
 =====================
 The ``lava_test_shell`` action provides a way to employ a more black-box style
-testing appoach with the target device. The action only requires that a
+testing approach with the target device. The action only requires that a
 deploy action (deploy_linaro_image/deploy_linaro_android_image) has been
 executed. Its format is::
 
@@ -82,14 +82,57 @@
         }
     }
 
-You can put multiple test definition URLs in the "testdef_urls" section. These
-will be run sequentially without reboot. Alternatively, you can specify each
-URL in a separate ``lava_test_shell`` action which will allow for a reboot
-between each test.
-
-.. seealso:: The test definition format for ``lava_test_shell`` actions here_
-
-.. _here: lava_test_shell.html
+You can put multiple test definition URLs in "testdef_urls"
+section. The "testdef_urls" section takes a python list of strings
+which are URLs. These will be run sequentially without
+reboot. Alternatively, you can specify each URL in a separate
+``lava_test_shell`` action which will allow for a reboot between each test.
+
+If your test definitions are available in a git repository then
+``lava_test_shell`` can automatically pull the test definition from
+the git repository and execute it. The format is::
+
+    {
+      "command": "lava_test_shell",
+      "parameters": {
+          "testdef_repos": [
+              {"git-repo": "git://git.linaro.org/people/stylesen/sampletestdefs.git",
+               "revision": "91df22796f904677c0fe5df787fc04234bf97691",
+               "testdef": "testdef.yaml"
+              }],
+      "timeout": 1800
+      }
+    }
+
+Alternatively, if your test definitions are available in a bzr repository then
+``lava_test_shell`` can automatically pull the test definition from
+the bzr repository and execute it. The format is::
+
+    {
+      "command": "lava_test_shell",
+      "parameters": {
+          "testdef_repos": [
+              {"bzr-repo": "lp:~stylesen/lava-dispatcher/sampletestdefs-bzr",
+               "revision": "1",
+               "testdef": "testdef.yaml"
+              }],
+      "timeout": 1800
+      }
+    },
+
+In both the above formats "revision" and "testdef" are optional. If
+"revision" is not specified then the latest revision in the repository is
+cloned. If there is no "testdef" specified, then inside the cloned
+directory of the repository a file with name "lavatest.yaml" is looked
+up which is the default name for test definitions. The "testdef"
+parameter could be used in order to override the default name for test
+definition file.
+
+.. seealso:: The test definition format for ``lava_test_shell``
+             actions `here <lava_test_shell.html>`_
+
+             Developer documentation for ``lava_test_shell`` is
+             available `here <http://bazaar.launchpad.net/~linaro-validation/lava-dispatcher/trunk/view/head:/lava_dispatcher/actions/lava_test_shell.py#L23>`_
 
 Adding Meta-Data
 ================