Merge lp:~pwlars/lava-test/help into lp:lava-test/0.0

[Paul Larson]

Simple help command and help provided for the existing commands

[James Westby (james-w)]

36 + print getdoc(cmd)

should you use the help() function you put on cmd?

39 + except IndexError:

I would not use try/except, and just check len(argv), as the intent
is clearer, and it won't mask other issues.

I would also be happy to see some tests of at least the
infrastructure, if not the commands themselves.

Thanks,

James

review: Approve

[lp:~pwlars/lava-test/help]

12. By Paul Larson on 2010-07-02

use AbrekCmd.help()

13. By Paul Larson on 2010-07-02

return instead of print help

[Paul Larson (pwlars)]

> 36 + print getdoc(cmd)
>
> should you use the help() function you put on cmd?
Ah yes, fixed that

> 39 + except IndexError:
>
> I would not use try/except, and just check len(argv), as the intent
> is clearer, and it won't mask other issues.
also fixed

> I would also be happy to see some tests of at least the
> infrastructure, if not the commands themselves.
I'll add some new tests shortly

=== modified file 'abrek/builtins.py'
--- abrek/builtins.py	2010-06-29 22:33:29 +0000
+++ abrek/builtins.py	2010-07-02 22:19:21 +0000
@@ -1,43 +1,81 @@
 import sys
 
-from abrek.command import AbrekCmd
-from abrek.testdef import testloader
-
-class cmd_version(AbrekCmd):
+import abrek
+
+class cmd_version(abrek.command.AbrekCmd):
+    """ Show the version of abrek
+
+    Usage:  abrek version
+    """
     def run(self, argv):
         import abrek
         print abrek.__version__
 
-class cmd_install(AbrekCmd):
+class cmd_help(abrek.command.AbrekCmd):
+    """ Get help on abrek commands
+
+    Usage: abrek help [command]
+
+    If the command name is ommited, calling the help command will return a
+    list of valid commands.
+    """
+    def run(self, argv):
+        if len(argv) != 1:
+            print "Available commands:"
+            for cmd in abrek.command.get_all_cmds():
+                print "  %s" % cmd
+            print
+            print "To access extended help on a command use 'abrek help " \
+                  "[command]'"
+        else:
+            cmd = abrek.command.get_command(argv[0])
+            if cmd:
+                print cmd.help()
+            else:
+                print "No command found for '%s'" % argv[0]
+
+class cmd_install(abrek.command.AbrekCmd):
+    """ Install a test
+
+    Usage: abrek install TEST_NAME
+    """
     def run(self, argv):
         if len(argv) != 1:
             print "please specify the name of the test to install"
             sys.exit(1)
-        test = testloader(argv[0])
+        test = abrek.testdef.testloader(argv[0])
         try:
             test.install()
         except RuntimeError as strerror:
             print "Test installation error: %s" % strerror
             sys.exit(1)
 
-class cmd_run(AbrekCmd):
+class cmd_run(abrek.command.AbrekCmd):
+    """ Run tests
+
+    Usage: abrek run TEST_NAME
+    """
     def run(self, argv):
         if len(argv) != 1:
             print "please specify the name of the test to run"
             sys.exit(1)
-        test = testloader(argv[0])
+        test = abrek.testdef.testloader(argv[0])
         try:
             test.run()
         except Exception as strerror:
             print "Test execution error: %s" % strerror
             sys.exit(1)
 
-class cmd_uninstall(AbrekCmd):
+class cmd_uninstall(abrek.command.AbrekCmd):
+    """ Uninstall a test
+
+    Usage: abrek uninstall TEST_NAME
+    """
     def run(self, argv):
         if len(argv) != 1:
             print "please specify the name of the test to uninstall"
             sys.exit(1)
-        test = testloader(argv[0])
+        test = abrek.testdef.testloader(argv[0])
         try:
             test.uninstall()
         except Exception as strerror:
 
=== modified file 'abrek/command.py'
--- abrek/command.py	2010-06-21 17:23:54 +0000
+++ abrek/command.py	2010-07-02 22:19:21 +0000
@@ -9,6 +9,9 @@
     def run(self, argv):
         raise NotImplementedError("%s: command defined but not implemented!" %
                                   self.name())
+    def help(self):
+        from inspect import getdoc
+        return getdoc(self)
 
 def _convert_command_name(cmd):
     return cmd[4:].replace('_','-')