Merge lp:~roignac/mago/test_thunderbird into lp:~mago-contributors/mago/mago-testsuite

[Vadim Rutkovsky]

This branch adds 4 simple tests for thunderbird:
 - Sending an email to oneself
 - Sending an email with attachment
 - Replying to an email
 - Forwarding an email

Note, that these tests require a configured account

I guess, some checks during tests are missing, so could you please point to the most important parts in these tests?

Unmerged revisions

30. By Vadim Rutkovsky on 2011-08-16

Added test_04_forward_a_mail_sent_to_you

29. By Vadim Rutkovsky on 2011-08-16

Added test_03_reply_to_mail_sent_to_you

28. By Vadim Rutkovsky on 2011-08-16

Added test_02_new_message_with_attachment

27. By Vadim Rutkovsky on 2011-08-16

Completed test_01_new_message

26. By Vadim Rutkovsky on 2011-08-15

Initial commit for thunderbird tests

25. By Vadim Rutkovsky on 2011-08-15

Started tests for evolution

=== added directory 'thunderbird'
=== added directory 'thunderbird/data'
=== added file 'thunderbird/data/ubuntu01.jpg'
Binary files thunderbird/data/ubuntu01.jpg	1970-01-01 00:00:00 +0000 and thunderbird/data/ubuntu01.jpg	2011-08-16 13:21:23 +0000 differ
=== added file 'thunderbird/test_thunderbird.py'
--- thunderbird/test_thunderbird.py	1970-01-01 00:00:00 +0000
+++ thunderbird/test_thunderbird.py	2011-08-16 13:21:23 +0000
@@ -0,0 +1,173 @@
+# Copyright (C) 2010 Canonical Ltd
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+
+"""
+Thunderbird Test Suite
+"""
+
+from mago import TestCase
+import unittest
+import os
+import ldtp, ooldtp
+import thunderbird
+
+"""
+Prerequisites:
+ - one configured mailbox
+"""
+
+class TestThunderbird(TestCase):
+    """
+    Test for Thunderbird mail client
+    """
+    launcher = 'thunderbird'
+    main = None             # Main Window class
+    composer = None         # Composer window class
+    
+    def test_01_new_message(self):
+        """
+        IntEvo-001: Compose and send message
+        """
+        
+        subject = 'Mago test_01'
+        body = 'Testing'
+        
+        # Open Compose message window
+        self.main = thunderbird.MainWindow()
+        self.composer = self.main.clickNewMessage()
+        
+        # Fill in details and click Send
+        sender = self.composer.getUserEmail()
+        self.composer.setTo(sender)
+        self.composer.setSubject(subject)
+        self.composer.setBody(body)
+        self.composer.clickSendMessage()
+        
+        # Click Get Mail and wait until operation is complete
+        self.main.clickGetMail()
+        # Select Inbox folder of specified mailbox     
+        self.main.selectFolder('Inbox')
+        # Search for a message with specified subject
+        self.main.selectMessage(subject)
+        # Check that correct body and subject are delivered
+        received_sender = self.main.getSenderFromActiveMessage()
+        received_subject = self.main.getSubjectFromActiveMessage()
+        received_body = self.main.getBodyFromActiveMessage()
+        assert received_sender== sender, "Got '%s', expected '%s'" % (received_sender, sender)
+        assert received_subject == subject, "Got '%s', expected '%s'" % (received_subject, subject)
+        assert received_body == body, "Got '%s', expected '%s'" % (received_body, body)
+
+    def test_02_new_message_with_attachment(self):
+        """
+        IntEvo-002: Compose and send message with attachment
+        """
+        
+        attachments = ['ubuntu01.jpg']
+        subject = 'Mago test_02'
+        body = 'Testing'
+        
+        # Open Compose message window
+        self.main = thunderbird.MainWindow()
+        self.composer = self.main.clickNewMessage()
+        
+        # Fill in details and click Send
+        sender = self.composer.getUserEmail()
+        self.composer.setTo(sender)
+        self.composer.setSubject(subject)
+        self.composer.setBody(body)
+        
+        for attachment in attachments:
+            self.attachDialog = self.composer.clickAddAttachment()
+            attachment_path = os.path.join(os.path.dirname(__file__), 'data', attachment)
+            self.attachDialog.selectLocation(attachment_path)
+        
+        self.composer.clickSendMessage()
+        
+        self.main.clickGetMail()
+        self.main.selectFolder('Inbox')
+        self.main.selectMessage(subject)
+        received_sender = self.main.getSenderFromActiveMessage()
+        received_subject = self.main.getSubjectFromActiveMessage()
+        received_body = self.main.getBodyFromActiveMessage()
+        received_attachments = self.main.getAttachmentsFromActiveMessage()
+        assert received_sender== sender, "Got '%s', expected '%s'" % (received_sender, sender)
+        assert received_subject == subject, "Got '%s', expected '%s'" % (received_subject, subject)
+        assert received_body == body, "Got '%s', expected '%s'" % (received_body, body)
+        assert received_attachments == attachments, "Got '%s', expected '%s'" % (received_attachments, attachments)
+        
+    def test_03_reply_to_mail_sent_to_you(self):
+        """
+        IntEvo-003: Reply to a mail sent to you
+        """
+        
+        subject = 'Mago test_02'
+        body = 'Replying'
+        
+        # Open Compose message window
+        self.main = thunderbird.MainWindow()
+        self.main.clickGetMail()
+        self.main.selectFolder('Inbox')
+        self.main.selectMessage(subject)
+        
+        self.composer = self.main.clickReply()
+        sender = self.composer.getUserEmail()
+        self.composer.appendBody(body)
+        self.composer.clickSendMessage()
+        
+        self.main.clickGetMail()
+        self.main.selectFolder('Inbox')
+        new_subject = 'Re: ' + subject
+        self.main.selectMessage(new_subject)
+        received_sender = self.main.getSenderFromActiveMessage()
+        received_subject = self.main.getSubjectFromActiveMessage()
+        received_body = self.main.getBodyFromActiveMessage().encode(errors='replace')
+        assert received_sender== sender, "Got '%s', expected '%s'" % (received_sender, sender)
+        assert received_subject == new_subject, "Got '%s', expected '%s'" % (received_subject, new_subject)
+        assert body in received_body, "Got '%s', doesn't contain '%s'" % (received_body, body)
+        
+    def test_04_forward_a_mail_sent_to_you(self):
+        """
+        IntEvo-004: Forward a mail sent to you
+        """
+        
+        subject = 'Mago test_02'
+        body = 'Forwarding'
+        
+        # Open Compose message window
+        self.main = thunderbird.MainWindow()
+        self.main.clickGetMail()
+        self.main.selectFolder('Inbox')
+        self.main.selectMessage(subject)
+        
+        self.composer = self.main.clickForward()
+        sender = self.composer.getUserEmail()
+        self.composer.setTo(sender)
+        self.composer.appendBody(body)
+        self.composer.clickSendMessage()
+        
+        self.main.clickGetMail()
+        self.main.selectFolder('Inbox')
+        new_subject = 'Fwd: ' + subject
+        self.main.selectMessage(new_subject)
+        received_sender = self.main.getSenderFromActiveMessage()
+        received_subject = self.main.getSubjectFromActiveMessage()
+        received_body = self.main.getBodyFromActiveMessage().encode(errors='replace')
+        assert received_sender== sender, "Got '%s', expected '%s'" % (received_sender, sender)
+        assert received_subject == new_subject, "Got '%s', expected '%s'" % (received_subject, new_subject)
+        assert body in received_body, "Got '%s', doesn't contain '%s'" % (received_body, body)
+
+if __name__ == "__main__":
+    unittest.main()

=== added file 'thunderbird/thunderbird.py'
--- thunderbird/thunderbird.py	1970-01-01 00:00:00 +0000
+++ thunderbird/thunderbird.py	2011-08-16 13:21:23 +0000
@@ -0,0 +1,197 @@
+# Copyright (C) 2010 Canonical Ltd
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 2 of the License, or
+# (at your option) any later version.
+#
+# This program 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 General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
+
+"""
+Thunderbird Test Wrapper
+"""
+
+import ldtp, ooldtp
+
+class MainWindow():
+    """ Main window class """
+    window_name = '*-MozillaThunderbird'
+    write_button = 'btnWrite'
+    mailbox_tree = 'tree0'
+    inbox = 'lstInbox'
+    messages_table = 'tbl1'
+    get_mail_button = 'btnGetMail1'
+    
+    attachments_panel = 'scpn0'
+    sender_field = 'txtfrom'
+    reply_button = 'btnreply1'
+    menu_message = 'mnuMessage'
+    menu_forward = 'mnuForward'
+    
+    def clickNewMessage(self):
+        """ Click 'New' button on toolbar """
+        ldtp.click(self.window_name, self.write_button)
+        # Wait until the editor window appears
+        ldtp.waittillguiexist(ComposeMessage.window_name)
+        return ComposeMessage()   
+        
+    def clickReply(self):
+        """ Click Reply in message pane """
+        ldtp.click(self.window_name, self.reply_button)
+        # Wait until the editor window appears
+        ldtp.waittillguiexist(ComposeMessage.window_name)
+        return ComposeMessage()
+        
+    def clickForward(self):
+        """ Click Reply in message pane """
+        ldtp.selectmenuitem(self.window_name, self.menu_message)
+        ldtp.selectmenuitem(self.window_name, self.menu_forward)
+        # Wait until the editor window appears
+        ldtp.waittillguiexist(ComposeMessage.window_name)
+        return ComposeMessage()
+        
+    def clickGetMail(self):
+        """ Click Get Mail """
+        ldtp.click(self.window_name, self.get_mail_button)
+        
+    def selectFirstMailbox(self):
+        """ Select mailbox with label """
+        mailboxes = ldtp.getobjectproperty(self.window_name, self.mailbox_tree, 'children').split(' ')
+        ldtp.doubleclick(self.window_name, mailboxes[1])
+    
+    def selectFolder(self, folder_name):
+        """ Select a folder with specified name """
+        try:
+            folder = ldtp.getchild(self.window_name, folder_name)
+        except:
+            self.selectFirstMailbox()
+            folder = ldtp.getchild(self.window_name, folder_name)
+            ldtp.wait(2)
+            ldtp.click(self.window_name, folder[0])
+
+        ldtp.wait(5)
+        assert ldtp.objectexist(self.window_name, self.messages_table)
+
+    def selectMessage(self, match):
+        """ Select a specified message by id """
+        ldtp.singleclickrow(self.window_name, self.messages_table, match)
+        ldtp.wait(5)
+        
+    def getSenderFromActiveMessage(self):
+        """ Get sender from active message """
+        ldtp.wait(2)
+        sender = ldtp.getobjectproperty(self.window_name, 'txtfrom*', 'label')
+        return sender.split('<')[1].split('>')[0]
+        
+    def getSubjectFromActiveMessage(self):
+        """ Get subject from active message """
+        sender = ldtp.getobjectproperty(self.window_name, 'txtsubject*', 'label')
+        return ": ".join(sender.split(': ')[1:])
+        
+    def getBodyFromActiveMessage(self):
+        """ Get body from active message """
+        body_frame  = ldtp.getchild(self.window_name, role = 'document_frame')[0]
+        body_field = ldtp.getobjectproperty(self.window_name, body_frame, 'children').split(' ')[0]
+        body_value = ldtp.gettextvalue(self.window_name, body_field)
+        return body_value.strip()
+        
+    def getAttachmentsFromActiveMessage(self):
+        """ Get attachment name from active message """
+        attachments = []
+        attachments_panel_children  = ldtp.getobjectproperty(self.window_name, self.attachments_panel, 'children').split(' ')
+        for child in attachments_panel_children:
+            if 'ukn' in child:
+                child_label = ldtp.getobjectproperty(self.window_name, child, 'label')
+                if child_label != '':
+                    attachments.append(child_label) 
+        return attachments
+
+class ComposeMessage():
+    """ Compose message class """
+    window_name = 'frmWrite:*'   
+    from_field = 'cboFrom'
+    to_field = 'To:'
+    subject_field = 'txtSubject'
+    body_field = 'uknaboutblank'   
+    send_button = 'btnSend'
+    
+    attach_button = 'btnAttach1'
+    
+    def getUserEmail(self):
+        """ Get user email from combobox """
+        from_value = ldtp.getobjectproperty(self.window_name, self.from_field, 'children')
+        full_user_name = ldtp.getobjectproperty(self.window_name,from_value, 'label')
+        return full_user_name.split('<')[1].split('>')[0]
+        
+    def setTo(self, value):
+        """ Enter recipient """
+        # TODO: Can't select To: field, so focus the window and send keys
+        ldtp.wait(2)
+        for char in value:
+            ldtp.generatekeyevent(char)
+            ldtp.wait(0.2)
+        
+    def setSubject(self, value):
+        """ Enter subject and update window_name"""
+        ldtp.settextvalue(self.window_name, self.subject_field, value)
+        
+    def setBody(self, value):
+        """ Enter body text """
+        ldtp.grabfocus(self.window_name,   self.body_field)
+        ldtp.settextvalue(self.window_name, self.body_field, value)
+        
+    def appendBody(self, value):
+        """ Append some text to body """
+        ldtp.grabfocus(self.window_name,   self.body_field)
+        ldtp.wait(2)
+        for char in value:
+            ldtp.generatekeyevent(char)
+            ldtp.wait(0.2)
+
+    def clickSendMessage(self):
+        """ Click Send button on toolbar and wait until the window disappears"""
+        ldtp.click(self.window_name, self.send_button)
+        ldtp.waittillguinotexist(self.window_name)
+        
+    def clickAddAttachment(self):
+        """ Click Add Attachment button """
+        ldtp.click(self.window_name, self.attach_button)
+        attachmentDialog = AttachmentDialog()
+        attachmentDialog.waitUntilDialogAppears()
+        return attachmentDialog
+
+class AttachmentDialog():
+    """ The class describes action in attachment dialog """
+    
+    attach_dialog = 'dlgAttachFile(s)'
+    attach_dialog_location_edit = 'tbtnTypeafilename'
+    attach_dialog_filename_field = 'txtLocation'
+    attach_dialog_attach_button = 'btnOpen'
+    
+    def waitUntilDialogAppears(self):
+        """ Wait until the dialog appears """
+        ldtp.waittillguiexist(self.attach_dialog)
+        
+    def selectLocation(self, location):
+        """ Click Edit Location button, input location and click 'Attach' button """
+        
+        # If location entry didn't appear, click 'Edit Location' button
+        try:
+            ldtp.getchild(self.attach_dialog, self.attach_dialog_filename_field)
+        except:
+            # Click 'Edit Location' button
+            ldtp.click(self.attach_dialog, self.attach_dialog_location_edit)
+
+        # Input path to sample file
+        ldtp.settextvalue(self.attach_dialog, self.attach_dialog_filename_field, location)
+        # Click 'Attach'
+        ldtp.click(self.attach_dialog, self.attach_dialog_attach_button)
+        # Wait until the dialog is closed
+        ldtp.waittillguinotexist(self.attach_dialog)