Merge lp:~chipaca/u1db/nonexistent_index_querying_is_frowned_upon into lp:u1db

[John Lenton]

get_from_index and get_index_keys now consistently die with "index does not exist" if the index does not exist.

[Eric Casteleijn (thisfred)]

looks good, tests pass

review: Approve

=== modified file 'include/u1db/u1db.h'
--- include/u1db/u1db.h	2012-05-20 15:50:51 +0000
+++ include/u1db/u1db.h	2012-05-21 15:08:18 +0000
@@ -66,6 +66,7 @@
 #define U1DB_MISSING_FIELD_SPECIFIER -15
 #define U1DB_INVALID_FIELD_SPECIFIER -16
 #define U1DB_DUPLICATE_INDEX_NAME -17
+#define U1DB_INDEX_DOES_NOT_EXIST -18
 #define U1DB_INTERNAL_ERROR -999
 
 // Used by put_doc_if_newer

=== modified file 'src/u1db_query.c'
--- src/u1db_query.c	2012-05-15 16:55:08 +0000
+++ src/u1db_query.c	2012-05-21 15:08:18 +0000
@@ -440,6 +440,9 @@
                                SQLITE_TRANSIENT);
     if (status != SQLITE_OK) { goto finish; }
     status = sqlite3_step(statement);
+    if (status == SQLITE_DONE) {
+        status = U1DB_INDEX_DOES_NOT_EXIST;
+    }
     while (status == SQLITE_ROW) {
         offset = sqlite3_column_int(statement, 0);
         field = (char*)sqlite3_column_text(statement, 1);
@@ -627,6 +630,9 @@
         goto finish;
     }
     status = sqlite3_step(statement);
+    if (status == SQLITE_DONE) {
+        status = U1DB_INDEX_DOES_NOT_EXIST;
+    }
     while (status == SQLITE_ROW) {
         key = (char*)sqlite3_column_text(statement, 0);
         if ((status = cb(context, key)) != U1DB_OK)

=== modified file 'u1db/backends/inmemory.py'
--- u1db/backends/inmemory.py	2012-05-20 15:50:51 +0000
+++ u1db/backends/inmemory.py	2012-05-21 15:08:18 +0000
@@ -189,7 +189,10 @@
         return definitions
 
     def get_from_index(self, index_name, key_values):
-        index = self._indexes[index_name]
+        try:
+            index = self._indexes[index_name]
+        except KeyError:
+            raise errors.IndexDoesNotExist
         doc_ids = index.lookup(key_values)
         result = []
         for doc_id in doc_ids:
@@ -198,7 +201,10 @@
         return result
 
     def get_index_keys(self, index_name):
-        index = self._indexes[index_name]
+        try:
+            index = self._indexes[index_name]
+        except KeyError:
+            raise errors.IndexDoesNotExist
         return list(set(index.keys()))
 
     def whats_changed(self, old_generation=0):

=== modified file 'u1db/backends/sqlite_backend.py'
--- u1db/backends/sqlite_backend.py	2012-05-20 15:50:51 +0000
+++ u1db/backends/sqlite_backend.py	2012-05-21 15:08:18 +0000
@@ -535,7 +535,11 @@
         c = self._db_handle.cursor()
         c.execute("SELECT field FROM index_definitions"
                   " WHERE name = ? ORDER BY offset", (index_name,))
-        return [x[0] for x in c.fetchall()]
+        fields = [x[0] for x in c.fetchall()]
+        if not fields:
+            raise errors.IndexDoesNotExist
+        return fields
+
 
     @staticmethod
     def _transform_glob(value, escape_char='.'):
@@ -617,6 +621,8 @@
             raise dbapi2.OperationalError(str(e) +
                 '\nstatement: %s\nargs: %s\n' % (SQL_INDEX_KEYS, (index,)))
         res = c.fetchall()
+        if not res:
+            raise errors.IndexDoesNotExist
         return [r[0] for r in res]
 
     def delete_index(self, index_name):

=== modified file 'u1db/errors.py'
--- u1db/errors.py	2012-05-20 00:50:57 +0000
+++ u1db/errors.py	2012-05-21 15:08:18 +0000
@@ -77,6 +77,10 @@
     """The index definition cannot be parsed."""
 
 
+class IndexDoesNotExist(U1DBError):
+    """No index of that name exists."""
+
+
 class Unauthorized(U1DBError):
     """Request wasn't authorized properly."""
 

=== modified file 'u1db/tests/c_backend_wrapper.pyx'
--- u1db/tests/c_backend_wrapper.pyx	2012-05-20 15:50:51 +0000
+++ u1db/tests/c_backend_wrapper.pyx	2012-05-21 15:08:18 +0000
@@ -118,6 +118,7 @@
     int U1DB_INVALID_VALUE_FOR_INDEX
     int U1DB_BROKEN_SYNC_STREAM
     int U1DB_DUPLICATE_INDEX_NAME
+    int U1DB_INDEX_DOES_NOT_EXIST
     int U1DB_INTERNAL_ERROR
 
     int U1DB_INSERTED
@@ -567,6 +568,8 @@
         raise errors.ConflictedDoc()
     if status == U1DB_DUPLICATE_INDEX_NAME:
         raise errors.IndexNameTakenError()
+    if status == U1DB_INDEX_DOES_NOT_EXIST:
+        raise errors.IndexDoesNotExist
     raise RuntimeError('%s (status: %s)' % (context, status))
 
 

=== modified file 'u1db/tests/test_backends.py'
--- u1db/tests/test_backends.py	2012-05-20 15:50:51 +0000
+++ u1db/tests/test_backends.py	2012-05-21 15:08:18 +0000
@@ -723,6 +723,16 @@
         self.assertEqual([doc],
             self.db.get_from_index('test-idx', [('value', 'value2')]))
 
+    def test_get_from_index_fails_if_no_index(self):
+        self.assertRaises(errors.IndexDoesNotExist,
+                          self.db.get_from_index,
+                          'foo', [])
+
+    def test_get_index_keys_fails_if_no_index(self):
+        self.assertRaises(errors.IndexDoesNotExist,
+                          self.db.get_index_keys,
+                          'foo')
+
     def test_put_updates_index(self):
         doc = self.db.create_doc(simple_doc)
         self.db.create_index('test-idx', ['key'])