Merge lp:~michael.nelson/launchpad/distro-series-difference-getByDistroSeries into lp:launchpad/db-devel

[Michael Nelson]

Add IDistroSeriesDifferenceSource.getForDistroSeries() for retrieving differences for a derived series.

Overview
========
This branch adds a method for getting all DistroSeriesDifferences for a particular derived distro series.

Details
=======
This is part of a feature for:

https://dev.launchpad.net/LEP/DerivativeDistributions

In particular, I've working on another branch with browser code which needs this.

Test:
bin/test -vvm test_distroseriesdifference -t DistroSeriesDifferenceSourceTestCase

No lint.

[Jelmer Vernooij (jelmer)]

This looks great, nice to have it well tested.

review: Approve (code)

=== modified file 'lib/lp/registry/interfaces/distroseriesdifference.py'
--- lib/lp/registry/interfaces/distroseriesdifference.py	2010-08-30 15:11:26 +0000
+++ lib/lp/registry/interfaces/distroseriesdifference.py	2010-09-01 14:55:33 +0000
@@ -152,3 +152,21 @@
             is not a derived series.
         :return: A new `DistroSeriesDifference` object.
         """
+
+    def getForDistroSeries(
+        distro_series,
+        difference_type=DistroSeriesDifferenceType.DIFFERENT_VERSIONS,
+        status=None):
+        """Return differences for the derived distro series.
+
+        :param distro_series: The derived distribution series which is to be
+            searched for differences.
+        :type distro_series: `IDistroSeries`.
+        :param difference_type: The type of difference to include in the
+            results.
+        :type difference_type: `DistroSeriesDifferenceType`.
+        :param status: Only differences matching the status(es) will be
+            included.
+        :type status: `DistroSeriesDifferenceStatus`.
+        :return: A result set of differences.
+        """

=== modified file 'lib/lp/registry/model/distroseriesdifference.py'
--- lib/lp/registry/model/distroseriesdifference.py	2010-08-31 15:56:29 +0000
+++ lib/lp/registry/model/distroseriesdifference.py	2010-09-01 14:55:33 +0000
@@ -9,6 +9,7 @@
     'DistroSeriesDifference',
     ]
 
+from lazr.enum import DBItem
 from storm.locals import (
     Int,
     Reference,
@@ -84,6 +85,25 @@
 
         return store.add(diff)
 
+    @staticmethod
+    def getForDistroSeries(
+        distro_series,
+        difference_type=DistroSeriesDifferenceType.DIFFERENT_VERSIONS,
+        status=None):
+        """See `IDistroSeriesDifferenceSource`."""
+        if status is None:
+            status = (
+                DistroSeriesDifferenceStatus.NEEDS_ATTENTION,
+                )
+        elif isinstance(status, DBItem):
+            status = (status, )
+
+        return IStore(DistroSeriesDifference).find(
+            DistroSeriesDifference,
+            DistroSeriesDifference.derived_series == distro_series,
+            DistroSeriesDifference.difference_type == difference_type,
+            DistroSeriesDifference.status.is_in(status))
+
     @property
     def source_pub(self):
         """See `IDistroSeriesDifference`."""

=== modified file 'lib/lp/registry/tests/test_distroseriesdifference.py'
--- lib/lp/registry/tests/test_distroseriesdifference.py	2010-08-31 07:39:49 +0000
+++ lib/lp/registry/tests/test_distroseriesdifference.py	2010-09-01 14:55:33 +0000
@@ -287,5 +287,100 @@
                 ds_diff.derived_series.owner, "Boo")
 
 
+class DistroSeriesDifferenceSourceTestCase(TestCaseWithFactory):
+
+    layer = DatabaseFunctionalLayer
+
+    def test_implements_interface(self):
+        # The implementation implements the interface correctly.
+        dsd_source = getUtility(IDistroSeriesDifferenceSource)
+
+        verifyObject(IDistroSeriesDifferenceSource, dsd_source)
+
+    def makeDiffsForDistroSeries(self, derived_series):
+        # Helper that creates a range of differences for a derived
+        # series.
+        diffs = {
+            'normal': [],
+            'unique': [],
+            'ignored': [],
+            }
+        diffs['normal'].append(
+            self.factory.makeDistroSeriesDifference(
+                derived_series=derived_series))
+        diffs['unique'].append(
+            self.factory.makeDistroSeriesDifference(
+                derived_series=derived_series,
+                difference_type=(
+                    DistroSeriesDifferenceType.UNIQUE_TO_DERIVED_SERIES)))
+        diffs['ignored'].append(
+            self.factory.makeDistroSeriesDifference(
+                derived_series=derived_series,
+                status=DistroSeriesDifferenceStatus.IGNORED))
+        return diffs
+
+    def makeDerivedSeries(self):
+        # Keep tests DRY.
+        return self.factory.makeDistroSeries(
+            parent_series=self.factory.makeDistroSeries())
+
+    def test_getForDistroSeries_default(self):
+        # By default all differences needing attention for the given
+        # series are returned.
+        derived_series = self.makeDerivedSeries()
+        diffs = self.makeDiffsForDistroSeries(derived_series)
+
+        result = getUtility(IDistroSeriesDifferenceSource).getForDistroSeries(
+            derived_series)
+
+        self.assertContentEqual(
+            diffs['normal'], result)
+
+    def test_getForDistroSeries_filters_by_distroseries(self):
+        # Differences for other series are not included.
+        derived_series = self.makeDerivedSeries()
+        diffs = self.makeDiffsForDistroSeries(derived_series)
+        diff_for_other_series = self.factory.makeDistroSeriesDifference()
+
+        result = getUtility(IDistroSeriesDifferenceSource).getForDistroSeries(
+            derived_series)
+
+        self.assertFalse(diff_for_other_series in result)
+
+    def test_getForDistroSeries_filters_by_type(self):
+        # Only differences for the specified types are returned.
+        derived_series = self.makeDerivedSeries()
+        diffs = self.makeDiffsForDistroSeries(derived_series)
+
+        result = getUtility(IDistroSeriesDifferenceSource).getForDistroSeries(
+            derived_series,
+            DistroSeriesDifferenceType.UNIQUE_TO_DERIVED_SERIES)
+
+    def test_getForDistroSeries_filters_by_status(self):
+        # A single status can be used to filter results.
+        derived_series = self.makeDerivedSeries()
+        diffs = self.makeDiffsForDistroSeries(derived_series)
+
+        result = getUtility(IDistroSeriesDifferenceSource).getForDistroSeries(
+            derived_series,
+            status=DistroSeriesDifferenceStatus.IGNORED)
+
+        self.assertContentEqual(diffs['ignored'], result)
+
+    def test_getForDistroSeries_filters_by_multiple_statuses(self):
+        # Multiple statuses can be passed for filtering.
+        derived_series = self.makeDerivedSeries()
+        diffs = self.makeDiffsForDistroSeries(derived_series)
+
+        result = getUtility(IDistroSeriesDifferenceSource).getForDistroSeries(
+            derived_series,
+            status=(
+                DistroSeriesDifferenceStatus.IGNORED,
+                DistroSeriesDifferenceStatus.NEEDS_ATTENTION,
+                ))
+
+        self.assertContentEqual(diffs['normal'] + diffs['ignored'], result)
+
+
 def test_suite():
     return unittest.TestLoader().loadTestsFromName(__name__)