Merge lp:~alecu/ubuntuone-client/add-simple-zeitgeist into lp:ubuntuone-client

[Alejandro J. Cura]

A twisted class to log zeitgeist events

A twisted class to log zeitgeist events

[lp:~alecu/ubuntuone-client/add-simple-zeitgeist]

752. By Alejandro J. Cura on 2010-11-25

renamed the logging module

[Natalia Bidart (nataliabidart)]

Tests will not run due to:

== Python Lint Notices ==

./tests/eventlog/test_zglog.py:
    94: undefined name 'NotFoundError'

* Please remove spaces from docstring and add ending dot and initial upper case for:

""" Tests module """
""" event logging module """

* Is this correct? stdout has an extra -

121 + tempstdout = tempfile.TemporaryFile(prefix="test-u1-stdout-")
122 + tempstderr = tempfile.TemporaryFile(prefix="test-u1-stderr")

* This code:

233 + except RuntimeError, e:
234 + print e

should use the ubuntuone.logger and log the exception

review: Needs Fixing

[lp:~alecu/ubuntuone-client/add-simple-zeitgeist]

753. By Alejandro J. Cura on 2010-12-01

fixes requested on review

754. By Alejandro J. Cura on 2010-12-02

merged with trunk

[Natalia Bidart (nataliabidart)]

Great!

review: Approve

[John Lenton (chipaca)]

Like it!

But...

Could you change the strings in zlog.py from "blah""" to just "blah"? I didn't even know the former was valid python, and it looks horrible.

review: Needs Fixing

[Alejandro J. Cura (alecu)]

> Could you change the strings in zlog.py from "blah""" to just "blah"? I didn't
> even know the former was valid python, and it looks horrible.

Yes, yes it is, and yes it looks horrible.

[Alejandro J. Cura (alecu)]

Fixed and pushed. Good catch!

[lp:~alecu/ubuntuone-client/add-simple-zeitgeist]

755. By Alejandro J. Cura on 2010-12-03

Fix horrible looking strings.

[Nicola Larosa (teknico)]

> Could you change the strings in zlog.py from "blah""" to just "blah"? I didn't
> even know the former was valid python, and it looks horrible.

It works because they are interpreted as two strings: "blah" and "" (empty), and then they are merged into one by implicit string concatenation, since they are in a parenthesized context.

[Alejandro J. Cura (alecu)]

> > Could you change the strings in zlog.py from "blah""" to just "blah"? I
> didn't
> > even know the former was valid python, and it looks horrible.
>
> It works because they are interpreted as two strings: "blah" and "" (empty),
> and then they are merged into one by implicit string concatenation, since they
> are in a parenthesized context.

Yeah, we discussed about this in PyAr a while ago, and I still find that it's ugly that this is valid python:
   print "abc"""

And that this is not:
   print """abc"

I think that implicit string concatenation in python *should* mandate a space between strings, but I guess it's a bit late to change the interpreter and third part parsers, and such.

Also, I think that in this case parenthesized context does not matters.

[John Lenton (chipaca)]

review: Approve

=== added directory 'tests/eventlog'
=== added file 'tests/eventlog/__init__.py'
--- tests/eventlog/__init__.py	1970-01-01 00:00:00 +0000
+++ tests/eventlog/__init__.py	2010-12-03 12:41:45 +0000
@@ -0,0 +1,14 @@
+# Copyright 2010 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License 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 warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, 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/>.
+"""Tests module."""

=== added file 'tests/eventlog/test_zglog.py'
--- tests/eventlog/test_zglog.py	1970-01-01 00:00:00 +0000
+++ tests/eventlog/test_zglog.py	2010-12-03 12:41:45 +0000
@@ -0,0 +1,155 @@
+# -*- coding: utf-8 -*-
+#
+# Author: Alejandro J. Cura <[e-mail]>
+#
+# Copyright 2010 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License 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 warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, 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/>.
+"""Tests for the Zeitgeist logging."""
+
+import os
+import shutil
+import subprocess
+import tempfile
+import time
+
+from distutils.spawn import find_executable
+
+from twisted.internet.defer import Deferred
+from zeitgeist.client import ZeitgeistClient
+from zeitgeist.datamodel import Event, Subject, Interpretation, Manifestation
+
+from tests.platform.linux.test_dbus import DBusTwistedTestCase
+from ubuntuone.eventlog.zglog import ZeitgeistLogger
+
+SRCDIR = os.environ.get('SRCDIR', os.getcwd())
+
+
+class NotFoundError(Exception):
+    """Not found error."""
+
+
+class ZeitgeistNotStartedTests(DBusTwistedTestCase):
+    """Tests for the zeitgeist logging module."""
+
+    def test_log_does_not_err_when_daemon_not_started(self):
+        """zeitgeist-daemon was not started."""
+        timestamp = int(time.time() * 1000)
+        subject = Subject.new_for_values(
+                uri="file:///tmp/folder1",
+                interpretation=Interpretation.FOLDER,
+                manifestation=Manifestation.FILE_DATA_OBJECT,
+                origin="ubuntuone:uuid",
+                mimetype="inode/directory",
+                text="sample folder"
+        )
+        sample_event = Event.new_for_values(
+            timestamp=timestamp,
+            interpretation=Interpretation.ACCESS_EVENT,
+            manifestation=Manifestation.USER_ACTIVITY,
+            actor="mailto:sample_subject",
+            subjects=[subject]
+        )
+
+        zg = ZeitgeistLogger()
+        d = zg.log(sample_event)
+        self.assertEqual(zg.client, None)
+
+        def verify(result):
+            """Stored result is the empty list, because zg not available."""
+            self.assertEqual(result, [])
+            return result
+
+        d.addCallback(verify)
+        return d
+
+def wait_zeitgeist_started(seconds=10):
+    """Wait a few seconds until zg is started, or fail if it can't."""
+    client = None
+    count = 0
+    while client is None:
+        count += 1
+        try:
+            client = ZeitgeistClient()
+            break
+        except RuntimeError:
+            if count > seconds*10:
+                raise
+            time.sleep(0.1)
+
+
+class ZeitgeistTestCase(DBusTwistedTestCase):
+    """Tests for the zeitgeist logging module."""
+
+    def setUp(self):
+        super(ZeitgeistTestCase, self).setUp()
+        zgdaemon = find_executable("zeitgeist-daemon")
+        if not zgdaemon:
+            raise NotFoundError("zeitgeist-daemon was not found.")
+
+        tempfolder = tempfile.mkdtemp(prefix="test-u1-zeitgeist-")
+        tempstdout = tempfile.TemporaryFile(prefix="test-u1-stdout-")
+        tempstderr = tempfile.TemporaryFile(prefix="test-u1-stderr-")
+        os.environ["ZEITGEIST_DATA_PATH"] = tempfolder
+        p = subprocess.Popen([zgdaemon], bufsize=4096, stdout=tempstdout,
+                             stderr=tempstderr)
+        def cleanup():
+            """Wait for the process to finish."""
+            p.terminate()
+            p.wait()
+            del(os.environ["ZEITGEIST_DATA_PATH"])
+            shutil.rmtree(tempfolder)
+
+        wait_zeitgeist_started()
+        self.addCleanup(cleanup)
+
+    def test_log_records_the_event(self):
+        """The log method records the event in zg."""
+        timestamp = int(time.time() * 1000)
+        subject = Subject.new_for_values(
+                uri="file:///tmp/folder1",
+                interpretation=Interpretation.FOLDER,
+                manifestation=Manifestation.FILE_DATA_OBJECT,
+                origin="ubuntuone:uuid",
+                mimetype="inode/directory",
+                text="sample folder"
+        )
+        sample_event = Event.new_for_values(
+            timestamp=timestamp,
+            interpretation=Interpretation.ACCESS_EVENT,
+            manifestation=Manifestation.USER_ACTIVITY,
+            actor="mailto:sample_subject",
+            subjects=[subject]
+        )
+
+        sample_template = Event.new_for_values()
+
+        zg = ZeitgeistLogger()
+        self.assertNotEqual(zg.client, None)
+
+        d2 = Deferred()
+
+        def logged(id_list):
+            """The event was logged to zeitgeist."""
+
+            def events_found(event_list):
+                """zg returned the list of events."""
+                self.assertEqual(event_list[0].id, id_list[0])
+                d2.callback("ok")
+
+            zg.client.find_events_for_template(sample_template, events_found)
+
+        d = zg.log(sample_event)
+        d.addCallbacks(logged, d2.errback)
+
+        return d2

=== modified file 'tests/syncdaemon/__init__.py'
--- tests/syncdaemon/__init__.py	2009-05-12 13:36:05 +0000
+++ tests/syncdaemon/__init__.py	2010-12-03 12:41:45 +0000
@@ -11,4 +11,4 @@
 #
 # You should have received a copy of the GNU General Public License along
 # with this program.  If not, see <http://www.gnu.org/licenses/>.
-""" Tests module """
+"""Tests module."""

=== added directory 'ubuntuone/eventlog'
=== added file 'ubuntuone/eventlog/__init__.py'
--- ubuntuone/eventlog/__init__.py	1970-01-01 00:00:00 +0000
+++ ubuntuone/eventlog/__init__.py	2010-12-03 12:41:45 +0000
@@ -0,0 +1,16 @@
+# ubuntuone.eventlog - Ubuntu One event logging modules
+#
+# Copyright 2010 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License 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 warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, 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/>.
+"""Event logging module."""

=== added file 'ubuntuone/eventlog/zglog.py'
--- ubuntuone/eventlog/zglog.py	1970-01-01 00:00:00 +0000
+++ ubuntuone/eventlog/zglog.py	2010-12-03 12:41:45 +0000
@@ -0,0 +1,48 @@
+# -*- coding: utf-8 -*-
+#
+# Author: Alejandro J. Cura <[e-mail]>
+#
+# Copyright 2010 Canonical Ltd.
+#
+# This program is free software: you can redistribute it and/or modify it
+# under the terms of the GNU General Public License 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 warranties of
+# MERCHANTABILITY, SATISFACTORY QUALITY, 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/>.
+"""Log into the Zeitgeist daemon."""
+
+from twisted.internet.defer import Deferred
+
+from ubuntuone.logger import logging
+
+logger = logging.getLogger('ubuntuone.eventlog.zglog')
+
+
+class ZeitgeistLogger(object):
+    """A class that logs zeitgeist events."""
+    client = None
+
+    def __init__(self):
+        """Initialize this instance."""
+        try:
+            from zeitgeist.client import ZeitgeistClient
+            self.client = ZeitgeistClient()
+            logger.info("Zeitgeist support initialized.")
+        except Exception:
+            logger.exception("Zeitgeist support not started:")
+
+    def log(self, event):
+        """Log a zeitgeist event."""
+        d = Deferred()
+        if self.client:
+            logger.info("Logging Zeitgeist event: %r", event)
+            self.client.insert_event(event, d.callback, d.errback)
+        else:
+            d.callback([])
+        return d

=== modified file 'ubuntuone/syncdaemon/__init__.py'
--- ubuntuone/syncdaemon/__init__.py	2010-07-23 14:52:03 +0000
+++ ubuntuone/syncdaemon/__init__.py	2010-12-03 12:41:45 +0000
@@ -13,7 +13,7 @@
 #
 # You should have received a copy of the GNU General Public License along
 # with this program.  If not, see <http://www.gnu.org/licenses/>.
-""" client module """
+"""Client module."""
 
 # required capabilities
 REQUIRED_CAPS = frozenset(["no-content",