Merge lp:~gmb/launchpad/cw-refactor-create-rename-bwu-567793 into lp:launchpad

[Graham Binns]

Rename BugWatchUpdater to CheckwatchesMaster and move checkwatches.updater to checkwatches.core.

This branch is the first stage of a big, mad checkwatches refactoring.

In this branch I renamed BugWatchUpdater to CheckwatchesMaster* (since we're going to use BugWatchUpdater for something else). I also renamed checkwatches.updater to checkwatches.core to avoid confusion with new modules as they're added.

*Note, I hate this name and think it's wrong; please suggest another one.

[Gavin Panella (allenap)]

review: Approve

[Robert Collins (lifeless)]

Perhaps BugWatchUpdaterController ?

=== modified file 'lib/lp/bugs/doc/bug-watch-activity.txt'
--- lib/lp/bugs/doc/bug-watch-activity.txt	2010-03-22 14:28:03 +0000
+++ lib/lp/bugs/doc/bug-watch-activity.txt	2010-04-21 12:20:54 +0000
@@ -68,12 +68,12 @@
 BugWatchActivity entry.
 
 We can demonstrate this by passing our bug watch to
-BugWatchUpdater.updateBugWatches().
+CheckwatchesMaster.updateBugWatches().
 
     >>> from canonical.launchpad.scripts.logger import QuietFakeLogger
-    >>> from lp.bugs.scripts.checkwatches import BugWatchUpdater
+    >>> from lp.bugs.scripts.checkwatches import CheckwatchesMaster
     >>> from lp.bugs.tests.externalbugtracker import TestExternalBugTracker
-    >>> updater = BugWatchUpdater(transaction, QuietFakeLogger())
+    >>> updater = CheckwatchesMaster(transaction, QuietFakeLogger())
     >>> updater.updateBugWatches(
     ...     TestExternalBugTracker('http://example.com'), [bug_watch])
 
@@ -128,7 +128,7 @@
     >>> print most_recent_activity.oops_id
     OOPS...
 
-The BugWatchUpdater also adds BugWatchActivity entries when errors occur
+The CheckwatchesMaster also adds BugWatchActivity entries when errors occur
 that don't have an entry in the BugWatchActivityStatus DB Enum.
 
     >>> broken_bugtracker.get_remote_status_error = Exception

=== modified file 'lib/lp/bugs/doc/bugwatch.txt'
--- lib/lp/bugs/doc/bugwatch.txt	2010-03-26 10:39:53 +0000
+++ lib/lp/bugs/doc/bugwatch.txt	2010-04-21 12:20:54 +0000
@@ -462,9 +462,9 @@
     >>> import transaction
     >>> from lp.bugs.tests.externalbugtracker import (
     ...     TestRoundup)
-    >>> from lp.bugs.scripts.checkwatches import BugWatchUpdater
+    >>> from lp.bugs.scripts.checkwatches import CheckwatchesMaster
     >>> from canonical.launchpad.scripts.logger import FakeLogger
-    >>> bug_watch_updater = BugWatchUpdater(transaction, FakeLogger())
+    >>> bug_watch_updater = CheckwatchesMaster(transaction, FakeLogger())
     >>> external_bugtracker = TestRoundup(bug_tracker.baseurl)
     >>> bug_watch_updater.updateBugWatches(external_bugtracker, [bug_watch])
     INFO Updating 1 watches for 1 bugs on http://some.where

=== modified file 'lib/lp/bugs/doc/checkwatches-batching.txt'
--- lib/lp/bugs/doc/checkwatches-batching.txt	2010-03-26 15:24:59 +0000
+++ lib/lp/bugs/doc/checkwatches-batching.txt	2010-04-21 12:20:54 +0000
@@ -6,10 +6,10 @@
 for batching up operations.
 
     >>> import transaction
-    >>> from lp.bugs.scripts.checkwatches import BugWatchUpdater
+    >>> from lp.bugs.scripts.checkwatches import CheckwatchesMaster
     >>> from pprint import pprint
 
-    >>> updater = BugWatchUpdater(transaction)
+    >>> updater = CheckwatchesMaster(transaction)
     >>> transaction.commit()
 
 

=== modified file 'lib/lp/bugs/doc/checkwatches-cli-switches.txt'
--- lib/lp/bugs/doc/checkwatches-cli-switches.txt	2010-04-21 12:20:52 +0000
+++ lib/lp/bugs/doc/checkwatches-cli-switches.txt	2010-04-21 12:20:54 +0000
@@ -1,6 +1,6 @@
 = Updating selected bug trackers =
 
-The BugWatchUpdater class can be instructed to update only a subset of
+The CheckwatchesMaster class can be instructed to update only a subset of
 bugtrackers. This is acheived by passing a list of bug tracker names to
 the updateBugTrackers() method.
 
@@ -9,7 +9,7 @@
     ...     cursor, sqlvalues, ZopelessTransactionManager)
     >>> from canonical.database.constants import UTC_NOW
     >>> from canonical.launchpad.scripts import FakeLogger
-    >>> from lp.bugs.scripts.checkwatches import BugWatchUpdater
+    >>> from lp.bugs.scripts.checkwatches import CheckwatchesMaster
 
 We'll update all bugtrackers so that the test doesn't try to make any
 external connections.
@@ -20,7 +20,7 @@
     >>> transaction.commit()
 
     >>> transactionmgr = ZopelessTransactionManager._installed
-    >>> updater = BugWatchUpdater(transactionmgr, logger=FakeLogger())
+    >>> updater = CheckwatchesMaster(transactionmgr, logger=FakeLogger())
 
     >>> updater.updateBugTrackers(['debbugs', 'gnome-bugzilla'])
     DEBUG...No watches to update on http://bugs.debian.org

=== modified file 'lib/lp/bugs/doc/checkwatches.txt'
--- lib/lp/bugs/doc/checkwatches.txt	2010-04-21 12:20:52 +0000
+++ lib/lp/bugs/doc/checkwatches.txt	2010-04-21 12:20:54 +0000
@@ -109,7 +109,7 @@
     >>> from canonical.launchpad.interfaces import (
     ...     BugTrackerType, IBugSet)
     >>> from lp.bugs.scripts.checkwatches import (
-    ...     BugWatchUpdater)
+    ...     CheckwatchesMaster)
     >>> from canonical.launchpad.interfaces import (
     ...     IPersonSet)
     >>> sample_person = getUtility(IPersonSet).getByEmail(
@@ -150,7 +150,7 @@
     ...     raise socket.timeout("Connection timed out.")
     >>> try:
     ...     urllib2.urlopen = do_not_urlopen
-    ...     updater = BugWatchUpdater(transaction.manager)
+    ...     updater = CheckwatchesMaster(transaction.manager)
     ...     updater.updateBugTrackers(
     ...         bug_tracker_names=[example_bug_tracker_name])
     ... finally:
@@ -212,7 +212,7 @@
     >>> try:
     ...     externalbugtracker.get_external_bugtracker = (
     ...         broken_get_external_bugtracker)
-    ...     updater = BugWatchUpdater(transaction.manager)
+    ...     updater = CheckwatchesMaster(transaction.manager)
     ...     transaction.commit()
     ...     updater._updateBugTracker(example_bug_tracker)
     ... finally:
@@ -261,7 +261,7 @@
     >>> from canonical.launchpad.scripts import FakeLogger
 
     >>> transaction.commit()
-    >>> updater = BugWatchUpdater(transaction.manager)
+    >>> updater = CheckwatchesMaster(transaction.manager)
     >>> original_log = updater.logger
     >>> batch_size = externalbugtracker.Roundup.batch_size
     >>> try:
@@ -283,7 +283,7 @@
 -----------------------------------------
 
 It's possible to update all the watches on a bug tracker using
-checkwatches using BugWatchUpdater's forceUpdateAll() method.
+checkwatches using CheckwatchesMaster's forceUpdateAll() method.
 forceUpdateAll() accepts a bug_tracker_name argument because it's
 called by the checkwatches script, which doesn't know or care about
 IBugTracker and instances thereof.
@@ -310,11 +310,11 @@
 been recently checked or not.
 
 We'll create a helper method here, because we want to monkey patch the
-BugWatchUpdater's logger.
+CheckwatchesMaster's logger.
 
     >>> def update_all(bug_tracker_name, batch_size=None):
     ...     transaction.commit()
-    ...     updater = BugWatchUpdater(transaction.manager)
+    ...     updater = CheckwatchesMaster(transaction.manager)
     ...     updater.logger = FakeLogger()
     ...     updater.forceUpdateAll(bug_tracker_name, batch_size)
 
@@ -367,10 +367,10 @@
     5
 
 With a batch_size of 1, only one bug watch will be updated at once.
-We'll use a custom BugWatchUpdater to make sure that no connections are
+We'll use a custom CheckwatchesMaster to make sure that no connections are
 made.
 
-    >>> class NonConnectingUpdater(BugWatchUpdater):
+    >>> class NonConnectingUpdater(CheckwatchesMaster):
     ...
     ...     def _updateBugTracker(self, bug_tracker, batch_size):
     ...         # Update as many watches as the batch size says.
@@ -476,7 +476,7 @@
 generated to updateBugWatches we can see that its comments will be
 synced and it will be linked to the remote bug.
 
-    >>> updater = BugWatchUpdater(transaction.manager)
+    >>> updater = CheckwatchesMaster(transaction.manager)
     >>> transaction.commit()
 
     >>> remote_system = UselessExternalBugTracker('http://example.com')

=== modified file 'lib/lp/bugs/doc/externalbugtracker-bug-imports.txt'
--- lib/lp/bugs/doc/externalbugtracker-bug-imports.txt	2010-03-25 11:44:28 +0000
+++ lib/lp/bugs/doc/externalbugtracker-bug-imports.txt	2010-04-21 12:20:54 +0000
@@ -45,14 +45,14 @@
 imported into, and the remote bug number. At the moment only
 distributions are supported as the bug target.
 
-    >>> from lp.bugs.scripts.checkwatches import BugWatchUpdater
+    >>> from lp.bugs.scripts.checkwatches import CheckwatchesMaster
     >>> from canonical.testing import LaunchpadZopelessLayer
     >>> debian = getUtility(IDistributionSet).getByName('debian')
     >>> external_bugtracker._bugs['3'] =  {
     ...     'package': 'evolution',
     ...     'reporter': ("Joe Bloggs", "[e-mail]")}
     >>> transaction.commit()
-    >>> bug_watch_updater = BugWatchUpdater(LaunchpadZopelessLayer.txn)
+    >>> bug_watch_updater = CheckwatchesMaster(LaunchpadZopelessLayer.txn)
     >>> bug = bug_watch_updater.importBug(
     ...     external_bugtracker, bugtracker, debian, '3')
 

=== modified file 'lib/lp/bugs/doc/externalbugtracker-bugzilla-oddities.txt'
--- lib/lp/bugs/doc/externalbugtracker-bugzilla-oddities.txt	2010-03-25 11:44:28 +0000
+++ lib/lp/bugs/doc/externalbugtracker-bugzilla-oddities.txt	2010-04-21 12:20:54 +0000
@@ -15,7 +15,7 @@
     >>> from canonical.launchpad.interfaces import IBugTrackerSet
 
     >>> from lp.bugs.tests.externalbugtracker import TestIssuezilla
-    >>> from lp.bugs.scripts.checkwatches import BugWatchUpdater
+    >>> from lp.bugs.scripts.checkwatches import CheckwatchesMaster
     >>> from canonical.testing import LaunchpadZopelessLayer
     >>> txn = LaunchpadZopelessLayer.txn
     >>> mozilla_bugzilla = getUtility(IBugTrackerSet).getByName('mozilla.org')
@@ -29,7 +29,7 @@
     42: FUBAR
     42: FUBAR
     >>> transaction.commit()
-    >>> bug_watch_updater = BugWatchUpdater(txn)
+    >>> bug_watch_updater = CheckwatchesMaster(txn)
     >>> bug_watch_updater.updateBugWatches(
     ...     issuezilla, mozilla_bugzilla.watches)
     INFO:...:Updating 4 watches for 3 bugs on https://bugzilla.mozilla.org

=== modified file 'lib/lp/bugs/doc/externalbugtracker-bugzilla.txt'
--- lib/lp/bugs/doc/externalbugtracker-bugzilla.txt	2010-03-26 13:48:53 +0000
+++ lib/lp/bugs/doc/externalbugtracker-bugzilla.txt	2010-04-21 12:20:54 +0000
@@ -312,8 +312,8 @@
 done through updateBugWatches(), which expects a list of bug watches to
 update:
 
-    >>> from lp.bugs.scripts.checkwatches import BugWatchUpdater
-    >>> bug_watch_updater = BugWatchUpdater(txn)
+    >>> from lp.bugs.scripts.checkwatches import CheckwatchesMaster
+    >>> bug_watch_updater = CheckwatchesMaster(txn)
     >>> for bug_watch in gnome_bugzilla.watches:
     ...     print "%s: %s" % (bug_watch.remotebug, bug_watch.remotestatus)
     304070: None

=== modified file 'lib/lp/bugs/doc/externalbugtracker-comment-imports.txt'
--- lib/lp/bugs/doc/externalbugtracker-comment-imports.txt	2010-03-30 17:25:52 +0000
+++ lib/lp/bugs/doc/externalbugtracker-comment-imports.txt	2010-04-21 12:20:54 +0000
@@ -79,14 +79,14 @@
     >>> external_bugtracker = CommentImportingExternalBugTracker(
     ...     'http://example.com/')
 
-The BugWatchUpdater method importBugComments() is responsible for
+The CheckwatchesMaster method importBugComments() is responsible for
 calling the three methods of ISupportsCommentImport in turn to import
 comments. Calling importBugComments() and passing it our new
 comment-importing ExternalBugTracker instance will result in the three
 comments in the comment_dict being imported into Launchpad.
 
-    >>> from lp.bugs.scripts.checkwatches import BugWatchUpdater
-    >>> bugwatch_updater = BugWatchUpdater(LaunchpadZopelessLayer.txn)
+    >>> from lp.bugs.scripts.checkwatches import CheckwatchesMaster
+    >>> bugwatch_updater = CheckwatchesMaster(LaunchpadZopelessLayer.txn)
     >>> transaction.commit()
     >>> bugwatch_updater.importBugComments(external_bugtracker, bug_watch)
     INFO:...:Imported 3 comments for remote bug 123456 on ...

=== modified file 'lib/lp/bugs/doc/externalbugtracker-comment-pushing.txt'
--- lib/lp/bugs/doc/externalbugtracker-comment-pushing.txt	2010-03-25 14:28:33 +0000
+++ lib/lp/bugs/doc/externalbugtracker-comment-pushing.txt	2010-04-21 12:20:54 +0000
@@ -90,13 +90,13 @@
     >>> print comments
     [u'Pushing, for the purpose of.']
 
-The BugWatchUpdater method pushBugComments() is responsible for
+The CheckwatchesMaster method pushBugComments() is responsible for
 calling the addRemoteComment() method of ISupportsCommentPushing for
 each Launchpad comment that needs to be pushed to the remote bug
 tracker.
 
-    >>> from lp.bugs.scripts.checkwatches import BugWatchUpdater
-    >>> bugwatch_updater = BugWatchUpdater(LaunchpadZopelessLayer.txn)
+    >>> from lp.bugs.scripts.checkwatches import CheckwatchesMaster
+    >>> bugwatch_updater = CheckwatchesMaster(LaunchpadZopelessLayer.txn)
 
     >>> transaction.commit()
 
@@ -305,7 +305,7 @@
     <BLANKLINE>
     --------------------
 
-The BugWatchUpdater class has a method, _formatRemoteComment() which
+The CheckwatchesMaster class has a method, _formatRemoteComment() which
 will take a Launchpad comment and format it ready for uploading to the
 remote server. This allows us to include salient information, such as
 the comment author, with the pushed comment.

=== modified file 'lib/lp/bugs/doc/externalbugtracker-debbugs.txt'
--- lib/lp/bugs/doc/externalbugtracker-debbugs.txt	2010-04-09 11:07:02 +0000
+++ lib/lp/bugs/doc/externalbugtracker-debbugs.txt	2010-04-21 12:20:54 +0000
@@ -115,8 +115,8 @@
 
     >>> transaction.commit()
 
-    >>> from lp.bugs.scripts.checkwatches import BugWatchUpdater
-    >>> bug_watch_updater = BugWatchUpdater(txn)
+    >>> from lp.bugs.scripts.checkwatches import CheckwatchesMaster
+    >>> bug_watch_updater = CheckwatchesMaster(txn)
     >>> external_debbugs.sync_comments = False
     >>> bug_watch_ids = sorted([bug_watch.id for bug_watch in bug_watches])
     >>> bug_watch_updater.updateBugWatches(external_debbugs, bug_watches)
@@ -419,7 +419,7 @@
 The debbugs implementation of fetchComments() doesn't actually do
 anything, since DebBugs comments are stored locally and there is no need
 to pre-fetch them. It exists, nevertheless, so that
-BugWatchUpdater.importBugComments() can call it.
+CheckwatchesMaster.importBugComments() can call it.
 
     >>> external_debbugs.fetchComments(bug_watch, comment_ids)
 

=== modified file 'lib/lp/bugs/doc/externalbugtracker-linking-back.txt'
--- lib/lp/bugs/doc/externalbugtracker-linking-back.txt	2010-04-21 12:20:52 +0000
+++ lib/lp/bugs/doc/externalbugtracker-linking-back.txt	2010-04-21 12:20:54 +0000
@@ -27,7 +27,7 @@
     ...         self.last_launchpad_bug_id = launchpad_bug_id
     ...         print "Setting Launchpad id for bug %s" % remote_bug
 
-The methods are called by the BugWatchUpdater class:
+The methods are called by the CheckwatchesMaster class:
 
     >>> from canonical.testing import LaunchpadZopelessLayer
     >>> txn = LaunchpadZopelessLayer.txn
@@ -46,8 +46,8 @@
     >>> txn.commit()
     >>> LaunchpadZopelessLayer.switchDbUser('checkwatches')
 
-    >>> from lp.bugs.scripts.checkwatches import BugWatchUpdater
-    >>> bug_watch_updater = BugWatchUpdater(txn)
+    >>> from lp.bugs.scripts.checkwatches import CheckwatchesMaster
+    >>> bug_watch_updater = CheckwatchesMaster(txn)
     >>> txn.commit()
 
     >>> external_bugtracker = BackLinkingExternalBugTracker(
@@ -67,13 +67,13 @@
     ...     external_bugtracker, [bug_watch_without_bugtask])
 
 
-== BugWatchUpdater.linkLaunchpadBug() ==
+== CheckwatchesMaster.linkLaunchpadBug() ==
 
-The BugWatchUpdater method that does the work of setting the Launchpad
+The CheckwatchesMaster method that does the work of setting the Launchpad
 bug link is linkLaunchpadBug(). This method first retrieves the
 current Launchpad bug ID for the remote bug. If the remote bug is
 already linked to a Launchpad bug other than the one that we're trying
-to link it to, the BugWatchUpdater will check that the bug that is
+to link it to, the CheckwatchesMaster will check that the bug that is
 already linked has a valid watch on the remote bug in question. If it
 does, the link will remain unchanged. Otherwise it will be updated.
 
@@ -97,7 +97,7 @@
 
 However, if we set the current Launchpad bug ID on our
 BackLinkingExternalBugTracker to a Launchpad bug that doesn't link to
-the remote bug, BugWatchUpdater.linkLaunchpadBug() will call
+the remote bug, CheckwatchesMaster.linkLaunchpadBug() will call
 getLaunchpadBugId() and then, when it discovers that the current
 Launchpad bug ID isn't valid, setLaunchpadBugId() to correct the error.
 

=== modified file 'lib/lp/bugs/doc/externalbugtracker-mantis-csv.txt'
--- lib/lp/bugs/doc/externalbugtracker-mantis-csv.txt	2010-03-26 13:48:53 +0000
+++ lib/lp/bugs/doc/externalbugtracker-mantis-csv.txt	2010-04-21 12:20:54 +0000
@@ -79,8 +79,8 @@
 
     >>> transaction.commit()
 
-    >>> from lp.bugs.scripts.checkwatches import BugWatchUpdater
-    >>> bug_watch_updater = BugWatchUpdater(transaction)
+    >>> from lp.bugs.scripts.checkwatches import CheckwatchesMaster
+    >>> bug_watch_updater = CheckwatchesMaster(transaction)
     >>> bug_watch_updater.updateBugWatches(
     ...     example_ext_bug_tracker, example_bug_tracker.watches)
     INFO:...:Updating 1 watches for 1 bugs on http://bugs.some.where

=== modified file 'lib/lp/bugs/doc/externalbugtracker-mantis.txt'
--- lib/lp/bugs/doc/externalbugtracker-mantis.txt	2010-03-26 13:48:53 +0000
+++ lib/lp/bugs/doc/externalbugtracker-mantis.txt	2010-04-21 12:20:54 +0000
@@ -79,10 +79,10 @@
 
     >>> transaction.commit()
 
-    >>> from lp.bugs.scripts.checkwatches import BugWatchUpdater
+    >>> from lp.bugs.scripts.checkwatches import CheckwatchesMaster
     >>> from canonical.testing import LaunchpadZopelessLayer
     >>> txn = LaunchpadZopelessLayer.txn
-    >>> bug_watch_updater = BugWatchUpdater(txn)
+    >>> bug_watch_updater = CheckwatchesMaster(txn)
     >>> bug_watch_updater.updateBugWatches(
     ...     example_ext_bug_tracker, example_bug_tracker.watches)
     INFO:...:Updating 1 watches for 1 bugs on http://bugs.some.where

=== modified file 'lib/lp/bugs/doc/externalbugtracker-roundup.txt'
--- lib/lp/bugs/doc/externalbugtracker-roundup.txt	2010-03-24 16:59:46 +0000
+++ lib/lp/bugs/doc/externalbugtracker-roundup.txt	2010-04-21 12:20:54 +0000
@@ -137,10 +137,10 @@
 
     >>> transaction.commit()
 
-    >>> from lp.bugs.scripts.checkwatches import BugWatchUpdater
+    >>> from lp.bugs.scripts.checkwatches import CheckwatchesMaster
     >>> from canonical.testing import LaunchpadZopelessLayer
     >>> txn = LaunchpadZopelessLayer.txn
-    >>> bug_watch_updater = BugWatchUpdater(txn)
+    >>> bug_watch_updater = CheckwatchesMaster(txn)
     >>> roundup = TestRoundup(example_bug_tracker.baseurl)
     >>> bug_watch_updater.updateBugWatches(
     ...     roundup, example_bug_tracker.watches)

=== modified file 'lib/lp/bugs/doc/externalbugtracker-rt.txt'
--- lib/lp/bugs/doc/externalbugtracker-rt.txt	2010-03-24 16:59:46 +0000
+++ lib/lp/bugs/doc/externalbugtracker-rt.txt	2010-04-21 12:20:54 +0000
@@ -180,10 +180,10 @@
 
     >>> transaction.commit()
 
-    >>> from lp.bugs.scripts.checkwatches import BugWatchUpdater
+    >>> from lp.bugs.scripts.checkwatches import CheckwatchesMaster
     >>> from canonical.testing import LaunchpadZopelessLayer
     >>> txn = LaunchpadZopelessLayer.txn
-    >>> bug_watch_updater = BugWatchUpdater(txn)
+    >>> bug_watch_updater = CheckwatchesMaster(txn)
     >>> rt = TestRequestTracker(example_bug_tracker.baseurl)
     >>> bug_watch_updater.updateBugWatches(rt, example_bug_tracker.watches)
     INFO:...:Updating 1 watches for 1 bugs on http://bugs.some.where

=== modified file 'lib/lp/bugs/doc/externalbugtracker-sourceforge.txt'
--- lib/lp/bugs/doc/externalbugtracker-sourceforge.txt	2010-03-24 16:59:46 +0000
+++ lib/lp/bugs/doc/externalbugtracker-sourceforge.txt	2010-04-21 12:20:54 +0000
@@ -161,10 +161,10 @@
 
     >>> transaction.commit()
 
-    >>> from lp.bugs.scripts.checkwatches import BugWatchUpdater
+    >>> from lp.bugs.scripts.checkwatches import CheckwatchesMaster
     >>> from canonical.testing import LaunchpadZopelessLayer
     >>> txn = LaunchpadZopelessLayer.txn
-    >>> bug_watch_updater = BugWatchUpdater(txn)
+    >>> bug_watch_updater = CheckwatchesMaster(txn)
     >>> sourceforge = TestSourceForge(example_bug_tracker.baseurl)
     >>> bug_watch_updater.updateBugWatches(
     ...     sourceforge, example_bug_tracker.watches)

=== modified file 'lib/lp/bugs/doc/externalbugtracker-trac.txt'
--- lib/lp/bugs/doc/externalbugtracker-trac.txt	2010-03-26 13:48:53 +0000
+++ lib/lp/bugs/doc/externalbugtracker-trac.txt	2010-04-21 12:20:54 +0000
@@ -297,10 +297,10 @@
 
     >>> transaction.commit()
 
-    >>> from lp.bugs.scripts.checkwatches import BugWatchUpdater
+    >>> from lp.bugs.scripts.checkwatches import CheckwatchesMaster
     >>> from canonical.testing import LaunchpadZopelessLayer
     >>> txn = LaunchpadZopelessLayer.txn
-    >>> bug_watch_updater = BugWatchUpdater(txn)
+    >>> bug_watch_updater = CheckwatchesMaster(txn)
     >>> trac = TestTrac(example_bug_tracker.baseurl)
     >>> bug_watch_updater.updateBugWatches(trac, example_bug_tracker.watches)
     INFO:...:Updating 1 watches for 1 bugs on http://bugs.some.where

=== modified file 'lib/lp/bugs/doc/externalbugtracker.txt'
--- lib/lp/bugs/doc/externalbugtracker.txt	2010-04-21 12:20:52 +0000
+++ lib/lp/bugs/doc/externalbugtracker.txt	2010-04-21 12:20:54 +0000
@@ -8,7 +8,7 @@
 
 All the ExternalBugTrackers know how to update the status of a bug
 watch. The method that updates the bug watches is
-BugWatchUpdater.updateBugWatches(), which expects an IExternalBugTracker
+CheckwatchesMaster.updateBugWatches(), which expects an IExternalBugTracker
 and the bug watches to update.
 
 
@@ -26,8 +26,8 @@
     ...         print "initializeRemoteBugDB() called: %r" % (
     ...             remote_bug_ids, )
 
-    >>> from lp.bugs.scripts.checkwatches import BugWatchUpdater
-    >>> bug_watch_updater = BugWatchUpdater(transaction)
+    >>> from lp.bugs.scripts.checkwatches import CheckwatchesMaster
+    >>> bug_watch_updater = CheckwatchesMaster(transaction)
     >>> bug_watch_updater.updateBugWatches(
     ...     InitializingExternalBugTracker(), [])
     initializeRemoteBugDB() called: []
@@ -49,7 +49,7 @@
     >>> chosen_bugtracker is external_bugtracker
     True
 
-BugWatchUpdater calls externalbugtracker.get_external_bugtracker(),
+CheckwatchesMaster calls externalbugtracker.get_external_bugtracker(),
 follwed by ExternalBugTracker.getExternalBugTrackerToUse() to get the
 correct ExternalBugTracker for a given BugTracker. It does this via the
 private _getExternalBugTrackersAndWatches() method, which returns a set of
@@ -193,17 +193,17 @@
 
 The checkwatches module contains a variable, SYNCABLE_GNOME_PRODUCTS,
 which defines the products that we want to sync comments for.
-BugWatchUpdater keeps a local copy of this variable, which we can
-override by passing a list of products to the BugWatchUpdater
+CheckwatchesMaster keeps a local copy of this variable, which we can
+override by passing a list of products to the CheckwatchesMaster
 constructor.
 
     >>> from lp.bugs.scripts import checkwatches
     >>> (bug_watch_updater._syncable_gnome_products ==
-    ...     checkwatches.updater.SYNCABLE_GNOME_PRODUCTS)
+    ...     checkwatches.core.SYNCABLE_GNOME_PRODUCTS)
     True
 
     >>> syncable_products = ['HeartOfGold']
-    >>> bug_watch_updater = BugWatchUpdater(
+    >>> bug_watch_updater = CheckwatchesMaster(
     ...     transaction, syncable_gnome_products=syncable_products)
 
     >>> bug_watches = [
@@ -256,7 +256,7 @@
     ...     'HeartOfGold',
     ...     'InfiniteImprobabilityDrive',
     ...     ]
-    >>> bug_watch_updater = BugWatchUpdater(
+    >>> bug_watch_updater = CheckwatchesMaster(
     ...     transaction, syncable_gnome_products=syncable_products)
 
     >>> trackers_and_watches = get_trackers_and_watches(
@@ -294,7 +294,7 @@
 If there are no syncable GNOME products, only one batch is returned,
 and the remote system is never asked about product information.
 
-    >>> bug_watch_updater = BugWatchUpdater(
+    >>> bug_watch_updater = CheckwatchesMaster(
     ...     transaction, syncable_gnome_products=[])
 
     >>> trackers_and_watches = get_trackers_and_watches(
@@ -352,7 +352,7 @@
     TooMuchTimeSkew: ...
 
 The error is in fact raised by the _getRemoteIdsToCheck() method of
-BugWatchUpdater, which is passed a server_time variable by
+CheckwatchesMaster, which is passed a server_time variable by
 updateBugWatches(). updateBugWatches() is responsible for logging the
 error and for setting the last_error_type on all affected BugWatches
 before re-raising the error.
@@ -641,7 +641,7 @@
 
 === Converting statuses ===
 
-Once it has retrieved the bugs from the remote server, BugWatchUpdater
+Once it has retrieved the bugs from the remote server, CheckwatchesMaster
 attempts to convert their statuses into Launchpad BugTaskStatuses by
 calling the convertRemoteStatus() method on the ExternalBugTracker via
 its own _convertRemoteStatus() method.
@@ -660,7 +660,7 @@
     ...         else:
     ...             raise UnknownRemoteStatusError(remote_status)
 
-BugWatchUpdater._convertRemoteStatus() will handle these errors and will
+CheckwatchesMaster._convertRemoteStatus() will handle these errors and will
 return BugTaskStatus.UNKNOWN when they occur. It will also log a
 warning.
 
@@ -710,7 +710,7 @@
     >>> external_bugtracker = TestBrokenExternalBugTracker(
     ...     'http://example.com')
     >>> from canonical.launchpad.scripts.logger import QuietFakeLogger
-    >>> bug_watch_updater = BugWatchUpdater(transaction, QuietFakeLogger())
+    >>> bug_watch_updater = CheckwatchesMaster(transaction, QuietFakeLogger())
 
 We'll create an example bug watch with which to test this. This will
 be passed to external_bugtracker's updateBugWatches() method and should
@@ -1069,13 +1069,13 @@
 outside world we'll subclass it to make sure it uses our non-connecting
 external_bugtracker.
 
-    >>> class NonConnectingBugWatchUpdater(BugWatchUpdater):
+    >>> class NonConnectingCheckwatchesMaster(CheckwatchesMaster):
     ...
     ...     def _getExternalBugTrackersAndWatches(self, bug_trackers,
     ...                                           bug_watches):
     ...         return [(external_bugtracker, bug_watches)]
 
-    >>> bug_watch_updater = NonConnectingBugWatchUpdater(
+    >>> bug_watch_updater = NonConnectingCheckwatchesMaster(
     ...     transaction, QuietFakeLogger())
     >>> transaction.commit()
     >>> bug_watch_updater._updateBugTracker(
@@ -1084,7 +1084,7 @@
     getRemoteStatus() called: u'5'
     getRemoteStatus() called: u'6'
 
-The default entry point into BugWatchUpdater for the checkwatches script is
+The default entry point into CheckwatchesMaster for the checkwatches script is
 the updateBugTrackers() method. This, too, takes a batch_size parameter, which
 allows it to be passed as a command-line option when the checkwatches script
 is run.

=== modified file 'lib/lp/bugs/externalbugtracker/bugzilla.py'
--- lib/lp/bugs/externalbugtracker/bugzilla.py	2010-04-21 12:20:52 +0000
+++ lib/lp/bugs/externalbugtracker/bugzilla.py	2010-04-21 12:20:54 +0000
@@ -656,7 +656,7 @@
         actual_bug_id = self._getActualBugId(remote_bug_id)
 
         # We need to cast comment_ids to integers, since
-        # BugWatchUpdater.importBugComments() will pass us a list of
+        # CheckwatchesMaster.importBugComments() will pass us a list of
         # strings (see bug 248938).
         comment_ids = [int(comment_id) for comment_id in comment_ids]
 
@@ -682,7 +682,7 @@
         actual_bug_id = self._getActualBugId(remote_bug_id)
 
         # We need to cast comment_id to integers, since
-        # BugWatchUpdater.importBugComments() will pass us a string (see
+        # CheckwatchesMaster.importBugComments() will pass us a string (see
         # bug 248938).
         comment_id = int(comment_id)
 
@@ -701,7 +701,7 @@
         actual_bug_id = self._getActualBugId(remote_bug_id)
 
         # We need to cast comment_id to integers, since
-        # BugWatchUpdater.importBugComments() will pass us a string (see
+        # CheckwatchesMaster.importBugComments() will pass us a string (see
         # bug 248938).
         comment_id = int(comment_id)
         comment = self._bugs[actual_bug_id]['comments'][comment_id]
@@ -725,7 +725,7 @@
         return_dict = self.xmlrpc_proxy.Bug.add_comment(request_params)
 
         # We cast the return value to string, since that's what
-        # BugWatchUpdater will expect (see bug 248938).
+        # CheckwatchesMaster will expect (see bug 248938).
         return str(return_dict['id'])
 
     def getLaunchpadBugId(self, remote_bug):
@@ -874,7 +874,7 @@
         bug_comments = bug_comments_dict['bugs'][str(actual_bug_id)]
 
         # We also need to convert each comment ID to a string, since
-        # that's what BugWatchUpdater.importBugComments() expects (see
+        # that's what CheckwatchesMaster.importBugComments() expects (see
         # bug 248938).
         return [str(comment['id']) for comment in bug_comments]
 
@@ -884,7 +884,7 @@
         actual_bug_id = self._getActualBugId(remote_bug_id)
 
         # We need to cast comment_ids to integers, since
-        # BugWatchUpdater.importBugComments() will pass us a list of
+        # CheckwatchesMaster.importBugComments() will pass us a list of
         # strings (see bug 248938).
         comment_ids = [int(comment_id) for comment_id in comment_ids]
 
@@ -922,7 +922,7 @@
         return_dict = self.xmlrpc_proxy.Launchpad.add_comment(request_params)
 
         # We cast the return value to string, since that's what
-        # BugWatchUpdater will expect (see bug 248938).
+        # CheckwatchesMaster will expect (see bug 248938).
         return str(return_dict['comment_id'])
 
     def getLaunchpadBugId(self, remote_bug):

=== modified file 'lib/lp/bugs/externalbugtracker/debbugs.py'
--- lib/lp/bugs/externalbugtracker/debbugs.py	2010-04-09 11:07:02 +0000
+++ lib/lp/bugs/externalbugtracker/debbugs.py	2010-04-21 12:20:54 +0000
@@ -253,7 +253,7 @@
         """See `ISupportsCommentImport`."""
         # This method does nothing since DebBugs bugs are stored locally
         # and their comments don't need to be pre-fetched. It exists
-        # purely to ensure that BugWatchUpdater doesn't choke on it.
+        # purely to ensure that CheckwatchesMaster doesn't choke on it.
         pass
 
     def getPosterForComment(self, remote_bug_id, comment_id):

=== modified file 'lib/lp/bugs/scripts/checkwatches/__init__.py'
--- lib/lp/bugs/scripts/checkwatches/__init__.py	2010-04-21 12:20:52 +0000
+++ lib/lp/bugs/scripts/checkwatches/__init__.py	2010-04-21 12:20:54 +0000
@@ -3,8 +3,8 @@
 """Top-level __init__ for the checkwatches package."""
 
 # We do this to maintain backwards compatibility with tests.
-from .base import (
+from lp.bugs.scripts.checkwatches.base import (
     WorkingBase, commit_before, with_interaction)
-from .updater import (
-    BaseScheduler, BugWatchUpdater, CheckWatchesCronScript, SerialScheduler,
+from lp.bugs.scripts.checkwatches.core import (
+    BaseScheduler, CheckwatchesMaster, CheckWatchesCronScript, SerialScheduler,
     TooMuchTimeSkew, TwistedThreadScheduler, externalbugtracker)

=== renamed file 'lib/lp/bugs/scripts/checkwatches/updater.py' => 'lib/lp/bugs/scripts/checkwatches/core.py'
--- lib/lp/bugs/scripts/checkwatches/updater.py	2010-04-21 12:20:52 +0000
+++ lib/lp/bugs/scripts/checkwatches/core.py	2010-04-21 12:20:54 +0000
@@ -8,7 +8,7 @@
 __metaclass__ = type
 __all__ = [
     'BaseScheduler',
-    'BugWatchUpdater',
+    'CheckwatchesMaster',
     'CheckWatchesCronScript',
     'SerialScheduler',
     'TooMuchTimeSkew',
@@ -149,12 +149,12 @@
         ]
 
 
-class BugWatchUpdater(WorkingBase):
+class CheckwatchesMaster(WorkingBase):
     """Takes responsibility for updating remote bug watches."""
 
     def __init__(self, transaction_manager, logger=default_log,
                  syncable_gnome_products=None):
-        """Initialize a BugWatchUpdater.
+        """Initialize a CheckwatchesMaster.
 
         :param transaction_manager: A transaction manager on which
             `begin()`, `abort()` and `commit()` can be
@@ -166,7 +166,7 @@
             provides a similar interface.
 
         """
-        super(BugWatchUpdater, self).__init__(
+        super(CheckwatchesMaster, self).__init__(
             LOGIN, transaction_manager, logger)
 
         # Override SYNCABLE_GNOME_PRODUCTS if necessary.
@@ -1194,7 +1194,7 @@
     def main(self):
         start_time = time.time()
 
-        updater = BugWatchUpdater(self.txn, self.logger)
+        updater = CheckwatchesMaster(self.txn, self.logger)
 
         if self.options.update_all and len(self.options.bug_trackers) > 0:
             # The user has requested that we update *all* the watches
@@ -1203,7 +1203,7 @@
                 updater.forceUpdateAll(bug_tracker, self.options.batch_size)
         else:
             # Otherwise we just update those watches that need updating,
-            # and we let the BugWatchUpdater decide which those are.
+            # and we let the CheckwatchesMaster decide which those are.
             if self.options.jobs <= 1:
                 # Use the default scheduler.
                 scheduler = None

=== renamed file 'lib/lp/bugs/scripts/checkwatches/tests/test_updater.py' => 'lib/lp/bugs/scripts/checkwatches/tests/test_core.py'
--- lib/lp/bugs/scripts/checkwatches/tests/test_updater.py	2010-04-21 12:20:52 +0000
+++ lib/lp/bugs/scripts/checkwatches/tests/test_core.py	2010-04-21 12:20:54 +0000
@@ -24,8 +24,8 @@
 from lp.bugs.externalbugtracker.bugzilla import BugzillaAPI
 from lp.bugs.interfaces.bugtracker import IBugTrackerSet
 from lp.bugs.scripts import checkwatches
-from lp.bugs.scripts.checkwatches.updater import (
-    BugWatchUpdater, TwistedThreadScheduler)
+from lp.bugs.scripts.checkwatches.core import (
+    CheckwatchesMaster, TwistedThreadScheduler)
 from lp.bugs.scripts.checkwatches.base import CheckWatchesErrorUtility
 from lp.bugs.tests.externalbugtracker import (
     TestBugzillaAPIXMLRPCTransport, TestExternalBugTracker, new_bugtracker)
@@ -51,8 +51,8 @@
         return self
 
 
-class NoBugWatchesByRemoteBugUpdater(checkwatches.BugWatchUpdater):
-    """A subclass of BugWatchUpdater with methods overridden for testing."""
+class NoBugWatchesByRemoteBugUpdater(checkwatches.CheckwatchesMaster):
+    """A subclass of CheckwatchesMaster with methods overridden for testing."""
 
     def _getBugWatchesForRemoteBug(self, remote_bug_id, bug_watch_ids):
         """Return an empty list.
@@ -74,13 +74,13 @@
         # We monkey-patch externalbugtracker.get_external_bugtracker()
         # so that it always returns what we want.
         self.original_get_external_bug_tracker = (
-            checkwatches.updater.externalbugtracker.get_external_bugtracker)
-        checkwatches.updater.externalbugtracker.get_external_bugtracker = (
+            checkwatches.core.externalbugtracker.get_external_bugtracker)
+        checkwatches.core.externalbugtracker.get_external_bugtracker = (
             always_BugzillaAPI_get_external_bugtracker)
 
         # Create an updater with a limited set of syncable gnome
         # products.
-        self.updater = checkwatches.BugWatchUpdater(
+        self.updater = checkwatches.CheckwatchesMaster(
             transaction.manager, QuietFakeLogger(), ['test-product'])
 
     def tearDown(self):
@@ -130,13 +130,13 @@
         # We monkey-patch externalbugtracker.get_external_bugtracker()
         # so that it always returns what we want.
         self.original_get_external_bug_tracker = (
-            checkwatches.updater.externalbugtracker.get_external_bugtracker)
-        checkwatches.updater.externalbugtracker.get_external_bugtracker = (
+            checkwatches.core.externalbugtracker.get_external_bugtracker)
+        checkwatches.core.externalbugtracker.get_external_bugtracker = (
             always_BugzillaAPIWithoutProducts_get_external_bugtracker)
 
         # Create an updater with a limited set of syncable gnome
         # products.
-        self.updater = checkwatches.BugWatchUpdater(
+        self.updater = checkwatches.CheckwatchesMaster(
             transaction.manager, QuietFakeLogger(), ['test-product'])
 
     def tearDown(self):
@@ -175,17 +175,17 @@
         self.failIf(remote_system.sync_comments)
 
 
-class TestBugWatchUpdater(TestCaseWithFactory):
+class TestCheckwatchesMaster(TestCaseWithFactory):
 
     layer = LaunchpadZopelessLayer
 
     def setUp(self):
-        super(TestBugWatchUpdater, self).setUp()
+        super(TestCheckwatchesMaster, self).setUp()
         transaction.abort()
 
     def test_bug_497141(self):
         # Regression test for bug 497141. KeyErrors raised in
-        # BugWatchUpdater.updateBugWatches() shouldn't cause
+        # CheckwatchesMaster.updateBugWatches() shouldn't cause
         # checkwatches to abort.
         updater = NoBugWatchesByRemoteBugUpdater(
             transaction.manager, QuietFakeLogger())
@@ -219,13 +219,13 @@
         # When the batch_size is None, suggest_batch_size() will set
         # it accordingly.
         remote_system.batch_size = None
-        checkwatches.updater.suggest_batch_size(remote_system, 1)
+        checkwatches.core.suggest_batch_size(remote_system, 1)
         self.failUnlessEqual(100, remote_system.batch_size)
         remote_system.batch_size = None
-        checkwatches.updater.suggest_batch_size(remote_system, 12350)
+        checkwatches.core.suggest_batch_size(remote_system, 12350)
         self.failUnlessEqual(247, remote_system.batch_size)
         # If the batch_size is already set, it will not be changed.
-        checkwatches.updater.suggest_batch_size(remote_system, 99999)
+        checkwatches.core.suggest_batch_size(remote_system, 99999)
         self.failUnlessEqual(247, remote_system.batch_size)
 
 
@@ -394,7 +394,7 @@
         return None
 
 
-class BugWatchUpdaterForThreads(BugWatchUpdater):
+class CheckwatchesMasterForThreads(CheckwatchesMaster):
     """Fake updater.
 
     Plumbs an `ExternalBugTrackerForThreads` into a given output file,
@@ -404,7 +404,7 @@
 
     def __init__(self, output_file):
         logger = QuietFakeLogger()
-        super(BugWatchUpdaterForThreads, self).__init__(
+        super(CheckwatchesMasterForThreads, self).__init__(
             transaction.manager, logger)
         self.output_file = output_file
 
@@ -443,7 +443,7 @@
         transaction.commit()
         # Prepare the updater with the Twisted scheduler.
         output_file = OutputFileForThreads()
-        threaded_bug_watch_updater = BugWatchUpdaterForThreads(output_file)
+        threaded_bug_watch_updater = CheckwatchesMasterForThreads(output_file)
         threaded_bug_watch_scheduler = TwistedThreadScheduler(
             num_threads=10, install_signal_handlers=False)
         # Run the updater.

=== modified file 'lib/lp/bugs/scripts/importdebianbugs.py'
--- lib/lp/bugs/scripts/importdebianbugs.py	2009-06-25 00:40:31 +0000
+++ lib/lp/bugs/scripts/importdebianbugs.py	2010-04-21 12:20:54 +0000
@@ -12,7 +12,7 @@
 from canonical.launchpad.scripts.logger import log
 from lp.bugs.externalbugtracker import get_external_bugtracker
 from lp.bugs.interfaces.bugtask import IBugTaskSet
-from lp.bugs.scripts.checkwatches import BugWatchUpdater
+from lp.bugs.scripts.checkwatches import CheckwatchesMaster
 
 
 def import_debian_bugs(bugs_to_import):
@@ -20,7 +20,7 @@
     debbugs = getUtility(ILaunchpadCelebrities).debbugs
     txn = ZopelessTransactionManager._installed
     external_debbugs = get_external_bugtracker(debbugs)
-    bug_watch_updater = BugWatchUpdater(txn, log)
+    bug_watch_updater = CheckwatchesMaster(txn, log)
     debian = getUtility(ILaunchpadCelebrities).debian
     for debian_bug in bugs_to_import:
         existing_bug_ids = [

=== modified file 'lib/lp/bugs/scripts/tests/test_bugimport.py'
--- lib/lp/bugs/scripts/tests/test_bugimport.py	2010-04-21 12:20:52 +0000
+++ lib/lp/bugs/scripts/tests/test_bugimport.py	2010-04-21 12:20:54 +0000
@@ -27,7 +27,7 @@
 from lp.bugs.interfaces.externalbugtracker import UNKNOWN_REMOTE_IMPORTANCE
 from lp.bugs.scripts import bugimport
 from lp.bugs.scripts.bugimport import ET
-from lp.bugs.scripts.checkwatches import BugWatchUpdater
+from lp.bugs.scripts.checkwatches import CheckwatchesMaster
 from lp.registry.interfaces.person import IPersonSet, PersonCreationRationale
 from lp.registry.interfaces.product import IProductSet
 from lp.registry.model.person import generate_nick
@@ -889,16 +889,16 @@
 
 
 
-class TestBugWatchUpdater(BugWatchUpdater):
-    """A mock `BugWatchUpdater` object."""
+class TestCheckwatchesMaster(CheckwatchesMaster):
+    """A mock `CheckwatchesMaster` object."""
 
     def _updateBugTracker(self, bug_tracker):
         # Save the current bug tracker, so _getBugWatch can reference it.
         self.bugtracker = bug_tracker
-        super(TestBugWatchUpdater, self)._updateBugTracker(bug_tracker)
+        super(TestCheckwatchesMaster, self)._updateBugTracker(bug_tracker)
 
     def _getExternalBugTrackersAndWatches(self, bug_tracker, bug_watches):
-        """See `BugWatchUpdater`."""
+        """See `CheckwatchesMaster`."""
         return [(TestExternalBugTracker(bug_tracker.baseurl), bug_watches)]
 
     def _getBugWatchesForRemoteBug(self, remote_bug_id, bug_watch_ids):
@@ -939,7 +939,7 @@
         # try and update two bug watches - the first will
         # trigger a DB error, the second updates successfully.
         bug_tracker = TestBugTracker(test_bug_one, test_bug_two)
-        bug_watch_updater = TestBugWatchUpdater(self.layer.txn)
+        bug_watch_updater = TestCheckwatchesMaster(self.layer.txn)
         self.layer.txn.commit()
         bug_watch_updater._updateBugTracker(bug_tracker)
         # We verify that the first bug watch didn't update the status,