~launchpad-pqm/launchpad/devel

« back to all changes in this revision

Viewing changes to lib/lp/bugs/doc/externalbugtracker-trac-lp-plugin.txt

  • Committer: Launchpad Patch Queue Manager
  • Date: 2011-12-26 06:01:53 UTC
  • mfrom: (14575.2.4 megalint-9)
  • Revision ID: launchpad@pqm.canonical.com-20111226060153-1rfmi1yn90lu4fuf
[r=jtv][no-qa] Lint.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
= ExternalBugTracker: TracLPPlugin =
 
1
ExternalBugTracker: TracLPPlugin
 
2
================================
2
3
 
3
4
This covers the implementation of the ExternalBugTracker class for Trac
4
5
instances having the LP XML-RPC plugin installed.
17
18
    True
18
19
 
19
20
 
20
 
== Authentication ==
 
21
Authentication
 
22
--------------
21
23
 
22
24
Before any XML-RPC methods can be used, we need to authenticate with the
23
25
Trac instance. To authenticate we create a special login token in
147
149
    HTTP Error 401: Denied!
148
150
 
149
151
 
150
 
== Current time ==
 
152
Current time
 
153
------------
151
154
 
152
155
The current time is always returned in UTC, no matter if the Trac
153
156
instance returns another time zone.
191
194
    datetime.datetime(2008, 4, 9, 2, 2, 1, tzinfo=<UTC>)
192
195
 
193
196
 
194
 
== Getting modified bugs ==
 
197
Getting modified bugs
 
198
---------------------
195
199
 
196
200
We only want to update the bug watches whose remote bugs have been
197
201
modified since the last time we checked.
259
263
    ['1', '100', '3', '99']
260
264
 
261
265
 
262
 
== Getting the status of remote bugs ==
 
266
Getting the status of remote bugs
 
267
---------------------------------
263
268
 
264
269
Like all other ExternalBugTrackers, the TracLPPlugin ExternalBugTracker
265
270
allows us to fetch bugs statuses from the remote bug tracker.
300
305
    BugNotFound: 2
301
306
 
302
307
 
303
 
== Importing Comments ==
 
308
Importing Comments
 
309
------------------
304
310
 
305
311
The TracLPPlugin class allows Launchpad to import comments from remote
306
312
systems that have the Launchpad plugin installed.
466
472
    Sample Person
467
473
 
468
474
 
469
 
== Pushing comments ==
 
475
Pushing comments
 
476
----------------
470
477
 
471
478
The TracLPPlugin ExternalBugTracker implements the
472
479
ISupportsCommentPushing interface, which allows Launchpad to use it to
527
534
    user: launchpad
528
535
 
529
536
 
530
 
== Linking remote bugs to Launchpad bugs ==
 
537
Linking remote bugs to Launchpad bugs
 
538
-------------------------------------
531
539
 
532
540
The TracLPPlugin class implements the ISupportsBackLinking interface,
533
541
which allows it to tell the remote bug tracker which Launchpad bug