Merge lp:~gmb/launchpad/add-bugzilla-3.4-ebt-bug-415778 into lp:launchpad

[Graham Binns]

[Graham Binns (gmb)]

This branch adds an ExternalBugTracker to support Bugzilla instances
that offer an API.

I've added the BugzillaAPI ExternalBugTracker as a subclass of the
Bugzilla ExternalBugTracker and made the existing BugzillaLPPlugin
inherit from it. This is because BugzillaLPPlugin currently offers a
superset of the BugzillaAPI functionality. If the inheritance went the
other way we'd end up with an ExternalBugTracker that claimed to do
things that it doesn't at the moment (e.g. syncing of comments).

It's very likely that significant functionality that's currently part of
BugzillaLPPlugin will be refactored into BugzillaAPI in subsequent
branches.

Test command: bin/test -vvt externalbugtracker-bugzilla-api.txt -t externalbugtracker-bugzilla-lp-plugin.txt

[Gavin Panella (allenap)]

review: Approve

=== added file 'lib/lp/bugs/doc/externalbugtracker-bugzilla-api.txt'
--- lib/lp/bugs/doc/externalbugtracker-bugzilla-api.txt	1970-01-01 00:00:00 +0000
+++ lib/lp/bugs/doc/externalbugtracker-bugzilla-api.txt	2009-08-19 08:01:23 +0000
@@ -0,0 +1,22 @@
+Bugzilla bugtrackers with an XML-RPC API
+========================================
+
+Instances of Bugzilla version 3.4+ offer an XML-RPC API for working with
+bugs. This is very similar in some regards to that offered by the
+Launchpad plugin for versions 3.0 and 3.2, however the differences
+between them necessitate Launchpad's support for Bugzilla 3.4+ being
+implemented as a separate ExternalBugTracker.
+
+As with the BugzillaLPPlugin ExternalBugTracker, we use a special XML-RPC
+transport for the purposes of testing.
+
+    >>> from lp.bugs.externalbugtracker.bugzilla import (
+    ...     BugzillaAPI)
+    >>> from lp.bugs.tests.externalbugtracker import (
+    ...     TestBugzillaAPIXMLRPCTransport)
+    >>> test_transport = TestBugzillaAPIXMLRPCTransport(
+    ...     'http://example.com/')
+    >>> bugzilla = BugzillaAPI(
+    ...     'http://example.com/', xmlrpc_transport=test_transport)
+    >>> bugzilla.xmlrpc_transport == test_transport
+    True

=== modified file 'lib/lp/bugs/doc/externalbugtracker-bugzilla-lp-plugin.txt'
--- lib/lp/bugs/doc/externalbugtracker-bugzilla-lp-plugin.txt	2009-07-08 09:28:40 +0000
+++ lib/lp/bugs/doc/externalbugtracker-bugzilla-lp-plugin.txt	2009-08-19 09:22:08 +0000
@@ -16,6 +16,14 @@
     >>> bugzilla.xmlrpc_transport == test_transport
     True
 
+BugzillaLPPlugin inherits from the BugzillaAPI ExternalBugTracker, with
+which it shares some functionality.
+
+    >>> from lp.bugs.externalbugtracker.bugzilla import (
+    ...     BugzillaAPI)
+    >>> issubclass(BugzillaLPPlugin, BugzillaAPI)
+    True
+
 
 == Authentication ==
 

=== modified file 'lib/lp/bugs/externalbugtracker/bugzilla.py'
--- lib/lp/bugs/externalbugtracker/bugzilla.py	2009-06-25 00:40:31 +0000
+++ lib/lp/bugs/externalbugtracker/bugzilla.py	2009-08-19 09:22:08 +0000
@@ -6,6 +6,7 @@
 __metaclass__ = type
 __all__ = [
     'Bugzilla',
+    'BugzillaAPI',
     'BugzillaLPPlugin',
     'needs_authentication',
     ]
@@ -370,16 +371,12 @@
     return decorator
 
 
-class BugzillaLPPlugin(Bugzilla):
-    """An `ExternalBugTracker` to handle Bugzillas using the LP Plugin."""
-
-    implements(
-        ISupportsBackLinking, ISupportsCommentImport,
-        ISupportsCommentPushing)
+class BugzillaAPI(Bugzilla):
+    """An `ExternalBugTracker` to handle Bugzillas that offer an API."""
 
     def __init__(self, baseurl, xmlrpc_transport=None,
                  internal_xmlrpc_transport=None):
-        super(BugzillaLPPlugin, self).__init__(baseurl)
+        super(BugzillaAPI, self).__init__(baseurl)
         self._bugs = {}
         self._bug_aliases = {}
 
@@ -397,6 +394,15 @@
         return xmlrpclib.ServerProxy(
             self.xmlrpc_endpoint, transport=self.xmlrpc_transport)
 
+
+
+class BugzillaLPPlugin(BugzillaAPI):
+    """An `ExternalBugTracker` to handle Bugzillas using the LP Plugin."""
+
+    implements(
+        ISupportsBackLinking, ISupportsCommentImport,
+        ISupportsCommentPushing)
+
     def _authenticate(self):
         """Authenticate with the remote Bugzilla instance.
 

=== modified file 'lib/lp/bugs/tests/test_doc.py'
--- lib/lp/bugs/tests/test_doc.py	2009-06-25 00:40:31 +0000
+++ lib/lp/bugs/tests/test_doc.py	2009-08-19 08:01:23 +0000
@@ -238,6 +238,13 @@
         tearDown=tearDown,
         layer=LaunchpadZopelessLayer
         ),
+    'externalbugtracker-bugzilla-api.txt':
+        LayeredDocFileSuite(
+        '../doc/externalbugtracker-bugzilla-api.txt',
+        setUp=checkwatchesSetUp,
+        tearDown=tearDown,
+        layer=LaunchpadZopelessLayer
+        ),
     'externalbugtracker-bugzilla-lp-plugin.txt':
         LayeredDocFileSuite(
         '../doc/externalbugtracker-bugzilla-lp-plugin.txt',