Merge lp:~om26er/address-book-app/abook_navigation_favorites into lp:address-book-app

[Omer Akram]

[lp:~om26er/address-book-app/abook_navigation_favorites]

161. By Omer Akram on 2014-03-17

remove unused test code

162. By Omer Akram on 2014-03-17

fix pep8 and pyflakes warnings for test_favorite, did not touch other modules

163. By Omer Akram on 2014-03-18

remove syncevolution dep

164. By Omer Akram on 2014-03-18

remove unused test code, fix things

165. By Omer Akram on 2014-03-18

make dummy backend code reusable by other test cases

166. By Omer Akram on 2014-03-18

add docstrings for new tests

167. By Omer Akram on 2014-03-24

make starting of dummy backend a reusable helper for other apps to consume

168. By Omer Akram on 2014-03-26

adapt autopilot tests to UI changes in trunk

169. By Omer Akram on 2014-03-26

merge trunk

Unmerged revisions

169. By Omer Akram on 2014-03-26

merge trunk

168. By Omer Akram on 2014-03-26

adapt autopilot tests to UI changes in trunk

167. By Omer Akram on 2014-03-24

make starting of dummy backend a reusable helper for other apps to consume

166. By Omer Akram on 2014-03-18

add docstrings for new tests

165. By Omer Akram on 2014-03-18

make dummy backend code reusable by other test cases

164. By Omer Akram on 2014-03-18

remove unused test code, fix things

163. By Omer Akram on 2014-03-18

remove syncevolution dep

162. By Omer Akram on 2014-03-17

fix pep8 and pyflakes warnings for test_favorite, did not touch other modules

161. By Omer Akram on 2014-03-17

remove unused test code

160. By Omer Akram on 2014-03-17

don't use memory backend for favorite tests, use the new dummy backend from the service

=== modified file 'debian/control'
--- debian/control	2013-12-11 15:03:32 +0000
+++ debian/control	2014-03-17 23:53:00 +0000
@@ -68,6 +68,7 @@
          libqt5test5,
          libqt5widgets5,
          ubuntu-ui-toolkit-autopilot,
+	 syncevolution,
          address-book-app (>= ${binary:Version}),
 Description: Test package for address-book-app
  Autopilot tests for the address-book-app package
 
=== modified file 'src/imports/ContactList/ContactListPage.qml'
--- src/imports/ContactList/ContactListPage.qml	2014-01-30 21:13:08 +0000
+++ src/imports/ContactList/ContactListPage.qml	2014-03-17 23:53:00 +0000
@@ -72,7 +72,6 @@
         id: contactList
         objectName: "contactListView"
 
-        showFavoritePhoneLabel: false
         multiSelectionEnabled: true
         acceptAction.text: pickMode ? i18n.tr("Select") : i18n.tr("Delete")
         multipleSelection: !pickMode ||
 
=== modified file 'src/imports/ContactView/ContactDetailFavoriteView.qml'
--- src/imports/ContactView/ContactDetailFavoriteView.qml	2013-07-04 20:57:19 +0000
+++ src/imports/ContactView/ContactDetailFavoriteView.qml	2014-03-17 23:53:00 +0000
@@ -24,15 +24,21 @@
     id: root
 
     detail: root.contact ? root.contact.favorite : null
-    Image {
+    showDivider: false
+
+    Icon {
+        id: icon
+        objectName: 'favoriteIcon'
+
         anchors.fill: parent
-        source: root.detail && root.detail.favorite ? "artwork:/favorite-selected.png" : "artwork:/favorite-unselected.png"
+        name: root.detail && root.detail.favorite ? "favorite-selected" : "favorite-unselected"
+        color: UbuntuColors.orange
         MouseArea {
-           anchors.fill: parent
-           onClicked: {
-               root.detail.favorite = !root.detail.favorite
-               //TODO: save favorite if not in edit mode
-           }
+            anchors.fill: parent
+            onClicked: {
+                   root.detail.favorite = !root.detail.favorite
+                   root.contact.save()
+            }
         }
-   }
+    }
 }
 
=== modified file 'src/imports/ContactView/ContactDetailPhoneNumbersView.qml'
--- src/imports/ContactView/ContactDetailPhoneNumbersView.qml	2014-01-14 20:43:59 +0000
+++ src/imports/ContactView/ContactDetailPhoneNumbersView.qml	2014-03-17 23:53:00 +0000
@@ -36,28 +36,12 @@
 
     detailDelegate: ContactDetailPhoneNumberView {
         property variant detailType: detail && root.contact && root.typeModel.ready ? root.getType(detail) : null
-        property bool isPreferred: root.contact && root.contact.preferredDetails && detail && root.contact.isPreferredDetail("TEL", detail)
-
-        action: Action {
-            objectName: "favoriteAction"
-
-            text: i18n.tr("Favorite")
-            iconSource: (contact.favorite.favorite && isPreferred) ? "artwork:/favorite-selected.svg" : "artwork:/favorite-unselected.svg"
-        }
+
         contact: root.contact
         fields: root.fields
         typeLabel: detailType ? detailType.label : ""
 
         height: implicitHeight
         width: root.width
-        onClicked: {
-            if (isPreferred && contact.favorite.favorite) {
-                contact.favorite.favorite = false
-            } else {
-                root.contact.setPreferredDetail("TEL", detail)
-                contact.favorite.favorite = true
-            }
-            contact.save()
-        }
     }
 }
 
=== modified file 'src/imports/ContactView/ContactView.qml'
--- src/imports/ContactView/ContactView.qml	2013-11-14 17:48:48 +0000
+++ src/imports/ContactView/ContactView.qml	2014-03-17 23:53:00 +0000
@@ -81,6 +81,16 @@
                     right: parent.right
                 }
                 height: implicitHeight
+                ContactDetailFavoriteView {
+                    contact: root.contact
+                    anchors {
+                        left: parent.left
+                        bottom: parent.bottom
+                        margins: units.gu(2)
+                    }
+                    width: units.gu(4)
+                    height: units.gu(4)
+                }
             }
 
             ContactDetailPhoneNumbersView {
 
=== modified file 'src/imports/Ubuntu/Contacts/CMakeLists.txt'
--- src/imports/Ubuntu/Contacts/CMakeLists.txt	2013-12-16 15:04:12 +0000
+++ src/imports/Ubuntu/Contacts/CMakeLists.txt	2014-03-17 23:53:00 +0000
@@ -11,7 +11,6 @@
     ContactSearchListView.qml
     ContactSimpleListView.qml
     DialogButtons.qml
-    FavoriteDelegate.qml
     MultipleSelectionListView.qml
     MultipleSelectionVisualModel.qml
     qmldir
 
=== modified file 'src/imports/Ubuntu/Contacts/ContactListView.qml'
--- src/imports/Ubuntu/Contacts/ContactListView.qml	2013-11-14 13:25:28 +0000
+++ src/imports/Ubuntu/Contacts/ContactListView.qml	2014-03-17 23:53:00 +0000
@@ -41,78 +41,75 @@
 ContactSimpleListView {
     id: root
 
-    /*!
-      \qmlproperty bool showFavoritePhoneLabel
-
-      This property holds if the phone label should appear on favorite contact or not
-      By default this is set to true.
-    */
-    property bool showFavoritePhoneLabel: true
-
-    header: Column {
-        objectName: "listHeader"
-
-        width: parent.width
-        height: favouritesList.count > 0 ? childrenRect.height : 0
-
-        ContactSimpleListView {
-            id: favouritesList
-            objectName: "favouritesList"
-
-            manager: root.manager
-            header: ListItem.Header {
-                height: units.gu(5)
+    property bool showFavourites: false
+
+    header: Rectangle {
+        id: itemHeader
+
+        height: units.gu(4)
+        anchors {
+            left: parent.left
+            right: parent.right
+        }
+        color: UbuntuColors.coolGrey
+
+        Row {
+            anchors.fill: parent
+            Label {
+                id: lblAll
+
+                anchors {
+                    top: parent.top
+                    bottom: parent.bottom
+                }
+                width: parent.width / 2
+                text: i18n.tr("All")
+                horizontalAlignment: Text.AlignHCenter
+                verticalAlignment: Text.AlignVCenter
+                color: root.showFavourites ? UbuntuColors.warmGrey : UbuntuColors.orange
+                MouseArea {
+                    anchors.fill: parent
+                    onClicked: root.showFavourites = false
+                }
+            }
+
+            Rectangle {
+                anchors {
+                    top: parent.top
+                    bottom: parent.bottom
+                    margins: units.gu(1)
+                }
+                width: 1
+            }
+
+            Label {
+                id: lblFavourites
+
+                anchors {
+                    top: parent.top
+                    bottom: parent.bottom
+                }
+                width: parent.width / 2
                 text: i18n.tr("Favourites")
-            }
-
-            anchors {
-                left: parent.left
-                right: parent.right
-            }
-
-            height: (count > 0 && !root.isInSelectionMode) ? contentHeight : 0
-            onContactClicked: root.contactClicked(contact)
-            defaultAvatarImageUrl: root.defaultAvatarImageUrl
-            multiSelectionEnabled: false
-            interactive: false
-            showSections: false
-
-            fetchHint: FetchHint {
-                optimizationHints: FetchHint.AllRequired
-                detailTypesHint: [ ContactDetail.Avatar,
-                                   ContactDetail.Favorite,
-                                   ContactDetail.Name,
-                                   ContactDetail.PhoneNumber ]
-            }
-
-            filter: DetailFilter {
-                detail: ContactDetail.Favorite
-                field: Favorite.Favorite
-                value: true
-                matchFlags: DetailFilter.MatchExactly
-            }
-
-            listDelegate: FavoriteDelegate {
-                showPhoneLabel: root.showFavoritePhoneLabel
-                defaultAvatarUrl: favouritesList.defaultAvatarImageUrl
-                onContactClicked: _fetchContact(index, contact)
-            }
-
-            Behavior on height {
-                UbuntuNumberAnimation {}
-            }
-
-            // WORKAROUND: Due a bug on the SDK Page component the page is nto correct positioned if it changes
-            // the size dynamically
-            onHeightChanged: {
-                root.contentY = -contentHeight * 2
-                root.returnToBounds()
-            }
-        }
-        ListItem.Header {
-            height: favouritesList.count > 0 ? units.gu(5) : 0
-            visible: height > 0
-            text: i18n.tr("All contacts")
-        }
-    }
+                horizontalAlignment: Text.AlignHCenter
+                verticalAlignment: Text.AlignVCenter
+                color: root.showFavourites ? UbuntuColors.orange : UbuntuColors.warmGrey
+                MouseArea {
+                    anchors.fill: parent
+                    onClicked: root.showFavourites = true
+                }
+            }
+        }
+    }
+
+    DetailFilter {
+        id: favouritesFilter
+
+        detail: ContactDetail.Favorite
+        field: Favorite.Favorite
+        value: true
+        matchFlags: DetailFilter.MatchExactly
+    }
+
+    filter: showFavourites ? favouritesFilter : null
 }
 
=== removed file 'src/imports/Ubuntu/Contacts/FavoriteDelegate.qml'
--- src/imports/Ubuntu/Contacts/FavoriteDelegate.qml	2013-10-11 00:12:19 +0000
+++ src/imports/Ubuntu/Contacts/FavoriteDelegate.qml	1970-01-01 00:00:00 +0000
@@ -1,112 +0,0 @@
-/*
- * Copyright (C) 2012-2013 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; 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 General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
- */
-
-import QtQuick 2.0
-import Ubuntu.Components 0.1
-import Ubuntu.Components.ListItems 0.1 as ListItem
-import QtContacts 5.0
-import "Contacts.js" as ContactsJS
-
-ListItem.Empty {
-    id: favoriteItem
-
-    property int index: -1
-    property bool showAvatar: true
-    property string defaultAvatarUrl: ""
-    property int titleDetail: ContactDetail.Name
-    property variant titleFields: [ Name.FirstName, Name.LastName ]
-    property bool showPhoneLabel: true
-
-    signal contactClicked(var index, var contact)
-
-    implicitHeight: units.gu(8)
-    width: parent ? parent.width : 0
-
-    Rectangle {
-        anchors {
-            fill: parent
-            bottomMargin: units.dp(1)
-        }
-        color: UbuntuColors.warmGrey
-        opacity: 0.07
-    }
-
-    UbuntuShape {
-        id: avatar
-
-        anchors {
-            left: parent.left
-            leftMargin: units.gu(2)
-            top: parent.top
-            topMargin: units.gu(1)
-            bottom: parent.bottom
-            bottomMargin: units.gu(1)
-        }
-        width: favoriteItem.showAvatar ? height : 0
-        visible: favoriteItem.showAvatar
-        radius: "medium"
-        image: Image {
-            property bool isDefaultAvatar: (source == favoriteItem.defaultAvatarUrl)
-
-            fillMode: Image.PreserveAspectCrop
-            asynchronous: true
-            source: ContactsJS.getAvatar(contact, favoriteItem.defaultAvatarUrl)
-            sourceSize.width: isDefaultAvatar ? undefined : width * 1.5
-            sourceSize.height: isDefaultAvatar ? undefined : height * 1.5
-        }
-    }
-
-    Column {
-        anchors {
-            top: parent.top
-            topMargin:  units.gu(2)
-            left: avatar.right
-            leftMargin: units.gu(2)
-            right: parent.right
-            bottom: parent.bottom
-        }
-
-        Label {
-            id: name
-
-            anchors {
-                left: parent.left
-                right: parent.right
-            }
-
-            height: favoriteItem.showPhoneLabel ? paintedHeight : paintedHeight * 2
-            verticalAlignment: Text.AlignVCenter
-            text: ContactsJS.formatToDisplay(contact, favoriteItem.titleDetail, favoriteItem.titleFields)
-            fontSize: "medium"
-        }
-
-        Label {
-            id: label
-
-            anchors {
-                left: parent.left
-                right: parent.right
-            }
-
-            opacity: 0.2
-            height: favoriteItem.showPhoneLabel ? paintedHeight : 0
-            text: favoriteItem.showPhoneLabel && contact.phoneNumbers ? ContactsJS.getFavoritePhoneLabel(contact, "") : ""
-            fontSize: "medium"
-        }
-    }
-
-    onClicked: favoriteItem.contactClicked(index, contact)
-}
 
=== modified file 'src/imports/Ubuntu/Contacts/qmldir'
--- src/imports/Ubuntu/Contacts/qmldir	2013-10-21 19:25:51 +0000
+++ src/imports/Ubuntu/Contacts/qmldir	2014-03-17 23:53:00 +0000
@@ -10,7 +10,6 @@
 
 internal ContactDetailPickerDelegate ContactDetailPickerDelegate.qml
 internal ContactDetailPickerPhoneNumberDelegate ContactDetailPickerPhoneNumberDelegate.qml
-internal ContactFavoriteListDelegate ContactFavoriteDelegate.qml
 internal DialogButtons DialogButtons.qml
 internal OrganicView OrganicView.qml
 internal ContactList ContactList.js
 
=== modified file 'tests/autopilot/address_book_app/emulators/__init__.py'
--- tests/autopilot/address_book_app/emulators/__init__.py	2013-07-09 18:42:30 +0000
+++ tests/autopilot/address_book_app/emulators/__init__.py	2014-03-17 23:53:00 +0000
@@ -4,3 +4,15 @@
 # This program is free software: you can redistribute it and/or modify it
 # under the terms of the GNU General Public License version 3, as published
 # by the Free Software Foundation.
+
+
+def get_nearest_parent_matching_type(child, desired_type):
+    """Climb down the widget tree, return first instance of desired_type"""
+    while type(child).__name__ != desired_type:
+        parent = child.get_parent()
+        if type(child).__name__ == 'AddressBookApp':
+            # we reached the root and found nothing
+            return None
+        else:
+            child = parent
+    return child
 
=== modified file 'tests/autopilot/address_book_app/emulators/contact_list_page.py'
--- tests/autopilot/address_book_app/emulators/contact_list_page.py	2014-02-13 16:44:12 +0000
+++ tests/autopilot/address_book_app/emulators/contact_list_page.py	2014-03-17 23:53:00 +0000
@@ -1,20 +1,24 @@
 # -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
-
-""" ContactListPage emulator for Addressbook App tests """
-
 # Copyright 2014 Canonical
 #
 # This program is free software: you can redistribute it and/or modify it
 # under the terms of the GNU General Public License version 3, as published
 # by the Free Software Foundation.
 
+""" ContactListPage emulator for Addressbook App tests """
+
 import logging
+from time import sleep
 
+from autopilot import logging as autopilot_logging
 from autopilot.introspection.dbus import StateNotFoundError
+from autopilot.matchers import Eventually
+from testtools.matchers import GreaterThan
 from ubuntuuitoolkit import emulators as uitk
 
-LOGGER = logging.getLogger(__name__)
-from time import sleep
+from address_book_app.emulators import get_nearest_parent_matching_type
+
+logger = logging.getLogger(__name__)
 
 
 class ContactListPage(uitk.UbuntuUIToolkitEmulatorBase):
@@ -27,9 +31,12 @@
         super(ContactListPage, self).__init__(*args)
 
     def get_contacts(self):
-        """
-        Returns a list of ContactDelegate objects and populate
-        self.selection_marks
+        """Returns a list of ContactDelegate objects.
+
+        Also populate self.selection_marks.
+
+        :return: The list of ContactDelegate objects.
+
         """
         sleep(1)
         self.contacts = self.select_many("ContactDelegate")
@@ -41,10 +48,12 @@
             self.selection_marks.append(mark)
         return self.contacts
 
+    @autopilot_logging.log_action(logger.info)
     def select_contacts_by_index(self, indices):
-        """ Select contacts corresponding to the list of index in indices
-
-        :param indices: List of integers
+        """Select contacts corresponding to the list of index in indices.
+
+        :param indices: List of integer indices of contacts to select.
+
         """
         self.deselect_all()
 
@@ -53,8 +62,9 @@
             self.selected_marks.append(self.selection_marks[idx])
             self.pointing_device.click_object(self.selection_marks[idx])
 
+    @autopilot_logging.log_action(logger.info)
     def deselect_all(self):
-        """Deselect every contacts"""
+        """Deselect every contact."""
         contacts = self.select_many("ContactDelegate")
         self.selected_marks = []
         for contact in contacts:
@@ -63,28 +73,144 @@
                                              objectName="selectionMark")
                 self.pointing_device.click_object(mark)
 
+    @autopilot_logging.log_action(logger.info)
     def click_button(self, objectname):
         """Press a button that matches objectname
 
-        :param objectname: Name of the object
+        :param objectname: The name of the object.
+        :raise StateNotFoundError: When a matching button is not found.
+
         """
-        try:
-            buttons = self.select_many("Button",
-                                       objectName=objectname)
-            for button in buttons:
-                if button.visible:
-                    self.pointing_device.click_object(button)
-        except StateNotFoundError:
-            LOGGER.error(
-                'Button with objectName "{0}" not found.'.format(objectname)
-            )
-            raise
+        button = self.select_single("Button",
+                                     objectName=objectname,
+                                     visible=True)
+        self.pointing_device.click_object(button)
 
+    @autopilot_logging.log_action(logger.info)
     def cancel(self):
-        """Press the cancel button displayed when pick mode is enabled"""
+        """Press the cancel button displayed when pick mode is enabled."""
         self.click_button("DialogButtons.rejectButton")
 
+    @autopilot_logging.log_action(logger.info)
     def delete(self):
-        """Press the delete button displayed when pick mode is enabled"""
+        """Press the delete button displayed when pick mode is enabled."""
         self.click_button("DialogButtons.acceptButton")
         self.get_contacts()
+
+    def get_contact_by_name(self,
+                            contact_name,
+                            parent_delegate_type='ContactDelegate'):
+        """Find a label with text matching contact name.
+
+        :param contact_name: The name of the contact, e.g. 'Fulano de Tal'.
+        :param parent_delegate_type: 'ContactDelegate' or 'FavoriteDelegate'.
+        :return: The label for a matching contact.
+        :raises StateNotFoundError: If the contact_name is not found.
+
+        """
+        try:
+            assert(lambda: len(self.select_many("Label",
+                                                text=contact_name)),
+                   Eventually(GreaterThan(0)))
+            contact_name_labels = self.select_many(
+                "Label",
+                text=contact_name)
+            for contact_name_label in contact_name_labels:
+                # we could have a contact or a favorite
+                if get_nearest_parent_matching_type(
+                        contact_name_label,
+                        parent_delegate_type):
+                    return contact_name_label
+            raise StateNotFoundError('Label')
+        except StateNotFoundError:
+            logger.error("Contact {} not found.".format(contact_name))
+            raise
+
+    def get_favorite_by_name(self, contact_name):
+        """Find a label with text matching contact name under Favorites.
+
+        :param contact_name: Name of the contact, e.g. 'Fulano de Tal'.
+        :return: The label for the metching favorite.
+        :raises StateNotFoundError: If the contact_name is not found.
+
+        """
+        return self.get_contact_by_name(
+            contact_name,
+            parent_delegate_type='FavoriteDelegate')
+
+    @autopilot_logging.log_action(logger.info)
+    def click_contact_by_name(self,
+                              contact_name,
+                              parent_delegate_type='ContactDelegate'):
+        """Click a contact with label matching the given contact name.
+
+        :param contact_name: Name of a contact, e.g. 'Fulano de Tal'.
+        :param parent_delegate_type: 'ContactDelegate' or 'FavoriteDelegate'.
+        :raises StateNotFoundError: If the contact_name is not found.
+
+        """
+        contact_name_label = self.get_contact_by_name(
+            contact_name, parent_delegate_type)
+        self.pointing_device.click_object(contact_name_label)
+
+    @autopilot_logging.log_action(logger.info)
+    def open_contact_view_by_contact_name(self, contact_name):
+        """Open the contact view page for a contact with the given name.
+
+        :param contact_name: The name of the contact, e.g. 'Abe Lincoln'.
+        :return: The ContactView for the contact.
+        :raises StateNotFoundError: If the name is not found.
+
+        """
+        self.click_contact_by_name(contact_name)
+
+    @autopilot_logging.log_action(logger.info)
+    def click_favorite_by_name(self,
+                               contact_name):
+        """Click a favorite with label matching the given contact name.
+
+        :param contact_name: Name of a contact, e.g. 'Fulano de Tal'
+        :raises StateNotFoundError: If the contact_name is not found.
+
+        """
+        contact_name_label = self.get_favorite_by_name(
+            contact_name)
+        self.pointing_device.click_object(contact_name_label)
+
+    @autopilot_logging.log_action(logger.info)
+    def open_contact_view_by_favorite_name(self, favorite_name):
+        """Open the contact view page for a favorite with the given name.
+
+        :param favorite_name: The name of the favorite, e.g. 'Abe Lincoln'.
+        :return: The ContactView for the contact.
+        :raises StateNotFoundError: If the name is not found.
+
+        """
+        self.click_favorite_by_name(favorite_name)
+
+    @autopilot_logging.log_action(logger.info)
+    def click_phone_number(self, phone_number):
+        """Click a label matching the given phone number.
+
+        :param phone_number: A phone number, e.g. '3321 1232'.
+        :raises StateNotFoundError: If the phone_number is not found.
+
+        """
+        phone_number_label = self.wait_select_single('Label',
+                                                     text=phone_number)
+        self.pointing_device.click_object(phone_number_label)
+
+    def contact_is_favorite(self, name):
+        """Is the given contact name a favorite?
+
+        :param contact_name: The name of a contact e.g. John.
+        :raises StateNotFoundError: If the contact name is not found.
+        :returns: Boolean.
+
+        """
+        try:
+            self.get_favorite_by_name(name)
+            return True
+        except StateNotFoundError:
+            logger.error("Favorite contact {} not found.".format(name))
+            return False
 
=== added file 'tests/autopilot/address_book_app/emulators/contact_view.py'
--- tests/autopilot/address_book_app/emulators/contact_view.py	1970-01-01 00:00:00 +0000
+++ tests/autopilot/address_book_app/emulators/contact_view.py	2014-03-17 23:53:00 +0000
@@ -0,0 +1,94 @@
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+# Copyright 2014 Canonical
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+
+""" ContactView emulator for Addressbook App tests """
+
+import logging
+
+from autopilot import logging as autopilot_logging
+from autopilot.introspection.dbus import StateNotFoundError
+from ubuntuuitoolkit import emulators as uitk
+
+from address_book_app.emulators import get_nearest_parent_matching_type
+
+logger = logging.getLogger(__name__)
+
+
+class ContactView(uitk.UbuntuUIToolkitEmulatorBase):
+    """ContactView emulator class"""
+
+    def __init__(self, *args):
+        super(ContactView, self).__init__(*args)
+
+    @autopilot_logging.log_action(logger.info)
+    def click_button(self, objectname):
+        """Press a button that matches objectname.
+
+        :param objectname: The name of the object.
+        :raises StateNotFoundError: If the matching object is not found.
+
+        """
+        buttons = self.select_single("Button",
+                                     objectName=objectname,
+                                     visible=True)
+        self.pointing_device.click_object(button)
+
+    @autopilot_logging.log_action(logger.info)
+    def cancel(self):
+        """Press the cancel button displayed when pick mode is enabled."""
+        self.click_button("DialogButtons.rejectButton")
+
+    @autopilot_logging.log_action(logger.info)
+    def delete(self):
+        """Press the delete button displayed when pick mode is enabled."""
+        self.click_button("DialogButtons.acceptButton")
+        self.get_contacts()
+
+    def get_contact_detail_phone_number_view(self, phone_number):
+        """Returns the View associated with the given phone number.
+
+        :param phone_number: The number listed for contact, e.g. '8675309'.
+        :return: The matching view.
+        :raises StateNotFoundError: If the phone_number is not found.
+
+        """
+        phone_number_label = self.select_single('Label',
+                                                text=phone_number)
+        return get_nearest_parent_matching_type(
+            phone_number_label,
+            'ContactDetailPhoneNumberView')
+
+    def _star_is_illuminated_for_phone_number(self, phone_number):
+        """Is the star associated with the given phone number illuminated?
+
+        :param phone_number: The number listed for contact, e.g. '8675309'.
+        :return: A Boolean.
+        :raises StateNotFoundError: If the phone_number is not found.
+
+        """
+        contact_detail = self.get_contact_detail_phone_number_view(
+            phone_number)
+        return contact_detail.iconSource == 'artwork:/favorite-selected.svg'
+
+    @autopilot_logging.log_action(logger.info)
+    def click_phone_number(self, phone_number):
+        """Tap/click the label with text matching the given phone number.
+
+        :param phone_number: The number listed for contact, e.g. '8675309'.
+        :raises StateNotFoundError: If the phone_number is not found.
+
+        """
+        phone_number_label = self.wait_select_single('Label',
+                                                     text=phone_number)
+        self.pointing_device.click_object(phone_number_label)
+
+    @autopilot_logging.log_action(logger.info)
+    def click_favorite_icon(self):
+        """Tap/click on the favorite icon to make a contact favorite."""
+        favorite_icon = self.select_single('Icon', objectName='favoriteIcon')
+
+        self.pointing_device.click_object(favorite_icon)
 
=== modified file 'tests/autopilot/address_book_app/emulators/main_window.py'
--- tests/autopilot/address_book_app/emulators/main_window.py	2014-02-13 16:44:12 +0000
+++ tests/autopilot/address_book_app/emulators/main_window.py	2014-03-17 23:53:00 +0000
@@ -13,7 +13,7 @@
 
     def get_contact_list_page(self):
         return self. wait_select_single("ContactListPage",
-                                        objectName="contactListPage")
+                                       objectName="contactListPage")
 
     def get_contact_edit_page(self):
         return self.wait_select_single("ContactEditor",
@@ -35,7 +35,7 @@
         """
         Returns a ContactListView iobject for the current window
         """
-        return self.wait_select_single( "ContactListView",
+        return self.wait_select_single("ContactListView",
                                        objectName="contactListView")
 
     def get_button(self, name):
@@ -45,7 +45,7 @@
         Arguments:
             name: Name of the button
         """
-        return self.wait_select_single( "Button", objectName=name)
+        return self.wait_select_single("Button", objectName=name)
 
     def cancel(self):
         """
 
=== added file 'tests/autopilot/address_book_app/helpers.py'
--- tests/autopilot/address_book_app/helpers.py	1970-01-01 00:00:00 +0000
+++ tests/autopilot/address_book_app/helpers.py	2014-03-17 23:53:00 +0000
@@ -0,0 +1,55 @@
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+# Copyright 2014 Canonical
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+
+"""Utilities for the evolution contacts db."""
+
+import os
+import subprocess
+import tempfile
+
+
+def backup_evolution_contacts_db(backup_filepath=None):
+    """Back up the existing evolution contacts db to a file.
+
+    :param backup_filepath: file to which to write, if None make tmpfile.
+    :returns: backup filepath used.
+    """
+    if backup_filepath is None:
+        backup_filepath = tempfile.mktemp(suffix=".syncevolution")
+    subprocess.call([
+        'syncevolution',
+        '--export',
+        backup_filepath,
+        'backend=evolution-contacts',
+    ])
+    return backup_filepath
+
+
+def restore_evolution_contacts_db(backup_filepath):
+    """Restore the evolution contacts db from the backup.
+
+    :param backup_filepath: file from which to restore.
+    """
+    # NOTE restoring from empty file creates a phantom contact
+    if os.path.getsize(backup_filepath) > 0:
+        subprocess.call([
+            'syncevolution',
+            '--import',
+            backup_filepath,
+            'backend=evolution-contacts'
+        ])
+
+
+def wipe_evolution_contacts_db():
+    """Wipe the existing evolution contacts db clean of contacts."""
+    subprocess.call([
+        'syncevolution',
+        '--delete-items',
+        'backend=evolution-contacts',
+        '--luids',
+        '*',
+    ])
 
=== modified file 'tests/autopilot/address_book_app/tests/__init__.py'
--- tests/autopilot/address_book_app/tests/__init__.py	2014-01-30 08:35:04 +0000
+++ tests/autopilot/address_book_app/tests/__init__.py	2014-03-17 23:53:00 +0000
@@ -18,6 +18,9 @@
 from testtools.matchers import Equals
 
 from address_book_app.emulators.main_window import MainWindow
+from address_book_app.helpers import (backup_evolution_contacts_db,
+                                      restore_evolution_contacts_db,
+                                      wipe_evolution_contacts_db)
 from ubuntuuitoolkit import emulators as toolkit_emulators
 
 
@@ -31,6 +34,7 @@
     VCARD_PATH_DEV = os.path.abspath("../data/vcard.vcf")
     ARGS = []
     PRELOAD_VCARD = False
+    QTCONTACTS_MANAGER_OVERRIDE_MEMORY = True
 
     def setUp(self):
         self.pointing_device = toolkit_emulators.get_pointing_device()
@@ -40,13 +44,25 @@
         if model() != "Desktop":
             subprocess.check_call(["/sbin/initctl", "stop", "maliit-server"])
 
+        self.backup_filepath = backup_evolution_contacts_db()
+        wipe_evolution_contacts_db()
+
         if 'AUTOPILOT_APP' in os.environ:
             self.app_bin = os.environ['AUTOPILOT_APP']
         else:
             self.app_bin = AddressBookAppTestCase.DEFAULT_DEV_LOCATION
 
-        os.environ['QTCONTACTS_MANAGER_OVERRIDE'] = 'memory'
+        print "Running from: %s" % (self.app_bin)
+        # NOTE defeats favoriting: contacts don't show up in "Favorites" header
+        if AddressBookAppTestCase.QTCONTACTS_MANAGER_OVERRIDE_MEMORY:
+            os.environ['QTCONTACTS_MANAGER_OVERRIDE'] = 'memory'
+        else:
+            try:
+                del(os.environ['QTCONTACTS_MANAGER_OVERRIDE'])
+            except KeyError:
+                pass
         vcard_data = ""
+
         if AddressBookAppTestCase.PRELOAD_VCARD:
             # Use vcard from source tree and fallback on installed vcard (from
             #  address-book-app-autopilot package)
@@ -55,16 +71,16 @@
             else:
                 vcard_data = AddressBookAppTestCase.VCARD_PATH_BIN
 
-        os.environ["ADDRESS_BOOK_TEST_DATA"] = vcard_data
-        if vcard_data != "": print "Using vcard %s" % vcard_data
+        os.environ['ADDRESS_BOOK_TEST_DATA'] = vcard_data
+        if vcard_data != '': print 'Using vcard %s' % vcard_data
         if os.path.exists(self.app_bin):
-            print "Running from: %s" % (self.app_bin)
+            print 'Running from: %s' % (self.app_bin)
             self.launch_test_local()
         elif os.path.exists(self.DEB_LOCALTION):
-            print "Running from: %s" % (self.DEB_LOCALTION)
+            print 'Running from: %s' % (self.DEB_LOCALTION)
             self.launch_test_installed()
         else:
-            print "Running from click package: address-book-app"
+            print 'Running from click package: address-book-app'
             self.launch_click_installed()
 
         AddressBookAppTestCase.ARGS = []
@@ -73,6 +89,9 @@
 
     def tearDown(self):
         super(AddressBookAppTestCase, self).tearDown()
+        wipe_evolution_contacts_db()
+        restore_evolution_contacts_db(self.backup_filepath)
+        os.remove(self.backup_filepath)
 
         # start the vkb
         if model() != "Desktop":
 
=== modified file 'tests/autopilot/address_book_app/tests/test_add_contact.py'
--- tests/autopilot/address_book_app/tests/test_add_contact.py	2014-01-28 10:20:07 +0000
+++ tests/autopilot/address_book_app/tests/test_add_contact.py	2014-03-17 23:53:00 +0000
@@ -18,6 +18,10 @@
 class TestAddContact(AddressBookAppTestCase):
     """ Tests the Add contact """
 
+    def setUp(self):
+        AddressBookAppTestCase.QTCONTACTS_MANAGER_OVERRIDE_MEMORY = True
+        super(TestAddContact, self).setUp()
+
     def test_add_and_cancel_contact(self):
         list_page = self.main_window.get_contact_list_page()
 
 
=== modified file 'tests/autopilot/address_book_app/tests/test_contactlist.py'
--- tests/autopilot/address_book_app/tests/test_contactlist.py	2013-11-21 18:53:19 +0000
+++ tests/autopilot/address_book_app/tests/test_contactlist.py	2014-03-17 23:53:00 +0000
@@ -18,6 +18,10 @@
 class TestContactList(AddressBookAppTestCase):
     """Tests the contact list features"""
 
+    def setUp(self):
+        AddressBookAppTestCase.QTCONTACTS_MANAGER_OVERRIDE_MEMORY = True
+        super(TestContactList, self).setUp()
+
     def test_contact_list(self):
         contact_list = self.main_window.get_contact_list_page()
         self.assertThat(contact_list.visible, Eventually(Equals(True)))
 
=== modified file 'tests/autopilot/address_book_app/tests/test_delete_contact.py'
--- tests/autopilot/address_book_app/tests/test_delete_contact.py	2014-02-13 16:44:12 +0000
+++ tests/autopilot/address_book_app/tests/test_delete_contact.py	2014-03-17 23:53:00 +0000
@@ -40,6 +40,7 @@
     ]
 
     def setUp(self):
+        AddressBookAppTestCase.QTCONTACTS_MANAGER_OVERRIDE_MEMORY = True
         AddressBookAppTestCase.PRELOAD_VCARD = True
         super(TestDeleteSelectContact, self).setUp()
 
 
=== modified file 'tests/autopilot/address_book_app/tests/test_edit_contact.py'
--- tests/autopilot/address_book_app/tests/test_edit_contact.py	2014-01-28 10:20:07 +0000
+++ tests/autopilot/address_book_app/tests/test_edit_contact.py	2014-03-17 23:53:00 +0000
@@ -17,6 +17,10 @@
 class TestEditContact(AddressBookAppTestCase):
     """Tests edit a contact"""
 
+    def setUp(self):
+        AddressBookAppTestCase.QTCONTACTS_MANAGER_OVERRIDE_MEMORY = True
+        super(TestEditContact, self).setUp()
+
     def test_add_new_phone(self):
         self.add_contact("Fulano", "de Tal", ["3321 2300"])
         edit_page = self.edit_contact(0)
 
=== added file 'tests/autopilot/address_book_app/tests/test_favorites.py'
--- tests/autopilot/address_book_app/tests/test_favorites.py	1970-01-01 00:00:00 +0000
+++ tests/autopilot/address_book_app/tests/test_favorites.py	2014-03-17 23:53:00 +0000
@@ -0,0 +1,130 @@
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+# Copyright 2014 Canonical
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License version 3, as published
+# by the Free Software Foundation.
+
+"""Tests of favoriting contacts for the Addressbook App"""
+
+from __future__ import absolute_import
+
+import subprocess
+
+from autopilot.introspection.dbus import StateNotFoundError
+from autopilot.matchers import Eventually
+from testtools.matchers import Equals
+
+from address_book_app.tests import AddressBookAppTestCase
+
+import dbus
+
+DUMMY_BACKEND_ADDRESS = 'com.canonical.test.pim'
+
+
+class TestFavorite(AddressBookAppTestCase):
+    """Test for favoriting contacts"""
+
+    def setUp(self):
+        AddressBookAppTestCase.QTCONTACTS_MANAGER_OVERRIDE_MEMORY = False
+        AddressBookAppTestCase.PRELOAD_VCARD = True
+        self.ensure_dummy_service_backend_running()
+        super(TestFavorite, self).setUp()
+
+    def _set_contact_service_dummy_backend_environment_variables(self):
+        self.patch_environment(
+            'CANONICAL_PIN_SERVICE_NAME', DUMMY_BACKEND_ADDRESS
+        )
+        self.patch_environment(
+            'FOLKS_BACKEND_PATH', self._get_dummy_backend_so_location()
+        )
+        self.patch_environment('FOLKS_BACKENDS_ALLOWED', 'dummy')
+        self.patch_environment('FOLKS_PRIMARY_STORE', 'dummy')
+
+    def _get_dummy_backend_so_location(self):
+        output = subprocess.check_output(
+            [
+                'find', '/usr/lib', '-name', 'dummy.so'
+            ]).split()
+
+        if len(output) is 1:
+            return output[0]
+        elif len(output) > 1:
+            for path in output:
+                if 'address-book-service' in path:
+                    return path[0]
+        else:
+            raise RuntimeError(
+                'Dummy backend .so not found is address-book-service-dummy'
+                'installed ?'
+            )
+
+    def _get_address_book_service_binary_location(self):
+        output = subprocess.check_output(
+            [
+                'find', '/usr/lib', '-name', 'address-book-service'
+            ]).split()
+
+        for path in output:
+            if 'address-book-service/address-book-service' in path:
+                return path
+
+    def _start_service_dummy_backend(self):
+        self.service = subprocess.Popen(
+            [self._get_address_book_service_binary_location()]
+        )
+        self.addCleanup(self.service.kill)
+
+        self.assertThat(
+            lambda: self._is_dummy_backend_up(), Eventually(Equals(True))
+        )
+
+    def _is_dummy_backend_up(self):
+        interfaces = dbus.SessionBus().list_names()
+
+        return DUMMY_BACKEND_ADDRESS in interfaces
+
+    def ensure_dummy_service_backend_running(self):
+        self._set_contact_service_dummy_backend_environment_variables()
+        self._start_service_dummy_backend()
+
+    def _add_contact_as_favorite(self, name):
+        contact_list_page = self.main_window.get_contact_list_page()
+        contact_list_page.open_contact_view_by_contact_name(name)
+        contact_view = self.main_window.get_contact_view_page()
+        contact_view.click_favorite_icon()
+        self.main_window.go_back()
+
+        return contact_list_page
+
+    def test_add_favorite(self):
+        contact_list_page = self._add_contact_as_favorite('teste test34')
+
+        self.assertTrue(contact_list_page.contact_is_favorite('teste test34'))
+
+    def test_save_multiple_favorites(self):
+        contact_list_page = self._add_contact_as_favorite('teste test34')
+        self.assertTrue(contact_list_page.contact_is_favorite('teste test34'))
+
+        contact_list_page = self._add_contact_as_favorite('teste teste2')
+        self.assertTrue(contact_list_page.contact_is_favorite('teste teste2'))
+
+    def test_remove_favorite(self):
+        contact_list_page = self._add_contact_as_favorite('teste test34')
+        contact_list_page.open_contact_view_by_contact_name('teste test34')
+        contact_view = self.main_window.get_contact_view_page()
+        contact_view.click_favorite_icon()
+        self.main_window.go_back()
+        self.assertFalse(contact_list_page.contact_is_favorite('teste test34'))
+
+    def test_delete_favorite(self):
+        contact_list_page = self._add_contact_as_favorite('teste test34')
+        contact_list_page.click_favorite_by_name('teste test34')
+        toolbar = self.main_window.open_toolbar()
+        toolbar.click_button('delete')
+        self.assertRaises(
+            StateNotFoundError,
+            lambda: contact_list_page.get_favorite_by_name('teste test34'))
+        self.assertRaises(
+            StateNotFoundError,
+            lambda: contact_list_page.get_contact_by_name('teste test34'))
 
=== modified file 'tests/autopilot/address_book_app/tests/test_multiple_pick_mode.py'
--- tests/autopilot/address_book_app/tests/test_multiple_pick_mode.py	2013-12-13 19:31:33 +0000
+++ tests/autopilot/address_book_app/tests/test_multiple_pick_mode.py	2014-03-17 23:53:00 +0000
@@ -20,6 +20,7 @@
 
     def setUp(self):
         self.ARGS.append("addressbook:///pick?single=false")
+        AddressBookAppTestCase.QTCONTACTS_MANAGER_OVERRIDE_MEMORY = True
         AddressBookAppTestCase.PRELOAD_VCARD = True
         super(TestMultiplePickerMode, self).setUp()
 
 
=== modified file 'tests/autopilot/address_book_app/tests/test_single_pick_mode.py'
--- tests/autopilot/address_book_app/tests/test_single_pick_mode.py	2013-12-13 19:31:33 +0000
+++ tests/autopilot/address_book_app/tests/test_single_pick_mode.py	2014-03-17 23:53:00 +0000
@@ -21,6 +21,7 @@
     def setUp(self):
         AddressBookAppTestCase.ARGS.append("addressbook:///pick?single=true")
         AddressBookAppTestCase.PRELOAD_VCARD = True
+        AddressBookAppTestCase.QTCONTACTS_MANAGER_OVERRIDE_MEMORY = True
         super(TestSinglePickerMode, self).setUp()
 
     def test_select_single_contact(self):