Added validation for ResourceGroupName and Cache Name (#2696)

Author: SiddharthChatrolaMs

src/ResourceManager/RedisCache/Commands.RedisCache.Test/Commands.RedisCache.Test.csproj

@@ -192,6 +192,7 @@
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="ScenarioTests\RedisCacheController.cs" />
     <Compile Include="ScenarioTests\RedisCacheTests.cs" />
+    <Compile Include="ScenarioTests\UtilityTests.cs" />
   </ItemGroup>
   <ItemGroup>
     <ProjectReference Include="..\..\..\Common\Commands.Common.Authentication\Commands.Common.Authentication.csproj">

src/ResourceManager/RedisCache/Commands.RedisCache.Test/ScenarioTests/Utilitytests.cs

@@ -0,0 +1,51 @@
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+using Xunit;
+
+namespace Microsoft.Azure.Commands.RedisCache.Test.ScenarioTests
+{
+    public class UtilityTests
+    {
+        [Fact]
+        public void ValidateResourceGroupAndResourceName_InvalidResourceGroup()
+        {
+            string resourceGroup = "subscriptions/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa/resourceGroups/Default-Storage-NorthEurope";
+            string name = "cache-name";
+
+            var ex = Assert.Throws<ArgumentException>(() => Utility.ValidateResourceGroupAndResourceName(resourceGroup, name));
+            Assert.Contains("ResourceGroupName should not contain '/'. Name should be the plain, short name of the resource group, e.g. 'myResourceGroup'. (Not an Azure resource identifier.)", ex.Message);
+        }
+
+        [Fact]
+        public void ValidateResourceGroupAndResourceName_InvalidRedisCacheName_FullName()
+        {
+            string resourceGroup = "Default-Storage-NorthEurope";
+            string name = "cache-name.redis.cache.windows.net";
+
+            var ex = Assert.Throws<ArgumentException>(() => Utility.ValidateResourceGroupAndResourceName(resourceGroup, name));
+            Assert.Contains("Name should not contain '/' or '.'. Name should be the plain, short name of the redis cache, e.g. 'mycache'. (Not a fully qualified DNS name, and not an Azure resource identifier.)", ex.Message);
+        }
+
+        [Fact]
+        public void ValidateResourceGroupAndResourceName_InvalidRedisCacheName_ID()
+        {
+            string resourceGroup = "Default-Storage-NorthEurope";
+            string name = "subscriptions/aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa/resourceGroups/Default-Storage-NorthEurope/cache-name";
+
+            var ex = Assert.Throws<ArgumentException>(() => Utility.ValidateResourceGroupAndResourceName(resourceGroup, name));
+            Assert.Contains("Name should not contain '/' or '.'. Name should be the plain, short name of the redis cache, e.g. 'mycache'. (Not a fully qualified DNS name, and not an Azure resource identifier.)", ex.Message);
+        }
+
+        [Fact]
+        public void ValidateResourceGroupAndResourceName_Success()
+        {
+            string resourceGroup = "Default-Storage-NorthEurope";
+            string name = "cache-name";
+
+            Utility.ValidateResourceGroupAndResourceName(resourceGroup, name);
+        }
+    }
+}

src/ResourceManager/RedisCache/Commands.RedisCache/Commands.RedisCache.csproj

@@ -174,6 +174,7 @@
     <Compile Include="Models\RedisCacheClient.cs" />
     <Compile Include="Models\RedisCacheCmdletBase.cs" />
     <Compile Include="Models\SizeConverter.cs" />
+    <Compile Include="Models\Utility.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="Properties\Resources.Designer.cs">
       <AutoGen>True</AutoGen>

src/ResourceManager/RedisCache/Commands.RedisCache/Commands/ExportAzureRedisCache.cs

@@ -46,6 +46,7 @@ public class ExportAzureRedisCache : RedisCacheCmdletBase
 
         public override void ExecuteCmdlet()
         {
+            Utility.ValidateResourceGroupAndResourceName(ResourceGroupName, Name);
             CacheClient.ExportToCache(ResourceGroupName, Name, Container, Prefix, Format);
 
             if (PassThru)

src/ResourceManager/RedisCache/Commands.RedisCache/Commands/GetAzureRedisCache.cs

@@ -36,6 +36,7 @@ public class GetAzureRedisCache : RedisCacheCmdletBase
 
         public override void ExecuteCmdlet()
         {
+            Utility.ValidateResourceGroupAndResourceName(ResourceGroupName, Name);
             if (!string.IsNullOrEmpty(ResourceGroupName) && !string.IsNullOrEmpty(Name))
             {
                 // Get for single cache

src/ResourceManager/RedisCache/Commands.RedisCache/Commands/GetAzureRedisCacheKey.cs

@@ -30,6 +30,7 @@ public class GetAzureRedisCacheKey : RedisCacheCmdletBase
 
         public override void ExecuteCmdlet()
         {
+            Utility.ValidateResourceGroupAndResourceName(ResourceGroupName, Name);
             RedisListKeysResult keysResponse = CacheClient.GetAccessKeys(ResourceGroupName, Name);
             WriteObject(new RedisAccessKeys()
             {

src/ResourceManager/RedisCache/Commands.RedisCache/Commands/GetAzureRedisCachePatchSchedule.cs

@@ -35,6 +35,7 @@ public class GetAzureRedisCachePatchSchedule : RedisCacheCmdletBase
 
         public override void ExecuteCmdlet()
         {
+            Utility.ValidateResourceGroupAndResourceName(ResourceGroupName, Name);
             IList<ScheduleEntry> response = CacheClient.GetPatchSchedules(ResourceGroupName, Name);
             List<PSScheduleEntry> returnValue = new List<PSScheduleEntry>();
             foreach (var schedule in response)

src/ResourceManager/RedisCache/Commands.RedisCache/Commands/ImportAzureRedisCache.cs

@@ -45,6 +45,7 @@ public class ImportAzureRedisCache : RedisCacheCmdletBase
 
         public override void ExecuteCmdlet()
         {
+            Utility.ValidateResourceGroupAndResourceName(ResourceGroupName, Name);
             if (!Force.IsPresent)
             {
                 ConfirmAction(

src/ResourceManager/RedisCache/Commands.RedisCache/Commands/NewAzureRedisCache.cs

@@ -80,6 +80,7 @@ public class NewAzureRedisCache : RedisCacheCmdletBase
 
         public override void ExecuteCmdlet()
         {
+            Utility.ValidateResourceGroupAndResourceName(ResourceGroupName, Name);
             if (!string.IsNullOrEmpty(RedisVersion))
             {
                 WriteWarning("The RedisVersion parameter has been deprecated.  As such, it is no longer necessary to provide this parameter and any value specified is ignored.");

src/ResourceManager/RedisCache/Commands.RedisCache/Commands/NewAzureRedisCacheKey.cs

@@ -40,6 +40,7 @@ public class NewAzureRedisCacheKey : RedisCacheCmdletBase
 
         public override void ExecuteCmdlet()
         {
+            Utility.ValidateResourceGroupAndResourceName(ResourceGroupName, Name);
             RedisKeyType keyTypeToRegenerated = RedisKeyType.Primary;
             if (KeyType.Equals("Secondary"))
             {

src/ResourceManager/RedisCache/Commands.RedisCache/Commands/NewAzureRedisCachePatchSchedule.cs

@@ -39,6 +39,7 @@ public class NewAzureRedisCachePatchSchedule : RedisCacheCmdletBase
 
         public override void ExecuteCmdlet()
         {
+            Utility.ValidateResourceGroupAndResourceName(ResourceGroupName, Name);
             // Convert from PSScheduleEntry to ScheduleEntry
             List<ScheduleEntry> requestData = new List<ScheduleEntry>();
             foreach (var schedule in Entries)

src/ResourceManager/RedisCache/Commands.RedisCache/Commands/RemoveAzureRedisCache.cs

@@ -37,6 +37,7 @@ public class RemoveAzureRedisCache : RedisCacheCmdletBase
 
         public override void ExecuteCmdlet()
         {
+            Utility.ValidateResourceGroupAndResourceName(ResourceGroupName, Name);
             ConfirmAction(
                 Force.IsPresent,
                 string.Format(Resources.RemovingRedisCache, Name),

src/ResourceManager/RedisCache/Commands.RedisCache/Commands/RemoveAzureRedisCacheDiagnostics.cs

@@ -38,6 +38,7 @@ public class RemoveAzureRedisCacheDiagnostics : RedisCacheCmdletBase
 
         public override void ExecuteCmdlet()
         {
+            Utility.ValidateResourceGroupAndResourceName(ResourceGroupName, Name);
             RedisCacheAttributes cache = new RedisCacheAttributes(CacheClient.GetCache(ResourceGroupName, Name), ResourceGroupName);
             ConfirmAction(
               string.Format(Resources.RemoveRedisCacheDiagnostics, Name),

src/ResourceManager/RedisCache/Commands.RedisCache/Commands/RemoveAzureRedisCachePatchSchedule.cs

@@ -35,6 +35,7 @@ public class RemoveAzureRedisCachePatchSchedule : RedisCacheCmdletBase
 
         public override void ExecuteCmdlet()
         {
+            Utility.ValidateResourceGroupAndResourceName(ResourceGroupName, Name);
             CacheClient.RemovePatchSchedules(ResourceGroupName, Name);
         }
     }

src/ResourceManager/RedisCache/Commands.RedisCache/Commands/ResetAzureRedisCache.cs

@@ -47,6 +47,7 @@ public class ResetAzureRedisCache : RedisCacheCmdletBase
 
         public override void ExecuteCmdlet()
         {
+            Utility.ValidateResourceGroupAndResourceName(ResourceGroupName, Name);
             if (!Force.IsPresent)
             {
                 ConfirmAction(

src/ResourceManager/RedisCache/Commands.RedisCache/Commands/SetAzureRedisCache.cs

@@ -62,6 +62,7 @@ public class SetAzureRedisCache : RedisCacheCmdletBase
 
         public override void ExecuteCmdlet()
         {
+            Utility.ValidateResourceGroupAndResourceName(ResourceGroupName, Name);
             if (!string.IsNullOrEmpty(MaxMemoryPolicy))
             {
                 throw new ArgumentException(Resources.MaxMemoryPolicyException);

src/ResourceManager/RedisCache/Commands.RedisCache/Commands/SetAzureRedisCacheDiagnostics.cs

@@ -43,6 +43,7 @@ public override void ExecuteCmdlet()
 
         private string GetStorageAccountName(string storageAccountId)
         {
+            Utility.ValidateResourceGroupAndResourceName(ResourceGroupName, Name);
             if (string.IsNullOrEmpty(storageAccountId))
             {
                 throw new ArgumentException(Resources.StorageAccountIdException);

src/ResourceManager/RedisCache/Commands.RedisCache/Models/Utility.cs

@@ -0,0 +1,25 @@
+using Microsoft.Azure.Commands.RedisCache.Properties;
+using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace Microsoft.Azure.Commands.RedisCache
+{
+    public class Utility
+    {
+        public static void ValidateResourceGroupAndResourceName(string resourceGroupName, string name)
+        {
+            if (resourceGroupName != null && resourceGroupName.Contains("/"))
+            {
+                throw new ArgumentException(Resources.InvalidResourceGroupName);
+            }
+
+            if (name != null && (name.Contains("/") || name.Contains(".")))
+            {
+                throw new ArgumentException(Resources.InvalidRedisCacheName);
+            }
+        }
+    }
+}

src/ResourceManager/RedisCache/Commands.RedisCache/Properties/Resources.Designer.cs

@@ -156,4 +156,10 @@
   <data name="StorageAccountIdException" xml:space="preserve">
     <value>StorageAccountId is not valid ARM resource Id.</value>
   </data>
+  <data name="InvalidRedisCacheName" xml:space="preserve">
+    <value>Name should not contain '/' or '.'. Name should be the plain, short name of the redis cache, e.g. 'mycache'. (Not a fully qualified DNS name, and not an Azure resource identifier.)</value>
+  </data>
+  <data name="InvalidResourceGroupName" xml:space="preserve">
+    <value>ResourceGroupName should not contain '/'. Name should be the plain, short name of the resource group, e.g. 'myResourceGroup'. (Not an Azure resource identifier.)</value>
+  </data>
 </root>