Merge ~cjwatson/launchpad:export-getSourceFilter into launchpad:master

[Colin Watson]

Export IDistroArchSeries.getSourceFilter

This allows webservice users to find out which source filters are
currently set.

I had to export IDistroArchSeriesFilter to make this work. Since there
can only be one source filter per DAS (enforced by a DB constraint), the
URL is just the DAS URL with +source-filter appended.

[Ioana Lasc (ilasc)]

review: Approve

[Otto Co-Pilot (otto-copilot)]

Voting criteria not met
https://jenkins.ols.canonical.com/online-services/job/launchpad/90/

[Colin Watson (cjwatson)]

Self-approving to work around incorrect repository reviewer.

review: Approve

diff --git a/lib/lp/_schema_circular_imports.py b/lib/lp/_schema_circular_imports.py
index cffb8ab..20db323 100644
--- a/lib/lp/_schema_circular_imports.py
+++ b/lib/lp/_schema_circular_imports.py
@@ -189,6 +189,7 @@ from lp.soyuz.interfaces.binarypackagerelease import (
     )
 from lp.soyuz.interfaces.buildrecords import IHasBuildRecords
 from lp.soyuz.interfaces.distroarchseries import IDistroArchSeries
+from lp.soyuz.interfaces.distroarchseriesfilter import IDistroArchSeriesFilter
 from lp.soyuz.interfaces.livefs import ILiveFSView
 from lp.soyuz.interfaces.livefsbuild import (
     ILiveFSBuild,
@@ -496,6 +497,8 @@ patch_reference_property(
 patch_reference_property(IDistroArchSeries, 'main_archive', IArchive)
 patch_plain_parameter_type(
     IDistroArchSeries, 'setChrootFromBuild', 'livefsbuild', ILiveFSBuild)
+patch_entry_return_type(
+    IDistroArchSeries, 'getSourceFilter', IDistroArchSeriesFilter)
 patch_plain_parameter_type(
     IDistroArchSeries, 'setSourceFilter', 'packageset', IPackageset)
 
diff --git a/lib/lp/services/webservice/wadl-to-refhtml.xsl b/lib/lp/services/webservice/wadl-to-refhtml.xsl
index 3df6657..d5198b0 100644
--- a/lib/lp/services/webservice/wadl-to-refhtml.xsl
+++ b/lib/lp/services/webservice/wadl-to-refhtml.xsl
@@ -299,6 +299,15 @@
                 <xsl:text>/</xsl:text>
                 <var>&lt;architecture_tag&gt;</var>
             </xsl:when>
+            <xsl:when test="@id = 'distro_arch_series_filter'">
+                <xsl:text>/</xsl:text>
+                <var>&lt;distribution.name&gt;</var>
+                <xsl:text>/</xsl:text>
+                <var>&lt;distroseries.name&gt;</var>
+                <xsl:text>/</xsl:text>
+                <var>&lt;architecture_tag&gt;</var>
+                <xsl:text>/+source-filter</xsl:text>
+            </xsl:when>
             <xsl:when test="@id = 'distro_series'">
                 <xsl:text>/</xsl:text>
                 <var>&lt;distribution.name&gt;</var>
diff --git a/lib/lp/soyuz/browser/configure.zcml b/lib/lp/soyuz/browser/configure.zcml
index 595aedf..1ce6b53 100644
--- a/lib/lp/soyuz/browser/configure.zcml
+++ b/lib/lp/soyuz/browser/configure.zcml
@@ -1,4 +1,4 @@
-<!-- Copyright 2009-2015 Canonical Ltd.  This software is licensed under the
+<!-- Copyright 2009-2019 Canonical Ltd.  This software is licensed under the
      GNU Affero General Public License version 3 (see the file LICENSE).
 -->
 
@@ -156,6 +156,10 @@
             template="../templates/distroarchseriesbinarypackagerelease-portlet-details.pt"/>
     </browser:pages>
     <browser:url
+        for="lp.soyuz.interfaces.distroarchseriesfilter.IDistroArchSeriesFilter"
+        path_expression="string:+source-filter"
+        attribute_to_parent="distroarchseries"/>
+    <browser:url
         for="lp.soyuz.interfaces.archive.IArchiveSet"
         path_expression="string:archives"
         parent_utility="lp.services.webapp.interfaces.ILaunchpadRoot"
diff --git a/lib/lp/soyuz/browser/distroarchseries.py b/lib/lp/soyuz/browser/distroarchseries.py
index 24cbc76..949809b 100644
--- a/lib/lp/soyuz/browser/distroarchseries.py
+++ b/lib/lp/soyuz/browser/distroarchseries.py
@@ -1,4 +1,4 @@
-# Copyright 2009-2012 Canonical Ltd.  This software is licensed under the
+# Copyright 2009-2019 Canonical Ltd.  This software is licensed under the
 # GNU Affero General Public License version 3 (see the file LICENSE).
 
 __metaclass__ = type
@@ -33,7 +33,10 @@ from lp.services.webapp.menu import (
     Link,
     NavigationMenu,
     )
-from lp.services.webapp.publisher import canonical_url
+from lp.services.webapp.publisher import (
+    canonical_url,
+    stepto,
+    )
 from lp.soyuz.browser.packagesearch import PackageSearchViewBase
 from lp.soyuz.interfaces.distroarchseries import IDistroArchSeries
 
@@ -42,6 +45,11 @@ class DistroArchSeriesNavigation(GetitemNavigation):
 
     usedfor = IDistroArchSeries
 
+    @stepto('+source-filter')
+    def traverse_source_filter(self):
+        """Traverse to the `IDistroArchSeriesFilter` for this DAS, if any."""
+        return self.context.getSourceFilter()
+
 
 class DistroArchSeriesBreadcrumb(Breadcrumb):
     """Builds a breadcrumb for `DistroArchSeries`."""
diff --git a/lib/lp/soyuz/browser/tests/test_distroarchseries_webservice.py b/lib/lp/soyuz/browser/tests/test_distroarchseries_webservice.py
index 9a7748f..74290a4 100644
--- a/lib/lp/soyuz/browser/tests/test_distroarchseries_webservice.py
+++ b/lib/lp/soyuz/browser/tests/test_distroarchseries_webservice.py
@@ -11,7 +11,11 @@ from lazr.restfulclient.errors import (
     BadRequest,
     Unauthorized,
     )
-from testtools.matchers import MatchesStructure
+from testtools.matchers import (
+    EndsWith,
+    Equals,
+    MatchesStructure,
+    )
 from zope.security.management import endInteraction
 
 from lp.buildmaster.enums import BuildBaseImageType
@@ -334,15 +338,14 @@ class TestDistroArchSeriesWebservice(TestCaseWithFactory):
         webservice = launchpadlib_for("testing", user, version="devel")
         ws_das = ws_object(webservice, das)
         ws_das.setSourceFilter(packageset=packageset_url, sense="Include")
-        with person_logged_in(user):
-            dasf = das.getSourceFilter()
-        self.assertThat(dasf, MatchesStructure.byEquality(
-            packageset=packageset, sense=DistroArchSeriesFilterSense.INCLUDE))
+        ws_dasf = ws_das.getSourceFilter()
+        self.assertThat(ws_dasf, MatchesStructure(
+            packageset_link=EndsWith(packageset_url),
+            sense=Equals("Include")))
         ws_das.setSourceFilter(packageset=packageset_url, sense="Exclude")
-        with person_logged_in(user):
-            dasf = das.getSourceFilter()
-        self.assertThat(dasf, MatchesStructure.byEquality(
-            packageset=packageset, sense=DistroArchSeriesFilterSense.EXCLUDE))
+        ws_dasf = ws_das.getSourceFilter()
+        self.assertThat(ws_dasf, MatchesStructure(
+            packageset_link=EndsWith(packageset_url),
+            sense=Equals("Exclude")))
         ws_das.removeSourceFilter()
-        with person_logged_in(user):
-            self.assertIsNone(das.getSourceFilter())
+        self.assertIsNone(ws_das.getSourceFilter())
diff --git a/lib/lp/soyuz/interfaces/distroarchseries.py b/lib/lp/soyuz/interfaces/distroarchseries.py
index 02b4a92..8f5caa1 100644
--- a/lib/lp/soyuz/interfaces/distroarchseries.py
+++ b/lib/lp/soyuz/interfaces/distroarchseries.py
@@ -24,6 +24,7 @@ from lazr.restful.declarations import (
     exported,
     operation_for_version,
     operation_parameters,
+    operation_returns_entry,
     REQUEST_USER,
     )
 from lazr.restful.fields import (
@@ -233,6 +234,10 @@ class IDistroArchSeriesPublic(IHasBuildRecords, IHasOwner):
         this distro arch series.
         """
 
+    # Really IDistroArchSeriesFilter, patched in _schema_circular_imports.py.
+    @operation_returns_entry(Interface)
+    @export_read_operation()
+    @operation_for_version("devel")
     def getSourceFilter():
         """Get the filter for packages to build for this architecture, if any.
 
diff --git a/lib/lp/soyuz/interfaces/distroarchseriesfilter.py b/lib/lp/soyuz/interfaces/distroarchseriesfilter.py
index a78e1fa..1cc324a 100644
--- a/lib/lp/soyuz/interfaces/distroarchseriesfilter.py
+++ b/lib/lp/soyuz/interfaces/distroarchseriesfilter.py
@@ -12,6 +12,10 @@ __all__ = [
     'NoSuchDistroArchSeriesFilter',
     ]
 
+from lazr.restful.declarations import (
+    export_as_webservice_entry,
+    exported,
+    )
 from lazr.restful.fields import Reference
 from zope.interface import Interface
 from zope.schema import (
@@ -39,37 +43,37 @@ class IDistroArchSeriesFilterView(Interface):
 
     id = Int(title=_("ID"), readonly=True, required=True)
 
-    distroarchseries = Reference(
+    distroarchseries = exported(Reference(
         title=_("Distro arch series"), required=True, readonly=True,
         schema=IDistroArchSeries,
-        description=_("The distro arch series that this filter is for."))
+        description=_("The distro arch series that this filter is for.")))
 
-    packageset = Reference(
+    packageset = exported(Reference(
         title=_("Package set"), required=True, readonly=True,
         schema=IPackageset,
         description=_(
             "The package set to be included in or excluded from this distro "
-            "arch series."))
+            "arch series.")))
 
-    sense = Choice(
+    sense = exported(Choice(
         title=_("Sense"),
         vocabulary=DistroArchSeriesFilterSense, required=True, readonly=True,
         description=_(
             "Whether the filter represents packages to include or exclude "
-            "from the distro arch series."))
+            "from the distro arch series.")))
 
-    creator = PublicPersonChoice(
+    creator = exported(PublicPersonChoice(
         title=_("Creator"), required=True, readonly=True,
         vocabulary="ValidPerson",
-        description=_("The user who created this filter."))
+        description=_("The user who created this filter.")))
 
-    date_created = Datetime(
+    date_created = exported(Datetime(
         title=_("Date created"), required=True, readonly=True,
-        description=_("The time when this filter was created."))
+        description=_("The time when this filter was created.")))
 
-    date_last_modified = Datetime(
+    date_last_modified = exported(Datetime(
         title=_("Date last modified"), required=True, readonly=True,
-        description=_("The time when this filter was last modified."))
+        description=_("The time when this filter was last modified.")))
 
     def isSourceIncluded(sourcepackagename):
         """Is this source package name included by this filter?
@@ -103,6 +107,10 @@ class IDistroArchSeriesFilter(
     exclude some packages ("this architecture can't handle some packages so
     we want to make them go away centrally").
     """
+    # XXX cjwatson 2019-10-04 bug=760849: "beta" is a lie to get WADL
+    # generation working.  Individual attributes must set their version to
+    # "devel".
+    export_as_webservice_entry(as_of="beta")
 
 
 class IDistroArchSeriesFilterSet(Interface):
diff --git a/lib/lp/soyuz/interfaces/webservice.py b/lib/lp/soyuz/interfaces/webservice.py
index 21591de..3620e81 100644
--- a/lib/lp/soyuz/interfaces/webservice.py
+++ b/lib/lp/soyuz/interfaces/webservice.py
@@ -1,4 +1,4 @@
-# Copyright 2010-2017 Canonical Ltd.  This software is licensed under the
+# Copyright 2010-2019 Canonical Ltd.  This software is licensed under the
 # GNU Affero General Public License version 3 (see the file LICENSE).
 
 """All the interfaces that are exposed through the webservice.
@@ -30,6 +30,7 @@ __all__ = [
     'IBinaryPackagePublishingHistory',
     'IBinaryPackageReleaseDownloadCount',
     'IDistroArchSeries',
+    'IDistroArchSeriesFilter',
     'ILiveFS',
     'ILiveFSBuild',
     'ILiveFSSet',
@@ -87,6 +88,7 @@ from lp.soyuz.interfaces.binarypackagerelease import (
     IBinaryPackageReleaseDownloadCount,
     )
 from lp.soyuz.interfaces.distroarchseries import IDistroArchSeries
+from lp.soyuz.interfaces.distroarchseriesfilter import IDistroArchSeriesFilter
 from lp.soyuz.interfaces.livefs import (
     ILiveFS,
     ILiveFSSet,