Merge into trunk : abook_navigation_favorites : Code : address-book-app

Status:	Superseded
Proposed branch:	lp:~allanlesage/address-book-app/abook_navigation_favorites
Merge into:	lp:address-book-app
Prerequisite:	lp:~jibel/address-book-app/abook_delete_contact_pickmode
Diff against target:	908 lines (+712/-11) 16 files modified debian/control (+1/-0) tests/autopilot/address_book_app/emulators/__init__.py (+12/-0) tests/autopilot/address_book_app/emulators/address_book.py (+73/-0) tests/autopilot/address_book_app/emulators/contact_list_page.py (+201/-0) tests/autopilot/address_book_app/emulators/contact_view.py (+97/-0) tests/autopilot/address_book_app/emulators/main_window.py (+3/-5) tests/autopilot/address_book_app/emulators/toolbar.py (+38/-0) tests/autopilot/address_book_app/helpers.py (+55/-0) tests/autopilot/address_book_app/tests/__init__.py (+25/-6) tests/autopilot/address_book_app/tests/test_add_contact.py (+4/-0) tests/autopilot/address_book_app/tests/test_contactlist.py (+4/-0) tests/autopilot/address_book_app/tests/test_delete_contact.py (+72/-0) tests/autopilot/address_book_app/tests/test_edit_contact.py (+4/-0) tests/autopilot/address_book_app/tests/test_favorites.py (+121/-0) tests/autopilot/address_book_app/tests/test_multiple_pick_mode.py (+1/-0) tests/autopilot/address_book_app/tests/test_single_pick_mode.py (+1/-0)
To merge this branch:	bzr merge lp:~allanlesage/address-book-app/abook_navigation_favorites
Related bugs:	Link a bug report

Reviewer	Review Type	Date Requested	Status
Leo Arias (community)	code review		Approve on 2014-02-28
PS Jenkins bot	continuous-integration		Needs Fixing on 2014-02-27
Jean-Baptiste Lallement (community)		2014-02-06	Needs Fixing on 2014-02-13
Chris Gagnon (community)			Needs Fixing on 2014-02-11
Review via email: mp+205264@code.launchpad.net

lp:~allanlesage/address-book-app/abook_navigation_favorites updated on 2014-02-06

132. By Allan LeSage on 2014-02-06: Merged trunk.
133. By Allan LeSage on 2014-02-06: PEP8 and pyflakes corrections.
134. By Allan LeSage on 2014-02-06: Add a python-psutil dependency.

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-02-06:

#

FAILED: Continuous integration, rev:132
No commit message was specified in the merge proposal. Click on the following link and set the commit message (if you want a jenkins rebuild you need to trigger it yourself):
https://code.launchpad.net/~allanlesage/address-book-app/abook_navigation_favorites/+merge/205264/+edit-commit-message

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/address-book-app-ci/377/rebuild

review: Needs Fixing (continuous-integration)

Revision history for this message

Chris Gagnon (chris.gagnon) wrote on 2014-02-06:

#

The emulators all functions all need docstrings lp #137 is good example of how it should be done, but it's missing the raises.

134 + def get_contact_by_name(self,
135 + contact_name,
136 + parent_delegate_type='ContactDelegate'):
137 + """Find a label with text matching contact name.
138 +
139 + :param contact_name: Name of the contact, e.g. 'Fulano de Tal'
140 + :param parent_delegate_type: 'ContactDelegate' or 'FavoriteDelegate'
141 + :raises StateNotFoundError: if contact_name and parent_delegate_type is not found

I get this error on all the favorites tests

Traceback (most recent call last):
  File "/home/phablet/abook_navigation_favorites/tests/autopilot/address_book_app/tests/test_favorites.py", line 85, in test_switch_between_favorites
    list_page.click_contact_by_name('Beth Whittard')
  File "/usr/lib/python2.7/dist-packages/autopilot/introspection/dbus.py", line 523, in __getattr__
    (self.__class__.__name__, name))
AttributeError: Class 'ContactListPage' has no attribute 'click_contact_by_name'

review: Needs Fixing

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-02-07:

#

FAILED: Continuous integration, rev:134
No commit message was specified in the merge proposal. Click on the following link and set the commit message (if you want a jenkins rebuild you need to trigger it yourself):
https://code.launchpad.net/~allanlesage/address-book-app/abook_navigation_favorites/+merge/205264/+edit-commit-message

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/address-book-app-ci/379/rebuild

review: Needs Fixing (continuous-integration)

lp:~allanlesage/address-book-app/abook_navigation_favorites updated on 2014-02-07

135. By Allan LeSage on 2014-02-07: Resolve env prob which failed some favorites tests on transition from in-memory to faked db.

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-02-07:

#

FAILED: Continuous integration, rev:135
No commit message was specified in the merge proposal. Click on the following link and set the commit message (if you want a jenkins rebuild you need to trigger it yourself):
https://code.launchpad.net/~allanlesage/address-book-app/abook_navigation_favorites/+merge/205264/+edit-commit-message

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/address-book-app-ci/380/rebuild

review: Needs Fixing (continuous-integration)

Revision history for this message

Chris Gagnon (chris.gagnon) wrote on 2014-02-07:

#

There are a lot of pep8 issues in these tests, the ones that should be fixed in this MP are

test_favorites.py:94:80: E501 line too long (103 > 79 characters)
test_favorites.py:110:33: E203 whitespace before ':'
test_favorites.py:110:80: E501 line too long (82 > 79 characters)

review: Needs Fixing

Revision history for this message

Jean-Baptiste Lallement (jibel) wrote on 2014-02-10:

#

On an LXC container with all updates applied, I get the following error, maybe because a service is not running:
0:45:55.249 INFO globals:57 - ************************************************************
10:45:55.249 INFO globals:58 - Starting test address_book_app.tests.test_favorites.TestFavorite.test_save_multiple_favorites
10:45:55.249 ERROR content:49 - Could not add content object 'None' due to IO Error: [Errno 13] Permission denied: '/var/log/syslog'
10:45:55.333 INFO _launcher:152 - Launching process: ['/usr/bin/address-book-app', '-testability', '--desktop_file_hint=/usr/share/applications/address-book-app.desktop']
10:45:56.409 DEBUG dbus:431 - Selecting objects of type MainWindow with attributes: {}
10:45:56.630 DEBUG dbus:431 - Selecting objects of type MainWindow with attributes: {}
10:45:56.645 DEBUG dbus:431 - Selecting objects of type ContactListPage with attributes: {'objectName': 'contactListPage'}
10:45:56.679 DEBUG dbus:431 - Selecting objects of type Label with attributes: {'text': 'Beth Whittard'}
10:45:56.704 ERROR contact_list_page:114 - Contact Beth Whittard not found.
10:45:56.720 INFO _launcher:340 - waiting for process to exit.
10:45:56.720 INFO _launcher:266 - Killing process 9593
}}}

Traceback (most recent call last):
  File "/home/ubuntu/Touch/GapCoverage/src/abook_navigation_favorites/tests/autopilot/address_book_app/tests/test_favorites.py", line 70, in test_save_multiple_favorites
    list_page.click_contact_by_name('Beth Whittard')
  File "/home/ubuntu/Touch/GapCoverage/src/abook_navigation_favorites/tests/autopilot/address_book_app/emulators/contact_list_page.py", line 127, in click_contact_by_name
    contact_name, parent_delegate_type)
  File "/home/ubuntu/Touch/GapCoverage/src/abook_navigation_favorites/tests/autopilot/address_book_app/emulators/contact_list_page.py", line 112, in get_contact_by_name
    raise StateNotFoundError('Label')
StateNotFoundError: State not found for class 'Label'.

======================================

About jinja2, I'd remove the dependency on jinja2 because it forces the installation of a new package on the device and the logic is simple enough to be implemented with str.format() and standard string functions.

======================================

Data sample: Would it be possible to pre-load vcards instead of creating/updating contacts. contacts.db backup/restore and services restart adds a lot of complexity to the test and also requires an additional dependency on psutil.

On an LXC container with all updates applied, I get the following error, maybe because a service is not running:
0:45:55.249 INFO globals:57 - ************************************************************
10:45:55.249 INFO globals:58 - Starting test address_book_app.tests.test_favorites.TestFavorite.test_save_multiple_favorites
10:45:55.249 ERROR content:49 - Could not add content object 'None' due to IO Error: [Errno 13] Permission denied: '/var/log/syslog'
10:45:55.333 INFO _launcher:152 - Launching process: ['/usr/bin/address-book-app', '-testability', '--desktop_file_hint=/usr/share/applications/address-book-app.desktop']
10:45:56.409 DEBUG dbus:431 - Selecting objects of type MainWindow with attributes: {}
10:45:56.630 DEBUG dbus:431 - Selecting objects of type MainWindow with attributes: {}
10:45:56.645 DEBUG dbus:431 - Selecting objects of type ContactListPage with attributes: {'objectName': 'contactListPage'}
10:45:56.679 DEBUG dbus:431 - Selecting objects of type Label with attributes: {'text': 'Beth Whittard'}
10:45:56.704 ERROR contact_list_page:114 - Contact Beth Whittard not found.
10:45:56.720 INFO _launcher:340 - waiting for process to exit.
10:45:56.720 INFO _launcher:266 - Killing process 9593
}}}

Traceback (most recent call last):
  File "/home/ubuntu/Touch/GapCoverage/src/abook_navigation_favorites/tests/autopilot/address_book_app/tests/test_favorites.py", line 70, in test_save_multiple_favorites
    list_page.click_contact_by_name('Beth Whittard')
  File "/home/ubuntu/Touch/GapCoverage/src/abook_navigation_favorites/tests/autopilot/address_book_app/emulators/contact_list_page.py", line 127, in click_contact_by_name
    contact_name, parent_delegate_type)
  File "/home/ubuntu/Touch/GapCoverage/src/abook_navigation_favorites/tests/autopilot/address_book_app/emulators/contact_list_page.py", line 112, in get_contact_by_name
    raise StateNotFoundError('Label')
StateNotFoundError: State not found for class 'Label'.

======================================

About jinja2, I'd remove the dependency on jinja2 because it forces the installation of a new package on the device and the logic is simple enough to be implemented with str.format() and standard string functions.

======================================

Data sample: Would it be possible to pre-load vcards instead of creating/updating contacts. contacts.db backup/restore and services restart adds a lot of complexity to the test and also requires an additional dependency on psutil.

review: Needs Fixing

lp:~allanlesage/address-book-app/abook_navigation_favorites updated on 2014-02-10

136. By Allan LeSage on 2014-02-10: A fix for importing ContactList which broke individually-running tests.
137. By Allan LeSage on 2014-02-10: Added delete favorite test.

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-02-10:

#

FAILED: Continuous integration, rev:136
No commit message was specified in the merge proposal. Click on the following link and set the commit message (if you want a jenkins rebuild you need to trigger it yourself):
https://code.launchpad.net/~allanlesage/address-book-app/abook_navigation_favorites/+merge/205264/+edit-commit-message

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/address-book-app-ci/381/rebuild

review: Needs Fixing (continuous-integration)

lp:~allanlesage/address-book-app/abook_navigation_favorites updated on 2014-02-10

138. By Allan LeSage on 2014-02-10: Add assertion for deleted contact not in contacts.

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-02-10:

#

FAILED: Continuous integration, rev:138
No commit message was specified in the merge proposal. Click on the following link and set the commit message (if you want a jenkins rebuild you need to trigger it yourself):
https://code.launchpad.net/~allanlesage/address-book-app/abook_navigation_favorites/+merge/205264/+edit-commit-message

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/address-book-app-ci/382/rebuild

review: Needs Fixing (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-02-11:

#

FAILED: Continuous integration, rev:138
No commit message was specified in the merge proposal. Click on the following link and set the commit message (if you want a jenkins rebuild you need to trigger it yourself):
https://code.launchpad.net/~allanlesage/address-book-app/abook_navigation_favorites/+merge/205264/+edit-commit-message

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/address-book-app-ci/383/rebuild

review: Needs Fixing (continuous-integration)

Revision history for this message

Chris Gagnon (chris.gagnon) wrote on 2014-02-11:

#

The following should be moved into an emulator, maybe the 2 star is illuminated could moved in to one star_is_illuminated_for_number function that returns true or false depending on if the star is illuminated?

(tests/autopilot/address_book_app/tests/test_favorites.py)
+ def get_contact_detail_phone_number_view(self, phone_number):
+ phone_number_label = self.main_window.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):
+ contact_detail = self.get_contact_detail_phone_number_view(
+ phone_number)
+ return contact_detail.iconSource == 'artwork:/favorite-selected.svg'
+
+ def star_is_unilluminated_for_phone_number(self, phone_number):
+ contact_detail = self.get_contact_detail_phone_number_view(
+ phone_number)
+ return contact_detail.iconSource == 'artwork:/favorite-unselected.svg'
+
+ def click_phone_number(self, phone_number):
+ # TODO select_many and raise if > 1?
+ phone_number_label = self.main_window.wait_select_single(
+ 'Label',
+ text=phone_number)
+ self.pointing_device.click_object(phone_number_label)

review: Needs Fixing

lp:~allanlesage/address-book-app/abook_navigation_favorites updated on 2014-02-11

139. By Allan LeSage on 2014-02-11: Some pep8 and docstring fixes.

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-02-11:

#

FAILED: Continuous integration, rev:139
No commit message was specified in the merge proposal. Click on the following link and set the commit message (if you want a jenkins rebuild you need to trigger it yourself):
https://code.launchpad.net/~allanlesage/address-book-app/abook_navigation_favorites/+merge/205264/+edit-commit-message

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/address-book-app-ci/384/rebuild

review: Needs Fixing (continuous-integration)

lp:~allanlesage/address-book-app/abook_navigation_favorites updated on 2014-02-11

140. By Allan LeSage on 2014-02-11: Establish contact_view emulator, some massaging.

Revision history for this message

Chris Gagnon (chris.gagnon) wrote on 2014-02-11:

#

tests/autopilot/address_book_app/emulators/address_book.py needs docstrings like the contact list page emulator.

review: Needs Fixing

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-02-11:

#

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/address-book-app-ci/385/rebuild

review: Needs Fixing (continuous-integration)

lp:~allanlesage/address-book-app/abook_navigation_favorites updated on 2014-02-12

141. By Allan LeSage on 2014-02-12: Add missing contact_view emulator.

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-02-12:

#

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/address-book-app-ci/387/rebuild

review: Needs Fixing (continuous-integration)

lp:~allanlesage/address-book-app/abook_navigation_favorites updated on 2014-02-12

142. By Allan LeSage on 2014-02-12: Remove dependency on psutil.

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-02-12:

#

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/address-book-app-ci/389/rebuild

review: Needs Fixing (continuous-integration)

lp:~allanlesage/address-book-app/abook_navigation_favorites updated on 2014-02-12

143. By Allan LeSage on 2014-02-12: Remove jinja2 dependency, transform vcard template to string.

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-02-12:

#

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/address-book-app-ci/393/rebuild

review: Needs Fixing (continuous-integration)

lp:~allanlesage/address-book-app/abook_navigation_favorites updated on 2014-02-12

144. By Allan LeSage on 2014-02-12: Add proper docstrings to address_book emulator.
145. By Allan LeSage on 2014-02-12: Temp commit of contacts-db-wiping for ChrisGagnon's perusal.

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-02-12:

#

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/address-book-app-ci/394/rebuild

review: Needs Fixing (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-02-12:

#

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/address-book-app-ci/395/rebuild

review: Needs Fixing (continuous-integration)

lp:~allanlesage/address-book-app/abook_navigation_favorites updated on 2014-02-12

146. By Allan LeSage on 2014-02-12: New helper uses syncevolution to manipulate contacts db.

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-02-13:

#

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/address-book-app-ci/396/rebuild

review: Approve (continuous-integration)

Revision history for this message

Jean-Baptiste Lallement (jibel) wrote on 2014-02-13:

#

1. You need to add syncevolution as a dependency of address-book-app-autopilot otherwise the test will fail on desktop. syncevolution is only a dependency ubuntu-touch which is not installed on desktop.

2. On desktop I always get this failure
11:53:00.053 INFO globals:58 - Starting test address_book_app.tests.test_favorites.TestFavorite.test_save_multiple_favorites
11:53:00.054 ERROR content:49 - Could not add content object 'None' due to IO Error: [Errno 13] Permission denied: '/var/log/syslog'
11:53:00.240 INFO _launcher:152 - Launching process: ['/usr/bin/address-book-app', '-testability', '--desktop_file_hint=/usr/share/applications/address-book-app.desktop']
11:53:01.314 DEBUG dbus:431 - Selecting objects of type MainWindow with attributes: {}
11:53:01.533 DEBUG dbus:431 - Selecting objects of type MainWindow with attributes: {}
11:53:01.548 DEBUG dbus:431 - Selecting objects of type ContactListPage with attributes: {'objectName': 'contactListPage'}
11:53:01.576 DEBUG dbus:431 - Selecting objects of type Label with attributes: {'text': 'Beth Whittard'}
11:53:01.593 ERROR contact_list_page:114 - Contact Beth Whittard not found.
11:53:02.893 INFO _launcher:340 - waiting for process to exit.
11:53:02.893 INFO _launcher:266 - Killing process 7151
}}}

Traceback (most recent call last):
  File "/home/ubuntu/Touch/GapCoverage/src/abook/ale.abook_navigation_favorites.205264/tests/autopilot/address_book_app/tests/test_favorites.py", line 50, in test_save_multiple_favorites
    contact_list_page.click_contact_by_name('Beth Whittard')
  File "/home/ubuntu/Touch/GapCoverage/src/abook/ale.abook_navigation_favorites.205264/tests/autopilot/address_book_app/emulators/contact_list_page.py", line 137, in click_contact_by_name
    contact_name, parent_delegate_type)
  File "/home/ubuntu/Touch/GapCoverage/src/abook/ale.abook_navigation_favorites.205264/tests/autopilot/address_book_app/emulators/contact_list_page.py", line 112, in get_contact_by_name
    raise StateNotFoundError('Label')
StateNotFoundError: State not found for class 'Label'.

1. You need to add syncevolution as a dependency of address-book-app-autopilot otherwise the test will fail on desktop. syncevolution is only a dependency ubuntu-touch which is not installed on desktop.

2. On desktop I always get this failure
11:53:00.053 INFO globals:58 - Starting test address_book_app.tests.test_favorites.TestFavorite.test_save_multiple_favorites
11:53:00.054 ERROR content:49 - Could not add content object 'None' due to IO Error: [Errno 13] Permission denied: '/var/log/syslog'
11:53:00.240 INFO _launcher:152 - Launching process: ['/usr/bin/address-book-app', '-testability', '--desktop_file_hint=/usr/share/applications/address-book-app.desktop']
11:53:01.314 DEBUG dbus:431 - Selecting objects of type MainWindow with attributes: {}
11:53:01.533 DEBUG dbus:431 - Selecting objects of type MainWindow with attributes: {}
11:53:01.548 DEBUG dbus:431 - Selecting objects of type ContactListPage with attributes: {'objectName': 'contactListPage'}
11:53:01.576 DEBUG dbus:431 - Selecting objects of type Label with attributes: {'text': 'Beth Whittard'}
11:53:01.593 ERROR contact_list_page:114 - Contact Beth Whittard not found.
11:53:02.893 INFO _launcher:340 - waiting for process to exit.
11:53:02.893 INFO _launcher:266 - Killing process 7151
}}}

Traceback (most recent call last):
  File "/home/ubuntu/Touch/GapCoverage/src/abook/ale.abook_navigation_favorites.205264/tests/autopilot/address_book_app/tests/test_favorites.py", line 50, in test_save_multiple_favorites
    contact_list_page.click_contact_by_name('Beth Whittard')
  File "/home/ubuntu/Touch/GapCoverage/src/abook/ale.abook_navigation_favorites.205264/tests/autopilot/address_book_app/emulators/contact_list_page.py", line 137, in click_contact_by_name
    contact_name, parent_delegate_type)
  File "/home/ubuntu/Touch/GapCoverage/src/abook/ale.abook_navigation_favorites.205264/tests/autopilot/address_book_app/emulators/contact_list_page.py", line 112, in get_contact_by_name
    raise StateNotFoundError('Label')
StateNotFoundError: State not found for class 'Label'.

review: Needs Fixing

Revision history for this message

Jean-Baptiste Lallement (jibel) wrote on 2014-02-13:

#

For the StateNotFoundError, I tried this patch and it seems to be working.

'=== modified file 'tests/autopilot/address_book_app/emulators/contact_list_page.py'
'--- tests/autopilot/address_book_app/emulators/contact_list_page.py 2014-02-11 21:15:02 +0000
'+++ tests/autopilot/address_book_app/emulators/contact_list_page.py 2014-02-13 12:11:56 +0000
'@@ -100,9 +100,18 @@
' :raises StateNotFoundError: if contact_name is not found
' """
' try:
'- contact_name_labels = self.select_many(
'- "Label",
'- text=contact_name)
'+ # Note:
'+ # There is no wait_select_many, this loop simulates it and retries
'+ # 3 times or until the list is populated. If the list is still
'+ # empty after the loop, the exception StateNotFoundError('Label')
'+ # will be raised
'+ for i in range(3):
'+ contact_name_labels = self.select_many(
'+ "Label",
'+ text=contact_name)
'+ if contact_name_labels != []:
'+ break
'+ sleep(.5)
' for contact_name_label in contact_name_labels:
' # we could have a contact or a favorite
' if get_nearest_parent_matching_type(

Revision history for this message

Jean-Baptiste Lallement (jibel) wrote on 2014-02-13:

#

nicer version: http://paste.ubuntu.com/6925222/

lp:~allanlesage/address-book-app/abook_navigation_favorites updated on 2014-02-13

147. By Allan LeSage on 2014-02-13: Use Eventually matcher to assert contacts are returned by name.

Revision history for this message

Renato Araujo Oliveira Filho (renatofilho) wrote on 2014-02-13:

#

I do not think this is the right approach, you should populate the vcard contact with some favorite contacts, this will allow you to test the functionality without touch on EDS.

Revision history for this message

Leo Arias (elopio) wrote on 2014-02-13:

#

Download full text (4.1 KiB)

55 +# Borrowed the following helper class from
56 +# lp:address-book-service/examples/contacts.py

Wouldn't it be better if this is packaged and made available as address-book-services test helpers? That way the code is on the same project that provides the service and we don't have to duplicate it. Is that possible?
This is not a blocker for this branch, just part of my ranting about developers not writing anything for testability, and we covering for their faults.

=== added file 'tests/autopilot/address_book_app/emulators/address_book.py'

I'd say this file needs unit test. With the query method we have all we need to check that the other methods are working correctly.

258 + # TODO select_many and raise if > 1?

wait_select_single will raise an exception if there's more than one item matching, so I think that's already covered. Unless I didn't get the comment.

299 + try:
300 + buttons = self.select_many("Button",
301 + objectName=objectname)
302 + for button in buttons:
303 + if button.visible:
304 + self.pointing_device.click_object(button)
305 + except StateNotFoundError:
306 + LOGGER.error(
307 + 'Button with objectName "{0}" not found.'.format(objectname)
308 + )
309 + raise

Please note that you are not breaking out of the for loop, so if there are many visible buttons, all of them will be clicked. That doesn't sound like the goal of this method.

I find this weird, as the purpose of the object name is to identify things uniquely. So if there are many buttons with the same name, we need to change the name.
This code could be simplified like this:
self.select_single('Button', objectName=object_name, visible=True)

That will raise an exception if there's no button with that name, if the button with that name is not visible, and if there are many buttons matching the query.

332 + def star_is_illuminated_for_phone_number(self, phone_number):

I think we should keep a higher language, closer to the design user stories. From a user perspective, a illuminated starts means that the phone number is favorite, so I would do this:

def is_phone_favorite(self, phone_number):
self._is_star_illuminated_for_phone_number(phone_number)

That way we keep as private the implementation detail, and on the tests we call the public higher level method that is more likely to remain stable. If in the future design decides to change the widget of a favorite number from a start to a drop down list, we don't have to change any tests, just the method we call inside is_phone_favorite.

576 + contact_list_page.click_contact_by_name('Fulano de Tal')
577 + contact_view = self.main_window.get_contact_view_page()

Here again, clicking a contact is actually an implementation details and it would be better as a private method in the emulator.
I prefer when the test reads like this:

contact_view = contact_list_page.open_contact_details(name='Fulano de Tal')

There's a nice selenium pattern called the page object: https://code.google.com/p/selenium/wiki/PageObjects
You might find it interesting to read. Not everything in there applies to the desktop, but some things do and I always try to follow them.

I find this as the most concise guide to avoid future pains with...

55	+# Borrowed the following helper class from
56	+# lp:address-book-service/examples/contacts.py

Wouldn't it be better if this is packaged and made available as address-book-services test helpers? That way the code is on the same project that provides the service and we don't have to duplicate it. Is that possible?
This is not a blocker for this branch, just part of my ranting about developers not writing anything for testability, and we covering for their faults.

=== added file 'tests/autopilot/address_book_app/emulators/address_book.py'

I'd say this file needs unit test. With the query method we have all we need to check that the other methods are working correctly.

258	+ # TODO select_many and raise if > 1?

wait_select_single will raise an exception if there's more than one item matching, so I think that's already covered. Unless I didn't get the comment.

299	+ try:
300	+ buttons = self.select_many("Button",
301	+ objectName=objectname)
302	+ for button in buttons:
303	+ if button.visible:
304	+ self.pointing_device.click_object(button)
305	+ except StateNotFoundError:
306	+ LOGGER.error(
307	+ 'Button with objectName "{0}" not found.'.format(objectname)
308	+ )
309	+ raise

Please note that you are not breaking out of the for loop, so if there are many visible buttons, all of them will be clicked. That doesn't sound like the goal of this method.

I find this weird, as the purpose of the object name is to identify things uniquely. So if there are many buttons with the same name, we need to change the name.
This code could be simplified like this:
self.select_single('Button', objectName=object_name, visible=True)

That will raise an exception if there's no button with that name, if the button with that name is not visible, and if there are many buttons matching the query.

332	+ def star_is_illuminated_for_phone_number(self, phone_number):

I think we should keep a higher language, closer to the design user stories. From a user perspective, a illuminated starts means that the phone number is favorite, so I would do this:

def is_phone_favorite(self, phone_number):
    self._is_star_illuminated_for_phone_number(phone_number)

That way we keep as private the implementation detail, and on the tests we call the public higher level method that is more likely to remain stable. If in the future design decides to change the widget of a favorite number from a start to a drop down list, we don't have to change any tests, just the method we call inside is_phone_favorite.

576	+ contact_list_page.click_contact_by_name('Fulano de Tal')
577	+ contact_view = self.main_window.get_contact_view_page()

Here again, clicking a contact is actually an implementation details and it would be better as a private method in the emulator.
I prefer when the test reads like this:

contact_view = contact_list_page.open_contact_details(name='Fulano de Tal')

There's a nice selenium pattern called the page object: https://code.google.com/p/selenium/wiki/PageObjects
You might find it interesting to read. Not everything in there applies to the desktop, but some things do and I always try to follow them.

I find this as the most concise guide to avoid future pains with user acceptance testing:
    The public methods represent the services that the page offers
    Try not to expose the internals of the page
    Generally don't make assertions
    Methods return other PageObjects
    Need not represent an entire page
    Different results for the same action are modelled as different methods

Please add the log_action decorators to all the public methods of the emulators that represent a user action, like cancel and delete. This will leave a trace of what the "user" is doing, that will look like a specification for manual testing. Really useful when trying to reproduce a failure manually. Here's a nice example of how we are using it:
http://bazaar.launchpad.net/~ubuntu-sdk-team/ubuntu-ui-toolkit/trunk/view/head:/tests/autopilot/ubuntuuitoolkit/emulators.py

And one small pita detail, please be consistent on how you use 'strings' or "strings". I prefer the single quote, but as long as it's consistent, anyone is ok.

review: Needs Fixing (code review)

lp:~allanlesage/address-book-app/abook_navigation_favorites updated on 2014-02-13

148. By Allan LeSage on 2014-02-13: Merged trunk, resolving conflicts (test passing).

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-02-13:

#

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/address-book-app-ci/398/rebuild

review: Needs Fixing (continuous-integration)

Revision history for this message

Renato Araujo Oliveira Filho (renatofilho) wrote on 2014-02-13:

#

Instead of adding contacts on the address-book-service. We should fix the in-memory backend to support favorite contacts.

We will go back to this MR, as soon as this bug get fixed: https://bugs.launchpad.net/bugs/1279916

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-02-13:

#

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/address-book-app-ci/399/rebuild

review: Approve (continuous-integration)

Revision history for this message

Chris Gagnon (chris.gagnon) wrote on 2014-02-14:

#

holding back on this MP until a bug is fixed is blocking other apps from landing tests. like the dialer and the messaging-app. When the in-memory backend is fixed we can change the helper to use it instead of using the address-book-service.

We want one place to add and remove contacts, so we don't have to update every project when there is a change. the address-book-app is the most logical place to keep the helper.

The tests are working currently, there is no reason to block landing the tests from landing.

lp:~allanlesage/address-book-app/abook_navigation_favorites updated on 2014-02-18

149. By Allan LeSage on 2014-02-18: Add some unit tests for our address_book emulator, removing any speculative functionality ;) .

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-02-18:

#

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/address-book-app-ci/406/rebuild

review: Needs Fixing (continuous-integration)

lp:~allanlesage/address-book-app/abook_navigation_favorites updated on 2014-02-18

150. By Allan LeSage on 2014-02-18: After discussing with thomi and elopio, in the interest of landing, remove unit tests for autopilot emulators.

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-02-19:

#

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/address-book-app-ci/408/rebuild

review: Approve (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-02-19:

#

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/address-book-app-ci/409/rebuild

review: Needs Fixing (continuous-integration)

lp:~allanlesage/address-book-app/abook_navigation_favorites updated on 2014-02-20

151. By Allan LeSage on 2014-02-20: Restore address_book emulator, some important quotation-mark changes per elopio.
152. By Allan LeSage on 2014-02-20: Actually restore address_book emulator :/ , remove emulators tests to expedite landing.

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-02-20:

#

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/address-book-app-ci/418/rebuild

review: Needs Fixing (continuous-integration)

Revision history for this message

Renato Araujo Oliveira Filho (renatofilho) wrote on 2014-02-26:

#

Could you guys try to use this service branch: https://code.launchpad.net/~renatofilho/address-book-service/dummy-mode/+merge/208459, to test this functionality?

And instead of adding the contacts direct in the server could you add it using vcard files? this will make the test more flexible in case of we change the server API.

Revision history for this message

Renato Araujo Oliveira Filho (renatofilho) wrote on 2014-02-26:

#

A MR to refactory the contact and favorite list is in progress to get merged, we should adapt the test to this new layout.

https://code.launchpad.net/~renatofilho/address-book-app/new-favorite-list/+merge/208223

lp:~allanlesage/address-book-app/abook_navigation_favorites updated on 2014-02-27

153. By Allan LeSage on 2014-02-27: Merge trunk.

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-02-27:

#

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/address-book-app-ci/429/rebuild

review: Approve (continuous-integration)

lp:~allanlesage/address-book-app/abook_navigation_favorites updated on 2014-02-27

154. By Allan LeSage on 2014-02-27: Docstring improvements and add autopilot action logger to emulators.

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-02-27:

#

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/address-book-app-ci/430/rebuild

review: Approve (continuous-integration)

lp:~allanlesage/address-book-app/abook_navigation_favorites updated on 2014-02-27

155. By Allan LeSage on 2014-02-27: Adopt page pattern per elopio's suggestion.
156. By Allan LeSage on 2014-02-27: Simplify emulators' click_button per elopio's request.

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-02-27:

#

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/address-book-app-ci/431/rebuild

review: Approve (continuous-integration)

Revision history for this message

PS Jenkins bot (ps-jenkins) wrote on 2014-02-27:

#

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/address-book-app-ci/432/rebuild

review: Needs Fixing (continuous-integration)

Revision history for this message

Allan LeSage (allanlesage) wrote on 2014-02-27:

#

Ready for review again, ubuntu-qa.

Concerning quotation marks for strings, I've straightened out for this commit (leaving triple-double-quotation-marks docstrings as-is), also added the log-action decorators.

Implemented the page pattern as elopio describes, thanks for that advice--formerly I've tried to keep the test-descriptions as stupid as possible, i.e. responding to visual stimulus, however I see the utility of separating the intention of the user from the visual implementation. Stashed the 'concise guide' for future reference :) .

Adjusted the simple selection singled out, removed an obsolete TODO.

elopio and I discussed adding unit tests with Thomi in Oakland, agreed that it'll be a good thing but exempted this MP (if we've changed our minds I can recover the tests I wrote for this emulator).

Lastly I've moved some of the emulator goodness to a 'helpers.py' file (although the packaging of this is opaque to me).

Revision history for this message

Leo Arias (elopio) wrote on 2014-02-28:

#

37 +#!/usr/bin/env python

I think you don't need this, as this file will never be executed as a script.

190 + @autopilot_logging.log_action(logger.info)

This log is unnecessary, as you you are already logging the action when calling cancel or delete.
What I would do is turn this:

191 + def click_button(self, objectname):

into _click_button, so we know it shouldn't be used outside the class. If we need to click another button, we will need to create a method for it.

214 + def get_contact_by_name(self,

I would rename this to _get_contact_label_by_name.
With the current name, it sounds like something that a test would call to get the text inside the label showing the contact name.

238 + raise StateNotFoundError('Label')
239 + except StateNotFoundError:
240 + logger.error('...')
241 + raise

I would prefer here to return our own exception, to differentiate it from something that autopilot throws.

Something like:
raise AddressBookError('Contact {} not found.'.format(contact_name))

I don't want to delay your branch anymore. It's already really nice. I have some comments that I think would make it a little more readable, but I'll make a note to discuss with you about them next week.

Thanks a lot, nice work.

review: Approve (code review)

Revision history for this message

Allan LeSage (allanlesage) wrote on 2014-02-28:

#

Thanks elopio for your review; I'll adapt some of your further suggestions after I've sorted renato's new address-book method, stay tuned. . . .

address-book-app

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

Commit message

Description of the change

Unmerged revisions

Preview Diff

Subscribers

 === modified file 'debian/control'
 --- debian/control	2013-12-11 15:03:32 +0000
 +++ debian/control	2014-02-27 22:11:08 +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 '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-02-27 22:11:08 +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
 === added file 'tests/autopilot/address_book_app/emulators/address_book.py'
 --- tests/autopilot/address_book_app/emulators/address_book.py	1970-01-01 00:00:00 +0000
 +++ tests/autopilot/address_book_app/emulators/address_book.py	2014-02-27 22:11:08 +0000
@@ -0,0 +1,73 @@
++#!/usr/bin/env python
++# -*- encoding: utf-8 -*-
++#
++#  Copyright 2014 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'
++
++TEL_WORK_TEMPLATE = """
++TEL;TYPE=WORK,VOICE;PID=1.1:{tel_work}"""
++
++VCARD_TEMPLATE = """BEGIN:VCARD
++VERSION:3.0
++N:{name}
++FN:{f_name}
++TEL;TYPE=HOME,VOICE;PID=1.1:{tel_home}{tel_work}
++END:VCARD
++"""
++
++
++class AddressBook(object):
++
++    def __init__(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 create_contact(self,
++                       name,
++                       f_name=None,
++                       tel_home=None,
++                       tel_work=None,
++                       email=None):
++        """Create a contact in address-book via dbus interface.
++
++        NOTE that if only one phone number is specified, it must be tel_home.
++
++        :param name: name of the contact, e.g. 'Lincoln;Abraham'
++        :param f_name: formatted name of the contact, e.g. 'Abraham Lincoln'
++        :param tel_home: telephone number string, e.g. '92340981'
++        :param tel_work: telephone number string, e.g. '23984719'
++        :param email: e-mail address string, e.g. 'abe@whitehouse.gov'
++        """
++        contact_dict = {
++            'name': name,
++            'f_name': f_name if f_name else '',
++            'tel_home': tel_home if tel_home else '',
++            'tel_work': TEL_WORK_TEMPLATE.format(
++                tel_work=tel_work) if tel_work else '',
++            'email': email if email else ''
++        }
++        vcard = VCARD_TEMPLATE.format(**contact_dict)
++        return self.addr_iface.createContact(vcard, "")
 === added file 'tests/autopilot/address_book_app/emulators/contact_list_page.py'
 --- tests/autopilot/address_book_app/emulators/contact_list_page.py	1970-01-01 00:00:00 +0000
 +++ tests/autopilot/address_book_app/emulators/contact_list_page.py	2014-02-27 22:11:08 +0000
@@ -0,0 +1,201 @@
++# -*- 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.
++
++""" 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
++
++from address_book_app.emulators import get_nearest_parent_matching_type
++
++logger = logging.getLogger(__name__)
++
++
++class ContactListPage(uitk.UbuntuUIToolkitEmulatorBase):
++    """ ContactListPage emulator class """
++
++    def __init__(self, *args):
++        self.contacts = None
++        self.selection_marks = []
++        self.selected_marks = []
++        super(ContactListPage, self).__init__(*args)
++
++    def get_contacts(self):
++        """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")
++        self.selection_marks = []
++        for contact in self.contacts:
++            if contact.visible:
++                mark = contact.select_single("QQuickRectangle",
++                                             objectName="selectionMark")
++            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 integer indices of contacts to select.
++
++        """
++        self.deselect_all()
++
++        # Select matching indices
++        for idx in indices:
++            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 contact."""
++        contacts = self.select_many("ContactDelegate")
++        self.selected_marks = []
++        for contact in contacts:
++            if contact.selected:
++                mark = contact.select_single("QQuickRectangle",
++                                             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: The name of the object.
++        :raise StateNotFoundError: When a matching button 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_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)
 === 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-02-27 22:11:08 +0000
@@ -0,0 +1,97 @@
++# -*- 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)
++
++    def phone_number_is_favorite(self, phone_number):
++        """Is the given phone number a favorite?
++
++        :param phone_number: A phone number, e.g. '8675309'.
++        :raises StateNotFoundError: If the phone number is not found.
++        :returns: Boolean.
++
++        """
++        return self._star_is_illuminated_for_phone_number(phone_number)
 === modified file 'tests/autopilot/address_book_app/emulators/main_window.py'
 --- tests/autopilot/address_book_app/emulators/main_window.py	2014-01-28 10:20:07 +0000
 +++ tests/autopilot/address_book_app/emulators/main_window.py	2014-02-27 22:11:08 +0000
@@ -1,5 +1,5 @@
  # -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
--# Copyright 2013 Canonical
++# 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
@@ -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):
@@ -58,5 +58,3 @@
          Press the 'Save' button
          """
          self.pointing_device.click_object(self.get_button("accept"))
--
--
 === added file 'tests/autopilot/address_book_app/emulators/toolbar.py'
 --- tests/autopilot/address_book_app/emulators/toolbar.py	1970-01-01 00:00:00 +0000
 +++ tests/autopilot/address_book_app/emulators/toolbar.py	2014-02-27 22:11:08 +0000
@@ -0,0 +1,38 @@
++# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
++
++""" Toolbar emulator for Addressbook App tests """
++
++# Copyright 2013 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.
++from autopilot.introspection.dbus import StateNotFoundError
++import logging
++from ubuntuuitoolkit import emulators as toolkit_emulators
++
++logger = logging.getLogger(__name__)
++
++
++class Toolbar(toolkit_emulators.Toolbar):
++    """An emulator class that makes it easy to interact with the tool bar"""
++    def __init__(self, *args):
++        super(Toolbar, self).__init__(*args)
++
++    def click_action_item_by_text(self, text):
++        """Click an action item in the tool labelled 'text'
++
++        :param text: label of the ActionItem
++        """
++        try:
++            action_item = self.select_single('ActionItem', text=text)
++            self.pointing_device.click_object(action_item)
++        except StateNotFoundError:
++            logger.error(
++                'ActionItem with text "{0}" not found.'.format(text)
++            )
++            raise
++
++    def click_select(self):
++        """Press 'Select' button on the toolbar"""
++        self.click_action_item_by_text("Select")
 === 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-02-27 22:11:08 +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-02-27 22:11:08 +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-02-27 22:11:08 +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-02-27 22:11:08 +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)))
 === added file 'tests/autopilot/address_book_app/tests/test_delete_contact.py'
 --- tests/autopilot/address_book_app/tests/test_delete_contact.py	1970-01-01 00:00:00 +0000
 +++ tests/autopilot/address_book_app/tests/test_delete_contact.py	2014-02-27 22:11:08 +0000
@@ -0,0 +1,72 @@
++# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
++
++"""Tests for the Addressbook App"""
++
++# 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.
++from __future__ import absolute_import
++
++from testtools.matchers import Equals
++
++from address_book_app.tests import AddressBookAppTestCase
++from address_book_app.emulators.contact_list_page import ContactListPage
++from address_book_app.emulators.toolbar import Toolbar
++
++
++class TestDeleteSelectContact(AddressBookAppTestCase):
++    """
++    Delete a contact using pick mode and verify the behavior of Cancel and
++    Delete actions
++    """
++    scenarios = [
++        ("single_cancel", {
++            "select": [1],
++            "action": "cancel"}),
++        ("multiple_cancel", {
++            "select": [1, 2],
++            "action": "cancel"}),
++        ("none_delete", {
++            "select": [],
++            "action": "delete"}),
++        ("single_delete", {
++            "select": [1],
++            "action": "delete"}),
++        ("multiple_delete", {
++            "select": [1, 2],
++            "action": "delete"}),
++    ]
++
++    def setUp(self):
++        AddressBookAppTestCase.QTCONTACTS_MANAGER_OVERRIDE_MEMORY = True
++        AddressBookAppTestCase.PRELOAD_VCARD = True
++        super(TestDeleteSelectContact, self).setUp()
++
++    def test_select(self):
++        """
++        Delete a contact in pick mode
++
++        This test switch the contact list view to pick mode and validate the
++        behavior of Cancel and delete actions by comparing the numbers of
++        contact in the list before and after the action.
++        Note that it doesn't check which contact has been deleted.
++        """
++        self.main_window.open_toolbar().click_select()
++        listpage = self.main_window.get_contact_list_page()
++        contacts_before = listpage.get_contacts()
++
++        listpage.select_contacts_by_index(self.select)
++        deleted = []
++        if self.action == "cancel":
++            listpage.cancel()
++        elif self.action == "delete":
++            listpage.delete()
++            deleted = self.select
++
++        contacts_after = listpage.get_contacts()
++        # TODO:
++        #   - Verify which contact have been deleted
++        self.assertThat(len(contacts_after), Equals(len(contacts_before) -
++                                                    len(deleted)))
 === 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-02-27 22:11:08 +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-02-27 22:11:08 +0000
@@ -0,0 +1,121 @@
++# -*- 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
++
++from autopilot.introspection.dbus import StateNotFoundError
++
++from address_book_app.tests import AddressBookAppTestCase
++from address_book_app.emulators import get_nearest_parent_matching_type
++from address_book_app.emulators.contact_list_page import ContactListPage
++from address_book_app.emulators.contact_view import ContactView
++from address_book_app.emulators.address_book import AddressBook
++
++
++class TestFavorite(AddressBookAppTestCase):
++    """Test for favoriting contacts"""
++
++    def setUp(self):
++        AddressBookAppTestCase.QTCONTACTS_MANAGER_OVERRIDE_MEMORY = False
++        super(TestFavorite, self).setUp()
++        self.address_book = AddressBook()
++
++    def test_add_favorite(self):
++        self.address_book.create_contact(
++            name='de Tal;Fulano',
++            tel_home='3321 2300')
++        contact_list_page = self.main_window.get_contact_list_page()
++        contact_list_page.open_contact_view_by_contact_name('Fulano de Tal')
++        contact_view = self.main_window.get_contact_view_page()
++        contact_view.click_phone_number('3321 2300')
++        self.assertTrue(
++            contact_view.phone_number_is_favorite('3321 2300'))
++        self.main_window.go_back()
++        self.assertTrue(contact_list_page.get_favorite_by_name('Fulano de Tal'))
++
++    def test_save_multiple_favorites(self):
++        self.address_book.create_contact(
++            name=';Andrew',
++            tel_home='3321 2300')
++        self.address_book.create_contact(
++            name='Whittard;Beth',
++            tel_home='8675309')
++        contact_list_page = self.main_window.get_contact_list_page()
++        contact_list_page.click_contact_by_name('Beth Whittard')
++        contact_view = self.main_window.get_contact_view_page()
++        contact_view.click_phone_number('8675309')
++        self.main_window.go_back()
++        self.assertIsNotNone(contact_list_page.get_favorite_by_name('Beth Whittard'))
++        contact_list_page.click_contact_by_name('Andrew')
++        contact_view = self.main_window.get_contact_view_page()
++        contact_view.click_phone_number('3321 2300')
++        self.main_window.go_back()
++        self.assertIsNotNone(contact_list_page.get_favorite_by_name('Andrew'))
++
++    def test_switch_between_favorites(self):
++        self.address_book.create_contact(
++            name='Whittard;Beth',
++            tel_home='8675309',
++            tel_work='5551212')
++        contact_list_page = self.main_window.get_contact_list_page()
++        contact_list_page.click_contact_by_name('Beth Whittard')
++        contact_view = self.main_window.get_contact_view_page()
++        contact_view.click_phone_number('8675309')
++        self.assertTrue(contact_view.phone_number_is_favorite('8675309'))
++        self.assertFalse(contact_view.phone_number_is_favorite('5551212'))
++        contact_view.click_phone_number('5551212')
++        self.assertFalse(contact_view.phone_number_is_favorite('8675309'))
++        self.assertTrue(contact_view.phone_number_is_favorite('5551212'))
++        self.main_window.go_back()
++        contact_list_page.click_contact_by_name('Beth Whittard')
++        contact_view = self.main_window.get_contact_view_page()
++        # NOTE phones not visible from contact list favorites view
++        self.assertTrue(contact_view.phone_number_is_favorite('5551212'))
++        self.assertFalse(contact_view.phone_number_is_favorite('8675309'))
++
++    def test_remove_favorite(self):
++        self.address_book.create_contact(
++            name='Whittard;Beth',
++            tel_home='8675309')
++        contact_list_page = self.main_window.get_contact_list_page()
++        contact_list_page.click_contact_by_name('Beth Whittard')
++        contact_view = self.main_window.get_contact_view_page()
++        contact_view.click_phone_number('8675309')
++        self.assertTrue(contact_view.phone_number_is_favorite('8675309'))
++        self.main_window.go_back()
++        contact_list_page.click_contact_by_name('Beth Whittard')
++        contact_view = self.main_window.get_contact_view_page()
++        contact_view.click_phone_number('8675309')
++        self.assertFalse(contact_view.phone_number_is_favorite('8675309'))
++        self.main_window.go_back()
++        self.assertRaises(
++            StateNotFoundError,
++            lambda: contact_list_page.get_favorite_by_name('Beth Wittard'))
++        # FIXME: this passes but appears broken ATM--screen refresh?
++
++    def test_delete_favorite(self):
++        self.address_book.create_contact(
++            name='Whittard;Beth',
++            tel_home='8675309')
++        contact_list_page = self.main_window.get_contact_list_page()
++        contact_list_page.click_contact_by_name('Beth Whittard')
++        contact_view = self.main_window.get_contact_view_page()
++        contact_view.click_phone_number('8675309')
++        self.assertTrue(contact_view.phone_number_is_favorite('8675309'))
++        self.main_window.go_back()
++        contact_list_page.click_favorite_by_name('Beth Whittard')
++        toolbar = self.main_window.open_toolbar()
++        toolbar.click_button('delete')
++        self.main_window.go_back()
++        self.assertRaises(
++            StateNotFoundError,
++            lambda: contact_list_page.get_favorite_by_name('Beth Wittard'))
++        self.assertRaises(
++            StateNotFoundError,
++            lambda: contact_list_page.get_contact_by_name('Beth Wittard'))
 === 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-02-27 22:11:08 +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-02-27 22:11:08 +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):