public void ShouldWriteJSONToFile()
{
// arrange
ARMTemplateWriter armTemplateWriter = new ARMTemplateWriter();
string location = String.Concat("..", Path.DirectorySeparatorChar,
"..", Path.DirectorySeparatorChar,
"..", Path.DirectorySeparatorChar,
"Creator", Path.DirectorySeparatorChar,
"example.json");
APITemplate testObject = new APITemplate()
{
apiVersion = ""
};
JObject testJSON = JObject.FromObject(testObject);
// delete existing file if exists
if (File.Exists(location))
{
File.Delete(location);
}
// write new
armTemplateWriter.WriteJSONToFile(testJSON, location);
// assert
Assert.True(File.Exists(location));
File.Delete(location);
}
public async Task <APITemplate> CreateAPITemplateAsync(CreatorConfig creatorConfig)
{
YAMLReader yamlReader = new YAMLReader();
// create api schema with properties
APITemplate apiSchema = new APITemplate()
{
type = "Microsoft.ApiManagement/service/apis",
apiVersion = "2018-06-01-preview",
properties = new APITemplateProperties()
{
contentFormat = "swagger-json",
contentValue = await yamlReader.RetrieveLocationContents(creatorConfig.api.openApiSpec),
// supplied via optional arguments
apiVersion = creatorConfig.api.apiVersion ?? "",
apiRevision = creatorConfig.api.revision ?? "",
apiVersionSetId = creatorConfig.api.versionSetId ?? "",
path = creatorConfig.api.suffix ?? "",
apiRevisionDescription = creatorConfig.api.revisionDescription ?? "",
apiVersionDescription = creatorConfig.api.apiVersionDescription ?? "",
apiVersionSet = creatorConfig.apiVersionSet ?? null,
authenticationSettings = creatorConfig.api.authenticationSettings ?? null
}
};
return(apiSchema);
}
public CreateCommand()
{
this.Name = Constants.CreateName;
this.Description = Constants.CreateDescription;
// list command options
CommandOption configFile = this.Option("--configFile <configFile>", "Config YAML file location", CommandOptionType.SingleValue).IsRequired();
this.HelpOption();
this.OnExecute(async() =>
{
// convert config file to CreatorConfig class
YAMLReader yamlReader = new YAMLReader();
CreatorConfig creatorConfig = yamlReader.ConvertConfigYAMLToCreatorConfig(configFile.Value());
// ensure required parameters have been passed in
if (creatorConfig.outputLocation == null)
{
throw new CommandParsingException(this, "Output location is required");
}
else if (creatorConfig.version == null)
{
throw new CommandParsingException(this, "Version is required");
}
else if (creatorConfig.api == null)
{
throw new CommandParsingException(this, "API configuration is required");
}
else if (creatorConfig.api.openApiSpec == null)
{
throw new CommandParsingException(this, "Open API Spec is required");
}
else if (creatorConfig.api.suffix == null)
{
throw new CommandParsingException(this, "API suffix is required");
}
else
{
// required parameters have been supplied
// initialize helper classes
APITemplateCreator apiTemplateCreator = new APITemplateCreator();
ARMTemplateWriter armTemplateWriter = new ARMTemplateWriter();
// create templates from provided configuration
APITemplate apiTemplate = await apiTemplateCreator.CreateAPITemplateAsync(creatorConfig);
// write templates to outputLocation
armTemplateWriter.WriteAPITemplateToFile(apiTemplate, creatorConfig.outputLocation);
ColoredConsole.WriteLine("Templates written to output location");
}
return(0);
});
}
public async Task <APITemplate> CreateAPITemplateAsync(OpenApiDocument doc, CLICreatorArguments cliArguments)
{
YAMLReader yamlReader = new YAMLReader();
// create api schema with properties
APITemplate apiSchema = new APITemplate()
{
name = doc.Info.Title,
type = "Microsoft.ApiManagement/service/apis",
apiVersion = "2018-06-01-preview",
properties = new APITemplateProperties()
{
contentFormat = "swagger-json",
contentValue = await CreateOpenAPISpecContentsAsync(cliArguments),
subscriptionRequired = IsSubscriptionRequired(doc),
protocols = CreateProtocols(doc),
serviceUrl = doc.Servers[0].Url,
subscriptionKeyParameterNames = CreateSubscriptionKeyParameterNames(doc),
description = doc.Info.Description,
displayName = doc.Info.Title,
apiVersion = cliArguments.apiVersion ?? doc.Info.Version,
apiRevision = cliArguments.apiRevision ?? "",
apiVersionSetId = cliArguments.apiVersionSetId ?? "",
path = cliArguments.path ?? "",
apiRevisionDescription = cliArguments.apiRevisionDescription ?? "",
apiVersionDescription = cliArguments.apiVersionDescription ?? "",
apiVersionSet = cliArguments.apiVersionSetFile != null?yamlReader.ConvertYAMLFileToAPIVersionSet(cliArguments.apiVersionSetFile) : null,
authenticationSettings = cliArguments.authenticationSettingsFile != null?yamlReader.ConvertYAMLFileToAuthenticationSettings(cliArguments.authenticationSettingsFile) : null,
// assumptions
type = "http",
apiType = "http",
wsdlSelector = null
}
};
// create resources
List <APITemplateResource> resources = new List <APITemplateResource>();
SchemaTemplateCreator schemaCreator = new SchemaTemplateCreator();
List <SchemaTemplate> schemaTemplates = schemaCreator.CreateSchemaTemplates(doc);
OperationTemplateCreator operationCreator = new OperationTemplateCreator();
List <OperationTemplate> operationTemplates = operationCreator.CreateOperationTemplates(doc);
resources.AddRange(schemaTemplates);
resources.AddRange(operationTemplates);
apiSchema.resources = resources.ToArray();
return(apiSchema);
}
public void WriteAPITemplateToFile(APITemplate template, string location)
{
WriteJSONToFile(JObject.FromObject(template), String.Concat(location, @"\APITemplate.json"));
}
public CreateCommand()
{
this.Name = Constants.CreateName;
this.Description = Constants.CreateDescription;
// list command options
CommandOption openAPISpecFile = this.Option("--openAPISpecFile <openAPISpecFile>", "Open API spec file location", CommandOptionType.SingleValue);
CommandOption openAPISpecURL = this.Option("--openAPISpecURL <openAPISpecURL>", "Open API spec remote url", CommandOptionType.SingleValue);
CommandOption outputLocation = this.Option("--outputLocation <outputLocation>", "Template output location", CommandOptionType.SingleValue).IsRequired();
CommandOption xmlPolicyFile = this.Option("--xmlPolicyFile <xmlPolicyFile>", "XML policy file location", CommandOptionType.SingleValue);
CommandOption xmlPolicyURL = this.Option("--xmlPolicyURL <xmlPolicyURL>", "XML policy remote url", CommandOptionType.SingleValue);
CommandOption linked = this.Option("--linked <linked>", "Creates linked templates versus inlined into a single file", CommandOptionType.SingleValue);
CommandOption path = this.Option("--path <path>", "API path", CommandOptionType.SingleValue);
CommandOption apiRevision = this.Option("--apiRevision <apiRevision>", "API revision", CommandOptionType.SingleValue);
CommandOption apiRevisionDescription = this.Option("--apiRevisionDescription <apiVersionSetId>", "Description of the API revision", CommandOptionType.SingleValue);
CommandOption apiVersion = this.Option("--apiVersion <apiVersion>", "API version", CommandOptionType.SingleValue);
CommandOption apiVersionDescription = this.Option("--apiVersionDescription <apiVersionSetId>", "Description of the API version", CommandOptionType.SingleValue);
CommandOption apiVersionSetFile = this.Option("--apiVersionSetFile <apiVersionSetId>", "YAML file with object that follows the ApiVersionSetContractDetails object schema - https://docs.microsoft.com/en-us/azure/templates/microsoft.apimanagement/2018-06-01-preview/service/apis#ApiVersionSetContractDetails", CommandOptionType.SingleValue);
CommandOption authenticationSettingsFile = this.Option("--authenticationSettingsFile <apiVersionSetId>", "YAML file with object that follows the AuthenticationSettingsContract object schema - https://docs.microsoft.com/en-us/azure/templates/microsoft.apimanagement/2018-06-01-preview/service/apis#AuthenticationSettingsContract", CommandOptionType.SingleValue);
CommandOption apiVersionSetId = this.Option("--apiVersionSetId <apiVersionSetId>", "API version set id", CommandOptionType.SingleValue);
CommandOption productIds = this.Option("--productIds <productIds>", "Product ids to associate the API with", CommandOptionType.MultipleValue);
this.HelpOption();
this.OnExecute(async() =>
{
// ensure required parameters have been passed in
if ((openAPISpecFile.HasValue() || openAPISpecURL.HasValue()) && outputLocation.HasValue())
{
// convert command options to CLIArguments class
CLICreatorArguments cliArguments = new CLICreatorArguments()
{
openAPISpecFile = openAPISpecFile.Value(),
openAPISpecURL = openAPISpecURL.Value(),
outputLocation = outputLocation.Value(),
xmlPolicyFile = xmlPolicyFile.Value(),
xmlPolicyURL = xmlPolicyURL.Value(),
linked = linked.HasValue(),
path = path.Value(),
apiRevision = apiRevision.Value(),
apiRevisionDescription = apiRevisionDescription.Value(),
apiVersion = apiVersion.Value(),
apiVersionDescription = apiVersionDescription.Value(),
apiVersionSetFile = apiVersionSetFile.Value(),
apiVersionSetId = apiVersionSetId.Value(),
authenticationSettingsFile = authenticationSettingsFile.Value(),
productIds = productIds.Values
};
if (apiVersionSetFile.HasValue() && AttemptAPIVersionSetConversion(cliArguments) != null)
{
// unable to convert version set argument into object, would cause failure down the line
ColoredConsole.Error.WriteLine("Incorrect apiVersionSet object structure");
return(0);
}
else if (authenticationSettingsFile.HasValue() && AttemptAuthenticationSettingsConversion(cliArguments) != null)
{
// unable to convert version set argument into object, would cause failure down the line
ColoredConsole.Error.WriteLine("Incorrect authenticationSettings object structure");
return(0);
}
else
{
// required parameters have been supplied and versionSet has correct object structure
// initialize helper classes
OpenAPISpecReader openAPISpecReader = new OpenAPISpecReader();
ARMTemplateWriter armTemplateWriter = new ARMTemplateWriter();
APITemplateCreator apiTemplateCreator = new APITemplateCreator();
TagTemplateCreator tagTemplateCreator = new TagTemplateCreator();
// create OpenApiDocument from Open API spec file
OpenApiDocument doc = new OpenApiDocument();
if (cliArguments.openAPISpecFile != null)
{
doc = openAPISpecReader.ConvertLocalFileToOpenAPISpec(cliArguments.openAPISpecFile);
}
else
{
doc = await openAPISpecReader.ConvertRemoteURLToOpenAPISpecAsync(cliArguments.openAPISpecURL);
}
// create templates from OpenApiDocument
APITemplate apiTemplate = await apiTemplateCreator.CreateAPITemplateAsync(doc, cliArguments);
List <TagTemplate> tagTemplates = tagTemplateCreator.CreateTagTemplates(doc);
List <TagDescriptionTemplate> tagDescriptionTemplates = tagTemplateCreator.CreateTagDescriptionTemplates(doc);
// write templates to outputLocation
armTemplateWriter.WriteAPITemplateToFile(apiTemplate, cliArguments.outputLocation);
armTemplateWriter.WriteTagTemplatesToFile(tagTemplates, cliArguments.outputLocation);
armTemplateWriter.WriteTagDescriptionTemplatesToFile(tagDescriptionTemplates, cliArguments.outputLocation);
ColoredConsole.WriteLine("Templates written to output location");
}
}
else if (!outputLocation.HasValue())
{
ColoredConsole.Error.WriteLine("Output location is required");
}
else if (!(openAPISpecFile.HasValue() || openAPISpecURL.HasValue()))
{
ColoredConsole.Error.WriteLine("Open API spec file or remote url is required");
}
;
return(0);
});
}
