Handling TCP: prefix in firewall rule creation (#2507)

* Handling TCP: prefix in firewall rule creation

* reverting scope change

* lower-casing const for readability

Author: Benjin

src/Microsoft.SqlTools.ResourceProvider.Core/Firewall/FirewallRuleService.cs

@@ -53,6 +53,12 @@ IAzureAuthenticationManager AuthenticationManager
     /// </summary>
     public class FirewallRuleService : IFirewallRuleService
     {
+
+        /// <summary>
+        /// TCP prefix for server names
+        /// </summary>
+        const string TCP_PREFIX = "tcp:";
+
         /// <summary>
         /// Creates firewall rule for given server name and IP address range. Throws exception if operation fails
         /// </summary>
@@ -257,6 +263,12 @@ private async Task<IAzureSqlServerResource> FindAzureResourceForSubscriptionAsyn
                 {
                     return null;
                 }
+
+                if (serverName.StartsWith(TCP_PREFIX, StringComparison.OrdinalIgnoreCase))
+                {
+                    serverName = serverName.Substring(TCP_PREFIX.Length);
+                }
+
                 foreach (IAzureSqlServerResource resource in resources)
                 {
                     if (serverName.Equals(resource.FullyQualifiedDomainName, StringComparison.OrdinalIgnoreCase))

test/Microsoft.SqlTools.ServiceLayer.UnitTests/ResourceProvider/FirewallRuleServiceTest.cs

@@ -241,6 +241,21 @@ public async Task CreateShouldFindTheRightResourceGivenValidResourceInMiddle()
             await VerifyCreateAsync(testContext, testContext.ServerName);
         }
 
+        [Test]
+        public async Task CreateShouldFindTheRightResourceWithTcpPrefix()
+        {
+            ServiceTestContext testContext = new ServiceTestContext();
+            var resources = new List<IAzureSqlServerResource>
+            {
+                ServiceTestContext.CreateAzureSqlServer(testContext.ServerName),
+            };
+            testContext.SubscriptionToResourcesMap[testContext.ValidSubscription.Subscription.SubscriptionId] = resources;
+
+            testContext = CreateMocks(testContext);
+
+            await VerifyCreateAsync(testContext, "tcp:" + testContext.ServerName, testContext.ServerName);
+        }
+
         [Test]
         public void CreateThrowExceptionIfResourceNotFound()
         {
@@ -305,16 +320,21 @@ public async Task CreateShouldCreateFirewallForTheRightServerFullyQualifiedName(
             testContext = CreateMocks(testContext);
 
             await VerifyCreateAsync(testContext, testContext.ServerName);
-        }        
+        }
+
+        private Task<FirewallRuleResponse> VerifyCreateAsync(ServiceTestContext testContext, string serverName, bool verifyFirewallRuleCreated = true)
+        {
+            return VerifyCreateAsync(testContext, serverName, serverName, verifyFirewallRuleCreated);
+        }
 
-        private async Task<FirewallRuleResponse> VerifyCreateAsync(ServiceTestContext testContext, string serverName, bool verifyFirewallRuleCreated = true)
+        private async Task<FirewallRuleResponse> VerifyCreateAsync(ServiceTestContext testContext, string firewallServerName, string azureServerName, bool verifyFirewallRuleCreated = true)
         {
             try
             {
                 FirewallRuleService service = new FirewallRuleService();
                 CreateFirewallRuleParams createFirewallRuleParams = new CreateFirewallRuleParams()
                 {
-                    ServerName = serverName,
+                    ServerName = firewallServerName,
                     StartIpAddress = testContext.StartIpAddress,
                     EndIpAddress = testContext.EndIpAddress
                 };
@@ -325,15 +345,15 @@ private async Task<FirewallRuleResponse> VerifyCreateAsync(ServiceTestContext te
                 {
                     testContext.AzureResourceManagerMock.Verify(x => x.CreateFirewallRuleAsync(
                             It.Is<IAzureResourceManagementSession>(s => s.SubscriptionContext.Subscription.SubscriptionId == testContext.ValidSubscription.Subscription.SubscriptionId),
-                            It.Is<IAzureSqlServerResource>(r => r.FullyQualifiedDomainName == serverName),
+                            It.Is<IAzureSqlServerResource>(r => r.FullyQualifiedDomainName == azureServerName),
                             It.Is<FirewallRuleRequest>(y => y.EndIpAddress.ToString().Equals(testContext.EndIpAddress) && y.StartIpAddress.ToString().Equals(testContext.StartIpAddress))),
                             Times.AtLeastOnce);
                 }
                 else
                 {
                     testContext.AzureResourceManagerMock.Verify(x => x.CreateFirewallRuleAsync(
                            It.Is<IAzureResourceManagementSession>(s => s.SubscriptionContext.Subscription.SubscriptionId == testContext.ValidSubscription.Subscription.SubscriptionId),
-                           It.Is<IAzureSqlServerResource>(r => r.FullyQualifiedDomainName == serverName),
+                           It.Is<IAzureSqlServerResource>(r => r.FullyQualifiedDomainName == firewallServerName),
                            It.Is<FirewallRuleRequest>(y => y.EndIpAddress.ToString().Equals(testContext.EndIpAddress) && y.StartIpAddress.ToString().Equals(testContext.StartIpAddress))),
                         Times.Never);
                 }