Merge pull request Azure#10565 from shenglol/shenglol/fix-deployment-dynamic-param-conflict-issue

[Az.Resources] Fix template parameter name conflict issue for deployment cmdlets

Author: isra-fel

src/Resources/ResourceManager/Utilities/TemplateUtility.cs

@@ -144,51 +144,41 @@ private static RuntimeDefinedParameterDictionary ParseTemplateAndExtractParamete
             }
             if (templateParameterObject != null)
             {
-                UpdateParametersWithObject(dynamicParameters, templateParameterObject);
+                UpdateParametersWithObject(staticParameters, dynamicParameters, templateParameterObject);
             }
             if (templateParameterFilePath != null && FileUtilities.DataStore.FileExists(templateParameterFilePath))
             {
                 var parametersFromFile = ParseTemplateParameterFileContents(templateParameterFilePath);
-                UpdateParametersWithObject(dynamicParameters, new Hashtable(parametersFromFile));
+                UpdateParametersWithObject(staticParameters, dynamicParameters, new Hashtable(parametersFromFile));
             }
             if (templateParameterFilePath != null && Uri.IsWellFormedUriString(templateParameterFilePath, UriKind.Absolute))
             {
                 var parametersFromUri = ParseTemplateParameterContent(GeneralUtilities.DownloadFile(templateParameterFilePath));
-                UpdateParametersWithObject(dynamicParameters, new Hashtable(parametersFromUri));
+                UpdateParametersWithObject(staticParameters, dynamicParameters, new Hashtable(parametersFromUri));
             }
             return dynamicParameters;
         }
 
-        private static void UpdateParametersWithObject(RuntimeDefinedParameterDictionary dynamicParameters, Hashtable templateParameterObject)
+        private static void UpdateParametersWithObject(string[] staticParameters, RuntimeDefinedParameterDictionary dynamicParameters, Hashtable templateParameterObject)
         {
+            const string duplicatedParameterSuffix = "FromTemplate";
+
             if (templateParameterObject != null)
             {
-                foreach (KeyValuePair<string, RuntimeDefinedParameter> dynamicParameter in dynamicParameters)
+                foreach (string paramName in templateParameterObject.Keys)
                 {
-                    try
-                    {
-                        foreach (string key in templateParameterObject.Keys)
-                        {
-                            if (key.Equals(dynamicParameter.Key, StringComparison.InvariantCultureIgnoreCase))
-                            {
-                                if (templateParameterObject[key] is TemplateFileParameterV1)
-                                {
-                                    dynamicParameter.Value.Value = (templateParameterObject[key] as TemplateFileParameterV1).Value;
-                                }
-                                else
-                                {
-                                    dynamicParameter.Value.Value = templateParameterObject[key];
-                                }
-                                dynamicParameter.Value.IsSet = true;
-                                ((ParameterAttribute)dynamicParameter.Value.Attributes[0]).Mandatory = false;
-                            }
-                        }
-                    }
-                    catch
+                    string dynamicParamName = staticParameters.Contains(paramName, StringComparer.OrdinalIgnoreCase)
+                        ? paramName + duplicatedParameterSuffix
+                        : paramName;
+
+                    if (dynamicParameters.TryGetValue(dynamicParamName, out RuntimeDefinedParameter dynamicParameter))
                     {
-                        throw new ArgumentException(string.Format(ProjectResources.FailureParsingTemplateParameterObject,
-                                                                  dynamicParameter.Key,
-                                                                  templateParameterObject[dynamicParameter.Key]));
+                        dynamicParameter.Value = templateParameterObject[paramName] is TemplateFileParameterV1 templateFileParameterV1
+                            ? templateFileParameterV1.Value
+                            : templateParameterObject[paramName];
+
+                        dynamicParameter.IsSet = true;
+                        ((ParameterAttribute)dynamicParameter.Attributes[0]).Mandatory = false;
                     }
                 }
             }
@@ -249,8 +239,7 @@ internal static RuntimeDefinedParameter ConstructDynamicParameter(string[] stati
             RuntimeDefinedParameter runtimeParameter = new RuntimeDefinedParameter()
             {
                 // For duplicated template parameter names, add a suffix FromTemplate to distinguish them from the cmdlet parameter.
-                Name = staticParameters.Any(n => n.StartsWith(name, StringComparison.OrdinalIgnoreCase))
-                    ? name + duplicatedParameterSuffix : name,
+                Name = staticParameters.Contains(name, StringComparer.OrdinalIgnoreCase) ? name + duplicatedParameterSuffix : name,
                 ParameterType = GetParameterType(parameter.Value.Type),
                 Value = defaultValue
             };

src/Resources/Resources.Test/Models.ResourceGroups/GalleryTemplatesClientTests.cs

@@ -123,39 +123,6 @@ public void ResolvesDuplicatedDynamicParameterName()
             Assert.Equal(int.Parse(value.MaxLength), validateLengthAttribute.MaxLength);
         }
 
-        [Fact]
-        [Trait(Category.AcceptanceType, Category.CheckIn)]
-        public void ResolvesDuplicatedDynamicParameterNameSubstring()
-        {
-            string[] parameters = { "Username", "Location", "Mode" };
-            string[] parameterSetNames = { "__AllParameterSets" };
-            string key = "user";
-            TemplateFileParameterV1 value = new TemplateFileParameterV1()
-            {
-                AllowedValues = new List<object>() { "Mode1", "Mode2", "Mode3" },
-                MaxLength = "5",
-                MinLength = "1",
-                Type = "bool"
-            };
-            KeyValuePair<string, TemplateFileParameterV1> parameter = new KeyValuePair<string, TemplateFileParameterV1>(key, value);
-
-            RuntimeDefinedParameter dynamicParameter = TemplateUtility.ConstructDynamicParameter(parameters, parameter);
-
-            Assert.Equal(key + "FromTemplate", dynamicParameter.Name);
-            Assert.Equal(value.DefaultValue, dynamicParameter.Value);
-            Assert.Equal(typeof(bool), dynamicParameter.ParameterType);
-            Assert.Equal(2, dynamicParameter.Attributes.Count);
-
-            ParameterAttribute parameterAttribute = (ParameterAttribute)dynamicParameter.Attributes[0];
-            Assert.True(parameterAttribute.Mandatory);
-            Assert.True(parameterAttribute.ValueFromPipelineByPropertyName);
-            Assert.Equal(parameterSetNames[0], parameterAttribute.ParameterSetName);
-
-            ValidateLengthAttribute validateLengthAttribute = (ValidateLengthAttribute)dynamicParameter.Attributes[1];
-            Assert.Equal(int.Parse(value.MinLength), validateLengthAttribute.MinLength);
-            Assert.Equal(int.Parse(value.MaxLength), validateLengthAttribute.MaxLength);
-        }
-
         [Fact]
         [Trait(Category.AcceptanceType, Category.CheckIn)]
         public void ResolvesDuplicatedDynamicParameterNameCaseInsensitive()

src/Resources/Resources/ChangeLog.md

@@ -18,6 +18,7 @@
         - Additional information about change #1
 -->
 ## Upcoming Release
+* Fix an issue where template deployment fails to read a template parameter if its name conflicts with some built-in parameter name.
 
 ## Version 1.8.0
 - Updated policy cmdlets to use new api version 2019-06-01 that has new EnforcementMode property in policy assignment.