From a1f28aa61b9c688f249095ec9ddcc6a53ea80136 Mon Sep 17 00:00:00 2001 From: Victor Shyba Date: Tue, 14 Oct 2014 09:01:46 -0300 Subject: adds tests and listener for indexing mails created outside the user agent, see #103 --- service/pixelated/adapter/listener.py | 46 +++++++++++++++++ service/pixelated/adapter/pixelated_mailboxes.py | 4 ++ service/pixelated/adapter/soledad_querier.py | 3 ++ service/pixelated/user_agent.py | 3 ++ service/test/support/integration_helper.py | 11 ++++ service/test/unit/adapter/listener_test.py | 59 ++++++++++++++++++++++ .../test/unit/adapter/pixelated_mailboxes_test.py | 1 + 7 files changed, 127 insertions(+) create mode 100644 service/pixelated/adapter/listener.py create mode 100644 service/test/unit/adapter/listener_test.py diff --git a/service/pixelated/adapter/listener.py b/service/pixelated/adapter/listener.py new file mode 100644 index 00000000..ca264f31 --- /dev/null +++ b/service/pixelated/adapter/listener.py @@ -0,0 +1,46 @@ +# +# Copyright (c) 2014 ThoughtWorks, Inc. +# +# Pixelated is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# Pixelated is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PCULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with Pixelated. If not, see . +from pixelated.adapter.soledad_querier import SoledadQuerier + + +class MailboxListener(object): + """ Listens for new mails, keeping the index updated """ + + SEARCH_ENGINE = None + + @classmethod + def listen(cls, account, mailbox_name): + listener = MailboxListener(mailbox_name) + if listener not in account.getMailbox(mailbox_name).listeners: + account.getMailbox(mailbox_name).addListener(listener) + + def __init__(self, mailbox_name): + self.mailbox_name = mailbox_name + self.querier = SoledadQuerier.get_instance() + + def newMessages(self, exists, recent): + indexed_idents = set(self.SEARCH_ENGINE.search('tag:' + self.mailbox_name.lower())) + soledad_idents = self.querier.get_idents_by_mailbox(self.mailbox_name) + + missing_idents = soledad_idents.difference(indexed_idents) + + self.SEARCH_ENGINE.index_mails(self.querier.mails(missing_idents)) + + def __eq__(self, other): + return other and other.mailbox_name == self.mailbox_name + + def __hash__(self): + return self.mailbox_name.__hash__() diff --git a/service/pixelated/adapter/pixelated_mailboxes.py b/service/pixelated/adapter/pixelated_mailboxes.py index c87b7ab3..1025f58e 100644 --- a/service/pixelated/adapter/pixelated_mailboxes.py +++ b/service/pixelated/adapter/pixelated_mailboxes.py @@ -15,6 +15,7 @@ # along with Pixelated. If not, see . from pixelated.adapter.pixelated_mailbox import PixelatedMailbox from pixelated.adapter.soledad_querier import SoledadQuerier +from pixelated.adapter.listener import MailboxListener class PixelatedMailBoxes(): @@ -22,11 +23,14 @@ class PixelatedMailBoxes(): def __init__(self, account): self.account = account self.querier = SoledadQuerier.get_instance() + for mailbox_name in account.mailboxes: + MailboxListener.listen(self.account, mailbox_name) def _create_or_get(self, mailbox_name): mailbox_name = mailbox_name.upper() if mailbox_name not in self.account.mailboxes: self.account.addMailbox(mailbox_name) + MailboxListener.listen(self.account, mailbox_name) return PixelatedMailbox.create(mailbox_name) def inbox(self): diff --git a/service/pixelated/adapter/soledad_querier.py b/service/pixelated/adapter/soledad_querier.py index 43b9891e..cb3db66a 100644 --- a/service/pixelated/adapter/soledad_querier.py +++ b/service/pixelated/adapter/soledad_querier.py @@ -88,6 +88,9 @@ class SoledadQuerier: self.soledad.delete_doc(_mail.hdoc) self.soledad.delete_doc(_mail.fdoc) + def get_idents_by_mailbox(self, mailbox_name): + return set(doc.content['chash'] for doc in self.soledad.get_from_index('by-type-and-mbox-and-deleted', 'flags', mailbox_name, '0')) + def _next_uid_for_mailbox(self, mailbox_name): mails = self.all_mails_by_mailbox(mailbox_name) mails.sort(key=lambda x: x.uid, reverse=True) diff --git a/service/pixelated/user_agent.py b/service/pixelated/user_agent.py index da8b69a0..307ab13a 100644 --- a/service/pixelated/user_agent.py +++ b/service/pixelated/user_agent.py @@ -37,6 +37,8 @@ from pixelated.adapter.soledad_querier import SoledadQuerier from pixelated.adapter.search import SearchEngine from pixelated.adapter.tag_service import TagService from pixelated.adapter.draft_service import DraftService +from pixelated.adapter.listener import MailboxListener + import dateutil.parser as dateparser static_folder = os.path.abspath(os.path.join(os.path.abspath(__file__), "..", "..", "web-ui", "app")) @@ -220,6 +222,7 @@ def start_user_agent(debug_enabled): mail_service = MailService(pixelated_mailboxes, pixelated_mail_sender) global search_engine search_engine = SearchEngine() + MailboxListener.SEARCH_ENGINE = search_engine search_engine.index_mails(mail_service.all_mails()) global draft_service draft_service = DraftService(pixelated_mailboxes) diff --git a/service/test/support/integration_helper.py b/service/test/support/integration_helper.py index 5975b9e8..c2f84157 100644 --- a/service/test/support/integration_helper.py +++ b/service/test/support/integration_helper.py @@ -34,10 +34,21 @@ from pixelated.adapter.soledad_querier import SoledadQuerier soledad_test_folder = "soledad-test" +class FakeLeapMailboxWithListeners: + def __init__(self): + self.listeners = set() + + def addListener(self, listener): + self.listeners.add(listener) + + class FakeAccount: def __init__(self): self.mailboxes = ['INBOX', 'DRAFTS', 'SENT', 'TRASH'] + def getMailbox(self, name): + return FakeLeapMailboxWithListeners() + def initialize_soledad(tempdir): uuid = "foobar-uuid" diff --git a/service/test/unit/adapter/listener_test.py b/service/test/unit/adapter/listener_test.py new file mode 100644 index 00000000..ec4b1d93 --- /dev/null +++ b/service/test/unit/adapter/listener_test.py @@ -0,0 +1,59 @@ +# +# Copyright (c) 2014 ThoughtWorks, Inc. +# +# Pixelated is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# Pixelated is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with Pixelated. If not, see . +import unittest + +from mockito import * +import pixelated.adapter.soledad_querier + +querier = mock() +when(pixelated.adapter.soledad_querier).get_soledad_querier_instance().thenReturn(querier) + +from pixelated.adapter.listener import MailboxListener + + +class MailboxListenerTest(unittest.TestCase): + def setUp(self): + self.account = mock() + self.account.mailboxes = [] + + def test_add_itself_to_mailbox_listeners(self): + self.account.mailboxes = ['INBOX'] + mailbox = mock() + when(self.account).getMailbox('INBOX').thenReturn(mailbox) + mailbox.listeners = set() + when(mailbox).addListener = lambda x: mailbox.listeners.add(x) + + self.assertNotIn(MailboxListener('INBOX'), mailbox.listeners) + + MailboxListener.listen(self.account, 'INBOX') + + self.assertIn(MailboxListener('INBOX'), mailbox.listeners) + + def test_reindex_missing_idents(self): + search_engine = mock() + when(search_engine).search('tag:inbox').thenReturn(['ident1', 'ident2']) + + MailboxListener.SEARCH_ENGINE = search_engine + + listener = MailboxListener('INBOX') + listener.querier = querier + when(querier).get_idents_by_mailbox('INBOX').thenReturn({'ident1', 'ident2', 'missing_ident'}) + querier.used_arguments = [] + querier.mails = lambda x: querier.used_arguments.append(x) + listener.newMessages(10, 5) + + verify(querier, times=1).get_idents_by_mailbox('INBOX') + self.assertIn({'missing_ident'}, querier.used_arguments) diff --git a/service/test/unit/adapter/pixelated_mailboxes_test.py b/service/test/unit/adapter/pixelated_mailboxes_test.py index fce06a22..ddb3e84b 100644 --- a/service/test/unit/adapter/pixelated_mailboxes_test.py +++ b/service/test/unit/adapter/pixelated_mailboxes_test.py @@ -31,6 +31,7 @@ class PixelatedMailboxesTest(unittest.TestCase): def setUp(self): self.account = mock() + self.account.mailboxes = [] self.drafts_mailbox = mock() self.drafts_mailbox.mailbox_name = 'drafts' self.mailboxes = PixelatedMailBoxes(self.account) -- cgit v1.2.3