Merge lp:~elopio/reminders-app/evernote-sdk into lp:reminders-app

[Leo Arias]

Added helpers for setting up and cleaning up the evernote account.
Added a test to check that an added note will be created on the server.
Make sure that all tests remove all the things they create.

[Ubuntu Phone Apps Jenkins Bot (ubuntu-phone-apps-jenkins-bot)]

FAILED: Continuous integration, rev:142
http://91.189.93.70:8080/job/reminders-app-ci/355/
Executed test runs:
    FAILURE: http://91.189.93.70:8080/job/generic-mediumtests-trusty/2643/console
        deb: http://91.189.93.70:8080/job/generic-mediumtests-trusty/2643/artifact/work/output/*zip*/output.zip
    FAILURE: http://91.189.93.70:8080/job/generic-mediumtests-utopic/180/console
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic/180/artifact/work/output/*zip*/output.zip
    SUCCESS: http://91.189.93.70:8080/job/reminders-app-trusty-amd64-ci/356
    SUCCESS: http://91.189.93.70:8080/job/reminders-app-utopic-amd64-ci/50

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/reminders-app-ci/355/rebuild

review: Needs Fixing (continuous-integration)

[Ubuntu Phone Apps Jenkins Bot (ubuntu-phone-apps-jenkins-bot)]

FAILED: Continuous integration, rev:142
http://91.189.93.70:8080/job/reminders-app-ci/365/
Executed test runs:
    FAILURE: http://91.189.93.70:8080/job/generic-mediumtests-trusty/2764/console
    FAILURE: http://91.189.93.70:8080/job/generic-mediumtests-utopic/301/console
    FAILURE: http://91.189.93.70:8080/job/reminders-app-trusty-amd64-ci/366/console
    FAILURE: http://91.189.93.70:8080/job/reminders-app-utopic-amd64-ci/60/console

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/reminders-app-ci/365/rebuild

review: Needs Fixing (continuous-integration)

[Ubuntu Phone Apps Jenkins Bot (ubuntu-phone-apps-jenkins-bot)]

FAILED: Continuous integration, rev:143
http://91.189.93.70:8080/job/reminders-app-ci/366/
Executed test runs:
    None: http://91.189.93.70:8080/job/generic-mediumtests-trusty/2766/console
    None: http://91.189.93.70:8080/job/generic-mediumtests-utopic/303/console
    None: http://91.189.93.70:8080/job/reminders-app-trusty-amd64-ci/367/console
    None: http://91.189.93.70:8080/job/reminders-app-utopic-amd64-ci/61/console

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/reminders-app-ci/366/rebuild

review: Needs Fixing (continuous-integration)

[Ubuntu Phone Apps Jenkins Bot (ubuntu-phone-apps-jenkins-bot)]

FAILED: Continuous integration, rev:142
http://91.189.93.70:8080/job/reminders-app-ci/367/
Executed test runs:
    UNSTABLE: http://91.189.93.70:8080/job/generic-mediumtests-trusty/2767
        deb: http://91.189.93.70:8080/job/generic-mediumtests-trusty/2767/artifact/work/output/*zip*/output.zip
    SUCCESS: http://91.189.93.70:8080/job/generic-mediumtests-utopic/304
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic/304/artifact/work/output/*zip*/output.zip
    SUCCESS: http://91.189.93.70:8080/job/reminders-app-trusty-amd64-ci/368
    SUCCESS: http://91.189.93.70:8080/job/reminders-app-utopic-amd64-ci/62

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/reminders-app-ci/367/rebuild

review: Needs Fixing (continuous-integration)

[Ubuntu Phone Apps Jenkins Bot (ubuntu-phone-apps-jenkins-bot)]

PASSED: Continuous integration, rev:143
http://91.189.93.70:8080/job/reminders-app-ci/369/
Executed test runs:
    SUCCESS: http://91.189.93.70:8080/job/generic-mediumtests-trusty/2771
        deb: http://91.189.93.70:8080/job/generic-mediumtests-trusty/2771/artifact/work/output/*zip*/output.zip
    SUCCESS: http://91.189.93.70:8080/job/generic-mediumtests-utopic/308
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic/308/artifact/work/output/*zip*/output.zip
    SUCCESS: http://91.189.93.70:8080/job/reminders-app-trusty-amd64-ci/370
    SUCCESS: http://91.189.93.70:8080/job/reminders-app-utopic-amd64-ci/64

Click here to trigger a rebuild:
http://91.189.93.70:8080/job/reminders-app-ci/369/rebuild

review: Approve (continuous-integration)

[Ubuntu Phone Apps Jenkins Bot (ubuntu-phone-apps-jenkins-bot)]

FAILED: Autolanding.
More details in the following jenkins job:
http://91.189.93.70:8080/job/reminders-app-autolanding/140/
Executed test runs:
    UNSTABLE: http://91.189.93.70:8080/job/generic-mediumtests-trusty/2826
        deb: http://91.189.93.70:8080/job/generic-mediumtests-trusty/2826/artifact/work/output/*zip*/output.zip
    UNSTABLE: http://91.189.93.70:8080/job/generic-mediumtests-utopic/363
        deb: http://91.189.93.70:8080/job/generic-mediumtests-utopic/363/artifact/work/output/*zip*/output.zip
    SUCCESS: http://91.189.93.70:8080/job/reminders-app-trusty-amd64-autolanding/140
    SUCCESS: http://91.189.93.70:8080/job/reminders-app-utopic-amd64-autolanding/32

review: Needs Fixing (continuous-integration)

[Ubuntu Phone Apps Jenkins Bot (ubuntu-phone-apps-jenkins-bot)]

review: Approve (continuous-integration)

=== modified file 'debian/control'
--- debian/control	2014-05-16 12:52:13 +0000
+++ debian/control	2014-05-22 08:31:45 +0000
@@ -50,12 +50,14 @@
 Package: reminders-app-autopilot
 Architecture: all
 Depends: ${misc:Depends},
+         evernote-sdk-python3,
          reminders-app (>= ${source:Version}), reminders-app (<< ${source:Version}.1~),
          libautopilot-qt,
          libqt5test5,
          python3-dbus,
          python3-dbusmock,
          python3-fixtures,
+         python3-thrift,
          ubuntu-ui-toolkit-autopilot,
 Description: Test package for the Reminders app
  Autopilot tests for the Reminders app package

=== modified file 'tests/autopilot/reminders/__init__.py'
--- tests/autopilot/reminders/__init__.py	2014-05-22 08:31:45 +0000
+++ tests/autopilot/reminders/__init__.py	2014-05-22 08:31:45 +0000
@@ -21,12 +21,9 @@
 import logging
 from distutils import version
 
-<<<<<<< TREE
+import ubuntuuitoolkit
+
 import autopilot
-=======
-import ubuntuuitoolkit
-
->>>>>>> MERGE-SOURCE
 from autopilot import logging as autopilot_logging
 from autopilot.introspection import dbus
 from ubuntuuitoolkit import emulators as toolkit_emulators

=== added file 'tests/autopilot/reminders/evernote.py'
--- tests/autopilot/reminders/evernote.py	1970-01-01 00:00:00 +0000
+++ tests/autopilot/reminders/evernote.py	2014-05-22 08:31:45 +0000
@@ -0,0 +1,132 @@
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+#
+# Copyright (C) 2014 Canonical Ltd.
+#
+# 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.
+#
+# 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/>.
+
+
+from evernote.api import client
+from evernote.edam.type import ttypes
+from evernote.edam.error import ttypes as errors
+
+
+TEST_OAUTH_TOKEN = (
+    'S=s1:U=8e6bf:E=14d08e375ff:C=145b1324a03:P=1cd:A=en-devtoken:V=2:'
+    'H=79b946c32b4515ee52b387f7b68baa69')
+EVERNOTE_NOTE_XML_PROLOG = (
+    '<?xml version="1.0" encoding="UTF-8"?>'
+    '<!DOCTYPE en-note SYSTEM "http://xml.evernote.com/pub/enml2.dtd">')
+EVERNOTE_NOTE_XML_ELEMENT_FORMAT = '<en-note>{}</en-note>'
+
+
+class SandboxEvernoteClient(client.EvernoteClient):
+    """Client to access the Evernote API on the sandbox server."""
+
+    def __init__(self):
+        super(SandboxEvernoteClient, self).__init__(
+            token=TEST_OAUTH_TOKEN, sandbox=True)
+
+    @property
+    def note_store(self):
+        return self.get_note_store()
+
+    def create_notebook(self, name):
+        """Create a notebook.
+
+        :param name: The name of the notebook to create.
+        :return: The created notebook.
+
+        """
+        notebook = ttypes.Notebook()
+        notebook.name = name
+
+        return self.note_store.createNotebook(notebook)
+
+    def create_note(self, title, content, notebook_guid):
+        """Create a note.
+
+        :param title: The title of the note to create.
+        :param content: The content to add to the note.
+        :return: The created note.
+
+        """
+        note = ttypes.Note()
+        note.title = title
+        note.content = EVERNOTE_NOTE_XML_PROLOG
+        note.content += EVERNOTE_NOTE_XML_ELEMENT_FORMAT.format(content)
+        note.notebookGuid = notebook_guid
+
+        return self.note_store.createNote(note)
+
+    def get_note_content(self, note_guid):
+        """Return the content of a note.
+
+        :param note_guid: The GUID of the note.
+        :return: The content of the note.
+
+        """
+        return self.note_store.getNoteContent(note_guid)
+
+    def expunge_notebook(self, notebook_guid):
+        """Permanently remove a notebook.
+
+        :param notebook_guid: The GUID of the notebook to expunge.
+
+        """
+        self.note_store.expungeNotebook(notebook_guid)
+
+    def get_notebook(self, notebook_guid):
+        """Return a notebook.
+
+        :param notebook_guid: The GUID of the notebook.
+
+        """
+        return self.note_store.getNotebook(notebook_guid)
+
+    def expunge_note(self, note_guid):
+        """Permanently remove a note.
+
+        :param note_guid: The GUID of the note to expunge.
+
+        """
+        return self.note_store.expungeNote(note_guid)
+
+    def get_note(self, note_guid):
+        """Return a note.
+
+        :param note_guid: The GUID of the note.
+
+        """
+        return self.note_store.getNote(note_guid, False, False, False, False)
+
+    def expunge_notebook_by_name(self, name):
+        """Permanently remove a notebook.
+
+        :param name: The first notebook found with this name will be expunged.
+
+        """
+        notebook = self.get_notebook_by_name(name)
+        self.expunge_notebook(notebook.guid)
+
+    def get_notebook_by_name(self, name):
+        """Return a notebook.
+
+        :param name: The first notebook found with this name will be returned.
+
+        """
+        notebooks = self.note_store.listNotebooks()
+        for notebook in notebooks:
+            if notebook.name == name:
+                return notebook
+        else:
+            raise errors.EDAMNotFoundException()

=== added file 'tests/autopilot/reminders/tests/test_evernote.py'
--- tests/autopilot/reminders/tests/test_evernote.py	1970-01-01 00:00:00 +0000
+++ tests/autopilot/reminders/tests/test_evernote.py	2014-05-22 08:31:45 +0000
@@ -0,0 +1,128 @@
+# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
+#
+# Copyright (C) 2014 Canonical Ltd.
+#
+# 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.
+#
+# 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 uuid
+
+import testtools
+from evernote.edam.error import ttypes as errors
+
+
+from reminders import evernote
+
+
+class EvernoteTestCase(testtools.TestCase):
+    """Test the evernote access with the SDK."""
+
+    def setUp(self):
+        super(EvernoteTestCase, self).setUp()
+        self.client = evernote.SandboxEvernoteClient()
+
+    def create_test_notebook(self, name=None):
+        if name is None:
+            name = 'Test notebook {}'.format(uuid.uuid1())
+        created_notebook = self.client.create_notebook(name)
+        self.addCleanup(self.expunge_test_notebook, created_notebook.guid)
+        return created_notebook
+
+    def expunge_test_notebook(self, notebook_guid):
+        try:
+            self.client.expunge_notebook(notebook_guid)
+        except errors.EDAMNotFoundException:
+            # The notebook was already deleted or not successfully created.
+            pass
+
+    def create_test_note(self, title=None, content=None, notebook_guid=None):
+        if title is None:
+            title = 'Test note {}'.format(uuid.uuid1())
+        if content is None:
+            content = 'test content.'
+        if notebook_guid is None:
+            notebook = self.create_test_notebook()
+            notebook_guid = notebook.guid
+
+        created_note = self.client.create_note(title, content, notebook_guid)
+        self.addCleanup(self.expunge_test_note, created_note.guid)
+        return created_note
+
+    def expunge_test_note(self, note_guid):
+        try:
+            self.client.expunge_note(note_guid)
+        except errors.EDAMNotFoundException:
+            # The note was already deleted or not successfully created.
+            pass
+
+    def test_create_notebook(self):
+        """Test that we can create a notebook on the evernote server."""
+        test_notebook_name = 'Test notebook {}'.format(uuid.uuid1())
+
+        # An exception will be raised if the notebook can't be created.
+        created_notebook = self.create_test_notebook(test_notebook_name)
+
+        self.assertEqual(created_notebook.name, test_notebook_name)
+
+    def test_create_note(self):
+        """Test that we can create a note on the evernote server."""
+        test_note_title = 'Test note {}'.format(uuid.uuid1())
+        test_note_content = 'test content.'
+        test_notebook = self.create_test_notebook()
+
+        # An exception will be raised if the note can't be created.
+        created_note = self.create_test_note(
+            test_note_title, test_note_content, test_notebook.guid)
+
+        self.assertEqual(created_note.title, test_note_title)
+        created_note_content = self.client.get_note_content(
+            created_note.guid)
+        self.assertIn(test_note_content, created_note_content)
+
+    def test_expunge_notebook_must_permanently_remove_it(self):
+        """Test that an expunged notebook is no longer available."""
+        created_notebook = self.create_test_notebook()
+
+        self.client.expunge_notebook(created_notebook.guid)
+
+        self.assertRaises(
+            errors.EDAMNotFoundException,
+            self.client.get_notebook,
+            created_notebook.guid)
+
+    def test_expunge_note_must_permanently_remove_it(self):
+        """Test that an expunged note is no longer available."""
+        created_note = self.create_test_note()
+
+        self.client.expunge_note(created_note.guid)
+
+        self.assertRaises(
+            errors.EDAMNotFoundException,
+            self.client.get_note,
+            created_note.guid)
+
+    def test_expunge_notebook_by_name_must_permanently_remove_it(self):
+        """Test that an expunged notebook is no longer available."""
+        created_notebook = self.create_test_notebook()
+
+        self.client.expunge_notebook_by_name(created_notebook.name)
+
+        self.assertRaises(
+            errors.EDAMNotFoundException,
+            self.client.get_notebook,
+            created_notebook.guid)
+
+    def test_get_unexisting_notebook_by_name_must_raise_exception(self):
+        self.assertRaises(
+            errors.EDAMNotFoundException,
+            self.client.get_notebook_by_name,
+            'I do not exist.')

=== modified file 'tests/autopilot/reminders/tests/test_reminders.py'
--- tests/autopilot/reminders/tests/test_reminders.py	2014-05-22 08:31:45 +0000
+++ tests/autopilot/reminders/tests/test_reminders.py	2014-05-22 08:31:45 +0000
@@ -23,10 +23,11 @@
 
 from autopilot import platform
 from autopilot.matchers import Eventually
+from evernote.edam.error import ttypes as evernote_errors
 from testtools.matchers import Equals
 
 import reminders
-from reminders import credentials, fixture_setup, tests
+from reminders import credentials, evernote, fixture_setup, tests
 
 
 logger = logging.getLogger(__name__)
@@ -66,24 +67,29 @@
         no_account_dialog = self.app.main_view.no_account_dialog
         self.add_evernote_account()
         no_account_dialog.wait_until_destroyed()
+        self.evernote_client = evernote.SandboxEvernoteClient()
 
     def add_evernote_account(self):
         account_manager = credentials.AccountManager()
-        oauth_token = (
-            'S=s1:U=8e6bf:E=14d08e375ff:C=145b1324a03:P=1cd:A=en-devtoken:'
-            'V=2:H=79b946c32b4515ee52b387f7b68baa69')
         account = account_manager.add_evernote_account(
-            'dummy', 'dummy', oauth_token)
+            'dummy', 'dummy', evernote.TEST_OAUTH_TOKEN)
         self.addCleanup(account_manager.delete_account, account)
         del account_manager._manager
         del account_manager
 
+    def expunge_test_notebook(self, notebook_name):
+        try:
+            self.evernote_client.expunge_notebook_by_name(notebook_name)
+        except evernote_errors.EDAMNotFoundException:
+            # The notebook was already deleted or not successfully created.
+            pass
+
     def test_add_notebook_must_append_it_to_list(self):
+        """Test that an added notebook will be available for selection."""
         test_notebook_title = 'Test notebook {}'.format(uuid.uuid1())
+        self.addCleanup(self.expunge_test_notebook, test_notebook_title)
 
         notebooks_page = self.app.open_notebooks()
-        # FIXME delete the added notebook. Otherwise, the test account will
-        # fill up. See http://pad.lv/1318749 --elopio - 2014-05-12
         notebooks_page.add_notebook(test_notebook_title)
 
         last_notebook = notebooks_page.get_notebooks()[-1]
@@ -96,3 +102,14 @@
         self.assertEqual(last_notebook[0], test_notebook_title)
         self.assertEqual(last_notebook[2], 'Private')
         self.assertEqual(last_notebook[3], 0)
+
+    def test_add_notebook_must_create_it_in_server(self):
+        """Test that an added notebook will be created on the server."""
+        test_notebook_title = 'Test notebook {}'.format(uuid.uuid1())
+        self.addCleanup(self.expunge_test_notebook, test_notebook_title)
+
+        notebooks_page = self.app.open_notebooks()
+        notebooks_page.add_notebook(test_notebook_title)
+
+        # An exception will be raised if the notebook is note found.
+        self.evernote_client.get_notebook_by_name(test_notebook_title)