Parameterizing backend Urls for the apis (#413)

* Parameterizing backend Urls for the apis

Parameterizing backend Urls for the apis.

Key value pair like - apiName
and the value will be
apiUrl.

This apiUrl will be mapped to the apiName which matches with the same name.

* fixed the unit test fails

* fixed the command option name

* updated the project version to 1.0.1

* Reverted the version update changes

* Fixed the code review comments

Moved the logic to separate file CreatorApiBackendUrlUpdater

When using the Creator cli tool in the pipeline we need to specify the backend url which will be changing for each environment, so want to pass it as an json input so that we can call different json files for eaach environment.

* Updated the Readme.md file with instructions to pass the backendurls json file as an parameter

Author: SSanjeevi

src/APIM_ARMTemplate/README.md

@@ -286,6 +286,9 @@ Below are the steps to run the Creator from the source code:
 - Navigate to {path_to_folder}/src/APIM_ARMTemplate/apimtemplate directory
 - Run the following command:
 ```dotnet run create --configFile CONFIG_YAML_FILE_LOCATION ```
+- Run the following command to pass BackendUrls as an json input file into the parameter(sample file available in the same path as below in this repository):
+```dotnet run create --configFile CONFIG_YAML_FILE_LOCATION --backendurlconfigFile .\apimtemplate\Creator\ExampleFiles\BackendUrlParameter\BackendUrlParameters.json```
+
 
 You can also run it directly from the [releases](https://github.com/Azure/azure-api-management-devops-resource-kit/releases).
 

src/APIM_ARMTemplate/apimtemplate/Commands/Create.cs

@@ -3,6 +3,8 @@
 using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common;
 using System.Collections.Generic;
 using System.Linq;
+using Newtonsoft.Json;
+using apimtemplate.Creator.Utilities;
 
 namespace Microsoft.Azure.Management.ApiManagement.ArmTemplates.Create
 {
@@ -16,6 +18,9 @@ public CreateCommand()
             // list command options
             CommandOption configFile = this.Option("--configFile <configFile>", "Config YAML file location", CommandOptionType.SingleValue).IsRequired();
 
+            // list command options
+            CommandOption backendurlconfigFile = this.Option("--backendurlconfigFile <backendurlconfigFile>", "backend url json file location", CommandOptionType.SingleValue);
+
             this.HelpOption();
 
             this.OnExecute(async () =>
@@ -26,6 +31,14 @@ public CreateCommand()
 
                 // validate creator config
                 CreatorConfigurationValidator creatorConfigurationValidator = new CreatorConfigurationValidator(this);
+
+                //if backendurlfile passed as parameter
+                if (backendurlconfigFile != null && !string.IsNullOrEmpty(backendurlconfigFile.Value()))
+                {
+                    CreatorApiBackendUrlUpdater creatorApiBackendUrlUpdater = new CreatorApiBackendUrlUpdater();
+                    creatorConfig = creatorApiBackendUrlUpdater.UpdateBackendServiceUrl(backendurlconfigFile.Value(), creatorConfig);
+                }
+
                 bool isValidCreatorConfig = creatorConfigurationValidator.ValidateCreatorConfig(creatorConfig);
                 if (isValidCreatorConfig == true)
                 {

src/APIM_ARMTemplate/apimtemplate/Creator/ExampleFiles/BackendUrlParameter/BackendUrlParameters.json

@@ -0,0 +1,9 @@
+[{
+        "apiName": "myAPI",
+        "apiUrl": "http://myApiBackendUrl.com"
+    },
+    {
+        "apiName": "myAPI2",
+        "apiUrl": "http://myApiBackendUrl.com"
+    }
+]

src/APIM_ARMTemplate/apimtemplate/Creator/Models/BackendUrlConfiguration.cs

@@ -0,0 +1,11 @@
+using System.Collections.Generic;
+
+
+namespace Microsoft.Azure.Management.ApiManagement.ArmTemplates.Create
+{
+    public class BackendUrlsConfig
+    {
+        public string apiName { get; set; }
+        public string apiUrl { get; set; }
+    }
+}

src/APIM_ARMTemplate/apimtemplate/Creator/Models/CreatorConfiguration.cs

@@ -6,6 +6,8 @@ namespace Microsoft.Azure.Management.ApiManagement.ArmTemplates.Create
     public class CLICreatorArguments
     {
         public string configFile { get; set; }
+
+        public string backendurlconfigFile { get; set; }
     }
 
     public class CreatorConfig

src/APIM_ARMTemplate/apimtemplate/Creator/Utilities/CreatorApiBackendUrlUpdater.cs

@@ -0,0 +1,40 @@
+using System;
+using System.Collections.Generic;
+using System.Text;
+using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Common;
+using Microsoft.Azure.Management.ApiManagement.ArmTemplates.Create;
+using Newtonsoft.Json;
+
+namespace apimtemplate.Creator.Utilities
+{
+    public class CreatorApiBackendUrlUpdater
+    {
+        public CreatorConfig UpdateBackendServiceUrl(string backendServiceUrlFile, CreatorConfig creatorConfig)
+        {
+            // convert config file to CreatorConfig class
+            FileReader fileReader = new FileReader();
+
+            string backendurlConfigContent = fileReader.RetrieveLocalFileContents(backendServiceUrlFile);
+
+            //if the file is json file
+            if (fileReader.isJSON(backendurlConfigContent))
+            {
+                List<BackendUrlsConfig> backendUrls = JsonConvert.DeserializeObject<List<BackendUrlsConfig>>(backendurlConfigContent);
+
+                foreach (APIConfig aPIConfig in creatorConfig.apis)
+                {
+                    //if the apiname matches with the one in valid yaml file
+                    BackendUrlsConfig backendUrlsConfig = backendUrls.Find(f => f.apiName == aPIConfig.name);
+
+                    //update the backendurl as per the input json file
+                    if (backendUrlsConfig != null && !string.IsNullOrEmpty(backendUrlsConfig.apiUrl))
+                    {
+                        aPIConfig.serviceUrl = backendUrlsConfig.apiUrl;
+                    }
+                }
+            }
+
+            return creatorConfig;
+        }
+    }
+}

src/APIM_ARMTemplate/apimtemplate/apimtemplate.csproj

@@ -1,4 +1,4 @@
-<Project Sdk="Microsoft.NET.Sdk">
+<Project Sdk="Microsoft.NET.Sdk">
 
   <PropertyGroup>
     <OutputType>Exe</OutputType>
@@ -7,6 +7,7 @@
     <LangVersion>preview</LangVersion>
     <PackAsTool>true</PackAsTool>
     <ToolCommandName>apim-templates</ToolCommandName>
+    <Version>1.0.0</Version>
   </PropertyGroup>
 
   <ItemGroup>