Support listing ports by the device owner

Author: carolynvs

src/corelib/Networking/v2/NetworkingApiBuilder.cs

@@ -266,18 +266,32 @@ public NetworkingApiBuilder(IServiceType serviceType, IAuthenticationProvider au
         /// <summary>
         /// Lists all ports associated with the account.
         /// </summary>
+        /// <param name="queryString">Options for filtering.</param>
         /// <param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
         /// <returns>
         /// A collection of port resources associated with the account.
         /// </returns>
-        public virtual async Task<PreparedRequest> ListPortsAsync(CancellationToken cancellationToken = default(CancellationToken))
+        public virtual async Task<T> ListPortsAsync<T>(IQueryStringBuilder queryString, CancellationToken cancellationToken = default(CancellationToken))
+            where T : IEnumerable<IServiceResource>
         {
-            Url endpoint = await Endpoint.GetEndpoint(cancellationToken).ConfigureAwait(false);
+            return await BuildListPortsRequest(queryString, cancellationToken)
+                .SendAsync()
+                .ReceiveJson<T>()
+                .PropogateOwnerToChildren(this).ConfigureAwait(false);
+        }
 
-            return endpoint
-                .AppendPathSegment("ports")
-                .Authenticate(AuthenticationProvider)
-                .PrepareGet(cancellationToken);
+        /// <summary>
+        /// Builds the <see cref="ListPortsAsync{T}"/> request.
+        /// </summary>
+        /// <param name="queryString">Options for filtering.</param>
+        /// <param name="cancellationToken">A cancellation token that can be used by other objects or threads to receive notice of cancellation.</param>
+        public virtual async Task<PreparedRequest> BuildListPortsRequest(IQueryStringBuilder queryString, CancellationToken cancellationToken = default(CancellationToken))
+        {
+            PreparedRequest request = await Endpoint.PrepareGetResourceRequest("ports", cancellationToken).ConfigureAwait(false);
+
+            request.Url.SetQueryParams(queryString?.Build());
+
+            return request;
         }
 
         /// <summary>

src/corelib/Networking/v2/NetworkingService.cs

@@ -141,13 +141,10 @@ public NetworkingService(IAuthenticationProvider authenticationProvider, string
 
         #region Ports
 
-        /// <inheritdoc cref="NetworkingApiBuilder.ListPortsAsync" />
-        public async Task<IEnumerable<Port>> ListPortsAsync(CancellationToken cancellationToken = default(CancellationToken))
+        /// <inheritdoc cref="NetworkingApiBuilder.ListPortsAsync{T}" />
+        public async Task<IEnumerable<Port>> ListPortsAsync(PortListOptions options = null, CancellationToken cancellationToken = default(CancellationToken))
         {
-            return await _networkingApiBuilder
-                .ListPortsAsync(cancellationToken)
-                .SendAsync()
-                .ReceiveJson<PortCollection>();
+            return await _networkingApiBuilder.ListPortsAsync<PortCollection>(options, cancellationToken);
         }
 
         /// <inheritdoc cref="NetworkingApiBuilder.CreatePortAsync" />

src/corelib/Networking/v2/NetworkingServiceExtensions.cs

@@ -169,9 +169,9 @@ public static void DeleteSubnet(this NetworkingService networkingService, Identi
         /// <returns>
         /// A collection of port resources associated with the account.
         /// </returns>
-        public static IEnumerable<Port> ListPorts(this NetworkingService networkingService)
+        public static IEnumerable<Port> ListPorts(this NetworkingService networkingService, PortListOptions options = null)
         {
-            return networkingService.ListPortsAsync().ForceSynchronous();
+            return networkingService.ListPortsAsync(options).ForceSynchronous();
         }
 
         /// <summary>

src/corelib/Networking/v2/Port.cs

@@ -1,4 +1,7 @@
-using Newtonsoft.Json;
+using System.Collections.Generic;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
+using OpenStack.Serialization;
 
 namespace OpenStack.Networking.v2
 {
@@ -9,7 +12,7 @@ namespace OpenStack.Networking.v2
     /// Virtual (or logical) switch ports on a given network.
     /// </para>
     /// <threadsafety static="true" instance="false"/>
-    public class Port : PortCreateDefinition
+    public class Port : PortCreateDefinition, IHaveExtraData, IServiceResource
     {
         /// <summary>
         /// The ID of the port.
@@ -34,5 +37,10 @@ public class Port : PortCreateDefinition
         /// </summary>
         [JsonProperty("port_security_enabled")]
         public bool IsPortSecurityEnabled { get; set; }
+
+        [JsonExtensionData]
+        IDictionary<string, JToken> IHaveExtraData.Data { get; set; } = new Dictionary<string, JToken>();
+
+        object IServiceResource.Owner { get; set; }
     }
 }

src/corelib/Networking/v2/PortListOptions.cs

@@ -0,0 +1,26 @@
+using System.Collections.Generic;
+
+namespace OpenStack.Networking.v2
+{
+    /// <summary>
+    /// Optional filter and paging options when listing ports.
+    /// </summary>
+    public class PortListOptions : FilterOptions
+    {
+        /// <summary>
+        /// Filter by the associated device identifier
+        /// </summary>
+        public Identifier DeviceId { get; set; }
+
+        /// <summary />
+        protected override IDictionary<string, object> BuildQueryString()
+        {
+            var queryString = new Dictionary<string, object>
+            {
+                ["device_id"] = DeviceId
+            };
+
+            return queryString;
+        }
+    }
+}

src/corelib/OpenStack.csproj

@@ -196,6 +196,7 @@
     <Compile Include="Networking\NamespaceDoc.cs" />
     <Compile Include="Networking\v2\AllowedAddress.cs" />
     <Compile Include="Networking\v2\AllocationPool.cs" />
+    <Compile Include="Networking\v2\PortListOptions.cs" />
     <Compile Include="Networking\v2\HostRoute.cs" />
     <Compile Include="Networking\v2\IPAddressAssociation.cs" />
     <Compile Include="Networking\v2\Layer3\ExternalGateway.cs" />

src/testing/unit/Networking/v2/PortTests.cs

@@ -34,6 +34,19 @@ public void ListPorts()
             }
         }
 
+        [Fact]
+        public void FilterPorts()
+        {
+            using (var httpTest = new HttpTest())
+            {
+                httpTest.RespondWithJson(new PortCollection());
+
+                _networkingService.ListPorts(new PortListOptions {DeviceId = "123"});
+
+                httpTest.ShouldHaveCalled("*/ports?device_id=123");
+            }
+        }
+
         [Fact]
         public void CreatePort()
         {