start implementing native API

2 files changed, 162 insertions, 11 deletions

diff --git a/tests/native_api_v1.txt b/tests/native_api_v1.txt
new file mode 100644
index 0000000..5df64d8
--- /dev/null
+++ b/tests/native_api_v1.txt
@@ -0,0 +1,143 @@
+>>> import os
+>>> import tempfile
+>>> import time
+
+Define some helper functions
+>>> def test_unique(items):
+...     return not [True for e in items if items.count(e) > 1]
+>>> def to_native(value):
+...     if isinstance(value, list):
+...         return [to_native(e) for e in value]
+...     elif isinstance(value, dict):
+...         return dict([(to_native(k), to_native(v)) for k, v in value.items()])
+...     elif isinstance(value, unicode):
+...         return unicode(value)
+...     elif isinstance(value, str):
+...         return str(value)
+...     return value
+>>> def create_temp_file(content):
+...    fd, file_name = tempfile.mkstemp()
+...    f = os.fdopen(fd, 'w')
+...    f.write(content)
+...    f.close()
+...    return file_name
+
+
+Connect to data store using DBus:
+>>> import dbus
+>>> DS_DBUS_SERVICE = 'org.silbe.GDataStore'
+>>> DS_DBUS_INTERFACE = 'org.silbe.GDataStore1'
+>>> DS_DBUS_PATH = '/org/silbe/GDataStore1'
+>>> bus = dbus.SessionBus()
+>>> ds = dbus.Interface(bus.get_object(DS_DBUS_SERVICE, DS_DBUS_PATH), DS_DBUS_INTERFACE)
+
+
+Make sure we're starting from an empty datastore:
+>>> assert ds.find({}, {}) == ([], 0)
+
+
+Create something to play with:
+>>> o1_oid = ds.create({'title': 'DS test object 1', 'mime_type': 'text/plain', 'activity': 'org.sugarlabs.DataStoreTest1'}, '')
+>>> assert isinstance(o1_oid, tuple) and len(o1_oid) == 2 and isinstance(o1_oid[0], basestring) and isinstance(o1_oid[1], basestring)
+>>> o2_oid = ds.create({'title': 'DS test object 2', 'mime_type': 'text/plain', 'activity': 'org.sugarlabs.DataStoreTest2'}, '')
+>>> assert isinstance(o2_oid, tuple) and len(o2_oid) == 2 and isinstance(o2_oid[0], basestring) and isinstance(o2_oid[1], basestring)
+>>> o3_oid = ds.create({'title': 'DS test object 3', 'mime_type': 'text/plain', 'activity': 'org.sugarlabs.DataStoreTest2'}, '')
+>>> assert isinstance(o3_oid, tuple) and len(o3_oid) == 2 and isinstance(o3_oid[0], basestring) and isinstance(o3_oid[1], basestring)
+>>> assert test_unique([o1_oid, o2_oid, o3_oid])
+
+
+Check everything is there:
+>>> assert sorted(to_native(ds.find({}, {'metadata': ['title', 'activity']}, byte_arrays=True)[0])) == \
+... [{u'title': 'DS test object 1', u'activity': 'org.sugarlabs.DataStoreTest1'},
+...  {u'title': 'DS test object 2', u'activity': 'org.sugarlabs.DataStoreTest2'},
+...  {u'title': 'DS test object 3', u'activity': 'org.sugarlabs.DataStoreTest2'}]
+>>> ds.get_data_path(*o1_oid, byte_arrays=True)
+dbus.String(u'')
+>>> ds.get_data_path(*o2_oid, byte_arrays=True)
+dbus.String(u'')
+>>> ds.get_data_path(*o3_oid, byte_arrays=True)
+dbus.String(u'')
+
+
+Change some metadata without creating a new version:
+>>> ds.change_metadata(o1_oid[0], o1_oid[1], {'title': 'DS test object 1 updated', 'mime_type': 'text/plain', 'activity': 'org.sugarlabs.DataStoreTest1', 'tags': 'foo'})
+>>> ds.change_metadata(o2_oid[0], o2_oid[1], {'title': 'DS test object 2', 'mime_type': 'text/plain', 'activity': 'org.sugarlabs.DataStoreTest1', 'tags': 'bar baz'})
+>>> ds.change_metadata(o3_oid[0], o3_oid[1], {'title': 'DS test object 2', 'mime_type': 'text/html', 'activity': 'org.sugarlabs.DataStoreTest3', 'timestamp': 10000})
+>>> assert sorted(to_native(ds.find({}, {'metadata': ['title', 'activity']}, byte_arrays=True)[0])) == \
+... [{u'activity': 'org.sugarlabs.DataStoreTest1', u'title': 'DS test object 1 updated'},
+...  {u'activity': 'org.sugarlabs.DataStoreTest1', u'title': 'DS test object 2'},
+...  {u'activity': 'org.sugarlabs.DataStoreTest3', u'title': 'DS test object 2'}]
+>>> unicode(ds.get_metadata(*o1_oid)['title'])
+u'DS test object 1 updated'
+
+
+Retrieve metadata for a single entry, ignoring variable data:
+>>> d=dict(ds.get_metadata(*o3_oid, byte_arrays=True))
+>>> del d['tree_id'], d['version_id'], d['timestamp'], d['creation_time']
+>>> assert to_native(d) == {u'title': 'DS test object 2', u'mime_type': 'text/html', u'activity': 'org.sugarlabs.DataStoreTest3'}
+
+
+Find entries using "standard" metadata:
+>>> assert sorted(to_native(ds.find({'mime_type': ['text/plain']}, {'metadata': ['title', 'activity', 'mime_type', 'tags']}, byte_arrays=True)[0])) == \
+... [{u'title': 'DS test object 2', u'activity': 'org.sugarlabs.DataStoreTest1', u'mime_type': 'text/plain', u'tags': 'bar baz'},
+...  {u'title': 'DS test object 1 updated', u'activity': 'org.sugarlabs.DataStoreTest1', u'mime_type': 'text/plain', u'tags': 'foo'}]
+>>> assert sorted(to_native(ds.find({'mime_type': ['text/html']}, {'metadata': ['title', 'activity', 'mime_type', 'tags']}, byte_arrays=True)[0])) == \
+... [{u'title': 'DS test object 2', u'mime_type': 'text/html', u'activity': 'org.sugarlabs.DataStoreTest3'}]
+>>> assert sorted(to_native(ds.find({'tree_id': o3_oid[0]}, {'metadata': ['title', 'activity', 'mime_type']}, byte_arrays=True)[0])) == \
+... [{u'title': 'DS test object 2', u'mime_type': 'text/html', u'activity': 'org.sugarlabs.DataStoreTest3'}]
+>>> assert sorted(to_native(ds.find({'timestamp': (9000, 11000)}, {'metadata': ['title', 'activity', 'mime_type']}, byte_arrays=True)[0])) == \
+... [{u'title': 'DS test object 2', u'mime_type': 'text/html', u'activity': 'org.sugarlabs.DataStoreTest3'}]
+
+Find entries using "non-standard" metadata (only works with dict-based queries or prefixed Xapian query strings):
+>>> assert sorted(to_native(ds.find({'title': 'DS test object 2'}, {'metadata': ['title', 'activity', 'mime_type', 'tags']}, byte_arrays=True)[0])) == \
+... [{u'title': 'DS test object 2', u'mime_type': 'text/html', u'activity': 'org.sugarlabs.DataStoreTest3'},
+...  {u'title': 'DS test object 2', u'activity': 'org.sugarlabs.DataStoreTest1', u'mime_type': 'text/plain', u'tags': 'bar baz'}]
+
+
+You can specify a (primary) sort order. Please note that the secondary sort order is undefined / implementation-dependent.
+>>> assert to_native(ds.find({}, {'metadata': ['title', 'activity'], 'order_by': ['+title']}, byte_arrays=True)[0]) == \
+... [{u'activity': 'org.sugarlabs.DataStoreTest3', u'title': 'DS test object 2'},
+...  {u'activity': 'org.sugarlabs.DataStoreTest1', u'title': 'DS test object 2'},
+...  {u'activity': 'org.sugarlabs.DataStoreTest1', u'title': 'DS test object 1 updated'}]
+>>> assert to_native(ds.find({}, {'metadata': ['title', 'activity'], 'order_by': ['-title']}, byte_arrays=True)[0]) == \
+... [{u'activity': 'org.sugarlabs.DataStoreTest1', u'title': 'DS test object 1 updated'},
+...  {u'activity': 'org.sugarlabs.DataStoreTest1', u'title': 'DS test object 2'},
+...  {u'activity': 'org.sugarlabs.DataStoreTest3', u'title': 'DS test object 2'}]
+
+
+Delete an entry:
+>>> ds.delete(*o1_oid)
+>>> assert sorted(to_native(ds.find({}, {'metadata': ['title', 'activity']}, byte_arrays=True)[0])) == \
+... [{u'title': 'DS test object 2', u'activity': 'org.sugarlabs.DataStoreTest1'},
+...  {u'title': 'DS test object 2', u'activity': 'org.sugarlabs.DataStoreTest3'}]
+
+
+Create an entry with content:
+>>> dog_content = 'The quick brown dog jumped over the lazy fox.'
+>>> dog_props = {'title': 'dog/fox story', 'mime_type': 'text/plain'}
+>>> dog_file_name = create_temp_file(dog_content)
+>>> dog_oid = ds.create(dog_props, dog_file_name)
+
+
+Retrieve and verify the entry with content:
+>>> dog_retrieved = ds.get_data_path(*dog_oid)
+>>> assert(file(dog_retrieved).read() == dog_content)
+>>> os.remove(dog_retrieved)
+
+
+Update the entry content (creates a new version):
+>>> dog_content_2 = 'The quick brown fox jumped over the lazy dog.'
+>>> dog_file_name = create_temp_file(dog_content_2)
+>>> dog_updated_version_id = ds.add_version(dog_oid[0], dog_oid[1], dog_props, dog_file_name)
+
+
+Verify updated content:
+>>> dog_retrieved = ds.get_data_path(dog_oid[0], dog_updated_version_id)
+>>> assert(file(dog_retrieved).read() == dog_content_2)
+>>> os.remove(dog_retrieved)
+
+
+Verify old content is still accessible:
+>>> dog_retrieved = ds.get_data_path(*dog_oid)
+>>> assert(file(dog_retrieved).read() == dog_content)
+>>> os.remove(dog_retrieved)
diff --git a/tests/runalltests.py b/tests/runalltests.py
index 26df032..1ed42c9 100755
--- a/tests/runalltests.py
+++ b/tests/runalltests.py
@@ -32,6 +32,7 @@ logging.basicConfig(level=logging.WARN,
 
 
 DOCTESTS = [
+    'native_api_v1.txt',
     'sugar_api_v2.txt',
 ]
 DOCTEST_OPTIONS = (doctest.ELLIPSIS | doctest.REPORT_ONLY_FIRST_FAILURE |
@@ -47,6 +48,18 @@ ENVIRONMENT_WHITELIST = [
     'GDATASTORE_LOGLEVEL',
 ]
 
+
+def write_service_file(service_dir, executable, bus_name):
+    service_path = os.path.join(service_dir, bus_name + '.service')
+    service_file = file(service_path, 'w')
+    service_file.write("""
+        [D-BUS Service]
+        Name = %s
+        Exec = %s
+        """.replace('        ', '') % (bus_name, executable))
+    service_file.close()
+
+
 def setup():
     """Prepare for testing and return environment.
 
@@ -69,19 +82,14 @@ def setup():
     python_path = [basedir] + python_path
     environment['PYTHONPATH'] = ':'.join(python_path)
     environment['PATH'] = os.path.join(basedir, 'bin')+':'+os.environ['PATH']
-
-    servicedir = os.path.join(environment['HOME'], 'dbus-1', 'services')
-    servicepath = os.path.join(servicedir, 'org.laptop.sugar.DataStore.service')
-    os.makedirs(servicedir)
-    servicefile = file(servicepath, 'w')
-    servicefile.write("""
-        [D-BUS Service]
-        Name = org.laptop.sugar.DataStore
-        Exec = %s/bin/gdatastore-service
-        """.replace('        ', '') % (basedir, ))
-    servicefile.close()
     environment['XDG_DATA_DIRS'] = environment['HOME']
 
+    service_dir = os.path.join(environment['HOME'], 'dbus-1', 'services')
+    os.makedirs(service_dir)
+    executable = os.path.join(basedir, 'bin', 'gdatastore-service')
+    write_service_file(service_dir, executable, 'org.laptop.sugar.DataStore')
+    write_service_file(service_dir, executable, 'org.silbe.GDataStore')
+
     os.setpgid(0, 0)
     # prevent suicide in cleanup()
     signal.signal(signal.SIGTERM, signal.SIG_IGN)