add comments, refactor

lucashuet93 · lucashuet93 · commit 3bd7556095a7 · 2019-01-17T12:01:19.000-05:00
diff --git a/src/APIM_ARMTemplate/apimtemplate.test/Creator/FileHandlerTests/FileWriterTests.cs b/src/APIM_ARMTemplate/apimtemplate.test/Creator/FileHandlerTests/FileWriterTests.cs
@@ -5,13 +5,13 @@
 
 namespace Microsoft.Azure.Management.ApiManagement.ArmTemplates
 {
-    public class ARMTemplateWriterTests
+    public class FileWriterTests
     {
         [Fact]
         public void ShouldWriteJSONToFile()
         {
             // arrange
-            ARMTemplateWriter armTemplateWriter = new ARMTemplateWriter();
+            FileWriter fileWriter = new FileWriter();
             string location = String.Concat("..", Path.DirectorySeparatorChar,
                    "..", Path.DirectorySeparatorChar,
                    "..", Path.DirectorySeparatorChar,
@@ -26,7 +26,7 @@ public void ShouldWriteJSONToFile()
                 File.Delete(location);
             }
             // write new 
-            armTemplateWriter.WriteJSONToFile(testJSON, location);
+            fileWriter.WriteJSONToFile(testJSON, location);
 
             // assert
             Assert.True(File.Exists(location));
diff --git a/src/APIM_ARMTemplate/apimtemplate/Commands/Create.cs b/src/APIM_ARMTemplate/apimtemplate/Commands/Create.cs
@@ -53,17 +53,16 @@ public CreateCommand()
                     // required parameters have been supplied
 
                     // initialize helper classes
-                    FileNameGenerator fileNameGenerator = new FileNameGenerator();
+                    FileWriter fileWriter = new FileWriter();
                     TemplateCreator templateCreator = new TemplateCreator();
                     APIVersionSetTemplateCreator apiVersionSetTemplateCreator = new APIVersionSetTemplateCreator(templateCreator);
                     ProductAPITemplateCreator productAPITemplateCreator = new ProductAPITemplateCreator();
                     PolicyTemplateCreator policyTemplateCreator = new PolicyTemplateCreator(fileReader);
                     APITemplateCreator apiTemplateCreator = new APITemplateCreator(fileReader, templateCreator, policyTemplateCreator, productAPITemplateCreator);
-                    MasterTemplateCreator masterTemplateCreator = new MasterTemplateCreator(templateCreator, fileNameGenerator);
-                    ARMTemplateWriter armTemplateWriter = new ARMTemplateWriter();
+                    MasterTemplateCreator masterTemplateCreator = new MasterTemplateCreator(templateCreator);
 
                     // create templates from provided configuration
-                    CreatorFileNames creatorFileNames = fileNameGenerator.GenerateCreatorFileNames();
+                    CreatorFileNames creatorFileNames = fileWriter.GenerateCreatorFileNames();
                     Template apiVersionSetTemplate = creatorConfig.apiVersionSet != null ? apiVersionSetTemplateCreator.CreateAPIVersionSetTemplate(creatorConfig) : null;
                     Template apiTemplate = await apiTemplateCreator.CreateAPITemplateAsync(creatorConfig);
                     if(creatorConfig.linked == true)
@@ -74,17 +73,17 @@ public CreateCommand()
                         // write templates to outputLocation
                         if (apiVersionSetTemplate != null)
                         {
-                            armTemplateWriter.WriteJSONToFile(apiVersionSetTemplate, String.Concat(creatorConfig.outputLocation, @"/linked/", creatorFileNames.apiVersionSet));
+                            fileWriter.WriteJSONToFile(apiVersionSetTemplate, String.Concat(creatorConfig.outputLocation, @"/linked/", creatorFileNames.apiVersionSet));
                         }
-                        armTemplateWriter.WriteJSONToFile(apiTemplate, String.Concat(creatorConfig.outputLocation, @"/linked/", creatorFileNames.api));
-                        armTemplateWriter.WriteJSONToFile(masterTemplate, String.Concat(creatorConfig.outputLocation, @"/linked/", "master.template.json"));
-                        armTemplateWriter.WriteJSONToFile(masterTemplateParameters, String.Concat(creatorConfig.outputLocation, @"/linked/", "master.parameters.json"));
+                        fileWriter.WriteJSONToFile(apiTemplate, String.Concat(creatorConfig.outputLocation, @"/linked/", creatorFileNames.api));
+                        fileWriter.WriteJSONToFile(masterTemplate, String.Concat(creatorConfig.outputLocation, @"/linked/", "master.template.json"));
+                        fileWriter.WriteJSONToFile(masterTemplateParameters, String.Concat(creatorConfig.outputLocation, @"/linked/", "master.parameters.json"));
                     } else
                     {
                         Template masterTemplate = masterTemplateCreator.CreateUnlinkedMasterTemplate(apiVersionSetTemplate, apiTemplate, creatorFileNames);
                         Template masterTemplateParameters = masterTemplateCreator.CreateMasterTemplateParameterValues(creatorConfig);
-                        armTemplateWriter.WriteJSONToFile(masterTemplate, String.Concat(creatorConfig.outputLocation, @"/unlinked/", "master.template.json"));
-                        armTemplateWriter.WriteJSONToFile(masterTemplateParameters, String.Concat(creatorConfig.outputLocation, @"/unlinked/", "master.parameters.json"));
+                        fileWriter.WriteJSONToFile(masterTemplate, String.Concat(creatorConfig.outputLocation, @"/unlinked/", "master.template.json"));
+                        fileWriter.WriteJSONToFile(masterTemplateParameters, String.Concat(creatorConfig.outputLocation, @"/unlinked/", "master.parameters.json"));
                     }
 
                     ColoredConsole.WriteLine("Templates written to output location");
diff --git a/src/APIM_ARMTemplate/apimtemplate/Creator/ExampleFiles/YAMLConfigs/valid.yml b/src/APIM_ARMTemplate/apimtemplate/Creator/ExampleFiles/YAMLConfigs/valid.yml
@@ -22,4 +22,4 @@ api:
       policy: C:\Users\lucashh\Desktop\Projects\APIM-ARM\azure-api-management-devops-example\src\APIM_ARMTemplate\apimtemplate\Creator\ExampleFiles\XMLPolicies\operationRateLimit.xml
   products: starter, platinum
 outputLocation: C:\Users\lucashh\Desktop\Projects\APIM-ARM\GeneratedTemplates
-linked: false
+linked: true
diff --git a/src/APIM_ARMTemplate/apimtemplate/Creator/FileHandlers/FileNameGenerator.cs b/src/APIM_ARMTemplate/apimtemplate/Creator/FileHandlers/FileNameGenerator.cs
diff --git a/src/APIM_ARMTemplate/apimtemplate/Creator/FileHandlers/FileReader.cs b/src/APIM_ARMTemplate/apimtemplate/Creator/FileHandlers/FileReader.cs
@@ -15,10 +15,12 @@ public class FileReader
     {
         public async Task<CreatorConfig> ConvertConfigYAMLToCreatorConfigAsync(string configFileLocation)
         {
+            // determine whether file location is local file path or remote url and convert appropriately
             Uri uriResult;
             bool isUrl = Uri.TryCreate(configFileLocation, UriKind.Absolute, out uriResult) && (uriResult.Scheme == Uri.UriSchemeHttp || uriResult.Scheme == Uri.UriSchemeHttps);
             if (isUrl)
             {
+                // make a request to the provided url and convert the response's content
                 HttpClient client = new HttpClient();
                 HttpResponseMessage response = await client.GetAsync(uriResult);
                 if (response.IsSuccessStatusCode)
@@ -43,19 +45,22 @@ public async Task<CreatorConfig> ConvertConfigYAMLToCreatorConfigAsync(string co
             {
                 using (StreamReader reader = new StreamReader(configFileLocation))
                 {
+                    // deserialize provided file contents into yaml
                     Deserializer deserializer = new Deserializer();
                     object deserializedYaml = deserializer.Deserialize(reader);
                     JsonSerializer jsonSerializer = new JsonSerializer();
                     StringWriter writer = new StringWriter();
+                    // serialize json from yaml object
                     jsonSerializer.Serialize(writer, deserializedYaml);
                     string jsonText = writer.ToString();
+                    // deserialize CreatorConfig from json string
                     CreatorConfig yamlObject = JsonConvert.DeserializeObject<CreatorConfig>(jsonText);
                     return yamlObject;
                 }
             }
         }
 
-        public async Task<string> RetrieveLocationContentsAsync(string fileLocation)
+        public async Task<string> RetrieveJSONContentsAsync(string fileLocation)
         {
             Uri uriResult;
             bool isUrl = Uri.TryCreate(fileLocation, UriKind.Absolute, out uriResult) && (uriResult.Scheme == Uri.UriSchemeHttp || uriResult.Scheme == Uri.UriSchemeHttps);
diff --git a/src/APIM_ARMTemplate/apimtemplate/Creator/FileHandlers/FileWriter.cs b/src/APIM_ARMTemplate/apimtemplate/Creator/FileHandlers/FileWriter.cs
@@ -6,10 +6,11 @@
 
 namespace Microsoft.Azure.Management.ApiManagement.ArmTemplates
 {
-    public class ARMTemplateWriter
+    public class FileWriter
     {
         public void WriteJSONToFile(object template, string location)
         {
+            // writes json object to provided location
             string jsonString = JsonConvert.SerializeObject(template,
                             Formatting.None,
                             new JsonSerializerSettings
@@ -18,5 +19,16 @@ public void WriteJSONToFile(object template, string location)
                             });
             File.WriteAllText(location, jsonString);
         }
+
+        public CreatorFileNames GenerateCreatorFileNames()
+        {
+            // generate useable object with file names for consistency throughout project
+            return new CreatorFileNames()
+            {
+                apiVersionSet = $@"/versionset.template.json",
+                api = $@"/api.template.json",
+                master = @"/master.template.json"
+            };
+        }
     }
 }
diff --git a/src/APIM_ARMTemplate/apimtemplate/Creator/FileHandlers/OpenAPISpecReader.cs b/src/APIM_ARMTemplate/apimtemplate/Creator/FileHandlers/OpenAPISpecReader.cs
@@ -15,6 +15,7 @@ public class OpenAPISpecReader
     {
         public OpenApiDocument ConvertToOpenAPISpec(string json)
         {
+            // converts json string into OpenApiDocument class
             OpenApiStringReader reader = new OpenApiStringReader();
             OpenApiDocument doc = reader.Read(json, out var diagnostic);
             return doc;
@@ -46,6 +47,7 @@ public async Task<OpenApiDocument> ConvertRemoteURLToOpenAPISpecAsync(Uri uriRes
 
         public async Task<OpenApiDocument> ConvertOpenAPISpecToDoc(string openApiSpecFileLocation)
         {
+            // determine whether file location is local file path or remote url and convert appropriately
             Uri uriResult;
             bool isUrl = Uri.TryCreate(openApiSpecFileLocation, UriKind.Absolute, out uriResult) && (uriResult.Scheme == Uri.UriSchemeHttp || uriResult.Scheme == Uri.UriSchemeHttps);
             if (isUrl)
diff --git a/src/APIM_ARMTemplate/apimtemplate/Creator/TemplateCreators/APITemplateCreator.cs b/src/APIM_ARMTemplate/apimtemplate/Creator/TemplateCreators/APITemplateCreator.cs
@@ -25,9 +25,8 @@ public APITemplateCreator(FileReader fileReader, TemplateCreator templateCreator
 
         public async Task<Template> CreateAPITemplateAsync(CreatorConfig creatorConfig)
         {
+            // create empty template
             Template apiTemplate = this.templateCreator.CreateEmptyTemplate();
-            OpenAPISpecReader openAPISpecReader = new OpenAPISpecReader();
-            OpenApiDocument doc = await openAPISpecReader.ConvertOpenAPISpecToDoc(creatorConfig.api.openApiSpec);
 
             // add parameters
             apiTemplate.parameters = new Dictionary<string, TemplateParameterProperties>
@@ -40,7 +39,7 @@ public async Task<Template> CreateAPITemplateAsync(CreatorConfig creatorConfig)
 
             List<TemplateResource> resources = new List<TemplateResource>();
             // create api resource with properties
-            APITemplateResource initialAPITemplateResource = this.CreateInitialAPITemplateResource(creatorConfig, doc);
+            APITemplateResource initialAPITemplateResource = await this.CreateInitialAPITemplateResource(creatorConfig);
             APITemplateResource subsequentAPITemplateResource = await this.CreateSubsequentAPITemplateResourceAsync(creatorConfig);
             PolicyTemplateResource apiPolicyResource = await this.policyTemplateCreator.CreateAPIPolicyTemplateResourceAsync(creatorConfig, dependsOnSubsequentAPI);
             List<PolicyTemplateResource> operationPolicyResources = await this.policyTemplateCreator.CreateOperationPolicyTemplateResourcesAsync(creatorConfig, dependsOnSubsequentAPI);
@@ -55,8 +54,12 @@ public async Task<Template> CreateAPITemplateAsync(CreatorConfig creatorConfig)
             return apiTemplate;
         }
 
-        public APITemplateResource CreateInitialAPITemplateResource(CreatorConfig creatorConfig, OpenApiDocument doc)
+        public async Task<APITemplateResource> CreateInitialAPITemplateResource(CreatorConfig creatorConfig)
         {
+            // protocols can be pulled by converting the OpenApiSpec into the OpenApiDocument class
+            OpenAPISpecReader openAPISpecReader = new OpenAPISpecReader();
+            OpenApiDocument doc = await openAPISpecReader.ConvertOpenAPISpecToDoc(creatorConfig.api.openApiSpec);
+
             // create api resource with properties
             APITemplateResource apiTemplateResource = new APITemplateResource()
             {
@@ -88,10 +91,9 @@ public APITemplateResource CreateInitialAPITemplateResource(CreatorConfig creato
         public async Task<APITemplateResource> CreateSubsequentAPITemplateResourceAsync(CreatorConfig creatorConfig)
         {
             // create api resource with properties
-            // used to escape characters in json file
-            object deserializedFileContents = JsonConvert.DeserializeObject<object>(await this.fileReader.RetrieveLocationContentsAsync(creatorConfig.api.openApiSpec));
             string subsequentAPIName = $"[concat(parameters('ApimServiceName'), '/{creatorConfig.api.name}')]";
             string subsequentAPIType = "Microsoft.ApiManagement/service/apis";
+            object deserializedFileContents = JsonConvert.DeserializeObject<object>(await this.fileReader.RetrieveJSONContentsAsync(creatorConfig.api.openApiSpec));
             APITemplateResource apiTemplateResource = new APITemplateResource()
             {
                 name = subsequentAPIName,
diff --git a/src/APIM_ARMTemplate/apimtemplate/Creator/TemplateCreators/APIVersionSetTemplateCreator.cs b/src/APIM_ARMTemplate/apimtemplate/Creator/TemplateCreators/APIVersionSetTemplateCreator.cs
@@ -18,6 +18,7 @@ public APIVersionSetTemplateCreator(TemplateCreator templateCreator)
 
         public Template CreateAPIVersionSetTemplate(CreatorConfig creatorConfig)
         {
+            // create empty template
             Template apiVersionSetTemplate = this.templateCreator.CreateEmptyTemplate();
 
             // add parameters
diff --git a/src/APIM_ARMTemplate/apimtemplate/Creator/TemplateCreators/MasterTemplateCreator.cs b/src/APIM_ARMTemplate/apimtemplate/Creator/TemplateCreators/MasterTemplateCreator.cs
@@ -10,18 +10,17 @@ namespace Microsoft.Azure.Management.ApiManagement.ArmTemplates
     public class MasterTemplateCreator
     {
         private TemplateCreator templateCreator;
-        private FileNameGenerator fileNameGenerator;
 
-        public MasterTemplateCreator(TemplateCreator templateCreator, FileNameGenerator fileNameGenerator)
+        public MasterTemplateCreator(TemplateCreator templateCreator)
         {
             this.templateCreator = templateCreator;
-            this.fileNameGenerator = fileNameGenerator;
         }
 
         public Template CreateLinkedMasterTemplate(Template apiVersionSetTemplate,
             Template apiTemplate,
             CreatorFileNames creatorFileNames)
         {
+            // create empty template
             Template masterTemplate = this.templateCreator.CreateEmptyTemplate();
 
             // add parameters
@@ -50,12 +49,13 @@ public Template CreateUnlinkedMasterTemplate(Template apiVersionSetTemplate,
             Template apiTemplate,
             CreatorFileNames creatorFileNames)
         {
+            // create empty template
             Template masterTemplate = this.templateCreator.CreateEmptyTemplate();
 
             // add parameters
             masterTemplate.parameters = this.CreateMasterTemplateParameters(false);
 
-            // add links to all resources
+            // add all resources directly
             List<TemplateResource> resources = new List<TemplateResource>();
 
             // apiVersionSet
@@ -98,6 +98,7 @@ public MasterTemplateResource CreateMasterTemplateResource(string name, string u
 
         public Dictionary<string, TemplateParameterProperties> CreateMasterTemplateParameters(bool linked)
         {
+            // used to create the parameter metatadata, etc (not value) for use in file with resources
             Dictionary<string, TemplateParameterProperties> parameters = new Dictionary<string, TemplateParameterProperties>();
             TemplateParameterProperties apimServiceNameProperties = new TemplateParameterProperties()
             {
@@ -125,6 +126,8 @@ public Dictionary<string, TemplateParameterProperties> CreateMasterTemplateParam
 
         public Template CreateMasterTemplateParameterValues(CreatorConfig creatorConfig)
         {
+            // used to create the parameter values for use in parameters file
+            // create empty template
             Template masterTemplate = this.templateCreator.CreateEmptyTemplate();
 
             // add parameters
@@ -138,11 +141,7 @@ public Template CreateMasterTemplateParameterValues(CreatorConfig creatorConfig)
             {
                 TemplateParameterProperties repoBaseUrlProperties = new TemplateParameterProperties()
                 {
-                    metadata = new TemplateParameterMetadata()
-                    {
-                        description = "Base URL of the repository"
-                    },
-                    type = "string"
+                    value = ""
                 };
                 parameters.Add("repoBaseUrl", repoBaseUrlProperties);
             }
diff --git a/src/APIM_ARMTemplate/apimtemplate/Creator/TemplateCreators/PolicyTemplateCreator.cs b/src/APIM_ARMTemplate/apimtemplate/Creator/TemplateCreators/PolicyTemplateCreator.cs
@@ -27,7 +27,7 @@ public async Task<PolicyTemplateResource> CreateAPIPolicyTemplateResourceAsync(C
                 properties = new PolicyTemplateProperties()
                 {
                     contentFormat = "rawxml",
-                    policyContent = await this.fileReader.RetrieveLocationContentsAsync(creatorConfig.api.policy)
+                    policyContent = await this.fileReader.RetrieveJSONContentsAsync(creatorConfig.api.policy)
                 },
                 dependsOn = dependsOn
             };
@@ -45,7 +45,7 @@ public async Task<PolicyTemplateResource> CreateOperationPolicyTemplateResourceA
                 properties = new PolicyTemplateProperties()
                 {
                     contentFormat = "rawxml",
-                    policyContent = await this.fileReader.RetrieveLocationContentsAsync(policyPair.Value.policy)
+                    policyContent = await this.fileReader.RetrieveJSONContentsAsync(policyPair.Value.policy)
                 },
                 dependsOn = dependsOn
             };
@@ -54,6 +54,7 @@ public async Task<PolicyTemplateResource> CreateOperationPolicyTemplateResourceA
 
         public async Task<List<PolicyTemplateResource>> CreateOperationPolicyTemplateResourcesAsync(CreatorConfig creatorConfig, string[] dependsOn)
         {
+            // create a policy resource for each policy listed in the config file and its associated provided xml file
             List<PolicyTemplateResource> policyTemplateResources = new List<PolicyTemplateResource>();
             foreach (KeyValuePair<string, OperationsConfig> pair in creatorConfig.api.operations)
             {
diff --git a/src/APIM_ARMTemplate/apimtemplate/Creator/TemplateCreators/ProductAPITemplateCreator.cs b/src/APIM_ARMTemplate/apimtemplate/Creator/TemplateCreators/ProductAPITemplateCreator.cs
@@ -26,6 +26,7 @@ public ProductAPITemplateResource CreateProductAPITemplateResource(string produc
 
         public List<ProductAPITemplateResource> CreateProductAPITemplateResources(CreatorConfig creatorConfig, string[] dependsOn)
         {
+            // create a products/apis association resource for each product provided in the config file
             List<ProductAPITemplateResource> productAPITemplates = new List<ProductAPITemplateResource>();
             string[] productIDs = creatorConfig.api.products.Split(", ");
             foreach (string productID in productIDs)
diff --git a/src/APIM_ARMTemplate/apimtemplate/Creator/TemplateCreators/TemplateCreator.cs b/src/APIM_ARMTemplate/apimtemplate/Creator/TemplateCreators/TemplateCreator.cs
@@ -11,6 +11,7 @@ public class TemplateCreator
     {
         public Template CreateEmptyTemplate()
         {
+            // creates empty template for use in all other template creators
             Template template = new Template()
             {
                 schema = "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#",

Original file line number	Diff line number	Diff line change
`@@ -5,13 +5,13 @@`
`5`	`5`
`6`	`6`	`namespace Microsoft.Azure.Management.ApiManagement.ArmTemplates`
`7`	`7`	`{`
`8`		`- public class ARMTemplateWriterTests`
	`8`	`+ public class FileWriterTests`
`9`	`9`	`{`
`10`	`10`	`[Fact]`
`11`	`11`	`public void ShouldWriteJSONToFile()`
`12`	`12`	`{`
`13`	`13`	`// arrange`
`14`		`- ARMTemplateWriter armTemplateWriter = new ARMTemplateWriter();`
	`14`	`+ FileWriter fileWriter = new FileWriter();`
`15`	`15`	`string location = String.Concat("..", Path.DirectorySeparatorChar,`
`16`	`16`	`"..", Path.DirectorySeparatorChar,`
`17`	`17`	`"..", Path.DirectorySeparatorChar,`
`@@ -26,7 +26,7 @@ public void ShouldWriteJSONToFile()`
`26`	`26`	`File.Delete(location);`
`27`	`27`	`}`
`28`	`28`	`// write new`
`29`		`- armTemplateWriter.WriteJSONToFile(testJSON, location);`
	`29`	`+ fileWriter.WriteJSONToFile(testJSON, location);`
`30`	`30`
`31`	`31`	`// assert`
`32`	`32`	`Assert.True(File.Exists(location));`
Original file line number	Diff line number	Diff line change
`@@ -15,10 +15,12 @@ public class FileReader`
`15`	`15`	`{`
`16`	`16`	`public async Task<CreatorConfig> ConvertConfigYAMLToCreatorConfigAsync(string configFileLocation)`
`17`	`17`	`{`
	`18`	`+ // determine whether file location is local file path or remote url and convert appropriately`
`18`	`19`	`Uri uriResult;`
`19`	`20`	`bool isUrl = Uri.TryCreate(configFileLocation, UriKind.Absolute, out uriResult) && (uriResult.Scheme == Uri.UriSchemeHttp \|\| uriResult.Scheme == Uri.UriSchemeHttps);`
`20`	`21`	`if (isUrl)`
`21`	`22`	`{`
	`23`	`+ // make a request to the provided url and convert the response's content`
`22`	`24`	`HttpClient client = new HttpClient();`
`23`	`25`	`HttpResponseMessage response = await client.GetAsync(uriResult);`
`24`	`26`	`if (response.IsSuccessStatusCode)`
`@@ -43,19 +45,22 @@ public async Task<CreatorConfig> ConvertConfigYAMLToCreatorConfigAsync(string co`
`43`	`45`	`{`
`44`	`46`	`using (StreamReader reader = new StreamReader(configFileLocation))`
`45`	`47`	`{`
	`48`	`+ // deserialize provided file contents into yaml`
`46`	`49`	`Deserializer deserializer = new Deserializer();`
`47`	`50`	`object deserializedYaml = deserializer.Deserialize(reader);`
`48`	`51`	`JsonSerializer jsonSerializer = new JsonSerializer();`
`49`	`52`	`StringWriter writer = new StringWriter();`
	`53`	`+ // serialize json from yaml object`
`50`	`54`	`jsonSerializer.Serialize(writer, deserializedYaml);`
`51`	`55`	`string jsonText = writer.ToString();`
	`56`	`+ // deserialize CreatorConfig from json string`
`52`	`57`	`CreatorConfig yamlObject = JsonConvert.DeserializeObject<CreatorConfig>(jsonText);`
`53`	`58`	`return yamlObject;`
`54`	`59`	`}`
`55`	`60`	`}`
`56`	`61`	`}`
`57`	`62`
`58`		`- public async Task<string> RetrieveLocationContentsAsync(string fileLocation)`
	`63`	`+ public async Task<string> RetrieveJSONContentsAsync(string fileLocation)`
`59`	`64`	`{`
`60`	`65`	`Uri uriResult;`
`61`	`66`	`bool isUrl = Uri.TryCreate(fileLocation, UriKind.Absolute, out uriResult) && (uriResult.Scheme == Uri.UriSchemeHttp \|\| uriResult.Scheme == Uri.UriSchemeHttps);`
Original file line number	Diff line number	Diff line change
`@@ -6,10 +6,11 @@`
`6`	`6`
`7`	`7`	`namespace Microsoft.Azure.Management.ApiManagement.ArmTemplates`
`8`	`8`	`{`
`9`		`- public class ARMTemplateWriter`
	`9`	`+ public class FileWriter`
`10`	`10`	`{`
`11`	`11`	`public void WriteJSONToFile(object template, string location)`
`12`	`12`	`{`
	`13`	`+ // writes json object to provided location`
`13`	`14`	`string jsonString = JsonConvert.SerializeObject(template,`
`14`	`15`	`Formatting.None,`
`15`	`16`	`new JsonSerializerSettings`
`@@ -18,5 +19,16 @@ public void WriteJSONToFile(object template, string location)`
`18`	`19`	`});`
`19`	`20`	`File.WriteAllText(location, jsonString);`
`20`	`21`	`}`
	`22`	`+`
	`23`	`+ public CreatorFileNames GenerateCreatorFileNames()`
	`24`	`+ {`
	`25`	`+ // generate useable object with file names for consistency throughout project`
	`26`	`+ return new CreatorFileNames()`
	`27`	`+ {`
	`28`	`+ apiVersionSet = $@"/versionset.template.json",`
	`29`	`+ api = $@"/api.template.json",`
	`30`	`+ master = @"/master.template.json"`
	`31`	`+ };`
	`32`	`+ }`
`21`	`33`	`}`
`22`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@ public class OpenAPISpecReader`
`15`	`15`	`{`
`16`	`16`	`public OpenApiDocument ConvertToOpenAPISpec(string json)`
`17`	`17`	`{`
	`18`	`+ // converts json string into OpenApiDocument class`
`18`	`19`	`OpenApiStringReader reader = new OpenApiStringReader();`
`19`	`20`	`OpenApiDocument doc = reader.Read(json, out var diagnostic);`
`20`	`21`	`return doc;`
`@@ -46,6 +47,7 @@ public async Task<OpenApiDocument> ConvertRemoteURLToOpenAPISpecAsync(Uri uriRes`
`46`	`47`
`47`	`48`	`public async Task<OpenApiDocument> ConvertOpenAPISpecToDoc(string openApiSpecFileLocation)`
`48`	`49`	`{`
	`50`	`+ // determine whether file location is local file path or remote url and convert appropriately`
`49`	`51`	`Uri uriResult;`
`50`	`52`	`bool isUrl = Uri.TryCreate(openApiSpecFileLocation, UriKind.Absolute, out uriResult) && (uriResult.Scheme == Uri.UriSchemeHttp \|\| uriResult.Scheme == Uri.UriSchemeHttps);`
`51`	`53`	`if (isUrl)`
Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,7 @@ public APIVersionSetTemplateCreator(TemplateCreator templateCreator)`
`18`	`18`
`19`	`19`	`public Template CreateAPIVersionSetTemplate(CreatorConfig creatorConfig)`
`20`	`20`	`{`
	`21`	`+ // create empty template`
`21`	`22`	`Template apiVersionSetTemplate = this.templateCreator.CreateEmptyTemplate();`
`22`	`23`
`23`	`24`	`// add parameters`
Original file line number	Diff line number	Diff line change
`@@ -10,18 +10,17 @@ namespace Microsoft.Azure.Management.ApiManagement.ArmTemplates`
`10`	`10`	`public class MasterTemplateCreator`
`11`	`11`	`{`
`12`	`12`	`private TemplateCreator templateCreator;`
`13`		`- private FileNameGenerator fileNameGenerator;`
`14`	`13`
`15`		`- public MasterTemplateCreator(TemplateCreator templateCreator, FileNameGenerator fileNameGenerator)`
	`14`	`+ public MasterTemplateCreator(TemplateCreator templateCreator)`
`16`	`15`	`{`
`17`	`16`	`this.templateCreator = templateCreator;`
`18`		`- this.fileNameGenerator = fileNameGenerator;`
`19`	`17`	`}`
`20`	`18`
`21`	`19`	`public Template CreateLinkedMasterTemplate(Template apiVersionSetTemplate,`
`22`	`20`	`Template apiTemplate,`
`23`	`21`	`CreatorFileNames creatorFileNames)`
`24`	`22`	`{`
	`23`	`+ // create empty template`
`25`	`24`	`Template masterTemplate = this.templateCreator.CreateEmptyTemplate();`
`26`	`25`
`27`	`26`	`// add parameters`
`@@ -50,12 +49,13 @@ public Template CreateUnlinkedMasterTemplate(Template apiVersionSetTemplate,`
`50`	`49`	`Template apiTemplate,`
`51`	`50`	`CreatorFileNames creatorFileNames)`
`52`	`51`	`{`
	`52`	`+ // create empty template`
`53`	`53`	`Template masterTemplate = this.templateCreator.CreateEmptyTemplate();`
`54`	`54`
`55`	`55`	`// add parameters`
`56`	`56`	`masterTemplate.parameters = this.CreateMasterTemplateParameters(false);`
`57`	`57`
`58`		`- // add links to all resources`
	`58`	`+ // add all resources directly`
`59`	`59`	`List<TemplateResource> resources = new List<TemplateResource>();`
`60`	`60`
`61`	`61`	`// apiVersionSet`
`@@ -98,6 +98,7 @@ public MasterTemplateResource CreateMasterTemplateResource(string name, string u`
`98`	`98`
`99`	`99`	`public Dictionary<string, TemplateParameterProperties> CreateMasterTemplateParameters(bool linked)`
`100`	`100`	`{`
	`101`	`+ // used to create the parameter metatadata, etc (not value) for use in file with resources`
`101`	`102`	`Dictionary<string, TemplateParameterProperties> parameters = new Dictionary<string, TemplateParameterProperties>();`
`102`	`103`	`TemplateParameterProperties apimServiceNameProperties = new TemplateParameterProperties()`
`103`	`104`	`{`
`@@ -125,6 +126,8 @@ public Dictionary<string, TemplateParameterProperties> CreateMasterTemplateParam`
`125`	`126`
`126`	`127`	`public Template CreateMasterTemplateParameterValues(CreatorConfig creatorConfig)`
`127`	`128`	`{`
	`129`	`+ // used to create the parameter values for use in parameters file`
	`130`	`+ // create empty template`
`128`	`131`	`Template masterTemplate = this.templateCreator.CreateEmptyTemplate();`
`129`	`132`
`130`	`133`	`// add parameters`
`@@ -138,11 +141,7 @@ public Template CreateMasterTemplateParameterValues(CreatorConfig creatorConfig)`
`138`	`141`	`{`
`139`	`142`	`TemplateParameterProperties repoBaseUrlProperties = new TemplateParameterProperties()`
`140`	`143`	`{`
`141`		`- metadata = new TemplateParameterMetadata()`
`142`		`- {`
`143`		`- description = "Base URL of the repository"`
`144`		`- },`
`145`		`- type = "string"`
	`144`	`+ value = ""`
`146`	`145`	`};`
`147`	`146`	`parameters.Add("repoBaseUrl", repoBaseUrlProperties);`
`148`	`147`	`}`