Naming templates (#129)

* refactor to support custom naming templates (ref #126)

* cleaning Naming interface

* refactored for custom naming template

and initial set of unit tests

* more unit tests

* convert ARM template to use additional parameters

* rename to better convey

* fix ARM template sanity check

* editorconfig, attributes and using clean-up

* fixed implementation of FileNamingTemplates

added more argument validation
added unit tests

* Integration test for naming template feature

and some fixes
and some doc notes

* fix integration test cleanup

should be moved to a special test command

* factored out integration test cleanup

that is delete all azure resources except for the resource group

Author: giuliov

.editorconfig

@@ -0,0 +1,10 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+insert_final_newline = true
+
+[**.md]
+indent_size = 2
+trim_trailing_whitespace = false

doc/command-examples.md

@@ -1,8 +1,31 @@
 # Sample Aggregator CLI usage
 
 run `aggregator-cli.exe` (Windows), `aggregator-cli` (Linux) or `dotnet aggregator-cli.dll` followed by the command and any option.
+
+
+### Options valid for all command
 All commands accept the `--verbose` option to print additional messages for troubleshooting.
 
+With `--namingTemplate`, you can specify affixes for all Azure resource that will be created or used.
+ follows
+
+```json
+{
+  "ResourceGroupPrefix": "aggregator-",
+  "ResourceGroupSuffix": "-sfx",
+  "FunctionAppPrefix": "fp",
+  "FunctionAppSuffix": "fs",
+  "HostingPlanPrefix": "hp",
+  "HostingPlanSuffix": "hs",
+  "AppInsightPrefix": "aip",
+  "AppInsightSuffix": "ais",
+  "StorageAccountPrefix": "strg",
+  "StorageAccountSuffix": "31415"
+}
+```
+
+If you use this, the `--resourceGroup` option is mandatory.
+
 
 ### Logon
 You are required to log into both Azure and ADO. The credentials are cached locally and expire after 2 hours. _(Replace the below asterisks `*` with valid values.)_
@@ -181,4 +204,4 @@ Runs existing rule in Azure, no change is sent to Azure DevOps thanks to the `dr
 invoke.rule --instance my7 --resourceGroup test-aggregator7  --name r1 --event workitem.created --account giuliovaad --project WorkItemTracking --workItemId 14 --verbose --dryrun
 ```
 If you want to see the log messages, run a `stream.logs` command in another window.
-This can be used (without the `dryrun` flag) to apply rules to existing work items.
+This can be used (without the `dryrun` flag) to apply rules to existing work items.

src/.editorconfig

@@ -0,0 +1,117 @@
+# To learn more about .editorconfig see https://aka.ms/editorconfigdocs
+###############################
+# Core EditorConfig Options   #
+###############################
+# All files
+[*]
+indent_style = space
+# Code files
+[*.{cs,csx}]
+indent_size = 4
+insert_final_newline = true
+charset = utf-8-bom
+###############################
+# .NET Coding Conventions     #
+###############################
+[*.{cs,vb}]
+# Organize usings
+dotnet_sort_system_directives_first = true
+# this. preferences
+dotnet_style_qualification_for_field = false:silent
+dotnet_style_qualification_for_property = false:silent
+dotnet_style_qualification_for_method = false:silent
+dotnet_style_qualification_for_event = false:silent
+# Language keywords vs BCL types preferences
+dotnet_style_predefined_type_for_locals_parameters_members = true:silent
+dotnet_style_predefined_type_for_member_access = true:silent
+# Parentheses preferences
+dotnet_style_parentheses_in_arithmetic_binary_operators = always_for_clarity:silent
+dotnet_style_parentheses_in_relational_binary_operators = always_for_clarity:silent
+dotnet_style_parentheses_in_other_binary_operators = always_for_clarity:silent
+dotnet_style_parentheses_in_other_operators = never_if_unnecessary:silent
+# Modifier preferences
+dotnet_style_require_accessibility_modifiers = for_non_interface_members:silent
+dotnet_style_readonly_field = true:suggestion
+# Expression-level preferences
+dotnet_style_object_initializer = true:suggestion
+dotnet_style_collection_initializer = true:suggestion
+dotnet_style_explicit_tuple_names = true:suggestion
+dotnet_style_null_propagation = true:suggestion
+dotnet_style_coalesce_expression = true:suggestion
+dotnet_style_prefer_is_null_check_over_reference_equality_method = true:silent
+dotnet_style_prefer_inferred_tuple_names = true:suggestion
+dotnet_style_prefer_inferred_anonymous_type_member_names = true:suggestion
+dotnet_style_prefer_auto_properties = true:silent
+dotnet_style_prefer_conditional_expression_over_assignment = true:silent
+dotnet_style_prefer_conditional_expression_over_return = true:silent
+###############################
+# Naming Conventions          #
+###############################
+# Style Definitions
+dotnet_naming_style.pascal_case_style.capitalization             = pascal_case
+# Use PascalCase for constant fields  
+dotnet_naming_rule.constant_fields_should_be_pascal_case.severity = suggestion
+dotnet_naming_rule.constant_fields_should_be_pascal_case.symbols  = constant_fields
+dotnet_naming_rule.constant_fields_should_be_pascal_case.style    = pascal_case_style
+dotnet_naming_symbols.constant_fields.applicable_kinds            = field
+dotnet_naming_symbols.constant_fields.applicable_accessibilities  = *
+dotnet_naming_symbols.constant_fields.required_modifiers          = const
+###############################
+# C# Coding Conventions       #
+###############################
+[*.cs]
+# var preferences
+csharp_style_var_for_built_in_types = true:silent
+csharp_style_var_when_type_is_apparent = true:silent
+csharp_style_var_elsewhere = true:silent
+# Expression-bodied members
+csharp_style_expression_bodied_methods = false:silent
+csharp_style_expression_bodied_constructors = false:silent
+csharp_style_expression_bodied_operators = false:silent
+csharp_style_expression_bodied_properties = true:silent
+csharp_style_expression_bodied_indexers = true:silent
+csharp_style_expression_bodied_accessors = true:silent
+# Pattern matching preferences
+csharp_style_pattern_matching_over_is_with_cast_check = true:suggestion
+csharp_style_pattern_matching_over_as_with_null_check = true:suggestion
+# Null-checking preferences
+csharp_style_throw_expression = true:suggestion
+csharp_style_conditional_delegate_call = true:suggestion
+# Modifier preferences
+csharp_preferred_modifier_order = public,private,protected,internal,static,extern,new,virtual,abstract,sealed,override,readonly,unsafe,volatile,async:suggestion
+# Expression-level preferences
+csharp_prefer_braces = true:silent
+csharp_style_deconstructed_variable_declaration = true:suggestion
+csharp_prefer_simple_default_expression = true:suggestion
+csharp_style_pattern_local_over_anonymous_function = true:suggestion
+csharp_style_inlined_variable_declaration = true:suggestion
+###############################
+# C# Formatting Rules         #
+###############################
+# New line preferences
+csharp_new_line_before_open_brace = all
+csharp_new_line_before_else = true
+csharp_new_line_before_catch = true
+csharp_new_line_before_finally = true
+csharp_new_line_before_members_in_object_initializers = true
+csharp_new_line_before_members_in_anonymous_types = true
+csharp_new_line_between_query_expression_clauses = true
+# Indentation preferences
+csharp_indent_case_contents = true
+csharp_indent_switch_labels = true
+csharp_indent_labels = flush_left
+# Space preferences
+csharp_space_after_cast = false
+csharp_space_after_keywords_in_control_flow_statements = true
+csharp_space_between_method_call_parameter_list_parentheses = false
+csharp_space_between_method_declaration_parameter_list_parentheses = false
+csharp_space_between_parentheses = false
+csharp_space_before_colon_in_inheritance_clause = true
+csharp_space_after_colon_in_inheritance_clause = true
+csharp_space_around_binary_operators = before_and_after
+csharp_space_between_method_declaration_empty_parameter_list_parentheses = false
+csharp_space_between_method_call_name_and_opening_parenthesis = false
+csharp_space_between_method_call_empty_parameter_list_parentheses = false
+# Wrapping preferences
+csharp_preserve_single_line_statements = true
+csharp_preserve_single_line_blocks = true

src/aggregator-cli/CommandBase.cs

@@ -16,7 +16,10 @@ abstract class CommandBase
         [Option('v', "verbose", Default = false, HelpText = "Prints all messages to standard output.")]
         public bool Verbose { get; set; }
 
-        protected ContextBuilder Context => new ContextBuilder(Logger);
+        [Option("namingTemplate", Default = "", HelpText = "Define template-set for generating names of Azure Resources.")]
+        public string NamingTemplate { get; set; }
+
+        protected ContextBuilder Context => new ContextBuilder(Logger, this.NamingTemplate);
 
         internal ILogger Logger { get; private set; }
 

src/aggregator-cli/ContextBuilder.cs

@@ -2,6 +2,7 @@
 using Microsoft.VisualStudio.Services.WebApi;
 using System;
 using System.Collections.Generic;
+using System.IO;
 using System.Text;
 using System.Threading;
 using System.Threading.Tasks;
@@ -14,21 +15,28 @@ internal class CommandContext
         internal ILogger Logger { get; }
         internal IAzure Azure { get; }
         internal VssConnection Devops { get; }
-        internal CommandContext(ILogger logger, IAzure azure, VssConnection devops)
+        internal INamingTemplates Naming { get; }
+        internal CommandContext(ILogger logger, IAzure azure, VssConnection devops, INamingTemplates naming)
         {
             Logger = logger;
             Azure = azure;
             Devops = devops;
+            Naming = naming;
         }
     }
 
     internal class ContextBuilder
     {
+        private readonly string namingTemplate;
         private readonly ILogger logger;
         private bool azureLogon;
         private bool devopsLogon;
 
-        internal ContextBuilder(ILogger logger) => this.logger = logger;
+        internal ContextBuilder(ILogger logger, string namingTemplate)
+        {
+            this.logger = logger;
+            this.namingTemplate = namingTemplate;
+        }
 
         internal ContextBuilder WithAzureLogon()
         {
@@ -75,7 +83,21 @@ internal async Task<CommandContext> BuildAsync(CancellationToken cancellationTok
                 logger.WriteInfo($"Connected to {devops.Uri.Host}");
             }
 
-            return new CommandContext(logger, azure, devops);
+            INamingTemplates naming = null;
+            switch (namingTemplate.ToLower())
+            {
+                case "builtin":
+                    goto case "";
+                case "":
+                    naming = new BuiltInNamingTemplates();
+                    break;
+                default:
+                    // implement custom Naming Templates, e.g. reading from a file
+                    naming = new FileNamingTemplates(File.ReadAllText(namingTemplate));
+                    break;
+            }
+
+            return new CommandContext(logger, azure, devops, naming);
         }
 
         private string TranslateResult(LogonResult reason)

src/aggregator-cli/GitHubVersionResponse.cs

@@ -1,10 +1,5 @@
-using Microsoft.Extensions.Logging;
-using Microsoft.TeamFoundation.TestManagement.WebApi.Legacy;
+using System;
 using Newtonsoft.Json;
-using System;
-using System.Collections.Generic;
-using System.IO;
-using System.Text;
 
 namespace aggregator.cli
 {

src/aggregator-cli/Instances/AggregatorInstances.cs

@@ -15,20 +15,24 @@ namespace aggregator.cli
 {
     class AggregatorInstances : AzureBaseClass
     {
+        private readonly INamingTemplates naming;
 
-        public AggregatorInstances(IAzure azure, ILogger logger) : base(azure, logger)
-        { }
+        public AggregatorInstances(IAzure azure, ILogger logger, INamingTemplates naming)
+            : base(azure, logger)
+        {
+            this.naming = naming;
+        }
 
         public async Task<IEnumerable<ILogDataObject>> ListAllAsync(CancellationToken cancellationToken)
         {
             var runtime = new FunctionRuntimePackage(logger);
             var rgs = await azure.ResourceGroups.ListAsync(cancellationToken: cancellationToken);
             var filter = rgs
-                .Where(rg => rg.Name.StartsWith(InstanceName.ResourceGroupInstancePrefix));
+                .Where(rg => naming.ResourceGroupMatches(rg));
             var result = new List<InstanceOutputData>();
             foreach (var rg in filter)
             {
-                var name = InstanceName.FromResourceGroupName(rg.Name);
+                var name = naming.FromResourceGroupName(rg.Name);
                 result.Add(new InstanceOutputData(
                     name.PlainName,
                     rg.RegionName,
@@ -42,13 +46,13 @@ public async Task<IEnumerable<ILogDataObject>> ListByLocationAsync(string locati
         {
             var runtime = new FunctionRuntimePackage(logger);
             var rgs = await azure.ResourceGroups.ListAsync(cancellationToken: cancellationToken);
-            var filter = rgs.Where(rg =>
-                    rg.Name.StartsWith(InstanceName.ResourceGroupInstancePrefix)
-                    && string.Compare(rg.RegionName, location, StringComparison.Ordinal) == 0);
+            var filter = rgs.Where(
+                rg => naming.ResourceGroupMatches(rg)
+                && string.Compare(rg.RegionName, location, StringComparison.Ordinal) == 0);
             var result = new List<InstanceOutputData>();
             foreach (var rg in filter)
             {
-                var name = InstanceName.FromResourceGroupName(rg.Name);
+                var name = naming.FromResourceGroupName(rg.Name);
                 result.Add(new InstanceOutputData(
                     name.PlainName,
                     rg.RegionName,
@@ -61,13 +65,14 @@ await runtime.GetDeployedRuntimeVersion(name, azure, cancellationToken))
         internal async Task<IEnumerable<ILogDataObject>> ListInResourceGroupAsync(string resourceGroup, CancellationToken cancellationToken)
         {
             var runtime = new FunctionRuntimePackage(logger);
-            var apps = await azure.AppServices.FunctionApps.ListByResourceGroupAsync(resourceGroup, cancellationToken: cancellationToken);
+            string rgName = naming.GetResourceGroupName(resourceGroup);
+            var apps = await azure.AppServices.FunctionApps.ListByResourceGroupAsync(rgName, cancellationToken: cancellationToken);
 
             var result = new List<InstanceOutputData>();
             foreach (var app in apps)
             {
                 cancellationToken.ThrowIfCancellationRequested();
-                var name = InstanceName.FromFunctionAppName(app.Name, resourceGroup);
+                var name = naming.FromFunctionAppName(app.Name, resourceGroup);
                 result.Add(new InstanceOutputData(
                     name.PlainName,
                     app.Region.Name,
@@ -83,7 +88,7 @@ private static T GetCustomAttribute<T>()
             return Assembly.GetExecutingAssembly().GetCustomAttributes(typeof(T), false).FirstOrDefault() as T;
         }
 
-        internal async Task<bool> AddAsync(InstanceName instance, string location, string requiredVersion, string sourceUrl, InstanceFineTuning tuning, CancellationToken cancellationToken)
+        internal async Task<bool> AddAsync(InstanceCreateNames instance, string location, string requiredVersion, string sourceUrl, InstanceFineTuning tuning, CancellationToken cancellationToken)
         {
             string rgName = instance.ResourceGroupName;
             bool ok = await MakeSureResourceGroupExistsAsync(instance.IsCustom, location, rgName, cancellationToken);
@@ -151,7 +156,7 @@ internal class InstanceFineTuning
             public string AppInsightLocation { get; set; }
         }
 
-        private async Task<bool> DeployArmTemplateAsync(InstanceName instance, string location, string rgName, InstanceFineTuning tuning, CancellationToken cancellationToken)
+        private async Task<bool> DeployArmTemplateAsync(InstanceCreateNames instance, string location, string rgName, InstanceFineTuning tuning, CancellationToken cancellationToken)
         {
             // IDEA the template should create a Storage account and/or a Key Vault for Rules' use
             // TODO https://github.com/gjlumsden/AzureFunctionsSlots suggest that slots must be created in template
@@ -166,21 +171,25 @@ private async Task<bool> DeployArmTemplateAsync(InstanceName instance, string lo
 
             var parsedTemplate = JObject.Parse(armTemplateString);
             // sanity checks
-            if (parsedTemplate.SelectToken("parameters.appName") == null)
+            if (parsedTemplate.SelectToken("parameters.aggregatorVersion") == null)
             {
                 // not good, blah
                 logger.WriteWarning($"Something is wrong with the ARM template");
                 return false;
             }
 
-            string appName = instance.FunctionAppName;
             var infoVersion = GetCustomAttribute<AssemblyInformationalVersionAttribute>();
             var templateParams = new Dictionary<string, Dictionary<string, object>>{
                 // TODO give use more control by setting more parameters
                 {"webLocation", new Dictionary<string, object>{{"value", location } }},
                 {"aiLocation", new Dictionary<string, object>{{"value", tuning.AppInsightLocation } }},
                 {"storageAccountType", new Dictionary<string, object>{{"value", "Standard_LRS" } }},
-                {"appName", new Dictionary<string, object>{{"value", appName } }},
+
+                {"functionAppName", new Dictionary<string, object>{{"value", instance.FunctionAppName } }},
+                {"storageAccountName", new Dictionary<string, object>{{"value", instance.StorageAccountName } }},
+                {"hostingPlanName", new Dictionary<string, object>{{"value", instance.HostingPlanName } }},
+                {"appInsightName", new Dictionary<string, object>{{"value", instance.AppInsightName } }},
+
                 {"aggregatorVersion", new Dictionary<string, object>{{"value", infoVersion.InformationalVersion } }},
                 {"hostingPlanSkuName", new Dictionary<string, object>{{"value", tuning.HostingPlanSku } }},
                 {"hostingPlanSkuTier", new Dictionary<string, object>{{"value", tuning.HostingPlanTier } }},

src/aggregator-cli/Instances/ConfigureInstanceCommand.cs

@@ -34,8 +34,8 @@ internal override async Task<int> RunAsync(CancellationToken cancellationToken)
                 .WithAzureLogon()
                 .WithDevOpsLogon() // need the token, so we can save it in the app settings
                 .BuildAsync(cancellationToken);
-            var instances = new AggregatorInstances(context.Azure, context.Logger);
-            var instance = new InstanceName(Name, ResourceGroup);
+            var instances = new AggregatorInstances(context.Azure, context.Logger, context.Naming);
+            var instance = context.Naming.Instance(Name, ResourceGroup);
             bool ok = false;
             if (Authentication)
             {

src/aggregator-cli/Instances/InstallInstanceCommand.cs

@@ -62,8 +62,8 @@ internal override async Task<int> RunAsync(CancellationToken cancellationToken)
                 .WithAzureLogon()
                 .WithDevOpsLogon() // need the token, so we can save it in the app settings
                 .BuildAsync(cancellationToken);
-            var instances = new AggregatorInstances(context.Azure, context.Logger);
-            var instance = new InstanceName(Name, ResourceGroup);
+            var instances = new AggregatorInstances(context.Azure, context.Logger, context.Naming);
+            var instance = context.Naming.GetInstanceCreateNames(Name, ResourceGroup);
             bool ok = await instances.AddAsync(instance, Location, RequiredVersion, SourceUrl, tuning, cancellationToken);
             return ok ? 0 : 1;
         }