Merge lp:~thomir-deactivatedaccount/autopilot/add_lttng_tracepoint_emit into lp:autopilot

[Thomi Richards]

Add a package with the tracepoint module.

Add a package with the tracepoint module.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:199
http://jenkins.qa.ubuntu.com/job/autopilot-ci/79/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-saucy-amd64-ci/7
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-saucy-armhf-ci/7

Click here to trigger a rebuild:
http://s-jenkins:8080/job/autopilot-ci/79/rebuild

review: Approve (continuous-integration)

[Christopher Lee (veebers)]

Looks good to me

review: Approve

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:200
http://jenkins.qa.ubuntu.com/job/autopilot-ci/80/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-saucy-amd64-ci/8
    SUCCESS: http://jenkins.qa.ubuntu.com/job/autopilot-saucy-armhf-ci/8

Click here to trigger a rebuild:
http://s-jenkins:8080/job/autopilot-ci/80/rebuild

review: Approve (continuous-integration)

=== modified file 'autopilot/testcase.py'
--- autopilot/testcase.py	2013-05-01 17:50:26 +0000
+++ autopilot/testcase.py	2013-05-09 00:06:26 +0000
@@ -71,6 +71,11 @@
 from autopilot.globals import on_test_started
 from autopilot.keybindings import KeybindingsHelper
 from autopilot.matchers import Eventually
+try:
+    from autopilot import tracepoint as tp
+    HAVE_TRACEPOINT=True
+except ImportError:
+    HAVE_TRACEPOINT=False
 
 
 logger = logging.getLogger(__name__)
@@ -101,6 +106,18 @@
         return result
 
 
+def _lttng_trace_test_started(test_id):
+    if HAVE_TRACEPOINT:
+        tp.emit_test_started(test_id)
+    else:
+        logger.warning("No tracing available - install the python-autopilot-trace package!")
+
+
+def _lttng_trace_test_ended(test_id):
+    if HAVE_TRACEPOINT:
+        tp.emit_test_ended(test_id)
+
+
 class AutopilotTestCase(TestWithScenarios, TestCase, KeybindingsHelper):
     """Wrapper around testtools.TestCase that adds significant functionality.
 
@@ -114,6 +131,9 @@
         super(AutopilotTestCase, self).setUp()
         on_test_started(self)
 
+        _lttng_trace_test_started(self.id())
+        self.addCleanup(_lttng_trace_test_ended, self.id())
+
         self._process_manager = None
         self._mouse = None
         self._kb = None

=== modified file 'debian/control'
--- debian/control	2013-05-06 22:25:57 +0000
+++ debian/control	2013-05-09 00:06:26 +0000
@@ -9,6 +9,7 @@
                gir1.2-gtk-2.0,
                python (>= 2.6),
                python-dbus,
+               python-dev,
                python-debian,
                python-mock,
                python-setuptools,
@@ -17,6 +18,7 @@
                python-testscenarios,
                python-xlib,
                python-zeitgeist,
+               liblttng-ust-dev,
 Standards-Version: 3.9.3
 Homepage: https://launchpad.net/autopilot
 Vcs-bzr: https://code.launchpad.net/+branch/ubuntu/autopilot
@@ -38,6 +40,17 @@
  keyboard. It also provides a lot of utilities linked to the X server
  and detecting applications.
 
+Package: python-autopilot-trace
+Architecture: any
+Depends: ${misc:Depends},
+         ${shlibs:Depends},
+         python-autopilot,
+Description: Support for tracing in autopilot
+ This package contains the binary lttng trace point for tracing
+ autopilot tests. This is useful when using autopilot to exercise
+ an instrumented application.
+
+
 Package: autopilot-touch
 Architecture: all
 Section: metapackages

=== added file 'debian/python-autopilot-trace.install'
--- debian/python-autopilot-trace.install	1970-01-01 00:00:00 +0000
+++ debian/python-autopilot-trace.install	2013-05-09 00:06:26 +0000
@@ -0,0 +1,1 @@
+usr/lib/python2.7/dist-packages/autopilot/tracepoint.so

=== modified file 'debian/rules' (properties changed: +x to -x)
--- debian/rules	2013-05-05 02:56:11 +0000
+++ debian/rules	2013-05-09 00:06:26 +0000
@@ -13,3 +13,6 @@
 
 override_dh_auto_test:
 	python -m testtools.run discover autopilot.tests.unit
+
+override_dh_install:
+	dh_install --list-missing

=== added directory 'lttng_module'
=== added file 'lttng_module/autopilot_tracepoint.c'
--- lttng_module/autopilot_tracepoint.c	1970-01-01 00:00:00 +0000
+++ lttng_module/autopilot_tracepoint.c	2013-05-09 00:06:26 +0000
@@ -0,0 +1,52 @@
+
+#define TRACEPOINT_CREATE_PROBES
+/*
+ * The header containing our TRACEPOINT_EVENTs.
+ */
+#define TRACEPOINT_DEFINE
+#include "autopilot_tracepoint.h"
+
+/// Python module stuff below here:
+
+#include <Python.h>
+
+static PyObject *
+emit_test_started(PyObject *self, PyObject *args)
+{
+    const char *mesg_text;
+
+    if(!PyArg_ParseTuple(args, "s", &mesg_text))
+    {
+        return NULL;
+    }
+    tracepoint(com_canonical_autopilot, test_event, "started", mesg_text);
+
+    Py_RETURN_NONE;
+}
+
+static PyObject *
+emit_test_ended(PyObject *self, PyObject *args)
+{
+    const char *mesg_text;
+
+    if(!PyArg_ParseTuple(args, "s", &mesg_text))
+    {
+        return NULL;
+    }
+    tracepoint(com_canonical_autopilot, test_event, "ended", mesg_text);
+
+    Py_RETURN_NONE;
+}
+
+static PyMethodDef TracepointMethods[] = {
+    {"emit_test_started", emit_test_started, METH_VARARGS, "Generate a tracepoint for test started."},
+    {"emit_test_ended", emit_test_ended, METH_VARARGS, "Generate a tracepoint for test started."},
+    {NULL, NULL, 0, NULL}        /* Sentinel */
+};
+
+
+PyMODINIT_FUNC
+inittracepoint(void)
+{
+    (void) Py_InitModule("tracepoint", TracepointMethods);
+}

=== added file 'lttng_module/autopilot_tracepoint.h'
--- lttng_module/autopilot_tracepoint.h	1970-01-01 00:00:00 +0000
+++ lttng_module/autopilot_tracepoint.h	2013-05-09 00:06:26 +0000
@@ -0,0 +1,37 @@
+
+#undef TRACEPOINT_PROVIDER
+#define TRACEPOINT_PROVIDER com_canonical_autopilot
+
+#undef TRACEPOINT_INCLUDE
+#define TRACEPOINT_INCLUDE "./autopilot_tracepoint.h"
+
+#ifdef __cplusplus
+extern "C"{
+#endif /* __cplusplus */
+
+
+#if !defined(AUTOPILOT_TRACEPOINT_H) || defined(TRACEPOINT_HEADER_MULTI_READ)
+#define AUTOPILOT_TRACEPOINT_H
+
+#include <lttng/tracepoint.h>
+
+
+TRACEPOINT_EVENT(
+    com_canonical_autopilot,
+    test_event,
+    TP_ARGS(const char *, started_or_stopped, const char *, test_id),
+    /* Next are the fields */
+    TP_FIELDS(
+        ctf_string(started_or_stopped, started_or_stopped)
+        ctf_string(test_id, test_id)
+    )
+)
+
+#endif /* AUTOPILOT_TRACEPOINT_H */
+
+#include <lttng/tracepoint-event.h>
+
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
+

=== modified file 'setup.py'
--- setup.py	2013-04-23 04:15:54 +0000
+++ setup.py	2013-05-09 00:06:26 +0000
@@ -18,8 +18,8 @@
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 #
 
-from distutils.core import setup
-from setuptools import find_packages
+
+from setuptools import find_packages, setup, Extension
 
 try:
     from debian import changelog
@@ -29,6 +29,11 @@
     # If we don't have python-debian installed, guess a coarse-grained version string
     version = '1.3'
 
+autopilot_tracepoint = Extension('autopilot.tracepoint',
+                                 libraries=['lttng-ust'],
+                                 include_dirs=['lttng_module'],
+                                 sources = ['lttng_module/autopilot_tracepoint.c'])
+
 setup(
     name='autopilot',
     version=version,
@@ -40,5 +45,6 @@
     packages=find_packages(),
     test_suite='autopilot.tests',
     scripts=['bin/autopilot',],
+    ext_modules=[autopilot_tracepoint],
 )