Merge lp:~lifeless/lptools/upstream into lp:~dobey/lptools/trunk

[Robert Collins]

[Robert Collins (lifeless)]

This adds an lptools package and reduces some duplicate code; I also added a lp-milestones command with a 'create' command. I'll probably add a few more as I automate my release management process.

Oh, it uses bzrlib's command processing facilities, because they are awesome. You might say 'use commandant instead', but that isn't packaged yet.

[Robert Collins (lifeless)]

Oh, and commandant depends on bzrlib anyhow :)

[Robert Collins (lifeless)]

I've added a delete and rename command to this.

[lp:~lifeless/lptools/upstream]

14. By Robert Collins on 2010-02-20

Faster creation please.

15. By Robert Collins on 2010-02-20

Work around launchpadlib wanting absolute urls for.load.

16. By Robert Collins on 2010-02-20

Add milestone deletion.

17. By Robert Collins on 2010-02-20

Add milestone renaming.

[Robert Collins (lifeless)]

I've also added 'release' as a subcommand, so one can totally script the release process.

[lp:~lifeless/lptools/upstream]

18. By Robert Collins on 2010-02-20

Add releasing.

19. By Robert Collins on 2010-02-20

Correctly handle failures in milestones delete.

[dobey (dobey)]

review: Approve

=== added file 'bin/lp-milestones'
--- bin/lp-milestones	1970-01-01 00:00:00 +0000
+++ bin/lp-milestones	2010-02-20 06:50:29 +0000
@@ -0,0 +1,189 @@
+#!/usr/bin/python
+#
+# Author: Robert Collins <[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/>.
+
+from __future__ import with_statement
+import time
+import optparse
+import os
+import sys
+
+# Might want to make errors import lazy.
+from bzrlib import commands, errors, ui, version_info as bzr_version_info
+from launchpadlib.errors import HTTPError
+
+from lptools import config
+
+def list_commands(command_names):
+    mod = sys.modules[__name__]
+    command_names.update(commands._scan_module_for_commands(mod))
+    return command_names
+
+
+def get_command(cmd_or_None, cmd_name):
+    if cmd_name is None:
+        return cmd_help()
+    try:
+        return globals()['cmd_' + cmd_name]()
+    except KeyError:
+        return cmd_or_None
+
+
+class LaunchpadCommand(commands.Command):
+    """Base class for commands working with launchpad."""
+
+    def run_argv_aliases(self, argv, alias_argv=None):
+        # This might not be unique-enough for a cachedir; can do
+        # lp-milestones/cmdname if needed.
+        self.launchpad = config.get_launchpad('lp-milestones')
+        return commands.Command.run_argv_aliases(self, argv, alias_argv)
+
+
+class cmd_create(LaunchpadCommand):
+    """Create a milestone.
+    
+    lp-milestone create projectname/seriesname/milestonename
+    """
+
+    takes_args = ['milestone']
+
+    def run(self, milestone):
+        components = milestone.split('/')
+        if len(components) != 3:
+            raise errors.BzrCommandError("milestone (%s) too short or too long."
+                % milestone)
+        projectname, seriesname, milestonename = components
+        # Direct access takes 50% of the time of doing traversal.
+        #proj = self.launchpad.projects[projectname]
+        #series = proj.getSeries(name=seriesname)
+        series = self.launchpad.load(projectname + '/' + seriesname)
+        milestone = series.newMilestone(name=milestonename)
+
+
+class cmd_delete(LaunchpadCommand):
+    """Delete a milestone.
+    
+    lp-milestone delete projectname/milestonename
+
+    Note that this cannot delete a milestone with releases on it (yet). The
+    server will throw a 500 error, and you may see
+      File "/srv/////lib/lp/registry/model/milestone.py", line 209, in destroySelf
+          "You cannot delete a milestone which has a product release "
+          AssertionError: You cannot delete a milestone which has a product release associated with it.
+    In the trace if you have appropriate access.
+    """
+
+    takes_args = ['milestone']
+
+    def run(self, milestone):
+        components = milestone.split('/')
+        if len(components) != 2:
+            raise errors.BzrCommandError("milestone (%s) too short or too long."
+                % milestone)
+        m = self.launchpad.load('%s/+milestone/%s' % tuple(components))
+        try:
+            m.delete()
+        except HTTPError, e:
+            if e.response.status == 404:
+                pass
+            elif e.response.status == 500:
+                self.outf.write("Perhaps the milestone has been released?\n")
+                self.outf.write("If so you can undo this in the web UI.\n")
+                raise
+            else:
+                raise
+
+
+class cmd_help(commands.Command):
+    """Show help on a command or other topic."""
+
+    # Can't use the stock bzrlib help, because the help indices aren't quite
+    # generic enough.
+    takes_args = ['topic?']
+    def run(self, topic=None):
+        if topic is None:
+            self.outf.write(
+"""lp-milestones -- An lptools command to work with milestones in launchpad.
+https://launchpad.net/lptools/
+
+lp-milestones help commands -- list commands
+""")
+        else:
+            import bzrlib.help
+            bzrlib.help.help(topic)
+
+
+class cmd_release(LaunchpadCommand):
+    """Create a release from a milestone.
+    
+    lp-milestone release projectname/milestonename
+    """
+
+    takes_args = ['milestone']
+
+    def run(self, milestone):
+        components = milestone.split('/')
+        if len(components) != 2:
+            raise errors.BzrCommandError("milestone (%s) too short or too long."
+                % milestone)
+        m = self.launchpad.load('%s/+milestone/%s' % tuple(components))
+        now = time.strftime('%Y-%m-%d-%X', time.gmtime())
+        # note: there is a bug with how the releases are created, don't be surprised
+        # if they are created 'X hours ago' where 'X' is the hour in UTC.
+        m.createProductRelease(date_released=now)
+
+
+class cmd_rename(LaunchpadCommand):
+    """Rename a milestone.
+    
+    lp-milestone rename projectname/milestonename newname
+    """
+
+    takes_args = ['milestone', 'newname']
+
+    def run(self, milestone, newname):
+        components = milestone.split('/')
+        if len(components) != 2:
+            raise errors.BzrCommandError("milestone (%s) too short or too long."
+                % milestone)
+        if '/' in newname:
+            raise errors.BzrCommandError(
+                "milestones can only be renamed within a project.")
+        m = self.launchpad.load('%s/+milestone/%s' % tuple(components))
+        m.name = newname
+        m.lp_save()
+
+
+def do_run_bzr(argv):
+    if bzr_version_info > (2, 2, 0):
+        # in bzr 2.2 we can disable bzr plugins so bzr commands don't show
+        # up.
+        return commands.run_bzr(argv, lambda:None, lambda:None)
+    else:
+        return commands.run_bzr(argv)
+
+
+def main():
+    commands.Command.hooks.install_named_hook('list_commands', list_commands,
+        "list")
+    commands.Command.hooks.install_named_hook('get_command', get_command,
+        "get")
+    ui.ui_factory = ui.make_ui_for_terminal(sys.stdin, sys.stdout, sys.stderr)
+    sys.exit(commands.exception_to_return_code(do_run_bzr, sys.argv[1:]))
+
+if __name__ == "__main__":
+    main()

=== modified file 'bin/lp-review-list'
--- bin/lp-review-list	2010-02-01 05:30:54 +0000
+++ bin/lp-review-list	2010-02-20 06:50:30 +0000
@@ -17,25 +17,21 @@
 # with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 from __future__ import with_statement
+from ConfigParser import ConfigParser
+import os
+import re
+import subprocess
+import sys
+from threading import Thread
 
 import pygtk
 pygtk.require('2.0')
 import gobject
 import gtk
 import pango
-
-from ConfigParser import ConfigParser
-import os
-import re
-import subprocess
-import sys
-
 from xdg.BaseDirectory import xdg_cache_home, xdg_config_home
 
-from threading import Thread
-
-from launchpadlib.launchpad import Launchpad, EDGE_SERVICE_ROOT
-from launchpadlib.credentials import Credentials
+from lptools import config
 
 VOTES = { "Approve" : "#00ff00",
           "Needs Fixing" : "#993300",
@@ -65,6 +61,7 @@
             else:
                   self.projects = []
 
+            # XXX: Not currently honoured - not sure if it ever worked.
             if self.config.has_option("lptools", "server"):
                   self.api_server = self.config.get("lptools", "server")
             else:
@@ -167,7 +164,7 @@
             self.set_title("Pending Reviews")
             self.set_default_size(320, 400)
             self.connect("destroy", lambda w: gtk.main_quit())
-            self.connect("delete_event", lambda w: gtk.main_quit())
+            self.connect("delete_event", lambda w,x: gtk.main_quit())
 
             vbox = gtk.VBox()
             self.add(vbox)
@@ -203,10 +200,6 @@
             col = gtk.TreeViewColumn("Branch", cell, markup=0)
             view.append_column(col)
 
-            self.cachedir = os.path.join(xdg_cache_home, "review-list")
-            if not os.path.isdir(self.cachedir):
-                  os.makedirs(self.cachedir)
-
             self.launchpad = None
             self.me = None
 
@@ -220,21 +213,7 @@
             Thread(target=self.__lp_login).start()
 
       def __lp_login(self):
-            credsfile = os.path.join(self.cachedir, "credentials")
-
-            if os.path.exists(credsfile):
-                  creds = Credentials()
-
-                  with file(credsfile) as f:
-                        creds.load(f)
-                  self.launchpad = Launchpad(creds, EDGE_SERVICE_ROOT)
-            else:
-                  self.launchpad = Launchpad.get_token_and_login(
-                        'review-list',
-                        EDGE_SERVICE_ROOT,
-                        self.cachedir)
-                  with file(credsfile, "w") as f:
-                        self.launchpad.credentials.save(f)
+            self.launchpad = config.get_launchpad("review-list")
 
             self.me = self.launchpad.me
 

=== modified file 'bin/lp-review-notifier'
--- bin/lp-review-notifier	2010-02-01 05:30:54 +0000
+++ bin/lp-review-notifier	2010-02-20 06:50:29 +0000
@@ -17,21 +17,18 @@
 # with this program.  If not, see <http://www.gnu.org/licenses/>.
 
 from __future__ import with_statement
+import os
+import sys
 
-import pygtk
-pygtk.require('2.0')
 import gobject
 import gtk
-
+import pygtk
 import pynotify
-
-import os
-import sys
-
 from xdg.BaseDirectory import xdg_cache_home
 
-from launchpadlib.launchpad import Launchpad, EDGE_SERVICE_ROOT
-from launchpadlib.credentials import Credentials
+from lptools import config
+
+pygtk.require('2.0')
 
 ICON_NAME = "bzr-icon-64"
 
@@ -40,31 +37,14 @@
     def __init__(self):
         self.id = 0
         self.cached_candidates = {}
-
-        self.cachedir = os.path.join(xdg_cache_home, "review-notifier")
-        credsfile = os.path.join(self.cachedir, "credentials")
-
-        if not os.path.isdir(self.cachedir):
-            os.makedirs(self.cachedir)
-
-        if os.path.exists(credsfile):
-            creds = Credentials()
-            with file(credsfile) as f:
-                creds.load(f)
-            self.launchpad = Launchpad(creds, EDGE_SERVICE_ROOT)
-        else:
-            self.launchpad = Launchpad.get_token_and_login('review-notifier',
-                                                           EDGE_SERVICE_ROOT,
-                                                           self.cachedir)
-            with file(credsfile, "w") as f:
-                self.launchpad.credentials.save(f)
-
+        self.launchpad = config.get_launchpad("review-notifier")
         self.me = self.launchpad.me
 
         print "Allo, %s" % self.me.name
 
         self.projects = []
 
+        # TODO: get the config from lptools.conf
         for arg in sys.argv:
             if not arg.endswith("review-notifier"):
                 self.projects.append(arg)

=== added directory 'lptools'
=== added file 'lptools/__init__.py'
--- lptools/__init__.py	1970-01-01 00:00:00 +0000
+++ lptools/__init__.py	2010-02-20 06:50:30 +0000
@@ -0,0 +1,20 @@
+# Author: Robert Collins <[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/>.
+
+"""LP-tools is largely command line tools. The package contains various helpers.
+
+See lptools.config for configuration support logic.
+"""

=== added file 'lptools/config.py'
--- lptools/config.py	1970-01-01 00:00:00 +0000
+++ lptools/config.py	2010-02-20 06:50:30 +0000
@@ -0,0 +1,83 @@
+# Author: Robert Collins <[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/>.
+
+from __future__ import with_statement
+
+"""Configuration glue for lptools."""
+
+__all__ = [
+    "ensure_dir",
+    "get_launchpad",
+    "lptools_cachedir",
+    "lptools_credentials_path",
+    ]
+
+import os.path
+
+from launchpadlib.credentials import Credentials
+from launchpadlib.launchpad import EDGE_SERVICE_ROOT
+from xdg.BaseDirectory import xdg_cache_home
+
+from lptools import launchpad
+
+
+def ensure_dir(dir):
+    """Ensure that dir exists."""
+    if not os.path.isdir(dir):
+        os.makedirs(dir)
+
+
+def get_launchpad(appname):
+    """Get a login to launchpad for lptools caching in cachedir.
+    
+    Note that caching is not multiple-process safe in launchpadlib, and the
+    appname parameter is used to create per-app cachedirs.
+
+    :param appname: The name of the app used to create per-app cachedirs.
+    """
+    cachedir = os.path.join(xdg_cache_home, appname)
+    ensure_dir(cachedir)
+    credspath = lptools_credentials_path()
+    if os.path.exists(credspath):
+        creds = Credentials()
+        with file(credspath) as f:
+            creds.load(f)
+        return launchpad.Launchpad(creds, EDGE_SERVICE_ROOT, cachedir)
+    else:
+        result = launchpad.Launchpad.get_token_and_login('lptools',
+            EDGE_SERVICE_ROOT, cachedir)
+        with file(credspath, "w") as f:
+            result.credentials.save(f)
+        return result
+
+
+def lptools_cachedir():
+    """Return the cachedir for common lptools things.
+    
+    This is xdg_cache_home/lptools.
+    """
+    return os.path.join(xdg_cache_home, "lptools")
+
+
+def lptools_credentials_path():
+    """Return the path to the lptools credentials file.
+    
+    This also ensures the path is usable by checking it's containing directory
+    exists.
+    """
+    cachedir = lptools_cachedir()
+    ensure_dir(cachedir)
+    return os.path.join(lptools_cachedir(), 'credentials')

=== added file 'lptools/launchpad.py'
--- lptools/launchpad.py	1970-01-01 00:00:00 +0000
+++ lptools/launchpad.py	2010-02-20 06:50:30 +0000
@@ -0,0 +1,38 @@
+# Author: Robert Collins <[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/>.
+
+__all__ = [
+    'Launchpad',
+    ]
+
+"""Wrapper class for launchpadlib with tweaks."""
+
+from launchpadlib.launchpad import Launchpad as UpstreamLaunchpad
+
+class Launchpad(UpstreamLaunchpad):
+    """Launchpad object with bugfixes."""
+
+    def load(self, url_string):
+        """Load an object.
+        
+        Extended to support url_string being a relative url.
+
+        Needed until bug 524775 is fixed.
+        """
+        if not url_string.startswith('https:'):
+            return UpstreamLaunchpad.load(self, str(self._root_uri) + url_string)
+        else:
+            return UpstreamLaunchpad.load(self, url_string)

=== modified file 'setup.py'
--- setup.py	2010-02-01 05:30:54 +0000
+++ setup.py	2010-02-20 06:50:29 +0000
@@ -2,6 +2,9 @@
 
 from glob import glob
 from distutils.core import setup
+import os.path
+
+description = file(os.path.join(os.path.dirname(__file__), 'README'), 'rb').read()
 
 setup(
     name='lptools',
@@ -11,7 +14,17 @@
     author_email='[e-mail]',
     license='GPLv3',
     description='A collection of tools for developers who use launchpad',
+    long_description=description,
     py_modules=[],
+    packages=['lptools'],
     scripts=glob('bin/*'),
+    classifiers = [
+        'Development Status :: 4 - Beta',
+        'Intended Audience :: Developers',
+        'License :: OSI Approved :: GNU General Public License v3 (GPL3)'
+        'Operating System :: OS Independent',
+        'Programming Language :: Python',
+        'Topic :: Software Development',
+        ],
     )