Refactoring merge PR (#649)

* Code architecture refactoring and fixing project structure (#612)

Co-authored-by: Dmitrii Korolev <dmkorolev@microsoft.com>

* Added .editorconfig and fixed style according to it (#621)

* added .editorconfig and fixed style according to it

* add issue link to TODO for creator executor

Co-authored-by: Dmitrii Korolev <dmkorolev@microsoft.com>

* PolicyExtractor refactoring & testing (#625)

* Initial extractorExecutor parameters\configuration refactoring + tests setup

* codestyle fixes. created apiclients and separated API + extraction for policy extractor

* review updates

* explicit variable for fixing dotnet build error CS0815

* fix IO.DirectoryNotFoundException in tests

* rename `ToParameterize` properties

* move template creator to Common\Templates\Abstractions

* rename templateCreator to templateGeneratorBase and make it a parent for all creators\extractors

Co-authored-by: Dmitrii Korolev <dmkorolev@microsoft.com>

* add DI to application (#631)

* add DI to application

* cleared entry pointed, deleted reflection, get rid of comman-line library dependencies in business logic code

* review +build fix

Co-authored-by: Dmitrii Korolev <dmkorolev@microsoft.com>

* product-apis extractor refactoring (#636)

* product apis refactoring

* launchsettings.json rollback

* rename service api products extractor

* global renaming, fix PR review

* rename product-apis response and properties

Co-authored-by: Dmitrii Korolev <dmkorolev@microsoft.com>

* order resources section fields of generated templates (#637)

* order resources section fields of generated templates

* fix comment

Co-authored-by: Dmitrii Korolev <dmkorolev@microsoft.com>

* refactor product extractor, fix logging, rework api-clients (#639)

* refactor product extractor, fix logging, rework api-clients

* rename predefined parameter

* parameter order fix

* rollback launch settings. json

* ignore changes in launch settings json

* make template builder as an injectable service

* exclude template builder extensions

* removed explicit discard

Co-authored-by: Dmitrii Korolev <dmkorolev@microsoft.com>

* fix typos in paths (#640)

Co-authored-by: Dmitrii Korolev <dmkorolev@microsoft.com>

* implement groups extractor (#641)

* implement groups extractor

* [review] duplicated code removal, cleaning tests, fixing namings

Co-authored-by: Dmitrii Korolev <dmkorolev@microsoft.com>

* ApiVersionSet, AuthorizationServer extractors refactoring (#643)

Co-authored-by: Dmitrii Korolev <dmkorolev@microsoft.com>

* make templates generic & refactor api-extractor (#644)

* make templates generic + refactor api-extractor

* runtime bugs fixes

* PR review

Co-authored-by: Dmitrii Korolev <dmkorolev@microsoft.com>

* serialization fixes after refactoring + entry point descriptions added (#645)

* serialization fixes

* provide fully-described outputs and fulfill rdocumentation

* fix required options for commands

* fix spaces

Co-authored-by: Dmitrii Korolev <dmkorolev@microsoft.com>

* fix refactoring breaking changes (checked manually)

* remove public pipelines

Co-authored-by: Dmitrii Korolev <dmkorolev@microsoft.com>

Author: DeagleGross

.editorconfig

@@ -0,0 +1,88 @@
+# To learn more about .editorconfig see https://aka.ms/editorconfigdocs
+root = true
+
+# Don't use tabs for indentation.
+[*]
+indent_style = space
+# (Please don't specify an indent_size here; that has too many unintended consequences.)
+
+[*.cs]
+indent_size = 4
+charset = utf-8-bom
+
+file_header_template =--------------------------------------------------------------------------\n <copyright file="{fileName}" company="Microsoft">\n     Copyright (c) Microsoft Corporation. All rights reserved.\n </copyright>\n--------------------------------------------------------------------------
+
+# use this. for all instance member access
+dotnet_style_qualification_for_field = true:error
+dotnet_style_qualification_for_property = true:error
+dotnet_style_qualification_for_method = true:error
+dotnet_style_qualification_for_event = true:error
+
+# Sort using and Import directives with System.* appearing first
+dotnet_sort_system_directives_first = true
+dotnet_separate_import_directive_groups = false
+
+# don't specify private/internal if it's default
+dotnet_style_require_accessibility_modifiers = omit_if_default:error
+
+# Reusable naming style definitions
+dotnet_naming_style.camel_case.capitalization = camel_case
+dotnet_naming_style.pascal_case.capitalization = pascal_case
+
+# Constants are PascalCase
+dotnet_naming_rule.constants_should_be_pascal_case.severity = error
+dotnet_naming_rule.constants_should_be_pascal_case.symbols = constants
+dotnet_naming_rule.constants_should_be_pascal_case.style = pascal_case
+
+dotnet_naming_symbols.constants.applicable_kinds = field, local
+dotnet_naming_symbols.constants.required_modifiers = const
+
+# Static fields are PascalCase
+dotnet_naming_rule.static_fields_should_be_pascal_case.severity = error
+dotnet_naming_rule.static_fields_should_be_pascal_case.symbols = static_fields
+dotnet_naming_rule.static_fields_should_be_pascal_case.style = pascal_case
+
+dotnet_naming_symbols.static_fields.applicable_kinds = field
+dotnet_naming_symbols.static_fields.applicable_accessibilities = *
+dotnet_naming_symbols.static_fields.required_modifiers = static
+
+# Private instance private fields are camelCase
+dotnet_naming_rule.private_instance_fields_should_be_camel_case.severity = error 
+dotnet_naming_rule.private_instance_fields_should_be_camel_case.symbols = private_instance_fields 
+dotnet_naming_rule.private_instance_fields_should_be_camel_case.style = camel_case
+
+dotnet_naming_symbols.private_instance_fields.applicable_kinds = field 
+dotnet_naming_symbols.private_instance_fields.applicable_accessibilities = private
+
+# Locals and parameters are camelCase
+dotnet_naming_rule.locals_should_be_camel_case.severity = error
+dotnet_naming_rule.locals_should_be_camel_case.symbols = locals_and_parameters
+dotnet_naming_rule.locals_should_be_camel_case.style = camel_case
+
+dotnet_naming_symbols.locals_and_parameters.applicable_kinds = parameter, local
+
+# Local functions are PascalCase
+dotnet_naming_rule.local_functions_should_be_pascal_case.severity = error
+dotnet_naming_rule.local_functions_should_be_pascal_case.symbols = local_functions
+dotnet_naming_rule.local_functions_should_be_pascal_case.style = pascal_case
+
+dotnet_naming_symbols.local_functions.applicable_kinds = local_function
+
+# All public and internal members are PascalCase
+dotnet_naming_rule.public_members_should_be_pascal_case.severity = error 
+dotnet_naming_rule.public_members_should_be_pascal_case.symbols = public_members 
+dotnet_naming_rule.public_members_should_be_pascal_case.style = pascal_case
+
+dotnet_naming_symbols.public_members.applicable_kinds = property, method, field, event, delegate
+dotnet_naming_symbols.public_members.applicable_accessibilities = public, internal
+
+# let's not take responsibility for DotNetty problems (is external repo)
+[Proxy/DotNetty/**.cs]
+dotnet_analyzer_diagnostic.severity = none # disables most external analyzers
+dotnet_diagnostic.CS0628.severity = none # protected member in sealed class
+dotnet_diagnostic.CS0108.severity = none # hides inherited member, no "new"
+dotnet_diagnostic.CS1570.severity = none # xml comments: badly formed xml
+dotnet_diagnostic.CS1573.severity = none # xml comments: missing a parameter
+dotnet_diagnostic.CS1574.severity = none # xml comments: bad cref
+dotnet_diagnostic.CS1711.severity = none # xml comments: bad type param
+dotnet_diagnostic.CS4014.severity = none # awaitable call not awaited

.gitignore

@@ -12,6 +12,27 @@ nupkg/
 !.vscode/launch.json
 !.vscode/extensions.json
 
+# Rider 
+## User specific
+**/.idea/**/workspace.xml
+**/.idea/**/tasks.xml
+**/.idea/shelf/*
+**/.idea/dictionaries
+**/.idea/httpRequests/
+
+## Sensitive or high-churn files
+**/.idea/**/dataSources/
+**/.idea/**/dataSources.ids
+**/.idea/**/dataSources.xml
+**/.idea/**/dataSources.local.xml
+**/.idea/**/sqlDataSources.xml
+**/.idea/**/dynamic.xml
+
+## Rider auto-generates .iml files, and contentModel.xml
+**/.idea/**/*.iml
+**/.idea/**/contentModel.xml
+**/.idea/**/modules.xml
+
 # User-specific files
 *.suo
 *.user
@@ -35,4 +56,5 @@ msbuild.err
 msbuild.wrn
 
 # Visual Studio 2015
-.vs/
+.vs/
+src/**/*launchSettings.json

src/APIM_ARMTemplate/apimtemplate/apimtemplate.sln renamed to Microsoft.Azure.Management.ApiManagement.sln

@@ -1,11 +1,15 @@
 
 Microsoft Visual Studio Solution File, Format Version 12.00
-# Visual Studio 15
-VisualStudioVersion = 15.0.28307.136
+# Visual Studio Version 17
+VisualStudioVersion = 17.0.32112.339
 MinimumVisualStudioVersion = 10.0.40219.1
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "apimtemplate", "apimtemplate.csproj", "{B5183465-2BC1-4206-9C9F-5AC9615AC941}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ArmTemplates", "src\ArmTemplates\ArmTemplates.csproj", "{B5183465-2BC1-4206-9C9F-5AC9615AC941}"
 EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "apimtemplate.test", "..\apimtemplate.test\apimtemplate.test.csproj", "{7D0C17F8-C0F5-4678-A75F-EB1BE94E3A46}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ArmTemplates.Tests", "tests\ArmTemplates.Tests\ArmTemplates.Tests.csproj", "{7D0C17F8-C0F5-4678-A75F-EB1BE94E3A46}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "src", "src", "{A8FCD0FA-2908-4EE5-B9DE-C0F6E0661C8D}"
+EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "tests", "tests", "{583B0ECD-81D1-4091-B158-2651468CBB51}"
 EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
@@ -25,6 +29,10 @@ Global
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
 	EndGlobalSection
+	GlobalSection(NestedProjects) = preSolution
+		{B5183465-2BC1-4206-9C9F-5AC9615AC941} = {A8FCD0FA-2908-4EE5-B9DE-C0F6E0661C8D}
+		{7D0C17F8-C0F5-4678-A75F-EB1BE94E3A46} = {583B0ECD-81D1-4091-B158-2651468CBB51}
+	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {86622F7B-B2EB-4FC7-9164-36F06B2F8B1D}
 	EndGlobalSection

README.md

@@ -6,7 +6,7 @@ APIs have become mundane. They have become the de facto standard for connecting
 
 With the strategic value of APIs, a continuous integration (CI) and continuous deployment (CD) pipeline has become an important aspect of API development. It allows organizations to automate deployment of API changes without error-prone manual steps, detect issues earlier, and ultimately deliver value to end users faster.
 
-This repository provides [guidance](./README.md), [examples](./example/), and [tools](./src/APIM_ARMTemplate/README.md) to help you achieve API DevOps with Azure API Management.
+This repository provides [guidance](./README.md), [examples](./example/), and [tools](./src/README.md) to help you achieve API DevOps with Azure API Management.
 
 ## The Problem
 
@@ -39,9 +39,9 @@ API developers will fork the publisher repository to a developer repository and
 
 We realize there are two challenges for API developers when working with Resource Manager templates:
 
-* First, API developers often work with [OpenAPI Specification](https://github.com/OAI/OpenAPI-Specification) and may not be familiar with Resource Manager schemas. Authoring templates manually might be an error-prone task. Therefore, we created a utility tool called [**Creator**](./src/APIM_ARMTemplate/README.md#Creator) to automate the creation of API templates based on an Open API Specification file. Optionally, developers can supply API Management policies for an API in XML format. Basically, the tool inserts the Open API specification and policies into a Resource Manager template in the proper format. With this tool, API developers can continue focusing on the formats and artifacts they are familiar with.
+* First, API developers often work with [OpenAPI Specification](https://github.com/OAI/OpenAPI-Specification) and may not be familiar with Resource Manager schemas. Authoring templates manually might be an error-prone task. Therefore, we created a utility tool called [**Creator**](./src/README.md#Creator) to automate the creation of API templates based on an Open API Specification file. Optionally, developers can supply API Management policies for an API in XML format. Basically, the tool inserts the Open API specification and policies into a Resource Manager template in the proper format. With this tool, API developers can continue focusing on the formats and artifacts they are familiar with.
 
-* Second, for customers who have already been using API Management, another challenge is how to extract existing configurations into Resource Manager templates. For those customers, We have created another tool called [**Extractor**](./src/APIM_ARMTemplate/README.md#extractor) to help them generate templates by extracting configurations from their exisitng API Management instances.  
+* Second, for customers who have already been using API Management, another challenge is how to extract existing configurations into Resource Manager templates. For those customers, We have created another tool called [**Extractor**](./src/README.md#extractor) to help them generate templates by extracting configurations from their exisitng API Management instances.  
 
 Once API developers have finished developing and testing an API, and have generated the API template, they can submit a pull request to merge the changes to the publisher repository. API publishers can validate the pull request and make sure the changes are safe and compliant. For example, they can check if only HTTPS is allowed to communicate with the API. Most of these validations can be automated as a step in the CI/CD pipeline. Once the changes are approved and merged successfully, API publishers can choose to deploy them to the Production instance either on schedule or on demand. The deployment of the templates can be automated using [Github Actions](https://github.com/Azure/apimanagement-devops-samples), [Azure Pipeline](https://docs.microsoft.com/en-us/azure/devops/pipelines/?view=azure-devops), [PowerShell](https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-group-template-deploy), [Azure CLI](Azure-cli-example.md) or other tools. An example using Azure DevOps can be find [here](docs/AzDO-Example.md)
 

docs/AzDO-Example.md

@@ -76,7 +76,7 @@ Where:
 
 **RESOURCE-GROUP-NAME:** Resource group where the DEV-APIM-NAME is hosted.
 
-***For more information on how to run the application and parameters, [go to this page](https://github.com/Azure/azure-api-management-devops-resource-kit/blob/master/src/APIM_ARMTemplate/README.md#extractor).***
+***For more information on how to run the application and parameters, [go to this page](https://github.com/Azure/azure-api-management-devops-resource-kit/blob/master/src/README.md#extractor).***
 
 After executing the command above, you will see something similar to this:
 

example/demo/README.md

@@ -4,5 +4,5 @@ In order to run the creator on this example:
 
 ```bash
 mkdir Output
-dotnet run --project ../../src/APIM_ARMTemplate/apimtemplate create --configFile Input/valid.yml
+dotnet run --project ../../src/ARMTemplates create --configFile Input/valid.yml
 ```