Standardize Networking.ListSecurityGroups

carolynvs · carolynvs · commit c1b5a2d18f6a · 2016-06-07T15:48:40.000-05:00
* Enable filtering by name
* Expose a builder and executor on the API
* Implement IHaveExtraData and IServiceResource
diff --git a/src/corelib/Networking/v2/Layer3/NetworkingService_Layer3_Extensions.cs b/src/corelib/Networking/v2/Layer3/NetworkingService_Layer3_Extensions.cs
@@ -106,14 +106,10 @@ public static class NetworkingService_Layer3_Extensions
         #endregion
 
         #region Security Groups
-        /// <inheritdoc cref="NetworkingApiBuilder.ListSecurityGroupAsync(CancellationToken)" />
-        public static async Task<IEnumerable<SecurityGroup>> ListSecurityGroupAsync(this NetworkingService service, CancellationToken cancellationToken = default(CancellationToken))
+        /// <inheritdoc cref="NetworkingApiBuilder.ListSecurityGroupsAsync{T}" />
+        public static async Task<IEnumerable<SecurityGroup>> ListSecurityGroupsAsync(this NetworkingService service, SecurityGroupListOptions options = null, CancellationToken cancellationToken = default(CancellationToken))
         {
-            return await service._networkingApiBuilder
-                .ListSecurityGroupAsync(cancellationToken)
-                .SendAsync()
-                .ReceiveJson<NetSecurityGroupCollection>()
-                .ConfigureAwait(false);
+            return await service._networkingApiBuilder.ListSecurityGroupsAsync<SecurityGroupCollection>(options, cancellationToken).ConfigureAwait(false);
         }
         #endregion
     }
@@ -215,11 +211,11 @@ public static void DeleteFloatingIP(this NetworkingService service, Identifier f
         }
         #endregion
 
-        #region Security Group
-        /// <inheritdoc cref="NetworkingService_Layer3_Extensions.ListSecurityGroupAsync" />
-        public static  IEnumerable<SecurityGroup> ListSecurityGroup (this NetworkingService service)
+        #region Security Groups
+        /// <inheritdoc cref="NetworkingService_Layer3_Extensions.ListSecurityGroupsAsync" />
+        public static IEnumerable<SecurityGroup> ListSecurityGroups(this NetworkingService service, SecurityGroupListOptions options = null)
         {
-            return service._networkingApiBuilder.ListSecurityGroupAsync().SendAsync().ReceiveJson<NetSecurityGroupCollection>().ForceSynchronous();
+            return service.ListSecurityGroupsAsync(options).ForceSynchronous();
         }
         #endregion
 
diff --git a/src/corelib/Networking/v2/Layer3/SecurityGroup.cs b/src/corelib/Networking/v2/Layer3/SecurityGroup.cs
@@ -1,48 +1,43 @@
-﻿using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
+﻿using System.Collections.Generic;
 using Newtonsoft.Json;
-using OpenStack.Networking.v2;
+using Newtonsoft.Json.Linq;
 using OpenStack.Serialization;
 
 namespace OpenStack.Networking.v2.Layer3
 {
     /// <summary>
-    ///Regpresents the security group of the <see cref="NetworkingService"/> 
+    /// Represents the security group of the <see cref="NetworkingService"/> 
     /// </summary>
-    [JsonConverterWithConstructor(typeof(RootWrapperConverter), "securitygroup")]
-    public class SecurityGroup
+    [JsonConverterWithConstructor(typeof(RootWrapperConverter), "security_group")]
+    public class SecurityGroup : IHaveExtraData, IServiceResource
     {
         /// <summary>
-        ///the security group description
+        /// The security group description
         /// </summary>
         [JsonProperty("description")]
         public string Description;
 
         /// <summary>
-        ///the UUID of security group
+        /// The UUID of security group
         /// </summary>
         [JsonProperty("id")]
         public Identifier Id;
 
         /// <summary>
-        /// the security group name
+        /// The security group name
         /// </summary>
         [JsonProperty("name")]
         public string Name;
 
         /// <summary>
-        ///A list of <see cref="SecurityGroup"/> objects.
+        /// A list of <see cref="SecurityGroup"/> objects.
         /// </summary>
         [JsonProperty("security_group_rules")]
         public IList<SecurityGroupRule> SecurityGroupRules;
 
-        /// <summary>
-        ///The UUId of tenant who owns the scurity group
-        /// </summary>
-        [JsonProperty("tenant_id")]
-        public string TenantId;
+        [JsonExtensionData]
+        IDictionary<string, JToken> IHaveExtraData.Data { get; set; } = new Dictionary<string, JToken>();
+
+        object IServiceResource.Owner { get; set; }
     }
 }
diff --git a/src/corelib/Networking/v2/Layer3/SecurityGroupListOptions.cs b/src/corelib/Networking/v2/Layer3/SecurityGroupListOptions.cs
@@ -0,0 +1,26 @@
+﻿using System.Collections.Generic;
+
+namespace OpenStack.Networking.v2.Layer3
+{
+    /// <summary>
+    /// Optional filter and paging options when listing security groups.
+    /// </summary>
+    public class SecurityGroupListOptions : FilterOptions
+    {
+        /// <summary>
+        /// Filter by the group name.
+        /// </summary>
+        public string Name { get; set; }
+
+        /// <summary />
+        protected override IDictionary<string, object> BuildQueryString()
+        {
+            var queryString = new Dictionary<string, object>
+            {
+                ["name"] = Name
+            };
+
+            return queryString;
+        }
+    }
+}
diff --git a/src/corelib/Networking/v2/Layer3/SecurityGroupRule.cs b/src/corelib/Networking/v2/Layer3/SecurityGroupRule.cs
@@ -1,29 +1,27 @@
-﻿using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
-using Newtonsoft.Json;
+﻿using Newtonsoft.Json;
+using OpenStack.Serialization;
+
 namespace OpenStack.Networking.v2.Layer3
 {
     /// <summary>
     /// 
     /// </summary>
+    [JsonConverterWithConstructor(typeof(RootWrapperConverter), "security_group_rule")]
     public class SecurityGroupRule
     {
         /// <summary>
-        ///ngress or egress: the direction in which the security group rule is applied.
-        ///For a compute instance, an ingress security group rule is applied to incoming (ingress) traffic for that instance. 
-        ///An egress rule is applied to traffic leaving the instance.
+        /// ingress or egress: the direction in which the security group rule is applied.
+        /// For a compute instance, an ingress security group rule is applied to incoming (ingress) traffic for that instance. 
+        /// An egress rule is applied to traffic leaving the instance.
         /// </summary>
         [JsonProperty("direction")]
-        public string Direction;
+        public TrafficDirection Direction;
 
         /// <summary>
-        ///Must be IPv4 or IPv6, and addresses represented in CIDR must match the ingress or egress rules. 
+        /// The internet protocol version. Addresses represented in CIDR must match the ingress or egress rules. 
         /// </summary>
         [JsonProperty("ethertype")]
-        public string Ethertype;
+        public IPVersion Ethertype;
 
         /// <summary>
         /// The UUID of the security group rule.
@@ -32,52 +30,46 @@ public class SecurityGroupRule
         public Identifier Id;
 
         /// <summary>
-        ///The maximum port number in the range that is matched by the security group rule. 
-        ///The port_range_min attribute constrains the port_range_max attribute.
-        ///If the protocol is ICMP, this value must be an ICMP type. 
+        /// The minimum port number in the range that is matched by the security group rule.
+        /// If the protocol is TCP or UDP, this value must be less than or equal to the port_range_max attribute value.
+        /// If the protocol is ICMP, this value must be an ICMP type.
         /// </summary>
-        [JsonProperty("port_range_max")]
-        public int PortRangeMax;
+        [JsonProperty("port_range_min")]
+        public int MinPort { get; set; }
 
-        ///<summary>
-        ///The minimum port number in the range that is matched by the security group rule.
-        ///If the protocol is TCP or UDP, this value must be less than or equal to the port_range_max attribute value.
-        ///If the protocol is ICMP, this value must be an ICMP type.
+        /// <summary>
+        /// The maximum port number in the range that is matched by the security group rule. 
+        /// The port_range_min attribute constrains the port_range_max attribute.
+        /// If the protocol is ICMP, this value must be an ICMP type. 
         /// </summary>
-        [JsonProperty("port_range_min")]
-        public int PortRangeMin;
+        [JsonProperty("port_range_max")]
+        public int MaxPort { get; set; }
 
         /// <summary>
-        ///The protocol that is matched by the security group rule. Value is null, icmp, icmpv6, tcp, or udp. 
+        /// The protocol that is matched by the security group rule.
         /// </summary>
         [JsonProperty("protocol")]
-        public string Protocol;
+        public IPProtocol Protocol;
 
-        ///<summary>
-        ///The remote group UUID to associate with this security group rule.
-        ///You can specify either the remote_group_id or remote_ip_prefix attribute in the request body. 
+        /// <summary>
+        /// The remote group UUID to associate with this security group rule.
+        /// You can specify either the remote_group_id or remote_ip_prefix attribute in the request body. 
         /// </summary>
         [JsonProperty("remote_group_id")]
-        public string RemoteGroupId;
+        public Identifier RemoteGroupId;
 
         /// <summary>
-        ///The remote IP prefix to associate with this security group rule.
-        ///You can specify either the remote_group_id or remote_ip_prefix attribute in the request body.
-        ///This attribute value matches the IP prefix as the source IP address of the IP packet. 
+        /// The remote IP prefix or CIDR to associate with this security group rule.
+        /// You can specify either the remote_group_id or remote_ip_prefix attribute in the request body.
+        /// This attribute value matches the IP prefix as the source IP address of the IP packet. 
         /// </summary>
         [JsonProperty("remote_ip_prefix")]
-        public string RemoteIpPrefix;
+        public string RemoteCIDR;
 
         /// <summary>
-        ///The UUId of security group 
+        /// The UUId of security group 
         /// </summary>
         [JsonProperty("security_group_id")]
-        public string SecurityGroupId;
-
-        /// <summary>
-        /// The UUID of the tenant who owns the security group rule. Only administrative users can specify a tenant UUID other than their own.
-        /// </summary>
-        [JsonProperty("tenant_id")]
-        public string TenantId;
+        public Identifier SecurityGroupId;
     }
 }
diff --git a/src/corelib/Networking/v2/NetworkingApiBuilder.cs b/src/corelib/Networking/v2/NetworkingApiBuilder.cs
@@ -384,7 +384,7 @@ public NetworkingApiBuilder(IServiceType serviceType, IAuthenticationProvider au
         }
         #endregion
 
-        #region Level 3 Extension
+        #region Layer 3 Extension
 
         #region Routers
         /// <summary>
@@ -669,20 +669,39 @@ public NetworkingApiBuilder(IServiceType serviceType, IAuthenticationProvider au
 
         #region SecurityGroup
         /// <summary>
-        /// Lists all networks security groups associated with the account.
+        /// Lists all network security groups 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 network resources associated with the account.
+        /// A collection of network security group resources associated with the account.
         /// </returns>
-        public async Task<PreparedRequest> ListSecurityGroupAsync(CancellationToken cancellationToken = default(CancellationToken))
+        public async Task<T> ListSecurityGroupsAsync<T>(IQueryStringBuilder queryString, CancellationToken cancellationToken = default(CancellationToken))
+            where T : IEnumerable<IServiceResource>
+        {
+            return await BuildListSecurityGroupsRequest(queryString, cancellationToken)
+                .SendAsync()
+                .ReceiveJson<T>()
+                .PropogateOwnerToChildren(this).ConfigureAwait(false);
+        }
+
+        /// <summary>
+        /// Builds a <see cref="ListSecurityGroupsAsync{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 async Task<PreparedRequest> BuildListSecurityGroupsRequest(IQueryStringBuilder queryString, CancellationToken cancellationToken = default(CancellationToken))
         {
             Url endpoint = await Endpoint.GetEndpoint(cancellationToken).ConfigureAwait(false);
 
-            return endpoint
+            var request = endpoint
                 .AppendPathSegments("security-groups")
                 .Authenticate(AuthenticationProvider)
                 .PrepareGet(cancellationToken);
+
+            request.Url.SetQueryParams(queryString?.Build());
+
+            return request;
         }
 
         #endregion
diff --git a/src/corelib/Networking/v2/Serialization/SecurityGroupCollection.cs b/src/corelib/Networking/v2/Serialization/SecurityGroupCollection.cs
@@ -1,8 +1,4 @@
-﻿using System;
-using System.Collections.Generic;
-using System.Linq;
-using System.Text;
-using System.Threading.Tasks;
+﻿using System.Collections.Generic;
 using OpenStack.Serialization;
 using OpenStack.Networking.v2.Layer3;
 
@@ -13,25 +9,24 @@ namespace OpenStack.Networking.v2.Serialization
     /// <para>Intended for custom implementations and stubbing responses in unit tests.</para>
     /// </summary>
     [JsonConverterWithConstructor(typeof(RootWrapperConverter), "security_groups")]
-     public class NetSecurityGroupCollection : List<SecurityGroup>
+    public class SecurityGroupCollection : List<SecurityGroup>
     {
-
         /// <summary>
-        ///Initializes a new instance of the<see cref="SecurityGroup"/> class.
+        /// Initializes a new instance of the <see cref="SecurityGroupCollection"/> class.
         /// </summary>
-        public NetSecurityGroupCollection()
+        public SecurityGroupCollection()
         {
 
         }
 
         /// <summary>
-        ///Initializes a new instance of the<see cref="SecurityGroup"/> class.
+        /// Initializes a new instance of the<see cref="SecurityGroupCollection"/> class.
         /// </summary>
-        /// <param name="securityGroups"></param>
-        public NetSecurityGroupCollection(IEnumerable<SecurityGroup> securityGroups) : base(securityGroups)
+        /// <param name="items">items</param>
+        public SecurityGroupCollection(IEnumerable<SecurityGroup> items)
+            : base(items)
         {
 
         }
-        
     }
 }
diff --git a/src/corelib/Networking/v2/Serialization/TrafficDirection.cs b/src/corelib/Networking/v2/Serialization/TrafficDirection.cs
@@ -0,0 +1,22 @@
+﻿using OpenStack.Serialization;
+
+namespace OpenStack.Networking.v2.Serialization
+{
+    /// <summary>
+    /// Direction of network traffic.
+    /// </summary>
+    /// <exclude />
+    public class TrafficDirection<T> : StringEnumeration
+        where T : TrafficDirection<T>, new()
+    {
+        /// <summary>
+        /// Incoming network traffic (ingress).
+        /// </summary>
+        public static readonly T Incoming = new T { DisplayName = "ingress" };
+
+        /// <summary>
+        /// Outgoing network traffic (egress).
+        /// </summary>
+        public static readonly T Outgoing = new T { DisplayName = "egress" };
+    }
+}
diff --git a/src/corelib/Networking/v2/TrafficDirection.cs b/src/corelib/Networking/v2/TrafficDirection.cs
@@ -0,0 +1,8 @@
+using OpenStack.Networking.v2.Serialization;
+
+namespace OpenStack.Networking.v2
+{
+    /// <inheritdoc />
+    public class TrafficDirection : TrafficDirection<TrafficDirection>
+    { }
+}
diff --git a/src/corelib/OpenStack.csproj b/src/corelib/OpenStack.csproj
@@ -195,6 +195,7 @@
     <Compile Include="Networking\IPVersion.cs" />
     <Compile Include="Networking\NamespaceDoc.cs" />
     <Compile Include="Networking\v2\IPProtocol.cs" />
+    <Compile Include="Networking\v2\Layer3\SecurityGroupListOptions.cs" />
     <Compile Include="Networking\v2\Layer3\SecurityGroup.cs" />
     <Compile Include="Networking\v2\Layer3\SecurityGroupRule.cs" />
     <Compile Include="Networking\v2\AllowedAddress.cs" />
@@ -238,12 +239,14 @@
     <Compile Include="Networking\v2\Serialization\NetworkDefinitionCollection.cs" />
     <Compile Include="Networking\v2\Serialization\PortCollection.cs" />
     <Compile Include="Networking\v2\Serialization\PortDefinitionCollection.cs" />
-    <Compile Include="Networking\v2\Serialization\NetSecurityGroupCollection.cs" />
+    <Compile Include="Networking\v2\Serialization\SecurityGroupCollection.cs" />
     <Compile Include="Networking\v2\Serialization\SubnetCollection.cs" />
     <Compile Include="Networking\v2\Serialization\SubnetDefinitionCollection.cs" />
+    <Compile Include="Networking\v2\Serialization\TrafficDirection.cs" />
     <Compile Include="Networking\v2\Subnet.cs" />
     <Compile Include="Networking\v2\SubnetCreateDefinition.cs" />
     <Compile Include="Networking\v2\SubnetUpdateDefinition.cs" />
+    <Compile Include="Networking\v2\TrafficDirection.cs" />
     <Compile Include="OpenStackNet.cs" />
     <Compile Include="ContentDeliveryNetworks\v1\Flavor.cs" />
     <Compile Include="ContentDeliveryNetworks\v1\FlavorCollection.cs" />
diff --git a/src/testing/unit/Networking/v2/Layer3/Layer3Tests.cs b/src/testing/unit/Networking/v2/Layer3/Layer3Tests.cs

Original file line number	Diff line number	Diff line change
`@@ -106,14 +106,10 @@ public static class NetworkingService_Layer3_Extensions`
`106`	`106`	`#endregion`
`107`	`107`
`108`	`108`	`#region Security Groups`
`109`		`- /// <inheritdoc cref="NetworkingApiBuilder.ListSecurityGroupAsync(CancellationToken)" />`
`110`		`- public static async Task<IEnumerable<SecurityGroup>> ListSecurityGroupAsync(this NetworkingService service, CancellationToken cancellationToken = default(CancellationToken))`
	`109`	`+ /// <inheritdoc cref="NetworkingApiBuilder.ListSecurityGroupsAsync{T}" />`
	`110`	`+ public static async Task<IEnumerable<SecurityGroup>> ListSecurityGroupsAsync(this NetworkingService service, SecurityGroupListOptions options = null, CancellationToken cancellationToken = default(CancellationToken))`
`111`	`111`	`{`
`112`		`- return await service._networkingApiBuilder`
`113`		`- .ListSecurityGroupAsync(cancellationToken)`
`114`		`- .SendAsync()`
`115`		`- .ReceiveJson<NetSecurityGroupCollection>()`
`116`		`- .ConfigureAwait(false);`
	`112`	`+ return await service._networkingApiBuilder.ListSecurityGroupsAsync<SecurityGroupCollection>(options, cancellationToken).ConfigureAwait(false);`
`117`	`113`	`}`
`118`	`114`	`#endregion`
`119`	`115`	`}`
`@@ -215,11 +211,11 @@ public static void DeleteFloatingIP(this NetworkingService service, Identifier f`
`215`	`211`	`}`
`216`	`212`	`#endregion`
`217`	`213`
`218`		`- #region Security Group`
`219`		`- /// <inheritdoc cref="NetworkingService_Layer3_Extensions.ListSecurityGroupAsync" />`
`220`		`- public static IEnumerable<SecurityGroup> ListSecurityGroup (this NetworkingService service)`
	`214`	`+ #region Security Groups`
	`215`	`+ /// <inheritdoc cref="NetworkingService_Layer3_Extensions.ListSecurityGroupsAsync" />`
	`216`	`+ public static IEnumerable<SecurityGroup> ListSecurityGroups(this NetworkingService service, SecurityGroupListOptions options = null)`
`221`	`217`	`{`
`222`		`- return service._networkingApiBuilder.ListSecurityGroupAsync().SendAsync().ReceiveJson<NetSecurityGroupCollection>().ForceSynchronous();`
	`218`	`+ return service.ListSecurityGroupsAsync(options).ForceSynchronous();`
`223`	`219`	`}`
`224`	`220`	`#endregion`
`225`	`221`
Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,4 @@`
`1`		`-using System;`
`2`		`-using System.Collections.Generic;`
`3`		`-using System.Linq;`
`4`		`-using System.Text;`
`5`		`-using System.Threading.Tasks;`
	`1`	`+using System.Collections.Generic;`
`6`	`2`	`using OpenStack.Serialization;`
`7`	`3`	`using OpenStack.Networking.v2.Layer3;`
`8`	`4`
`@@ -13,25 +9,24 @@ namespace OpenStack.Networking.v2.Serialization`
`13`	`9`	`/// <para>Intended for custom implementations and stubbing responses in unit tests.</para>`
`14`	`10`	`/// </summary>`
`15`	`11`	`[JsonConverterWithConstructor(typeof(RootWrapperConverter), "security_groups")]`
`16`		`- public class NetSecurityGroupCollection : List<SecurityGroup>`
	`12`	`+ public class SecurityGroupCollection : List<SecurityGroup>`
`17`	`13`	`{`
`18`		`-`
`19`	`14`	`/// <summary>`
`20`		`- ///Initializes a new instance of the<see cref="SecurityGroup"/> class.`
	`15`	`+ /// Initializes a new instance of the <see cref="SecurityGroupCollection"/> class.`
`21`	`16`	`/// </summary>`
`22`		`- public NetSecurityGroupCollection()`
	`17`	`+ public SecurityGroupCollection()`
`23`	`18`	`{`
`24`	`19`
`25`	`20`	`}`
`26`	`21`
`27`	`22`	`/// <summary>`
`28`		`- ///Initializes a new instance of the<see cref="SecurityGroup"/> class.`
	`23`	`+ /// Initializes a new instance of the<see cref="SecurityGroupCollection"/> class.`
`29`	`24`	`/// </summary>`
`30`		`- /// <param name="securityGroups"></param>`
`31`		`- public NetSecurityGroupCollection(IEnumerable<SecurityGroup> securityGroups) : base(securityGroups)`
	`25`	`+ /// <param name="items">items</param>`
	`26`	`+ public SecurityGroupCollection(IEnumerable<SecurityGroup> items)`
	`27`	`+ : base(items)`
`32`	`28`	`{`
`33`	`29`
`34`	`30`	`}`
`35`		`-`
`36`	`31`	`}`
`37`	`32`	`}`