Merge lp:~gmb/lp2kanban/bug-1112622 into lp:~launchpad/lp2kanban/trunk

[Graham Binns]

We now sync cards with blueprints based on their description annotations _or_ external_system_url.

This branch makes the blueprint syncing code use either the external_system_url of a card _or_ its description annotations to decide whether it should be synced. This prevents syncing from getting clobbered by merge proposals.

[Brad Crittenden (bac)]

Looks good Graham. One typo to fix: blueoprint

review: Approve (code)

=== modified file 'src/lp2kanban/bugs2cards.py'
--- src/lp2kanban/bugs2cards.py	2013-03-05 20:42:37 +0000
+++ src/lp2kanban/bugs2cards.py	2013-03-18 11:38:32 +0000
@@ -6,6 +6,7 @@
 from launchpadlib.launchpad import Launchpad
 from lp2kanban.cards2workitems import (
     convert_cards_to_work_items,
+    get_blueprint_linked_cards,
     update_blueprints_from_work_items,
     )
 from lp2kanban.kanban import (
@@ -439,7 +440,7 @@
     if bconf.get("convert_cards_to_work_items", False) == "on":
         # Sync cards to blueprint work items, if so configured.
         print "   Checking for cards to sync with work items..."
-        cards_to_convert = board.getCardsWithExternalLinks()
+        cards_to_convert = get_blueprint_linked_cards(board)
         work_items = convert_cards_to_work_items(
             cards_to_convert, board, lp_users)
         if len(work_items) == 0:

=== modified file 'src/lp2kanban/cards2workitems.py'
--- src/lp2kanban/cards2workitems.py	2013-01-19 13:36:31 +0000
+++ src/lp2kanban/cards2workitems.py	2013-03-18 11:38:32 +0000
@@ -105,3 +105,18 @@
                 len(work_items), blueprint.name)
             blueprint.workitems_text = work_items_text
             blueprint.lp_save()
+
+
+def get_blueprint_linked_cards(board):
+    """Return the cards on `board` that need to be converted."""
+    blueprint_linked_cards = set()
+    for card in board.getCardsWithDescriptionAnnotations():
+        blueprint_url = card.description_annotations.get(
+            'blueprint_url', None)
+        if blueprint_url is not None:
+            blueprint_linked_cards.add(card)
+    blueprint_url_pattern = re.compile(BLUEPRINT_URL_PATTERN)
+    for card in board.getCardsWithExternalLinks():
+        if blueprint_url_pattern.match(card.external_system_url):
+            blueprint_linked_cards.add(card)
+    return blueprint_linked_cards

=== modified file 'src/lp2kanban/kanban.py'
--- src/lp2kanban/kanban.py	2013-03-15 07:57:56 +0000
+++ src/lp2kanban/kanban.py	2013-03-18 11:38:32 +0000
@@ -480,7 +480,8 @@
             "/Board/" + str(self.id) + "/Archive").ReplyData[0]
         archive_lanes = [lane_dict['Lane'] for lane_dict in self._archive]
         archive_lanes.extend(
-            [lane_dict['Lane'] for lane_dict in self._archive[0]['ChildLanes']])
+            [lane_dict['Lane'] for
+            lane_dict in self._archive[0]['ChildLanes']])
         self._backlog = self.connector.get(
             "/Board/" + str(self.id) + "/Backlog").ReplyData[0]
         self._populateLanes(

=== modified file 'src/lp2kanban/tests/common.py'
--- src/lp2kanban/tests/common.py	2013-02-01 14:52:54 +0000
+++ src/lp2kanban/tests/common.py	2013-03-18 11:38:32 +0000
@@ -18,12 +18,21 @@
 
 class FauxBoard:
 
-    def __init__(self, cards, users_by_id=None, default_cardtype=None, is_archived=False):
+    def __init__(self, cards, users_by_id=None, default_cardtype=None,
+                 is_archived=False):
         self.cards = cards
         self.users_by_id = users_by_id
         self.default_cardtype = default_cardtype or FauxCardType()
         self.cardtypes = {1: FauxCardType()}
         self.is_archived = is_archived
+        self._cards_with_description_annotations = set()
+        self._cards_with_external_links = set()
+
+    def getCardsWithDescriptionAnnotations(self):
+        return self._cards_with_description_annotations
+
+    def getCardsWithExternalLinks(self):
+        return self._cards_with_external_links
 
 
 class FauxLane:

=== modified file 'src/lp2kanban/tests/test_cards2workitems.py'
--- src/lp2kanban/tests/test_cards2workitems.py	2013-02-01 14:52:54 +0000
+++ src/lp2kanban/tests/test_cards2workitems.py	2013-03-18 11:38:32 +0000
@@ -9,6 +9,7 @@
     LANE_TYPE_TO_WORK_ITEM_STATUS_MAP,
     convert_card_to_work_item,
     convert_cards_to_work_items,
+    get_blueprint_linked_cards,
     update_blueprints_from_work_items,
     )
 from lp2kanban.kanban import (
@@ -65,10 +66,12 @@
                 blueprint_url=self.blueprint_url)
         if title is None:
             title = "A card"
-        return FauxCard(
+        card = FauxCard(
             title=title, lane=lane, assigned_user_id=assigned_user_id,
             description_annotations=description_annotations,
             external_system_url=external_system_url)
+        board.cards.append(card)
+        return card
 
 
 class CardsToWorkItemsTestCase(CardsToWorkItemsBase):
@@ -286,3 +289,47 @@
         update_blueprints_from_work_items(lp=None, work_items=self.work_items)
         # No assert here; we just want to make sure that
         # update_blueprints_from_work_items() doesn't error.
+
+
+class GetBluePrintLinkedCardsTestCase(CardsToWorkItemsBase):
+    """Tests for get_blueprint_linked_cards()."""
+
+    def test_returns_cards_with_blueprint_url_annotations(self):
+        # get_blueprint_linked_cards() returns cards with a blueprint url in
+        # their description_annotations.
+        blueprint_card = self._generateCard(
+            title="Card 1",
+            description_annotations=Record(blueprint_url=self.blueprint_url))
+        self.board._cards_with_description_annotations.add(blueprint_card)
+        cards_to_convert = get_blueprint_linked_cards(self.board)
+        self.assertIn(blueprint_card, cards_to_convert)
+
+    def test_doesnt_return_non_blueprint_cards(self):
+        # get_blueprint_linked_cards() doesn't return cards that don't have a
+        # blueprint_url set.
+        non_blueprint_card = self._generateCard(
+            title="Card 1", description_annotations=Record(foo='bar'))
+        self.board._cards_with_description_annotations.add(non_blueprint_card)
+        cards_to_convert = get_blueprint_linked_cards(self.board)
+        self.assertNotIn(non_blueprint_card, cards_to_convert)
+
+    def test_returns_cards_with_external_link_to_blueprint(self):
+        # get_blueprint_linked_cards() returns cards that have an
+        # external_system_url that points to a blueprint.
+        blueprint_card = self._generateCard(
+            title="Card 1", description_annotations={})
+        blueprint_card.external_system_url = self.blueprint_url
+        self.board._cards_with_external_links.add(blueprint_card)
+        cards_to_convert = get_blueprint_linked_cards(self.board)
+        self.assertIn(blueprint_card, cards_to_convert)
+
+    def test_does_not_return_cards_with_links_not_to_blueprints(self):
+        # get_blueprint_linked_cards() won't return cards that have a
+        # external_system_url that points to something other than a
+        # blueoprint.
+        non_blueprint_card = self._generateCard(
+            title="Card 1", description_annotations={})
+        non_blueprint_card.external_system_url = "http://example.com"
+        self.board._cards_with_external_links.add(non_blueprint_card)
+        cards_to_convert = get_blueprint_linked_cards(self.board)
+        self.assertNotIn(non_blueprint_card, cards_to_convert)