Merge lp:~stolowski/unity-scopes-api/support-apport into lp:unity-scopes-api

[Paweł Stołowski]

Provide script for apport package hooks to handle scoperunner crashes. This script alters 'Package' and 'SourcePackage' fields of the crash report to distribute error reports to correct scopes.

Provide script for apport package hooks to handle scoperunner crashes. This script alters 'Package' and 'SourcePackage' fields of the crash report to distribute error reports to correct scopes.

There are three cases it handles:
1) a scope comes from a deb package: the script executes dpkg query to find its deb and from that, get source package name.
2) a scope comes from a click package: the script gets the 'name' field from click manifest.
 a) if we know this scope (currently vimeo and youtube are well known), we remap src package to unity-scope-vimeo/youtube.
 b) otherwise we just use the dotted click name as source package (similar to how clicks are handled by default with generic click hook of apport).

Example reports:

https://errors.staging.ubuntu.com/oops/f7bae794-aab3-11e4-af2c-fa163e1893a8
https://errors.staging.ubuntu.com/oops/6e2cd734-aab4-11e4-af2c-fa163e1893a8
https://errors.staging.ubuntu.com/oops/57840d6c-aab5-11e4-af2c-fa163e1893a8

This hook can be tested against a testing server, ping me for instructions if you're interested in giving it a try.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:282
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-ci/559/
Executed test runs:
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-amd64-ci/86/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-armhf-ci/84/console
    FAILURE: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-i386-ci/85/console

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-api-ci/559/rebuild

review: Needs Fixing (continuous-integration)

[Brian Murray (brian-murray)]

This looks good to me but see my in-line comment regarding the function collect_dpkg_info.

[Brian Murray (brian-murray)]

review: Needs Fixing

[lp:~stolowski/unity-scopes-api/support-apport]

283. By Paweł Stołowski on 2015-02-03

Simplified collect_dpkg_info.

284. By Paweł Stołowski on 2015-02-03

Installation fixes.

[Paweł Stołowski (stolowski)]

> This looks good to me but see my in-line comment regarding the function
> collect_dpkg_info.

Thank you, this was a very good suggestion. I've simplified it.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:284
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-ci/560/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-amd64-ci/87
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-armhf-ci/85
        deb: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-armhf-ci/85/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-i386-ci/86

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-api-ci/560/rebuild

review: Approve (continuous-integration)

[Brian Murray (brian-murray)]

review: Approve

[Michi Henning (michihenning)]

I tried accessing the sample report links you posted, but was told that I'm not trustworthy enough... I've filled in the relevant bit of webwork. Hopefully someone will give me permission.

Looks good to me, but I'm not a package/click person. Pete, would you mind looking through this too please?

review: Approve

[lp:~stolowski/unity-scopes-api/support-apport]

285. By Paweł Stołowski on 2015-02-04

Added mapping for soundcloud scope.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:285
http://jenkins.qa.ubuntu.com/job/unity-scopes-api-ci/564/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-amd64-ci/91
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-armhf-ci/89
        deb: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-armhf-ci/89/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/unity-scopes-api-vivid-i386-ci/90

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/unity-scopes-api-ci/564/rebuild

review: Approve (continuous-integration)

[Pete Woods (pete-woods)]

review: Approve

=== modified file 'data/CMakeLists.txt'
--- data/CMakeLists.txt	2014-05-06 09:00:45 +0000
+++ data/CMakeLists.txt	2015-02-04 09:48:00 +0000
@@ -10,6 +10,10 @@
 configure_file(scope-registry.conf.in scope-registry.conf @ONLY)
 install(FILES ${CMAKE_CURRENT_BINARY_DIR}/scope-registry.conf DESTINATION ${CMAKE_INSTALL_DATADIR}/upstart/sessions)
 
+# apport package hook
+configure_file(${CMAKE_CURRENT_SOURCE_DIR}/libunity-scopes.py libunity-scopes${UNITY_SCOPES_SOVERSION}.py COPYONLY)
+install(FILES ${CMAKE_CURRENT_BINARY_DIR}/libunity-scopes${UNITY_SCOPES_SOVERSION}.py DESTINATION /usr/share/apport/package-hooks)
+
 # Empty directory for scopes to put their conf files into
 # If we start install our own conf files here, this can be
 # removed (installing files implicitly creates the subdirs)

=== added file 'data/libunity-scopes.py'
--- data/libunity-scopes.py	1970-01-01 00:00:00 +0000
+++ data/libunity-scopes.py	2015-02-04 09:48:00 +0000
@@ -0,0 +1,96 @@
+#
+# Copyright (C) 2015 Canonical Ltd.
+# Author: Pawel Stolowski <[e-mail]>
+#
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation; version 3.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+#
+
+
+#
+# This script parses ProcCmdline to check if this is a crash of scoperunner process.
+# If so, it checks what scope made it crash and adjusts Package and SourcePackage
+# attributes of the crash report to point at the crashing scope.
+#
+
+from os import path
+import subprocess, json, configparser
+import apport
+import apport.fileutils
+from apport.packaging_impl import impl as packaging
+
+# map 'name' from click package manifest to LP project (if known)
+click_name_to_src = {
+    'com.ubuntu.scopes.youtube': 'unity-scope-youtube',
+    'com.ubuntu.scopes.vimeo': 'unity-scope-vimeo',
+    'com.ubuntu.scopes.soundcloud': 'unity-scope-soundcloud'
+}
+
+def get_scope_display_name(ini_file_path):
+    try:
+        cfg = configparser.ConfigParser()
+        cfg.read(ini_file_path)
+        return cfg.get('ScopeConfig', 'DisplayName')
+    except:
+        pass
+    return ''
+
+def collect_dpkg_info(report, inifile):
+    try:
+        # find deb package that owns this inifile
+        pkg = apport.fileutils.find_file_package(inifile)
+        ver = packaging.get_version(pkg)
+        report['Package'] = '%s %s' % (pkg, ver)
+        report['SourcePackage'] = packaging.get_source(pkg)
+    except:
+       pass
+
+def collect_click_info(report, inifile):
+    try:
+        # get click manifest of a click package that owns this inifile
+        click_info = subprocess.check_output(['click', 'info', inifile], universal_newlines=True)
+        manifest = json.loads(click_info)
+        report['Package'] = '%s %s' % (manifest['name'], manifest['version'])
+        name = manifest['name']
+        if name in click_name_to_src:
+            report['SourcePackage'] = click_name_to_src[name]
+        else:
+            report['SourcePackage'] = name
+        report['PackageArchitecture'] = manifest['architecture']
+    except:
+        pass
+
+def add_info(report, ui):
+    exec_path = report.get('ExecutablePath')
+    if not exec_path:
+        return
+    cmd_line = report.get('ProcCmdline')
+    if not cmd_line:
+        return
+    if exec_path.find("scoperunner") < 0:
+        return
+    args = cmd_line.split()
+    if len(args) != 2:
+        return
+
+    scope_ini_path = args[1]
+    scope_name = get_scope_display_name(scope_ini_path)
+    if scope_name:
+        report['Scope'] = scope_name
+
+    #
+    # check whether it's a click package or deb and collect additional pkg info
+    if scope_ini_path.find('.local/share') >= 0:
+        report['ClickPackage'] = 'True'
+        collect_click_info(report, scope_ini_path)
+    else:
+        collect_dpkg_info(report, scope_ini_path)

=== modified file 'debian/libunity-scopes3.install'
--- debian/libunity-scopes3.install	2015-01-15 04:56:00 +0000
+++ debian/libunity-scopes3.install	2015-02-04 09:48:00 +0000
@@ -4,3 +4,4 @@
 usr/lib/*/unity-scopes/scoperunner
 usr/lib/*/unity-scopes/smartscopesproxy
 usr/share/upstart/sessions/*.conf
+usr/share/apport/package-hooks/*.py