Merge lp:~teknico/desktopcouch/more-varied-random-contacts into lp:desktopcouch

[Nicola Larosa]

Improve the randomization of automatically generated contacts, creating a greater variety of combinations of absent and present data, useful for testing.

[Nicola Larosa (teknico)]

This branch improves the randomization of automatically generated contacts, creating a greater variety of combinations of absent and present data, useful for testing.

[Eric Casteleijn (thisfred)]

Looks good!

review: Approve

[dobey (dobey)]

review: Approve

[lp:~teknico/desktopcouch/more-varied-random-contacts]

47. By Nicola Larosa on 2009-09-07

Merge from trunk

48. By Nicola Larosa on 2009-09-07

Added some tests.

=== modified file 'desktopcouch/contacts/testing/create.py'
--- desktopcouch/contacts/testing/create.py	2009-08-19 10:07:54 +0000
+++ desktopcouch/contacts/testing/create.py	2009-09-04 08:59:18 +0000
@@ -30,25 +30,55 @@
     'Daniel', 'William', 'James', 'Alfie', 'Grace', 'Ruby', 'Olivia',
     'Emily', 'Jessica', 'Sophie', 'Chloe', 'Lily', 'Ella', 'Amelia')
 LAST_NAMES = ('Dalglish', 'Grobbelaar', 'Lawrenson', 'Beglin', 'Nicol',
-    'Whelan', 'Hansen', 'Johnston', 'Rush', 'Molby', 'MacDonald', 'McMahon')
+    'Whelan', 'Hansen', 'Johnston', 'Rush', 'Molby', 'MacDonald', 'McMahon',
+    'Penny', 'Leicester', 'Langley', 'Commodore', 'Touchstone', 'Fielding')
+COMPANIES = ('Gostram', 'Grulthing', 'Nasform', 'Smarfish', 'Builsank')
+STREET_TYPES = ('Street', 'Road', 'Lane', 'Avenue', 'Square', 'Park', 'Mall')
 CITIES = ('Scunthorpe', 'Birmingham', 'Cambridge', 'Durham', 'Bedford')
 COUNTRIES = ('England', 'Ireland', 'Scotland', 'Wales')
 
-def random_string(length=10):
-    """Return a string of random lowercase letters and of specified length"""
-    return ''.join(random.sample(string.lowercase, length))
+def head_or_tails():
+    """Randomly return True or False"""
+    return random.choice((False, True))
+
+def random_bools(num_bools, at_least_one_true=True):
+    """
+    Return a sequence of random booleans. If at_least_one_true,
+    guarantee at list one True value.
+    """
+    if num_bools < 2:
+        raise RuntimeError('Cannot build a sequence smaller than two elements')
+    bools = [head_or_tails() for __ in range(num_bools)]
+    if at_least_one_true and not any(bools):
+        bools[random.randrange(num_bools)] = True
+    return bools
+
+def random_string(length=10, upper=False):
+    """
+    Return a string, of specified length, of random lower or uppercase letters.
+    """
+    charset = string.uppercase if upper else string.lowercase
+    return ''.join(random.sample(charset, length))
 
 def random_postal_address():
     """Return something that looks like a postal address"""
-    return '%s Street' % random.choice(LAST_NAMES)
+    return '%d %s %s' % (random.randint(1, 100), random.choice(LAST_NAMES),
+        random.choice(STREET_TYPES))
 
-def random_email_address(first_name, last_name):
-    """Return something that looks like an email address"""
-    return '%s.%s@%s.com' % (first_name, last_name, random_string(3))
+def random_email_address(
+        first_name='', last_name='', company='', address_type='other'):
+    """
+    Return something that looks like an email address.
+    address_type values: 'personal', 'work', 'other'.
+    """
+    # avoid including the dot if one or both names are missing
+    pers_name = '.'.join([name for name in (first_name, last_name) if name])
+    return {'personal': pers_name, 'work': company,
+        }.get(address_type, random_string(5)) + '@example.com'
 
 def random_postal_code():
     """Return something that looks like a postal code"""
-    return '%s12 3%s' % (random_string(2), random_string(2))
+    return '%s12 3%s' % (random_string(2, True), random_string(2, True))
 
 def random_phone_number():
     """Return something that looks like a phone number"""
@@ -65,11 +95,39 @@
     # Record schema
     fielddict = {'record_type': doctype, 'record_type_version': '1.0'}
     # Names
-    first_name = random.choice(FIRST_NAMES) + str(maincount)
-    last_name = random.choice(LAST_NAMES)
+    # at least one of the three will be present
+    has_first_name, has_last_name, has_company_name = random_bools(3)
+    first_name = (random.choice(FIRST_NAMES) + str(maincount)
+        ) if has_first_name else ''
+    last_name = random.choice(LAST_NAMES) if has_last_name else ''
+    company = (random.choice(COMPANIES) + str(maincount)
+        ) if has_company_name else ''
+    # Address places and types
+    address_places, email_types, phone_places = [], [], []
+    if has_first_name or has_last_name:
+        for (has_it, seq, val) in zip(
+                # at least one of the three will be present
+                random_bools(3),
+                (address_places, email_types, phone_places),
+                ('home', 'personal', 'home')):
+            if has_it:
+                seq.append(val)
+    if has_company_name:
+        for (has_it, seq) in zip(
+                # at least one of the three will be present
+                random_bools(3),
+                (address_places, email_types, phone_places)):
+            if has_it:
+                seq.append('work')
+    for (has_it, seq) in zip(
+            # none of the three may be present
+            random_bools(3, at_least_one_true=False),
+            (address_places, email_types, phone_places)):
+        if has_it:
+            seq.append('other')
     # Addresses
     addresses = {}
-    for address_type in ('home', 'work', 'other'):
+    for address_type in address_places:
         addresses[str(uuid.uuid4())] = {
             'address1': random_postal_address(), 'address2': '',
             'pobox': '', 'city': random.choice(CITIES),
@@ -77,20 +135,23 @@
             'country': random.choice(COUNTRIES), 'description': address_type}
     # Email addresses
     email_addresses = {}
-    for email_address_type in ('home', 'work', 'other'):
+    for email_address_type in email_types:
         email_addresses[str(uuid.uuid4())] = {
-            'address': random_email_address(first_name, last_name),
+            'address': random_email_address(
+                first_name, last_name, company, email_address_type),
             'description': email_address_type}
     # Phone numbers
     phone_numbers = {}
-    for phone_number_type in ('home', 'work', 'other'):
+    for phone_number_type in phone_places:
         phone_numbers[str(uuid.uuid4())] = {
             'priority': 0, 'number': random_phone_number(),
             'description': phone_number_type}
     # Store data in fielddict
+    if (has_first_name or has_last_name) and head_or_tails():
+        fielddict['birth_date'] = random_birth_date()
     fielddict.update({'first_name': first_name, 'last_name': last_name,
         'addresses': addresses, 'email_addresses': email_addresses,
-        'phone_numbers': phone_numbers, 'birth_date': random_birth_date()})
+        'phone_numbers': phone_numbers, 'company': company})
     # Possibly add example application annotations
     if app_annots:
         fielddict['application_annotations'] = app_annots