append api name with revision and create release if necessary

Author: lucashuet93

src/APIM_ARMTemplate/apimtemplate/Commands/Create.cs

@@ -45,8 +45,9 @@ public CreateCommand()
                     ProductAPITemplateCreator productAPITemplateCreator = new ProductAPITemplateCreator();
                     PolicyTemplateCreator policyTemplateCreator = new PolicyTemplateCreator(fileReader);
                     DiagnosticTemplateCreator diagnosticTemplateCreator = new DiagnosticTemplateCreator();
+                    ReleaseTemplateCreator releaseTemplateCreator = new ReleaseTemplateCreator();
                     ProductTemplateCreator productTemplateCreator = new ProductTemplateCreator(policyTemplateCreator);
-                    APITemplateCreator apiTemplateCreator = new APITemplateCreator(fileReader, policyTemplateCreator, productAPITemplateCreator, diagnosticTemplateCreator);
+                    APITemplateCreator apiTemplateCreator = new APITemplateCreator(fileReader, policyTemplateCreator, productAPITemplateCreator, diagnosticTemplateCreator, releaseTemplateCreator);
                     MasterTemplateCreator masterTemplateCreator = new MasterTemplateCreator();
 
                     // create templates from provided configuration
@@ -74,7 +75,7 @@ public CreateCommand()
                     foreach (APIConfig api in creatorConfig.apis)
                     {
                         // create api templates from provided api config - if the api config contains a supplied apiVersion, split the templates into 2 for metadata and swagger content, otherwise create a unified template
-                        List<Template> apiTemplateSet = await apiTemplateCreator.CreateAPITemplatesAsync(creatorConfig, api);
+                        List<Template> apiTemplateSet = await apiTemplateCreator.CreateAPITemplatesAsync(api);
                         apiTemplates.AddRange(apiTemplateSet);
                         // create the relevant info that will be needed to properly link to the api template(s) from the master template
                         apiInformation.Add(new LinkedMasterTemplateAPIInformation()

src/APIM_ARMTemplate/apimtemplate/Common/FileHandlers/FileNameGenerator.cs

@@ -23,13 +23,15 @@ public FileNames GenerateFileNames(string apimServiceName)
 
         public string GenerateCreatorAPIFileName(string apiName, bool isSplitAPI, bool isInitialAPI, string apimServiceName)
         {
+            // in case the api name has been appended with ;rev={revisionNumber}, take only the api name initially provided by the user in the creator config
+            string sanitizedAPIName = apiName.Split(";")[0];
             if (isSplitAPI == true)
             {
-                return isInitialAPI == true ? $@"/{apimServiceName}-{apiName}-initial.api.template.json" : $@"/{apimServiceName}-{apiName}-subsequent.api.template.json";
+                return isInitialAPI == true ? $@"/{apimServiceName}-{sanitizedAPIName}-initial.api.template.json" : $@"/{apimServiceName}-{sanitizedAPIName}-subsequent.api.template.json";
             }
             else
             {
-                return $@"/{apimServiceName}-{apiName}.api.template.json";
+                return $@"/{apimServiceName}-{sanitizedAPIName}.api.template.json";
             }
         }
 

src/APIM_ARMTemplate/apimtemplate/Common/TemplateModels/ReleaseTemplateResource.cs

@@ -2,10 +2,10 @@
 {
     public class ReleaseTemplateResource : APITemplateSubResource
     {
-        public ReleasTemplateProperties properties { get; set; }
+        public ReleaseTemplateProperties properties { get; set; }
     }
 
-    public class ReleasTemplateProperties
+    public class ReleaseTemplateProperties
     {
         public string apiId { get; set; }
         public string notes { get; set; }

src/APIM_ARMTemplate/apimtemplate/Creator/TemplateCreators/APITemplateCreator.cs

@@ -13,36 +13,49 @@ public class APITemplateCreator : TemplateCreator
         private PolicyTemplateCreator policyTemplateCreator;
         private ProductAPITemplateCreator productAPITemplateCreator;
         private DiagnosticTemplateCreator diagnosticTemplateCreator;
+        private ReleaseTemplateCreator releaseTemplateCreator;
 
-        public APITemplateCreator(FileReader fileReader, PolicyTemplateCreator policyTemplateCreator, ProductAPITemplateCreator productAPITemplateCreator, DiagnosticTemplateCreator diagnosticTemplateCreator)
+        public APITemplateCreator(FileReader fileReader, PolicyTemplateCreator policyTemplateCreator, ProductAPITemplateCreator productAPITemplateCreator, DiagnosticTemplateCreator diagnosticTemplateCreator, ReleaseTemplateCreator releaseTemplateCreator)
         {
             this.fileReader = fileReader;
             this.policyTemplateCreator = policyTemplateCreator;
             this.productAPITemplateCreator = productAPITemplateCreator;
             this.diagnosticTemplateCreator = diagnosticTemplateCreator;
+            this.releaseTemplateCreator = releaseTemplateCreator;
         }
 
-        public async Task<List<Template>> CreateAPITemplatesAsync(CreatorConfig creatorConfig, APIConfig api)
+        public async Task<List<Template>> CreateAPITemplatesAsync(APIConfig api)
         {
             // determine if api needs to be split into multiple templates
             bool isSplit = isSplitAPI(api);
 
+            // update api name if necessary (apiRevision > 1 and isCurrent = true) 
+            int revisionNumber = 0;
+            if (Int32.TryParse(api.apiRevision, out revisionNumber))
+            {
+                if (revisionNumber > 1 && api.isCurrent == true)
+                {
+                    string currentAPIName = api.name;
+                    api.name += $";rev={revisionNumber}";
+                }
+            }
+
             List<Template> apiTemplates = new List<Template>();
             if (isSplit == true)
             {
                 // create 2 templates, an initial template with metadata and a subsequent template with the swagger content
-                apiTemplates.Add(await CreateAPITemplateAsync(creatorConfig, api, isSplit, true));
-                apiTemplates.Add(await CreateAPITemplateAsync(creatorConfig, api, isSplit, false));
+                apiTemplates.Add(await CreateAPITemplateAsync(api, isSplit, true));
+                apiTemplates.Add(await CreateAPITemplateAsync(api, isSplit, false));
             }
             else
             {
                 // create a unified template that includes both the metadata and swagger content 
-                apiTemplates.Add(await CreateAPITemplateAsync(creatorConfig, api, isSplit, false));
+                apiTemplates.Add(await CreateAPITemplateAsync(api, isSplit, false));
             }
             return apiTemplates;
         }
 
-        public async Task<Template> CreateAPITemplateAsync(CreatorConfig creatorConfig, APIConfig api, bool isSplit, bool isInitial)
+        public async Task<Template> CreateAPITemplateAsync(APIConfig api, bool isSplit, bool isInitial)
         {
             // create empty template
             Template apiTemplate = CreateEmptyTemplate();
@@ -77,12 +90,15 @@ public List<TemplateResource> CreateChildResourceTemplates(APIConfig api)
             List<PolicyTemplateResource> operationPolicyResources = api.operations != null ? this.policyTemplateCreator.CreateOperationPolicyTemplateResources(api, dependsOn) : null;
             List<ProductAPITemplateResource> productAPIResources = api.products != null ? this.productAPITemplateCreator.CreateProductAPITemplateResources(api, dependsOn) : null;
             DiagnosticTemplateResource diagnosticTemplateResource = api.diagnostic != null ? this.diagnosticTemplateCreator.CreateAPIDiagnosticTemplateResource(api, dependsOn) : null;
+            // add release resource if the name has been appended with ;rev{revisionNumber}
+            ReleaseTemplateResource releaseTemplateResource = api.name.Contains(";rev") == true ? this.releaseTemplateCreator.CreateAPIReleaseTemplateResource(api, dependsOn) : null;
 
             // add resources if not null
             if (apiPolicyResource != null) resources.Add(apiPolicyResource);
             if (operationPolicyResources != null) resources.AddRange(operationPolicyResources);
             if (productAPIResources != null) resources.AddRange(productAPIResources);
             if (diagnosticTemplateResource != null) resources.Add(diagnosticTemplateResource);
+            if (releaseTemplateResource != null) resources.Add(releaseTemplateResource);
 
             return resources;
         }

src/APIM_ARMTemplate/apimtemplate/Properties/launchSettings.json

@@ -2,7 +2,7 @@
   "profiles": {
     "apimtemplate": {
       "commandName": "Project",
-      "commandLineArgs": "extract  --sourceApimName LucasBlankLinked  --destinationApimName LucasBlankUnlinked --resourceGroup LucasHuetHudsonInternal --fileFolder C:\\Users\\lucashh\\Desktop\\Projects\\APIM-ARM\\GeneratedTemplates\\Extractor\\Full --linkedTemplatesBaseUrl https://lucasarmtemplates.blob.core.windows.net/linked-templates "
+      "commandLineArgs": "create --configFile ./Creator/ExampleFiles/YAMLConfigs/validTesting.yml"
     }
   }
 }