Changeset 17c79627d5d4c95f2428c5e361f8f06b64257983

Timestamp:

05/31/10 10:20:30 (2 years ago)

Author:

Frederic Lepied <frederic.lepied@…>

Children:

9462a1ee61cb7c69c57720d39360f2d0765578a5

Parents:

7c3da85ea3081cd215b42b3ed64f951232d808ec

git-committer:

Frederic Lepied <frederic.lepied@…> (05/31/10 10:20:30)

Message:

added docstrings and a few unit tests

Files:

• pxe/common.py (modified) (11 diffs)

pxe/common.py

@@ -5 +5 @@
 # Author          : Frederic Lepied
 # Created On      : Sun Feb  1 19:03:58 2009
-# Purpose         : common functions used by scripts and web logic.
 #---------------------------------------------------------------
+
+"""Common functions used by scripts and web logic."""
 
 import sys
@@ -12 +13 @@
 import re
 import settings
-from models import *
+from pxe.models import *
 
-MAC_REGEXP = re.compile('^.*\s([0-9a-f:]+)\s.*', re.I)
-IP_REGEXP = re.compile('^([0-9.]+).*\s[0-9a-f:]+\s.*', re.I)
+_MAC_REGEXP = re.compile('^.*\s([0-9a-f:]+)\s.*', re.I)
+_IP_REGEXP = re.compile('^([0-9.]+).*\s[0-9a-f:]+\s.*', re.I)
 
 def ip_to_mac(ip):
+    """Lookup a MAC address from an IPV4 address on a live Linux system."""
     for line in open('/proc/net/arp').readlines():
         if line.find(ip) != -1:
-            res = MAC_REGEXP.search(line)
+            res = _MAC_REGEXP.search(line)
             if res:
                 return res.group(1)
@@ -26 +28 @@
 
 def mac_to_ip(mac):
+    """Lookup an IPV4 address from a MAC address on a live Linux system."""
     mac = mac.upper()
     for line in open('/proc/net/arp').readlines():
         if line.find(mac) != -1:
-            res = IP_REGEXP.search(line)
+            res = _IP_REGEXP.search(line)
             if res:
                 return res.group(1)
@@ -35 +38 @@
 
 def get_mac(request):
+    """Returns a MAC address corresponding to the IPV4 address of the remote host of the request."""
     mac = ip_to_mac(request.META['REMOTE_ADDR'])
     if not mac:
@@ -42 +46 @@
     
 def error(str):
+    """Print an error and exit with a return code of 1."""
     sys.stderr.write(str + '\n')
     sys.exit(1)
 
 def simplify_mac(s):
-    '''Remove : or - between hexa numbers for a MAC address. Always return the address in lowercase'''
+    """Remove : or - between hexa numbers for a MAC address. Always returns the address in lowercase"""
     ss = s.replace('-', '')
     sss = ss.replace(':', '')
@@ -55 +60 @@
 
 def mac2filename(m):
+    """Returns a filename using the naming convention used by PXE: 01-<mac address separated by - >."""
     s = '01-'
     for i in range(0, 10, 2):
@@ -62 +68 @@
 
 def mac2path(mac):
+    """Returns the path of the MAC or IPV4 mask in the file system."""
     if len(mac) == 12:
         return '%s/%s' % (settings.PXE_ROOT, mac2filename(mac))
@@ -68 +75 @@
     
 def create_symlink(src, dst):
+    """Creates a symlink removing the destination if it exists before."""
     if os.path.exists(dst):
         os.unlink(dst)
@@ -73 +81 @@
     
 def set_next_boot(system, name, abort=True):
+    """Sets next boot symlinks in the PXE and stores the value in the database."""
     try:
         boot_name = BootName.objects.get(name=name)
@@ -96 +105 @@
 
 def simplify_ip(ip):
-    '''Rertun a string containing the hexadecimal representation of an ipv4 address or a sub-part.'''
+    """Returns a string containing the hexadecimal representation of an IPV4 address or a sub-part."""
     l = ip.split('.')
     s = ''
@@ -103 +112 @@
     return s
 
+if __name__ == "__main__":
+    import unittest
+    
+    class commonTest(unittest.TestCase):
+    
+        def test1(self):
+            """simplify_ip test."""
+            return self.assertEqual(simplify_ip('10.34'), '0A22')
+
+        def test2(self):
+            """mac2filename test."""
+            return self.assertEqual(mac2filename('001b38710ab6'), '01-00-1b-38-71-0a-b6')
+
+        def test3(self):
+            """simplify_mac test."""
+            return self.assertEqual(simplify_mac('00:1b:38:71:0a:b6'), '001b38710ab6')
+
+        def test4(self):
+            """simplify_mac test."""
+            return self.assertRaises(ValueError, lambda: simplify_mac('00:1b:38:71:0a'))
+
+    unittest.main()
+
 # common.py ends here