Merge lp:~jameinel/u1db/win32-tweaks into lp:u1db

[John A Meinel]

I logged into Windows and ran the test suite.

The tests generally seem to pass, but test suite cleanup fails because the sqlite file handle is still open. In general, trusting Python's gc to close file handles is pretty weak (which is why they invented context managers).

I think having an "I'm done with this Database object, please release its resources" is a reasonable thing to have.

The test suite now passes cleanly on Windows.

[lp:~jameinel/u1db/win32-tweaks]

108. By John A Meinel on 2011-11-14

Don't nuke InMemoryDatabase.

We might call .close() from a commandline client, but we don't want to nuke the
data for the test case.

[Samuele Pedroni (pedronis)]

+1

review: Approve

=== modified file 'u1db/__init__.py'
--- u1db/__init__.py	2011-11-03 14:29:22 +0000
+++ u1db/__init__.py	2011-11-14 15:01:26 +0000
@@ -245,6 +245,10 @@
         """
         raise NotImplementedError(self.get_sync_generation)
 
+    def close(self):
+        """Release any resources associated with this database."""
+        raise NotImplementedError(self.close)
+
 
 class SyncTarget(object):
     """Functionality for using a Database as a synchronization target."""

=== modified file 'u1db/backends/inmemory.py'
--- u1db/backends/inmemory.py	2011-11-01 18:26:07 +0000
+++ u1db/backends/inmemory.py	2011-11-14 15:01:26 +0000
@@ -33,6 +33,11 @@
         self._replica_uid = replica_uid
         self._last_exchange_log = None
 
+    def close(self):
+        # This is a no-op, We don't want to free the data because one client
+        # may be closing it, while another wants to inspect the results.
+        pass
+
     def get_sync_generation(self, other_replica_uid):
         return self._other_generations.get(other_replica_uid, 0)
 

=== modified file 'u1db/backends/sqlite_backend.py'
--- u1db/backends/sqlite_backend.py	2011-10-28 09:17:26 +0000
+++ u1db/backends/sqlite_backend.py	2011-11-14 15:01:26 +0000
@@ -68,6 +68,9 @@
         """Release access to the underlying sqlite database."""
         self._db_handle.close()
 
+    def close(self):
+        self._close_sqlite_handle()
+
     def _is_initialized(self, c):
         """Check if this database has been initialized."""
         c.execute("PRAGMA case_sensitive_like=ON")

=== modified file 'u1db/commandline/client.py'
--- u1db/commandline/client.py	2011-11-04 13:12:38 +0000
+++ u1db/commandline/client.py	2011-11-14 15:01:26 +0000
@@ -148,6 +148,7 @@
         st = self._open_target(target)
         syncer = sync.Synchronizer(source_db, st)
         syncer.sync()
+        source_db.close()
 
 client_commands.register(CmdSync)
 

=== modified file 'u1db/tests/commandline/test_client.py'
--- u1db/tests/commandline/test_client.py	2011-11-04 13:12:38 +0000
+++ u1db/tests/commandline/test_client.py	2011-11-14 15:01:26 +0000
@@ -101,6 +101,7 @@
         self.db_path = self.working_dir + '/test.db'
         self.db = sqlite_backend.SQLitePartialExpandDatabase(self.db_path)
         self.db._set_replica_uid('test')
+        self.addCleanup(self.db.close)
 
     def make_command(self, cls, stdin_content=''):
         inf = cStringIO.StringIO(stdin_content)
@@ -175,6 +176,7 @@
         super(TestCmdSync, self).setUp()
         self.db2_path = self.working_dir + '/test2.db'
         self.db2 = sqlite_backend.SQLitePartialExpandDatabase(self.db2_path)
+        self.addCleanup(self.db2.close)
         self.db2._set_replica_uid('test2')
         _, self.doc_rev = self.db.create_doc(tests.simple_doc,
                                              doc_id='test-id')
@@ -247,7 +249,7 @@
         self.assertEqual(tests.simple_doc, doc)
         self.assertFalse(has_conflicts)
         self.assertEqual('id: test-id\nrev: %s\n' % (doc_rev,),
-                         stderr)
+                         stderr.replace('\r\n', '\n'))
 
     def test_get(self):
         _, doc_rev = self.db.create_doc(tests.simple_doc, doc_id='test-id')
@@ -277,6 +279,7 @@
         _, doc_rev = self.db.create_doc(tests.simple_doc, doc_id='test-id')
         self.db2_path = self.working_dir + '/test2.db'
         self.db2 = sqlite_backend.SQLitePartialExpandDatabase(self.db2_path)
+        self.addCleanup(self.db2.close)
         ret, stdout, stderr = self.run_main(
             ['sync', self.db_path, self.db2_path])
         self.assertEqual(0, ret)

=== modified file 'u1db/tests/commandline/test_serve.py'
--- u1db/tests/commandline/test_serve.py	2011-11-04 13:05:54 +0000
+++ u1db/tests/commandline/test_serve.py	2011-11-14 15:01:26 +0000
@@ -67,8 +67,8 @@
         host, port = s.getsockname()
         s.close()
         p = self.startU1DBServe(['--port', str(port)])
-        x = p.stdout.readline()
-        self.assertEqual('listening on port: %s\n' % (port,), x)
+        x = p.stdout.readline().strip()
+        self.assertEqual('listening on port: %s' % (port,), x)
         s = socket.socket()
         s.connect(('127.0.0.1', port))
         self.addCleanup(s.close)

=== modified file 'u1db/tests/test_backends.py'
--- u1db/tests/test_backends.py	2011-11-02 14:12:14 +0000
+++ u1db/tests/test_backends.py	2011-11-14 15:01:26 +0000
@@ -26,6 +26,9 @@
 
 class DatabaseTests(tests.DatabaseBaseTests):
 
+    def test_close(self):
+        self.db.close()
+
     def test_create_doc_allocating_doc_id(self):
         doc_id, new_rev = self.db.create_doc(simple_doc)
         self.assertNotEqual(None, doc_id)