Merge lp:~robert-ancell/quickly/drop-lpi into lp:quickly

[Robert Ancell]

Remove Launchpad integration. It will be removed in Quantal:
https://blueprints.launchpad.net/ubuntu/+spec/desktop-q-gnome-plans-review

Not sure if this branch does enough, and also the packaging needs to be updated to drop the dependency.

[Didier Roche-Tolomelli (didrocks)]

that looks good. Nice work Robert!

I think you did all what is needed apart from giving an upgrade story.
Can you try to add an upgrade path to data/templates/ubuntu-application/upgrade.py to remove it (if the stenza is found) on project upgrade?
You should "just" need to remove bump the version of the template and remove the lpi lines if you find them anywhere on the project directory.

review: Needs Fixing

[Michael Terry (mterry)]

Didier, does this need to remove the code on upgrade? It's harmless if the module isn't present (ignores the exception).

[Didier Roche-Tolomelli (didrocks)]

@Michael: you are right, but that means that we will still install it if the application packaging was generated on a machine that have LPI, it will be pulled on the user's machine for nothing, wdyt?

[Michael Terry (mterry)]

Fair.

I have a branch I'm about to propose that will help with such upgrade.py issues (the branch will finally actually keep bin/, setup.py, and python_lib/ up to date with the latest versions automatically, so we don't have to keep managing upgrade.py ourselves for the quickly-owned code).

I'll base it off this branch because there is actually some overlapping changes in the apport test. So if the upgrade branch gets approval, this can land too, because it will get upgrade support automatically.

[Didier Roche-Tolomelli (didrocks)]

I'm approving this one then, please feel free to merge it altogether with your test branch

=== modified file 'data/templates/ubuntu-application/internal/apportutils.py'
--- data/templates/ubuntu-application/internal/apportutils.py	2011-06-06 10:14:40 +0000
+++ data/templates/ubuntu-application/internal/apportutils.py	2012-05-14 22:57:18 +0000
@@ -28,19 +28,6 @@
 
 from lxml import etree
 
-LPI_init_menu_block = """
-        # Optional Launchpad integration
-        # This shouldn't crash if not found as it is simply used for bug reporting.
-        # See https://wiki.ubuntu.com/UbuntuDevelopment/Internationalisation/Coding
-        # for more information about Launchpad integration.
-        try:
-            import LaunchpadIntegration
-            LaunchpadIntegration.add_items(self.ui.%(help_menu)s, 1, True, True)
-            LaunchpadIntegration.set_sourcepackagename('%(project_name)s')
-        except:
-            pass
-"""
-
 def update_apport(project_name, old_lp_project, new_lp_project):
     if not new_lp_project:
         return
@@ -88,50 +75,6 @@
                 os.makedirs(relative_apport_dir)
             templatetools.file_from_template(template_hook_dir, "source_project_name.py", relative_apport_dir, subst_new)
 
-def insert_lpi_if_required(project_name):
-    camel_case_project_name = quickly.templatetools.get_camel_case_name(project_name)
-    existing_base_filename = os.path.join(quickly.templatetools.python_name(project_name) + '_lib',
-                                          "Window.py")
-    existing_ui_filename = os.path.join("data", "ui", "%sWindow.ui"%camel_case_project_name)
-    
-    if os.path.isfile(existing_base_filename) and os.path.isfile(existing_ui_filename):
-        tree = etree.parse(existing_ui_filename)
-        help_menu = find_about_menu(tree)
-        
-        if help_menu:
-            existing_base_file = file(existing_base_filename, "r")
-            existing_lines = existing_base_file.readlines()
-            existing_base_file.close()
-            new_lines = detect_or_insert_lpi(existing_lines, project_name, help_menu)
-            if new_lines:
-                print _("Adding launchpad integration to existing application")
-                new_content = ''.join(new_lines)
-                templatetools.set_file_contents(existing_base_filename, new_content)
-            return True
-    return False
-        
-def detect_or_insert_lpi(existing_lines, project_name, help_menu):
-    integration_present = False
-    init_insert_line = None
-    current_line = 0
-    for line in existing_lines:
-        if "import LaunchpadIntegration" in line:
-            integration_present = True
-            break
-        if not init_insert_line and "self.builder.connect_signals(self)" in line:
-            init_insert_line = current_line
-        current_line += 1
-    
-    if not integration_present and init_insert_line:
-        init_menu_block = LPI_init_menu_block%{"project_name":project_name, "help_menu":help_menu}
-        existing_lines = existing_lines[:init_insert_line+1] + \
-            ["%s\n"%l for l in init_menu_block.splitlines()] + \
-            existing_lines[init_insert_line+1:]
-        return existing_lines
-    else:
-        return None
-
-
 def find_about_menu(tree):
     """Finds the current help menu in the passed xml document by looking for the gtk-about element"""
     help_item = tree.xpath('//property[@name="label" and .="gtk-about"]/../../../@id')

=== modified file 'data/templates/ubuntu-application/project_root/python_lib/Window.py'
--- data/templates/ubuntu-application/project_root/python_lib/Window.py	2011-11-07 21:55:54 +0000
+++ data/templates/ubuntu-application/project_root/python_lib/Window.py	2012-05-14 22:57:18 +0000
@@ -52,17 +52,6 @@
         self.settings = Gio.Settings("net.launchpad.project_name")
         self.settings.connect('changed', self.on_preferences_changed)
 
-        # Optional Launchpad integration
-        # This shouldn't crash if not found as it is simply used for bug reporting.
-        # See https://wiki.ubuntu.com/UbuntuDevelopment/Internationalisation/Coding
-        # for more information about Launchpad integration.
-        try:
-            from gi.repository import LaunchpadIntegration # pylint: disable=E0611
-            LaunchpadIntegration.add_items(self.ui.helpMenu, 1, True, True)
-            LaunchpadIntegration.set_sourcepackagename('project_name')
-        except ImportError:
-            pass
-
         # Optional application indicator support
         # Run 'quickly add indicator' to get started.
         # More information:

=== removed file 'data/templates/ubuntu-application/test/apport/TestProjectWindow.py.no_lpi'
--- data/templates/ubuntu-application/test/apport/TestProjectWindow.py.no_lpi	2011-03-01 20:12:22 +0000
+++ data/templates/ubuntu-application/test/apport/TestProjectWindow.py.no_lpi	1970-01-01 00:00:00 +0000
@@ -1,102 +0,0 @@
-# -*- Mode: Python; coding: utf-8; indent-tabs-mode: nil; tab-width: 4 -*-
-### BEGIN LICENSE
-# This file is in the public domain
-### END LICENSE
-
-import gtk
-
-import test.helpers as helpers
-
-import gettext
-from gettext import gettext as _
-gettext.textdomain('test')
-
-
-# This class is meant to be subclassed by TestWindow.  It provides
-# common functions and some boilerplate.
-class BaseTestWindow(gtk.Window):
-    __gtype_name__ = "BaseTestWindow"
-    
-    # To construct a new instance of this method, the following notable 
-    # methods are called in this order:
-    # __new__(cls)
-    # __init__(self)
-    # finish_initializing(self, builder)
-    # __init__(self)
-    #
-    # For this reason, it's recommended you leave __init__ empty and put
-    # your initialization code in finish_initializing
-    
-    def __new__(cls):
-        """Special static method that's automatically called by Python when 
-        constructing a new instance of this class.
-        
-        Returns a fully instantiated BaseTestWindow object.
-        """
-        builder = helpers.get_builder('TestWindow')
-        new_object = builder.get_object("test_window")
-        new_object.finish_initializing(builder)
-        return new_object
-
-    def finish_initializing(self, builder):
-        """Called while initializing this instance in __new__
-
-        finish_initializing should be called after parsing the UI definition
-        and creating a TestWindow object with it in order to finish
-        initializing the start of the new TestWindow instance.
-        
-        Put your initilization code in here and leave __init__ undefined.
-        """
-        # Get a reference to the builder and set up the signals.
-        self.builder = builder
-        self.builder.connect_signals(self)
-
-        # Optional application indicator support
-        # Run 'quickly add indicator' to get started.
-        # More information:
-        #  http://owaislone.org/quickly-add-indicator/
-        #  https://wiki.ubuntu.com/DesktopExperienceTeam/ApplicationIndicators
-        try:
-            from test import indicator
-            # self is passed so methods of this class can be called from indicator.py
-            # Comment this next line out to disable appindicator
-            self.indicator = indicator.new_application_indicator(self)
-        except:
-            pass
-
-    def load_preferences(self):
-        """Loads preferences into self.preferences"""
-        prefs = PreferencesTestDialog.PreferencesTestDialog()
-        self.preferences = prefs.get_preferences()
-
-    def about(self, widget, data=None):
-        """Display the about box for test."""
-        about = AboutTestDialog.AboutTestDialog()
-        response = about.run()
-        about.destroy()
-
-    def preferences(self, widget, data=None):
-        """Display the preferences window for test."""
-        prefs = PreferencesTestDialog.PreferencesTestDialog()
-        response = prefs.run()
-        if response == gtk.RESPONSE_OK and hasattr(self, 'preferences_updated'):
-            # Add a preferences_updated function to subclasses to react to
-            # changes that a user makes.  You'll find such changes in self.preferences
-            self.preferences = prefs.get_preferences() # in case load_preferences was never called
-            self.preferences_updated()
-        prefs.destroy()
-
-    def quit(self, widget, data=None):
-        """Signal handler for closing the TestWindow."""
-        self.destroy()
-
-    def on_destroy(self, widget, data=None):
-        """Called when the TestWindow is closed."""
-        # Clean up code for saving application state should be added here.
-        gtk.main_quit()
-
-
-if __name__ == "__main__":
-    window = BaseTestWindow()
-    window.show()
-    gtk.main()

=== modified file 'data/templates/ubuntu-application/test/apport/apport.sh'
--- data/templates/ubuntu-application/test/apport/apport.sh	2011-11-08 02:27:24 +0000
+++ data/templates/ubuntu-application/test/apport/apport.sh	2012-05-14 22:57:18 +0000
@@ -11,28 +11,12 @@
 
 cd test-project
 
-grep LaunchpadIntegration. test_project_lib/Window.py
-#             from gi.repository import LaunchpadIntegration # pylint: disable=E0611
-#             LaunchpadIntegration.add_items(self.ui.helpMenu, 1, True, True)
-#             LaunchpadIntegration.set_sourcepackagename('test-project')
-
-grep helpMenu test_project_lib/Window.py
-#             LaunchpadIntegration.add_items(self.ui.helpMenu, 1, True, True)
-
 quickly configure lp-project gpoweroff
 # Get Launchpad Settings
 # Launchpad connection is ok
 # Creating new apport crashdb configuration
 # Creating new apport hooks
 
-grep LaunchpadIntegration. test_project_lib/Window.py
-#             from gi.repository import LaunchpadIntegration # pylint: disable=E0611
-#             LaunchpadIntegration.add_items(self.ui.helpMenu, 1, True, True)
-#             LaunchpadIntegration.set_sourcepackagename('test-project')
-
-grep helpMenu test_project_lib/Window.py
-#             LaunchpadIntegration.add_items(self.ui.helpMenu, 1, True, True)
-
 bzr status
 # modified:
 #   .quickly
@@ -55,14 +39,6 @@
 # Launchpad connection is ok
 # Updating project name references in existing apport crashdb configuration
 
-grep LaunchpadIntegration. test_project_lib/Window.py
-#             from gi.repository import LaunchpadIntegration # pylint: disable=E0611
-#             LaunchpadIntegration.add_items(self.ui.helpMenu, 1, True, True)
-#             LaunchpadIntegration.set_sourcepackagename('test-project')
-
-grep helpMenu test_project_lib/Window.py
-#             LaunchpadIntegration.add_items(self.ui.helpMenu, 1, True, True)
-
 bzr status
 # added:
 #   apport/
@@ -121,14 +97,6 @@
 # Launchpad connection is ok
 # Updating project name references in existing apport crashdb configuration
 
-grep LaunchpadIntegration. test_project_lib/Window.py
-#             from gi.repository import LaunchpadIntegration # pylint: disable=E0611
-#             LaunchpadIntegration.add_items(self.ui.helpMenu, 1, True, True)
-#             LaunchpadIntegration.set_sourcepackagename('test-project')
-
-grep helpMenu test_project_lib/Window.py
-#             LaunchpadIntegration.add_items(self.ui.helpMenu, 1, True, True)
-
 bzr status
 # modified:
 #   .quickly
@@ -152,14 +120,6 @@
 # Updating project name references in existing apport crashdb configuration
 # Creating new apport hooks
 
-grep LaunchpadIntegration. test_project_lib/Window.py
-#             from gi.repository import LaunchpadIntegration # pylint: disable=E0611
-#             LaunchpadIntegration.add_items(self.ui.helpMenu, 1, True, True)
-#             LaunchpadIntegration.set_sourcepackagename('test-project')
-
-grep helpMenu test_project_lib/Window.py
-#             LaunchpadIntegration.add_items(self.ui.helpMenu, 1, True, True)
-
 cat etc/apport/crashdb.conf.d/test-project-crashdb.conf
 # ### BEGIN LICENSE
 # # This file is in the public domain
@@ -192,14 +152,6 @@
 # Launchpad connection is ok
 # Updating project name references in existing apport crashdb configuration
 
-grep LaunchpadIntegration. test_project_lib/Window.py
-#             from gi.repository import LaunchpadIntegration # pylint: disable=E0611
-#             LaunchpadIntegration.add_items(self.ui.helpMenu, 1, True, True)
-#             LaunchpadIntegration.set_sourcepackagename('test-project')
-
-grep helpMenu test_project_lib/Window.py
-#             LaunchpadIntegration.add_items(self.ui.helpMenu, 1, True, True)
-
 cat etc/apport/crashdb.conf.d/test-project-crashdb.conf
 # ### BEGIN LICENSE
 # # This file is in the public domain
@@ -319,14 +271,6 @@
 # Creating new apport crashdb configuration
 # Creating new apport hooks
 
-grep LaunchpadIntegration. test_project_lib/Window.py
-#             from gi.repository import LaunchpadIntegration # pylint: disable=E0611
-#             LaunchpadIntegration.add_items(self.ui.helpMenu, 1, True, True)
-#             LaunchpadIntegration.set_sourcepackagename('test-project')
-
-grep helpMenu test_project_lib/Window.py
-#             LaunchpadIntegration.add_items(self.ui.helpMenu, 1, True, True)
-
 cat etc/apport/crashdb.conf.d/test-project-crashdb.conf
 # ### BEGIN LICENSE
 # # This file is in the public domain
@@ -354,66 +298,38 @@
 #         report['ThirdParty'] = 'True'
 #         report['CrashDB'] = 'test_project'
 
-cp "$TEST_SCRIPT_DIR/TestProjectWindow.py.no_lpi" ./test_project_lib/Window.py
-
 cp "$TEST_SCRIPT_DIR/TestProjectWindow.ui.renamed_help_menu" ./data/ui/TestProjectWindow.ui
 
 rm -rf apport
 
 rm -rf etc
 
-grep LaunchpadIntegration. test_project_lib/Window.py
-
-grep helpMenu test_project_lib/Window.py
-
 quickly upgrade 0.3
-# Adding launchpad integration to existing application
 # Creating new apport crashdb configuration
 # Creating new apport hooks
 
-grep LaunchpadIntegration. test_project_lib/Window.py
-#             LaunchpadIntegration.add_items(self.ui.differentHelpMenu, 1, True, True)
-#             LaunchpadIntegration.set_sourcepackagename('test-project')
-
-cp "$TEST_SCRIPT_DIR/TestProjectWindow.py.no_lpi" ./test_project_lib/Window.py
-
 cp "$TEST_SCRIPT_DIR/TestProjectWindow.ui.no_gtk-about" ./data/ui/TestProjectWindow.ui
 
 rm -rf apport
 
 rm -rf etc
 
-grep LaunchpadIntegration. test_project_lib/Window.py
-
-grep helpMenu test_project_lib/Window.py
-
 grep gtk-about data/ui/TestProjectWindow.ui
 
 bzr commit -m "Committing after removing all lpi integration"
 # Committing to: /tmp/test-project/
 # modified data/ui/TestProjectWindow.ui
-# modified test_project_lib/Window.py
 # Committed revision 6.
 
 quickly upgrade 0.3
 # Creating new apport crashdb configuration
 # Creating new apport hooks
 
-grep LaunchpadIntegration. test_project_lib/Window.py
-
-grep helpMenu test_project_lib/Window.py
-
 bzr status
 # unknown:
 #   apport/
 #   etc/
 
-cp "$TEST_SCRIPT_DIR/TestProjectWindow.py.no_lpi" ./test_project_lib/Window.py
-
 rm ./data/ui/TestProjectWindow.ui
 
-grep LaunchpadIntegration. test_project_lib/Window.py
-
-grep helpMenu test_project_lib/Window.py
-
 quickly upgrade 0.3

=== modified file 'data/templates/ubuntu-application/test/apportutils.py'
--- data/templates/ubuntu-application/test/apportutils.py	2011-04-04 13:22:11 +0000
+++ data/templates/ubuntu-application/test/apportutils.py	2012-05-14 22:57:18 +0000
@@ -17,146 +17,6 @@
 from internal import apportutils
 
 class TestApportUtils(unittest.TestCase):
-    def test_lpi_existing(self):
-        lines = """#!/usr/bin/python
-import sys
-import os
-import gtk
-import gettext
-from gettext import gettext as _
-gettext.textdomain('project_name')
-
-# optional Launchpad integration
-# this shouldn't crash if not found as it is simply used for bug reporting
-try:
-    import LaunchpadIntegration
-    launchpad_available = True
-except:
-    launchpad_available = False        
-        
-class camel_case_nameWindow(gtk.Window):
-    __gtype_name__ = "camel_case_nameWindow"
-
-    def __init__(self):
-        pass
-
-    def finish_initializing(self, builder):
-        # Get a reference to the builder and set up the signals.
-        self.builder = builder
-        self.builder.connect_signals(self)
-
-        if launchpad_available:
-            # see https://wiki.ubuntu.com/UbuntuDevelopment/Internationalisation/Coding for more information
-            # about LaunchpadIntegration
-            LaunchpadIntegration.set_sourcepackagename('project_name')
-            LaunchpadIntegration.add_items(self.builder.get_object('helpMenu'), 1, True, True)
-            
-    def about(self, widget, data=None):
-        about = Aboutcamel_case_nameDialog.NewAboutcamel_case_nameDialog()
-        response = about.run()
-        about.destroy()
-""".splitlines()
-        self.failIf(apportutils.detect_or_insert_lpi(lines, "project_name1", "helpMenu1"))
-
-    def test_partial_lpi_import_only(self):
-        lines = """#!/usr/bin/python
-import sys
-import os
-import gtk
-import gettext
-from gettext import gettext as _
-gettext.textdomain('project_name')
-
-# optional Launchpad integration
-# this shouldn't crash if not found as it is simply used for bug reporting
-try:
-    import LaunchpadIntegration
-    launchpad_available = True
-except:
-    launchpad_available = False        
-        
-class camel_case_nameWindow(gtk.Window):
-    __gtype_name__ = "camel_case_nameWindow"
-
-    def __init__(self):
-        pass
-
-    def finish_initializing(self, builder):
-        # Get a reference to the builder and set up the signals.
-        self.builder = builder
-        self.builder.connect_signals(self)
-            
-    def about(self, widget, data=None):
-        about = Aboutcamel_case_nameDialog.NewAboutcamel_case_nameDialog()
-        response = about.run()
-        about.destroy()
-""".splitlines()
-        self.failIf(apportutils.detect_or_insert_lpi(lines, "project_name1", "helpMenu1"))
-
-    def test_no_lpi(self):
-        lines = """#!/usr/bin/python
-import sys
-import os
-import gtk
-import gettext
-from gettext import gettext as _
-gettext.textdomain('project_name')
-       
-class camel_case_nameWindow(gtk.Window):
-    __gtype_name__ = "camel_case_nameWindow"
-
-    def __init__(self):
-        pass
-
-    def finish_initializing(self, builder):
-        # Get a reference to the builder and set up the signals.
-        self.builder = builder
-        self.builder.connect_signals(self)
-            
-    def about(self, widget, data=None):
-        about = Aboutcamel_case_nameDialog.NewAboutcamel_case_nameDialog()
-        response = about.run()
-        about.destroy()
-""".splitlines(True)
-        expected = """#!/usr/bin/python
-import sys
-import os
-import gtk
-import gettext
-from gettext import gettext as _
-gettext.textdomain('project_name')
-       
-class camel_case_nameWindow(gtk.Window):
-    __gtype_name__ = "camel_case_nameWindow"
-
-    def __init__(self):
-        pass
-
-    def finish_initializing(self, builder):
-        # Get a reference to the builder and set up the signals.
-        self.builder = builder
-        self.builder.connect_signals(self)
-
-        # Optional Launchpad integration
-        # This shouldn't crash if not found as it is simply used for bug reporting.
-        # See https://wiki.ubuntu.com/UbuntuDevelopment/Internationalisation/Coding
-        # for more information about Launchpad integration.
-        try:
-            import LaunchpadIntegration
-            LaunchpadIntegration.add_items(self.ui.helpMenu1, 1, True, True)
-            LaunchpadIntegration.set_sourcepackagename('project_name1')
-        except:
-            pass
-            
-    def about(self, widget, data=None):
-        about = Aboutcamel_case_nameDialog.NewAboutcamel_case_nameDialog()
-        response = about.run()
-        about.destroy()
-"""
-        # print "".join(apportutils.detect_or_insert_lpi(lines, "project_name1", "helpMenu1"))
-        # print "".join(expected.splitlines(True))
-        self.assertEqual("".join(expected.splitlines(True)).strip(), "".join(apportutils.detect_or_insert_lpi(lines, "project_name1", "helpMenu1")).strip())
-
     def test_find_about_menu(self):
         xml_tree = etree.parse(StringIO.StringIO("""<?xml version="1.0"?>
 <interface>

=== modified file 'data/templates/ubuntu-application/upgrade.py'
--- data/templates/ubuntu-application/upgrade.py	2011-12-22 16:42:11 +0000
+++ data/templates/ubuntu-application/upgrade.py	2012-05-14 22:57:18 +0000
@@ -169,7 +169,6 @@
         pass
 
     # add apport hooks if launchpad application is configured
-    internal.apportutils.insert_lpi_if_required(project_name)
     lp_project_name = configurationhandler.project_config.get('lp_id', None)
     if lp_project_name is not None:
         internal.apportutils.update_apport(project_name, lp_project_name, lp_project_name)