NetworkService.ListSecurityGroupRules

Author: carolynvs

src/corelib/Networking/v2/Layer3/NetworkingService_Layer3_Extensions.cs

@@ -111,6 +111,12 @@ public static class NetworkingService_Layer3_Extensions
         {
             return await service._networkingApiBuilder.ListSecurityGroupsAsync<SecurityGroupCollection>(options, cancellationToken).ConfigureAwait(false);
         }
+
+        /// <inheritdoc cref="NetworkingApiBuilder.ListSecurityGroupRulesAsync{T}" />
+        public static async Task<IEnumerable<SecurityGroupRule>> ListSecurityGroupRulesAsync(this NetworkingService service, SecurityGroupRuleListOptions options = null, CancellationToken cancellationToken = default(CancellationToken))
+        {
+            return await service._networkingApiBuilder.ListSecurityGroupRulesAsync<SecurityGroupRuleCollection>(options, cancellationToken).ConfigureAwait(false);
+        }
         #endregion
     }
 }
@@ -217,6 +223,11 @@ public static IEnumerable<SecurityGroup> ListSecurityGroups(this NetworkingServi
         {
             return service.ListSecurityGroupsAsync(options).ForceSynchronous();
         }
+        /// <inheritdoc cref="NetworkingService_Layer3_Extensions.ListSecurityGroupRulesAsync" />
+        public static IEnumerable<SecurityGroupRule> ListSecurityGroupRules(this NetworkingService service, SecurityGroupRuleListOptions options = null)
+        {
+            return service.ListSecurityGroupRulesAsync(options).ForceSynchronous();
+        }
         #endregion
 
     }

src/corelib/Networking/v2/Layer3/SecurityGroupRule.cs

@@ -1,4 +1,6 @@
-using Newtonsoft.Json;
+using System.Collections.Generic;
+using Newtonsoft.Json;
+using Newtonsoft.Json.Linq;
 using OpenStack.Serialization;
 
 namespace OpenStack.Networking.v2.Layer3
@@ -7,7 +9,7 @@ namespace OpenStack.Networking.v2.Layer3
     /// 
     /// </summary>
     [JsonConverterWithConstructor(typeof(RootWrapperConverter), "security_group_rule")]
-    public class SecurityGroupRule
+    public class SecurityGroupRule : IHaveExtraData, IServiceResource
     {
         /// <summary>
         /// ingress or egress: the direction in which the security group rule is applied.
@@ -71,5 +73,10 @@ public class SecurityGroupRule
         /// </summary>
         [JsonProperty("security_group_id")]
         public Identifier SecurityGroupId;
+
+        [JsonExtensionData]
+        IDictionary<string, JToken> IHaveExtraData.Data { get; set; } = new Dictionary<string, JToken>();
+
+        object IServiceResource.Owner { get; set; }
     }
 }

src/corelib/Networking/v2/Layer3/SecurityGroupRuleListOptions.cs

@@ -0,0 +1,26 @@
+using System.Collections.Generic;
+
+namespace OpenStack.Networking.v2.Layer3
+{
+    /// <summary>
+    /// Optional filter and paging options when listing security group rules.
+    /// </summary>
+    public class SecurityGroupRuleListOptions : FilterOptions
+    {
+        /// <summary>
+        /// Filter by the group name.
+        /// </summary>
+        public TrafficDirection Direction { get; set; }
+
+        /// <summary />
+        protected override IDictionary<string, object> BuildQueryString()
+        {
+            var queryString = new Dictionary<string, object>
+            {
+                ["direction"] = Direction
+            };
+
+            return queryString;
+        }
+    }
+}

src/corelib/Networking/v2/NetworkingApiBuilder.cs

@@ -704,6 +704,41 @@ public NetworkingApiBuilder(IServiceType serviceType, IAuthenticationProvider au
             return request;
         }
 
+        /// <summary>
+        /// Lists all network security group rules 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 security group rule resources associated with the account.
+        /// </returns>
+        public async Task<T> ListSecurityGroupRulesAsync<T>(IQueryStringBuilder queryString, CancellationToken cancellationToken = default(CancellationToken))
+            where T : IEnumerable<IServiceResource>
+        {
+            return await BuildListSecurityGroupRulesRequest(queryString, cancellationToken)
+                .SendAsync()
+                .ReceiveJson<T>()
+                .PropogateOwnerToChildren(this).ConfigureAwait(false);
+        }
+
+        /// <summary>
+        /// Builds a <see cref="ListSecurityGroupRulesAsync{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> BuildListSecurityGroupRulesRequest(IQueryStringBuilder queryString, CancellationToken cancellationToken = default(CancellationToken))
+        {
+            Url endpoint = await Endpoint.GetEndpoint(cancellationToken).ConfigureAwait(false);
+
+            var request = endpoint
+                .AppendPathSegments("security-group-rules")
+                .Authenticate(AuthenticationProvider)
+                .PrepareGet(cancellationToken);
+
+            request.Url.SetQueryParams(queryString?.Build());
+
+            return request;
+        }
         #endregion
 
         #region Floating IPs

src/corelib/Networking/v2/Serialization/SecurityGroupRuleCollection.cs

@@ -0,0 +1,32 @@
+using System.Collections.Generic;
+using OpenStack.Networking.v2.Layer3;
+using OpenStack.Serialization;
+
+namespace OpenStack.Networking.v2.Serialization
+{
+    /// <summary>
+    /// Represents a collection of security group rule resources returned by the <see cref="NetworkingService"/>.
+    /// <para>Intended for custom implementations and stubbing responses in unit tests.</para>
+    /// </summary>
+    [JsonConverterWithConstructor(typeof(RootWrapperConverter), "security_group_rules")]
+    public class SecurityGroupRuleCollection : List<SecurityGroupRule>
+    {
+
+        /// <summary>
+        /// Initializes a new instance of the<see cref="SecurityGroupRuleCollection"/> class.
+        /// </summary>
+        public SecurityGroupRuleCollection()
+        {
+
+        }
+
+        /// <summary>
+        /// Initializes a new instance of the<see cref="SecurityGroupRuleCollection"/> class.
+        /// </summary>
+        /// <param name="items"></param>
+        public SecurityGroupRuleCollection(IEnumerable<SecurityGroupRule> items) : base(items)
+        {
+
+        }
+    }
+}

src/corelib/OpenStack.csproj

@@ -200,6 +200,7 @@
     <Compile Include="Networking\v2\Layer3\SecurityGroupRule.cs" />
     <Compile Include="Networking\v2\AllowedAddress.cs" />
     <Compile Include="Networking\v2\AllocationPool.cs" />
+    <Compile Include="Networking\v2\Layer3\SecurityGroupRuleListOptions.cs" />
     <Compile Include="Networking\v2\PortListOptions.cs" />
     <Compile Include="Networking\v2\HostRoute.cs" />
     <Compile Include="Networking\v2\IPAddressAssociation.cs" />
@@ -240,6 +241,7 @@
     <Compile Include="Networking\v2\Serialization\PortCollection.cs" />
     <Compile Include="Networking\v2\Serialization\PortDefinitionCollection.cs" />
     <Compile Include="Networking\v2\Serialization\SecurityGroupCollection.cs" />
+    <Compile Include="Networking\v2\Serialization\SecurityGroupRuleCollection.cs" />
     <Compile Include="Networking\v2\Serialization\SubnetCollection.cs" />
     <Compile Include="Networking\v2\Serialization\SubnetDefinitionCollection.cs" />
     <Compile Include="Networking\v2\Serialization\TrafficDirection.cs" />

src/testing/unit/Networking/v2/Layer3/Layer3Tests.cs

@@ -340,6 +340,28 @@ public void ListSecurityGroups()
                 Assert.Equal(rule.Id, resultRule.Id);
             }
         }
+
+        [Fact]
+        public void ListSecurityGroupRules()
+        {
+            using (var httpTest = new HttpTest())
+            {
+                Identifier securityGroupId = Guid.NewGuid();
+                Identifier securityGroupRuleId = Guid.NewGuid();
+                httpTest.RespondWithJson(new SecurityGroupRuleCollection
+                {
+                    new SecurityGroupRule {Id = securityGroupRuleId, SecurityGroupId = securityGroupId}
+                });
+
+                var results = _networking.ListSecurityGroupRules();
+
+                httpTest.ShouldHaveCalled("*/security-group-rules");
+                Assert.Equal(1, results.Count());
+                var result = results.First();
+                Assert.Equal(securityGroupRuleId, result.Id);
+                Assert.Equal(securityGroupId, result.SecurityGroupId);
+            }
+        }
         #endregion
 
     }