Merge lp:~iahmad/dialer-app/smart-dialing-test into lp:dialer-app

[Omer Akram]

Added smart dialing test.

Are there any related MPs required for this MP to build/function as expected? Please list.

None

Is your branch in sync with latest trunk (e.g. bzr pull lp:trunk -> no changes)

Yes. if not lp:dialer-app is broken

Did you perform an exploratory manual test run of your code change and any related functionality on device or emulator?

Yes, ran the test suite
Did you successfully run all tests found in your component's Test Plan on device or emulator?

Not needed, we only added tests

If you changed the UI, was the change specified/approved by design?

No change.

If you changed the packaging (debian), did you subscribe a core-dev to this MP?

None.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:92
http://jenkins.qa.ubuntu.com/job/dialer-app-ci/185/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/dialer-app-trusty-amd64-ci/90
    SUCCESS: http://jenkins.qa.ubuntu.com/job/dialer-app-trusty-armhf-ci/92
        deb: http://jenkins.qa.ubuntu.com/job/dialer-app-trusty-armhf-ci/92/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/dialer-app-trusty-i386-ci/90
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty/3098
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty-touch/2803/console
    UNSTABLE: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-trusty/2723
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/3100
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/3100/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/2805
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/2805/artifact/work/output/*zip*/output.zip
    FAILURE: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-mako/5217/console
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/3826

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/dialer-app-ci/185/rebuild

review: Needs Fixing (continuous-integration)

[lp:~iahmad/dialer-app/smart-dialing-test]

93. By I Ahmad on 2014-02-11

fix for MismatchError and use of Eventually

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:93
http://jenkins.qa.ubuntu.com/job/dialer-app-ci/186/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/dialer-app-trusty-amd64-ci/91
    SUCCESS: http://jenkins.qa.ubuntu.com/job/dialer-app-trusty-armhf-ci/93
        deb: http://jenkins.qa.ubuntu.com/job/dialer-app-trusty-armhf-ci/93/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/dialer-app-trusty-i386-ci/91
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty/3099
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-trusty-touch/2804
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-testrunner-otto-trusty/2724
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/3101
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-amd64/3101/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/2806
        deb: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-builder-trusty-armhf/2806/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/generic-mediumtests-runner-mako/5218
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/3827

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/dialer-app-ci/186/rebuild

review: Approve (continuous-integration)

[Omer Akram (om26er)]

looks good to me

review: Approve

[Gustavo Pichorim Boiko (boiko)]

Thanks for writing this test.
This MR uses the user's addressbook and also assumes it is empty. I don't think that is a good idea, because we are required to run tests on our own devices and we are not going to be emptying the addressbook for that.

My suggestion would be to use the memory backend for the addressbook, there are two MRs being done to prepare the dialer-app to support that:
https://code.launchpad.net/~renatofilho/address-book-app/contact-list-default-model/+merge/204103
https://code.launchpad.net/~boiko/dialer-app/contacts_memory_backend/+merge/206521

Can you please revisit this test after those MRs are merged?

review: Needs Fixing

[Gustavo Pichorim Boiko (boiko)]

> Thanks for writing this test.
> This MR uses the user's addressbook and also assumes it is empty. I don't
> think that is a good idea, because we are required to run tests on our own
> devices and we are not going to be emptying the addressbook for that.
>
> My suggestion would be to use the memory backend for the addressbook, there
> are two MRs being done to prepare the dialer-app to support that:
> https://code.launchpad.net/~renatofilho/address-book-app/contact-list-default-
> model/+merge/204103
> https://code.launchpad.net/~boiko/dialer-
> app/contacts_memory_backend/+merge/206521
>
> Can you please revisit this test after those MRs are merged?

Actually, I was talking to Renato about that, and we both think it would be a much better idea to have the address-book-service to use the folks dummy backend (same effect as using the memory backend on the apps themselves), but with the advantage that we can write inter-app tests (like creating a contact from a call log entry, etc).
This would probably require that the autopilot tests are executed in a separate dbus session, not sure if this would be possible.

Unmerged revisions

93. By I Ahmad on 2014-02-11

fix for MismatchError and use of Eventually

92. By I Ahmad on 2014-02-10

merge om26er branch

91. By I Ahmad on 2014-01-30

fixed pep8 warnings

90. By I Ahmad on 2014-01-30

Fixed the typo in delete contact and added few more asserts

89. By I Ahmad on 2014-01-28

removed the commented code and simplified the contact details

88. By I Ahmad on 2014-01-27

fix the pyflakes and pep8 warnings

87. By I Ahmad on 2014-01-27

code cleanup

86. By I Ahmad on 2014-01-27

Added a smart dialing test case

=== added file 'tests/autopilot/dialer_app/contacts.py'
--- tests/autopilot/dialer_app/contacts.py	1970-01-01 00:00:00 +0000
+++ tests/autopilot/dialer_app/contacts.py	2014-02-11 07:56:02 +0000
@@ -0,0 +1,58 @@
+#!/usr/bin/env python3
+# -*- encoding: utf-8 -*-
+#
+#  Copyright 2013 Canonical Ltd.
+#
+#  This program is free software; you can redistribute it and/or modify
+#  it under the terms of the GNU Lesser General Public License as published by
+#  the Free Software Foundation; version 3.
+#
+#  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 Lesser General Public License for more details.
+#
+#  You should have received a copy of the GNU Lesser General Public License
+#  along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+#  Borrowed the following helper class from
+#  lp:address-book-service/examples/contacts.py
+
+import dbus
+
+DBUS_IFACE_ADD_BOOK = 'com.canonical.pim.AddressBook'
+DBUS_IFACE_ADD_BOOKVIEW = 'com.canonical.pim.AddressBookView'
+
+
+class Contacts(object):
+    def __init__(self):
+        self.bus = None
+        self.addr = None
+        self.addr_iface = None
+
+    def connect(self):
+        self.bus = dbus.SessionBus()
+        self.addr = self.bus.get_object('com.canonical.pim',
+                                        '/com/canonical/pim/AddressBook')
+        self.addr_iface = dbus.Interface(self.addr,
+                                         dbus_interface=DBUS_IFACE_ADD_BOOK)
+
+    def query(self, fields='', query='', sources=[]):
+        view_path = self.addr_iface.query(fields, query, [])
+        view = self.bus.get_object('com.canonical.pim',
+                                   view_path)
+        view_iface = dbus.Interface(view,
+                                    dbus_interface=DBUS_IFACE_ADD_BOOKVIEW)
+        contacts = view_iface.contactsDetails([], 0, -1)
+        view.close()
+        return contacts
+
+    def update(self, vcard):
+        return self.addr_iface.updateContacts([vcard])
+
+    def create(self, vcard):
+        return self.addr_iface.createContact(vcard, "")
+
+    def delete(self, ids):
+        return self.addr_iface.removeContacts(ids)

=== modified file 'tests/autopilot/dialer_app/emulators.py'
--- tests/autopilot/dialer_app/emulators.py	2013-11-12 15:57:52 +0000
+++ tests/autopilot/dialer_app/emulators.py	2014-02-11 07:56:02 +0000
@@ -49,6 +49,38 @@
         return self.select_single("KeypadButton",
                                   objectName=buttonsDict[number])
 
+    def get_key_from_letter(self, letter):
+        buttonsDict = {
+            "A": "buttonTwo",
+            "B": "buttonTwo",
+            "C": "buttonTwo",
+            "D": "buttonThree",
+            "E": "buttonThree",
+            "F": "buttonThree",
+            "G": "buttonFour",
+            "H": "buttonFour",
+            "I": "buttonFour",
+            "J": "buttonFive",
+            "K": "buttonFive",
+            "L": "buttonFive",
+            "M": "buttonSix",
+            "N": "buttonSix",
+            "O": "buttonSix",
+            "P": "buttonSeven",
+            "Q": "buttonSeven",
+            "R": "buttonSeven",
+            "S": "buttonSeven",
+            "T": "buttonEight",
+            "U": "buttonEight",
+            "V": "buttonEight",
+            "W": "buttonNine",
+            "X": "buttonNine",
+            "Y": "buttonNine",
+            "Z": "buttonNine",
+        }
+        return self.select_single("KeypadButton",
+                                  objectName=buttonsDict[letter.upper()])
+
     def get_erase_button(self):
         return self.select_single("CustomButton", objectName="eraseButton")
 

=== modified file 'tests/autopilot/dialer_app/tests/test_calls.py'
--- tests/autopilot/dialer_app/tests/test_calls.py	2014-01-30 03:36:43 +0000
+++ tests/autopilot/dialer_app/tests/test_calls.py	2014-02-11 07:56:02 +0000
@@ -22,6 +22,23 @@
 
 from dialer_app.tests import DialerAppTestCase
 
+from dialer_app import contacts
+
+#Connect to address-book-service
+service = contacts.Contacts()
+service.connect()
+
+#Test VCARD
+VCARD_HUMPTY = """
+BEGIN:VCARD
+VERSION:3.0
+N:Dumpty;Humpty
+FN:Humpty Dumpty
+TEL;TYPE=WORK,VOICE;PID=1.1:[phone]
+EMAIL;TYPE=PREF,INTERNET;PID=1.1:[e-mail]
+END:VCARD
+"""
+
 # determine whether we are running with phonesim
 try:
     out = subprocess.check_output(["/usr/share/ofono/scripts/list-modems"],
@@ -151,6 +168,30 @@
             print('Expected failure due to known Mir crash '
                   '(https://launchpad.net/bugs/1240400): %s' % e)
 
+    def test_smart_dialing(self):
+        """Test for smart dialing feature."""
+        # assert that address book is empty.
+        self.assert_number_of_contacts(0)
+
+        self.add_new_contact_from_predefined_vcard()
+        self.addCleanup(self.delete_newly_added_contact)
+        
+        self.dial_number_from_letter('Humpty')
+
+        contact_title = 'Humpty Dumpty'
+        contact_search_list = self.main_view.dialer_page.wait_select_single(
+            "ContactSearchListView"
+        )
+        Name = contact_search_list.select_single(
+            "Label",
+            text=contact_title,
+            visible=True
+        )
+
+        self.pointing_device.click_object(Name)
+        self.wait_live_call_page(contact_title)
+        self.hangup()
+
     #
     # Helper methods
     #
@@ -163,7 +204,7 @@
 
         self.pointing_device.click_object(self.call_button)
 
-    def wait_live_call_page(self, number):
+    def wait_live_call_page(self, contact):
         """Wait until live call page gets visible
 
         Sets self.hangup_button.
@@ -175,7 +216,7 @@
 
         # should show called number in title page
         lcp = self.app.select_single(objectName="pageLiveCall")
-        self.assertThat(lcp.title, Equals(number))
+        self.assertThat(lcp.title, Eventually(Equals(contact)))
 
     def wait_for_incoming_call(self):
         """Wait up to 5 s for an incoming phone call"""
@@ -200,3 +241,22 @@
 
         # should switch to call log page
         self.assertThat(self.history_list.visible, Eventually(Equals(True)))
+
+    def assert_number_of_contacts(self, number):
+        contacts = service.query()
+
+        self.assertThat(lambda: len(contacts), Eventually(Equals(number)))
+
+    def dial_number_from_letter(self, letters):
+        for letter in letters:
+            key = self.main_view.dialer_page.get_key_from_letter(letter)
+            self.pointing_device.click_object(key)
+
+    def add_new_contact_from_predefined_vcard(self):
+        self.contactId = service.create(VCARD_HUMPTY)
+        self.assert_number_of_contacts(1)
+
+    def delete_newly_added_contact(self):
+        service.delete([self.contactId])
+
+        self.assert_number_of_contacts(0)