More comments added to methods in host_test.py

Author: PrzemekWirkus

workspace_tools/host_tests/host_test.py

@@ -28,8 +28,7 @@
 from sys import stdout
 
 class Mbed:
-    """
-    Base class for a host driven test
+    """ Base class for a host driven test
     """
     def __init__(self):
         parser = OptionParser()
@@ -83,10 +82,11 @@ def __init__(self):
         self.extra_serial = None
         self.serial = None
         self.timeout = self.DEFAULT_TOUT if self.options.timeout is None else self.options.timeout
-        print 'Mbed: "%s" "%s"' % (self.port, self.disk)
+        print 'Host test instrumentation on port: "%s" with serial: "%s"' % (self.port, self.disk)
 
     def init_serial(self, baud=9600, extra_baud=9600):
-        """ Initialize serial port. Function will return error is port can't be opened or initialized """
+        """ Initialize serial port. Function will return error is port can't be opened or initialized
+        """
         result = True
         try:
             self.serial = Serial(self.port, timeout=1)
@@ -102,15 +102,17 @@ def init_serial(self, baud=9600, extra_baud=9600):
         return result
 
     def serial_timeout(self, timeout):
-        """ Wraps self.mbed.serial object timeout property """
+        """ Wraps self.mbed.serial object timeout property
+        """
         result = None
         if self.serial:
             self.serial.timeout = timeout
             result = True
         return result
 
     def serial_read(self, count=1):
-        """ Wraps self.mbed.serial object read method """
+        """ Wraps self.mbed.serial object read method
+        """
         result = None
         if self.serial:
             try:
@@ -120,7 +122,8 @@ def serial_read(self, count=1):
         return result
 
     def serial_write(self, write_buffer):
-        """ Wraps self.mbed.serial object write method """
+        """ Wraps self.mbed.serial object write method
+        """
         result = -1
         if self.serial:
             try:
@@ -131,12 +134,12 @@ def serial_write(self, write_buffer):
 
     def safe_sendBreak(self, serial):
         """ Wraps serial.sendBreak() to avoid serial::serialposix.py exception on Linux
-        Traceback (most recent call last):
-          File "make.py", line 189, in <module>
-            serial.sendBreak()
-          File "/usr/lib/python2.7/dist-packages/serial/serialposix.py", line 511, in sendBreak
-            termios.tcsendbreak(self.fd, int(duration/0.25))
-        error: (32, 'Broken pipe')
+            Traceback (most recent call last):
+              File "make.py", line 189, in <module>
+                serial.sendBreak()
+              File "/usr/lib/python2.7/dist-packages/serial/serialposix.py", line 511, in sendBreak
+                termios.tcsendbreak(self.fd, int(duration/0.25))
+            error: (32, 'Broken pipe')
         """
         result = True
         try:
@@ -151,15 +154,22 @@ def safe_sendBreak(self, serial):
         return result
 
     def touch_file(self, path):
+        """ Touch file and set timestamp to items
+        """
         with open(path, 'a'):
             os.utime(path, None)
 
     def reset_timeout(self, timeout):
+        """ Timeout executed just after reset command is issued
+        """
         for n in range(0, timeout):
             sleep(1)
 
     def reset(self):
-        """ reboot.txt   - startup from standby state, reboots when in run mode.
+        """ Reset function. Supports 'standard' send break command via Mbed's CDC,
+            also handles other reset modes.
+            E.g. reset by touching file with specific file name:
+            reboot.txt   - startup from standby state, reboots when in run mode.
             shutdown.txt - shutdown from run mode
             reset.txt    - reset FPGA during run mode
         """
@@ -173,6 +183,8 @@ def reset(self):
         self.reset_timeout(reset_tout_s)
 
     def flush(self):
+        """ Flush serial ports
+        """
         self.serial.flushInput()
         self.serial.flushOutput()
         if self.extra_serial:
@@ -181,10 +193,15 @@ def flush(self):
 
 
 class Test:
+    """ Baseclass for host test's test runner
+    """
     def __init__(self):
         self.mbed = Mbed()
 
     def run(self):
+        """ Test runner for host test. This function will start executing
+            test and forward test result via serial port to test suite
+        """
         try:
             result = self.test()
             self.print_result("success" if result else "failure")
@@ -193,31 +210,40 @@ def run(self):
             self.print_result("error")
 
     def setup(self):
-        """ Setup and check if configuration for test is correct. E.g. if serial port can be opened """
+        """ Setup and check if configuration for test is correct. E.g. if serial port can be opened
+        """
         result = True
         if not self.mbed.serial:
             result = False
             self.print_result("ioerr_serial")
         return result
 
     def notify(self, message):
-        """ On screen notification function """
+        """ On screen notification function
+        """
         print message
         stdout.flush()
 
     def print_result(self, result):
-        """ Test result unified printing function """
+        """ Test result unified printing function
+        """
         self.notify("\n{%s}\n{end}" % result)
 
 
 class DefaultTest(Test):
+    """ Test class with serial port initialization
+    """
     def __init__(self):
         Test.__init__(self)
         serial_init_res = self.mbed.init_serial()
         self.mbed.reset()
 
 
 class Simple(DefaultTest):
+    """ Simple, basic host test's test runner waiting for serial port
+        output from MUT, no supervision over test running in MUT is executed.
+        Just waiting for result
+    """
     def run(self):
         try:
             while True:
@@ -230,5 +256,6 @@ def run(self):
         except KeyboardInterrupt, _:
             print "\n[CTRL+c] exit"
 
+
 if __name__ == '__main__':
     Simple().run()