gh-47 Add tests for localstorage module including new geolocation database functions

elodie/tests/helper.py

@@ -27,6 +27,9 @@ def get_file(name):
     current_folder = os.path.dirname(os.path.realpath(__file__))
     return '%s/files/%s' % (current_folder, name)
 
+def get_test_location():
+    return (61.013710, 99.196656, 'Siberia')
+
 def populate_folder(number_of_files):
     folder = '%s/%s' % (tempfile.gettempdir(), random_string(10))
     os.makedirs(folder)
@@ -42,5 +45,12 @@ def populate_folder(number_of_files):
 def random_string(length):
     return ''.join(random.SystemRandom().choice(string.ascii_uppercase + string.digits) for _ in range(length))
 
+def random_decimal():
+    return random.random()
+
+def random_coordinate(coordinate, precision):
+    # Here we add to the decimal section of the coordinate by a given precision
+    return coordinate + ((10.0 / (10.0**precision)) * random_decimal())
+
 def temp_dir():
     return tempfile.gettempdir()

elodie/tests/localstorage_test.py

@@ -0,0 +1,179 @@
+# Project imports
+import os
+import sys
+
+sys.path.insert(0, os.path.abspath(os.path.dirname(os.path.dirname(os.path.dirname(os.path.realpath(__file__))))))
+
+import helper
+from elodie.localstorage import Db
+from elodie import constants
+
+os.environ['TZ'] = 'GMT'
+
+def test_init_writes_files():
+    db = Db()
+
+    assert os.path.isfile(constants.hash_db) == True
+    assert os.path.isfile(constants.location_db) == True
+
+def test_add_hash_default_do_not_write():
+    db = Db()
+
+    random_key = helper.random_string(10)
+    random_value = helper.random_string(12)
+
+    # Test with default False value as 3rd param
+    db.add_hash(random_key, random_value)
+
+    assert db.check_hash(random_key) == True, 'Lookup for hash did not return True'
+
+    # Instnatiate new db class to confirm random_key does not exist
+    db2 = Db()
+    assert db2.check_hash(random_key) == False
+    
+def test_add_hash_explicit_do_not_write():
+    db = Db()
+
+    random_key = helper.random_string(10)
+    random_value = helper.random_string(12)
+
+    # Test with explicit False value as 3rd param
+    db.add_hash(random_key, random_value, False)
+
+    assert db.check_hash(random_key) == True, 'Lookup for hash did not return True'
+
+    # Instnatiate new db class to confirm random_key does not exist
+    db2 = Db()
+    assert db2.check_hash(random_key) == False
+    
+def test_add_hash_explicit_write():
+    db = Db()
+
+    random_key = helper.random_string(10)
+    random_value = helper.random_string(12)
+
+    # Test with explicit True value as 3rd param
+    db.add_hash(random_key, random_value, True)
+
+    assert db.check_hash(random_key) == True, 'Lookup for hash did not return True'
+
+    # Instnatiate new db class to confirm random_key exists
+    db2 = Db()
+    assert db2.check_hash(random_key) == True
+    
+def test_check_hash_exists():
+    db = Db()
+
+    random_key = helper.random_string(10)
+    random_value = helper.random_string(12)
+
+    # Test with explicit False value as 3rd param
+    db.add_hash(random_key, random_value, False)
+
+    assert db.check_hash(random_key) == True, 'Lookup for hash did not return True'
+    
+def test_check_hash_does_not_exist():
+    db = Db()
+
+    random_key = helper.random_string(10)
+
+    assert db.check_hash(random_key) == False, 'Lookup for hash that should not exist returned True'
+
+def test_get_hash_exists():
+    db = Db()
+
+    random_key = helper.random_string(10)
+    random_value = helper.random_string(12)
+
+    # Test with explicit False value as 3rd param
+    db.add_hash(random_key, random_value, False)
+
+    assert db.get_hash(random_key) == random_value, 'Lookup for hash that exists did not return value'
+    
+def test_get_hash_does_not_exist():
+    db = Db()
+
+    random_key = helper.random_string(10)
+
+    assert db.get_hash(random_key) is None, 'Lookup for hash that should not exist did not return None'
+
+def test_update_hash_db():
+    db = Db()
+
+    random_key = helper.random_string(10)
+    random_value = helper.random_string(12)
+
+    # Test with default False value as 3rd param
+    db.add_hash(random_key, random_value)
+
+    assert db.check_hash(random_key) == True, 'Lookup for hash did not return True'
+
+    # Instnatiate new db class to confirm random_key does not exist
+    db2 = Db()
+    assert db2.check_hash(random_key) == False
+
+    db.update_hash_db()
+
+    # Instnatiate new db class to confirm random_key exists
+    db3 = Db()
+    assert db3.check_hash(random_key) == True
+
+def test_checksum():
+    db = Db()
+
+    src = helper.get_file('plain.jpg')
+    checksum = db.checksum(src)
+
+    assert checksum == 'd5eb755569ddbc8a664712d2d7d6e0fa1ddfcdb378475e4a6758dc38d5ea9a16', 'Checksum for plain.jpg did not match'
+
+def test_add_location():
+    db = Db()
+
+    latitude, longitude, name = helper.get_test_location()
+
+    db.add_location(latitude, longitude, name)
+    retrieved_name = db.get_location_name(latitude, longitude, 5)
+
+    assert name == retrieved_name
+
+def test_get_location_name():
+    db = Db()
+
+    latitude, longitude, name = helper.get_test_location()
+    db.add_location(latitude, longitude, name)
+
+    
+    # 1 meter
+    retrieved_name = db.get_location_name(latitude, longitude, 1)
+
+    assert name == retrieved_name
+
+def test_get_location_name_within_threshold():
+    db = Db()
+
+    latitude, longitude, name = helper.get_test_location()
+    db.add_location(latitude, longitude, name)
+
+    print latitude
+    new_latitude = helper.random_coordinate(latitude, 4)
+    new_longitude = helper.random_coordinate(longitude, 4)
+    print new_latitude
+
+    # 10 miles
+    retrieved_name = db.get_location_name(new_latitude, new_longitude, 1600*10)
+
+    assert name == retrieved_name, 'Name (%r) did not match retrieved name (%r)' % (name, retrieved_name)
+
+def test_get_location_name_outside_threshold():
+    db = Db()
+
+    latitude, longitude, name = helper.get_test_location()
+    db.add_location(latitude, longitude, name)
+
+    new_latitude = helper.random_coordinate(latitude, 1)
+    new_longitude = helper.random_coordinate(longitude, 1)
+
+    # 800 meters
+    retrieved_name = db.get_location_name(new_latitude, new_longitude, 800)
+
+    assert retrieved_name is None