Merge lp:~joetalbott/utah/add_product_uuid into lp:utah

[Joe Talbott]

Add product_uuid for machine under test to the result packet.

[Javier Collado (javier.collado)]

To read files I like to use a context manager to guarantee that the file is closed:

with open(filename) as f:
    product_uuid = f.read().strip()

Besides this, I'm not sure about the expected UUID format, but maybe using a regular
expression is a good idea.

Finally, when is the IOError expected to happen? If it's related to permissions,
then checking the permissions before opening the file might be clearer and explicit.

[lp:~joetalbott/utah/add_product_uuid]

723. By Joe Talbott on 2012-10-25

Check for read access of product_uuid file rather than try/except

* use 'with' wrapper for file reads
* note that some methods are best-effort.

724. By Joe Talbott on 2012-10-25

tests - Add test for get_product_uuid().

[Joe Talbott (joetalbott)]

Updated to address Javier's issues.

I don't think we need to worry about the contents of /sys/class/dmi/id/product_uuid. We do a best-effort attempt to read the file and return whatever is there.

review: Needs Resubmitting

[Javier Collado (javier.collado)]

Thanks for the update. Looks good to me now.

review: Approve

=== modified file 'utah/client/common.py'
--- utah/client/common.py	2012-10-22 08:15:08 +0000
+++ utah/client/common.py	2012-10-25 19:42:18 +0000
@@ -299,18 +299,43 @@
 def get_media_info():
     """
     Get the contents of the media-info file if available.
+
+    NOTE: This is only a best-effort approach.
+
+    Returns the contents of the media-info file or None.
     """
 
     filename = '/var/log/installer/media-info'
 
     media_info = None
 
-    if os.path.exists(filename):
-        media_info = open(filename, 'r').read()
+    if os.path.exists(filename) and os.access(filename, os.R_OK):
+        with open(filename, 'r') as f:
+            media_info = f.read()
 
     return media_info
 
 
+def get_product_uuid():
+    """
+    Get the product_uuid of the machine under test.
+
+    NOTE: This is only a best-effort approach.
+
+    Returns the contents of the product_uuid file or None.
+    """
+
+    filename = '/sys/class/dmi/id/product_uuid'
+
+    product_uuid = None
+
+    if os.path.exists(filename) and os.access(filename, os.R_OK):
+        with open(filename) as f:
+            product_uuid = f.read().strip()
+
+    return product_uuid
+
+
 def get_host_info():
     """
     Get host info, useful for debugging.
@@ -321,6 +346,8 @@
     retval['uname'] = platform.uname()
     retval['media-info'] = get_media_info()
 
+    retval['product_uuid'] = get_product_uuid()
+
     return retval
 
 
 
=== modified file 'utah/client/tests/test_common.py'
--- utah/client/tests/test_common.py	2012-09-27 13:55:41 +0000
+++ utah/client/tests/test_common.py	2012-10-25 19:42:18 +0000
@@ -4,6 +4,7 @@
 # REQUIRES that the top level utah package be in the Python path.
 from utah.client.common import (
         get_media_info,
+        get_product_uuid,
         get_host_info,
         run_cmd,
         debug_print,
@@ -15,6 +16,15 @@
     """
     Tests for utah.client.common.
     """
+
+    def test_get_product_uuid(self):
+        """ Test that product_uuid is returned when possible. """
+
+        product_uuid = get_product_uuid()
+
+        if os.access('/sys/class/dmi/id/product_uuid', os.R_OK):
+            self.assertIsNotNone(product_uuid)
+
     def test_get_media_info(self):
         """
         Test that if there is a media-info file that it is parsed.