Merge pull request noironetworks#285 from noironetworks/bad_desc

Add the sanitize_description() helper function

Author: tbachman

aim/tests/unit/test_utils.py

@@ -38,6 +38,14 @@ def test_sanitize_display_name(self):
             'some' * 14 + 'som',
             utils.sanitize_display_name('some' * 15))
 
+    def test_sanitize_description(self):
+        self.assertEqual(
+            '_eF5\\!#$%()*,-./:;@ _{|}~?&+_',
+            utils.sanitize_description('\'eF5\\!#$%()*,-./:;@ _{|}~?&+\"'))
+        self.assertEqual(
+            'somed' * 24 + 'some',
+            utils.sanitize_description('somed' * 25))
+
     def test_get_backoff_time_with_big_tentative(self):
         tentative = 10240
         tentative = internal_utils.get_backoff_time(600, tentative)

aim/utils.py

@@ -18,3 +18,8 @@
 
 def sanitize_display_name(display_name):
     return re.sub(r'[^a-zA-Z0-9_.-]', '_', display_name[:59])
+
+
+def sanitize_description(description):
+    return re.sub(r'[^a-zA-Z0-9\\!#$%()*,-./:;@ _{|}~?&+]',
+                  '_', description[:124])