Template Specs: Expose .UIFormDefinition and support UIFormDefinition export (Azure#16088)

stuartko · BethanyZhou · web-flow · commit 54c9ff4364bd · 2021-10-15T16:09:49.000+08:00
* Template Specs: Expose .UIFormDefinition with support for export

* Update src/Resources/Resources/ChangeLog.md

Co-authored-by: Beisi Zhou &lt;zazbs@qq.com&gt;
diff --git a/src/Resources/ResourceManager/Components/TemplateSpecPackagingEngine.cs b/src/Resources/ResourceManager/Components/TemplateSpecPackagingEngine.cs
@@ -34,10 +34,13 @@ public PackagedTemplate(TemplateSpecVersion versionModel)
             this.RootTemplate = (JObject)versionModel?.MainTemplate;
             this.Artifacts = versionModel?.LinkedTemplates?.ToArray() 
                 ?? new LinkedTemplateArtifact[0];
+            this.UIFormDefinition = (JObject)versionModel?.UiFormDefinition;
         }
 
         public JObject RootTemplate { get; set; }
 
+        public JObject UIFormDefinition { get; set; }
+
         public LinkedTemplateArtifact[] Artifacts { get; set; }
     }
 
@@ -75,19 +78,34 @@ public PackingContext(string rootTemplateDirectory)
         /// <param name="rootTemplateFilePath">
         /// The path to the ARM Template .json file to pack
         /// </param>
-        public static PackagedTemplate Pack(string rootTemplateFilePath)
+        /// <param name="uiFormDefinitionFilePath">
+        /// The path to the UI Form Definition .json to pack (if any)
+        /// </param>
+        public static PackagedTemplate Pack(string rootTemplateFilePath, 
+            string uiFormDefinitionFilePath)
         {
             rootTemplateFilePath = Path.GetFullPath(rootTemplateFilePath);
             PackingContext context = new PackingContext(
                 Path.GetDirectoryName(rootTemplateFilePath)
             );
-
+            
             PackArtifacts(rootTemplateFilePath, context, out JObject templateObj);
-            return new PackagedTemplate
+            var packagedTemplate = new PackagedTemplate
             {
                 RootTemplate = templateObj,
                 Artifacts = context.Artifacts.ToArray()
             };
+
+            // If a UI Form Definition file path was provided to us, make sure we package the
+            // UI Form Definition as well:
+
+            if (!string.IsNullOrWhiteSpace(uiFormDefinitionFilePath))
+            {
+                string uiFormDefinitionJson = FileUtilities.DataStore.ReadFileAsText(uiFormDefinitionFilePath);
+                packagedTemplate.UIFormDefinition = JObject.Parse(uiFormDefinitionJson);
+            }
+
+            return packagedTemplate;
         }
 
         /// <summary>
@@ -193,10 +211,15 @@ private static void PackArtifacts(
         /// <param name="templateFileName">
         /// The name of the file to use for the root template json
         /// </param>
+        /// <param name="uiFormDefinitionFileName">
+        /// The name of the file to use for the ui form definition json (if any). If set to
+        /// null, the ui definition won't be unpacked even if present within the packaged template.
+        /// </param>
         public static void Unpack(
             PackagedTemplate packagedTemplate,
             string targetDirectory,
-            string templateFileName)
+            string templateFileName,
+            string uiFormDefinitionFileName)
         {
             // Ensure paths are normalized:
             templateFileName = Path.GetFileName(templateFileName);
@@ -254,6 +277,23 @@ public static void Unpack(
                 FileUtilities.DataStore.WriteFile(absoluteLocalPath,
                     ((JObject)templateArtifact.Template).ToString());
             }
+
+            // Lastly, let's write the UIFormDefinition file if a UIFormDefinition is present within
+            // the packaged template:
+
+            if (!string.IsNullOrWhiteSpace(uiFormDefinitionFileName) && 
+                packagedTemplate.UIFormDefinition != null)
+            {
+                string absoluteUIFormDefinitionFilePath = Path.Combine(
+                    targetDirectory, 
+                    uiFormDefinitionFileName
+                );
+
+                FileUtilities.DataStore.WriteFile(
+                    absoluteUIFormDefinitionFilePath,
+                    packagedTemplate.UIFormDefinition.ToString()
+                );
+            }
         }
 
         /// <summary>
diff --git a/src/Resources/ResourceManager/Implementation/TemplateSpecs/ExportAzTemplateSpec.cs b/src/Resources/ResourceManager/Implementation/TemplateSpecs/ExportAzTemplateSpec.cs
@@ -123,13 +123,15 @@ public override void ExecuteCmdlet()
                 OutputFolder = ResolveUserPath(OutputFolder);
 
                 string mainTemplateFileName = $"{parentTemplateSpec.Name}.{specificVersion.Name}.json";
+                string uiFormDefinitionFileName = $"{parentTemplateSpec.Name}.{specificVersion.Name}.uiformdefinition.json";
                 string fullRootTemplateFilePath = Path.GetFullPath(
                     Path.Combine(OutputFolder, mainTemplateFileName)
                 );
 
                 if (ShouldProcess(specificVersion.Id, $"Export to '{fullRootTemplateFilePath}'"))
                 {
-                    TemplateSpecPackagingEngine.Unpack(packagedTemplate, OutputFolder, mainTemplateFileName);
+                    TemplateSpecPackagingEngine.Unpack(
+                        packagedTemplate, OutputFolder, mainTemplateFileName, uiFormDefinitionFileName);
                 }
 
                 WriteObject(PowerShellUtilities.ConstructPSObject(null, "Path", fullRootTemplateFilePath));
diff --git a/src/Resources/ResourceManager/Implementation/TemplateSpecs/NewAzTemplateSpec.cs b/src/Resources/ResourceManager/Implementation/TemplateSpecs/NewAzTemplateSpec.cs
@@ -169,7 +169,9 @@ public override void ExecuteCmdlet()
                             filePath = BicepUtility.BuildFile(this.ResolvePath(TemplateFile), this.WriteVerbose);
                         }
 
-                        packagedTemplate = TemplateSpecPackagingEngine.Pack(filePath);
+                        // Note: We set uiFormDefinitionFilePath to null below because we process the UIFormDefinition
+                        // specified by the cmdlet parameters later within this method...
+                        packagedTemplate = TemplateSpecPackagingEngine.Pack(filePath, uiFormDefinitionFilePath: null);
                         break;
                     case FromJsonStringParameterSet:
 
@@ -218,12 +220,7 @@ public override void ExecuteCmdlet()
                         throw new PSNotSupportedException();
                 }
 
-                JObject UIFormDefinition = new JObject();
-                if (UIFormDefinitionFile == null && UIFormDefinitionString == null)
-                {
-                    UIFormDefinition = null;
-                }
-                else if (!String.IsNullOrEmpty(UIFormDefinitionFile))
+                if (!string.IsNullOrWhiteSpace(UIFormDefinitionFile))
                 {
                     string UIFormFilePath = this.TryResolvePath(UIFormDefinitionFile);
                     if (!File.Exists(UIFormFilePath))
@@ -233,13 +230,14 @@ public override void ExecuteCmdlet()
                         );
                     }
                     string UIFormJson = FileUtilities.DataStore.ReadFileAsText(UIFormDefinitionFile);
-                    UIFormDefinition = JObject.Parse(UIFormJson);
+                    packagedTemplate.UIFormDefinition = JObject.Parse(UIFormJson);
                 }
-                else if (!String.IsNullOrEmpty(UIFormDefinitionString))
+                else if (!string.IsNullOrEmpty(UIFormDefinitionString))
                 {
-                    UIFormDefinition = JObject.Parse(UIFormDefinitionString);
+                    packagedTemplate.UIFormDefinition = JObject.Parse(UIFormDefinitionString);
                 }
 
+
                 Action createOrUpdateAction = () =>
                 {
                     var templateSpecVersion = TemplateSpecsSdkClient.CreateOrUpdateTemplateSpecVersion(
@@ -248,7 +246,6 @@ public override void ExecuteCmdlet()
                         Version,
                         Location,
                         packagedTemplate,
-                        UIFormDefinition,
                         templateSpecDescription: Description,
                         templateSpecDisplayName: DisplayName,
                         versionDescription: VersionDescription,
diff --git a/src/Resources/ResourceManager/Implementation/TemplateSpecs/SetAzTemplateSpec.cs b/src/Resources/ResourceManager/Implementation/TemplateSpecs/SetAzTemplateSpec.cs
@@ -206,7 +206,10 @@ public override void ExecuteCmdlet()
                             {
                                 filePath = BicepUtility.BuildFile(this.ResolvePath(TemplateFile), this.WriteVerbose);
                             }
-                            packagedTemplate = TemplateSpecPackagingEngine.Pack(filePath);
+
+                            // Note: We set uiFormDefinitionFilePath to null below because we process the UIFormDefinition
+                            // specified by the cmdlet parameters later within this method...
+                            packagedTemplate = TemplateSpecPackagingEngine.Pack(filePath, uiFormDefinitionFilePath: null);
                             break;
                         case UpdateVersionByIdFromJsonParameterSet:
                         case UpdateVersionByNameFromJsonParameterSet:
@@ -260,12 +263,7 @@ public override void ExecuteCmdlet()
                         return;
                     }
 
-                    JObject UIFormDefinition = new JObject();
-                    if (UIFormDefinitionFile == null && UIFormDefinitionString == null)
-                    {
-                        UIFormDefinition = null;
-                    }
-                    else if (!String.IsNullOrEmpty(UIFormDefinitionFile))
+                    if (!string.IsNullOrWhiteSpace(UIFormDefinitionFile))
                     {
                         string UIFormFilePath = this.TryResolvePath(UIFormDefinitionFile);
                         if (!File.Exists(UIFormFilePath))
@@ -275,11 +273,11 @@ public override void ExecuteCmdlet()
                             );
                         }
                         string UIFormJson = FileUtilities.DataStore.ReadFileAsText(UIFormDefinitionFile);
-                        UIFormDefinition = JObject.Parse(UIFormJson);
+                        packagedTemplate.UIFormDefinition = JObject.Parse(UIFormJson);
                     }
-                    else if (!String.IsNullOrEmpty(UIFormDefinitionString))
+                    else if (!string.IsNullOrWhiteSpace(UIFormDefinitionString))
                     {
-                        UIFormDefinition = JObject.Parse(UIFormDefinitionString);
+                        packagedTemplate.UIFormDefinition = JObject.Parse(UIFormDefinitionString);
                     }
 
                     var templateSpecVersion = TemplateSpecsSdkClient.CreateOrUpdateTemplateSpecVersion(
@@ -288,7 +286,6 @@ public override void ExecuteCmdlet()
                         Version,
                         Location,
                         packagedTemplate,
-                        UIFormDefinition,
                         templateSpecDescription: Description,
                         templateSpecDisplayName: DisplayName,
                         versionDescription: VersionDescription,
diff --git a/src/Resources/ResourceManager/SdkClient/TemplateSpecsSdkClient.cs b/src/Resources/ResourceManager/SdkClient/TemplateSpecsSdkClient.cs
@@ -182,7 +182,6 @@ public PSTemplateSpec CreateOrUpdateTemplateSpecVersion(
             string templateSpecVersion,
             string location,
             PackagedTemplate packagedTemplate,
-            object UIFormDefinition,
             string templateSpecDisplayName = null,
             string templateSpecDescription = null,
             string versionDescription = null,
@@ -212,7 +211,7 @@ public PSTemplateSpec CreateOrUpdateTemplateSpecVersion(
                 MainTemplate = packagedTemplate.RootTemplate,
                 LinkedTemplates = packagedTemplate.Artifacts?.ToList(),
                 Description = versionDescription ?? existingTemplateSpecVersion?.Description,
-                UiFormDefinition = UIFormDefinition
+                UiFormDefinition = packagedTemplate.UIFormDefinition
         };
 
             // Handle our conditional tagging:
diff --git a/src/Resources/ResourceManager/SdkModels/TemplateSpecs/PSTemplateSpecVersion.cs b/src/Resources/ResourceManager/SdkModels/TemplateSpecs/PSTemplateSpecVersion.cs
@@ -67,6 +67,11 @@ public class PSTemplateSpecVersion
         /// </summary>
         public DateTime? LastModifiedTime { get; private set; }
 
+        /// <summary>
+        /// Gets or sets the UI Form definition (if any) for the template spec version
+        /// </summary>
+        public string UIFormDefinition { get; set; }
+
         /// <summary>
         /// Converts a template spec model from the Azure SDK to the powershell
         /// exposed template spec model.
@@ -92,7 +97,8 @@ internal static PSTemplateSpecVersion FromAzureSDKTemplateSpecVersion(
                     ? new Dictionary<string, string>()
                     : new Dictionary<string, string>(templateSpecVersion.Tags),
                 // Note: Cast is redundant, but present for clarity reasons:
-                MainTemplate = ((JToken)templateSpecVersion.MainTemplate).ToString()
+                MainTemplate = ((JToken)templateSpecVersion.MainTemplate).ToString(),
+                UIFormDefinition = ((JToken)templateSpecVersion.UiFormDefinition)?.ToString()
             };
 
             if (templateSpecVersion.LinkedTemplates?.Any() == true) {
diff --git a/src/Resources/Resources/ChangeLog.md b/src/Resources/Resources/ChangeLog.md
@@ -19,6 +19,7 @@
 -->
 
 ## Upcoming Release
+* Added property `UIFormDefinition` to Template Spec Versions,  `Export-AzTemplateSpec` will now include a Template Spec Version's UIFormDefinition (if any) as part of the export.
 
 ## Version 4.4.0
 * Added a clearer error message for a case in which TemplateUri do not accept bicep file.

Original file line number	Diff line number	Diff line change
`@@ -123,13 +123,15 @@ public override void ExecuteCmdlet()`
`123`	`123`	`OutputFolder = ResolveUserPath(OutputFolder);`
`124`	`124`
`125`	`125`	`string mainTemplateFileName = $"{parentTemplateSpec.Name}.{specificVersion.Name}.json";`
	`126`	`+ string uiFormDefinitionFileName = $"{parentTemplateSpec.Name}.{specificVersion.Name}.uiformdefinition.json";`
`126`	`127`	`string fullRootTemplateFilePath = Path.GetFullPath(`
`127`	`128`	`Path.Combine(OutputFolder, mainTemplateFileName)`
`128`	`129`	`);`
`129`	`130`
`130`	`131`	`if (ShouldProcess(specificVersion.Id, $"Export to '{fullRootTemplateFilePath}'"))`
`131`	`132`	`{`
`132`		`- TemplateSpecPackagingEngine.Unpack(packagedTemplate, OutputFolder, mainTemplateFileName);`
	`133`	`+ TemplateSpecPackagingEngine.Unpack(`
	`134`	`+ packagedTemplate, OutputFolder, mainTemplateFileName, uiFormDefinitionFileName);`
`133`	`135`	`}`
`134`	`136`
`135`	`137`	`WriteObject(PowerShellUtilities.ConstructPSObject(null, "Path", fullRootTemplateFilePath));`
Original file line number	Diff line number	Diff line change
`@@ -169,7 +169,9 @@ public override void ExecuteCmdlet()`
`169`	`169`	`filePath = BicepUtility.BuildFile(this.ResolvePath(TemplateFile), this.WriteVerbose);`
`170`	`170`	`}`
`171`	`171`
`172`		`- packagedTemplate = TemplateSpecPackagingEngine.Pack(filePath);`
	`172`	`+ // Note: We set uiFormDefinitionFilePath to null below because we process the UIFormDefinition`
	`173`	`+ // specified by the cmdlet parameters later within this method...`
	`174`	`+ packagedTemplate = TemplateSpecPackagingEngine.Pack(filePath, uiFormDefinitionFilePath: null);`
`173`	`175`	`break;`
`174`	`176`	`case FromJsonStringParameterSet:`
`175`	`177`
`@@ -218,12 +220,7 @@ public override void ExecuteCmdlet()`
`218`	`220`	`throw new PSNotSupportedException();`
`219`	`221`	`}`
`220`	`222`
`221`		`- JObject UIFormDefinition = new JObject();`
`222`		`- if (UIFormDefinitionFile == null && UIFormDefinitionString == null)`
`223`		`- {`
`224`		`- UIFormDefinition = null;`
`225`		`- }`
`226`		`- else if (!String.IsNullOrEmpty(UIFormDefinitionFile))`
	`223`	`+ if (!string.IsNullOrWhiteSpace(UIFormDefinitionFile))`
`227`	`224`	`{`
`228`	`225`	`string UIFormFilePath = this.TryResolvePath(UIFormDefinitionFile);`
`229`	`226`	`if (!File.Exists(UIFormFilePath))`
`@@ -233,13 +230,14 @@ public override void ExecuteCmdlet()`
`233`	`230`	`);`
`234`	`231`	`}`
`235`	`232`	`string UIFormJson = FileUtilities.DataStore.ReadFileAsText(UIFormDefinitionFile);`
`236`		`- UIFormDefinition = JObject.Parse(UIFormJson);`
	`233`	`+ packagedTemplate.UIFormDefinition = JObject.Parse(UIFormJson);`
`237`	`234`	`}`
`238`		`- else if (!String.IsNullOrEmpty(UIFormDefinitionString))`
	`235`	`+ else if (!string.IsNullOrEmpty(UIFormDefinitionString))`
`239`	`236`	`{`
`240`		`- UIFormDefinition = JObject.Parse(UIFormDefinitionString);`
	`237`	`+ packagedTemplate.UIFormDefinition = JObject.Parse(UIFormDefinitionString);`
`241`	`238`	`}`
`242`	`239`
	`240`	`+`
`243`	`241`	`Action createOrUpdateAction = () =>`
`244`	`242`	`{`
`245`	`243`	`var templateSpecVersion = TemplateSpecsSdkClient.CreateOrUpdateTemplateSpecVersion(`
`@@ -248,7 +246,6 @@ public override void ExecuteCmdlet()`
`248`	`246`	`Version,`
`249`	`247`	`Location,`
`250`	`248`	`packagedTemplate,`
`251`		`- UIFormDefinition,`
`252`	`249`	`templateSpecDescription: Description,`
`253`	`250`	`templateSpecDisplayName: DisplayName,`
`254`	`251`	`versionDescription: VersionDescription,`
Original file line number	Diff line number	Diff line change
`@@ -206,7 +206,10 @@ public override void ExecuteCmdlet()`
`206`	`206`	`{`
`207`	`207`	`filePath = BicepUtility.BuildFile(this.ResolvePath(TemplateFile), this.WriteVerbose);`
`208`	`208`	`}`
`209`		`- packagedTemplate = TemplateSpecPackagingEngine.Pack(filePath);`
	`209`	`+`
	`210`	`+ // Note: We set uiFormDefinitionFilePath to null below because we process the UIFormDefinition`
	`211`	`+ // specified by the cmdlet parameters later within this method...`
	`212`	`+ packagedTemplate = TemplateSpecPackagingEngine.Pack(filePath, uiFormDefinitionFilePath: null);`
`210`	`213`	`break;`
`211`	`214`	`case UpdateVersionByIdFromJsonParameterSet:`
`212`	`215`	`case UpdateVersionByNameFromJsonParameterSet:`
`@@ -260,12 +263,7 @@ public override void ExecuteCmdlet()`
`260`	`263`	`return;`
`261`	`264`	`}`
`262`	`265`
`263`		`- JObject UIFormDefinition = new JObject();`
`264`		`- if (UIFormDefinitionFile == null && UIFormDefinitionString == null)`
`265`		`- {`
`266`		`- UIFormDefinition = null;`
`267`		`- }`
`268`		`- else if (!String.IsNullOrEmpty(UIFormDefinitionFile))`
	`266`	`+ if (!string.IsNullOrWhiteSpace(UIFormDefinitionFile))`
`269`	`267`	`{`
`270`	`268`	`string UIFormFilePath = this.TryResolvePath(UIFormDefinitionFile);`
`271`	`269`	`if (!File.Exists(UIFormFilePath))`
`@@ -275,11 +273,11 @@ public override void ExecuteCmdlet()`
`275`	`273`	`);`
`276`	`274`	`}`
`277`	`275`	`string UIFormJson = FileUtilities.DataStore.ReadFileAsText(UIFormDefinitionFile);`
`278`		`- UIFormDefinition = JObject.Parse(UIFormJson);`
	`276`	`+ packagedTemplate.UIFormDefinition = JObject.Parse(UIFormJson);`
`279`	`277`	`}`
`280`		`- else if (!String.IsNullOrEmpty(UIFormDefinitionString))`
	`278`	`+ else if (!string.IsNullOrWhiteSpace(UIFormDefinitionString))`
`281`	`279`	`{`
`282`		`- UIFormDefinition = JObject.Parse(UIFormDefinitionString);`
	`280`	`+ packagedTemplate.UIFormDefinition = JObject.Parse(UIFormDefinitionString);`
`283`	`281`	`}`
`284`	`282`
`285`	`283`	`var templateSpecVersion = TemplateSpecsSdkClient.CreateOrUpdateTemplateSpecVersion(`
`@@ -288,7 +286,6 @@ public override void ExecuteCmdlet()`
`288`	`286`	`Version,`
`289`	`287`	`Location,`
`290`	`288`	`packagedTemplate,`
`291`		`- UIFormDefinition,`
`292`	`289`	`templateSpecDescription: Description,`
`293`	`290`	`templateSpecDisplayName: DisplayName,`
`294`	`291`	`versionDescription: VersionDescription,`