Merge lp:~jtv/launchpad/fakelibrarian-commit into lp:launchpad

[Jeroen T. Vermeulen]

FakeLibrarian.pretendCommit

= FakeLibrarian commit =

The FakeLibrarian is a usable substitute for the Librarian in tests that only need the librarian inside their own process. Like the real Librarian, the FakeLibrarian makes a file available only after you commit the transaction that added it.

This branch adds a "fake commit" method to the fake librarian. The fake commit allows tests to add files to the fake librarian and continue using them as if there had been a commit—but without incurring a database commit. Commits in tests can be quite costly because they make it necessary to restore a pristine test database for the next test.

[Abel Deuring (adeuring)]

review: Approve (code)

=== modified file 'lib/lp/testing/fakelibrarian.py'
--- lib/lp/testing/fakelibrarian.py	2010-08-20 20:31:18 +0000
+++ lib/lp/testing/fakelibrarian.py	2010-08-22 09:27:48 +0000
@@ -151,6 +151,19 @@
         alias.checkCommitted()
         return StringIO(alias.content_string)
 
+    def pretendCommit(self):
+        """Pretend that there's been a commit.
+
+        When you add a file to the librarian (real or fake), it is not
+        fully available until the transaction that added the file has
+        been committed.  Call this method to make the FakeLibrarian act
+        as if there's been a commit, without actually committing a
+        database transaction.
+        """
+        # Note that all files have been committed to storage.
+        for alias in self.aliases.itervalues():
+            alias.file_committed = True
+
     def _makeAlias(self, file_id, name, content, content_type):
         """Create a `LibraryFileAlias`."""
         alias = InstrumentedLibraryFileAlias(
@@ -195,9 +208,7 @@
 
     def afterCompletion(self, txn):
         """See `ISynchronizer`."""
-        # Note that all files have been committed to storage.
-        for alias in self.aliases.itervalues():
-            alias.file_committed = True
+        self.pretendCommit()
 
     def newTransaction(self, txn):
         """See `ISynchronizer`."""

=== modified file 'lib/lp/testing/tests/test_fakelibrarian.py'
--- lib/lp/testing/tests/test_fakelibrarian.py	2010-08-20 20:31:18 +0000
+++ lib/lp/testing/tests/test_fakelibrarian.py	2010-08-22 09:27:48 +0000
@@ -109,6 +109,15 @@
         self.assertTrue(verifyObject(ISynchronizer, self.fake_librarian))
         self.assertIsInstance(self.fake_librarian, FakeLibrarian)
 
+    def test_pretend_commit(self):
+        name, text, alias_id = self._storeFile()
+
+        self.fake_librarian.pretendCommit()
+
+        retrieved_alias = getUtility(ILibraryFileAliasSet)[alias_id]
+        retrieved_alias.open()
+        self.assertEqual(text, retrieved_alias.read())
+
 
 class TestRealLibrarian(LibraryAccessScenarioMixin, TestCaseWithFactory):
     """Test the supported interface subset on the real librarian."""