Merge lp:~chipaca/u1db/para-nessita-que-lo-mira-por-TV___u1db-client_get-index-keys into lp:u1db

[John Lenton]

Adds get-index-keys to u1db-client.

Adds get-index-keys to u1db-client

[Samuele Pedroni (pedronis)]

+1

review: Approve

[John A Meinel (jameinel)]

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

On 5/21/2012 7:38 PM, John Lenton wrote:
> John Lenton has proposed merging
> lp:~chipaca/u1db/para-nessita-que-lo-mira-por-TV___u1db-client_get-index-keys
> into lp:u1db.
>
> Requested reviews: Ubuntu One hackers (ubuntuone-hackers) Related
> bugs: Bug #1000720 in U1DB: "u1db-client should have support for
> managing indexes" https://bugs.launchpad.net/u1db/+bug/1000720
>
> For more details, see:
> https://code.launchpad.net/~chipaca/u1db/para-nessita-que-lo-mira-por-TV___u1db-client_get-index-keys/+merge/106676
>
> Adds get-index-keys to u1db-client

 merge: approve
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.9 (Cygwin)
Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org/

iEYEARECAAYFAk+7XEkACgkQJdeBCYSNAAM/8ACfeAxKEFWYGmdM3UQtSIDjccj2
HKMAn0ynJaz/ayGrQEqJKTKclzuqK7O2
=+LEw
-----END PGP SIGNATURE-----

review: Approve

[dobey (dobey)]

17:01:58 E: Merging lp:~chipaca/u1db/para-nessita-que-lo-mira-por-TV___u1db-client_get-index-keys into lp:u1db would be pointless.

=== modified file 'u1db/commandline/client.py'
--- u1db/commandline/client.py	2012-05-21 09:02:54 +0000
+++ u1db/commandline/client.py	2012-05-21 17:48:19 +0000
@@ -295,9 +295,36 @@
             return 1
         db.delete_index(index)
 
-
 client_commands.register(CmdDeleteIndex)
 
 
+class CmdGetIndexKeys(OneDbCmd):
+    """Get the index's keys"""
+
+    name = "get-index-keys"
+
+    @classmethod
+    def _populate_subparser(cls, parser):
+        parser.add_argument('database', help='The local database to query',
+                            metavar='database-path')
+        parser.add_argument('index', help='the name of the index')
+
+    def run(self, database, index):
+        try:
+            db = self._open(database, create=False)
+            for i in db.get_index_keys(index):
+                self.stdout.write("%s\n" % (i,))
+        except errors.DatabaseDoesNotExist:
+            self.stderr.write("Database does not exist.\n")
+        except errors.IndexDoesNotExist:
+            self.stderr.write("Index does not exist.\n")
+        else:
+            return
+        return 1
+
+
+client_commands.register(CmdGetIndexKeys)
+
+
 def main(args):
     return client_commands.run_argv(args, sys.stdin, sys.stdout, sys.stderr)

=== modified file 'u1db/tests/commandline/test_client.py'
--- u1db/tests/commandline/test_client.py	2012-05-21 08:50:47 +0000
+++ u1db/tests/commandline/test_client.py	2012-05-21 17:48:19 +0000
@@ -139,6 +139,12 @@
         self.assertEqual('db', args.database)
         self.assertEqual('index', args.index)
 
+    def test_get_index_keys(self):
+        args = self.parse_args(['get-index-keys', 'db', 'index'])
+        self.assertEqual(client.CmdGetIndexKeys, args.subcommand)
+        self.assertEqual('db', args.database)
+        self.assertEqual('index', args.index)
+
 
 class TestCaseWithDB(tests.TestCase):
     """These next tests are meant to have one class per Command.
@@ -432,6 +438,40 @@
         self.assertEqual(cmd.stderr.getvalue(), '')
 
 
+class TestCmdGetIndexKeys(TestCaseWithDB):
+
+    def test_get_index_keys(self):
+        self.db.create_index("foo", ["bar"])
+        self.db.create_doc('{"bar": 42}')
+        cmd = self.make_command(client.CmdGetIndexKeys)
+        retval = cmd.run(self.db_path, "foo")
+        self.assertEqual(retval, None)
+        self.assertEqual(cmd.stdout.getvalue(), '42\n')
+        self.assertEqual(cmd.stderr.getvalue(), '')
+
+    def test_get_index_keys_empty(self):
+        self.db.create_index("foo", ["bar"])
+        cmd = self.make_command(client.CmdGetIndexKeys)
+        retval = cmd.run(self.db_path, "foo")
+        self.assertEqual(retval, None)
+        self.assertEqual(cmd.stdout.getvalue(), '')
+        self.assertEqual(cmd.stderr.getvalue(), '')
+
+    def test_get_index_keys_no_db(self):
+        cmd = self.make_command(client.CmdGetIndexKeys)
+        retval = cmd.run(self.db_path + "__DOES_NOT_EXIST", "foo")
+        self.assertEqual(retval, 1)
+        self.assertEqual(cmd.stdout.getvalue(), '')
+        self.assertEqual(cmd.stderr.getvalue(), 'Database does not exist.\n')
+
+    def test_get_index_keys_no_index(self):
+        cmd = self.make_command(client.CmdGetIndexKeys)
+        retval = cmd.run(self.db_path, "foo")
+        self.assertEqual(retval, 1)
+        self.assertEqual(cmd.stdout.getvalue(), '')
+        self.assertEqual(cmd.stderr.getvalue(), 'Index does not exist.\n')
+
+
 class RunMainHelper(object):
 
     def run_main(self, args, stdin=None):